Refactor the data model, Doctrine, and validation structures

markitosgv · Jun 28, 2021 · a5e4689 · a5e4689
1 parent fe9c459
commit a5e4689
Show file tree

Hide file tree

Showing 18 changed files with 202 additions and 391 deletions.
diff --git a/DependencyInjection/Compiler/DoctrineMappingsCompilerPass.php b/DependencyInjection/Compiler/DoctrineMappingsCompilerPass.php
diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php
@@ -11,6 +11,7 @@
 
 namespace Gesdinet\JWTRefreshTokenBundle\DependencyInjection;
 
+use Symfony\Component\Config\Definition\BaseNode;
 use Symfony\Component\Config\Definition\Builder\TreeBuilder;
 use Symfony\Component\Config\Definition\ConfigurationInterface;
 
@@ -50,24 +51,36 @@ public function getConfigTreeBuilder()
                     ->end()
                 ->scalarNode('user_checker')->defaultValue('security.user_checker')->end()
                 ->scalarNode('refresh_token_entity')
+                    ->setDeprecated(...$this->getDeprecationParameters('The "%node%" node is deprecated, use the "refresh_token_class" node instead.', '0.5'))
                     ->defaultNull()
-                    ->info('Deprecated, use refresh_token_class instead')
+                    ->info('Set another refresh token class to use instead of default one (Gesdinet\JWTRefreshTokenBundle\Entity\RefreshToken)')
                     ->end()
                 ->scalarNode('entity_manager')
+                    ->setDeprecated(...$this->getDeprecationParameters('The "%node%" node is deprecated, use the "object_manager" node instead.', '0.5'))
                     ->defaultNull()
-                    ->info('Deprecated, use object_manager instead')
+                    ->info('Set entity manager to use')
                     ->end()
                 ->scalarNode('single_use')
                     ->defaultFalse()
                     ->info('When true, generate a new refresh token on consumption (deleting the old one)')
                     ->end()
                 ->scalarNode('token_parameter_name')->defaultValue('refresh_token')->end()
                 ->booleanNode('doctrine_mappings')
+                    ->setDeprecated(...$this->getDeprecationParameters('The "%node%" node is deprecated without replacement.', '0.13'))
                     ->info('When true, resolving of Doctrine mapping is done automatically to use either ORM or ODM object manager')
                     ->defaultTrue()
                 ->end()
             ->end();
 
         return $treeBuilder;
     }
+
+    private function getDeprecationParameters(string $message, string $version): array
+    {
+        if (method_exists(BaseNode::class, 'getDeprecation')) {
+            return ['gesdinet/jwt-refresh-token-bundle', $version, $message];
+        }
+
+        return [$message];
+    }
 }
diff --git a/Document/AbstractRefreshToken.php b/Document/AbstractRefreshToken.php
@@ -11,132 +11,36 @@
 
 namespace Gesdinet\JWTRefreshTokenBundle\Document;
 
-use Doctrine\Bundle\MongoDBBundle\Validator\Constraints\Unique;
+use Gesdinet\JWTRefreshTokenBundle\Model\AbstractRefreshToken as BaseAbstractRefreshToken;
 use Symfony\Component\Validator\Constraints as Assert;
-use Gesdinet\JWTRefreshTokenBundle\Model\RefreshTokenInterface;
 
 /**
  * Abstract Refresh Token.
  *
  * @Unique("refreshToken")
+ *
+ * @deprecated Extend from `Gesdinet\JWTRefreshTokenBundle\Model\AbstractRefreshToken` instead
  */
-abstract class AbstractRefreshToken implements RefreshTokenInterface
+abstract class AbstractRefreshToken extends BaseAbstractRefreshToken
 {
     /**
      * @var string
      *
      * @Assert\NotBlank()
      */
-    private $refreshToken;
+    protected $refreshToken;
 
     /**
      * @var string
      *
      * @Assert\NotBlank()
      */
-    private $username;
+    protected $username;
 
     /**
-     * @var \DateTime
+     * @var \DateTimeInterface
      *
      * @Assert\NotBlank()
      */
-    private $valid;
-
-    /**
-     * {@inheritdoc}
-     */
-    abstract public function getId();
-
-    /**
-     * Set refreshToken.
-     *
-     * @param string $refreshToken
-     *
-     * @return AbstractRefreshToken
-     */
-    public function setRefreshToken($refreshToken = null)
-    {
-        $this->refreshToken = null === $refreshToken
-            ? bin2hex(openssl_random_pseudo_bytes(64))
-            : $refreshToken;
-
-        return $this;
-    }
-
-    /**
-     * Get refreshToken.
-     *
-     * @return string
-     */
-    public function getRefreshToken()
-    {
-        return $this->refreshToken;
-    }
-
-    /**
-     * Set valid.
-     *
-     * @param \DateTime $valid
-     *
-     * @return AbstractRefreshToken
-     */
-    public function setValid($valid)
-    {
-        $this->valid = $valid;
-
-        return $this;
-    }
-
-    /**
-     * Get valid.
-     *
-     * @return \DateTime
-     */
-    public function getValid()
-    {
-        return $this->valid;
-    }
-
-    /**
-     * Set username.
-     *
-     * @param string $username
-     *
-     * @return AbstractRefreshToken
-     */
-    public function setUsername($username)
-    {
-        $this->username = $username;
-
-        return $this;
-    }
-
-    /**
-     * Get username.
-     *
-     * @return string
-     */
-    public function getUsername()
-    {
-        return $this->username;
-    }
-
-    /**
-     * Check if is a valid refresh token.
-     *
-     * @return bool
-     */
-    public function isValid()
-    {
-        return $this->valid >= new \DateTime();
-    }
-
-    /**
-     * @return string Refresh Token
-     */
-    public function __toString()
-    {
-        return $this->getRefreshToken();
-    }
+    protected $valid;
 }
diff --git a/Document/RefreshToken.php b/Document/RefreshToken.php
@@ -11,25 +11,11 @@
 
 namespace Gesdinet\JWTRefreshTokenBundle\Document;
 
-use Doctrine\Bundle\MongoDBBundle\Validator\Constraints\Unique;
+use Gesdinet\JWTRefreshTokenBundle\Model\AbstractRefreshToken;
 
 /**
  * Refresh Token.
- *
- * @Unique("refreshToken")
  */
 class RefreshToken extends AbstractRefreshToken
 {
-    /**
-     * @var string
-     */
-    protected $id;
-
-    /**
-     * {@inheritdoc}
-     */
-    public function getId()
-    {
-        return $this->id;
-    }
 }