refactor owner to owner factories, with a simple owner value object (#7)

* refactor owner to owner factories, with a simple owner value object
* remove obsolete toString method

Author: temp

composer.json

@@ -16,7 +16,12 @@
     "require-dev": {
         "mikey179/vfsStream": "^1.2",
         "phpunit/phpunit": "^6.0",
-        "symfony/http-foundation": "^2.8|^3.0"
+        "symfony/http-foundation": "^2.8|^3.0",
+        "symfony/security-core": "^2.8|^3.0"
+    },
+    "suggest": {
+        "symfony/http-foundation": "If you want to use the SymfonySessionOwnerFactory",
+        "symfony/security-core": "If you want to use the SymfonyTokenOwnerFactory"
     },
     "autoload": {
         "psr-4": { "Brainbits\\Blocking\\": "src/" }

src/Block.php

@@ -13,7 +13,7 @@
 
 namespace Brainbits\Blocking;
 
-use Brainbits\Blocking\Identifier\IdentifierInterface;
+use Brainbits\Blocking\Identity\IdentityInterface;
 use Brainbits\Blocking\Owner\OwnerInterface;
 use DateTimeImmutable;
 
@@ -27,15 +27,15 @@ class Block implements BlockInterface
     private $createdAt;
     private $updatedAt;
 
-    public function __construct(IdentifierInterface $identifier, OwnerInterface $owner, DateTimeImmutable $createdAt)
+    public function __construct(IdentityInterface $identifier, OwnerInterface $owner, DateTimeImmutable $createdAt)
     {
         $this->identifier = $identifier;
         $this->owner = $owner;
         $this->createdAt = $createdAt;
         $this->updatedAt = $createdAt;
     }
 
-    public function getIdentifier(): IdentifierInterface
+    public function getIdentity(): IdentityInterface
     {
         return $this->identifier;
     }

src/BlockInterface.php

@@ -13,7 +13,7 @@
 
 namespace Brainbits\Blocking;
 
-use Brainbits\Blocking\Identifier\IdentifierInterface;
+use Brainbits\Blocking\Identity\IdentityInterface;
 use Brainbits\Blocking\Owner\OwnerInterface;
 use DateTimeImmutable;
 
@@ -22,7 +22,7 @@
  */
 interface BlockInterface
 {
-    public function getIdentifier(): IdentifierInterface;
+    public function getIdentity(): IdentityInterface;
 
     public function getOwner(): OwnerInterface;
 

src/BlockableInterface.php

@@ -13,7 +13,7 @@
 
 namespace Brainbits\Blocking;
 
-use Brainbits\Blocking\Identifier\IdentifierInterface;
+use Brainbits\Blocking\Identity\IdentityInterface;
 
 /**
  * Blockable interface.
@@ -23,7 +23,7 @@ interface BlockableInterface
     /**
      * Return block identifier
      *
-     * @return IdentifierInterface
+     * @return IdentityInterface
      */
     public function getBlockIdentifier();
 }

src/Blocker.php

@@ -13,10 +13,10 @@
 
 namespace Brainbits\Blocking;
 
-use Brainbits\Blocking\Storage\StorageInterface;
 use Brainbits\Blocking\Exception\BlockFailedException;
-use Brainbits\Blocking\Identifier\IdentifierInterface;
-use Brainbits\Blocking\Owner\OwnerInterface;
+use Brainbits\Blocking\Identity\IdentityInterface;
+use Brainbits\Blocking\Owner\OwnerFactoryInterface;
+use Brainbits\Blocking\Storage\StorageInterface;
 use Brainbits\Blocking\Validator\ValidatorInterface;
 use DateTimeImmutable;
 
@@ -26,17 +26,17 @@
 class Blocker
 {
     private $storage;
-    private $owner;
+    private $ownerFactory;
     private $validator;
 
-    public function __construct(StorageInterface $adapter, OwnerInterface $owner, ValidatorInterface $validator)
+    public function __construct(StorageInterface $adapter, OwnerFactoryInterface $ownerFactory, ValidatorInterface $validator)
     {
         $this->storage = $adapter;
-        $this->owner = $owner;
+        $this->ownerFactory = $ownerFactory;
         $this->validator = $validator;
     }
 
-    public function block(IdentifierInterface $identifier): BlockInterface
+    public function block(IdentityInterface $identifier): BlockInterface
     {
         $block = $this->tryBlock($identifier);
 
@@ -47,27 +47,28 @@ public function block(IdentifierInterface $identifier): BlockInterface
         return $block;
     }
 
-    public function tryBlock(IdentifierInterface $identifier): ?BlockInterface
+    public function tryBlock(IdentityInterface $identifier): ?BlockInterface
     {
+        $owner = $this->ownerFactory->createOwner();
+
         if ($this->isBlocked($identifier)) {
             $block = $this->getBlock($identifier);
-            if (!$block->isOwnedBy($this->owner)) {
+            if (!$block->isOwnedBy($owner)) {
                 return null;
             }
             $this->storage->touch($block);
 
             return $block;
         }
 
-        $block = new Block($identifier, $this->owner, new DateTimeImmutable());
+        $block = new Block($identifier, $owner, new DateTimeImmutable());
 
         $this->storage->write($block);
 
         return $block;
     }
 
-
-    public function unblock(IdentifierInterface $identifier): ?BlockInterface
+    public function unblock(IdentityInterface $identifier): ?BlockInterface
     {
         $block = $this->getBlock($identifier);
         if (null === $block) {
@@ -79,7 +80,7 @@ public function unblock(IdentifierInterface $identifier): ?BlockInterface
         return $block;
     }
 
-    public function isBlocked(IdentifierInterface $identifier): bool
+    public function isBlocked(IdentityInterface $identifier): bool
     {
         $exists = $this->storage->exists($identifier);
 
@@ -99,7 +100,7 @@ public function isBlocked(IdentifierInterface $identifier): bool
         return false;
     }
 
-    public function getBlock(IdentifierInterface $identifier): ?BlockInterface
+    public function getBlock(IdentityInterface $identifier): ?BlockInterface
     {
         if (!$this->isBlocked($identifier)) {
             return null;

src/Exception/BlockFailedException.php

@@ -13,14 +13,14 @@
 
 namespace Brainbits\Blocking\Exception;
 
-use Brainbits\Blocking\Identifier\IdentifierInterface;
+use Brainbits\Blocking\Identity\IdentityInterface;
 
 /**
  * Block failed exception.
  */
 class BlockFailedException extends RuntimeException
 {
-    public static function createAlreadyBlocked(IdentifierInterface $identifier): self
+    public static function createAlreadyBlocked(IdentityInterface $identifier): self
     {
         return new self("Identifier $identifier is already blocked.");
     }

src/Exception/NoTokenFoundException.php

@@ -0,0 +1,25 @@
+<?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;
+
+/**
+ * No token found exception.
+ */
+class NoTokenFoundException extends RuntimeException
+{
+    public static function create(): self
+    {
+        return new self("No token found.");
+    }
+}

src/Exception/NoUserFoundException.php

@@ -0,0 +1,25 @@
+<?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;
+
+/**
+ * No user found exception.
+ */
+class NoUserFoundException extends RuntimeException
+{
+    public static function create(): self
+    {
+        return new self("No user found.");
+    }
+}

src/Identifier/Identifier.php src/Identity/Identity.phpsrc/Identifier/Identifier.php renamed to src/Identity/Identity.php

@@ -11,27 +11,27 @@
  * file that was distributed with this source code.
  */
 
-namespace Brainbits\Blocking\Identifier;
+namespace Brainbits\Blocking\Identity;
 
 /**
  * Standard identifier.
  */
-class Identifier implements IdentifierInterface
+class Identity implements IdentityInterface
 {
-    private $identifier;
+    private $identityValue;
 
-    public function __construct(string $identifier)
+    public function __construct(string $identityValue)
     {
-        $this->identifier = $identifier;
+        $this->identityValue = $identityValue;
     }
 
-    public function equals(IdentifierInterface $identifier): bool
+    public function equals(IdentityInterface $identifier): bool
     {
-        return (string) $identifier === (string) $this->identifier;
+        return (string) $identifier === (string) $this;
     }
 
     public function __toString(): string
     {
-        return $this->identifier;
+        return $this->identityValue;
     }
 }

src/Identifier/IdentifierInterface.php src/Identity/IdentityInterface.phpsrc/Identifier/IdentifierInterface.php renamed to src/Identity/IdentityInterface.php

@@ -11,14 +11,14 @@
  * file that was distributed with this source code.
  */
 
-namespace Brainbits\Blocking\Identifier;
+namespace Brainbits\Blocking\Identity;
 
 /**
- * Block identifier interface.
+ * Block identity interface.
  */
-interface IdentifierInterface
+interface IdentityInterface
 {
-    public function equals(IdentifierInterface $identifier): bool;
+    public function equals(IdentityInterface $identifier): bool;
 
     public function __toString(): string;
 }