Applied small optimizations, and fixes

Signed-off-by: Sascha Greuel <[email protected]>

Author: SoftCreatR

CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+### 0.10.0
+- TBA
+
 ### 0.9.0
 🔻 Breaking changes ahead:
 

composer.json

@@ -2,7 +2,7 @@
   "name": "softcreatr/jsonpath",
   "description": "JSONPath implementation for parsing, searching and flattening arrays",
   "license": "MIT",
-  "version": "0.9.1",
+  "version": "0.10.0",
   "authors": [
     {
       "name": "Stephen Frank",

src/Filters/QueryMatchFilter.php

@@ -13,12 +13,19 @@
 use Flow\JSONPath\AccessHelper;
 use Flow\JSONPath\JSONPath;
 use Flow\JSONPath\JSONPathException;
+use JsonException;
 use RuntimeException;
 
+use const JSON_THROW_ON_ERROR;
+use const PREG_OFFSET_CAPTURE;
+use const PREG_UNMATCHED_AS_NULL;
+
 class QueryMatchFilter extends AbstractFilter
 {
     protected const MATCH_QUERY_NEGATION_WRAPPED = '^(?<negate>!)\((?<logicalexpr>.+)\)$';
+
     protected const MATCH_QUERY_NEGATION_UNWRAPPED = '^(?<negate>!)(?<logicalexpr>.+)$';
+
     protected const MATCH_QUERY_OPERATORS = '
       (@\.(?<key>[^\s<>!=]+)|@\[["\']?(?<keySquare>.*?)["\']?\]|(?<node>@)|(%group(?<group>\d+)%))
       (\s*(?<operator>==|=~|=|<>|!==|!=|>=|<=|>|<|in|!in|nin)\s*(?<comparisonValue>.+?(?=(&&|$|\|\||%))))?
@@ -56,7 +63,7 @@ public function filter($collection): array
                 //sanity check that our group is a group and not something within a string or regular expression
                 if (\preg_match('/' . static::MATCH_QUERY_OPERATORS . '/x', $test)) {
                     $filterGroups[$i] = $test;
-                    $filterExpression = \str_replace($matchesGroup[0], "%group$i%", $filterExpression);
+                    $filterExpression = \str_replace($matchesGroup[0], "%group{$i}%", $filterExpression);
                 }
             }
         }
@@ -71,16 +78,18 @@ public function filter($collection): array
         if (
             $match === false
             || !isset($matches[1][0])
-            || isset($matches['logicalandor'][array_key_last($matches['logicalandor'])])
+            || isset($matches['logicalandor'][\array_key_last($matches['logicalandor'])])
         ) {
             throw new RuntimeException('Malformed filter query');
         }
 
         $return = [];
+        $matchCount = \count($matches[0]);
 
-        for ($expressionPart = 0; $expressionPart < \count($matches[0]); $expressionPart++) {
+        for ($expressionPart = 0; $expressionPart < $matchCount; $expressionPart++) {
             $filteredCollection = $collection;
             $logicalJoin = $expressionPart > 0 ? $matches['logicalandor'][$expressionPart - 1] : null;
+
             if ($logicalJoin === '&&') {
                 //Restrict the nodes we need to look at to those already meeting criteria
                 $filteredCollection = $return;
@@ -92,6 +101,7 @@ public function filter($collection): array
                 $filter = '$[?(' . $filterGroups[$matches['group'][$expressionPart]] . ')]';
                 $resolve = (new JSONPath($filteredCollection))->find($filter)->getData();
                 $return = $resolve;
+
                 continue;
             }
 
@@ -102,12 +112,13 @@ public function filter($collection): array
             $comparisonValue = $matches['comparisonValue'][$expressionPart] ?? null;
 
             if (\is_string($comparisonValue)) {
-                $comparisonValue = \preg_replace('/^[\']/', '"', $comparisonValue);
-                $comparisonValue = \preg_replace('/[\']$/', '"', $comparisonValue);
+                $comparisonValue = \preg_replace('/^\'/', '"', $comparisonValue);
+                $comparisonValue = \preg_replace('/\'$/', '"', $comparisonValue);
+
                 try {
-                    $comparisonValue = \json_decode($comparisonValue, true, flags: JSON_THROW_ON_ERROR);
-                } catch (\JsonException $e) {
-                    //Leave $comparisonValue as raw (eg. regular express or non quote wrapped string)
+                    $comparisonValue = \json_decode($comparisonValue, true, 512, JSON_THROW_ON_ERROR);
+                } catch (JsonException) {
+                    //Leave $comparisonValue as raw (e.g. regular express or non quote wrapped string)
                 }
             }
 
@@ -116,14 +127,16 @@ public function filter($collection): array
                     //Short-circuit, node already exists in output due to previous test
                     continue;
                 }
-                $selectedNode = null;
 
+                $selectedNode = null;
                 $notNothing = AccessHelper::keyExists($node, $key, $this->magicIsAllowed);
+
                 if ($key) {
                     if ($notNothing) {
                         $selectedNode = AccessHelper::getValue($node, $key, $this->magicIsAllowed);
                     } elseif (\str_contains($key, '.')) {
                         $foundValue = (new JSONPath($node))->find($key)->getData();
+
                         if ($foundValue) {
                             $selectedNode = $foundValue[0];
                             $notNothing = true;
@@ -136,6 +149,7 @@ public function filter($collection): array
                 }
 
                 $comparisonResult = null;
+
                 if ($notNothing) {
                     $comparisonResult = match ($operator) {
                         null => AccessHelper::keyExists($node, $key, $this->magicIsAllowed) || (!$key),
@@ -165,6 +179,7 @@ public function filter($collection): array
 
         //Keep out returned nodes in the same order they were defined in the original collection
         \ksort($return);
+
         return $return;
     }
 
@@ -177,14 +192,17 @@ protected function compareEquals($a, $b): bool
     {
         $type_a = \gettype($a);
         $type_b = \gettype($b);
+
         if ($type_a === $type_b || ($this->isNumber($a) && $this->isNumber($b))) {
             //Primitives or Numbers
             if ($a === null || \is_scalar($a)) {
+                /** @noinspection TypeUnsafeComparisonInspection */
                 return $a == $b;
             }
             //Object/Array
             //@TODO array and object comparison
         }
+
         return false;
     }
 
@@ -194,6 +212,7 @@ protected function compareLessThan($a, $b): bool
             //numerical and string comparison supported only
             return $a < $b;
         }
+
         return false;
     }
 }

tests/QueryTest.php

@@ -75,12 +75,14 @@ public function testQueries(
             self::assertEquals($consensus, $results);
 
             if (\in_array($id, self::$baselineFailedQueries, true)) {
-                throw new \Exception("XFAIL test $id unexpectedly passed, update baselineFailedQueries.txt");
+                throw new ExpectationFailedException(
+                    "XFAIL test {$id} unexpectedly passed, update baselineFailedQueries.txt"
+                );
             }
         } catch (ExpectationFailedException $e) {
             try {
                 // In some cases, the consensus is just disordered, while
-                // the actual result is correct. Let's perform a canonicalized
+                // the actual result is correct. Let's perform a canonical
                 // assert in these cases. There might be still some false positives
                 // (e.g. multidimensional comparisons), but that's okay, I guess. Maybe,
                 // we can also find a way around that in the future.
@@ -100,7 +102,7 @@ public function testQueries(
                     );
                 }
             }
-        } catch (JSONPathException|RuntimeException $e) {
+        } catch (JSONPathException | RuntimeException $e) {
             if (!\in_array($id, self::$baselineFailedQueries, true)) {
                 throw new RuntimeException(
                     $e->getMessage() . "\nQuery: {$query}\n\nMore information: {$url}",
@@ -1559,55 +1561,55 @@ public static function queryDataProvider(): array
                 'rfc_semantics_of_null_object_value',
                 '$.a',
                 '{"a": null, "b": [null], "c": [{}], "null": 1}',
-                '[null]'
+                '[null]',
             ],
             [
                 'rfc_semantics_of_null_null_used_as_array',
                 '$.a[0]',
                 '{"a": null, "b": [null], "c": [{}], "null": 1}',
-                'XFAIL'
+                'XFAIL',
             ],
             [
                 'rfc_semantics_of_null_null_used_as_object',
                 '$.a.d',
                 '{"a": null, "b": [null], "c": [{}], "null": 1}',
-                'XFAIL'
+                'XFAIL',
             ],
             [
                 'rfc_semantics_of_null_array_value',
                 '$.b[0]',
                 '{"a": null, "b": [null], "c": [{}], "null": 1}',
-                '[null]'
+                '[null]',
             ],
             [
                 'rfc_semantics_of_null_array_value_2',
                 '$.b[*]',
                 '{"a": null, "b": [null], "c": [{}], "null": 1}',
-                '[null]'
+                '[null]',
             ],
             [
                 'rfc_semantics_of_null_existence',
                 '$.b[?@]',
                 '{"a": null, "b": [null], "c": [{}], "null": 1}',
-                '[null]'
+                '[null]',
             ],
             [
                 'rfc_semantics_of_null_comparison',
                 '$.b[?@==null]',
                 '{"a": null, "b": [null], "c": [{}], "null": 1}',
-                '[null]'
+                '[null]',
             ],
             [
                 'rfc_semantics_of_null_comparison_with_missing_value',
                 '$.c[[email protected]==null]',
                 '{"a": null, "b": [null], "c": [{}], "null": 1}',
-                'XFAIL'
+                'XFAIL',
             ],
             [
                 'rfc_semantics_of_null_null_string',
                 '$.null',
                 '{"a": null, "b": [null], "c": [{}], "null": 1}',
-                '[1]'
+                '[1]',
             ],
         ];
     }

tests/Traits/TestDataTrait.php

@@ -11,15 +11,14 @@
 use JsonException;
 use RuntimeException;
 
-use const JSON_ERROR_NONE;
 use const JSON_THROW_ON_ERROR;
 
 trait TestDataTrait
 {
     /**
      * Returns decoded JSON from a given file either as array or object.
      *
-     * @throws JsonException
+     * @throws RuntimeException
      */
     protected function getData(string $type, bool|int $asArray = true): mixed
     {