refactor collection

Kachit · Feb 22, 2015 · e87710b · e87710b
1 parent dd353f9
commit e87710b
Show file tree

Hide file tree

Showing 8 changed files with 62 additions and 79 deletions.
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -21,9 +21,11 @@
         <whitelist>
             <directory suffix=".php">src/Kachit/Collection/</directory>
             <exclude>
-                <file suffix=".php">src/Kachit/Collection/ItemObject.php</file>
+                <file suffix=".php">src/Kachit/Collection/ItemInterface.php</file>
+                <file suffix=".php">src/Kachit/Collection/ItemTrait.php</file>
                 <file suffix=".php">src/Kachit/Collection/Exception.php</file>
                 <file suffix=".php">src/Kachit/Collection/ErrorHandler/HandlerException.php</file>
+                <file suffix=".php">src/Kachit/Collection/ErrorHandler/HandlerInterface.php</file>
             </exclude>
         </whitelist>
     </filter>

diff --git a/src/Kachit/Collection/Collection.php b/src/Kachit/Collection/Collection.php
@@ -11,8 +11,8 @@
 
 class Collection implements \IteratorAggregate, \JsonSerializable {
 
-    const METHOD_ADD_OBJECT = 'addObject';
-    const METHOD_SET_OBJECT = 'setObject';
+    const METHOD_ADD_OBJECT = 'add';
+    const METHOD_SET_OBJECT = 'set';
 
     /**
      * @var ItemInterface[]
@@ -96,11 +96,11 @@ public function toArray() {
      * @return ItemInterface
      * @throws Exception
      */
-    public function getObject($index = null) {
+    public function get($index = null) {
         if (is_null($index)) {
             return current($this->data);
         }
-        if (!$this->hasObject($index)) {
+        if (!$this->has($index)) {
             $this->handleError('Object with index "' . $index .'" not exists in collection');
         }
         return $this->data[$index];
@@ -113,7 +113,7 @@ public function getObject($index = null) {
      * @return ItemInterface
      */
     public function cloneObject($index) {
-        return clone $this->getObject($index);
+        return clone $this->get($index);
     }
 
     /**
@@ -122,9 +122,9 @@ public function cloneObject($index) {
      * @param mixed $index
      * @return ItemInterface
      */
-    public function moveObject($index) {
-        $object = $this->getObject($index);
-        $this->deleteObject($index);
+    public function move($index) {
+        $object = $this->get($index);
+        $this->delete($index);
         return $object;
     }
 
@@ -133,7 +133,7 @@ public function moveObject($index) {
      *
      * @return ItemInterface
      */
-    public function getFirstObject() {
+    public function getFirst() {
         $data = $this->toArray();
         return array_shift($data);
     }
@@ -143,7 +143,7 @@ public function getFirstObject() {
      *
      * @return ItemInterface
      */
-    public function getLastObject() {
+    public function getLast() {
         $data = $this->toArray();
         return array_pop($data);
     }
@@ -154,7 +154,7 @@ public function getLastObject() {
      * @param mixed $index
      * @return bool
      */
-    public function hasObject($index) {
+    public function has($index) {
         return isset($this->data[$index]);
     }
 
@@ -165,8 +165,8 @@ public function hasObject($index) {
      * @return $this
      * @throws Exception
      */
-    public function deleteObject($index) {
-        if (!$this->hasObject($index)) {
+    public function delete($index) {
+        if (!$this->has($index)) {
             $this->handleError('Object with index "' . $index .'" not exists in collection');
         }
         unset($this->data[$index]);
@@ -179,7 +179,7 @@ public function deleteObject($index) {
      * @param ItemInterface $object
      * @return $this
      */
-    public function setObject(ItemInterface $object) {
+    public function set(ItemInterface $object) {
         $this->data[$object->getId()] = $object;
         return $this;
     }
@@ -191,11 +191,11 @@ public function setObject(ItemInterface $object) {
      * @return $this
      * @throws Exception
      */
-    public function addObject(ItemInterface $object) {
-        if ($this->hasObject($object->getId())) {
+    public function add(ItemInterface $object) {
+        if ($this->has($object->getId())) {
             $this->handleError('Object with index "' . $object->getId() .'" all ready exists in collection');
         }
-        return $this->setObject($object);
+        return $this->set($object);
     }
 
     /**
@@ -309,7 +309,7 @@ public function extract(array $keys) {
         /* @var Collection $collection */
         $collection = new static();
         foreach ($keys as $index) {
-            $collection->addObject($this->getObject($index));
+            $collection->add($this->get($index));
         }
         return $collection;
     }
@@ -343,7 +343,7 @@ public function append(Collection $otherCollection) {
      * @return $this
      */
     public function merge(Collection $otherCollection) {
-        return $this->fillFromArray($otherCollection->toArray(), 'setObject');
+        return $this->fillFromArray($otherCollection->toArray(), 'set');
     }
 
     /**

diff --git a/src/Kachit/Collection/ItemInterface.php b/src/Kachit/Collection/ItemInterface.php
@@ -6,7 +6,6 @@
  */
 namespace Kachit\Collection;
 
-
 interface ItemInterface {
 
     /**

diff --git a/src/Kachit/Collection/ItemObject.php → src/Kachit/Collection/ItemTrait.php b/src/Kachit/Collection/ItemObject.php → src/Kachit/Collection/ItemTrait.php
@@ -1,12 +1,12 @@
 <?php
 /**
- * ItemObject
+ * Item trait
  *
  * @author Kachit
  */
 namespace Kachit\Collection;
 
-class ItemObject implements ItemInterface {
+trait ItemTrait {
 
     /**
      * @var mixed

diff --git a/tests/Kachit/Collection/Test/CollectionTest.php b/tests/Kachit/Collection/Test/CollectionTest.php
@@ -9,6 +9,9 @@
 use Kachit\Collection\Collection;
 use Kachit\Collection\ItemInterface;
 
+use Kachit\Collection\Testable\Collection as TestableCollection;
+use Kachit\Collection\Testable\Object as TestableObject;
+
 class CollectionTest extends \PHPUnit_Framework_TestCase {
 
     /**
@@ -72,7 +75,7 @@ public function testToArray() {
      * RTFN
      */
     public function testGetObject() {
-        $result = $this->testable->getObject(1);
+        $result = $this->testable->get(1);
         $this->assertNotEmpty($result);
         $this->assertTrue(is_object($result));
         $this->assertInstanceOf('Kachit\Collection\ItemInterface', $result);
@@ -82,7 +85,7 @@ public function testGetObject() {
      * RTFN
      */
     public function testGetObjectWithNullIndex() {
-        $result = $this->testable->getObject();
+        $result = $this->testable->get();
         $this->assertNotEmpty($result);
         $this->assertTrue(is_object($result));
         $this->assertInstanceOf('Kachit\Collection\ItemInterface', $result);
@@ -93,15 +96,15 @@ public function testGetObjectWithNullIndex() {
      * RTFN
      */
     public function testGetFirstObject() {
-        $result = $this->testable->getFirstObject();
+        $result = $this->testable->getFirst();
         $this->assertEquals(1, $result->getId());
     }
 
     /**
      * RTFN
      */
     public function testMoveObject() {
-        $result = $this->testable->moveObject(1);
+        $result = $this->testable->move(1);
         $this->assertNotEmpty($result);
         $this->assertTrue(is_object($result));
         $this->assertInstanceOf('Kachit\Collection\ItemInterface', $result);
@@ -113,7 +116,7 @@ public function testMoveObject() {
      * RTFN
      */
     public function testGetLastObject() {
-        $result = $this->testable->getLastObject();
+        $result = $this->testable->getLast();
         $this->assertEquals(10, $result->getId());
     }
 
@@ -127,9 +130,9 @@ public function testExtract() {
         $this->assertTrue(is_object($result));
         $this->assertInstanceOf('Kachit\Collection\Collection', $result);
         $this->assertEquals(3, $result->count());
-        $this->assertTrue($result->hasObject(1));
-        $this->assertTrue($result->hasObject(2));
-        $this->assertTrue($result->hasObject(10));
+        $this->assertTrue($result->has(1));
+        $this->assertTrue($result->has(2));
+        $this->assertTrue($result->has(10));
     }
 
     /**
@@ -160,7 +163,7 @@ public function testCloneObject() {
         $this->assertNotEmpty($result);
         $this->assertTrue(is_object($result));
         $this->assertInstanceOf('Kachit\Collection\ItemInterface', $result);
-        $this->assertFalse($result === $this->testable->getObject(1));
+        $this->assertFalse($result === $this->testable->get(1));
     }
 
     /**
@@ -178,7 +181,7 @@ public function testCloneCollection() {
         $collection = clone $this->testable;
         $this->assertFalse($collection === $this->testable);
         foreach ($collection->getIds() as $key) {
-            $this->assertFalse($collection->getObject($key) === $this->testable->getObject($key));
+            $this->assertFalse($collection->get($key) === $this->testable->get($key));
         }
     }
 
@@ -190,7 +193,7 @@ public function testAppendCollection() {
         $this->testable->append($collection);
         $this->assertEquals(16, $this->testable->count());
         foreach ($collection as $object) {
-            $this->assertTrue($this->testable->hasObject($object->getId()));
+            $this->assertTrue($this->testable->has($object->getId()));
         }
     }
 
@@ -202,7 +205,7 @@ public function testMergeCollection() {
         $this->testable->merge($collection);
         $this->assertEquals(12, $this->testable->count());
         foreach ($collection as $object) {
-            $this->assertTrue($this->testable->hasObject($object->getId()));
+            $this->assertTrue($this->testable->has($object->getId()));
         }
     }
 
@@ -228,7 +231,7 @@ public function testFilterOdd() {
         $this->assertInstanceOf('Kachit\Collection\Collection', $result);
         $this->assertEquals(5, $result->count());
         foreach ($indexes as $key) {
-            $this->assertTrue($result->hasObject($key));
+            $this->assertTrue($result->has($key));
         }
     }
 
@@ -261,9 +264,9 @@ public function testSortSimple() {
     public function testAddObject() {
         $object = $this->getTestableObject();
         $object->setId('foo');
-        $this->testable->addObject($object);
+        $this->testable->add($object);
         $this->assertEquals(11, $this->testable->count());
-        $result = $this->testable->getObject('foo');
+        $result = $this->testable->get('foo');
         $this->assertNotEmpty($result);
         $this->assertTrue(is_object($result));
         $this->assertInstanceOf('Kachit\Collection\ItemInterface', $result);
@@ -273,7 +276,7 @@ public function testAddObject() {
      * RTFN
      */
     public function testDeleteObject() {
-        $this->testable->deleteObject(1);
+        $this->testable->delete(1);
         $this->assertEquals(9, $this->testable->count());
     }
 
@@ -283,7 +286,7 @@ public function testDeleteObject() {
      * @expectedExceptionMessage Object with index "100" not exists in collection
      */
     public function testDeleteUnavailableObject() {
-        $this->testable->deleteObject(100);
+        $this->testable->delete(100);
     }
 
     /**
@@ -294,7 +297,7 @@ public function testDeleteUnavailableObject() {
     public function testAddObjectWithExistingIndex() {
         $object = $this->getTestableObject();
         $object->setId(1);
-        $this->testable->addObject($object);
+        $this->testable->add($object);
     }
 
     /**
@@ -303,9 +306,9 @@ public function testAddObjectWithExistingIndex() {
     public function testSetObject() {
         $object = $this->getTestableObject();
         $object->setId('foo');
-        $this->testable->setObject($object);
+        $this->testable->set($object);
         $this->assertEquals(11, $this->testable->count());
-        $result = $this->testable->getObject('foo');
+        $result = $this->testable->get('foo');
         $this->assertNotEmpty($result);
         $this->assertTrue(is_object($result));
         $this->assertInstanceOf('Kachit\Collection\ItemInterface', $result);
@@ -318,9 +321,9 @@ public function testSetWithExistsIndex() {
         $object = $this->getTestableObject();
         $object->setName('bar');
         $object->setId(1);
-        $this->testable->setObject($object);
+        $this->testable->set($object);
         $this->assertEquals(10, $this->testable->count());
-        $this->assertEquals('bar', $this->testable->getObject(1)->getName());
+        $this->assertEquals('bar', $this->testable->get(1)->getName());
     }
 
     /**
@@ -330,7 +333,7 @@ public function testSetWithExistsIndex() {
      * @expectedExceptionMessage Object with index "100" not exists in collection
      */
     public function testGetObjectUnavailable() {
-        $this->testable->getObject(100);
+        $this->testable->get(100);
     }
 
     /**
@@ -406,7 +409,7 @@ protected function fillCollection() {
         for ($i = 1; $i <= 10; $i++) {
             $object = $this->getTestableObject();
             $object->setId($i);
-            $this->testable->addObject($object);
+            $this->testable->add($object);
         }
     }
 
@@ -420,7 +423,7 @@ protected function getCollectionForAppend() {
         for ($i = 15; $i <= 20; $i++) {
             $object = $this->getTestableObject();
             $object->setId($i);
-            $collection->addObject($object);
+            $collection->add($object);
         }
         return $collection;
     }
@@ -435,7 +438,7 @@ protected function getCollectionForMerge() {
         for ($i = 7; $i <= 12; $i++) {
             $object = $this->getTestableObject();
             $object->setId($i);
-            $collection->addObject($object);
+            $collection->add($object);
         }
         return $collection;
     }

diff --git a/...it/Collection/Test/TestableCollection.php → ...Kachit/Collection/Testable/Collection.php b/...it/Collection/Test/TestableCollection.php → ...Kachit/Collection/Testable/Collection.php
@@ -4,12 +4,12 @@
  *
  * @author Kachit
  */
-namespace Kachit\Collection\Test;
+namespace Kachit\Collection\Testable;
 
-use Kachit\Collection\Collection;
+use Kachit\Collection\Collection as BaseCollection;
 use Kachit\Collection\Exception;
 
-class TestableCollection extends Collection {
+class Collection extends BaseCollection {
 
     /**
      * Get MethodsForAddObject