Merge pull request #10 from danitome24/7-weight-vo

#7 - Added weight VO

Author: danitome24

src/PhpValueObject/Person/Exception/WeightNotValidException.php

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

src/PhpValueObject/Person/Weight.php

@@ -0,0 +1,94 @@
+<?php
+/**
+ * This software was built by:
+ * Daniel Tomé Fernández <danieltomefer@gmail.com>
+ * GitHub: danitome24
+ */
+
+namespace PhpValueObject\Person;
+
+use PhpValueObject\Person\Exception\WeightNotValidException;
+use PhpValueObject\ValueObject;
+
+final class Weight implements ValueObject
+{
+    const MIN_KG = 10;
+    const MAX_KG = 200;
+
+    /**
+     * Weight in kg
+     *
+     * @var float
+     */
+    private $weight;
+
+    /**
+     * Weight constructor.
+     * @param float $weight
+     * @throws \PhpValueObject\Person\Exception\WeightNotValidException
+     */
+    private function __construct(float $weight)
+    {
+        $this->changeWeight($weight);
+    }
+
+    /**
+     * Named constructor
+     *
+     * @param float $weight
+     * @return Weight
+     * @throws \PhpValueObject\Person\Exception\WeightNotValidException
+     */
+    public static function fromKg(float $weight): self
+    {
+        return new static($weight);
+    }
+
+    /**
+     * @return float
+     */
+    public function inKilograms(): float
+    {
+        return $this->weight;
+    }
+
+    /**
+     * @return float
+     */
+    public function inGrams(): float
+    {
+        return $this->weight * 1000;
+    }
+
+    /**
+     * @return float
+     */
+    public function inPounds(): float
+    {
+        return $this->weight * 2.2046;
+    }
+
+    /**
+     * Compare a value object with another one.
+     *
+     * @param static|ValueObject $valueObjectToCompare
+     * @return bool
+     */
+    public function equals(ValueObject $valueObjectToCompare): bool
+    {
+        return ($this->inKilograms() === $valueObjectToCompare->inKilograms());
+    }
+
+    /**
+     * @param float $kg
+     * @throws WeightNotValidException
+     */
+    private function changeWeight(float $kg)
+    {
+        if ($kg < self::MIN_KG || $kg > self::MAX_KG) {
+            throw new WeightNotValidException('Weight ' . $kg . ' is not valid');
+        }
+
+        $this->weight = $kg;
+    }
+}

tests/Person/WeightTest.php

@@ -0,0 +1,54 @@
+<?php
+/**
+ * This software was built by:
+ * Daniel Tomé Fernández <danieltomefer@gmail.com>
+ * GitHub: danitome24
+ */
+
+namespace Test\Person;
+
+use PHPUnit\Framework\TestCase;
+use PhpValueObject\Person\Exception\WeightNotValidException;
+use PhpValueObject\Person\Weight;
+
+class WeightTest extends TestCase
+{
+    public function testWeightNotValidExceptionIsThrown()
+    {
+        $this->expectException(WeightNotValidException::class);
+
+        Weight::fromKg(2.34);
+    }
+
+    public function testWeightIsValidInstance()
+    {
+        $weightInKg = 90.5;
+        $weightInPounds = $weightInKg * 2.2046;
+        $weight = Weight::fromKg($weightInKg);
+        $this->assertEquals($weightInKg, $weight->inKilograms());
+        $this->assertEquals($weightInKg * 1000, $weight->inGrams());
+        $this->assertEquals($weightInPounds, $weight->inPounds());
+    }
+
+    /**
+     * @dataProvider weights
+     * @param Weight $weight
+     * @param Weight $otherWeight
+     * @param bool $isEquals
+     */
+    public function testEqualsMethod(Weight $weight, Weight $otherWeight, bool $isEquals)
+    {
+        $this->assertEquals($weight->equals($otherWeight), $isEquals);
+    }
+
+    /**
+     * @return array
+     */
+    public function weights(): array
+    {
+        return [
+            [Weight::fromKg(25.98), Weight::fromKg(23.2), false],
+            [Weight::fromKg(25.98), Weight::fromKg(25.98), true]
+        ];
+    }
+}