Merge branch 'release/0.5'

Author: gnumoksha

README.md

@@ -9,4 +9,5 @@
 Provide objects which follow value semantics rather than reference semantics. This means value objects' equality are not based on identity. Two value objects are equal when they have the same value, not necessarily being the same object.
 
 ## Related projects
-* https://github.com/cultuurnet/valueobjects
+- https://github.com/cultuurnet/valueobjects
+- https://github.com/nubeiro/value-objects

src/Network/IpAddress.php

@@ -0,0 +1,44 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Talentify\ValueObject\Network;
+
+use Talentify\ValueObject\ValueObject;
+
+class IpAddress implements ValueObject
+{
+    /** @var string */
+    private $ipAddress;
+
+    /**
+     * @throws \InvalidArgumentException if IP address is not valid
+     */
+    public function __construct(string $ipAddress)
+    {
+        if (filter_var($ipAddress, FILTER_VALIDATE_IP) === false) {
+            throw new \InvalidArgumentException(sprintf('The value %s is not a valid IP address.', $ipAddress));
+        }
+
+        $this->ipAddress = $ipAddress;
+    }
+
+    public function getIpAddress() : string
+    {
+        return $this->ipAddress;
+    }
+
+    public function equals(?ValueObject $object) : bool
+    {
+        if (!$object instanceof self) {
+            return false;
+        }
+
+        return $object->getIpAddress() === $this->getIpAddress();
+    }
+
+    public function __toString() : string
+    {
+        return $this->ipAddress;
+    }
+}

tests/Network/IpAddressTest.php

@@ -0,0 +1,51 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Talentify\ValueObject\Network;
+
+use Talentify\ValueObject\ValueObjectTestCase;
+
+class IpAddressTest extends ValueObjectTestCase
+{
+    /**
+     * @test
+     */
+    public function willThrownExceptionIfValueIsInvalid() : void
+    {
+        $this->expectException(\InvalidArgumentException::class);
+        new IpAddress('fooBar');
+    }
+
+    public static function getClassName() : string
+    {
+        return IpAddress::class;
+    }
+
+    public function sameValueDataProvider() : array
+    {
+        return [
+            [new IpAddress('127.0.0.1'), new IpAddress('127.0.0.1')],
+            [
+                new IpAddress('2001:0db8:85a3:08d3:1319:8a2e:0370:7344'),
+                new IpAddress('2001:0db8:85a3:08d3:1319:8a2e:0370:7344')
+            ],
+            // #FIXME these as equal IPv6 addresses
+//            [
+//                new IpAddress('2001:0db8:85a3:0000:0000:0000:0000:7344'),
+//                new IpAddress('2001:0db8:85a3::7344')
+//            ]
+        ];
+    }
+
+    public function differentValueDataProvider() : array
+    {
+        return [
+            [new IpAddress('127.0.0.1'), new IpAddress('192.168.0.1')],
+            [
+                new IpAddress('2001:0db8:85a3:08d3:1319:8a2e:0370:7344'),
+                new IpAddress('2001:0db8:85a3:08d3:1319:8a2e:0370:5555')
+            ]
+        ];
+    }
+}