Merge pull request #11 from danitome24/1-email-vo

#1 - added email VO

Author: danitome24

src/PhpValueObject/User/Email.php

@@ -0,0 +1,83 @@
+<?php
+/**
+ * This software was built by:
+ * Daniel Tomé Fernández <danieltomefer@gmail.com>
+ * GitHub: danitome24
+ */
+
+namespace PhpValueObject\User;
+
+use PhpValueObject\User\Exception\InvalidEmailException;
+use PhpValueObject\ValueObject;
+
+final class Email implements ValueObject
+{
+    /**
+     * @var string
+     */
+    private $email;
+
+    /**
+     * Email constructor.
+     * @param string $email
+     * @throws \PhpValueObject\User\Exception\InvalidEmailException
+     */
+    private function __construct(string $email)
+    {
+        $this->changeEmail($email);
+    }
+
+    /**
+     * @param string $email
+     * @return static
+     * @throws \PhpValueObject\User\Exception\InvalidEmailException
+     */
+    public static function build(string $email)
+    {
+        return new static($email);
+    }
+
+    /**
+     * @return string
+     */
+    public function email(): string
+    {
+        return $this->email;
+    }
+
+    /**
+     * Compare a value object with another one.
+     *
+     * @param static|ValueObject $valueObjectToCompare
+     * @return bool
+     */
+    public function equals(ValueObject $valueObjectToCompare): bool
+    {
+        return ($this->email() === $valueObjectToCompare->email());
+    }
+
+    /**
+     * Change email
+     *
+     * @param string $email
+     * @throws InvalidEmailException
+     */
+    private function changeEmail(string $email)
+    {
+        $this->checkIsValidEmail($email);
+        $this->email = $email;
+    }
+
+    /**
+     * Check if email is valid
+     *
+     * @param string $email
+     * @throws InvalidEmailException
+     */
+    private function checkIsValidEmail(string $email): void
+    {
+        if (!filter_var($email, FILTER_VALIDATE_EMAIL)) {
+            throw new InvalidEmailException('Email ' . $email . ' is not valid');
+        }
+    }
+}

src/PhpValueObject/User/Exception/InvalidEmailException.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 InvalidEmailException extends \Exception
+{
+    public function __construct($message = "", $code = 0, Throwable $previous = null)
+    {
+        parent::__construct($message, $code, $previous);
+    }
+}

tests/User/EmailTest.php

@@ -0,0 +1,50 @@
+<?php
+/**
+ * This software was built by:
+ * Daniel Tomé Fernández <danieltomefer@gmail.com>
+ * GitHub: danitome24
+ */
+
+namespace Test\User;
+
+use PHPUnit\Framework\TestCase;
+use PhpValueObject\User\Email;
+use PhpValueObject\User\Exception\InvalidEmailException;
+
+class EmailTest extends TestCase
+{
+    public function testEmailIsNotValidException()
+    {
+        $this->expectException(InvalidEmailException::class);
+        Email::build('aninvalidEmail.com');
+    }
+
+    public function testEmailIsValidInstance()
+    {
+        $emailText = 'thebestproject@email.com';
+        $email = Email::build($emailText);
+        $this->assertEquals($emailText, $email->email());
+    }
+
+    /**
+     * @dataProvider emails
+     * @param Email $email
+     * @param Email $emailToCompare
+     * @param bool $isEquals
+     */
+    public function testEmailIsEquals(Email $email, Email $emailToCompare, bool $isEquals)
+    {
+        $this->assertEquals($email->equals($emailToCompare), $isEquals);
+    }
+
+    /**
+     * @return array
+     */
+    public function emails(): array
+    {
+        return [
+            [Email::build('thebestproject@email.com'), Email::build('thebestproject@email.com'), true],
+            [Email::build('thebestproject@email.com'), Email::build('thebestproject2@email.com'), false]
+        ];
+    }
+}