Moved Password\PasswordProtectedInterface & CredentialInterface to Credential\ (#308)

ro0NL · web-flow · commit d456a6e2bbd5 · 2019-03-23T17:17:30.000+01:00
diff --git a/Credential/Anonymous.php b/Credential/Anonymous.php
@@ -4,20 +4,25 @@
 
 namespace MsgPhp\User\Credential;
 
-use MsgPhp\User\CredentialInterface;
+use MsgPhp\User\Event\Domain\ChangeCredentialEvent;
 
 /**
  * @author Roland Franssen <franssen.roland@gmail.com>
  */
 final class Anonymous implements CredentialInterface
 {
+    public function __invoke(ChangeCredentialEvent $event): bool
+    {
+        throw new \BadMethodCallException('An anonymous credential cannot be changed.');
+    }
+
     public static function getUsernameField(): string
     {
-        throw new \LogicException('An anonymous credential has no username field.');
+        throw new \BadMethodCallException('An anonymous credential has no username field.');
     }
 
     public function getUsername(): string
     {
-        throw new \LogicException('An anonymous credential has no username.');
+        throw new \BadMethodCallException('An anonymous credential has no username.');
     }
 }
diff --git a/Credential/CredentialInterface.php b/Credential/CredentialInterface.php
@@ -2,13 +2,17 @@
 
 declare(strict_types=1);
 
-namespace MsgPhp\User;
+namespace MsgPhp\User\Credential;
+
+use MsgPhp\User\Event\Domain\ChangeCredentialEvent;
 
 /**
  * @author Roland Franssen <franssen.roland@gmail.com>
  */
 interface CredentialInterface
 {
+    public function __invoke(ChangeCredentialEvent $event): bool;
+
     public static function getUsernameField(): string;
 
     public function getUsername(): string;
diff --git a/Credential/Email.php b/Credential/Email.php
@@ -4,8 +4,6 @@
 
 namespace MsgPhp\User\Credential;
 
-use MsgPhp\User\Credential\Features\EmailAsUsername;
-use MsgPhp\User\CredentialInterface;
 use MsgPhp\User\Event\Domain\ChangeCredentialEvent;
 
 /**
diff --git a/Credential/EmailAsUsername.php b/Credential/EmailAsUsername.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace MsgPhp\User\Credential\Features;
+namespace MsgPhp\User\Credential;
 
 /**
  * @author Roland Franssen <franssen.roland@gmail.com>
diff --git a/Credential/EmailPassword.php b/Credential/EmailPassword.php
@@ -4,16 +4,12 @@
 
 namespace MsgPhp\User\Credential;
 
-use MsgPhp\User\Credential\Features\EmailAsUsername;
-use MsgPhp\User\Credential\Features\PasswordProtection;
-use MsgPhp\User\CredentialInterface;
 use MsgPhp\User\Event\Domain\ChangeCredentialEvent;
-use MsgPhp\User\Password\PasswordProtectedInterface;
 
 /**
  * @author Roland Franssen <franssen.roland@gmail.com>
  */
-final class EmailPassword implements CredentialInterface, PasswordProtectedInterface
+final class EmailPassword implements PasswordProtectedCredentialInterface
 {
     use EmailAsUsername;
     use PasswordProtection;
diff --git a/Credential/Nickname.php b/Credential/Nickname.php
@@ -4,8 +4,6 @@
 
 namespace MsgPhp\User\Credential;
 
-use MsgPhp\User\Credential\Features\NicknameAsUsername;
-use MsgPhp\User\CredentialInterface;
 use MsgPhp\User\Event\Domain\ChangeCredentialEvent;
 
 /**
diff --git a/Credential/NicknameAsUsername.php b/Credential/NicknameAsUsername.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace MsgPhp\User\Credential\Features;
+namespace MsgPhp\User\Credential;
 
 /**
  * @author Roland Franssen <franssen.roland@gmail.com>
diff --git a/Credential/NicknamePassword.php b/Credential/NicknamePassword.php
@@ -4,16 +4,12 @@
 
 namespace MsgPhp\User\Credential;
 
-use MsgPhp\User\Credential\Features\NicknameAsUsername;
-use MsgPhp\User\Credential\Features\PasswordProtection;
-use MsgPhp\User\CredentialInterface;
 use MsgPhp\User\Event\Domain\ChangeCredentialEvent;
-use MsgPhp\User\Password\PasswordProtectedInterface;
 
 /**
  * @author Roland Franssen <franssen.roland@gmail.com>
  */
-final class NicknamePassword implements CredentialInterface, PasswordProtectedInterface
+final class NicknamePassword implements PasswordProtectedCredentialInterface
 {
     use NicknameAsUsername;
     use PasswordProtection;
diff --git a/Credential/PasswordProtectedCredentialInterface.php b/Credential/PasswordProtectedCredentialInterface.php
@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace MsgPhp\User\Credential;
+
+use MsgPhp\User\Password\PasswordAlgorithm;
+
+/**
+ * Represents a password protected credential. The password is usually a *hashed* value (thus secret).
+ *
+ * @author Roland Franssen <franssen.roland@gmail.com>
+ */
+interface PasswordProtectedCredentialInterface extends CredentialInterface
+{
+    public function getPassword(): string;
+
+    public function getPasswordAlgorithm(): ?PasswordAlgorithm;
+}
diff --git a/Credential/PasswordProtection.php b/Credential/PasswordProtection.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace MsgPhp\User\Credential\Features;
+namespace MsgPhp\User\Credential;
 
 use MsgPhp\User\Password\PasswordAlgorithm;
 
diff --git a/Credential/Token.php b/Credential/Token.php
@@ -4,7 +4,6 @@
 
 namespace MsgPhp\User\Credential;
 
-use MsgPhp\User\CredentialInterface;
 use MsgPhp\User\Event\Domain\ChangeCredentialEvent;
 
 /**
diff --git a/Event/Domain/ChangeCredentialEvent.php b/Event/Domain/ChangeCredentialEvent.php
@@ -21,16 +21,16 @@ final public function __construct(array $fields)
         $this->fields = $fields;
     }
 
-    public function getStringField(string $field): string
+    public function getStringField(string $field, string $default = null): string
     {
-        if (!isset($this->fields[$field])) {
-            throw new \LogicException(sprintf('Field "%s" does not exists.', $field));
+        if (null === $value = $this->fields[$field] ?? $default) {
+            throw new \LogicException(sprintf('No value available for field "%s".', $field));
         }
 
-        if (!\is_string($this->fields[$field])) {
-            throw new \LogicException(sprintf('Field "%s" must be a string, got "%s".', $field, \gettype($this->fields[$field])));
+        if (!\is_string($value)) {
+            throw new \LogicException(sprintf('Field value for "%s" must be a string, got "%s".', $field, \gettype($value)));
         }
 
-        return $this->fields[$field];
+        return $value;
     }
 }
diff --git a/Event/UserCredentialChangedEvent.php b/Event/UserCredentialChangedEvent.php
@@ -4,7 +4,7 @@
 
 namespace MsgPhp\User\Event;
 
-use MsgPhp\User\CredentialInterface;
+use MsgPhp\User\Credential\CredentialInterface;
 use MsgPhp\User\User;
 
 /**
diff --git a/Infra/Doctrine/ObjectMappings.php b/Infra/Doctrine/ObjectMappings.php
@@ -30,8 +30,8 @@ final class ObjectMappings implements ObjectMappingProviderInterface
 
     public static function provideObjectMappings(MappingConfig $config): iterable
     {
-        foreach (self::CREDENTIALS as $object => $credential) {
-            yield $object => [
+        foreach (self::CREDENTIALS as $model => $credential) {
+            yield $model => [
                 'credential' => [
                     'type' => self::TYPE_EMBEDDED,
                     'class' => $credential,
@@ -40,6 +40,28 @@ public static function provideObjectMappings(MappingConfig $config): iterable
             ];
         }
 
+        yield Credential\EmailAsUsername::class => [
+            'email' => [
+                'type' => 'string',
+                'unique' => true,
+                'length' => $config->keyMaxLength,
+            ],
+        ];
+
+        yield Credential\NicknameAsUsername::class => [
+            'nickname' => [
+                'type' => 'string',
+                'unique' => true,
+                'length' => $config->keyMaxLength,
+            ],
+        ];
+
+        yield Credential\PasswordProtection::class => [
+            'password' => [
+                'type' => 'string',
+            ],
+        ];
+
         yield Model\ResettablePassword::class => [
             'passwordResetToken' => [
                 'type' => 'string',
diff --git a/Infra/Security/SecurityUser.php b/Infra/Security/SecurityUser.php
@@ -4,8 +4,8 @@
 
 namespace MsgPhp\User\Infra\Security;
 
+use MsgPhp\User\Credential\PasswordProtectedCredentialInterface;
 use MsgPhp\User\Password\PasswordAlgorithm;
-use MsgPhp\User\Password\PasswordProtectedInterface;
 use MsgPhp\User\User;
 use MsgPhp\User\UserIdInterface;
 use Symfony\Component\Security\Core\User\EquatableInterface;
@@ -57,7 +57,7 @@ public function __construct(User $user, string $originUsername = null, array $ro
 
         $credential = $user->getCredential();
 
-        if ($credential instanceof PasswordProtectedInterface) {
+        if ($credential instanceof PasswordProtectedCredentialInterface) {
             $this->password = $credential->getPassword();
             $this->passwordAlgorithm = $credential->getPasswordAlgorithm();
         }
diff --git a/Model/AbstractCredential.php b/Model/AbstractCredential.php
@@ -4,13 +4,11 @@
 
 namespace MsgPhp\User\Model;
 
-use MsgPhp\User\CredentialInterface;
+use MsgPhp\User\Credential\CredentialInterface;
 use MsgPhp\User\Event\Domain\ChangeCredentialEvent;
 
 /**
  * @author Roland Franssen <franssen.roland@gmail.com>
- *
- * @internal
  */
 trait AbstractCredential
 {
diff --git a/Model/AbstractPasswordCredential.php b/Model/AbstractPasswordCredential.php
@@ -4,21 +4,18 @@
 
 namespace MsgPhp\User\Model;
 
-use MsgPhp\User\CredentialInterface;
+use MsgPhp\User\Credential\PasswordProtectedCredentialInterface;
 use MsgPhp\User\Event\Domain\ChangeCredentialEvent;
-use MsgPhp\User\Password\PasswordProtectedInterface;
 
 /**
  * @author Roland Franssen <franssen.roland@gmail.com>
- *
- * @internal
  */
 trait AbstractPasswordCredential
 {
     use AbstractCredential;
 
     /**
-     * @var CredentialInterface&PasswordProtectedInterface
+     * @var PasswordProtectedCredentialInterface
      */
     private $credential;
 
diff --git a/Password/PasswordProtectedInterface.php b/Password/PasswordProtectedInterface.php
diff --git a/Tests/Infra/Doctrine/ObjectMappingsTest.php b/Tests/Infra/Doctrine/ObjectMappingsTest.php
@@ -5,6 +5,7 @@
 namespace MsgPhp\User\Tests\Infra\Doctrine;
 
 use MsgPhp\Domain\Infra\Doctrine\MappingConfig;
+use MsgPhp\User\Credential;
 use MsgPhp\User\Infra\Doctrine\ObjectMappings;
 use MsgPhp\User\Model;
 use PHPUnit\Framework\TestCase;
@@ -13,7 +14,12 @@ final class ObjectMappingsTest extends TestCase
 {
     public function testMapping(): void
     {
-        $available = array_flip(array_map(function (string $file): string {
+        $available = array_flip([
+            Credential\EmailAsUsername::class,
+            Credential\NicknameAsUsername::class,
+            Credential\PasswordProtection::class,
+        ]);
+        $available += array_flip(array_map(function (string $file): string {
             return 'MsgPhp\\User\\Model\\'.basename($file, '.php');
         }, glob(\dirname(__DIR__, 3).'/Model/*.php')));
         unset(
diff --git a/Tests/Infra/Security/SecurityUserProviderTest.php b/Tests/Infra/Security/SecurityUserProviderTest.php
@@ -5,7 +5,7 @@
 namespace MsgPhp\User\Tests\Infra\Security;
 
 use MsgPhp\Domain\Exception\EntityNotFoundException;
-use MsgPhp\User\CredentialInterface;
+use MsgPhp\User\Credential\CredentialInterface;
 use MsgPhp\User\Infra\Security\SecurityUser;
 use MsgPhp\User\Infra\Security\SecurityUserProvider;
 use MsgPhp\User\Repository\UserRepositoryInterface;
diff --git a/Tests/Infra/Security/SecurityUserTest.php b/Tests/Infra/Security/SecurityUserTest.php
@@ -4,10 +4,10 @@
 
 namespace MsgPhp\User\Tests\Infra\Security;
 
-use MsgPhp\User\CredentialInterface;
+use MsgPhp\User\Credential\CredentialInterface;
+use MsgPhp\User\Credential\PasswordProtectedCredentialInterface;
 use MsgPhp\User\Infra\Security\SecurityUser;
 use MsgPhp\User\Password\PasswordAlgorithm;
-use MsgPhp\User\Password\PasswordProtectedInterface;
 use MsgPhp\User\Password\PasswordSalt;
 use MsgPhp\User\ScalarUserId;
 use MsgPhp\User\User;
@@ -122,7 +122,7 @@ private function createUser(string $password = null, PasswordAlgorithm $password
         if (null === $password) {
             $credential = $this->createMock(CredentialInterface::class);
         } else {
-            $credential = $this->createMock([CredentialInterface::class, PasswordProtectedInterface::class]);
+            $credential = $this->createMock(PasswordProtectedCredentialInterface::class);
             $credential->expects(self::any())
                 ->method('getPassword')
                 ->willReturn($password)
diff --git a/User.php b/User.php
@@ -5,6 +5,7 @@
 namespace MsgPhp\User;
 
 use MsgPhp\User\Credential\Anonymous;
+use MsgPhp\User\Credential\CredentialInterface;
 
 /**
  * @author Roland Franssen <franssen.roland@gmail.com>

Original file line number	Diff line number	Diff line change
`@@ -4,20 +4,25 @@`
`4`	`4`
`5`	`5`	`namespace MsgPhp\User\Credential;`
`6`	`6`
`7`		`-use MsgPhp\User\CredentialInterface;`
	`7`	`+use MsgPhp\User\Event\Domain\ChangeCredentialEvent;`
`8`	`8`
`9`	`9`	`/**`
`10`	`10`	`* @author Roland Franssen <[email protected]>`
`11`	`11`	`*/`
`12`	`12`	`final class Anonymous implements CredentialInterface`
`13`	`13`	`{`
	`14`	`+ public function __invoke(ChangeCredentialEvent $event): bool`
	`15`	`+ {`
	`16`	`+ throw new \BadMethodCallException('An anonymous credential cannot be changed.');`
	`17`	`+ }`
	`18`	`+`
`14`	`19`	`public static function getUsernameField(): string`
`15`	`20`	`{`
`16`		`- throw new \LogicException('An anonymous credential has no username field.');`
	`21`	`+ throw new \BadMethodCallException('An anonymous credential has no username field.');`
`17`	`22`	`}`
`18`	`23`
`19`	`24`	`public function getUsername(): string`
`20`	`25`	`{`
`21`		`- throw new \LogicException('An anonymous credential has no username.');`
	`26`	`+ throw new \BadMethodCallException('An anonymous credential has no username.');`
`22`	`27`	`}`
`23`	`28`	`}`