Merge pull request #14 from danitome24/13-gender-vo

#13 - Added gender vo

Author: danitome24

src/PhpValueObject/Person/Female.php

@@ -0,0 +1,23 @@
+<?php
+/**
+ * This software was built by:
+ * Daniel Tomé Fernández <[email protected]>
+ * GitHub: danitome24
+ */
+
+namespace PhpValueObject\Person;
+
+final class Female extends Gender
+{
+    private const NAME = 'Female';
+
+    /**
+     * Build Female instance
+     *
+     * @return static
+     */
+    public static function fromFemale()
+    {
+        return new static(self::NAME);
+    }
+}

src/PhpValueObject/Person/Gender.php

@@ -0,0 +1,46 @@
+<?php
+/**
+ * This software was built by:
+ * Daniel Tomé Fernández <[email protected]>
+ * GitHub: danitome24
+ */
+
+namespace PhpValueObject\Person;
+
+use PhpValueObject\ValueObject;
+
+abstract class Gender implements ValueObject
+{
+    /**
+     * @var string
+     */
+    private $gender;
+
+    /**
+     * Gender constructor.
+     * @param string $gender
+     */
+    protected function __construct(string $gender)
+    {
+        $this->gender = $gender;
+    }
+
+    /**
+     * @return string
+     */
+    public function gender(): string
+    {
+        return $this->gender;
+    }
+
+    /**
+     * Compare a value object with another one.
+     *
+     * @param static|ValueObject $valueObjectToCompare
+     * @return bool
+     */
+    public function equals(ValueObject $valueObjectToCompare): bool
+    {
+        return ($this->gender() === $valueObjectToCompare->gender());
+    }
+}

src/PhpValueObject/Person/Male.php

@@ -0,0 +1,23 @@
+<?php
+/**
+ * This software was built by:
+ * Daniel Tomé Fernández <[email protected]>
+ * GitHub: danitome24
+ */
+
+namespace PhpValueObject\Person;
+
+final class Male extends Gender
+{
+    private const NAME = 'Male';
+
+    /**
+     * Build Male instance
+     *
+     * @return static
+     */
+    public static function fromMale()
+    {
+        return new static(self::NAME);
+    }
+}

src/PhpValueObject/Person/Neutral.php

@@ -0,0 +1,23 @@
+<?php
+/**
+ * This software was built by:
+ * Daniel Tomé Fernández <[email protected]>
+ * GitHub: danitome24
+ */
+
+namespace PhpValueObject\Person;
+
+final class Neutral extends Gender
+{
+    private const NAME = 'Neutral';
+
+    /**
+     * Build Neutral instance
+     *
+     * @return static
+     */
+    public static function fromNeutral()
+    {
+        return new static(self::NAME);
+    }
+}

tests/Person/GenderTest.php

@@ -0,0 +1,47 @@
+<?php
+/**
+ * This software was built by:
+ * Daniel Tomé Fernández <[email protected]>
+ * GitHub: danitome24
+ */
+
+namespace Person;
+
+use PHPUnit\Framework\TestCase;
+use PhpValueObject\Person\Female;
+use PhpValueObject\Person\Gender;
+use PhpValueObject\Person\Male;
+use PhpValueObject\Person\Neutral;
+
+class GenderTest extends TestCase
+{
+
+    public function testGenderInheritanceInstance()
+    {
+        $this->assertEquals('Male', Male::fromMale()->gender());
+        $this->assertEquals('Female', Female::fromFemale()->gender());
+        $this->assertEquals('Neutral', Neutral::fromNeutral()->gender());
+    }
+
+    /**
+     * @dataProvider genders
+     * @param Gender $gender
+     * @param Gender $genderToCompare
+     * @param bool $isEquals
+     */
+    public function testEqualsMethod(Gender $gender, Gender $genderToCompare, bool $isEquals)
+    {
+        $this->assertEquals($isEquals, $gender->equals($genderToCompare));
+    }
+
+    /**
+     * @return array
+     */
+    public function genders(): array
+    {
+        return [
+            [Male::fromMale(), Male::fromMale(), true],
+            [Male::fromMale(), Female::fromFemale(), false]
+        ];
+    }
+}