Updates

Author: SoftCreatR

.github/workflows/Test.yml

@@ -35,7 +35,6 @@ jobs:
           php-version: ${{ matrix.php }}
           extensions: json
           coverage: pcov
-          #tools: cs2pr
         env:
           COMPOSER_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
@@ -46,7 +45,7 @@ jobs:
         run: composer install --prefer-dist --no-interaction --no-suggest
 
       - name: Run phpcs
-        run: composer cs-check #| cs2pr
+        run: composer cs-check -- -v
 
       - name: Setup PCOV
         if: matrix.php == '7.1'
@@ -55,7 +54,7 @@ jobs:
           vendor/bin/pcov clobber
 
       - name: Execute tests
-        run: ./vendor/bin/phpunit -v --configuration ./phpunit.xml.dist --coverage-clover=coverage.xml
+        run: composer test -- -v --coverage-clover=coverage.xml
 
       - name: Run codecov
         uses: codecov/codecov-action@v1

composer.json

@@ -49,7 +49,8 @@
   "minimum-stability": "stable",
   "scripts": {
     "cs-check": "phpcs",
-    "cs-fix": "phpcbf"
+    "cs-fix": "phpcbf",
+    "test": "phpunit"
   },
   "support": {
     "email": "[email protected]",

src/AccessHelper.php

@@ -61,15 +61,15 @@ public static function keyExists($collection, $key, bool $magicIsAllowed = false
         }
 
         if (is_int($key) && $key < 0) {
-            $key = abs((int)$key);
+            $key = abs($key);
         }
 
         if (is_array($collection) || $collection instanceof ArrayAccess) {
             return array_key_exists($key, $collection);
         }
 
         if (is_object($collection)) {
-            return property_exists($collection, (string)$key);
+            return property_exists($collection, $key);
         }
 
         return false;

src/JSONPathToken.php

@@ -26,10 +26,14 @@ class JSONPathToken
     public const T_SLICE = 'slice';
     public const T_INDEXES = 'indexes';
 
-    /** @var string */
+    /**
+     * @var string
+     */
     public $type;
 
-    /** @var mixed */
+    /**
+     * @var mixed
+     */
     public $value;
 
     /**

tests/QueryTest.php

@@ -10,8 +10,7 @@
 
 namespace Flow\JSONPath\Test;
 
-use Exception;
-use Flow\JSONPath\JSONPath;
+use Flow\JSONPath\{JSONPath, JSONPathException};
 use PHPUnit\Framework\{ExpectationFailedException, TestCase};
 
 use function fwrite;
@@ -33,44 +32,62 @@ class QueryTest extends TestCase
      * printed to the console (using STDERR), so we know, what's going on.
      *
      * @see https://cburgmer.github.io/json-path-comparison
-     *
-     * @small
      * @dataProvider queryDataProvider
-     *
      * @param string $query
      * @param string $selector
      * @param string $data
      * @param string $consensus
      * @param bool $allowFail
-     * @throws Exception
+     * @param bool $skip
+     * @throws JSONPathException
      */
     public function testQueries(
         string $query,
         string $selector,
         string $data,
         string $consensus,
-        bool $allowFail = false
+        bool $allowFail = false,
+        bool $skip = false
     ): void {
+        if ($skip) {
+            // Avoid "This test did not perform any assertions"
+            // but do not use markTestSkipped, to prevent unnecessary
+            // console outputs
+            self::assertTrue(true);
+
+            return;
+        }
+
+        $results = json_encode((new JSONPath(json_decode($data, true)))->find($selector));
+
         if ($allowFail) {
             try {
-                self::assertEquals(
-                    $consensus,
-                    json_encode((new JSONPath(json_decode($data, true)))->find($selector))
-                );
+                self::assertEquals($consensus, $results);
             } catch (ExpectationFailedException $e) {
                 $comparisonFailure = $e->getComparisonFailure();
 
                 fwrite(STDERR, "Query: {$query}\n{$comparisonFailure->toString()}");
             }
         } else {
-            self::assertEquals(
-                $consensus,
-                json_encode((new JSONPath(json_decode($data, true)))->find($selector))
-            );
+            self::assertEquals($consensus, $results);
         }
     }
 
     /**
+     * Returns a list of queries, test data and expected results.
+     *
+     * A hand full of queries may run forever, thus they should
+     * be skipped.
+     *
+     * Queries that are currently known as "problematic" are:
+     *
+     * - array_slice_with_negative_step_and_start_greater_than_end
+     * - array_slice_with_open_end_and_negative_step
+     * - array_slice_with_large_number_for_start
+     * - array_slice_with_large_number_for_end
+     * - array_slice_with_open_start_and_negative_step
+     * - array_slice_with_negative_step_only
+     *
      * @return string[]
      * @todo Finish this list
      */
@@ -113,13 +130,14 @@ public function queryDataProvider(): array
                 '["first", "second", "third", "forth", "fifth"]',
                 '[]', // Unknown consensus, might be ["third","second","first"]
             ],
-            //[
-            //    'Array slice with large number for start',
-            //    '$[-113667776004:2]',
-            //    '["first","second","third","forth","fifth"]',
-            //    '[]', // Unknown consensus, might be ["first","second"],
-            //    true
-            //]
+            [
+                'Array slice with large number for start',
+                '$[-113667776004:2]',
+                '["first","second","third","forth","fifth"]',
+                '[]', // Unknown consensus, might be ["first","second"],
+                true, // Allow fail
+                true // Skip
+            ]
         ];
     }
 }

tests/Traits/TestDataTrait.php

@@ -10,6 +10,7 @@
 
 namespace Flow\JSONPath\Test\Traits;
 
+use ArrayAccess;
 use RuntimeException;
 
 trait TestDataTrait
@@ -19,7 +20,7 @@ trait TestDataTrait
      *
      * @param string $type
      * @param bool|int $asArray
-     * @return mixed
+     * @return array|ArrayAccess|null
      */
     protected function getData(string $type, $asArray = true)
     {