Customers name and surname can not be empty strings and e-mail must b…

…e valid e-mail address

composer.json

@@ -5,6 +5,7 @@
     "require": {
         "php": "~7.4|~8.0",
         "ext-json": "*",
+        "egulias/email-validator": "^4.0",
         "psr/http-client": "^1.0",
         "psr/http-factory": "^1.0",
         "psr/http-message": "^1.0|^2.0"

src/Model/CreatePaymentCustomer.php

@@ -3,16 +3,17 @@
 namespace ThePay\ApiClient\Model;
 
 use InvalidArgumentException;
+use ThePay\ApiClient\ValueObject\EmailAddress;
+use ThePay\ApiClient\ValueObject\NonEmptyString;
 use ThePay\ApiClient\ValueObject\PhoneNumber;
-use ThePay\ApiClient\ValueObject\StringValue;
 
 final class CreatePaymentCustomer
 {
     private string $name;
     private string $surname;
-    /** @var StringValue|null */
+    /** @var string|null */
     private $email;
-    /** @var PhoneNumber|null */
+    /** @var string|null */
     private $phone;
     /** @var Address|null */
     private $billingAddress;
@@ -31,10 +32,10 @@ public function __construct(string $name, string $surname, $email, $phone, Addre
             throw new InvalidArgumentException('At least one of $email and $phone is required.');
         }
 
-        $this->name = $name;
-        $this->surname = $surname;
-        $this->email = $email === null ? null : new StringValue($email);
-        $this->phone = $phone === null ? null : new PhoneNumber($phone);
+        $this->name = (new NonEmptyString($name))->getValue();
+        $this->surname = (new NonEmptyString($surname))->getValue();
+        $this->email = $email === null ? null : (new EmailAddress($email))->getValue();
+        $this->phone = $phone === null ? null : (new PhoneNumber($phone))->getValue();
         $this->billingAddress = $billingAddress;
         $this->shippingAddress = $shippingAddress;
     }
@@ -54,15 +55,15 @@ public function getSurname(): string
      */
     public function getEmail()
     {
-        return $this->email === null ? null : $this->email->getValue();
+        return $this->email;
     }
 
     /**
      * @return string|null
      */
     public function getPhone()
     {
-        return $this->phone === null ? null : $this->phone->getValue();
+        return $this->phone;
     }
 
     /**

src/ValueObject/Amount.php

@@ -4,11 +4,11 @@
 
 use InvalidArgumentException;
 
+/**
+ * @extends BaseValueObject<int>
+ */
 final class Amount extends BaseValueObject
 {
-    /** @var int */
-    private $value;
-
     /**
      * Amount constructor.
      *

src/ValueObject/BaseValueObject.php

@@ -2,13 +2,27 @@
 
 namespace ThePay\ApiClient\ValueObject;
 
+use InvalidArgumentException;
+
+/**
+ * @template TValue of mixed
+ */
 abstract class BaseValueObject implements ValueObject
 {
     /**
-     * BaseValueObject constructor.
-     * @param mixed $value
+     * @var TValue
+     */
+    protected $value;
+
+    /**
+     * @param TValue|mixed $value
+     *
+     * @throws InvalidArgumentException
      */
-    abstract public function __construct($value);
+    public function __construct($value)
+    {
+        $this->value = static::filter($value);
+    }
 
     /**
      * @param mixed $value
@@ -30,4 +44,33 @@ public function equals(ValueObject $object)
 
         return $this->getValue() === $object->getValue();
     }
+
+    /**
+     * @return TValue
+     */
+    public function getValue()
+    {
+        return $this->value;
+    }
+
+    /**
+     * @internal should be abstract
+     *
+     * @param TValue|mixed $value
+     *
+     * @return TValue
+     *
+     * @throws InvalidArgumentException
+     */
+    protected static function filter($value)
+    {
+        throw self::invalidValue('expected');
+    }
+
+    protected static function invalidValue(string $expected, ?string $actual = null): InvalidArgumentException
+    {
+        return new InvalidArgumentException(
+            'Value ' . ($actual === null ? '' : '"' . $actual . '" ') . 'is not ' . $expected,
+        );
+    }
 }

src/ValueObject/CountryCode.php

@@ -2,11 +2,11 @@
 
 namespace ThePay\ApiClient\ValueObject;
 
+/**
+ * @extends BaseValueObject<string>
+ */
 final class CountryCode extends BaseValueObject
 {
-    /** @var string */
-    private $value;
-
     /**
      * @param string $value
      */

src/ValueObject/CurrencyCode.php

@@ -4,11 +4,11 @@
 
 use InvalidArgumentException;
 
+/**
+ * @extends BaseValueObject<string>
+ */
 final class CurrencyCode extends BaseValueObject
 {
-    /** @var string */
-    private $value;
-
     /**
      * CurrencyCode constructor.
      *

src/ValueObject/EmailAddress.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace ThePay\ApiClient\ValueObject;
+
+use Egulias\EmailValidator\EmailValidator;
+use Egulias\EmailValidator\Validation\RFCValidation;
+
+class EmailAddress extends NonEmptyString
+{
+    public static function filter($value)
+    {
+        $nonEmptyString = parent::filter($value);
+
+        if ((new EmailValidator())->isValid($nonEmptyString, new RFCValidation()) === false) {
+            throw self::invalidValue('e-mail address', $nonEmptyString);
+        }
+
+        return $nonEmptyString;
+    }
+}

src/ValueObject/EnumValueObject.php

@@ -2,11 +2,11 @@
 
 namespace ThePay\ApiClient\ValueObject;
 
+/**
+ * @extends BaseValueObject<string>
+ */
 abstract class EnumValueObject extends BaseValueObject
 {
-    /** @var string */
-    protected $value;
-
     /**
      * @param string $value
      */

src/ValueObject/Identifier.php

@@ -4,11 +4,11 @@
 
 use InvalidArgumentException;
 
+/**
+ * @extends BaseValueObject<string>
+ */
 final class Identifier extends BaseValueObject
 {
-    /** @var string */
-    private $value;
-
     /**
      * Uid constructor.
      *

src/ValueObject/LanguageCode.php

@@ -4,11 +4,11 @@
 
 use InvalidArgumentException;
 
+/**
+ * @extends BaseValueObject<string>
+ */
 final class LanguageCode extends BaseValueObject
 {
-    /** @var string */
-    private $value;
-
     /**
      * CurrencyCode constructor.
      *

src/ValueObject/NonEmptyString.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace ThePay\ApiClient\ValueObject;
+
+class NonEmptyString extends StringValue
+{
+    protected static function filter($value)
+    {
+        $string = parent::filter($value);
+
+        if (trim($string) === '') {
+            throw self::invalidValue('non-empty string', $string);
+        }
+
+        return $string;
+    }
+}

src/ValueObject/PhoneNumber.php

@@ -4,6 +4,9 @@
 
 use InvalidArgumentException;
 
+/**
+ * @extends BaseValueObject<string>
+ */
 final class PhoneNumber extends BaseValueObject
 {
     /** @var string */

src/ValueObject/SecureUrl.php

@@ -2,6 +2,9 @@
 
 namespace ThePay\ApiClient\ValueObject;
 
+/**
+ * @extends BaseValueObject<string>
+ */
 final class SecureUrl extends BaseValueObject
 {
     /** @var string */

src/ValueObject/StringValue.php

@@ -2,33 +2,22 @@
 
 namespace ThePay\ApiClient\ValueObject;
 
-final class StringValue extends BaseValueObject
+/**
+ * @extends BaseValueObject<string>
+ */
+class StringValue extends BaseValueObject
 {
-    /** @var string */
-    private $value;
-
-    public function __construct($value)
-    {
-        if ( ! is_string($value)) {
-            throw new \InvalidArgumentException('type of value: ' . (string) $value . ' is not string');
-        }
-
-        $this->value = $value;
-    }
-
-    /**
-     * @return string
-     */
     public function __toString()
     {
         return $this->value;
     }
 
-    /**
-     * @return string
-     */
-    public function getValue()
+    protected static function filter($value)
     {
-        return $this->value;
+        if ( ! is_string($value)) {
+            throw self::invalidValue('string');
+        }
+
+        return $value;
     }
 }

src/ValueObject/Url.php

@@ -4,6 +4,9 @@
 
 use InvalidArgumentException;
 
+/**
+ * @extends BaseValueObject<string>
+ */
 final class Url extends BaseValueObject
 {
     /** @var string */

tests/ValueObject/BaseValueObjectTestCase.php

@@ -0,0 +1,57 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ThePay\ApiClient\Tests\ValueObject;
+
+use PHPUnit\Framework\TestCase;
+use ThePay\ApiClient\ValueObject\BaseValueObject;
+
+abstract class BaseValueObjectTestCase extends TestCase
+{
+    /**
+     * @dataProvider validValuesDataProvider
+     *
+     * @param mixed $value
+     */
+    public function testCreatesWorkingInstanceWithValidValue($value): void
+    {
+        $className = static::getClassName();
+        $a = $className::create($value);
+        $b = new $className($value);
+
+        self::assertTrue($a->equals($b));
+        self::assertTrue($b->equals($a));
+        self::assertSame($value, $a->getValue());
+        self::assertSame((string) $value, (string) $a);
+    }
+
+    /**
+     * @dataProvider invalidValuesAndMessagesDataProvider
+     *
+     * @param mixed $value
+     */
+    public function testThrowsWithInvalidValue($value, string $message): void
+    {
+        $this->expectException(\InvalidArgumentException::class);
+        $this->expectExceptionMessage($message);
+
+        $className = static::getClassName();
+        $className::create($value);
+    }
+
+    /**
+     * @return class-string<BaseValueObject>
+     */
+    abstract protected static function getClassName(): string;
+
+    /**
+     * @return array<array<mixed>>|array<string, array<mixed>
+     */
+    abstract public static function validValuesDataProvider(): array;
+
+    /**
+     * @return array<array<mixed|string>>|array<string, array<mixed|string>
+     */
+    abstract public static function invalidValuesAndMessagesDataProvider(): array;
+}