refactor(src) PHP 8.4 compatibility

.github/workflows/ci.yml

@@ -0,0 +1,59 @@
+# yaml-language-server: $schema=https://json.schemastore.org/github-workflow
+name: CI
+
+on: push
+
+jobs:
+  sniff:
+    name: Code validation
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@master
+      - name: Setup PHP {{ matrix.php-versions }}
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '8.0'
+          tools: composer
+      - name: Get Composer cache directory
+        id: composer-cache
+        run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
+      - name: Cache Composer dependencies
+        uses: actions/cache@v4
+        with:
+          path: ${{ steps.composer-cache.outputs.dir }}
+          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}
+          restore-keys: ${{ runner.os }}-composer-
+      - name: Install Composer dependencies
+        run: composer install --prefer-dist
+      - name: Run PHPCodeSniffer
+        run: vendor/bin/phpcs --colors -p --standard=PSR2 -s src
+      - name: Run PHPStan
+        run: vendor/bin/phpstan analyze src --level=9
+  test:
+    strategy:
+      matrix:
+        php-versions: [8.0, 8.1, 8.2, 8.3, 8.4]
+    name: Test on PHP ${{ matrix.php-versions }}
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@master
+      - name: Setup PHP {{ matrix.php-versions }}
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '${{ matrix.php-versions }}'
+          tools: composer
+      - name: Get Composer cache directory
+        id: composer-cache
+        run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
+      - name: Cache Composer dependencies
+        uses: actions/cache@v4
+        with:
+          path: ${{ steps.composer-cache.outputs.dir }}
+          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}
+          restore-keys: ${{ runner.os }}-composer-
+      - name: Install Composer dependencies
+        run: composer install --prefer-dist
+      - name: Run tests
+        run: vendor/bin/codecept run

Makefile

@@ -14,3 +14,6 @@ fix_n_sniff: fix sniff
 # Runs phpstan on the source files.
 phpstan:
 	phpstan analyze src --level=9
+
+act:
+	act -P ubuntu-22.04=shivammathur/node:2204 -W '.github/workflows/ci.yml'

src/AbstractSnapshot.php

@@ -53,7 +53,7 @@ class AbstractSnapshot extends Snapshot
      * @param array<int|string,mixed>|string|false|null $current The current value.
      * @param bool|null $refresh Whether to refresh the snapshot or not.
      */
-    public function __construct(protected mixed $current = null, bool $refresh = null)
+    public function __construct(protected mixed $current = null, ?bool $refresh = null)
     {
         $this->refresh = $refresh ?? (Configuration::getRefresh() && Debug::isEnabled());
     }
@@ -76,6 +76,7 @@ public function snapshotFileName(): string
      * @return string The snapshot file name, including the file extension.
      * @throws ReflectionException If the class that called the class cannot be reflected.
      */
+    #[\Override]
     protected function getFileName(bool $increment = false): string
     {
         if ($this->fileName !== null) {
@@ -89,13 +90,11 @@ protected function getFileName(bool $increment = false): string
                 | DEBUG_BACKTRACE_PROVIDE_OBJECT,
                 5
             ),
-            static function (array $backtraceEntry) use ($traitMethods): bool {
-                return isset($backtraceEntry['class']) && !in_array(
-                    $backtraceEntry['class'],
-                    [Snapshot::class, static::class, self::class, SnapshotAssertions::class],
-                    true
-                ) && !in_array($backtraceEntry['function'], $traitMethods, true);
-            }
+            static fn(array $backtraceEntry): bool => isset($backtraceEntry['class']) && !in_array(
+                $backtraceEntry['class'],
+                [Snapshot::class, static::class, self::class, SnapshotAssertions::class],
+                true
+            ) && !in_array($backtraceEntry['function'], $traitMethods, true)
         ));
         $class = $backtrace[0]['class'];
         $classFrags = explode('\\', $class);
@@ -146,9 +145,10 @@ protected static function getTraitMethods(): array
         }
 
         $reflection = new ReflectionClass(SnapshotAssertions::class);
-        static::$traitMethods = array_map(static function (ReflectionMethod $method): string {
-            return $method->name;
-        }, $reflection->getMethods());
+        static::$traitMethods = array_map(
+            static fn(ReflectionMethod $method): string => $method->name,
+            $reflection->getMethods()
+        );
 
         return static::$traitMethods;
     }
@@ -214,6 +214,7 @@ public function snapshotPutContents(string|false $contents): void
      *
      * @throws Exception If there's an issue reading or saving the snapshot.
      */
+    #[\Override]
     protected function save(bool $increment = true): void
     {
         $fileName = $this->getFileName($increment);
@@ -245,6 +246,7 @@ public function prepareSnapshotForDump(): string|false
      * @throws Exception
      * @throws Exception
      */
+    #[\Override]
     public function assert(): void
     {
         // Fetch data.
@@ -299,6 +301,7 @@ public function assert(): void
      *
      * @return string|false The fetched data, the current data by default.
      */
+    #[\Override]
     protected function fetchData(): string|false
     {
         if (!(is_string($this->current) || $this->current === false)) {
@@ -313,6 +316,7 @@ protected function fetchData(): string|false
      *
      * @throws ReflectionException
      */
+    #[\Override]
     protected function load(): void
     {
         $filename = $this->getFileName();
@@ -335,7 +339,7 @@ protected function load(): void
      */
     protected function printDebug(string $message): void
     {
-        Debug::debug($this::class . ': ' . $message);
+        Debug::debug(static::class . ': ' . $message);
     }
 
     /**
@@ -373,6 +377,7 @@ protected function getDataName(TestCase $testCase): string
      *
      * @param mixed $data The data to check.
      */
+    #[\Override]
     protected function assertData(mixed $data): void
     {
         if ($this->dataVisitor !== null) {

src/CodeSnapshot.php

@@ -33,6 +33,7 @@ public function __construct($current = null, string $extension = 'php')
     /**
      * {@inheritDoc}
      */
+    #[\Override]
     public function fileExtension(): string
     {
         return 'snapshot.'.$this->extension;

src/DirectorySnapshot.php

@@ -42,6 +42,7 @@ public function __construct($current = null)
     /**
      * {@inheritDoc}
      */
+    #[\Override]
     protected function fetchData(): string|false
     {
         return $this->prepareSnapshotForDump();
@@ -69,6 +70,7 @@ protected function buildIterator(string $dir): RecursiveIteratorIterator
     /**
      * {@inheritDoc}
      */
+    #[\Override]
     public function prepareSnapshotForDump(): string
     {
         if ($this->preparedSnapshot !== null) {
@@ -103,7 +105,7 @@ protected function getFileSectionHeadersFor(string $fileRelativePath): array
     {
         $fileSectionHeaderStart = sprintf('>>> %s >>>', $fileRelativePath);
         $fileSectionHeaderEnd = sprintf('<<< %s <<<', $fileRelativePath);
-        return array($fileSectionHeaderStart, $fileSectionHeaderEnd);
+        return [$fileSectionHeaderStart, $fileSectionHeaderEnd];
     }
 
     /**
@@ -113,16 +115,20 @@ protected function getFileSectionHeadersFor(string $fileRelativePath): array
      *
      * @throws ReflectionException
      */
+    #[\Override]
     protected function assertData(mixed $data): void
     {
         $currentIterator = $this->buildIterator($this->current);
         $snapshotFiles = $this->readFileListFromSnapshot($this->getFileName());
         $root = rtrim($this->current, '\\/');
         /** @var SplFileInfo[] $files */
         $files = iterator_to_array($currentIterator, false);
-        $currentFiles = array_map(static function (SplFileInfo $file) use ($root): string {
-            return '/' . ltrim(str_replace($root, '', $file->getPathname()), '/');
-        }, $files);
+        $currentFiles = array_map(
+            static function (SplFileInfo $file) use ($root): string {
+                return '/' . ltrim(str_replace($root, '', $file->getPathname()), '/');
+            },
+            $files
+        );
 
         usort($currentFiles, 'strcasecmp');
 
@@ -136,9 +142,7 @@ protected function assertData(mixed $data): void
         $multiIterator->attachIterator(new ArrayIterator($snapshotFiles));
         $sortedFiles = $files;
         $sortedFiles = array_combine(
-            array_map(static function (SplFileInfo $f): string {
-                return $f->getPathname();
-            }, $sortedFiles),
+            array_map(static fn(SplFileInfo $f): string => $f->getPathname(), $sortedFiles),
             $sortedFiles
         );
 

src/HtmlSnapshot.php

@@ -36,6 +36,7 @@ public function __construct($current = null)
     /**
      * {@inheritDoc}
      */
+    #[\Override]
     public function fileExtension(): string
     {
         return 'snapshot.html';
@@ -51,6 +52,7 @@ public function fileExtension(): string
      *
      * @throws RuntimeException If there's an issue during the HTML string parsing.
      */
+    #[\Override]
     protected function assertData($data): void
     {
         if ($this->dataVisitor !== null) {

src/JsonSnapshot.php

@@ -17,6 +17,7 @@ class JsonSnapshot extends AbstractSnapshot
     /**
      * {@inheritDoc}
      */
+    #[\Override]
     public function fileExtension(): string
     {
         return 'snapshot.json';

src/SnapshotAssertions.php

@@ -28,7 +28,7 @@ trait SnapshotAssertions
      *
      * @throws ReflectionException
      */
-    public function assertMatchesStringSnapshot(string $current, callable $dataVisitor = null): void
+    public function assertMatchesStringSnapshot(string $current, ?callable $dataVisitor = null): void
     {
         $stringSnapshot = new StringSnapshot($current);
         $showSnapshotDiff = !property_exists($this, 'showSnapshotDiff') || $this->showSnapshotDiff;
@@ -51,7 +51,7 @@ public function assertMatchesStringSnapshot(string $current, callable $dataVisit
      * @throws InvalidArgumentException If the HTML is not valid.
      * @throws ReflectionException
      */
-    public function assertMatchesHtmlSnapshot(string $current, callable $dataVisitor = null): void
+    public function assertMatchesHtmlSnapshot(string $current, ?callable $dataVisitor = null): void
     {
         $htmlSnapshot = new HtmlSnapshot($current);
         $showSnapshotDiff = !property_exists($this, 'showSnapshotDiff') || $this->showSnapshotDiff;
@@ -73,7 +73,7 @@ public function assertMatchesHtmlSnapshot(string $current, callable $dataVisitor
      *
      * @throws ReflectionException
      */
-    public function assertMatchesJsonSnapshot(string $current, callable $dataVisitor = null): void
+    public function assertMatchesJsonSnapshot(string $current, ?callable $dataVisitor = null): void
     {
         $jsonSnapshot = new JsonSnapshot($current);
         $showSnapshotDiff = !property_exists($this, 'showSnapshotDiff') || $this->showSnapshotDiff;
@@ -99,7 +99,7 @@ public function assertMatchesJsonSnapshot(string $current, callable $dataVisitor
     public function assertMatchesCodeSnapshot(
         string $current,
         string $extension = 'php',
-        callable $dataVisitor = null
+        ?callable $dataVisitor = null
     ): void {
         $codeSnapshot = new CodeSnapshot($current, $extension);
         $showSnapshotDiff = !property_exists($this, 'showSnapshotDiff') || $this->showSnapshotDiff;
@@ -120,7 +120,7 @@ public function assertMatchesCodeSnapshot(
      *
      * @throws ReflectionException
      */
-    public function assertMatchesDirectorySnapshot(string $current, callable $dataVisitor = null): void
+    public function assertMatchesDirectorySnapshot(string $current, ?callable $dataVisitor = null): void
     {
         $dirSnapshot = new DirectorySnapshot($current);
         $showSnapshotDiff = !property_exists($this, 'showSnapshotDiff') || $this->showSnapshotDiff;

src/StringSnapshot.php

@@ -17,6 +17,7 @@ class StringSnapshot extends AbstractSnapshot
     /**
      * {@inheritDoc}
      */
+    #[\Override]
     public function fileExtension(): string
     {
         return 'snapshot.txt';
@@ -38,6 +39,7 @@ public function __construct($current = null)
      *
      * @return string The string representation of the current value.
      */
+    #[\Override]
     protected function fetchData(): string
     {
         return $this->stringify($this->current);