test remove_key

Author: brenoroosevelt

composer.json

@@ -37,6 +37,7 @@
             "src/Expand.php",
             "src/DotNotation.php",
             "src/Remove.php",
+            "src/RemoveKey.php",
             "src/array_functions.php"
         ]
     },

src/RemoveKey.php

@@ -0,0 +1,24 @@
+<?php
+declare(strict_types=1);
+
+namespace BrenoRoosevelt;
+
+/**
+ * Remove elements by keys
+ *
+ * @param array $set The collection
+ * @param string|int ...$keys The keys to be removed
+ * @return int The number of removed elements
+ */
+function remove_key(array &$set, ...$keys): int
+{
+    $removed = 0;
+    foreach ($keys as $key) {
+        if (array_key_exists($key, $set)) {
+            unset($set[$key]);
+            $removed++;
+        }
+    }
+
+    return $removed;
+}

src/array_functions.php

@@ -3,19 +3,6 @@
 
 namespace BrenoRoosevelt;
 
-function remove_key(array &$set, ...$keys): int
-{
-    $removed = 0;
-    foreach ($keys as $key) {
-        if (array_key_exists($key, $set)) {
-            unset($set[$key]);
-            $removed++;
-        }
-    }
-
-    return $removed;
-}
-
 function pull(array &$set, $key, $default = null)
 {
     $value = $set[$key] ?? $default;

tests/RemoveKeyTest.php

@@ -0,0 +1,31 @@
+<?php
+declare(strict_types=1);
+
+namespace BrenoRoosevelt\Tests;
+
+use PHPUnit\Framework\TestCase;
+use function BrenoRoosevelt\remove_key;
+
+class RemoveKeyTest extends TestCase
+{
+    public function testRemoveOneKey()
+    {
+        $elements = [1, 'a' => 2, 'b' => 3];
+        $this->assertEquals(1, remove_key($elements, 0));
+        $this->assertEquals(['a' => 2, 'b' => 3], $elements);
+    }
+
+    public function testRemoveManyKeys()
+    {
+        $elements = [1, 'a' => 2, 'b' => 3];
+        $this->assertEquals(2, remove_key($elements, 0, 'a'));
+        $this->assertEquals(['b' => 3], $elements);
+    }
+
+    public function testDontRemoveKey()
+    {
+        $elements = [1, 'a' => 2, 'b' => 3];
+        $this->assertEquals(0, remove_key($elements, 1));
+        $this->assertEquals([1, 'a' => 2, 'b' => 3], $elements);
+    }
+}