Merge pull request #20 from danitome24/19-username-vo

#19 - Username vo added

Author: danitome24

src/PhpValueObject/User/Exception/InvalidUsernameException.php

@@ -0,0 +1,18 @@
+<?php
+/**
+ * This software was built by:
+ * Daniel Tomé Fernández <danieltomefer@gmail.com>
+ * GitHub: danitome24
+ */
+
+namespace PhpValueObject\User\Exception;
+
+use Throwable;
+
+class InvalidUsernameException extends \Exception
+{
+    public function __construct($message = "", $code = 0, Throwable $previous = null)
+    {
+        parent::__construct($message, $code, $previous);
+    }
+}

src/PhpValueObject/User/Username.php

@@ -0,0 +1,76 @@
+<?php
+/**
+ * This software was built by:
+ * Daniel Tomé Fernández <danieltomefer@gmail.com>
+ * GitHub: danitome24
+ */
+
+namespace PhpValueObject\User;
+
+use PhpValueObject\User\Exception\InvalidUsernameException;
+use PhpValueObject\ValueObject;
+
+final class Username implements ValueObject
+{
+    private const USERNAME_REGEX = '/^([A-Za-z0-9]{5,31})$/';
+
+    /**
+     * @var string
+     */
+    private $username;
+
+    /**
+     * Username constructor.
+     * @param string $username
+     * @throws \PhpValueObject\User\Exception\InvalidUsernameException
+     */
+    private function __construct(string $username)
+    {
+        $this->checkIfIsValid($username);
+        $this->username = $username;
+    }
+
+    /**
+     * Named constructor
+     *
+     * @param string $username
+     * @return Username
+     * @throws \PhpValueObject\User\Exception\InvalidUsernameException
+     */
+    public static function fromString(string $username): Username
+    {
+        return new self($username);
+    }
+
+    /**
+     * @return string
+     */
+    public function username(): string
+    {
+        return $this->username;
+    }
+
+    /**
+     * Compare a value object with another one.
+     *
+     * @param static|ValueObject $valueObjectToCompare
+     * @return bool
+     */
+    public function equals(ValueObject $valueObjectToCompare): bool
+    {
+        return $this->username() === $valueObjectToCompare->username();
+    }
+
+    /**
+     * Check if username is valid
+     *
+     * @param $username
+     * @throws InvalidUsernameException
+     */
+    private function checkIfIsValid($username)
+    {
+        if (!preg_match(self::USERNAME_REGEX, $username)) {
+            throw new InvalidUsernameException('Username must contain only letters and numbers anb must be from 5 to 31 length');
+        }
+    }
+}

tests/User/UsernameTest.php

@@ -0,0 +1,49 @@
+<?php
+/**
+ * This software was built by:
+ * Daniel Tomé Fernández <danieltomefer@gmail.com>
+ * GitHub: danitome24
+ */
+
+namespace User;
+
+use PhpValueObject\User\Exception\InvalidUsernameException;
+use PhpValueObject\User\Username;
+use PHPUnit\Framework\TestCase;
+
+class UsernameTest extends TestCase
+{
+
+    public function testIsInvalidUsername()
+    {
+        $this->expectException(InvalidUsernameException::class);
+
+        Username::fromString('dtom');
+    }
+
+    public function testUserIsValid()
+    {
+        $usernameString = 'dtome23';
+        $username = Username::fromString($usernameString);
+        $this->assertEquals($usernameString, $username->username());
+    }
+
+    /**
+     * @dataProvider usernames
+     * @param Username $username
+     * @param Username $usernameToTest
+     * @param bool $isEquals
+     */
+    public function testEqualsMethodIsValid(Username $username, Username $usernameToTest, bool $isEquals)
+    {
+        $this->assertEquals($isEquals, $username->equals($usernameToTest));
+    }
+
+    public function usernames()
+    {
+        return [
+            [Username::fromString('dtome'), Username::fromString('dtome'), true],
+            [Username::fromString('dfernandez'), Username::fromString('tests'), false]
+        ];
+    }
+}