VSVGVQ-51: add UrlSuffixGenerator and interface, add timezone to date…

…time in registration, remove find on user in registrationdoctrinerepository

src/Registration/Models/Registration.php

@@ -3,6 +3,7 @@
 namespace VSV\GVQ_API\Registration\Models;
 
 use Ramsey\Uuid\UuidInterface;
+use VSV\GVQ_API\Registration\ValueObjects\UrlSuffix;
 use VSV\GVQ_API\User\Models\User;
 
 class Registration
@@ -12,9 +13,9 @@ class Registration
      */
     private $id;
     /**
-     * @var string
+     * @var UrlSuffix
      */
-    private $hashCode;
+    private $urlSuffix;
 
     /**
      * @var User
@@ -33,20 +34,20 @@ class Registration
 
     /**
      * @param UuidInterface $id
-     * @param string $hashCode
+     * @param UrlSuffix $hashCode
      * @param User $user
      * @param \DateTimeImmutable $createdOn
      * @param bool $passwordReset
      */
     public function __construct(
         UuidInterface $id,
-        string $hashCode,
+        UrlSuffix $hashCode,
         User $user,
         \DateTimeImmutable $createdOn,
         bool $passwordReset
     ) {
         $this->id = $id;
-        $this->hashCode = $hashCode;
+        $this->urlSuffix = $hashCode;
         $this->user = $user;
         $this->createdOn = $createdOn;
         $this->passwordReset = $passwordReset;
@@ -61,11 +62,11 @@ public function getId(): UuidInterface
     }
 
     /**
-     * @return string
+     * @return UrlSuffix
      */
-    public function getHashCode(): string
+    public function getUrlSuffix(): UrlSuffix
     {
-        return $this->hashCode;
+        return $this->urlSuffix;
     }
 
     /**

src/Registration/Repositories/Entities/RegistrationEntity.php

@@ -6,26 +6,30 @@
 use Ramsey\Uuid\Uuid;
 use VSV\GVQ_API\Common\Repositories\Entities\Entity;
 use VSV\GVQ_API\Registration\Models\Registration;
+use VSV\GVQ_API\Registration\ValueObjects\UrlSuffix;
 use VSV\GVQ_API\User\Repositories\Entities\UserEntity;
 
 /**
  * @ORM\Entity()
- * @ORM\Table(name="registration")
+ * @ORM\Table(name="registration", indexes={
+ *     @ORM\Index(name="url_suffix_idx", columns={"url_suffix"}),
+ *     @ORM\Index(name="user_id_idx", columns={"user_id"})
+ * })
  */
 class RegistrationEntity extends Entity
 {
     /**
      * @var string
      *
-     * @ORM\Column(type="string", name="hash_code", length=22, nullable=false)
+     * @ORM\Column(type="string", name="url_suffix", length=22, nullable=false, unique=true)
      */
-    private $hashCode;
+    private $urlSuffix;
 
     /**
      * @var UserEntity
      *
      * @ORM\OneToOne(targetEntity="VSV\GVQ_API\User\Repositories\Entities\UserEntity", fetch="EAGER")
-     * @ORM\JoinColumn(name="user_id", referencedColumnName="id", nullable=false)
+     * @ORM\JoinColumn(name="user_id", referencedColumnName="id", nullable=false, unique=true)
      */
     private $userEntity;
 
@@ -57,7 +61,7 @@ public function __construct(
         bool $passwordReset
     ) {
         parent::__construct($id);
-        $this->hashCode = $hashCode;
+        $this->urlSuffix = $hashCode;
         $this->userEntity = $userEntity;
         $this->createdOn = $createdOn;
         $this->passwordReset = $passwordReset;
@@ -72,7 +76,7 @@ public static function fromRegistration(Registration $registration): Registratio
     {
         return new RegistrationEntity(
             $registration->getId()->toString(),
-            $registration->getHashCode(),
+            $registration->getUrlSuffix()->toNative(),
             UserEntity::fromUser($registration->getUser()),
             $registration->getCreatedOn(),
             $registration->isPasswordReset()
@@ -86,7 +90,7 @@ public function toRegistration(): Registration
     {
         return new Registration(
             Uuid::fromString($this->getId()),
-            $this->getHashCode(),
+            new UrlSuffix($this->getUrlSuffix()),
             $this->getUserEntity()->toUser(),
             $this->getCreatedOn(),
             $this->isPasswordReset()
@@ -96,9 +100,9 @@ public function toRegistration(): Registration
     /**
      * @return string
      */
-    public function getHashCode(): string
+    public function getUrlSuffix(): string
     {
-        return $this->hashCode;
+        return $this->urlSuffix;
     }
 
     /**

src/Registration/Repositories/RegistrationDoctrineRepository.php

@@ -24,34 +24,21 @@ public function save(Registration $registration): void
     {
         $registrationEntity = RegistrationEntity::fromRegistration($registration);
 
-        /** @var UserEntity $userEntity */
-        $userEntity = $this->entityManager->find(
-            UserEntity::class,
-            $registrationEntity->getUserEntity()->getId()
-        );
-
-        if ($userEntity == null) {
-            throw new \InvalidArgumentException(
-                'User with id: '.$registrationEntity->getUserEntity()->getId().' not found.'
-            );
-        }
-
-        $registrationEntity->setUserEntity($userEntity);
-
-        $this->entityManager->persist($registrationEntity);
+        //the user object inside registration is not managed, therefore we need to use merge instead of persist
+        $this->entityManager->merge($registrationEntity);
         $this->entityManager->flush();
     }
 
     /**
-     * @param string $hashCode
-     * @return Registration
+     * @param string $urlSuffix
+     * @return Registration|null
      */
-    public function getByHashCode(string $hashCode): ?Registration
+    public function getByUrlSuffix(string $urlSuffix): ?Registration
     {
         /** @var RegistrationEntity|null $registrationEntity */
         $registrationEntity = $this->objectRepository->findOneBy(
             [
-                'hashCode' => $hashCode,
+                'urlSuffix' => $urlSuffix,
             ]
         );
 

src/Registration/Repositories/RegistrationRepository.php

@@ -10,4 +10,10 @@ interface RegistrationRepository
      * @param Registration $registration
      */
     public function save(Registration $registration): void;
+
+    /**
+     * @param string $urlSuffix
+     * @return Registration|null
+     */
+    public function getByUrlSuffix(string $urlSuffix): ?Registration;
 }

src/Registration/UrlSuffixGenerator.php

@@ -0,0 +1,10 @@
+<?php declare(strict_types=1);
+
+namespace VSV\GVQ_API\Registration;
+
+use VSV\GVQ_API\Registration\ValueObjects\UrlSuffix;
+
+interface UrlSuffixGenerator
+{
+    public function createUrlSuffix(): UrlSuffix;
+}

src/Registration/UrlSuffixHashGenerator.php

@@ -0,0 +1,13 @@
+<?php declare(strict_types=1);
+
+namespace VSV\GVQ_API\Registration;
+
+use VSV\GVQ_API\Registration\ValueObjects\UrlSuffix;
+
+class UrlSuffixHashGenerator implements UrlSuffixGenerator
+{
+    public function createUrlSuffix(): UrlSuffix
+    {
+        return new UrlSuffix(bin2hex(random_bytes(11)));
+    }
+}

src/Registration/ValueObjects/UrlSuffix.php

@@ -0,0 +1,47 @@
+<?php declare(strict_types=1);
+
+namespace VSV\GVQ_API\Registration\ValueObjects;
+
+class UrlSuffix
+{
+    /**
+     * @var string
+     */
+    private $value;
+
+    /**
+     * @var int
+     */
+    private $minLimit = 22;
+
+    /**
+     * @param string $value
+     */
+    public function __construct(string $value)
+    {
+        if (strlen($value) < $this->minLimit) {
+            throw new \InvalidArgumentException(
+                'Value has to be at least '.$this->minLimit.' characters long, '.strlen($value).' given.'
+            );
+        }
+
+        $this->value = $value;
+    }
+
+    /**
+     * @return string
+     */
+    public function toNative(): string
+    {
+        return $this->value;
+    }
+
+    /**
+     * @param UrlSuffix $suffix
+     * @return bool
+     */
+    public function equals(UrlSuffix $suffix): bool
+    {
+        return $this->toNative() === $suffix->toNative();
+    }
+}

tests/Common/Repositories/AbstractDoctrineRepositoryTest.php

@@ -28,10 +28,7 @@ protected function setUp(): void
     {
         $configuration = Setup::createAnnotationMetadataConfiguration(
             [
-                __DIR__.'/../../../src/Question/Repositories/Entities',
-                __DIR__.'/../../../src/User/Repositories/Entities',
-                __DIR__.'/../../../src/Company/Repositories/Entities',
-                __DIR__.'/../../../src/Registration/Repositories/Entities',
+                __DIR__.'/../../../src/'
             ],
             true,
             null,

tests/Factory/ModelsFactory.php

@@ -18,8 +18,9 @@
 use VSV\GVQ_API\Question\Models\Question;
 use VSV\GVQ_API\Question\Models\Questions;
 use VSV\GVQ_API\Question\ValueObjects\Year;
-use VSV\GVQ_API\Registration\HashCodeGenerator;
+use VSV\GVQ_API\Registration\UrlSuffixHashGenerator;
 use VSV\GVQ_API\Registration\Models\Registration;
+use VSV\GVQ_API\Registration\ValueObjects\UrlSuffix;
 use VSV\GVQ_API\User\Models\User;
 use VSV\GVQ_API\User\ValueObjects\Email;
 use VSV\GVQ_API\User\ValueObjects\Password;
@@ -266,9 +267,9 @@ public static function createRegistration(): Registration
     {
         return new Registration(
             Uuid::fromString('00f20af9-c2f5-4bfb-9424-5c0c29fbc2e3'),
-            'd2c63a605ae27c13e43e26fe2c97a36c4556846dd3ef',
+            new UrlSuffix('d2c63a605ae27c13e43e26fe2c97a36c4556846dd3ef'),
             self::createUser(),
-            new \DateTimeImmutable('2020-02-02'),
+            new \DateTimeImmutable('2020-02-02', new \DateTimeZone('GMT+1')),
             false
         );
     }
@@ -281,7 +282,7 @@ public static function createRegistrationWithAlternateUser(): Registration
     {
         return new Registration(
             Uuid::fromString('00f20af9-c2f5-4bfb-9424-5c0c29fbc2e3'),
-            'd2c63a605ae27c13e43e26fe2c97a36c4556846dd3ef',
+            new UrlSuffix('d2c63a605ae27c13e43e26fe2c97a36c4556846dd3ef'),
             self::createAlternateUser(),
             new \DateTimeImmutable('2020-02-02'),
             false

tests/Registration/Models/RegistrationTest.php

@@ -4,6 +4,7 @@
 
 use PHPUnit\Framework\TestCase;
 use VSV\GVQ_API\Factory\ModelsFactory;
+use VSV\GVQ_API\Registration\ValueObjects\UrlSuffix;
 
 class RegistrationTest extends TestCase
 {
@@ -26,8 +27,8 @@ protected function setUp(): void
     public function it_stores_a_hashcode(): void
     {
         $this->assertEquals(
-            'd2c63a605ae27c13e43e26fe2c97a36c4556846dd3ef',
-            $this->registration->getHashCode()
+            new UrlSuffix('d2c63a605ae27c13e43e26fe2c97a36c4556846dd3ef'),
+            $this->registration->getUrlSuffix()
         );
     }
 
@@ -49,7 +50,7 @@ public function it_stores_a_user(): void
     public function it_stores_a_created_on(): void
     {
         $this->assertEquals(
-            new \DateTimeImmutable('2020-02-02'),
+            new \DateTimeImmutable('2020-02-02', new \DateTimeZone('GMT+1')),
             $this->registration->getCreatedOn()
         );
     }

tests/Registration/Repositories/RegistrationDoctrineRepositoryTest.php

@@ -2,6 +2,7 @@
 
 namespace VSV\GVQ_API\Registration\Repositories;
 
+use Doctrine\ORM\ORMInvalidArgumentException;
 use PhpParser\Node\Expr\AssignOp\Mod;
 use VSV\GVQ_API\Common\Repositories\AbstractDoctrineRepositoryTest;
 use VSV\GVQ_API\Factory\ModelsFactory;
@@ -59,7 +60,7 @@ public function it_can_save_a_registration(): void
     {
         $this->registrationDoctrineRepository->save($this->registration);
 
-        $foundRegistration = $this->registrationDoctrineRepository->getByHashCode(
+        $foundRegistration = $this->registrationDoctrineRepository->getByUrlSuffix(
             'd2c63a605ae27c13e43e26fe2c97a36c4556846dd3ef'
         );
 
@@ -74,9 +75,9 @@ public function it_throws_on_saving_with_an_invalid_user(): void
     {
         $registration = ModelsFactory::createRegistrationWithAlternateUser();
 
-        $this->expectException(\InvalidArgumentException::class);
+        $this->expectException(ORMInvalidArgumentException::class);
         $this->expectExceptionMessage(
-            'User with id: '.$registration->getUser()->getId()->toString().' not found.'
+            'A new entity was found through the relationship'
         );
 
         $this->registrationDoctrineRepository->save($registration);