Add Arr::convertToShortSyntax() (#2)

Author: onairmarc

.gitignore

@@ -59,6 +59,8 @@ yarn-error.log
 /.phpunit.cache
 .phpunit.result.cache
 /--cache-directory/*
+tests/test_files/array_short_syntax_test/*
+tests/test_files/hash_test/*
 
 ##################################
 ########  Legacy Laravel  ########

.idea/inspectionProfiles/Project_Default.xml

@@ -34,6 +34,7 @@
             "EncoreDigitalGroup\\StdLib\\": "src/"
         },
         "files": [
+            "src/ObjectHelpers/arr_helpers.php",
             "src/ObjectHelpers/dir_helpers.php",
             "src/ObjectHelpers/file_helpers.php",
             "src/ObjectHelpers/num_helpers.php",

.idea/php.xml

@@ -6,11 +6,11 @@ parameters:
     paths:
         - src
     reportUnmatchedIgnoredErrors: false
-    checkMissingIterableValueType: false
-    checkGenericClassInNonGenericObjectType: false
     checkDynamicProperties: false
     checkTooWideReturnTypesInProtectedAndPublicMethods: false
     ignoreErrors:
+        - identifier: missingType.generics
+        - identifier: missingType.iterableValue
         - '#PHPDoc tag .+ #'
     unused_public:
         methods: true

.idea/stdlib.iml

@@ -0,0 +1,14 @@
+<?php
+
+use EncoreDigitalGroup\StdLib\Exceptions\ArgumentNullException;
+use EncoreDigitalGroup\StdLib\Objects\Arr;
+
+if (!function_exists('arr_to_short_syntax')) {
+    /**
+     * @throws ArgumentNullException
+     */
+    function arr_to_short_syntax(array|string $value): array|string
+    {
+        return Arr::convertToShortSyntax($value);
+    }
+}

composer.json

@@ -2,15 +2,112 @@
 
 namespace EncoreDigitalGroup\StdLib\Objects;
 
+use EncoreDigitalGroup\StdLib\Exceptions\ArgumentNullException;
 use Illuminate\Support\Arr as ArraySupport;
+use TypeError;
 
 /**
  * @api
  *
  * @internal
- *
- * @codeCoverageIgnore
  */
 class Arr extends ArraySupport
 {
+    public static function convertToShortSyntax(array|string $code): array|string
+    {
+        // Regular expression to match long array syntax
+        $pattern = '/array\s*\(([^()]*(?:(?R)[^()]*)*)\)/m';
+
+        // Callback function to replace long array syntax with short array syntax
+        $callback = function ($matches): string {
+            // Recursively convert nested arrays
+            $innerArray = $matches[1];
+            $convertedInnerArray = self::convertToShortSyntax($innerArray);
+
+            // Handle proper formatting of nested arrays
+            $convertedInnerArray = preg_replace('/\n\s*/', ' ', $convertedInnerArray);
+
+            if (!is_string($convertedInnerArray)) {
+                throw new TypeError(str_concat_space('Expected string, got ', get_type($convertedInnerArray)));
+            }
+
+            return "[\n    " . $convertedInnerArray . "\n]";
+        };
+
+        /**
+         * Replace all instances of long array syntax with short array syntax
+         */
+        $convertedCode = preg_replace_callback($pattern, $callback, $code);
+
+        /** Ensure array brackets are properly placed on the same line as the key. This regex searches for an
+         * opening square bracket '[' followed by one or more whitespace characters '\s+' and replaces it with
+         * the same opening bracket '[' followed by a new line '\n', ensuring the array's opening bracket appears
+         * on its own line.
+         */
+        $convertedCode = preg_replace('/\[\s+/', "[\n", $convertedCode ?? '');
+
+        /**
+         * Ensure array brackets are properly placed on the same line as the key (closing brackets). This regex searches
+         * for a closing square bracket ']' followed by one or more whitespace characters '\s+' and replaces it with just
+         * the closing bracket ']', ensuring that the array's closing bracket is placed correctly without extra whitespace.
+         */
+        $convertedCode = preg_replace('/\]\s+/', '] ', $convertedCode ?? '');
+
+        /**
+         * Ensure array brackets are properly placed on the same line as the key (opening brackets in nested arrays). This regex
+         * searches for a comma ',' followed by one or more whitespace characters '\s+' and an opening square bracket '[' and
+         * replaces it with just a comma ',' followed by a space and an opening bracket '[', ensuring proper spacing between the
+         * comma and the opening bracket in nested arrays.
+         */
+        $convertedCode = preg_replace('/,\s+\[/', ', [', $convertedCode ?? '');
+
+        /**
+         * Add new lines after commas that are outside of array values. This regex searches for a comma ',' followed by zero or
+         * more whitespace characters '\s*' and a closing square bracket ']' and replaces it with just a comma ',' followed by a
+         * new line '\n' and a closing bracket ']', ensuring that a new line is triggered before the closing bracket ']'.
+         */
+        $convertedCode = preg_replace('/,\s*\]/', ",\n]", $convertedCode ?? '');
+
+        /**
+         * Format array keys to ensure brackets are on the same line. This regex matches and captures an opening square bracket '\['
+         * followed by zero or more whitespace characters '\s*', then captures any characters that are not commas, closing or opening
+         * square brackets '([^,\]\[]+?)', and finally captures a closing square bracket '\]'. It replaces the matches with the captured
+         * groups, ensuring the brackets are not separated by whitespace.
+         */
+        $convertedCode = preg_replace('/(\[)\s*([^,\]\[]+?)\s*(\])/', '$1$2$3', $convertedCode ?? '');
+
+        /**
+         * Add new lines after closing brackets of arrays. This regex searches for a closing bracket ']' followed by zero or more whitespace
+         * characters '\s*' and a comma ',' and replaces it with just the closing bracket ']' followed by a new line '\n', ensuring each array
+         * element is on a new line.
+         */
+        $convertedCode = preg_replace('/\]\s*,/', "],\n", $convertedCode ?? '');
+
+        /**
+         * Replace every occurrence of a comma ',' in the $convertedCode string with a comma followed by a newline ",\n".
+         */
+        $convertedCode = preg_replace('/,/', ",\n", $convertedCode ?? '');
+
+        /**
+         * Add indentation for nested arrays. This regex searches for a comma ',' followed by zero or more whitespace characters '\s*', a new line
+         * '\n', zero or more whitespace characters '\s*', and an opening square bracket '[' and replaces it with a comma ',' followed by a new line
+         * '\n' and indentation '    ' equivalent to four spaces and an opening square bracket '['.
+         */
+        $convertedCode = preg_replace('/,\s*\n\s*\[/', ",\n    [", $convertedCode ?? '');
+
+        /**
+         * Add a new line after the closing bracket of the entire array declaration. This regex searches for a closing bracket ']' followed by zero or
+         * more whitespace characters '\s*' and a semicolon ';' and replaces it with just the closing bracket ']' followed by a semicolon ';' and a new
+         * line '\n'.
+         */
+        $convertedCode = preg_replace('/\]\s*;/', '];', $convertedCode ?? '');
+
+        $convertedCode = preg_replace("/(^[\r\n]*|[\r\n]+)[\s\t]*[\r\n]+/", "\n", $convertedCode ?? '');
+
+        if (is_null($convertedCode) || empty($convertedCode)) {
+            throw new ArgumentNullException('convertedCode');
+        }
+
+        return $convertedCode;
+    }
 }

phpstan.neon

@@ -0,0 +1,17 @@
+<?php
+
+test('Array converts to short syntax without error', function () {
+    $longSyntax = require 'tests/test_files/array_short_syntax_test/long_syntax.php';
+
+    $longSyntax = var_export($longSyntax, true);
+    $shortSyntax = arr_to_short_syntax($longSyntax);
+
+    $tmp = "<?php\n\nreturn " . $shortSyntax . ";\n";
+
+    file_put_contents('tests/test_files/array_short_syntax_test/tmp_short_syntax.php', $tmp);
+
+    $shortSyntaxFile = require 'tests/test_files/array_short_syntax_test/short_syntax.php';
+    $tmpSyntaxFile = require 'tests/test_files/array_short_syntax_test/tmp_short_syntax.php';
+
+    $this->assertEquals($shortSyntaxFile, $tmpSyntaxFile);
+});