refactor: aggregate array helper functions in their own file and namespace

Author: loilo

composer.json

@@ -38,6 +38,7 @@
             "src/utils/is-equal.php",
             "src/utils/traverse-descendant.php",
             "src/utils/helpers.php",
+            "src/utils/array.php",
             "src/utils/convert-i-regexp-to-php-regexp.php",
             "src/functions/function-types.php",
             "src/functions/search.php",

src/parsers/filter-selector.php

@@ -13,7 +13,7 @@ function apply_filter_selector($selector, $root_node, $json)
 		return [];
 	}
 
-	return array_filter_2(to_array($json), function ($item) use ($selector, $root_node) {
+	return Array\filter(to_array($json), function ($item) use ($selector, $root_node) {
 		return apply_filter_expression($selector->expr, $root_node, $item);
 	});
 }

src/parsers/root.php

@@ -20,7 +20,7 @@ function apply_segments(array $segments, $root_node, $node_list)
 	$result = array_reduce(
 		$segments,
 		function ($result_node_list, $current_segment) use ($root_node) {
-			return array_flat_map(
+			return Array\flat_map(
 				fn($node) => apply_segment($current_segment, $root_node, $node),
 				$result_node_list,
 			);
@@ -41,16 +41,16 @@ function apply_segment($segment, $root_node, $json)
 		$selector_results = array_map(function ($selector) use ($root_node, $json) {
 			return apply_selector($selector, $root_node, $json);
 		}, $segment);
-		$segment_result = array_flatten($selector_results);
+		$segment_result = Array\flatten($selector_results);
 
 		return $segment_result;
 	}
 
 	// DescendantSegment
 	$descendant_nodes = traverse_descendant($json);
 
-	return array_flat_map(
-		fn($node) => array_flat_map(
+	return Array\flat_map(
+		fn($node) => Array\flat_map(
 			fn($selector) => apply_selector($selector, $root_node, $node),
 			$segment->selectors,
 		),
@@ -117,7 +117,7 @@ function apply_index_selector($node, $json)
 		return [];
 	}
 
-	$index = normalize_index($node->index, sizeof($json));
+	$index = Array\normalize_index($node->index, sizeof($json));
 
 	return $index === null ? [] : [$json[$index]];
 }

src/utils.php

@@ -23,7 +23,7 @@ function json_get($value, $key)
  */
 function is_json_object($value): bool
 {
-	return (is_array($value) && !array_is_list_2($value)) || $value instanceof \stdClass;
+	return (is_array($value) && !Array\is_list($value)) || $value instanceof \stdClass;
 }
 
 /**
@@ -39,7 +39,7 @@ function is_json_primitive($value): bool
  */
 function is_json_array($value): bool
 {
-	return is_array($value) && array_is_list_2($value);
+	return is_array($value) && Array\is_list($value);
 }
 
 /**

src/utils/array.php

@@ -0,0 +1,95 @@
+<?php
+
+namespace Loilo\JsonPath\Array;
+
+/**
+ * Flatten a multi-dimensional array by a given number of levels
+ */
+function flatten(array $array, float $levels = 1): array
+{
+	if ($levels <= 0) {
+		return $array;
+	}
+
+	$result = [];
+	foreach ($array as $key => $value) {
+		if (is_array($value)) {
+			$result = array_merge($result, flatten($value, $levels - 1));
+		} else {
+			$result = array_merge($result, [$key => $value]);
+		}
+	}
+
+	return $result;
+}
+
+/**
+ * Map a callback over the elements of one or more arrays and flatten the result
+ */
+function flat_map(callable $callback, ...$arrays): array
+{
+	if (sizeof($arrays) === 0) {
+		return [];
+	}
+
+	$new_array = [];
+	$maxlength = max(array_map('sizeof', $arrays));
+	for ($i = 0; $i < $maxlength; $i++) {
+		$args =
+			sizeof($arrays) === 1
+				? [$arrays[0][$i]]
+				: array_map(fn($array) => $array[$i] ?? null, $arrays);
+		$result = call_user_func_array($callback, $args);
+
+		if (is_array($result)) {
+			if (empty($result)) {
+				continue;
+			}
+
+			$new_array = array_merge($new_array, $result);
+		} else {
+			$new_array[] = $result;
+		}
+	}
+
+	return $new_array;
+}
+
+/**
+ * Filter an array and re-index it
+ */
+function filter(array $array, ?callable $callback = null): array
+{
+	return array_values(array_filter($array, $callback));
+}
+
+/**
+ * Check if an array is a list
+ */
+function is_list(array $array): bool
+{
+	if (function_exists('array_is_list')) {
+		return \array_is_list($array);
+	}
+
+	return array_keys($array) === range(0, count($array) - 1);
+}
+
+/**
+ * Normalize an index for a given array length to be positive
+ * or null if it is out of bounds
+ * An index is out of bounds if it is less than the negative length
+ * or greater than or equal to the length
+ */
+function normalize_index($index, int $length): ?int
+{
+	if ($index < -$length || $index >= $length) {
+		return null;
+	}
+
+	if ($index < 0) {
+		$index += $length;
+	}
+
+	return $index;
+}

src/utils/helpers.php

@@ -2,102 +2,10 @@
 
 namespace Loilo\JsonPath;
 
-/**
- * Map a callback over the elements of one or more arrays and flatten the result
- */
-function array_flat_map(callable $callback, ...$arrays): array
-{
-	if (sizeof($arrays) === 0) {
-		return [];
-	}
-
-	$new_array = [];
-	$maxlength = max(array_map('sizeof', $arrays));
-	for ($i = 0; $i < $maxlength; $i++) {
-		$args =
-			sizeof($arrays) === 1
-				? [$arrays[0][$i]]
-				: array_map(fn($array) => $array[$i] ?? null, $arrays);
-		$result = call_user_func_array($callback, $args);
-
-		if (is_array($result)) {
-			if (empty($result)) {
-				continue;
-			}
-
-			$new_array = array_merge($new_array, $result);
-		} else {
-			$new_array[] = $result;
-		}
-	}
-
-	return $new_array;
-}
-
-/**
- * Flatten a multi-dimensional array by a given number of levels
- */
-function array_flatten(array $array, float $levels = 1): array
-{
-	if ($levels <= 0) {
-		return $array;
-	}
-
-	$result = [];
-	foreach ($array as $key => $value) {
-		if (is_array($value)) {
-			$result = array_merge($result, array_flatten($value, $levels - 1));
-		} else {
-			$result = array_merge($result, [$key => $value]);
-		}
-	}
-
-	return $result;
-}
-
-/**
- * Filter an array and re-indexes it
- */
-function array_filter_2(array $array, ?callable $callback = null): array
-{
-	return array_values(array_filter($array, $callback));
-}
-
-/**
- * Check if an array is a list
- */
-function array_is_list_2(array $array): bool
-{
-	if (function_exists('array_is_list')) {
-		return \array_is_list($array);
-	}
-
-	return array_keys($array) === range(0, count($array) - 1);
-}
-
 /**
  * Check if a value is a number
  */
 function is_number($value): bool
 {
 	return is_int($value) || is_float($value);
 }
-
-/**
- * Normalize an index for a given array length to be positive
- * or null if it is out of bounds
- * An index is out of bounds if it is less than the negative length
- * or greater than or equal to the length
- */
-function normalize_index($index, int $length): ?int
-{
-	if ($index < -$length || $index >= $length) {
-		return null;
-	}
-
-	if ($index < 0) {
-		$index += $length;
-	}
-
-	return $index;
-}