Merge pull request #3 from byjg/4.9

Allow to change Property Index in the Iterator
byjg · Jan 4, 2024 · 189c5d4 · 189c5d4
2 parents 9deb0da + 94733c8
commit 189c5d4
Show file tree

Hide file tree

Showing 7 changed files with 84 additions and 39 deletions.
diff --git a/.github/workflows/phpunit.yml b/.github/workflows/phpunit.yml
@@ -16,23 +16,22 @@ jobs:
     strategy:
       matrix:
         php-version:
+          - "8.2"
           - "8.1"
           - "8.0"
           - "7.4"
-          - "7.3"
-          - "7.2"
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - run: composer install
       - run: ./vendor/bin/phpunit
 
   Documentation:
-    runs-on: 'ubuntu-latest'
-    needs: Build
     if: github.ref == 'refs/heads/master'
-    env:
-      DOC_GITHUB_TOKEN: '${{ secrets.DOC_TOKEN }}'
-    steps:
-      - uses: actions/checkout@v3
-      - run: curl https://opensource.byjg.com/add-doc.sh | bash /dev/stdin php anydataset-array
+    needs: Build
+    uses: byjg/byjg.github.io/.github/workflows/add-doc.yaml@master
+    with:
+      folder: php
+      project: ${{ github.event.repository.name }}
+    secrets: inherit
+
diff --git a/README.md b/README.md
@@ -1,13 +1,12 @@
 # AnyDataset-Array
 
-[![Build Status](https://github.com/byjg/anydataset-array/actions/workflows/phpunit.yml/badge.svg?branch=master)](https://github.com/byjg/anydataset-array/actions/workflows/phpunit.yml)
+[![Build Status](https://github.com/byjg/php-anydataset-array/actions/workflows/phpunit.yml/badge.svg?branch=master)](https://github.com/byjg/php-anydataset-array/actions/workflows/phpunit.yml)
 [![Opensource ByJG](https://img.shields.io/badge/opensource-byjg-success.svg)](http://opensource.byjg.com)
-[![GitHub source](https://img.shields.io/badge/Github-source-informational?logo=github)](https://github.com/byjg/anydataset-array/)
-[![GitHub license](https://img.shields.io/github/license/byjg/anydataset-array.svg)](https://opensource.byjg.com/opensource/licensing.html)
-[![GitHub release](https://img.shields.io/github/release/byjg/anydataset-array.svg)](https://github.com/byjg/anydataset-array/releases/)
+[![GitHub source](https://img.shields.io/badge/Github-source-informational?logo=github)](https://github.com/byjg/php-anydataset-array/)
+[![GitHub license](https://img.shields.io/github/license/byjg/php-anydataset-array.svg)](https://opensource.byjg.com/opensource/licensing.html)
+[![GitHub release](https://img.shields.io/github/release/byjg/php-anydataset-array.svg)](https://github.com/byjg/php-anydataset-array/releases/)
 
-
-Array abstraction dataset. Anydataset is an agnostic data source abstraction layer in PHP. 
+Array abstraction dataset. Anydataset is an agnostic data source abstraction layer in PHP.
 
 See more about Anydataset [here](https://opensource.byjg.com/php/anydataset).
 
@@ -111,10 +110,10 @@ foreach ($iterator as $row) {
 
 ## Install
 
-Just type: 
+Just type:
 
 ```bash
-composer require "byjg/anydataset-array=4.0.*"
+composer require "byjg/anydataset-array"
 ```
 
 ## Running Unit tests
@@ -123,5 +122,12 @@ composer require "byjg/anydataset-array=4.0.*"
 vendor/bin/phpunit
 ```
 
+## Dependencies
+
+```mermaid
+flowchart TD
+    byjg/anydataset-array --> byjg/anydataset
+```
+
 ----
 [Open source ByJG](http://opensource.byjg.com)
diff --git a/composer.json b/composer.json
@@ -9,7 +9,7 @@
   "prefer-stable": true,
   "minimum-stability": "dev",
   "require": {
-    "php": ">=5.6.0",
+    "php": ">=7.4",
     "byjg/anydataset": "4.9.*"
   },
   "require-dev": {

diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -20,17 +20,17 @@ and open the template in the editor.
         <ini name="display_startup_errors" value="On" />
         <ini name="error_reporting" value="E_ALL" />
     </php>
-    
+
     <filter>
         <whitelist>
             <directory>./src</directory>
         </whitelist>
     </filter>
-    
+
     <testsuites>
         <testsuite name="Test Suite">
             <directory>./tests</directory>
         </testsuite>
     </testsuites>
-    
+
 </phpunit>
diff --git a/src/ArrayDataset.php b/src/ArrayDataset.php
@@ -13,27 +13,33 @@ class ArrayDataset
      * @var array
      */
     protected $array;
+    /**
+     * @var mixed|string
+     */
+    protected $propertyIndexName;
+    /**
+     * @var mixed|string
+     */
+    protected $propertyKeyName;
 
     /**
      * Constructor Method
      *
      * @param array $array
-     * @param string $fieldName
+     * @param string $property The name of the field if the item is not an array or object
      */
-    public function __construct($array, $fieldName = "value")
+    public function __construct(array $array, string $property = "value", $propertyIndexName = "__id", $propertyKeyName = "__key")
     {
-
-        if (!is_array($array)) {
-            throw new UnexpectedValueException("You need to pass an array");
-        }
+        $this->propertyIndexName = $propertyIndexName;
+        $this->propertyKeyName = $propertyKeyName;
 
         $this->array = [];
 
         foreach ($array as $key => $value) {
             if (is_array($value)) {
                 $this->array[$key] = $value;
             } elseif (!is_object($value)) {
-                $this->array[$key] = array($fieldName => $value);
+                $this->array[$key] = array($property => $value);
             } else {
                 $result = array("__class" => get_class($value));
                 $methods = get_class_methods($value);
@@ -57,6 +63,6 @@ public function __construct($array, $fieldName = "value")
      */
     public function getIterator($filter = null)
     {
-        return new ArrayDatasetIterator($this->array, $filter);
+        return new ArrayDatasetIterator($this->array, $filter, $this->propertyIndexName, $this->propertyKeyName);
     }
 }
diff --git a/src/ArrayDatasetIterator.php b/src/ArrayDatasetIterator.php
@@ -36,12 +36,20 @@ class ArrayDatasetIterator extends GenericIterator
      * @var IteratorFilter
      */
     protected $filter;
+    /**
+     * @var mixed|string
+     */
+    protected $propertyIndexName;
+    /**
+     * @var mixed|string
+     */
+    protected $propertyKeyName;
 
     /**
      * @param array $rows
      * @param IteratorFilter $filter
      */
-    public function __construct($rows, $filter)
+    public function __construct($rows, $filter, $propertyIndexName = "__id", $propertyKeyName = "__key")
     {
         if (!is_array($rows)) {
             throw new InvalidArgumentException("ArrayDatasetIterator must receive an array");
@@ -51,6 +59,10 @@ public function __construct($rows, $filter)
         $this->rows = $rows;
         $this->keys = array_keys($rows);
         $this->filter = $filter;
+
+        $this->propertyIndexName = $propertyIndexName;
+        $this->propertyKeyName = $propertyKeyName;
+
     }
 
     /**
@@ -81,8 +93,12 @@ public function hasNext()
         $cols = $this->rows[$key];
 
         $arr = [];
-        $arr["__id"] = $ix;
-        $arr["__key"] = $key;
+        if (!empty($this->propertyIndexName)) {
+            $arr[$this->propertyIndexName] = $ix;
+        }
+        if (!empty($this->propertyKeyName)) {
+            $arr[$this->propertyKeyName] = $key;
+        }
         foreach ($cols as $key => $value) {
             $arr[strtolower($key)] = $value;
         }

diff --git a/tests/ArrayDatasetTest.php b/tests/ArrayDatasetTest.php
@@ -5,6 +5,7 @@
 use ByJG\AnyDataset\Core\Enum\Relation;
 use ByJG\AnyDataset\Core\IteratorFilter;
 use ByJG\AnyDataset\Core\IteratorInterface;
+use ByJG\AnyDataset\Core\Row;
 use ByJG\AnyDataset\Lists\ArrayDataset;
 use PHPUnit\Framework\TestCase;
 use Tests\AnyDataset\Sample\ModelGetter;
@@ -24,12 +25,6 @@ class ArrayDatasetTest extends TestCase
         "B" => array('code' => 1001, 'name' => "ProdB"),
         "C" => array('code' => 1002, 'name' => "ProdC"));
 
-    public function testInvalidConstructor()
-    {
-        $this->expectException(UnexpectedValueException::class);
-        new ArrayDataset('aaa');
-    }
-
     public function testcreateArrayIteratorSample1()
     {
         $arrayDataset = new ArrayDataset($this->SAMPLE1);
@@ -356,5 +351,28 @@ public function testEmptyArray()
 
         $this->assertEquals(0, $iterator->count());
     }
+
+    public function testPropertyKeyName()
+    {
+        $dataset = new ArrayDataset($this->SAMPLE1, "value", "id", "name");
+
+        $iterator = $dataset->getIterator();
+
+        $row = $iterator->moveNext();
+        $this->assertField($row, "id", 0);
+        $this->assertField($row, "name", 0);
+        $this->assertField($row, "value", "ProdA");
+
+    }
+
+    public function testPropertyKeyNameEmpty()
+    {
+        $dataset = new ArrayDataset($this->SAMPLE1, "value", null, null);
+
+        $iterator = $dataset->getIterator();
+
+        $row = $iterator->moveNext();
+        $this->assertEquals(["value" => 'ProdA'], $row->toArray());
+    }
 }