[Directory] Create dir_scan() helper function (#5)

Co-authored-by: onairmarc <[email protected]>

.git-blame-ignore-revs

@@ -2,3 +2,4 @@ a709fafb67d0f1ee38b072390385ec486416aa3e
 6be6fc90b919882151178c22ce21c5d99f3ee383
 00a48bf6a894d24c9ed4c82bee6297ed24769e34
 c0c6bf6fb1c3ad80ff54b7420853ecc9096ee576
+d637c653da4a72e3b2b1132c1f0a4af3e0135387

.github/workflows/_pullRequest.yml

@@ -23,13 +23,13 @@ jobs:
             branch: ${{ github.head_ref }}
             path: 'src/'
     Test:
-        needs: StaticAnalysis
+        needs: Duster
         name: Test
         uses: EncoreDigitalGroup/.github/.github/workflows/pest.yml@v1
         with:
             phpVersion: '8.3'
             branch: ${{ github.head_ref }}
     AutoMerge:
-        needs: Test
+        needs: [ StaticAnalysis, Test ]
         name: AutoMerge
         uses: EncoreDigitalGroup/.github/.github/workflows/dependabotAutoMerge.yml@v1

src/ObjectHelpers/dir_helpers.php

@@ -16,3 +16,11 @@ function dir_hash(string $dir): string
         return Directory::hash($dir);
     }
 }
+
+if (!function_exists('dir_scan')) {
+    /** @experimental */
+    function dir_scan(string $dir): array
+    {
+        return Directory::scan($dir);
+    }
+}

src/ObjectHelpers/str_helpers.php

@@ -28,7 +28,7 @@ function str_concat(mixed ...$str): string
     /**@param array<string, string> ...$str */
     function str_concat_space(mixed ...$str): string
     {
-        return Str::concatSpace($str);
+        return Str::concatSpace($str); //@phpstan-ignore-line
     }
 }
 

src/Objects/Str.php

@@ -25,12 +25,18 @@ public static function concat(mixed ...$str): string
         return implode('', $str);
     }
 
-    /**@param array<string, string> ...$str */
+    /**
+     * @param  array<string, string>  ...$str
+     *
+     * @deprecated No replacement.
+     *
+     * @codeCoverageIgnore deprecated
+     */
     public static function concatSpace(mixed ...$str): string
     {
-        $str = array_merge(...$str);
+        $str = array_merge($str);
 
-        return implode(' ', $str);
+        return implode(' ', $str); //@phpstan-ignore-line
     }
 
     public static function guid(): string

tests/Unit/StringTest.php

@@ -10,14 +10,6 @@
     expect($result)->toEqual('HelloWorld');
 });
 
-test('concatSpace method concatenates strings with a space', function () {
-    $strings = ['Hello', 'World'];
-
-    $result = Str::concatSpace(...$strings);
-
-    expect($result)->toEqual('Hello World');
-});
-
 test('guid method returns a UUID', function () {
     $result = Str::guid();