Merge pull request #18 from faissaloux/support-text-files

Support text files

Author: faissaloux

README.md

@@ -13,6 +13,11 @@ This plugin checks what's inside the files.
 | ^3.0                | ^8.2    | ^1.2.0                 |
 | ^4.0                | ^8.3    | ^1.7.0                 |
 
+## Supported files
+- php
+- txt
+- stub
+
 ## Available Expectations
 ### toReturnLowercase
 Make sure a file or directory files returns an array with all lowercase values.

src/Content.php

@@ -0,0 +1,67 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Faissaloux\PestInside;
+
+use ArrayIterator;
+use Faissaloux\PestInside\Contracts\Content as ContentContract;
+use Traversable;
+
+final class Content implements ContentContract
+{
+    /**
+     * @var array<int|string, string|array<string, string>>
+     */
+    private array $content = [];
+
+    private string $extension;
+
+    public function __construct(private string $file)
+    {
+        $this->extension = pathinfo($this->file, PATHINFO_EXTENSION);
+
+        $this->content = $this->extension === 'php'
+            ? include $this->file
+            : explode("\n", file_get_contents($this->file) ?: '');
+    }
+
+    public function getExtension(): string
+    {
+        return $this->extension;
+    }
+
+    public function count(): int
+    {
+        return count($this->content);
+    }
+
+    public function getIterator(): Traversable
+    {
+        return new ArrayIterator($this->content);
+    }
+
+    public function offsetExists(mixed $offset): bool
+    {
+        return isset($this->content[$offset]);
+    }
+
+    public function offsetGet(mixed $offset): mixed
+    {
+        return $this->content[$offset];
+    }
+
+    public function offsetSet(mixed $offset, mixed $value): void
+    {
+        if (is_null($offset)) {
+            $this->content[] = $value;
+        } else {
+            $this->content[$offset] = $value;
+        }
+    }
+
+    public function offsetUnset(mixed $offset): void
+    {
+        unset($this->content[$offset]);
+    }
+}

src/Contracts/Content.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Faissaloux\PestInside\Contracts;
+
+use ArrayAccess;
+use Countable;
+use IteratorAggregate;
+
+/**
+ * @extends IteratorAggregate<int|string, string|array<string, string>>
+ * @extends ArrayAccess<int|string, string|array<string, string>>
+ */
+interface Content extends ArrayAccess, Countable, IteratorAggregate
+{
+    public function getExtension(): string;
+}

src/Exceptions/NotSupported.php

@@ -0,0 +1,9 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Faissaloux\PestInside;
+
+use Exception;
+
+class NotSupported extends Exception {}

src/Expectation.php

@@ -4,6 +4,8 @@
 
 namespace Faissaloux\PestInside;
 
+use Faissaloux\PestInside\Contracts\Content;
+
 final class Expectation extends Inside
 {
     use Investigator;
@@ -12,7 +14,7 @@ public function toReturnLowercase(int $depth = -1): void
     {
         $this->applyOnDirectory(
             $depth,
-            fn (array $content): array => $this->notLowercasesIn($content),
+            fn (Content $content): array => $this->notLowercasesIn($content),
             'Not lowercase detected'
         );
     }
@@ -21,7 +23,7 @@ public function toReturnUnique(int $depth = -1): void
     {
         $this->applyOnDirectory(
             $depth,
-            fn (array $content): array => $this->duplicatesIn($content),
+            fn (Content $content): array => $this->duplicatesIn($content),
             'Duplicates detected'
         );
     }
@@ -30,7 +32,7 @@ public function toReturnSingleWords(int $depth = -1): void
     {
         $this->applyOnDirectory(
             $depth,
-            fn (array $content): array => $this->multipleWordsIn($content),
+            fn (Content $content): array => $this->multipleWordsIn($content),
             'Not single words detected'
         );
     }
@@ -39,7 +41,7 @@ public function toBeOrdered(int $depth = -1): void
     {
         $this->applyOnDirectory(
             $depth,
-            fn (array $content): array => $this->dataNotOrderedIn($content),
+            fn (Content $content): array => $this->dataNotOrderedIn($content),
             'Your data is not ordered'
         );
     }
@@ -48,7 +50,7 @@ public function toReturnStrings(int $depth = -1): void
     {
         $this->applyOnDirectory(
             $depth,
-            fn (array $content): array => $this->notStringsIn($content),
+            fn (Content $content): array => $this->notStringsIn($content),
             'Not string detected'
         );
     }

src/Inside.php

@@ -32,18 +32,6 @@ protected function checkFileExistence(string $file): void
         }
     }
 
-    /**
-     * @return array<string>
-     */
-    protected function getContentFrom(string $file): array
-    {
-        $content = include $file;
-
-        expect($content)->toBeArray();
-
-        return $content;
-    }
-
     /**
      * @return PestExpectation<string>
      */
@@ -60,7 +48,7 @@ protected function applyOnDirectory(int $depth, callable $callback, string $mess
         foreach ($this->files as $file) {
             $this->checkFileExistence($file);
 
-            $content = $this->getContentFrom($file);
+            $content = new Content($file);
 
             $unwanted = $callback($content);
 

src/Investigator.php

@@ -4,20 +4,22 @@
 
 namespace Faissaloux\PestInside;
 
+use Faissaloux\PestInside\Contracts\Content;
+
 /**
  * @internal
  */
 trait Investigator
 {
     /**
-     * @param  array<string|array<string>>  $array
+     * @param  Content|array<int|string, string|array<string, string>>  $content
      * @return array<string>
      */
-    private function notLowercasesIn(array $array): array
+    private function notLowercasesIn(Content|array $content): array
     {
         $unwanted = [];
 
-        foreach ($array as $word) {
+        foreach ($content as $word) {
             if (is_array($word)) {
                 array_push($unwanted, ...$this->notLowercasesIn($word));
 
@@ -35,15 +37,15 @@ private function notLowercasesIn(array $array): array
     }
 
     /**
-     * @param  array<string|array<string>>  $array
+     * @param  Content|array<int|string, string|array<string, string>>  $content
      * @return array<string>
      */
-    private function duplicatesIn(array $array): array
+    private function duplicatesIn(Content|array $content): array
     {
         $unwanted = [];
         $unique = [];
 
-        foreach ($array as $word) {
+        foreach ($content as $word) {
             if (is_array($word)) {
                 array_push($unwanted, ...$this->duplicatesIn($word));
 
@@ -61,14 +63,14 @@ private function duplicatesIn(array $array): array
     }
 
     /**
-     * @param  array<string|array<string>>  $array
+     * @param  Content|array<int|string, string|array<string, string>>  $content
      * @return array<string>
      */
-    private function multipleWordsIn(array $array): array
+    private function multipleWordsIn(Content|array $content): array
     {
         $unwanted = [];
 
-        foreach ($array as $word) {
+        foreach ($content as $word) {
             if (is_array($word)) {
                 array_push($unwanted, ...$this->multipleWordsIn($word));
 
@@ -84,19 +86,19 @@ private function multipleWordsIn(array $array): array
     }
 
     /**
-     * @param  array<string|array<string>>  $array
+     * @param  Content|array<int|string, string|array<string, string>>  $content
      * @return array<string>
      */
-    private function dataNotOrderedIn(array $array): array
+    private function dataNotOrderedIn(Content|array $content): array
     {
-        if (count($array) < 2) {
+        if (count($content) < 2) {
             return [];
         }
 
         $unwanted = [];
-        $lastWord = $array[0];
+        $lastWord = $content[0];
 
-        foreach ($array as $key => $value) {
+        foreach ($content as $key => $value) {
             if ($key === 0) {
                 continue;
             }
@@ -124,14 +126,18 @@ private function dataNotOrderedIn(array $array): array
     }
 
     /**
-     * @param  array<string|array<string>>  $array
+     * @param  Content|array<int|string, string|array<string, string>>  $content
      * @return array<string>
      */
-    private function notStringsIn(array $array): array
+    private function notStringsIn(Content|array $content): array
     {
+        if ($content instanceof Content && ($extension = $content->getExtension()) !== 'php') {
+            throw new NotSupported("toReturnStrings is not supported on $extension files.");
+        }
+
         $unwanted = [];
 
-        foreach ($array as $word) {
+        foreach ($content as $word) {
             if (is_array($word)) {
                 array_push($unwanted, ...$this->notStringsIn($word));
 

src/helpers.php

@@ -1,8 +1,10 @@
 <?php
 
-function isDirOrPhp(string $maybeFile): bool
+function isDirOrSupportedFile(string $maybeFile): bool
 {
-    return isDir($maybeFile) || isPhp($maybeFile);
+    return isDir($maybeFile)
+        || isPhp($maybeFile)
+        || isText($maybeFile);
 }
 
 function isDir(string $maybeDir): bool
@@ -17,6 +19,13 @@ function isPhp(string $file): bool
     return end($exploded) === 'php';
 }
 
+function isText(string $file): bool
+{
+    $exploded = explode('.', $file);
+
+    return end($exploded) === 'txt' || end($exploded) === 'stub';
+}
+
 /**
  * @return array<string>
  */
@@ -26,7 +35,7 @@ function getFilesIn(string $directory, int $depth = -1): array
 
     if ($files = scandir($directory)) {
         $files = array_diff($files, ['.', '..']);
-        $files = array_filter($files, 'isDirOrPhp');
+        $files = array_filter($files, 'isDirOrSupportedFile');
 
         foreach ($files as $file) {
             if (isDir($file)) {

test.php

@@ -0,0 +1,8 @@
+
+f@issA!oux
+pest
+plugin
+inside
+lowercase
+lower
+case