Implement apull on Objects and Arrays (#8)

TomK · web-flow · commit 35e14d5bf1b2 · 2017-11-08T11:39:15.000Z
* add gitignore

* add apull to Objects

* add apull to Arrays

* update docblocks

* update variable names

* add circle config

* add bcmath
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -0,0 +1,50 @@
+defaults: &defaults
+  steps:
+    # common php steps
+    - run: echo "http://dl-cdn.alpinelinux.org/alpine/edge/community" >> /etc/apk/repositories
+    - run: if [ -n "$ADD_PACKAGES" ]; then apk -U add $ADD_PACKAGES; fi;
+    - run: if [ -n "$ADD_MODULES" ]; then docker-php-ext-install $ADD_MODULES; fi;
+    - run: echo "date.timezone = UTC" >> $(php --ini |grep Scan |awk '{print $NF}')/timezone.ini
+    - run: curl -sS https://getcomposer.org/installer | php -- --install-dir=/usr/bin --filename=composer
+
+    # pre-checkout steps
+
+    # checkout
+    - checkout
+
+    # post-checkout steps
+
+    # run tests
+    - run: composer install -n --prefer-dist
+    - run: php vendor/phpunit/phpunit/phpunit -c phpunit.xml --log-junit /tmp/test-results/phpunit/junit.xml
+    - store_test_results:
+        path: /tmp/test-results
+
+version: 2
+jobs:
+  build-php56:
+    <<: *defaults
+    docker:
+      - image: php:5.6-alpine
+        environment:
+          ADD_MODULES: bcmath
+  build-php70:
+    <<: *defaults
+    docker:
+      - image: php:7.0-alpine
+        environment:
+          ADD_MODULES: bcmath
+  build-php71:
+    <<: *defaults
+    docker:
+      - image: php:7.1-alpine
+        environment:
+          ADD_MODULES: bcmath
+
+workflows:
+  version: 2
+  build:
+    jobs:
+      - build-php56
+      - build-php70
+      - build-php71
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,2 @@
+/vendor
+/composer.lock
diff --git a/src/Arrays.php b/src/Arrays.php
@@ -305,6 +305,42 @@ public static function ipull(array $list, $index, $keyIndex = null)
     return $result;
   }
 
+  /**
+   * Short for 'array pull'.  Extracts specified items from a list of arrays
+   * and returns them in an array keyed by the original key, or alternatively the
+   * value of another item on the array.
+   *
+   * @param array[]     $list     A list of arrays.
+   * @param string[]    $keys     Array of keys to extract.
+   * @param string|null $keyIndex Determines how **keys** will be
+   *                              assigned in the result array. Use a string like
+   *                              'id' to use the specified index as each item's
+   *                              key, or ##null## to preserve the original keys.
+   *
+   * @return array                An array keyed by $keyProperty populated by the
+   *                              properties specified in $properties.
+   */
+  public static function apull(array $list, array $keys, $keyIndex = null)
+  {
+    $result = [];
+    foreach($list as $key => $data)
+    {
+      if($keyIndex !== null)
+      {
+        $key = $data[$keyIndex];
+      }
+
+      $value = [];
+      foreach($keys as $index)
+      {
+        $value[$index] = Arrays::value($data, $index);
+      }
+
+      $result[$key] = $value;
+    }
+    return $result;
+  }
+
   /**
    * Group a list of arrays by the value of some index. This function is the
    * same as @{function:mgroup}, except it operates on the values of array
diff --git a/src/Objects.php b/src/Objects.php
@@ -366,6 +366,43 @@ public static function ppull(array $list, $property, $keyProperty = null)
     return $result;
   }
 
+  /**
+   * Short for 'array pull'.  Extracts specified properties from a list of objects
+   * and returns them in an array keyed by the original key, or alternatively the
+   * value of another property on the object.
+   *
+   * @param array       $list        Some list of objects.
+   * @param string[]    $properties  Array of properties to extract.
+   * @param string|null $keyProperty Determines how **keys** will be
+   *                                 assigned in the result array. Use a string like
+   *                                 'id' to use the result of accessing the named
+   *                                 property as each object's key, or
+   *                                 ##null## to preserve the original keys.
+   *
+   * @return array                   An array keyed by $keyProperty populated by the
+   *                                 properties specified in $properties.
+   */
+  public static function apull(array $list, array $properties, $keyProperty = null)
+  {
+    $result = [];
+    foreach($list as $key => $object)
+    {
+      if($keyProperty !== null && is_object($object))
+      {
+        $key = $object->$keyProperty;
+      }
+
+      $value = [];
+      foreach($properties as $property)
+      {
+        $value[$property] = Objects::property($object, $property);
+      }
+
+      $result[$key] = $value;
+    }
+    return $result;
+  }
+
   /**
    * Group a list of objects by the result of some method, similar to how
    * GROUP BY works in an SQL query. This function simplifies grouping objects
diff --git a/tests/ArraysTest.php b/tests/ArraysTest.php
@@ -352,6 +352,35 @@ public function testIpull()
     $this->assertEquals($expected, Arrays::ipull($list, null, 'name'));
   }
 
+  public function testApull()
+  {
+    $a = [
+      'name'   => "a",
+      'value1' => 1,
+      'value2' => 2,
+    ];
+    $b = [
+      'name'   => "b",
+      'value1' => 2,
+      'value2' => 3,
+    ];
+    $c = [
+      'name'   => "c",
+      'value1' => 3,
+      'value2' => 4,
+    ];
+    $list = [$a, $b, $c];
+
+    $this->assertEquals(
+      [
+        'a' => ['value1' => 1, 'value2' => 2],
+        'b' => ['value1' => 2, 'value2' => 3],
+        'c' => ['value1' => 3, 'value2' => 4],
+      ],
+      Arrays::apull($list, ['value1', 'value2'], 'name')
+    );
+  }
+
   public function testIsort()
   {
     $list = [
diff --git a/tests/ObjectsTest.php b/tests/ObjectsTest.php
@@ -137,7 +137,7 @@ public function testClassShortName()
     $expectations = [
       ['Strings', "Strings"],
       ['\Packaged\Helpers\Strings', "Strings"],
-      [new \Packaged\Helpers\Strings, "Strings"],
+      [new \Packaged\Helpers\Strings(), "Strings"],
     ];
     foreach($expectations as $expect)
     {
@@ -174,7 +174,7 @@ public function testGetNamespace()
       ['', ''],
       ['Strings', ''],
       ['\Packaged\Helpers\Strings', '\Packaged\Helpers'],
-      [new \Packaged\Helpers\Strings, '\Packaged\Helpers'],
+      [new \Packaged\Helpers\Strings(), '\Packaged\Helpers'],
     ];
     foreach($expectations as $expect)
     {
@@ -222,6 +222,32 @@ public function testPpull()
     $this->assertEquals($expected, Objects::ppull($list, null, 'name'));
   }
 
+  public function testApull()
+  {
+    $a = new stdClass();
+    $a->name = "a";
+    $a->value1 = 1;
+    $a->value2 = 2;
+    $b = new stdClass();
+    $b->name = "b";
+    $b->value1 = 2;
+    $b->value2 = 3;
+    $c = new stdClass();
+    $c->name = "c";
+    $c->value1 = 3;
+    $c->value2 = 4;
+    $list = [$a, $b, $c];
+
+    $this->assertEquals(
+      [
+        'a' => ['value1' => 1, 'value2' => 2],
+        'b' => ['value1' => 2, 'value2' => 3],
+        'c' => ['value1' => 3, 'value2' => 4],
+      ],
+      Objects::apull($list, ['value1', 'value2'], 'name')
+    );
+  }
+
   public function testMsort()
   {
     $a = new MFilterTestHelper('1', 'a', 'q');
@@ -251,21 +277,21 @@ public function testMGroup()
     $expect = [
       'food'     => [
         'fruit'     => ['a' => $apple],
-        'vegetable' => ['c' => $carrot]
+        'vegetable' => ['c' => $carrot],
       ],
       'creature' => [
-        'animal' => ['b' => $bear]
+        'animal' => ['b' => $bear],
       ],
     ];
     $this->assertEquals($expect, Objects::mgroup($list, 'group', 'type'));
 
     $expect = [
       'food'     => [
         'a' => $apple,
-        'c' => $carrot
+        'c' => $carrot,
       ],
       'creature' => [
-        'b' => $bear
+        'b' => $bear,
       ],
     ];
     $this->assertEquals($expect, Objects::mgroup($list, 'group'));
@@ -289,10 +315,10 @@ public function testPGroup()
     $expect = [
       'food'     => [
         'fruit'     => ['a' => $apple],
-        'vegetable' => ['c' => $carrot]
+        'vegetable' => ['c' => $carrot],
       ],
       'creature' => [
-        'animal' => ['b' => $bear]
+        'animal' => ['b' => $bear],
       ],
     ];
     $this->assertEquals(
@@ -303,10 +329,10 @@ public function testPGroup()
     $expect = [
       'food'     => [
         'a' => $apple,
-        'c' => $carrot
+        'c' => $carrot,
       ],
       'creature' => [
-        'b' => $bear
+        'b' => $bear,
       ],
     ];
     $this->assertEquals($expect, Objects::pgroup($list, 'groupProperty'));
@@ -326,7 +352,7 @@ public function testPsort()
         ["apple" => $apple, "pear" => $pear, "grape" => $grape],
         "name",
         ["apple" => $apple, "grape" => $grape, "pear" => $pear],
-      ]
+      ],
     ];
     foreach($expectations as $expect)
     {
