Merge pull request #7 from faissaloux/toReturnUnique

faissaloux · web-flow · commit 8832be533d6f · 2024-10-14T23:32:22.000+01:00
`toReturnUnique()`
diff --git a/README.md b/README.md
@@ -5,6 +5,21 @@ 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
+### toReturnLowercase
+Make sure a file or directory files returns an array with all lowercase values.
+```php
+expect('file.php')->toReturnLowercase();
+```
+
+### toReturnUnique
+Make sure a file or directory files returns an array with unique values.
+```php
+expect('file.php')->toReturnUnique();
+```
+
+----
+
 ### Success
 
 ```php
diff --git a/src/Expectation.php b/src/Expectation.php
@@ -4,6 +4,39 @@
 
 use Pest\Expectation as PestExpectation;
 
+expect()->extend(
+    'toReturnUnique',
+    function (int $depth = -1): PestExpectation {
+        $files = [$this->value];
+
+        if (is_dir($files[0])) {
+            $files = getFilesIn($files[0], $depth);
+
+            if ($files === []) {
+                expect(true)->toBeTrue();
+
+                return $this;
+            }
+        }
+
+        foreach ((array) $files as $file) {
+            if (! file_exists($file)) {
+                expect(true)->toBeFalse("$file not found!");
+            }
+
+            $content = include $file;
+
+            expect($content)->toBeArray();
+
+            $duplicates = array_diff_assoc($content, array_unique($content));
+
+            expect($duplicates)->toBeEmpty('Duplicates found:'.implode(',', $duplicates)." in $file");
+        }
+
+        return $this;
+    }
+);
+
 expect()->extend(
     'toReturnLowercase',
     function (int $depth = -1): PestExpectation {
diff --git a/tests/Fixtures/directory/allLowerCase.php b/tests/Fixtures/directory/allLowerCase.php
diff --git a/tests/Fixtures/directory/allLowerCase1.php b/tests/Fixtures/directory/allLowerCase1.php
diff --git a/tests/Fixtures/directory/subdirectory/notAllLowerCase.php b/tests/Fixtures/directory/subdirectory/notAllLowerCase.php
diff --git a/tests/Fixtures/directory/subdirectory/notAllUnique.php b/tests/Fixtures/directory/subdirectory/notAllUnique.php
@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+return [
+    '',
+    'f@issa!oux',
+    'pest',
+    'plugin',
+    'inside',
+    'duplicate',
+    'word',
+    'duplicate',
+];
diff --git a/tests/Fixtures/directory1/allLowerCase.php b/tests/Fixtures/directory1/allLowerCase.php
diff --git a/tests/Fixtures/directory1/notAllLowerCase.php b/tests/Fixtures/directory1/notAllLowerCase.php
diff --git a/tests/Fixtures/directory1/notAllUnique.php b/tests/Fixtures/directory1/notAllUnique.php
@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+return [
+    '',
+    'f@issa!oux',
+    'pest',
+    'plugin',
+    'inside',
+    'duplicate',
+    'word',
+    'duplicate',
+];
diff --git a/tests/Fixtures/returnsArrayOnlyLowercase.php b/tests/Fixtures/returnsArrayOnlyLowercase.php
@@ -5,7 +5,9 @@
 return [
     '',
     'f@issa!oux',
+    'pestphp',
     'pest',
+    'plugin inside',
     'plugin',
     'inside',
     'lowercase',
diff --git a/tests/Fixtures/returnsDuplicates.php b/tests/Fixtures/returnsDuplicates.php
@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+return [
+    '',
+    'f@issa!oux',
+    'pest',
+    'plugin',
+    'inside',
+    'duplicate',
+    'word',
+    'duplicate',
+];
diff --git a/tests/Fixtures/returnsMultipleDuplicates.php b/tests/Fixtures/returnsMultipleDuplicates.php
@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+return [
+    '',
+    'f@issa!oux',
+    1,
+    'pest',
+    'plugin',
+    'inside',
+    'duplicate',
+    'word',
+    1,
+    'duplicate',
+];
diff --git a/tests/Fixtures/returnsUnique.php b/tests/Fixtures/returnsUnique.php
@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+return [
+    '',
+    'f@issa!oux',
+    'pestphp',
+    'pest',
+    'plugin inside',
+    'plugin',
+    'inside',
+    'unique',
+    'word',
+];
diff --git a/tests/Unit/helpers/getFilesIn.php b/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(7);
+    expect($files)->toBeArray()->toHaveCount(12);
 });
 
 it('gets all direct php files in directory', function (): void {
     $files = getFilesIn('tests/Fixtures', depth: 0);
 
-    expect($files)->toBeArray()->toHaveCount(2);
+    expect($files)->toBeArray()->toHaveCount(5);
 });
 
 it('gets all php files in directory depth 1', function (): void {
     $files = getFilesIn('tests/Fixtures', depth: 1);
 
-    expect($files)->toBeArray()->toHaveCount(6);
+    expect($files)->toBeArray()->toHaveCount(10);
 });
 
 it('gets all php files in directory and subdirectories on negative depth', function (): void {
     $files = getFilesIn('tests/Fixtures', depth: -4);
 
-    expect($files)->toBeArray()->toHaveCount(7);
+    expect($files)->toBeArray()->toHaveCount(12);
 });
diff --git a/tests/toReturnLowercase.php b/tests/toReturnLowercase.php
@@ -18,7 +18,7 @@
 });
 
 it('passes when all directory files content are lowercase', function (): void {
-    expect('tests/Fixtures/shouldAllBeLowercase')
+    expect('tests/Fixtures/directory')
         ->toReturnLowercase(depth: 0);
 });
 
@@ -43,19 +43,19 @@
 })->throws(ExpectationFailedException::class);
 
 it('fails when not all directory files content are lowercase', function (): void {
-    expect('tests/Fixtures/shouldAllBeLowercase1')
+    expect('tests/Fixtures/directory1')
         ->toReturnLowercase();
 })->throws(ExpectationFailedException::class);
 
 it('fails when not all subdirectories files content are lowercase', function (): void {
-    expect('tests/Fixtures/shouldAllBeLowercase')
+    expect('tests/Fixtures/directory')
         ->toReturnLowercase();
 })->throws(ExpectationFailedException::class);
 
 it('displays word detected', function (): void {
-    expect('tests/Fixtures/shouldAllBeLowercase')->toReturnLowercase();
+    expect('tests/Fixtures/directory')->toReturnLowercase();
 })->throws(ExpectationFailedException::class, 'Not lowercase word detected: loWer');
 
 it('displays file where error detected', function (): void {
-    expect('tests/Fixtures/shouldAllBeLowercase')->toReturnLowercase();
+    expect('tests/Fixtures/directory')->toReturnLowercase();
 })->throws(ExpectationFailedException::class, 'notAllLowerCase.php');
diff --git a/tests/toReturnUnique.php b/tests/toReturnUnique.php
@@ -0,0 +1,68 @@
+<?php
+
+use PHPUnit\Framework\ExpectationFailedException;
+
+it('passes', function (): void {
+    expect('tests/Fixtures/returnsUnique.php')
+        ->toReturnUnique();
+});
+
+it('passes with not', function (): void {
+    expect('tests/Fixtures/returnsDuplicates.php')
+        ->not->toReturnUnique();
+});
+
+it('passes when directory is empty', function (): void {
+    expect('tests/Fixtures/empty')
+        ->toReturnUnique();
+});
+
+it('passes when all directory files content are unique', function (): void {
+    expect('tests/Fixtures/directory')
+        ->toReturnUnique(depth: 0);
+});
+
+it('fails', function (): void {
+    expect('tests/Fixtures/returnsDuplicates.php')
+        ->toReturnUnique();
+})->throws(ExpectationFailedException::class);
+
+it('fails with not', function (): void {
+    expect('tests/Fixtures/returnsUnique.php')
+        ->not->toReturnUnique();
+})->throws(ExpectationFailedException::class);
+
+it('fails when file does not exist', function (): void {
+    expect('tests/Fixtures/notExist.php')
+        ->toReturnUnique();
+})->throws(ExpectationFailedException::class, 'tests/Fixtures/notExist.php not found');
+
+it('fails when directory does not exist', function (): void {
+    expect('tests/Fixtures/notExist')
+        ->toReturnUnique();
+})->throws(ExpectationFailedException::class);
+
+it('fails when not all directory files content are unique', function (): void {
+    expect('tests/Fixtures/directory1')
+        ->toReturnUnique();
+})->throws(ExpectationFailedException::class);
+
+it('fails when not all subdirectories files content are unique', function (): void {
+    expect('tests/Fixtures/directory')
+        ->toReturnUnique();
+})->throws(ExpectationFailedException::class);
+
+it('displays found duplicate', function (): void {
+    expect('tests/Fixtures/returnsDuplicates.php')
+        ->toReturnUnique();
+})->throws(ExpectationFailedException::class, 'duplicate');
+
+it('displays multiple found duplicates', function (): void {
+    expect('tests/Fixtures/returnsMultipleDuplicates.php')
+        ->toReturnUnique();
+})->throws(ExpectationFailedException::class, '1,duplicate');
+
+it('displays file where duplicate found', function (): void {
+    expect('tests/Fixtures/returnsDuplicates.php')
+        ->toReturnUnique();
+})->throws(ExpectationFailedException::class, 'returnsDuplicates.php');
