Merge pull request #15 from faissaloux/tobeordered

`toBeOrdered()`

Author: faissaloux

README.md

@@ -5,7 +5,7 @@ This plugin checks what's inside the files.
 
 [![Tests](https://github.com/faissaloux/pest-plugin-inside/actions/workflows/tests.yml/badge.svg)](https://github.com/faissaloux/pest-plugin-inside/actions/workflows/tests.yml) ![Codecov](https://img.shields.io/codecov/c/github/faissaloux/pest-plugin-inside) ![Packagist Version](https://img.shields.io/packagist/v/faissaloux/pest-plugin-inside) ![Packagist License](https://img.shields.io/packagist/l/faissaloux/pest-plugin-inside)
 
-## Available Methods
+## Available Expectations
 ### toReturnLowercase
 Make sure a file or directory files returns an array with all lowercase values.
 ```php
@@ -24,6 +24,12 @@ Make sure a file or directory files returns an array with single words.
 expect('file.php')->toReturnSingleWords();
 ```
 
+### toBeOrdered
+Make sure a file or directory files returns an array with words that are ordered.
+```php
+expect('file.php')->toBeOrdered();
+```
+
 ----
 
 ### Success

src/Autoload.php

@@ -6,7 +6,7 @@
 use Pest\Expectation as PestExpectation;
 
 $expectations = get_class_methods(Expectation::class);
-$expectations = array_filter($expectations, fn ($function): bool => str_starts_with($function, 'toReturn'));
+$expectations = array_filter($expectations, fn ($function): bool => str_starts_with($function, 'toReturn') || str_starts_with($function, 'toBe'));
 
 foreach ($expectations as $expectation) {
     expect()->extend(

src/Expectation.php

@@ -34,4 +34,13 @@ public function toReturnSingleWords(int $depth = -1): void
             'Not single words detected'
         );
     }
+
+    public function toBeOrdered(int $depth = -1): void
+    {
+        $this->applyOnDirectory(
+            $depth,
+            fn (array $content): array => $this->dataNotOrderedIn($content),
+            'Your data is not ordered'
+        );
+    }
 }

src/Investigator.php

@@ -82,4 +82,44 @@ private function multipleWordsIn(array $array): array
 
         return $unwanted;
     }
+
+    /**
+     * @param  array<string|array<string>>  $array
+     * @return array<string>
+     */
+    private function dataNotOrderedIn(array $array): array
+    {
+        if (count($array) < 2) {
+            return [];
+        }
+
+        $unwanted = [];
+        $lastWord = $array[0];
+
+        foreach ($array as $key => $value) {
+            if ($key === 0) {
+                continue;
+            }
+
+            $currentWord = $value;
+            if (is_array($currentWord) && is_string($lastWord)) {
+                if ($lastWord > $key) {
+                    $unwanted[] = "$lastWord <=> $key";
+                }
+                $lastWord = $key;
+
+                array_push($unwanted, ...$this->dataNotOrderedIn($currentWord));
+
+                continue;
+            }
+
+            if (is_string($currentWord) && is_string($lastWord) && $lastWord > $currentWord) {
+                $unwanted[] = "$lastWord <=> $currentWord";
+            }
+
+            $lastWord = $currentWord;
+        }
+
+        return $unwanted;
+    }
 }

test.php

@@ -0,0 +1,34 @@
+<?php
+
+$array = [
+    '',
+    'f@issA!oux',
+    'pest',
+    'plugin',
+    'inside',
+    'lowercase',
+    'lower',
+    'case',
+];
+
+sort($array);
+
+// array(8) {
+//     [0]=>
+//     string(0) ""
+//     [1]=>
+//     string(4) "case"
+//     [2]=>
+//     string(10) "f@issA!oux"
+//     [3]=>
+//     string(6) "inside"
+//     [4]=>
+//     string(5) "lower"
+//     [5]=>
+//     string(9) "lowercase"
+//     [6]=>
+//     string(4) "pest"
+//     [7]=>
+//     string(6) "plugin"
+//   }
+var_dump($array);

tests/Fixtures/alphaOrder/arrayNotOrdered.php

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

tests/Fixtures/alphaOrder/arrayOrdered.php

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

tests/Fixtures/alphaOrder/nestedArrayNotOrdered.php

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

tests/Fixtures/alphaOrder/nestedArrayOrdered.php

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

tests/Unit/helpers/getFilesIn.php

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