Fix: ImmutableArrayCollection now can be constructed and/or created

Added: diffKeysAssoc and keys methods
sauls · Feb 18, 2018 · 71020d8 · 71020d8
1 parent ee3f922
commit 71020d8
Show file tree

Hide file tree

Showing 5 changed files with 144 additions and 0 deletions.
diff --git a/Readme.md b/Readme.md
@@ -33,3 +33,4 @@ $ composer require sauls/collections
 Available collections
 
 * ArrayCollection
+* ImmutableArrayCollection
diff --git a/src/ArrayCollection.php b/src/ArrayCollection.php
@@ -13,7 +13,9 @@
 namespace Sauls\Component\Collection;
 
 use function Sauls\Component\Helper\array_deep_search;
+use function Sauls\Component\Helper\array_diff_key_assoc;
 use function Sauls\Component\Helper\array_get_value;
+use function Sauls\Component\Helper\array_key_assoc;
 use function Sauls\Component\Helper\array_remove_key;
 use function Sauls\Component\Helper\array_remove_value;
 use function Sauls\Component\Helper\array_merge;
@@ -276,4 +278,19 @@ public function diffAssoc(array $elements, \Closure $function = null): Collectio
 
         return $this->create($difference);
     }
+
+    public function keys(): Collection
+    {
+        return $this->create(array_key_assoc($this->elements));
+    }
+
+    protected function assign(array $elements): void
+    {
+        $this->elements = $elements;
+    }
+
+    public function diffKeysAssoc(array $elements): Collection
+    {
+        return $this->create(array_diff_key_assoc($this->elements, $elements));
+    }
 }
diff --git a/src/Collection.php b/src/Collection.php
@@ -30,7 +30,9 @@ public function sort(\Closure $function = null): Collection;
     public function sortKeys(\Closure $function = null): Collection;
     public function diff(array $elements, \Closure $function = null): Collection;
     public function diffKeys(array $elements, \Closure $function = null): Collection;
+    public function diffKeysAssoc(array $elements): Collection;
     public function diffAssoc(array $elements, \Closure $function = null): Collection;
+    public function keys(): Collection;
     public function map(\Closure $function);
     public function keyOrValueExists($keyOrValue): bool;
     public function keyOrValueDoesNotExists($keyOrValue): bool;

diff --git a/src/ImmutableArrayCollection.php b/src/ImmutableArrayCollection.php
@@ -16,6 +16,11 @@
 
 class ImmutableArrayCollection extends ArrayCollection
 {
+    public function __construct($elements = null)
+    {
+        $this->assign((new ArrayCollection($elements))->all());
+    }
+
     /**
      * @throws \Sauls\Component\Collection\Exception\UnsupportedOperationException
      */

diff --git a/tests/ArrayCollectionTest.php b/tests/ArrayCollectionTest.php
@@ -386,6 +386,36 @@ public function should_return_existence_of_key_or_value()
         $this->assertFalse($arrayCollection->keyOrValueExists('key2.b'));
     }
 
+    /**
+     * @test
+     */
+    public function should_construct_immutable_array_collection(): void
+    {
+        $immutableArrayCollection = new ImmutableArrayCollection(['no' => 'change']);
+
+        $this->assertSame(
+            [
+                'no' => 'change',
+            ],
+            $immutableArrayCollection->all()
+        );
+    }
+
+    /**
+     * @test
+     */
+    public function should_create_immutable_array_collection(): void
+    {
+        $immutableArrayCollection = (new ImmutableArrayCollection())->create(['no' => 'change']);
+
+        $this->assertSame(
+            [
+                'no' => 'change',
+            ],
+            $immutableArrayCollection->all()
+        );
+    }
+
     /**
      * @test
      */
@@ -874,4 +904,93 @@ function($a, $b) {
             )->all()
         );
     }
+
+    /**
+     * @test
+     */
+    public function should_return_flat_array_keys()
+    {
+        $arrayCollection = new ArrayCollection([
+            'a' => 1,
+            'b' => 2,
+        ]);
+
+        $this->assertSame(
+            [
+                0 => 'a',
+                1 => 'b',
+            ],
+            $arrayCollection->keys()->all()
+        );
+    }
+
+    /**
+     * @test
+     */
+    public function should_return_assoc_array_keys()
+    {
+        $arrayCollection = new ArrayCollection([
+            'a' => 1,
+            'c' => [
+                'd' => 11
+            ],
+            'g' => 2,
+            'x' => [
+                'y' => [
+                    'z' => [
+                        'yes' => 11
+                    ]
+                ]
+            ]
+        ]);
+
+        $this->assertSame(
+            [
+                0 => 'a',
+                1 => 'c.d',
+                2 => 'g',
+                3 => 'x.y.z.yes',
+            ],
+            $arrayCollection->keys()->all()
+        );
+    }
+
+    /**
+     * @test
+     */
+    public function should_diff_keys_with_associative_arrays(): void
+    {
+        $array1 = [
+            'a' => 1,
+            'b' => 2,
+            'c' => [
+                'd' => 13
+            ],
+            'x' => [
+                'y' => [
+                    'z' => 11,
+                ]
+            ]
+        ];
+        $arrayCollection = new ArrayCollection($array1);
+        $array2 = [
+            'b' => 4,
+            'c' => [
+                'd' =>11,
+            ]
+        ];
+
+
+        $this->assertSame(
+            [
+                'a' => 1,
+                'x' => [
+                    'y' => [
+                        'z' => 11,
+                    ]
+                ],
+            ],
+            $arrayCollection->diffKeysAssoc($array2)->all()
+        );
+    }
 }