Merge pull request #562 from uzulla/use-phpstan

Add PHPStan Static Analysis (Level Max + Strict Rules)

Author: Vitorinox

.github/workflows/test.yml

@@ -42,3 +42,29 @@ jobs:
 
             - name: Tests
               run: composer test
+
+    phpstan:
+        name: PHPStan Static Analysis
+        runs-on: ubuntu-latest
+
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v4
+
+            - name: Install PHP
+              uses: shivammathur/setup-php@v2
+              with:
+                  php-version: 8.4
+
+            - name: Cache PHP dependencies
+              uses: actions/cache@v4
+              with:
+                  path: vendor
+                  key: ${{ runner.os }}-php-8.4-composer-${{ hashFiles('**/composer.json') }}
+                  restore-keys: ${{ runner.os }}-php-8.4-composer-
+
+            - name: Install dependencies
+              run: composer install
+
+            - name: Run PHPStan
+              run: composer phpstan

composer.json

@@ -42,7 +42,9 @@
         "nyholm/psr7": "^1.2",
         "oscarotero/php-cs-fixer-config": "^1.0",
         "brick/varexporter": "^0.3.1",
-        "symfony/css-selector": "^5.0"
+        "symfony/css-selector": "^5.0",
+        "phpstan/phpstan": "^2.1",
+        "phpstan/phpstan-strict-rules": "^2.0"
     },
     "suggest": {
         "symfony/css-selector": "If you want to get elements using css selectors"
@@ -64,6 +66,7 @@
         "demo": "php -S localhost:8888 demo/index.php",
         "test": "phpunit",
         "cs-fix": "php-cs-fixer fix",
+        "phpstan": "phpstan --memory-limit=-1",
         "update-resources": [
             "php scripts/update-oembed.php",
             "php scripts/update-suffix.php"

phpstan.dist.neon

@@ -0,0 +1,15 @@
+includes:
+    - vendor/phpstan/phpstan-strict-rules/rules.neon
+
+parameters:
+    level: max
+    paths:
+        - src
+#        - tests
+    excludePaths:
+        - tests/cache
+        - tests/fixtures
+    checkMissingCallableSignature: true
+    checkUninitializedProperties: true
+    checkTooWideReturnTypesInProtectedAndPublicMethods: true
+    checkImplicitMixed: true

src/Adapters/Archive/Api.php

@@ -9,6 +9,9 @@ class Api
 {
     use HttpApiTrait;
 
+    /**
+     * @return array<string, mixed>
+     */
     protected function fetchData(): array
     {
         $this->endpoint = $this->extractor->getUri()->withQuery('output=json');

src/Adapters/Archive/Detectors/AuthorName.php

@@ -3,15 +3,18 @@
 
 namespace Embed\Adapters\Archive\Detectors;
 
+use Embed\Adapters\Archive\Extractor;
 use Embed\Detectors\AuthorName as Detector;
 
 class AuthorName extends Detector
 {
     public function detect(): ?string
     {
-        $api = $this->extractor->getApi();
+        /** @var Extractor $extractor */
+        $extractor = $this->extractor;
+        $api = $extractor->getApi();
 
-        return $api->str('metadata', 'creator')
-            ?: parent::detect();
+        $result = $api->str('metadata', 'creator');
+        return (is_string($result) && trim($result) !== '') ? $result : parent::detect();
     }
 }

src/Adapters/Archive/Detectors/Description.php

@@ -3,15 +3,18 @@
 
 namespace Embed\Adapters\Archive\Detectors;
 
+use Embed\Adapters\Archive\Extractor;
 use Embed\Detectors\Description as Detector;
 
 class Description extends Detector
 {
     public function detect(): ?string
     {
-        $api = $this->extractor->getApi();
+        /** @var Extractor $extractor */
+        $extractor = $this->extractor;
+        $api = $extractor->getApi();
 
-        return $api->str('metadata', 'extract')
-            ?: parent::detect();
+        $result = $api->str('metadata', 'extract');
+        return (is_string($result) && trim($result) !== '') ? $result : parent::detect();
     }
 }

src/Adapters/Archive/Detectors/PublishedTime.php

@@ -4,17 +4,25 @@
 namespace Embed\Adapters\Archive\Detectors;
 
 use DateTime;
+use Embed\Adapters\Archive\Extractor;
 use Embed\Detectors\PublishedTime as Detector;
 
 class PublishedTime extends Detector
 {
     public function detect(): ?DateTime
     {
-        $api = $this->extractor->getApi();
+        /** @var Extractor $extractor */
+        $extractor = $this->extractor;
+        $api = $extractor->getApi();
 
-        return $api->time('metadata', 'publicdate')
-            ?: $api->time('metadata', 'addeddate')
-            ?: $api->time('metadata', 'date')
-            ?: parent::detect();
+        $fields = ['publicdate', 'addeddate', 'date'];
+        foreach ($fields as $field) {
+            $result = $api->time('metadata', $field);
+            if ($result !== null) {
+                return $result;
+            }
+        }
+
+        return parent::detect();
     }
 }

src/Adapters/Archive/Detectors/Title.php

@@ -3,15 +3,18 @@
 
 namespace Embed\Adapters\Archive\Detectors;
 
+use Embed\Adapters\Archive\Extractor;
 use Embed\Detectors\Title as Detector;
 
 class Title extends Detector
 {
     public function detect(): ?string
     {
-        $api = $this->extractor->getApi();
+        /** @var Extractor $extractor */
+        $extractor = $this->extractor;
+        $api = $extractor->getApi();
 
-        return $api->str('metadata', 'title')
-            ?: parent::detect();
+        $result = $api->str('metadata', 'title');
+        return (is_string($result) && trim($result) !== '') ? $result : parent::detect();
     }
 }

src/Adapters/Archive/Extractor.php

@@ -4,20 +4,35 @@
 namespace Embed\Adapters\Archive;
 
 use Embed\Extractor as Base;
+use Embed\Http\Crawler;
+use Psr\Http\Message\RequestInterface;
+use Psr\Http\Message\ResponseInterface;
+use Psr\Http\Message\UriInterface;
 
 class Extractor extends Base
 {
     private Api $api;
 
+    public function __construct(
+        UriInterface $uri,
+        RequestInterface $request,
+        ResponseInterface $response,
+        Crawler $crawler
+    ) {
+        parent::__construct($uri, $request, $response, $crawler);
+        $this->api = new Api($this);
+    }
+
     public function getApi(): Api
     {
         return $this->api;
     }
 
+    /**
+     * @return array<string, \Embed\Detectors\Detector>
+     */
     public function createCustomDetectors(): array
     {
-        $this->api = new Api($this);
-
         return [
             'title' => new Detectors\Title($this),
             'description' => new Detectors\Description($this),

src/Adapters/Bandcamp/Extractor.php

@@ -7,6 +7,9 @@
 
 class Extractor extends Base
 {
+    /**
+     * @return array<string, \Embed\Detectors\Detector>
+     */
     public function createCustomDetectors(): array
     {
         return [