Centralize Composer\Semver\VersionParser dependency in VersionNormali…

…zer (#22)
staabm · Dec 19, 2023 · 5450b15 · 5450b15
1 parent ad1898c
commit 5450b15
Show file tree

Hide file tree

Showing 7 changed files with 48 additions and 21 deletions.
diff --git a/extension.neon b/extension.neon
@@ -43,3 +43,6 @@ services:
         class: staabm\PHPStanTodoBy\ReferenceVersionFinder
         arguments:
             - %todo_by.referenceVersion%
+
+    -
+        class: staabm\PHPStanTodoBy\VersionNormalizer
diff --git a/src/ReferenceVersionFinder.php b/src/ReferenceVersionFinder.php
@@ -10,30 +10,28 @@ final class ReferenceVersionFinder
     private TagFetcher $fetcher;
     private string $referenceVersion;
 
+    private VersionNormalizer $versionNormalizer;
+
     public function __construct(string $referenceVersion, TagFetcher $fetcher)
     {
         $this->referenceVersion = $referenceVersion;
         $this->fetcher = $fetcher;
+        $this->versionNormalizer = new VersionNormalizer();
     }
     public function find(?string $workingDirectory): string
     {
         if (in_array($this->referenceVersion, ['nextMajor', 'nextMinor', 'nextPatch'], true)) {
             $latestTagVersion = $this->fetcher->fetchLatestTagVersion($workingDirectory);
 
-            try {
-                $version = Version::fromString($latestTagVersion);
-            } catch (InvalidVersionString $originException) {
-                try {
-                    $version = Version::fromString($latestTagVersion.'.0');
-                } catch (InvalidVersionString $innerException) {
-                    try {
-                        $version = Version::fromString($latestTagVersion.'.0.0');
-                    } catch (InvalidVersionString $innerInnerException) {
-                        throw $originException;
-                    }
-                }
+            $normalized = $this->versionNormalizer->normalize($latestTagVersion);
+            // composer/semver versions have 4 parts, but Version\Version only accepts 3.
+            $normalized = preg_replace('/\.0$/', '', $normalized);
+            if ($normalized === null) {
+                throw new \RuntimeException('Could not normalize version: ' . $latestTagVersion);
             }
 
+            $version = Version::fromString($normalized);
+
             if ($this->referenceVersion === 'nextMajor') {
                 return $version->incrementMajor()->toString();
             }

diff --git a/src/TodoByVersionRule.php b/src/TodoByVersionRule.php
@@ -3,7 +3,6 @@
 namespace staabm\PHPStanTodoBy;
 
 use Composer\Semver\Comparator;
-use Composer\Semver\VersionParser;
 use PhpParser\Node;
 use PHPStan\Analyser\Scope;
 use PHPStan\Node\VirtualNode;
@@ -38,7 +37,7 @@ final class TodoByVersionRule implements Rule
 
     private bool $nonIgnorable;
 
-    private VersionParser $versionParser;
+    private VersionNormalizer $versionNormalizer;
 
     private ReferenceVersionFinder $referenceVersionFinder;
 
@@ -52,12 +51,13 @@ final class TodoByVersionRule implements Rule
     public function __construct(
         bool $nonIgnorable,
         bool $singleGitRepo,
-        ReferenceVersionFinder $refVersionFinder
+        ReferenceVersionFinder $refVersionFinder,
+        VersionNormalizer $versionNormalizer
     ) {
-        $this->versionParser = new VersionParser();
         $this->referenceVersionFinder = $refVersionFinder;
         $this->nonIgnorable = $nonIgnorable;
         $this->singleGitRepo = $singleGitRepo;
+        $this->versionNormalizer = $versionNormalizer;
     }
 
     public function getNodeType(): string
@@ -106,7 +106,7 @@ public function processNode(Node $node, Scope $scope): array
 
                 $versionComparator = $this->getVersionComparator($version);
                 $plainVersion = ltrim($version, implode("", self::COMPARATORS));
-                $normalized = $this->versionParser->normalize($plainVersion);
+                $normalized = $this->versionNormalizer->normalize($plainVersion);
 
                 $expired = false;
                 if ($versionComparator === '<') {
@@ -161,7 +161,7 @@ private function getReferenceVersion(Scope $scope): string
 
         if (!array_key_exists($cacheKey, $this->referenceVersions)) {
             // lazy get the version, as it might incur subprocess creation
-            $this->referenceVersions[$cacheKey] = $this->versionParser->normalize(
+            $this->referenceVersions[$cacheKey] = $this->versionNormalizer->normalize(
                 $this->referenceVersionFinder->find($workingDirectory)
             );
         }

diff --git a/src/VersionNormalizer.php b/src/VersionNormalizer.php
@@ -0,0 +1,20 @@
+<?php
+
+namespace staabm\PHPStanTodoBy;
+
+use Composer\Semver\VersionParser;
+
+final class VersionNormalizer
+{
+    private VersionParser $versionParser;
+
+    public function __construct()
+    {
+        $this->versionParser = new VersionParser();
+    }
+
+    public function normalize(string $version): string
+    {
+        return $this->versionParser->normalize($version);
+    }
+}
diff --git a/tests/TodoByVersionRuleAlwaysThrowingFetchterTest.php b/tests/TodoByVersionRuleAlwaysThrowingFetchterTest.php
@@ -6,6 +6,7 @@
 use PHPStan\Testing\RuleTestCase;
 use staabm\PHPStanTodoBy\ReferenceVersionFinder;
 use staabm\PHPStanTodoBy\TodoByVersionRule;
+use staabm\PHPStanTodoBy\VersionNormalizer;
 
 /**
  * @extends RuleTestCase<TodoByVersionRule>
@@ -18,7 +19,8 @@ protected function getRule(): Rule
         return new TodoByVersionRule(
             true,
             true,
-            new ReferenceVersionFinder($this->referenceVersion, new AlwaysThrowingTagFetcher())
+            new ReferenceVersionFinder($this->referenceVersion, new AlwaysThrowingTagFetcher()),
+            new VersionNormalizer()
         );
     }
 

diff --git a/tests/TodoByVersionRuleSingleTimeFetchterTest.php b/tests/TodoByVersionRuleSingleTimeFetchterTest.php
@@ -6,6 +6,7 @@
 use PHPStan\Testing\RuleTestCase;
 use staabm\PHPStanTodoBy\ReferenceVersionFinder;
 use staabm\PHPStanTodoBy\TodoByVersionRule;
+use staabm\PHPStanTodoBy\VersionNormalizer;
 
 /**
  * @extends RuleTestCase<TodoByVersionRule>
@@ -18,7 +19,8 @@ protected function getRule(): Rule
         return new TodoByVersionRule(
             true,
             false,
-            new ReferenceVersionFinder($this->referenceVersion, new SingleTimeTagFetcher())
+            new ReferenceVersionFinder($this->referenceVersion, new SingleTimeTagFetcher()),
+            new VersionNormalizer()
         );
     }
 

diff --git a/tests/TodoByVersionRuleTest.php b/tests/TodoByVersionRuleTest.php
@@ -8,6 +8,7 @@
 use staabm\PHPStanTodoBy\ReferenceVersionFinder;
 use staabm\PHPStanTodoBy\TodoByDateRule;
 use staabm\PHPStanTodoBy\TodoByVersionRule;
+use staabm\PHPStanTodoBy\VersionNormalizer;
 
 /**
  * @extends RuleTestCase<TodoByVersionRule>
@@ -20,7 +21,8 @@ protected function getRule(): Rule
         return new TodoByVersionRule(
             true,
             true,
-            new ReferenceVersionFinder($this->referenceVersion, new GitTagFetcher())
+            new ReferenceVersionFinder($this->referenceVersion, new GitTagFetcher()),
+            new VersionNormalizer()
         );
     }