test pull

Author: brenoroosevelt

composer.json

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

src/Pull.php

@@ -0,0 +1,20 @@
+<?php
+declare(strict_types=1);
+
+namespace BrenoRoosevelt;
+
+/**
+ * Pulls and returns an element by key
+ *
+ * @param array $set The array containing the elements/keys
+ * @param string|int $key The key to be pulled
+ * @param mixed $default default value that will be returned if the key does not exist
+ * @return mixed|null pulled element or `default` parameter
+ */
+function pull(array &$set, $key, $default = null)
+{
+    $value = $set[$key] ?? $default;
+    unset($set[$key]);
+
+    return $value;
+}

src/array_functions.php

@@ -3,14 +3,6 @@
 
 namespace BrenoRoosevelt;
 
-function pull(array &$set, $key, $default = null)
-{
-    $value = $set[$key] ?? $default;
-    unset($set[$key]);
-
-    return $value;
-}
-
 function reindex(array &$items): void
 {
     $items = array_values($items);

tests/PullTest.php

@@ -0,0 +1,24 @@
+<?php
+declare(strict_types=1);
+
+namespace BrenoRoosevelt\Tests;
+
+use PHPUnit\Framework\TestCase;
+use function BrenoRoosevelt\pull;
+
+class PullTest extends TestCase
+{
+    public function testPullKey()
+    {
+        $elements = [1, 'a' => 2, 'b' => 3];
+        $this->assertEquals(1, pull($elements, 0));
+        $this->assertEquals(['a' => 2, 'b' => 3], $elements);
+    }
+
+    public function testPullRetunsDefault()
+    {
+        $elements = [1, 'a' => 2, 'b' => 3];
+        $this->assertEquals('k', pull($elements, 1, 'k'));
+        $this->assertEquals([1, 'a' => 2, 'b' => 3], $elements);
+    }
+}