Update for PHP8 support.

Ian Jenkins · Ian Jenkins · commit 3deeb03f6204 · 2020-12-04T15:41:09.000Z
* Updates PHPUnit to ^9.
* Remove phpunit_extensions due to lack of php8 support and implements
  assertion in a trait.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,5 @@
 /vendor
 composer.lock
 clover.xml
+.phpunit.result.cache
+phpunit.xml.bak
diff --git a/composer.json b/composer.json
@@ -11,12 +11,12 @@
     ],
     "minimum-stability": "stable",
     "require": {
-        "php": ">=5.6,<8.0-DEV"
+        "php": ">=7.4",
+        "composer-plugin-api": "^1.0.0 || ^2.0.0"
     },
     "require-dev": {
-        "composer/composer": "~1.1",
-        "phpunit/phpunit": "~5.3",
-        "etsy/phpunit-extensions": "0.7.*"
+        "composer/composer": "^2",
+        "phpunit/phpunit": "^9"
     },
     "scripts": {
         "post-package-install": [
diff --git a/phpunit.xml b/phpunit.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     bootstrap="./vendor/autoload.php"
     colors="true"
     convertErrorsToExceptions="true"
@@ -9,26 +9,27 @@
     stopOnFailure="false"
     processIsolation="false"
     backupGlobals="false"
-    syntaxCheck="true"
+    xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd"
 >
+    <coverage includeUncoveredFiles="true">
+        <include>
+            <directory suffix=".php">./src</directory>
+        </include>
+        <exclude>
+            <directory>./vendor</directory>
+            <directory>./tests</directory>
+            <directory>./template</directory>
+            <directory>./bin</directory>
+        </exclude>
+        <report>
+            <clover outputFile="./clover.xml"/>
+            <text outputFile="php://stdout" showUncoveredFiles="false"/>
+        </report>
+    </coverage>
     <testsuites>
         <testsuite name="Tests">
             <directory>./tests</directory>
         </testsuite>
     </testsuites>
-    <filter>
-        <whitelist addUncoveredFilesFromWhitelist="true">
-            <directory suffix=".php">./src</directory>
-            <exclude>
-                <directory>./vendor</directory>
-                <directory>./tests</directory>
-                <directory>./template</directory>
-                <directory>./bin</directory>
-            </exclude>
-        </whitelist>
-    </filter>
-    <logging>
-        <log type="coverage-text" target="php://stdout" showUncoveredFiles="false"/>
-        <log type="coverage-clover" target="./clover.xml"/>
-    </logging>
-</phpunit>
+    <logging/>
+</phpunit>
diff --git a/tests/CustomAssertionsTrait.php b/tests/CustomAssertionsTrait.php
@@ -0,0 +1,17 @@
+<?php
+
+namespace Jenko\Sunscreen\Tests;
+
+trait CustomAssertionsTrait
+{
+    public static function assertStringMatchIgnoreWhitespace( string $expecting, string $actual )
+    {
+        $expected = preg_replace('#\&. #', '', implode(' ', preg_split('/\s+/', trim($expecting))));
+        $actual = preg_replace('#\&. #', '', implode(' ', preg_split('/\s+/', trim($actual))));
+
+        return self::assertEquals(
+            $expected,
+            $actual
+        );
+    }
+}
diff --git a/tests/Guesser/AbstractClassGuesserTest.php b/tests/Guesser/AbstractClassGuesserTest.php
@@ -5,8 +5,9 @@
 use Composer\Package\Package;
 use Jenko\Sunscreen\Guesser\AbstractClassGuesser;
 use Jenko\Sunscreen\Util;
+use PHPUnit\Framework\TestCase;
 
-class AbstractClassGuesserTest extends \PHPUnit_Framework_TestCase
+class AbstractClassGuesserTest extends TestCase
 {
     /**
      * @dataProvider getAutoloadsAndExpectedClasses
@@ -33,4 +34,4 @@ public function getAutoloadsAndExpectedClasses()
             [['psr-9999' => ['Foo\\Bar\\' => 'foo/bar/src/']], []],
         ];
     }
-}
+}
diff --git a/tests/Guesser/InterfaceClassGuesserTest.php b/tests/Guesser/InterfaceClassGuesserTest.php
@@ -5,8 +5,9 @@
 use Composer\Package\Package;
 use Jenko\Sunscreen\Guesser\InterfaceGuesser;
 use Jenko\Sunscreen\Util;
+use PHPUnit\Framework\TestCase;
 
-class InterfaceGuesserTest extends \PHPUnit_Framework_TestCase
+class InterfaceGuesserTest extends TestCase
 {
     /**
      * @dataProvider getAutoloadsAndExpectedClasses
@@ -33,4 +34,4 @@ public function getAutoloadsAndExpectedClasses()
             [['psr-9999' => ['Foo\\Bar\\' => 'foo/bar/src/']], []],
         ];
     }
-}
+}
diff --git a/tests/Processor/AdapterMethodsProcessorTest.php b/tests/Processor/AdapterMethodsProcessorTest.php
@@ -3,10 +3,14 @@
 namespace Jenko\Sunscreen\Tests\Processor;
 
 use Jenko\Sunscreen\Processor\AdapterMethodsProcessor;
+use Jenko\Sunscreen\Tests\CustomAssertionsTrait;
 use Jenko\Sunscreen\Tests\Fixtures\Foo;
+use PHPUnit\Framework\TestCase;
 
-class AdapterMethodsProcessorTest extends \PHPUnit_Framework_TestCase
+class AdapterMethodsProcessorTest extends TestCase
 {
+    use CustomAssertionsTrait;
+
     /**
      * @dataProvider getMethodsAndExpectedStrings
      * @param array $methods
@@ -16,7 +20,7 @@ public function testProcessGeneratesExpectedMethodsString($methods, $expectedMet
     {
         $processor = new AdapterMethodsProcessor($methods, 'myInterface');
 
-        \PHPUnit_Extensions_Assert_More::assertStringMatchIgnoreWhitespace(
+        self::assertStringMatchIgnoreWhitespace(
             $expectedMethodsString,
             $processor->process(true)
         );
diff --git a/tests/Processor/AdapterProcessorTest.php b/tests/Processor/AdapterProcessorTest.php
@@ -3,10 +3,14 @@
 namespace Jenko\Sunscreen\Tests\Processor;
 
 use Jenko\Sunscreen\Processor\AdapterProcessor;
+use Jenko\Sunscreen\Tests\CustomAssertionsTrait;
 use Jenko\Sunscreen\Util;
+use PHPUnit\Framework\TestCase;
 
-class AdapterProcessorTest extends \PHPUnit_Framework_TestCase
+class AdapterProcessorTest extends TestCase
 {
+    use CustomAssertionsTrait;
+
     /**
      * @dataProvider getInterfaceAndExpectedStrings
      *
@@ -20,7 +24,7 @@ public function testProcessGeneratesExpectedAdapterString($interfaceFqn, $expect
 
         $processor = new AdapterProcessor($interfaceFqn, $namespace, $fileLocation);
 
-        \PHPUnit_Extensions_Assert_More::assertStringMatchIgnoreWhitespace($expectedAdapterString, $processor->process(true));
+        self::assertStringMatchIgnoreWhitespace($expectedAdapterString, $processor->process(true));
     }
 
     public function getInterfaceAndExpectedStrings()
diff --git a/tests/Processor/ClassProcessorTest.php b/tests/Processor/ClassProcessorTest.php
@@ -3,10 +3,14 @@
 namespace Jenko\Sunscreen\Tests\Processor;
 
 use Jenko\Sunscreen\Processor\ClassProcessor;
+use Jenko\Sunscreen\Tests\CustomAssertionsTrait;
 use Jenko\Sunscreen\Util;
+use PHPUnit\Framework\TestCase;
 
-class ClassProcessorTest extends \PHPUnit_Framework_TestCase
+class ClassProcessorTest extends TestCase
 {
+    use CustomAssertionsTrait;
+
     /**
      * @dataProvider getClassAndExpectedStrings
      *
@@ -20,7 +24,7 @@ public function testProcessGeneratesExpectedClassString($classFqn, $expectedClas
 
         $processor = new ClassProcessor($classFqn, $namespace, $fileLocation);
 
-        \PHPUnit_Extensions_Assert_More::assertStringMatchIgnoreWhitespace(
+        self::assertStringMatchIgnoreWhitespace(
             $expectedClassString,
             $processor->process(true)
         );
diff --git a/tests/Processor/InterfaceMethodsProcessorTest.php b/tests/Processor/InterfaceMethodsProcessorTest.php
@@ -3,9 +3,13 @@
 namespace Jenko\Sunscreen\Tests\Processor;
 
 use Jenko\Sunscreen\Processor\InterfaceMethodsProcessor;
+use Jenko\Sunscreen\Tests\CustomAssertionsTrait;
+use PHPUnit\Framework\TestCase;
 
-class InterfaceMethodsProcessorTest extends \PHPUnit_Framework_TestCase
+class InterfaceMethodsProcessorTest extends TestCase
 {
+    use CustomAssertionsTrait;
+
     /**
      * @dataProvider getMethodsAndExpectedStrings
      * @param array $methods
@@ -15,7 +19,7 @@ public function testProcessGeneratesExpectedMethodsString($methods, $expectedMet
     {
         $processor = new InterfaceMethodsProcessor($methods);
 
-        \PHPUnit_Extensions_Assert_More::assertStringMatchIgnoreWhitespace(
+        self::assertStringMatchIgnoreWhitespace(
             $expectedMethodsString,
             $processor->process(true)
         );
diff --git a/tests/Processor/InterfaceProcessorTest.php b/tests/Processor/InterfaceProcessorTest.php
@@ -3,10 +3,14 @@
 namespace Jenko\Sunscreen\Tests\Processor;
 
 use Jenko\Sunscreen\Processor\InterfaceProcessor;
+use Jenko\Sunscreen\Tests\CustomAssertionsTrait;
 use Jenko\Sunscreen\Util;
+use PHPUnit\Framework\TestCase;
 
-class InterfaceProcessorTest extends \PHPUnit_Framework_TestCase
+class InterfaceProcessorTest extends TestCase
 {
+    use CustomAssertionsTrait;
+
     /**
      * @dataProvider getInterfaceAndExpectedStrings
      *
@@ -20,7 +24,7 @@ public function testProcessGeneratesExpectedInterfaceString($interfaceFqn, $expe
 
         $processor = new InterfaceProcessor($interfaceFqn, $namespace, $fileLocation);
 
-        \PHPUnit_Extensions_Assert_More::assertStringMatchIgnoreWhitespace(
+        self::assertStringMatchIgnoreWhitespace(
             $expectedClassString,
             $processor->process(true)
         );
diff --git a/tests/UtilTest.php b/tests/UtilTest.php
@@ -4,8 +4,9 @@
 
 use Composer\Package\Package;
 use Jenko\Sunscreen\Util;
+use PHPUnit\Framework\TestCase;
 
-class UtilTest extends \PHPUnit_Framework_TestCase
+class UtilTest extends TestCase
 {
     /**
      * @dataProvider getAutoloadsAndExpectedNamespaces
@@ -77,4 +78,4 @@ public function getInterfaceFqnAndExpectedClassName()
             ['Jenko\Sunscreen\Tests\Fixtures\BazInterface', 'JenkoBaz']
         ];
     }
-}
+}

Original file line number	Diff line number	Diff line change
`@@ -3,10 +3,14 @@`
`3`	`3`	`namespace Jenko\Sunscreen\Tests\Processor;`
`4`	`4`
`5`	`5`	`use Jenko\Sunscreen\Processor\AdapterProcessor;`
	`6`	`+use Jenko\Sunscreen\Tests\CustomAssertionsTrait;`
`6`	`7`	`use Jenko\Sunscreen\Util;`
	`8`	`+use PHPUnit\Framework\TestCase;`
`7`	`9`
`8`		`-class AdapterProcessorTest extends \PHPUnit_Framework_TestCase`
	`10`	`+class AdapterProcessorTest extends TestCase`
`9`	`11`	`{`
	`12`	`+ use CustomAssertionsTrait;`
	`13`	`+`
`10`	`14`	`/**`
`11`	`15`	`* @dataProvider getInterfaceAndExpectedStrings`
`12`	`16`	`*`
`@@ -20,7 +24,7 @@ public function testProcessGeneratesExpectedAdapterString($interfaceFqn, $expect`
`20`	`24`
`21`	`25`	`$processor = new AdapterProcessor($interfaceFqn, $namespace, $fileLocation);`
`22`	`26`
`23`		`- \PHPUnit_Extensions_Assert_More::assertStringMatchIgnoreWhitespace($expectedAdapterString, $processor->process(true));`
	`27`	`+ self::assertStringMatchIgnoreWhitespace($expectedAdapterString, $processor->process(true));`
`24`	`28`	`}`
`25`	`29`
`26`	`30`	`public function getInterfaceAndExpectedStrings()`
Original file line number	Diff line number	Diff line change
`@@ -4,8 +4,9 @@`
`4`	`4`
`5`	`5`	`use Composer\Package\Package;`
`6`	`6`	`use Jenko\Sunscreen\Util;`
	`7`	`+use PHPUnit\Framework\TestCase;`
`7`	`8`
`8`		`-class UtilTest extends \PHPUnit_Framework_TestCase`
	`9`	`+class UtilTest extends TestCase`
`9`	`10`	`{`
`10`	`11`	`/**`
`11`	`12`	`* @dataProvider getAutoloadsAndExpectedNamespaces`
`@@ -77,4 +78,4 @@ public function getInterfaceFqnAndExpectedClassName()`
`77`	`78`	`['Jenko\Sunscreen\Tests\Fixtures\BazInterface', 'JenkoBaz']`
`78`	`79`	`];`
`79`	`80`	`}`
`80`		`-}`
	`81`	`+}`