Merge pull request #12 from faissaloux/support-nested-arrays

Support nested arrays

Author: faissaloux

README.md

@@ -37,6 +37,10 @@ return [
     'lower',
     'case',
     'lowercase',
+    'array' => [
+        'lower',
+        'case',
+    ],
 ];
 
 ```

src/Investigator.php

@@ -7,7 +7,7 @@
 trait Investigator
 {
     /**
-     * @param  array<string>  $array
+     * @param  array<string|array<string>>  $array
      * @return array<string>
      */
     private function lowercasesIn(array $array): array
@@ -19,6 +19,12 @@ private function lowercasesIn(array $array): array
                 continue;
             }
 
+            if (is_array($word)) {
+                array_push($unwanted, ...$this->lowercasesIn($word));
+
+                continue;
+            }
+
             if (! ctype_lower(preg_replace('/[^A-Za-z]/', '', $word))) {
                 $unwanted[] = $word;
             }
@@ -28,20 +34,51 @@ private function lowercasesIn(array $array): array
     }
 
     /**
-     * @param  array<string>  $array
+     * @param  array<string|array<string>>  $array
      * @return array<string>
      */
     private function duplicatesIn(array $array): array
     {
-        return array_diff_assoc($array, array_unique($array));
+        $unwanted = [];
+        $unique = [];
+
+        foreach ($array as $word) {
+            if (is_array($word)) {
+                array_push($unwanted, ...$this->duplicatesIn($word));
+
+                continue;
+            }
+
+            if (! in_array($word, $unique)) {
+                $unique[] = $word;
+            } else {
+                $unwanted[] = $word;
+            }
+        }
+
+        return $unwanted;
     }
 
     /**
-     * @param  array<string>  $array
+     * @param  array<string|array<string>>  $array
      * @return array<string>
      */
     private function singleWordsIn(array $array): array
     {
-        return array_filter($array, fn (string $word): bool => str_contains(trim($word), ' '));
+        $unwanted = [];
+
+        foreach ($array as $word) {
+            if (is_array($word)) {
+                array_push($unwanted, ...$this->singleWordsIn($word));
+
+                continue;
+            }
+
+            if (str_contains(trim((string) $word), ' ')) {
+                $unwanted[] = $word;
+            }
+        }
+
+        return $unwanted;
     }
 }

tests/Fixtures/returnsNestedLowercase.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+return [
+    '',
+    'f@issa!oux',
+    'pestphp',
+    'pest',
+    'plugin inside',
+    'plugin' => [
+        'pest',
+        'inside',
+    ],
+    'inside',
+    'lowercase',
+    'lower',
+    'case',
+];

tests/Fixtures/returnsNestedNotAllLowercase.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+return [
+    '',
+    'f@issa!oux',
+    'pestphp',
+    'pest',
+    'plugin inside',
+    'plugin' => [
+        'pest',
+        'inSide',
+    ],
+    'inside',
+    'lowercase',
+    'lower',
+    'case',
+];

tests/Fixtures/returnsNestedNotSingleWords.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+return [
+    '',
+    'f@issa!oux',
+    'pestphp',
+    'pest',
+    'plugin inside',
+    'plugin' => [
+        'pest',
+        'inside',
+        'not single word',
+    ],
+    'inside',
+    'lowercase',
+    'lower',
+    'case',
+];

tests/Fixtures/returnsNestedNotUnique.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+return [
+    '',
+    'f@issa!oux',
+    'pestphp',
+    'pest',
+    'plugin inside',
+    'plugin' => [
+        'pest',
+        'inSide',
+        'pest',
+    ],
+    'plugin',
+    'inside',
+    'unique',
+    'inside',
+    'word',
+];

tests/Fixtures/returnsNestedSingleWords.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+return [
+    '',
+    'f@issa!oux',
+    'pestphp',
+    'pest',
+    'plugin' => [
+        'pest',
+        'inside',
+    ],
+    'inside',
+    'lowercase',
+    'lower',
+    'case',
+];

tests/Fixtures/returnsNestedUnique.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+return [
+    '',
+    'f@issa!oux',
+    'pestphp',
+    'pest',
+    'plugin inside',
+    'plugin' => [
+        'pest',
+        'inSide',
+    ],
+    'plugin',
+    'inside',
+    'unique',
+    'word',
+];

tests/Unit/helpers/getFilesIn.php

@@ -5,23 +5,23 @@
 it('gets all php files in directory and subdirectories', function (): void {
     $files = getFilesIn('tests/Fixtures');
 
-    expect($files)->toBeArray()->toHaveCount(12);
+    expect($files)->toBeArray()->toHaveCount(18);
 });
 
 it('gets all direct php files in directory', function (): void {
     $files = getFilesIn('tests/Fixtures', depth: 0);
 
-    expect($files)->toBeArray()->toHaveCount(5);
+    expect($files)->toBeArray()->toHaveCount(11);
 });
 
 it('gets all php files in directory depth 1', function (): void {
     $files = getFilesIn('tests/Fixtures', depth: 1);
 
-    expect($files)->toBeArray()->toHaveCount(10);
+    expect($files)->toBeArray()->toHaveCount(16);
 });
 
 it('gets all php files in directory and subdirectories on negative depth', function (): void {
     $files = getFilesIn('tests/Fixtures', depth: -4);
 
-    expect($files)->toBeArray()->toHaveCount(12);
+    expect($files)->toBeArray()->toHaveCount(18);
 });

tests/toReturnLowercase.php

@@ -12,6 +12,11 @@
         ->not->toReturnLowercase();
 });
 
+it('passes when all nested arrays content is lowercase', function (): void {
+    expect('tests/Fixtures/returnsNestedLowercase.php')
+        ->toReturnLowercase();
+});
+
 it('passes when directory is empty', function (): void {
     expect('tests/Fixtures/empty')
         ->toReturnLowercase();
@@ -32,6 +37,11 @@
         ->not->toReturnLowercase();
 })->throws(ExpectationFailedException::class);
 
+it('fails when not all nested arrays content is lowercase', function (): void {
+    expect('tests/Fixtures/returnsNestedNotAllLowercase.php')
+        ->toReturnLowercase();
+})->throws(ExpectationFailedException::class, 'Not lowercase detected: inSide');
+
 it('fails when file does not exist', function (): void {
     expect('tests/Fixtures/notExist.php')
         ->toReturnLowercase();