refactor(src) add phpstan

Author: lucatume

.gitattributes

@@ -1,7 +1,7 @@
 /tests                  export-ignore
 /.gitattributes         export-ignore
 /.gitignore             export-ignore
-/.travis.yml            export-ignore
+/.github                export-ignore
 /.codeception.dist.yml  export-ignore
-/composer.lock 		export-ignore
+/composer.lock 		    export-ignore
 /Makefile               export-ignore

.github/main.workflow

@@ -3,6 +3,18 @@ name: CI
 on: push
 
 jobs:
+  sniff;
+    name: Code validation
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@master
+      - uses: MilesChou/composer-action/install@master
+      - 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
   php56:
     name: Test on PHP 5.6
     runs-on: ubuntu-latest

.github/workflows/ci.yaml

@@ -6,7 +6,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-## [0.2.3] - 2020-03-03
+## [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
+
+## [0.2.3] - 2020-02-03
 ### Added
 - data visitor support in all assertions to allow pre-processing of the expected and current values before assertions
 
@@ -32,5 +36,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 [0.2.1]: https://github.com/lucatume/codeception-snapshot-assertions/compare/0.2.0...0.2.1
 [0.2.2]: https://github.com/lucatume/codeception-snapshot-assertions/compare/0.2.1...0.2.2
 [0.2.3]: https://github.com/lucatume/codeception-snapshot-assertions/compare/0.2.2...0.2.3
-[Unreleased]: https://github.com/lucatume/codeception-snapshot-assertions/compare/0.2.3...HEAD
+[0.2.4]: https://github.com/lucatume/codeception-snapshot-assertions/compare/0.2.3...0.2.4
+[Unreleased]: https://github.com/lucatume/codeception-snapshot-assertions/compare/0.2.4...HEAD
 

CHANGELOG.md

@@ -1,20 +1,16 @@
-.PHONY: wp_dump cs_sniff cs_fix cs_fix_n_sniff phpstan
+.PHONY: sniff fix fix_n_sniff phpstan
 
 # Sniff the source files.
-cs_sniff:
-	vendor/bin/phpcs --colors -p --standard=PSR2 $(SRC) --ignore=src/data,src/includes,src/tad/scripts -s src
+sniff:
+	vendor/bin/phpcs --colors -p --standard=PSR2 -s src
 
 # Fix the source and test files.
-cs_fix:
-	vendor/bin/phpcbf --colors -p --standard=PSR2 $(SRC) --ignore=src/data,src/includes,src/tad/scripts -s src tests
+fix:
+	vendor/bin/phpcbf --colors -p --standard=PSR2 -s src tests
 
 # Fix and then sniff the source files.
-cs_fix_n_sniff: cs_fix cs_sniff
-
-# Updates Composer dependencies using PHP 5.6.
-composer_update: composer.lock
-	docker run --rm -v ${CURDIR}:/app composer/composer:master-php5 update
+fix_n_sniff: cs_fix cs_sniff
 
 # Runs phpstan on the source files.
 phpstan:
-	docker run --rm -v ${CURDIR}:/app phpstan/phpstan analyse -l 5 /app/src
+	phpstan analyze src --level=7

Makefile

@@ -1,30 +1,32 @@
 {
-    "name": "lucatume/codeception-snapshot-assertions",
-    "description": "Snapshot assertions sugar for Codeception.",
-    "type": "library",
-    "license": "MIT",
-    "authors": [
-        {
-            "name": "theAverageDev (Luca Tumedei)",
-            "email": "luca@theaveragedev.com"
-        }
-    ],
-    "require": {
-        "ext-dom": "*",
-        "gajus/dindent": "^2.0",
-        "codeception/codeception": "^2.5 || ^3.0 || ^4.0"
-    },
-    "require-dev": {
-        "squizlabs/php_codesniffer": "*"
-    },
-    "autoload": {
-        "psr-4": {
-            "tad\\Codeception\\SnapshotAssertions\\": "src"
-        }
-    },
-    "autoload-dev": {
-        "psr-0": {
-            "tad\\Codeception\\SnapshotAssertions" : "tests/unit"
-        }
+  "name": "lucatume/codeception-snapshot-assertions",
+  "description": "Snapshot assertions sugar for Codeception.",
+  "type": "library",
+  "license": "MIT",
+  "authors": [
+    {
+      "name": "theAverageDev (Luca Tumedei)",
+      "email": "luca@theaveragedev.com"
     }
+  ],
+  "require": {
+    "ext-dom": "*",
+    "gajus/dindent": "^2.0",
+    "codeception/codeception": "^2.5 || ^3.0 || ^4.0"
+  },
+  "require-dev": {
+    "php": ">=7.1",
+    "squizlabs/php_codesniffer": "*",
+    "phpstan/phpstan": "^0.12.9"
+  },
+  "autoload": {
+    "psr-4": {
+      "tad\\Codeception\\SnapshotAssertions\\": "src"
+    }
+  },
+  "autoload-dev": {
+    "psr-0": {
+      "tad\\Codeception\\SnapshotAssertions": "tests/unit"
+    }
+  }
 }

composer.json

@@ -24,14 +24,14 @@ class AbstractSnapshot extends Snapshot
     /**
      * Keeps a counter for each class, function and data-set combination.
      *
-     * @var array
+     * @var array<string,array>
      */
     protected static $counters = [];
 
     /**
      * A list of method names provided by the SnapshotAssertions trait.
      *
-     * @var array
+     * @var array<string>
      */
     protected static $traitMethods = [];
 
@@ -95,6 +95,11 @@ static function (array $backtraceEntry) use ($traitMethods) {
             $classFrags = explode('\\', $class);
             $classBasename = array_pop($classFrags);
             $classFile = (new \ReflectionClass($class))->getFileName();
+
+            if ($classFile === false) {
+                throw new \RuntimeException('Cannot get the filename of the class ' . $class);
+            }
+
             $classDir = dirname($classFile);
             $function = $backtrace[0]['function'];
             $dataSetFrag = '';
@@ -121,12 +126,11 @@ static function (array $backtraceEntry) use ($traitMethods) {
     }
 
     /**
+     * Returns an array of the trait method names.
      *
+     * @return array<string> An array of the trait method names.
      *
-     * @return array
-     * @throws \ReflectionException
-     * @since TBD
-     *
+     * @throws \ReflectionException If a reflection cannot be done on a trait method.
      */
     protected static function getTraitMethods()
     {
@@ -177,7 +181,11 @@ public function fileExtension()
      *
      * This method is useful to create, or overwrite, the contents of the snapshot during tests.
      *
-     * @param  mixed  $contents  The snapshot contents.
+     * @param mixed $contents The snapshot contents.
+     *
+     * @throws \ReflectionException
+     *
+     * @return void
      */
     public function snapshotPutContents($contents)
     {
@@ -189,17 +197,18 @@ public function snapshotPutContents($contents)
 
     /**
      * Saves the snapshot contents to the snapshot file.
-     * @throws \RejectionException If there's an issue while building the snapshot filename.
-     * @throws \RuntimeException If the snapshots folder cannot be created.
-     * @throws \ReflectionException If there's an issue building the file name from the test case.
+     *
+     * @throws \Exception If there's an issue reading or saving the snapshot.
+     *
+     * @return void
      */
     protected function save()
     {
         $fileName = $this->getFileName();
         $snapshotsDir = dirname($fileName);
 
         if (!is_dir($snapshotsDir) && !mkdir($snapshotsDir, 0777, true) && !is_dir($snapshotsDir)) {
-            throw new RuntimeException(sprintf('Snapshots directory "%s" was not created', $snapshotsDir));
+            throw new \RuntimeException(sprintf('Snapshots directory "%s" was not created', $snapshotsDir));
         }
 
         file_put_contents($fileName, $this->prepareSnapshotForDump());
@@ -217,6 +226,10 @@ public function prepareSnapshotForDump()
 
     /**
      * Asserts the current contents match the contents of the snapshot.
+     *
+     * @return void
+     *
+     * @throws \ReflectionException If there's an issue building the snapshot file name.
      */
     public function assert()
     {
@@ -285,6 +298,13 @@ protected function isEmptyData($data)
         return !$data;
     }
 
+    /**
+     * Loads the data set from the snapshot.
+     *
+     * @return void
+     *
+     * @throws \ReflectionException
+     */
     protected function load()
     {
         if (!file_exists($this->getFileName())) {
@@ -301,6 +321,8 @@ protected function load()
      * Copy and paste of the bae method to allow for easier debug.
      *
      * @param  string  $message  The message to print in debug.
+     *
+     * @return void
      */
     protected function printDebug($message)
     {
@@ -309,7 +331,7 @@ protected function printDebug($message)
     /**
  * Returns the data name taking care of doing so in a way that is compatible with different PHPUnit versions.
  *
- * @param  TestCase|\PHPUnit_Framework_TestCase  $testCase The current test case.
+ * @param  TestCase  $testCase The current test case.
  *
  * @return string The data name if available or an empty string if not available.
  */
@@ -322,21 +344,25 @@ protected function getDataName(TestCase $testCase)
         $candidates = array_reverse(class_parents($testCase));
         $testCaseClass = get_class($testCase);
         $candidates[$testCaseClass] = $testCaseClass;
+        $read = '';
         foreach (array_reverse($candidates) as $class) {
             try {
                 $read = (string)ReflectionHelper::readPrivateProperty($testCase, 'dataName', $class);
             } catch (\ReflectionException $e) {
                 continue;
             }
-
-            return $read;
+            break;
         }
+
+        return $read;
     }
 
     /**
      * Overrides the base implementation to add a pre-assertion data handler.
      *
-     * {@inheritDoc}
+     * @param mixed $data The data to check.
+     *
+     * @return void
      */
     protected function assertData($data)
     {
@@ -354,6 +380,8 @@ protected function assertData($data)
      * @param callable $dataVisitor The data visitor that will be called on each visit of a snapshot "node".
      *                              The parameters passed to the visitor will be different for each snapshot; usually
      *                              the expected data and the current data.
+     *
+     * @return void
      */
     public function setDataVisitor(callable $dataVisitor)
     {
@@ -366,6 +394,8 @@ public function setDataVisitor(callable $dataVisitor)
      * @param string $snapshotFileName The absolute path to the file the snapshot file should use.
      *                                 This value is, usually, the one produced by another snapshot `snapshotFileName()`
      *                                 method.
+     *
+     * @return void
      */
     public function setSnapshotFileName($snapshotFileName)
     {