Merge pull request #11 from brainbits/feature/symfony6

feat: Rework for symfony 6, drop PHP 7.4 support

Author: jojoguru

.github/workflows/test.yml

@@ -16,7 +16,6 @@ jobs:
       matrix:
         dependencies: ["lowest", "highest"]
         php-version:
-          - "7.4"
           - "8.0"
           - "8.1"
         operating-system: ["ubuntu-latest"]

composer.json

@@ -11,18 +11,18 @@
         }
     ],
     "require": {
-        "php": "^7.4|^8.0"
+        "php": "^8.0"
     },
     "require-dev": {
         "mikey179/vfsstream": "^1.6.10",
         "phpunit/phpunit": "^9.5",
-        "symfony/http-foundation": ">=4.4",
-        "symfony/security-core": ">=4.4",
+        "symfony/http-foundation": "^5.4|^6.0",
+        "symfony/security-core": "^5.4|^6.0",
         "phpspec/prophecy-phpunit": "^2.0.1",
         "squizlabs/php_codesniffer": "^3.6",
         "brainbits/phpcs-standard": "^5.0",
-        "phpstan/phpstan": "^0.12.99",
-        "brainbits/phpstan-rules": "^2.0"
+        "phpstan/phpstan": "^1.0",
+        "brainbits/phpstan-rules": "^3.0"
     },
     "suggest": {
         "symfony/http-foundation": "If you want to use the SymfonySessionOwnerFactory",
@@ -38,5 +38,10 @@
         "branch-alias": {
             "dev-master": "4.0-dev"
         }
+    },
+    "config": {
+        "allow-plugins": {
+            "dealerdirect/phpcodesniffer-composer-installer": true
+        }
     }
 }

src/Exception/NoSessionException.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the brainbits blocking package.
+ *
+ * (c) brainbits GmbH (http://www.brainbits.net)
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Brainbits\Blocking\Exception;
+
+class NoSessionException extends RuntimeException
+{
+    public static function create(): self
+    {
+        return new self('No session.');
+    }
+}

src/Exception/UnserializeFailedException.php

@@ -13,6 +13,9 @@
 
 namespace Brainbits\Blocking\Exception;
 
+use function gettype;
+use function is_scalar;
+
 /**
  * Unserialize failed exception.
  */
@@ -29,7 +32,7 @@ private function __construct(string $message, string $input)
 
     public static function createFromInput(mixed $input): self
     {
-        return new self('Unserialize failed.', (string) $input);
+        return new self('Unserialize failed.', is_scalar($input) ? (string) $input : gettype($input));
     }
 
     public function getInput(): string

src/Owner/SymfonySessionOwnerFactory.php

@@ -13,22 +13,35 @@
 
 namespace Brainbits\Blocking\Owner;
 
+use Brainbits\Blocking\Exception\NoSessionException;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\RequestStack;
 use Symfony\Component\HttpFoundation\Session\SessionInterface;
 
 /**
  * Symfony session owner factory.
  */
 class SymfonySessionOwnerFactory implements OwnerFactoryInterface
 {
-    private SessionInterface $session;
+    private RequestStack $requestStack;
 
-    public function __construct(SessionInterface $session)
+    public function __construct(RequestStack $requestStack)
     {
-        $this->session = $session;
+        $this->requestStack = $requestStack;
     }
 
     public function createOwner(): OwnerInterface
     {
-        return new Owner($this->session->getId());
+        $request = $this->requestStack->getCurrentRequest();
+        if (!$request instanceof Request) {
+            throw NoSessionException::create();
+        }
+
+        $session = $request->getSession();
+        if (!$session instanceof SessionInterface) {
+            throw NoSessionException::create();
+        }
+
+        return new Owner($session->getId());
     }
 }

src/Owner/SymfonyTokenOwnerFactory.php

@@ -42,6 +42,6 @@ public function createOwner(): OwnerInterface
             throw NoUserFoundException::create();
         }
 
-        return new Owner($user->getUsername());
+        return new Owner($user->getUserIdentifier());
     }
 }

tests/Owner/SymfonySessionOwnerFactoryTest.php

@@ -15,6 +15,8 @@
 use Brainbits\Blocking\Owner\SymfonySessionOwnerFactory;
 use PHPUnit\Framework\TestCase;
 use Prophecy\PhpUnit\ProphecyTrait;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\RequestStack;
 use Symfony\Component\HttpFoundation\Session\SessionInterface;
 
 /**
@@ -26,7 +28,14 @@ class SymfonySessionOwnerFactoryTest extends TestCase
 
     public function testToString(): void
     {
-        $factory = new SymfonySessionOwnerFactory($this->createSession('foo'));
+        $request = new Request();
+        $request->setSession($this->createSession('foo'));
+
+        $requestStack = new RequestStack();
+        $requestStack->push($request);
+
+        $factory = new SymfonySessionOwnerFactory($requestStack);
+
         $owner = $factory->createOwner();
 
         $this->assertEquals($owner, new Owner('foo'));

tests/Owner/SymfonyTokenOwnerFactoryTest.php

@@ -60,7 +60,7 @@ public function testE2(): void
     private function createTokenStorage(string $username, bool $createToken = true, bool $createUser = true)
     {
         $user = $this->prophesize(UserInterface::class);
-        $user->getUsername()
+        $user->getUserIdentifier()
             ->willReturn($username);
 
         $token = $this->prophesize(TokenInterface::class);