Merge pull request #30 from shochdoerfer/feature/phpstan

Add phpstan to test the project

Author: shochdoerfer

.travis.yml

@@ -19,9 +19,9 @@ script:
     - composer validate
     - ./vendor/bin/phing security:check
     - ./vendor/bin/phing sniff
+    - ./vendor/bin/phing static-analysis
     - if [[ $TEST_COVERAGE == 'true' ]]; then ./vendor/bin/phing unit-with-coverage ; fi
     - if [[ $TEST_COVERAGE != 'true' ]]; then ./vendor/bin/phing unit ; fi
 
 after_script:
     - if [[ $TEST_COVERAGE == 'true' ]]; then ./vendor/bin/coveralls -v ; fi
-

build.xml

@@ -39,4 +39,12 @@
             <arg value="clover.xml"/>
         </exec>
     </target>
+
+    <target name="static-analysis">
+        <exec executable="./vendor/bin/phpstan"
+              passthru="true"
+              checkreturn="true">
+            <arg value="analyse"/>
+        </exec>
+    </target>
 </project>

captainhook.json

@@ -14,6 +14,10 @@
     "pre-push": {
         "enabled": false,
         "actions": [
+            {
+                "action": "./vendor/bin/phing static-analysis",
+                "options": []
+            },
             {
                 "action": "./vendor/bin/phing security:check",
                 "options": []

composer.json

@@ -27,6 +27,8 @@
     "mikey179/vfsstream": "^1.6",
     "nikic/php-parser": "^4.3",
     "phing/phing": "^2.16",
+    "phpstan/extension-installer": "^1.0",
+    "phpstan/phpstan-phpunit": "^0.12.8",
     "phpunit/phpunit": "^8.5.3",
     "squizlabs/php_codesniffer": "^3.4"
   },

composer.lock

@@ -0,0 +1,18 @@
+parameters:
+    level: 7
+    inferPrivatePropertyTypeFromConstructor: true
+    fileExtensions:
+        - php
+    paths:
+        - src/bitExpert
+        - tests/bitExpert
+    ignoreErrors:
+        -
+            message: '~Call to an undefined method ReflectionType::getName~'
+            path: src/bitExpert/PHPStan/Magento/Autoload/ProxyAutoloader.php
+        -
+            message: '~Parameter #1 \$argument of class ReflectionClass constructor expects~'
+            path: src/bitExpert/PHPStan/Magento/Autoload/ProxyAutoloader.php
+        -
+            message: '~Class Magento\\Framework\\DataObject not found~'
+            path: src/bitExpert/PHPStan/Magento/Reflection/Framework/DataObjectMagicMethodReflectionExtension.php

phpstan.neon

@@ -49,10 +49,10 @@ public function autoload(string $class): void
     /**
      * Generate the factory file content as Magento would.
      *
-     * @param $class
+     * @param string $class
      * @return string
      */
-    protected function getFileContents($class): string
+    protected function getFileContents(string $class): string
     {
         $namespace = explode('\\', ltrim($class, '\\'));
         $factoryClassname = array_pop($namespace);

src/bitExpert/PHPStan/Magento/Autoload/FactoryAutoloader.php

@@ -28,7 +28,7 @@ class MagicMethodReflection implements MethodReflection
      */
     private $declaringClass;
     /**
-     * @var array
+     * @var ParametersAcceptor[]
      */
     private $variants;
 

src/bitExpert/PHPStan/Magento/Reflection/MagicMethodReflection.php

@@ -37,7 +37,7 @@ public function setUp(): void
     /**
      * @test
      */
-    public function nullReturnedWhenLookingUpNonExistentFileInCache()
+    public function nullReturnedWhenLookingUpNonExistentFileInCache(): void
     {
         $absFilename = $this->storage->load('test.txt', '');
 
@@ -47,7 +47,7 @@ public function nullReturnedWhenLookingUpNonExistentFileInCache()
     /**
      * @test
      */
-    public function absoluteFilenameReturnedWhenLookingUpExistentFileInCache()
+    public function absoluteFilenameReturnedWhenLookingUpExistentFileInCache(): void
     {
         vfsStream::create(
             ['4b' => ['6f' => ['4b6fcb2d521ef0fd442a5301e7932d16cc9f375a.php' => 'Lorem ipsum']]],
@@ -62,7 +62,7 @@ public function absoluteFilenameReturnedWhenLookingUpExistentFileInCache()
     /**
      * @test
      */
-    public function addingFileToCacheSucceeds()
+    public function addingFileToCacheSucceeds(): void
     {
         $this->storage->save('test.txt', '', 'Lorem ipsum');
         $absFilename = $this->storage->load('test.txt', '');
@@ -73,7 +73,7 @@ public function addingFileToCacheSucceeds()
     /**
      * @test
      */
-    public function addingFileToCacheFails()
+    public function addingFileToCacheFails(): void
     {
         $this->expectException(InvalidArgumentException::class);
 

tests/bitExpert/PHPStan/Magento/Autoload/Cache/FileCacheStorageUnitTest.php

@@ -36,7 +36,7 @@ public function setUp(): void
     /**
      * @test
      */
-    public function autoloaderIgnoresClassesWithoutFactoryPostfix()
+    public function autoloaderIgnoresClassesWithoutFactoryPostfix(): void
     {
         $this->storage->expects($this->never())
             ->method('load');
@@ -47,7 +47,7 @@ public function autoloaderIgnoresClassesWithoutFactoryPostfix()
     /**
      * @test
      */
-    public function autoloaderUsesCachedFileWhenFound()
+    public function autoloaderUsesCachedFileWhenFound(): void
     {
         $this->storage->expects($this->once())
             ->method('load')
@@ -61,7 +61,7 @@ public function autoloaderUsesCachedFileWhenFound()
     /**
      * @test
      */
-    public function autoloaderGeneratesCacheFileWhenNotFoundInCache()
+    public function autoloaderGeneratesCacheFileWhenNotFoundInCache(): void
     {
         $this->storage->expects($this->atMost(2))
             ->method('load')