Merge pull request #154 from spatie/v5

freekmurze · web-flow · commit 9fcb3c5ec6ee · 2023-02-09T13:57:28.000+01:00
v5 - add support for PHPUnit v10
diff --git a/.github/workflows/php-cs-fixer.yml b/.github/workflows/php-cs-fixer.yml
diff --git a/.github/workflows/pint.yml b/.github/workflows/pint.yml
@@ -0,0 +1,21 @@
+name: Check & fix styling
+
+on: [push]
+
+jobs:
+  php-cs-fixer:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+        with:
+          ref: ${{ github.head_ref }}
+
+      - name: Fix styling issues
+        uses: aglipanci/laravel-pint-action@0.1.0
+
+      - name: Commit changes
+        uses: stefanzweifel/git-auto-commit-action@v4
+        with:
+          commit_message: Fix styling
diff --git a/.github/workflows/run-tests.yml b/.github/workflows/run-tests.yml
@@ -9,7 +9,7 @@ jobs:
             fail-fast: true
             matrix:
                 os: [ubuntu-latest, windows-latest]
-                php: [8.2, 8.1, 8.0, 7.4, 7.3]
+                php: [8.2, 8.1]
                 stability: [prefer-lowest, prefer-stable]
 
         name: P${{ matrix.php }} - ${{ matrix.stability }} - ${{ matrix.os }}
diff --git a/.gitignore b/.gitignore
@@ -1,7 +1,4 @@
-.idea
-.php-cs-fixer.cache
-.phpunit.result.cache
-build
+.phpunit.cache
 composer.lock
 coverage
 docs
diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php
diff --git a/README.md b/README.md
@@ -188,7 +188,7 @@ Snapshot ids are generated via the `getSnapshotId` method on the `MatchesSnapsho
 protected function getSnapshotId(): string
 {
     return (new ReflectionClass($this))->getShortName().'--'.
-        $this->getName().'--'.
+        $this->name().'--'.
         $this->snapshotIncrementor;
 }
 ```
diff --git a/composer.json b/composer.json
@@ -20,18 +20,15 @@
         }
     ],
     "require": {
-        "php": "^7.3|^7.4|^8.0",
+        "php": "^8.1",
         "ext-dom": "*",
         "ext-json": "*",
         "ext-libxml": "*",
         "composer-runtime-api": "^2.0",
-        "phpunit/phpunit": "^8.3|^9.0",
-        "symfony/property-access": "^4.0|^5.0|^6.0",
-        "symfony/serializer": "^4.0|^5.0|^6.0",
-        "symfony/yaml": "^4.0|^5.0|^6.0"
-    },
-    "require-dev": {
-        "phpunit/phpunit": "^9.1.0"
+        "phpunit/phpunit": "^10.0",
+        "symfony/property-access": "^5.2|^6.2",
+        "symfony/serializer": "^5.2|^6.2",
+        "symfony/yaml": "^5.2|^6.2"
     },
     "autoload": {
         "psr-4": {
@@ -48,5 +45,12 @@
     },
     "config": {
         "sort-packages": true
-  }
+    },
+    "minimum-stability": "dev",
+    "prefer-stable": true,
+    "extra": {
+        "branch-alias": {
+            "dev-v5": "5.0-dev"
+        }
+    }
 }
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -1,15 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" bootstrap="vendor/autoload.php" backupGlobals="false" backupStaticAttributes="false" colors="true" verbose="true" convertErrorsToExceptions="true" convertNoticesToExceptions="true" convertWarningsToExceptions="true" processIsolation="false" stopOnFailure="false" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
-  <coverage>
-    <include>
-      <directory suffix=".php">src/</directory>
-    </include>
-    <report>
-      <clover outputFile="build/logs/clover.xml"/>
-      <html outputDirectory="build/coverage"/>
-      <text outputFile="build/coverage.txt"/>
-    </report>
-  </coverage>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" bootstrap="vendor/autoload.php" backupGlobals="false" colors="true" processIsolation="false" stopOnFailure="false" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.0/phpunit.xsd" cacheDirectory=".phpunit.cache" backupStaticProperties="false">
   <testsuites>
     <testsuite name="Integration">
       <directory>tests/Integration</directory>
diff --git a/src/Concerns/SnapshotIdAware.php b/src/Concerns/SnapshotIdAware.php
@@ -13,7 +13,7 @@ trait SnapshotIdAware
     protected function getSnapshotId(): string
     {
         return (new ReflectionClass($this))->getShortName().'__'.
-            $this->getName().'__'.
+            $this->name().'__'.
             $this->snapshotIncrementor;
     }
 }
diff --git a/src/Driver.php b/src/Driver.php
@@ -4,33 +4,22 @@
 
 interface Driver
 {
-    /**
+    /*
      * Serialize a snapshot's data to a string that can be written to a
      * generated snapshot file.
-     *
-     * @param mixed $data
-     *
-     * @return string
      */
-    public function serialize($data): string;
+    public function serialize(mixed $data): string;
 
-    /**
+    /*
      * The extension that should be used to save the snapshot file, without
      * a leading dot.
-     *
-     * @return string
      */
     public function extension(): string;
 
-    /**
+    /*
      * Match an expectation with a snapshot's actual contents. Should throw an
      * `ExpectationFailedException` if it doesn't match. This happens by
      * default if you're using PHPUnit's `Assert` class for the match.
-     *
-     * @param mixed $expected
-     * @param mixed $actual
-     *
-     * @throws \PHPUnit\Framework\ExpectationFailedException
      */
-    public function match($expected, $actual);
+    public function match(mixed $expected, mixed $actual);
 }
diff --git a/src/Drivers/HtmlDriver.php b/src/Drivers/HtmlDriver.php
@@ -26,6 +26,7 @@ public function serialize($data): string
         @$domDocument->loadHTML($data, LIBXML_HTML_NODEFDTD); // to ignore HTML5 errors
 
         $htmlValue = $domDocument->saveHTML();
+
         // Normalize line endings for cross-platform tests.
         if (PHP_OS_FAMILY === 'Windows') {
             $htmlValue = implode("\n", explode("\r\n", $htmlValue));
diff --git a/src/Drivers/ObjectDriver.php b/src/Drivers/ObjectDriver.php
@@ -2,7 +2,6 @@
 
 namespace Spatie\Snapshots\Drivers;
 
-use Composer\InstalledVersions;
 use PHPUnit\Framework\Assert;
 use Spatie\Snapshots\Driver;
 use Symfony\Component\Serializer\Encoder\YamlEncoder;
@@ -26,15 +25,6 @@ public function serialize($data): string
 
         $serializer = new Serializer($normalizers, $encoders);
 
-        if ($data instanceof \stdClass) {
-            $serializerVersion = InstalledVersions::getVersion('symfony/serializer');
-
-            if (version_compare($serializerVersion, '5.1.0.0') < 0) {
-                // The Symfony serializer (before 5.1 version) doesn't support `stdClass`.
-                $data = (array) $data;
-            }
-        }
-
         return $this->dedent(
             $serializer->serialize($data, 'yaml', [
                 'yaml_inline' => 2,
diff --git a/src/Filesystem.php b/src/Filesystem.php
@@ -4,12 +4,8 @@
 
 class Filesystem
 {
-    /** @var string */
-    private $basePath;
-
-    public function __construct(string $basePath)
+    public function __construct(private string $basePath)
     {
-        $this->basePath = $basePath;
     }
 
     public static function inDirectory(string $path): self
diff --git a/src/MatchesSnapshots.php b/src/MatchesSnapshots.php
@@ -18,11 +18,9 @@ trait MatchesSnapshots
     use SnapshotDirectoryAware;
     use SnapshotIdAware;
 
-    /** @var int */
-    protected $snapshotIncrementor = 0;
+    protected int $snapshotIncrementor = 0;
 
-    /** @var array */
-    protected $snapshotChanges = [];
+    protected array $snapshotChanges = [];
 
     /** @before */
     public function setUpSnapshotIncrementor()
@@ -67,7 +65,7 @@ public function assertMatchesSnapshot($actual, Driver $driver = null): void
         $this->doSnapshotAssertion($actual, new ObjectDriver());
     }
 
-    public function assertMatchesFileHashSnapshot($filePath): void
+    public function assertMatchesFileHashSnapshot(string $filePath): void
     {
         if (! file_exists($filePath)) {
             $this->fail('File does not exist');
@@ -78,17 +76,17 @@ public function assertMatchesFileHashSnapshot($filePath): void
         $this->assertMatchesSnapshot($actual);
     }
 
-    public function assertMatchesFileSnapshot($file): void
+    public function assertMatchesFileSnapshot(string $file): void
     {
         $this->doFileSnapshotAssertion($file);
     }
 
-    public function assertMatchesHtmlSnapshot($actual): void
+    public function assertMatchesHtmlSnapshot(string $actual): void
     {
         $this->assertMatchesSnapshot($actual, new HtmlDriver());
     }
 
-    public function assertMatchesJsonSnapshot($actual): void
+    public function assertMatchesJsonSnapshot(array|string $actual): void
     {
         $this->assertMatchesSnapshot($actual, new JsonDriver());
     }
@@ -154,7 +152,7 @@ protected function shouldCreateSnapshots(): bool
             && getenv('CREATE_SNAPSHOTS') !== 'false';
     }
 
-    protected function doSnapshotAssertion($actual, Driver $driver)
+    protected function doSnapshotAssertion(mixed $actual, Driver $driver)
     {
         $this->snapshotIncrementor++;
 
diff --git a/tests/Integration/MatchesSnapshotTest.php b/tests/Integration/MatchesSnapshotTest.php
@@ -489,7 +489,7 @@ private function getMatchesSnapshotMock(bool $mockGetSnapshotId = true): MockObj
             $matchesSnapshotMock
                 ->expects($this->any())
                 ->method('getSnapshotId')
-                ->willReturn('MatchesSnapshotTest__'.$this->getName().'__1');
+                ->willReturn('MatchesSnapshotTest__'.$this->name().'__1');
         }
 
         $matchesSnapshotMock
diff --git a/tests/Unit/Drivers/JsonDriverTest.php b/tests/Unit/Drivers/JsonDriverTest.php
@@ -124,6 +124,7 @@ public function it_can_not_serialize_resources()
 
     /**
      * @test
+     *
      * @testWith ["{}", "{}", true]
      *           ["{}", "{\"data\":1}", false]
      *           ["{\"data\":1}", "{\"data\":1}", true]
diff --git a/tests/Unit/Drivers/ObjectDriverTest.php b/tests/Unit/Drivers/ObjectDriverTest.php
@@ -92,6 +92,7 @@ public function it_can_serialize_a_class_instance()
 class Obj
 {
     private $private = 'private';
+
     public $public = 'public';
 
     public function getName()
diff --git a/tests/Unit/Drivers/TextDriverTest.php b/tests/Unit/Drivers/TextDriverTest.php
@@ -19,7 +19,7 @@ public function it_can_serialize_laravel_route_list()
             '                                                            Showing [1] routes',
         ]);
 
-        $this->assertEquals($expected, $driver->serialize(<<<EOF
+        $this->assertEquals($expected, $driver->serialize(<<<'EOF'
 
   GET|HEAD       / ..................................................... index
 
diff --git a/tests/Unit/FilenameTest.php b/tests/Unit/FilenameTest.php
@@ -9,14 +9,15 @@ class FilenameTest extends TestCase
 {
     /**
      * @test
+     *
      * @dataProvider fileNameProvider
      */
     public function it_creates_a_filename_which_is_valid_on_all_systems($name, $expected)
     {
         $this->assertEquals($expected, Filename::cleanFilename($name));
     }
 
-    public function fileNameProvider()
+    public static function fileNameProvider()
     {
         return [
             ['ClassTest__testOne with... data set "Empty".php', 'ClassTest__testOne with data set Empty.php'],

Original file line number	Diff line number	Diff line change
@@ -188,7 +188,7 @@ Snapshot ids are generated via the `getSnapshotId` method on the `MatchesSnapsho
`188`	`188`	`protected function getSnapshotId(): string`
`189`	`189`	`{`
`190`	`190`	`return (new ReflectionClass($this))->getShortName().'--'.`
`191`		`- $this->getName().'--'.`
	`191`	`+ $this->name().'--'.`
`192`	`192`	`$this->snapshotIncrementor;`
`193`	`193`	`}`
`194`	`194`	```
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ trait SnapshotIdAware`
`13`	`13`	`protected function getSnapshotId(): string`
`14`	`14`	`{`
`15`	`15`	`return (new ReflectionClass($this))->getShortName().'__'.`
`16`		`- $this->getName().'__'.`
	`16`	`+ $this->name().'__'.`
`17`	`17`	`$this->snapshotIncrementor;`
`18`	`18`	`}`
`19`	`19`	`}`