Merge pull request #3 from chadicus/fea/immutable-keyvaluepair

Replace KeyValuePair with ImmutableKeyValuePair

src/KeyValuePair.php → src/ImmutableKeyValuePair.php

@@ -4,7 +4,7 @@
 /**
  * Defines an immutable key/value pair.
  */
-class KeyValuePair
+final class ImmutableKeyValuePair implements KeyValuePairInterface
 {
     /**
      * The key in the key/value pair.
@@ -51,30 +51,4 @@ public function getValue()
     {
         return $this->value;
     }
-
-    /**
-     * Sets the key in the key/value pair.
-     *
-     * @param mixed $key The new key.
-     *
-     * @return KeyValuePair
-     */
-    public function setKey($key)
-    {
-        $this->key = $key;
-        return $this;
-    }
-
-    /**
-     * Sets the value in the key/value pair.
-     *
-     * @param mixed $value The new value.
-     *
-     * @return mixed
-     */
-    public function setValue($value)
-    {
-        $this->value = $value;
-        return $this;
-    }
 }

src/KeyValuePairInterface.php

@@ -0,0 +1,22 @@
+<?php
+namespace Chadicus\Spl\DataStructures;
+
+/**
+ * Defines a key/value pair interface.
+ */
+interface KeyValuePairInterface
+{
+    /**
+     * Gets the key in the key/value pair.
+     *
+     * @return mixed
+     */
+    public function getKey();
+
+    /**
+     * Gets the value in the key/value pair.
+     *
+     * @return mixed
+     */
+    public function getValue();
+}

tests/ImmutableKeyValuePairTest.php

@@ -0,0 +1,31 @@
+<?php
+namespace ChadicusTest\Spl\DataStructures;
+
+use Chadicus\Spl\DataStructures\ImmutableKeyValuePair;
+
+/**
+ * Unit tests for the \Chadicus\Spl\DataStructures\ImmutableKeyValuePair class.
+ *
+ * @coversDefaultClass \Chadicus\Spl\DataStructures\ImmutableKeyValuePair
+ */
+final class ImmutableKeyValuePairTest extends \PHPUnit_Framework_TestCase
+{
+    /**
+     * Verify basic behavior of ImmutableKeyValuePair class.
+     *
+     * @test
+     * @covers ::__construct
+     * @covers ::getValue
+     * @covers ::getKey
+     *
+     * @return void
+     */
+    public function basicUsage()
+    {
+        $key = new \StdClass();
+        $value = new \Exception();
+        $pair = new ImmutableKeyValuePair($key, $value);
+        $this->assertSame($key, $pair->getKey());
+        $this->assertSame($value, $pair->getValue());
+    }
+}