Merge pull request #14 from byjg/5.0.0

byjg · web-flow · commit aee3d9eb3927 · 2024-01-03T17:57:00.000-06:00
Documentation Change
diff --git a/.github/workflows/phpunit.yml b/.github/workflows/phpunit.yml
@@ -8,8 +8,6 @@ on:
   pull_request:
     branches:
       - master
-  schedule:
-    - cron: "0 8 * * 1"
 
 jobs:
   Build:
@@ -18,25 +16,23 @@ jobs:
     strategy:
       matrix:
         php-version:
+          - "8.2"
           - "8.1"
           - "8.0"
           - "7.4"
-          - "7.3"
-          - "7.2"
-          - "7.1"
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - run: composer install
       - run: ./vendor/bin/phpunit
       - run: ./vendor/bin/psalm
 
   Documentation:
-    runs-on: 'ubuntu-latest'
-    needs: Build
     if: github.ref == 'refs/heads/master'
-    env:
-      DOC_GITHUB_TOKEN: '${{ secrets.DOC_TOKEN }}'
-    steps:
-      - uses: actions/checkout@v2
-      - run: curl https://opensource.byjg.com/add-doc.sh | bash /dev/stdin php anydataset
+    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,13 @@
 # AnyDataset
 
 [![Opensource ByJG](https://img.shields.io/badge/opensource-byjg-success.svg)](http://opensource.byjg.com)
-[![Build Status](https://github.com/byjg/anydataset/actions/workflows/phpunit.yml/badge.svg?branch=master)](https://github.com/byjg/anydataset/actions/workflows/phpunit.yml)
+[![Build Status](https://github.com/byjg/php-anydataset/actions/workflows/phpunit.yml/badge.svg?branch=master)](https://github.com/byjg/php-anydataset/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/)
+[![GitHub source](https://img.shields.io/badge/Github-source-informational?logo=github)](https://github.com/byjg/php-anydataset/)
 [![GitHub license](https://img.shields.io/github/license/byjg/anydataset.svg)](https://opensource.byjg.com/opensource/licensing.html)
-[![GitHub release](https://img.shields.io/github/release/byjg/anydataset.svg)](https://github.com/byjg/anydataset/releases/)
-[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/byjg/anydataset/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/byjg/anydataset/?branch=master)
-[![Code Coverage](https://scrutinizer-ci.com/g/byjg/anydataset/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/byjg/anydataset/?branch=master)
+[![GitHub release](https://img.shields.io/github/release/byjg/anydataset.svg)](https://github.com/byjg/php-anydataset/releases/)
+[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/byjg/php-anydataset/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/byjg/php-anydataset/?branch=master)
+[![Code Coverage](https://scrutinizer-ci.com/g/byjg/php-anydataset/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/byjg/php-anydataset/?branch=master)
 
 Anydataset Core Module. Anydataset is an agnostic data source abstraction layer in PHP.
 
@@ -21,18 +21,18 @@ Anydataset Core Module. Anydataset is an agnostic data source abstraction layer
 
 {:.table}
 
-| Object                 | Data Source           | Read | Write | Reference               |
-| ---------------------- | --------------------- |:----:|:-----:| ----------------------- |
-| DbDriverInterface      | Relational DB         | yes  | yes   | [Github](https://github.com/byjg/anydataset-db) |
-| AnyDataSet             | Anydataset            | yes  | yes   | [Github](https://github.com/byjg/anydataset) |
-| ArrayDataSet           | Array                 | yes  | no    | [Github](https://github.com/byjg/anydataset-array) |
-| TextFileDataSet        | Delimited Fields      | yes  | no    | [Github](https://github.com/byjg/anydataset-text) |
-| FixedTextFileDataSet   | Fixed Size fields     | yes  | no    | [Github](https://github.com/byjg/anydataset-text) |
-| XmlDataSet             | Xml                   | yes  | no    | [Github](https://github.com/byjg/anydataset-xml) |
-| JSONDataSet            | Json                  | yes  | no    | [Github](https://github.com/byjg/anydataset-json) |
-| SparQLDataSet          | SparQl Repositories   | yes  | no    | [Github](https://github.com/byjg/anydataset-sparql) |
-| NoSqlDocumentInterface | NoSql Document Based  | yes  | yes   | [Github](https://github.com/byjg/anydataset-nosql) |
-| KeyValueInterface      | NoSql Key/Value Based | yes  | yes   | [Github](https://github.com/byjg/anydataset-nosql) |
+| Object                 | Data Source           | Read | Write | Reference                                           |
+|------------------------|-----------------------|:----:|:-----:|-----------------------------------------------------|
+| DbDriverInterface      | Relational DB         | yes  |  yes  | [Github](https://github.com/byjg/anydataset-db)     |
+| AnyDataSet             | Anydataset            | yes  |  yes  | [Github](https://github.com/byjg/anydataset)        |
+| ArrayDataSet           | Array                 | yes  |  no   | [Github](https://github.com/byjg/anydataset-array)  |
+| TextFileDataSet        | Delimited Fields      | yes  |  no   | [Github](https://github.com/byjg/anydataset-text)   |
+| FixedTextFileDataSet   | Fixed Size fields     | yes  |  no   | [Github](https://github.com/byjg/anydataset-text)   |
+| XmlDataSet             | Xml                   | yes  |  no   | [Github](https://github.com/byjg/anydataset-xml)    |
+| JSONDataSet            | Json                  | yes  |  no   | [Github](https://github.com/byjg/anydataset-json)   |
+| SparQLDataSet          | SparQl Repositories   | yes  |  no   | [Github](https://github.com/byjg/anydataset-sparql) |
+| NoSqlDocumentInterface | NoSql Document Based  | yes  |  yes  | [Github](https://github.com/byjg/anydataset-nosql)  |
+| KeyValueInterface      | NoSql Key/Value Based | yes  |  yes  | [Github](https://github.com/byjg/anydataset-nosql)  |
 
 ## Examples
 
@@ -72,7 +72,7 @@ print_r($iterator->toArray());
 $iterator = $dataset->getIterator();
 while ($iterator->hasNext()) {
     $row = $iterator->moveNext();
-    
+
     print_r($row->get("field1"));
 }
 ```
@@ -97,7 +97,7 @@ $output = RowOutput::getInstance()
     ->addFormat("field1", "Test {field1}")
     ->addFormat("field2", "Showing {} and {field3}");
     ->addCustomFormat("field3", function ($row, $field, $value) {
-        // return the formatted output. 
+        // return the formatted output.
         // $row: The row object with all values
         // $field: The field has been processed
         // $value: The field value
@@ -126,10 +126,10 @@ $validator = RowValidator::getInstance()
     ->regexValidation("field4", '/\d{4}-\d{2}-\d{2}/')
     ->customValidation("field3", function($value) {
         // Return any string containing the error message if validation FAILS
-        // otherwise, just return null and the valition will pass. 
+        // otherwise, just return null and the valition will pass.
     });
 
-$validator->validate($row) // Will return an array with the error messages. Empty array if not errors. 
+$validator->validate($row) // Will return an array with the error messages. Empty array if not errors.
 ```
 
 ## Formatters
@@ -139,7 +139,7 @@ AnyDataset comes with an extensible set to format the AnyDataset. The interface
 ```php
 namespace ByJG\AnyDataset\Core\Formatter;
 
-interface FormatterInterface 
+interface FormatterInterface
 {
     /**
      * Return the object in your original format, normally as object
@@ -177,12 +177,14 @@ Example:
 $formatter = new XmlFormatter($anydataset->getIterator());
 $formatter->raw(); // Return a DOM object
 $formatter->toText(); // Return the XML as a text
-$formatter->saveToFile("/path/to/file.xml");  // Save the XML Text to a file. 
+$formatter->saveToFile("/path/to/file.xml");  // Save the XML Text to a file.
 ```
 
 ## Install
 
-Just type: `composer require "byjg/anydataset=4.1.*"`
+```bash
+composer require "byjg/anydataset"
+```
 
 ## Running Unit tests
 
diff --git a/composer.json b/composer.json
@@ -9,15 +9,15 @@
   "prefer-stable": true,
   "minimum-stability": "dev",
   "require": {
-    "php": ">=5.6.0",
+    "php": ">=7.4",
     "byjg/xmlutil": "4.9.*",
     "byjg/serializer": "4.9.*"
   },
   "suggest": {
     "ext-dom": "*"
   },
   "require-dev": {
-    "phpunit/phpunit": "5.7.*|7.4.*|^9.5",
+    "phpunit/phpunit": "^9.6",
     "vimeo/psalm": "^4.24"
   },
   "license": "MIT"
diff --git a/src/IteratorFilterFormatter.php b/src/IteratorFilterFormatter.php
@@ -28,7 +28,7 @@ abstract public function getRelation($name, $relation, $value, &$param);
     abstract public function format($filters, $tableName = null, &$params = [], $returnFields = "*");
 
     /**
-     * Get Filter 
+     * Get Filter
      *
      * @param array $filters
      * @param array $param

Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ abstract public function getRelation($name, $relation, $value, &$param);`
`28`	`28`	`abstract public function format($filters, $tableName = null, &$params = [], $returnFields = "*");`
`29`	`29`
`30`	`30`	`/**`
`31`		`- * Get Filter`
	`31`	`+ * Get Filter`
`32`	`32`	`*`
`33`	`33`	`* @param array $filters`
`34`	`34`	`* @param array $param`