Initial commit, ported methods from Fetch! CMS

Author: koenpunt

.gitignore

@@ -0,0 +1,3 @@
+/vendor
+/test/coverage
+/composer.lock

composer.json

@@ -0,0 +1,20 @@
+{
+    "name": "fetch/array-utils",
+    "description": "Array utility methods, inspired by Ruby's array methods",
+    "keywords": ["array", "utils"],
+    "homepage": "https://github.com/fetch/php-array-utils",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Koen Punt",
+            "email": "koen@fetch.nl",
+            "homepage": "https://github.com/koenpunt"
+        }
+    ],
+    "require-dev": {
+        "phpunit/phpunit": "~4.5"
+    },
+    "autoload": {
+        "files": ["lib/array.php"]
+    }
+}

lib/array.php

@@ -0,0 +1,111 @@
+<?php
+
+namespace {
+
+  if(!function_exists('array_delete')){
+
+    /**
+     * Deletes entry from array and return its value
+     *
+     * @param array $data
+     * @param string $key
+     * @return mixed
+     */
+    function array_delete(array &$data, $key){
+      if(array_key_exists($key, $data)){
+        $value = $data[$key];
+        unset($data[$key]);
+        return $value;
+      }
+    }
+
+  }
+
+  if(!function_exists('array_get')){
+
+    /**
+     * Lookup entry in array and return value, returns false if not found
+     *
+     * @param array $data
+     * @param string $key
+     * @return mixed
+     */
+    function array_get(array &$data, $key){
+      if(array_key_exists($key, $data)){
+        return $data[$key];
+      }
+      return false;
+    }
+
+  }
+
+  if(!function_exists('array_flatten')){
+
+    /**
+     * Make multidimensional array flat
+     *
+     * @param array $array
+     * @return array
+     */
+    function array_flatten(array $array){
+      $index = 0;
+      $count = count($array);
+
+      while($index < $count){
+        if(is_array($array[$index])){
+          array_splice($array, $index, 1, $array[$index]);
+        }else{
+          ++$index;
+        }
+        $count = count($array);
+      }
+      return $array;
+    }
+
+  }
+
+  if(!function_exists('array_pick')){
+
+    /**
+     * Return array with only the keys in $keys
+     *
+     * @param array $array The source
+     * @param mixed $keys Keys of $array to return
+     * @return array
+     */
+    function array_pick(array $array, $keys){
+      $arguments = func_get_args();
+      if(func_num_args() > 2){
+        $keys = array_slice($arguments, 1);
+      }
+      if(!is_array($keys)){
+        $keys = array($keys);
+      }
+      return array_intersect_key($array, array_flip($keys));
+    }
+
+  }
+
+  if(!function_exists('array_reject')){
+
+    /**
+     * Return array without the keys in $keys.
+     * This is the inverse of array_pick
+     *
+     * @param array $array The source
+     * @param mixed $keys Keys of $array to exclude
+     * @return array
+     */
+    function array_reject(array $array, $keys){
+      $arguments = func_get_args();
+      if(func_num_args() > 2){
+        $keys = array_slice($arguments, 1);
+      }
+      if(!is_array($keys)){
+        $keys = array($keys);
+      }
+      return array_diff_key($array, array_flip($keys));
+    }
+
+  }
+}

phpunit.xml.dist

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit bootstrap="vendor/autoload.php" colors="true">
+  <logging>
+    <log type="coverage-html" target="test/coverage/" charset="UTF-8"
+      highlight="false" lowUpperBound="35" highLowerBound="70" />
+  </logging>
+  <testsuites>
+    <testsuite name="Array utils Suite">
+      <directory suffix="_test.php">./test</directory>
+    </testsuite>
+  </testsuites>
+  <filter>
+    <whitelist addUncoveredFilesFromWhitelist="true">
+      <directory suffix=".php">lib</directory>
+    </whitelist>
+  </filter>
+</phpunit>

test/unit/array_test.php

@@ -0,0 +1,51 @@
+<?php
+
+class ArrayTest extends PHPUnit_Framework_TestCase {
+
+  public function test_array_delete(){
+    $ar = array('key1' => 'Foo', 'key2' => 'bar');
+    $this->assertEquals('Foo', array_delete($ar, 'key1'));
+    $this->assertEquals(array('key2' => 'bar'), $ar);
+
+    $this->assertNull(array_delete($ar, 'not_existing'));
+    $this->assertEquals(array('key2' => 'bar'), $ar);
+  }
+
+  public function test_array_get(){
+    $ref = array('key1' => 'Foo', 'key2' => 'bar');
+    $ar1 = $ref;
+    $this->assertEquals('Foo', array_get($ar1, 'key1'));
+    $this->assertEquals($ref, $ar1);
+    $this->assertFalse(array_get($ar1, 'not_existing'));
+    $this->assertEquals($ref, $ar1);
+  }
+
+  public function test_array_flatten(){
+    $this->assertEquals(array(), array_flatten(array()));
+    $this->assertEquals(array(1), array_flatten(array(1)));
+    $this->assertEquals(array(1), array_flatten(array(array(1))));
+    $this->assertEquals(array(1, 2), array_flatten(array(array(1, 2))));
+    $this->assertEquals(array(1, 2), array_flatten(array(array(1), 2)));
+    $this->assertEquals(array(1, 2), array_flatten(array(1, array(2))));
+    $this->assertEquals(array(1, 2, 3), array_flatten(array(1, array(2), 3)));
+    $this->assertEquals(array(1, 2, 3, 4), array_flatten(array(1, array(2, 3), 4)));
+    $this->assertEquals(array(1, 2, 3, 4, 5, 6), array_flatten(array(1, array(2, 3), 4, array(5, 6))));
+  }
+
+  public function test_array_pick(){
+    $this->assertEquals(array(), array_pick(array(), array('foo', 'bar', 'baz')));
+    $this->assertEquals(array(), array_pick(array('bzz' => 'bar'), array('foo', 'bar', 'baz')));
+    $this->assertEquals(array('foo' => 'bar'), array_pick(array('foo' => 'bar'), array('foo', 'bar', 'baz')));
+    $this->assertEquals(array('foo' => 'bar'), array_pick(array('foo' => 'bar'), 'foo', 'bar'));
+    $this->assertEquals(array('foo' => 'bar'), array_pick(array('foo' => 'bar'), 'foo'));
+  }
+
+  public function test_array_reject(){
+    $this->assertEquals(array(), array_reject(array(), array('foo', 'bar', 'baz')));
+    $this->assertEquals(array('bzz' => 'bar'), array_reject(array('bzz' => 'bar'), array('foo', 'bar', 'baz')));
+    $this->assertEquals(array(), array_reject(array('foo' => 'bar'), array('foo', 'bar', 'baz')));
+    $this->assertEquals(array(), array_reject(array('foo' => 'bar'), 'foo', 'bar'));
+    $this->assertEquals(array('foo' => 'bar'), array_reject(array('foo' => 'bar'), 'bar'));
+  }
+
+}