init function (lstrojny#154)

sphaso · lstrojny · commit 94c019799295 · 2018-01-10T12:24:11.000+02:00
but_last() function to return all elements but the last
diff --git a/composer.json b/composer.json
@@ -24,6 +24,7 @@
         "psr-4": {"Functional\\": "src/Functional"},
         "files": [
             "src/Functional/Average.php",
+            "src/Functional/ButLast.php",
             "src/Functional/Capture.php",
             "src/Functional/ConstFunction.php",
             "src/Functional/CompareOn.php",
diff --git a/src/Functional/ButLast.php b/src/Functional/ButLast.php
@@ -0,0 +1,41 @@
+<?php
+/**
+ * Copyright (C) 2011-2017 by Lars Strojny <lstrojny@php.net>
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+namespace Functional;
+use Functional\Exceptions\InvalidArgumentException;
+use Traversable;
+
+/**
+ * Returns an array containing the elements of the list without its last element.
+ *
+ * @param Traversable|array $collection
+ * @return array
+ */
+function but_last($collection)
+{
+    InvalidArgumentException::assertCollection($collection, __FUNCTION__, 1);
+
+    $butLast = is_array($collection) ? $collection : iterator_to_array($collection);
+    array_pop($butLast);
+
+    return $butLast;
+}
diff --git a/tests/Functional/ButLastTest.php b/tests/Functional/ButLastTest.php
@@ -0,0 +1,50 @@
+<?php
+/**
+ * Copyright (C) 2011-2017 by Lars Strojny <lstrojny@php.net>
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the 'Software'), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+namespace Functional\Tests;
+
+use ArrayIterator;
+use Functional\Exceptions\InvalidArgumentException;
+use function Functional\but_last;
+
+class ButLastTest extends AbstractTestCase
+{
+    public function setUp()
+    {
+        parent::setUp();
+        $this->list = [1, 2, 3, 4];
+        $this->listIterator = new ArrayIterator($this->list);
+    }
+
+    public function test()
+    {
+        $this->assertSame([0 => 1, 1 => 2, 2 => 3], but_last($this->list));
+        $this->assertSame([0 => 1, 1 => 2, 2 => 3], but_last($this->listIterator));
+        $this->assertSame([], but_last([]));
+    }
+
+    public function testPassNoCollection()
+    {
+        $this->expectArgumentError('Functional\but_last() expects parameter 1 to be array or instance of Traversable');
+        but_last('invalidCollection');
+    }
+}
