Merge pull request #21 from stof/phpstan

Add phpstan

Author: stof

.github/workflows/ci.yml

@@ -16,6 +16,19 @@ jobs:
                   php-version: '8.0'
             - run: composer validate --strict --no-check-lock
 
+    static_analysis:
+        name: Static analysis
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v2
+            - uses: shivammathur/setup-php@v2
+              with:
+                  coverage: none
+                  php-version: '8.0'
+            - name: Install dependencies
+              run: composer update --ansi --no-progress --prefer-dist --no-interaction
+            - run: vendor/bin/phpstan analyze
+
     tests:
         name: "Tests on PHP ${{ matrix.php }}${{ matrix.name_suffix }}"
         runs-on: ubuntu-latest

composer.json

@@ -21,7 +21,12 @@
         "symfony/http-kernel": "^4.4.13 || ^5.3 || ^6.0"
     },
     "require-dev": {
+        "jangregor/phpstan-prophecy": "^1.0",
         "phpspec/prophecy-phpunit": "^2.0",
+        "phpstan/phpstan": "^1.5",
+        "phpstan/phpstan-deprecation-rules": "^1.0",
+        "phpstan/phpstan-phpunit": "^1.0",
+        "phpstan/phpstan-symfony": "^1.1",
         "phpunit/phpunit": "^9.5",
         "symfony/phpunit-bridge": "^5.3 || ^6.0"
     },

phpstan.neon

@@ -0,0 +1,16 @@
+parameters:
+    level: max
+    paths:
+        - src/
+        - tests/
+    ignoreErrors:
+        - '#^Method Incenteev\\HashedAssetBundle\\Tests\\[^:]++\:\:test\w++\(\) has no return type specified\.$#'
+        - '#^Method Incenteev\\HashedAssetBundle\\Tests\\[^:]++\:\:get\w++\(\) has no return type specified\.$#'
+
+includes:
+    - vendor/phpstan/phpstan-deprecation-rules/rules.neon
+    - vendor/phpstan/phpstan-phpunit/extension.neon
+    - vendor/phpstan/phpstan-phpunit/rules.neon
+    - vendor/phpstan/phpstan-symfony/extension.neon
+    - vendor/phpstan/phpstan-symfony/rules.neon
+    - vendor/jangregor/phpstan-prophecy/extension.neon

src/Asset/HashingVersionStrategy.php

@@ -16,11 +16,17 @@ public function __construct(AssetHasherInterface $hasher, string $format = null)
         $this->hasher = $hasher;
     }
 
+    /**
+     * @param string $path
+     */
     public function getVersion($path): string
     {
         return $this->hasher->computeHash($path);
     }
 
+    /**
+     * @param string $path
+     */
     public function applyVersion($path): string
     {
         $versionized = sprintf($this->format, ltrim($path, '/'), $this->hasher->computeHash($path));

src/CacheWarmer/AssetFinder.php

@@ -17,6 +17,9 @@ public function __construct(string $webRoot)
         $this->webRoot = $webRoot;
     }
 
+    /**
+     * @return \Traversable<string>
+     */
     public function getAssetPaths(): \Traversable
     {
         $finder = (new Finder())->files()

src/CacheWarmer/HashCacheWarmer.php

@@ -31,6 +31,11 @@ public function __construct(AssetFinder $assetFinder, string $cacheFile, AssetHa
         $this->fallbackPool = $fallbackPool;
     }
 
+    /**
+     * @param string $cacheDir
+     *
+     * @return string[]
+     */
     public function warmUp($cacheDir): array
     {
         $phpArrayPool = new PhpArrayAdapter($this->cacheFile, $this->fallbackPool);

src/DependencyInjection/IncenteevHashedAssetExtension.php

@@ -10,9 +10,9 @@
 class IncenteevHashedAssetExtension extends ConfigurableExtension
 {
     /**
-     * {@inheritdoc}
+     * @param array{web_root: string, version_format: string} $config
      */
-    protected function loadInternal(array $config, ContainerBuilder $container)
+    protected function loadInternal(array $config, ContainerBuilder $container): void
     {
         $loader = new XmlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
         $loader->load('services.xml');

src/Hashing/CachedHasher.php

@@ -21,7 +21,11 @@ public function computeHash(string $path): string
         $item = $this->cache->getItem(base64_encode(ltrim($path, '/')));
 
         if ($item->isHit()) {
-            return $item->get();
+            $cachedHash = $item->get();
+
+            if (\is_string($cachedHash)) {
+                return $cachedHash;
+            }
         }
 
         $hash = $this->hasher->computeHash($path);

src/Hashing/FileHasher.php

@@ -19,6 +19,12 @@ public function computeHash(string $path): string
             return '';
         }
 
-        return substr(sha1_file($fullPath), 0, 7);
+        $hash = sha1_file($fullPath);
+
+        if ($hash === false) {
+            return '';
+        }
+
+        return substr($hash, 0, 7);
     }
 }

tests/Asset/HashingVersionStrategyTest.php

@@ -24,7 +24,7 @@ public function testGetVersion()
     /**
      * @dataProvider getVersionedAssets
      */
-    public function testApplyVersion($path, $expected, $hash, $format = null)
+    public function testApplyVersion(string $path, string $expected, string $hash, ?string $format = null)
     {
         $hasher = $this->prophesize(AssetHasherInterface::class);
         $hasher->computeHash($path)->willReturn($hash);

tests/DependencyInjection/IncenteevHashedAssetExtensionTest.php

@@ -65,7 +65,7 @@ public function testNonDebugMode()
         $this->assertEquals('/var/html/test', $assetFinderDef->getArgument(0));
     }
 
-    private function assertHasDefinition(ContainerBuilder $containerBuilder, string $id)
+    private function assertHasDefinition(ContainerBuilder $containerBuilder, string $id): void
     {
         $this->assertTrue($containerBuilder->hasDefinition($id), sprintf('The container has a `%s` service definition.', $id));
     }

tests/Hashing/FileHasherTest.php

@@ -10,7 +10,7 @@ class FileHasherTest extends TestCase
     /**
      * @dataProvider getAssetVersions
      */
-    public function testComputeHash($path, $version)
+    public function testComputeHash(string $path, string $version)
     {
         $versionStrategy = new FileHasher(__DIR__.'/fixtures');