Merge pull request #78 from pyrech/fix-strpos-null-parameter

Fix PHP 8 warning about passing null to strpos()

Author: pyrech

.github/workflows/ci.yml

@@ -26,7 +26,7 @@ jobs:
         strategy:
             fail-fast: false
             matrix:
-                php-version: ['7.1', '7.2', '7.3', '7.4', '8.0']
+                php-version: ['7.1', '7.2', '7.3', '7.4', '8.0', '8.1']
                 minimum-stability: ['']
                 composer-flags: ['']
                 name: ['']

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changes between versions
 
+## Not yet released
+
+* Fix PHP 8 warning about passing null to strpos() ([#78](https://github.com/pyrech/composer-changelogs/pull/78))
+
 ## 1.8.1 (2021-10-13)
 
 * Fix semver output colors ([#74](https://github.com/pyrech/composer-changelogs/pull/74))

src/UrlGenerator/GitBasedUrlGenerator.php

@@ -30,7 +30,7 @@ abstract protected function getDomain();
      */
     public function supports($sourceUrl)
     {
-        return false !== strpos($sourceUrl, $this->getDomain());
+        return $sourceUrl && false !== strpos($sourceUrl, $this->getDomain());
     }
 
     /**
@@ -39,12 +39,16 @@ public function supports($sourceUrl)
      * It ensures there is no .git part in http url. It also supports ssh urls
      * by converting them in their http equivalent format.
      *
-     * @param string $sourceUrl
+     * @param ?string $sourceUrl
      *
      * @return string
      */
     protected function generateBaseUrl($sourceUrl)
     {
+        if (!$sourceUrl) {
+            return '';
+        }
+
         if ($this->isSshUrl($sourceUrl)) {
             return $this->transformSshUrlIntoHttp($sourceUrl);
         }

src/UrlGenerator/GithubUrlGenerator.php

@@ -69,9 +69,15 @@ public function generateReleaseUrl($sourceUrl, Version $version)
             return false;
         }
 
+        $baseUrl = $this->generateBaseUrl($sourceUrl);
+
+        if (!$baseUrl) {
+            return false;
+        }
+
         return sprintf(
             '%s/releases/tag/%s',
-            $this->generateBaseUrl($sourceUrl),
+            $baseUrl,
             $version->getPretty()
         );
     }

src/UrlGenerator/GitlabUrlGenerator.php

@@ -70,6 +70,12 @@ public function generateReleaseUrl($sourceUrl, Version $version)
             return false;
         }
 
+        $baseUrl = $this->generateBaseUrl($sourceUrl);
+
+        if (!$baseUrl) {
+            return false;
+        }
+
         return sprintf(
             '%s/tags/%s',
             $this->generateBaseUrl($sourceUrl),

src/UrlGenerator/UrlGenerator.php

@@ -16,7 +16,7 @@
 interface UrlGenerator
 {
     /**
-     * @param string $sourceUrl
+     * @param ?string $sourceUrl
      *
      * @return bool
      */
@@ -29,9 +29,9 @@ public function supports($sourceUrl);
      * In case the from and to source urls are different, this probably means
      * that an across fork compare url should be generated instead.
      *
-     * @param string  $sourceUrlFrom
+     * @param ?string $sourceUrlFrom
      * @param Version $versionFrom
-     * @param string  $sourceUrlTo
+     * @param ?string $sourceUrlTo
      * @param Version $versionTo
      *
      * @return string|false
@@ -42,7 +42,7 @@ public function generateCompareUrl($sourceUrlFrom, Version $versionFrom, $source
      * Return the release url for the given version or false if compare url is
      * not supported.
      *
-     * @param string  $sourceUrl
+     * @param ?string $sourceUrl
      * @param Version $version
      *
      * @return string|false

src/UrlGenerator/WordPressUrlGenerator.php

@@ -25,14 +25,18 @@ class WordPressUrlGenerator implements UrlGenerator
      */
     public function supports($sourceUrl)
     {
-        return false !== strpos($sourceUrl, self::DOMAIN);
+        return $sourceUrl && false !== strpos($sourceUrl, self::DOMAIN);
     }
 
     /**
      * {@inheritdoc}
      */
     public function generateCompareUrl($sourceUrlFrom, Version $versionFrom, $sourceUrlTo, Version $versionTo)
     {
+        if (!$sourceUrlTo) {
+            return false;
+        }
+
         if (preg_match('#plugins.svn.wordpress.org/(.*)/#', $sourceUrlTo, $matches)) {
             $plugin = $matches[1];
 

tests/UrlGenerator/BitbucketUrlGeneratorTest.php

@@ -36,6 +36,7 @@ public function testItDoesNotSupportNonBitbucketUrls()
     {
         $this->assertFalse($this->SUT->supports('https://github.com/phpunit/phpunit-mock-objects.git'));
         $this->assertFalse($this->SUT->supports('https://github.com/symfony/console'));
+        $this->assertFalse($this->SUT->supports(null));
     }
 
     public function testItGeneratesCompareUrlsWithOrWithoutGitExtensionInSourceUrl()
@@ -178,6 +179,21 @@ public function testItGeneratesCompareUrlsWithSshSourceUrl()
         );
     }
 
+    public function testItDoesNotGenerateCompareUrlsWithoutSourceUrl()
+    {
+        $versionFrom = new Version('v1.0.0.0', 'v1.0.0', 'v1.0.0');
+        $versionTo = new Version('v1.0.1.0', 'v1.0.1', 'v1.0.1');
+
+        $this->assertFalse(
+            $this->SUT->generateCompareUrl(
+                null,
+                $versionFrom,
+                null,
+                $versionTo
+            )
+        );
+    }
+
     public function testItDoesNotGenerateReleaseUrls()
     {
         $this->assertFalse(
@@ -194,4 +210,14 @@ public function testItDoesNotGenerateReleaseUrls()
             )
         );
     }
+
+    public function testItDoesNotGenerateReleaseUrlWithoutSourceUrl()
+    {
+        $this->assertFalse(
+            $this->SUT->generateReleaseUrl(
+                null,
+                new Version('v1.0.1.0', 'v1.0.1', 'v1.0.1')
+            )
+        );
+    }
 }

tests/UrlGenerator/GithubUrlGeneratorTest.php

@@ -178,6 +178,21 @@ public function testItGeneratesCompareUrlsWithSshSourceUrl()
         );
     }
 
+    public function testItDoesNotGenerateCompareUrlsWithoutSourceUrl()
+    {
+        $versionFrom = new Version('v1.0.0.0', 'v1.0.0', 'v1.0.0');
+        $versionTo = new Version('v1.0.1.0', 'v1.0.1', 'v1.0.1');
+
+        $this->assertFalse(
+            $this->SUT->generateCompareUrl(
+                null,
+                $versionFrom,
+                null,
+                $versionTo
+            )
+        );
+    }
+
     public function testItDoesNotGenerateReleaseUrlsForDevVersion()
     {
         $this->assertFalse(
@@ -224,4 +239,14 @@ public function testItGeneratesReleaseUrlWithSshSourceUrl()
             )
         );
     }
+
+    public function testItDoesNotGenerateReleaseUrlWithoutSourceUrl()
+    {
+        $this->assertFalse(
+            $this->SUT->generateReleaseUrl(
+                null,
+                new Version('v1.0.1.0', 'v1.0.1', 'v1.0.1')
+            )
+        );
+    }
 }

tests/UrlGenerator/GitlabUrlGeneratorTest.php

@@ -161,6 +161,21 @@ public function testItGeneratesCompareUrlsWithSshSourceUrl()
         );
     }
 
+    public function testItDoesNotGenerateCompareUrlsWithoutSourceUrl()
+    {
+        $versionFrom = new Version('v1.0.0.0', 'v1.0.0', 'v1.0.0');
+        $versionTo = new Version('v1.0.1.0', 'v1.0.1', 'v1.0.1');
+
+        $this->assertFalse(
+            $this->SUT->generateCompareUrl(
+                null,
+                $versionFrom,
+                null,
+                $versionTo
+            )
+        );
+    }
+
     public function testItDoesNotGenerateReleaseUrlsForDevVersion()
     {
         $this->assertFalse(
@@ -207,4 +222,14 @@ public function testItGeneratesReleaseUrlWithSshSourceUrl()
             )
         );
     }
+
+    public function testItDoesNotGenerateReleaseUrlWithoutSourceUrl()
+    {
+        $this->assertFalse(
+            $this->SUT->generateReleaseUrl(
+                null,
+                new Version('v1.0.1.0', 'v1.0.1', 'v1.0.1')
+            )
+        );
+    }
 }