feat(src) show diff by default on failure

Author: lucatume

.github/workflows/ci.yaml

@@ -3,18 +3,20 @@ name: CI
 on: push
 
 jobs:
-  sniff;
+  sniff:
     name: Code validation
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@master
-      - uses: MilesChou/composer-action/install@master
+      - uses: MilesChou/composer-action/7.3/install@master
+        with:
+          args: require --dev phpstan/phpstan
       - uses: docker://php:7.3-alpine
         with:
           args: vendor/bin/phpcs --colors -p --standard=PSR2 -s src
       - uses: docker://php:7.3-alpine
         with:
-          args: phpstan analyze src --level=7
+          args: vendor/bin/phpstan analyze src --level=7
   php56:
     name: Test on PHP 5.6
     runs-on: ubuntu-latest

CHANGELOG.md

@@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.3.0] - 2023-09-08
+### Changed
+- show diff on failure by default
+
 ## [0.2.4] - 2020-02-05
 ### Added
 - data visitor support in all assertions to allow pre-processing of the expected and current values before assertions

composer.json

@@ -15,9 +15,7 @@
     "codeception/codeception": "^2.5 || ^3.0 || ^4.0"
   },
   "require-dev": {
-    "php": ">=7.1",
-    "squizlabs/php_codesniffer": "*",
-    "phpstan/phpstan": "^0.12.9"
+    "squizlabs/php_codesniffer": "*"
   },
   "autoload": {
     "psr-4": {

src/AbstractSnapshot.php

@@ -24,7 +24,7 @@ class AbstractSnapshot extends Snapshot
     /**
      * Keeps a counter for each class, function and data-set combination.
      *
-     * @var array<string,array>
+     * @var array<string,array<string,int>>
      */
     protected static $counters = [];
 
@@ -49,6 +49,13 @@ class AbstractSnapshot extends Snapshot
      */
     protected $dataVisitor;
 
+    /**
+     * By default, show the diff on failure.
+     *
+     * @var bool
+     */
+    protected $showDiff = true;
+
     /**
      * Snapshot constructor.
      *
@@ -84,14 +91,19 @@ protected function getFileName()
                 debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS
                     | DEBUG_BACKTRACE_PROVIDE_OBJECT, 5),
                 static function (array $backtraceEntry) use ($traitMethods) {
-                    return !in_array(
+                    return 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'];
+            $class = isset($backtrace[0]['class']) ? $backtrace[0]['class'] : '';
+    
+            if (empty($class)) {
+                throw new \RuntimeException('Cannot get ithe class name.');
+            }
+
             $classFrags = explode('\\', $class);
             $classBasename = array_pop($classFrags);
             $classFile = (new \ReflectionClass($class))->getFileName();
@@ -103,7 +115,7 @@ static function (array $backtraceEntry) use ($traitMethods) {
             $classDir = dirname($classFile);
             $function = $backtrace[0]['function'];
             $dataSetFrag = '';
-            if ($backtrace[0]['object'] instanceof TestCase) {
+            if (isset($backtrace[0]['object']) && $backtrace[0]['object'] instanceof TestCase) {
                 /** @var TestCase $testCase */
                 $testCase = $backtrace[0]['object'];
                 $dataName = $this->getDataName($testCase);
@@ -268,6 +280,10 @@ public function assert()
                 return;
             }
 
+            if ($this->showDiff) {
+                throw $exception;
+            }
+
             $this->fail($exception->getMessage());
         }
     }

src/DirectorySnapshot.php

@@ -30,7 +30,7 @@ protected function fetchData()
      *
      * @param string $dir The directory to build the iterator for.
      *
-     * @return \RecursiveIteratorIterator The recursive directory iterator, built on the specified directory.
+     * @return \RecursiveIteratorIterator<\RecursiveDirectoryIterator> The iterator, built on the specified directory.
      */
     protected function buildIterator($dir)
     {
@@ -125,6 +125,7 @@ protected function assertData($data)
             $sortedFiles
         );
 
+        // @phpstan-ignore-next-line
         uksort($sortedFiles, 'strcasecmp');
         $multiIterator->attachIterator(new \ArrayIterator($sortedFiles));