fix: add phpstan and fix warnings

Author: timonf

.github/workflows/test.yml

@@ -47,3 +47,6 @@ jobs:
 
       - name: "Coding style"
         run: "vendor/bin/phpcs --report=summary"
+
+      - name: "Static analysis"
+        run: "vendor/bin/phpstan --no-progress"

composer.json

@@ -21,7 +21,9 @@
         "phpspec/prophecy": "^1.14",
         "phpspec/prophecy-phpunit": "^2.0.1",
         "squizlabs/php_codesniffer": "^3.6",
-        "brainbits/phpcs-standard": "^5.0"
+        "brainbits/phpcs-standard": "^5.0",
+        "phpstan/phpstan": "^0.12.99",
+        "brainbits/phpstan-rules": "^2.0"
     },
     "suggest": {
         "symfony/http-foundation": "If you want to use the SymfonySessionOwnerFactory",

phpstan.neon

@@ -0,0 +1,8 @@
+parameters:
+    level: 8
+    paths:
+        - src
+    bootstrapFiles:
+        - vendor/autoload.php
+includes:
+    - vendor/brainbits/phpstan-rules/rules.neon

src/Block.php

@@ -16,7 +16,6 @@
 use Brainbits\Blocking\Identity\IdentityInterface;
 use Brainbits\Blocking\Owner\OwnerInterface;
 use DateTimeImmutable;
-use DateTimeInterface;
 
 /**
  * Standard block.
@@ -25,8 +24,8 @@ class Block implements BlockInterface
 {
     private IdentityInterface $identifier;
     private OwnerInterface $owner;
-    private DateTimeInterface $createdAt;
-    private DateTimeInterface $updatedAt;
+    private DateTimeImmutable $createdAt;
+    private DateTimeImmutable $updatedAt;
 
     public function __construct(IdentityInterface $identifier, OwnerInterface $owner, DateTimeImmutable $createdAt)
     {

src/Blocker.php

@@ -56,7 +56,8 @@ public function tryBlock(IdentityInterface $identifier): ?BlockInterface
 
         if ($this->isBlocked($identifier)) {
             $block = $this->getBlock($identifier);
-            if (!$block->isOwnedBy($owner)) {
+
+            if (!$block || !$block->isOwnedBy($owner)) {
                 return null;
             }
 
@@ -86,13 +87,12 @@ public function unblock(IdentityInterface $identifier): ?BlockInterface
 
     public function isBlocked(IdentityInterface $identifier): bool
     {
-        $exists = $this->storage->exists($identifier);
+        $block = $this->storage->get($identifier);
 
-        if (!$exists) {
+        if (!$block) {
             return false;
         }
 
-        $block = $this->storage->get($identifier);
         $valid = $this->validator->validate($block);
 
         if ($valid) {

src/Exception/UnserializeFailedException.php

@@ -13,25 +13,23 @@
 
 namespace Brainbits\Blocking\Exception;
 
-use Throwable;
-
 /**
  * Unserialize failed exception.
  */
 final class UnserializeFailedException extends RuntimeException
 {
     private string $input;
 
-    public function __construct(string $message, ?int $code, ?Throwable $previous, string $input)
+    private function __construct(string $message, string $input)
     {
-        parent::__construct($message, $code, $previous);
+        parent::__construct($message);
 
         $this->input = $input;
     }
 
     public static function createFromInput(mixed $input): self
     {
-        return new self('Unserialize failed.', null, null, (string) $input);
+        return new self('Unserialize failed.', (string) $input);
     }
 
     public function getInput(): string

src/Owner/SymfonyTokenOwnerFactory.php

@@ -16,6 +16,7 @@
 use Brainbits\Blocking\Exception\NoTokenFoundException;
 use Brainbits\Blocking\Exception\NoUserFoundException;
 use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
+use Symfony\Component\Security\Core\User\UserInterface;
 
 /**
  * Symfony token owner.
@@ -37,7 +38,7 @@ public function createOwner(): OwnerInterface
         }
 
         $user = $token->getUser();
-        if (!$user) {
+        if (!$user instanceof UserInterface) {
             throw NoUserFoundException::create();
         }
 

src/Storage/FilesystemStorage.php

@@ -68,6 +68,10 @@ public function touch(BlockInterface $block): bool
 
         $updatedAt = DateTimeImmutable::createFromFormat('U', (string) filemtime($filename));
 
+        if (!$updatedAt) {
+            throw IOException::createTouchFailed($filename);
+        }
+
         $block->touch($updatedAt);
 
         return true;
@@ -104,9 +108,14 @@ public function get(IdentityInterface $identifier): ?BlockInterface
 
         $filename = $this->getFilename($identifier);
         $content = file_get_contents($filename);
+
+        if (!$content) {
+            throw UnserializeFailedException::createFromInput($content);
+        }
+
         $updatedAt = DateTimeImmutable::createFromFormat('U', (string) filemtime($filename));
         $block = unserialize($content);
-        if (!$block) {
+        if (!$block instanceof BlockInterface || !$updatedAt) {
             throw UnserializeFailedException::createFromInput($content);
         }
 

tests/BlockerTest.php

@@ -257,6 +257,8 @@ private function createNonexistingStorage()
         $storage = $this->prophesize(StorageInterface::class);
         $storage->exists(Argument::type(IdentityInterface::class))
             ->willReturn(false);
+        $storage->get(Argument::type(IdentityInterface::class))
+            ->willReturn(null);
 
         return $storage;
     }