[DEV-5152] TC: Data Warehouse: Multi-Supplier/Line Quotes

Author: Corey Vollmer

composer.json

@@ -1,7 +1,7 @@
 {
     "name": "lovullo/libliza-php",
     "description": "PHP client for the Liza Data Collection Framework",
-    "version": "0.7.1",
+    "version": "0.7.2",
     "type": "project",
     "keywords": [ "liza" ],
     "license": "GPL-3.0+",

src/Bucket/Bucket.php

@@ -50,6 +50,18 @@ interface Bucket
     public function getDataByName( $name, $index = null );
 
 
+    /**
+     * Return the values associated with the provided regex
+     *
+     * @param string $regex  regex for key
+     *
+     * @return array values associated with the key
+     *
+     * @throws \DomainException if requested index does not exist
+     */
+    public function getDataByRegEx( $regex );
+
+
     /**
      * Whether the given key and (optionally) index exist
      *

src/Bucket/ImmutableBucket.php

@@ -61,13 +61,34 @@ public function __construct( array $data )
     }
 
 
+    /**
+     * Return the values associated with the provided regex
+     *
+     * @param string $regex regex for key
+     *
+     * @return array values associated with the key
+     */
+    public function getDataByRegEx( $regex )
+    {
+        $data      = [];
+        $data_keys = preg_grep( $regex, array_keys( $this->_data ) );
+
+        foreach ( $data_keys as $key )
+        {
+            $data[ $key ] = $this->getDataByName( $key );
+        }
+
+        return $data;
+    }
+
+
     /**
      * Return the values associated with the provided key
      *
      * This method accepts an index due to PHP's lack of array dereferencing
      * support prior to 5.4.
      *
-     * @param string $name  name of key
+     * @param string $name name of key
      * @param int    $index index to return
      *
      * @return array values associated with the key

test/Bucket/BucketTestCase.php

@@ -75,6 +75,23 @@ public function testCanRetrieveBucketDataByName()
     }
 
 
+    /**
+     * The bucket data should be retrievable by the RegEx, so long as
+     * it exists.
+     */
+    public function testGetDataByRegEx()
+    {
+        $key = '_foo';
+        $result = $this->getSut( $this->_initialData )->getDataByRegEx( '/'. $key .'/' );
+        $this->assertEquals(
+            $this->_initialData[ $key ],
+            $result[ $key ],
+            'Bucket should return the value identified by a given name'
+        );
+    }
+
+
+
     /**
      * PHP < 5.4's lack of array dereferencing support can be rather
      * frustrating.  As such, getDataByName() should also accept an index to

test/Document/DocumentTest.php

@@ -32,7 +32,7 @@ protected function getDummyBucket()
         return $this->getMockBuilder(
             "Lovullo\Liza\Bucket\Bucket"
         )
-            ->setMethods( array( "getDataByName", "hasData" ) )
+            ->setMethods( array( "getDataByName", "hasData", "getDataByRegEx" ) )
             ->getMock();
     }