Merge pull request #210 from CircleCode

allow ThatIs filter to take multivalued options (BC BREAK)

Author: sebastianfeldmann

src/Hook/Condition/FileStaged/ThatIs.php

@@ -43,16 +43,16 @@ class ThatIs implements Condition, Constrained
     /**
      * Directory path to check e.g. 'src/' or 'path/To/Custom/Directory/'
      *
-     * @var string
+     * @var string[]
      */
-    private string $directory;
+    private array $directories;
 
     /**
      * File type to check e.g. 'php' or 'html'
      *
-     * @var string
+     * @var string[]
      */
-    private string $suffix;
+    private array $suffixes;
 
     /**
      * OfType constructor
@@ -61,8 +61,8 @@ class ThatIs implements Condition, Constrained
      */
     public function __construct(array $options)
     {
-        $this->directory = $options['inDirectory'] ?? '';
-        $this->suffix    = $options['ofType'] ?? '';
+        $this->directories = (array)($options['inDirectory'] ?? []);
+        $this->suffixes    = (array)($options['ofType'] ?? []);
     }
 
     /**
@@ -98,10 +98,17 @@ public function isTrue(IO $io, Repository $repository): bool
      */
     private function filterFilesByDirectory(array $files): array
     {
-        if (empty($this->directory)) {
+        if (empty($this->directories)) {
             return $files;
         }
-        return array_filter($files, fn($file) => strpos($file, $this->directory) !== false);
+        return array_filter($files, function ($file) {
+            foreach ($this->directories as $directory) {
+                if (str_starts_with($file, $directory)) {
+                    return true;
+                }
+            }
+            return false;
+        });
     }
 
     /**
@@ -112,9 +119,13 @@ private function filterFilesByDirectory(array $files): array
      */
     private function filterFilesByType(array $files): array
     {
-        if (empty($this->suffix)) {
+        if (empty($this->suffixes)) {
             return $files;
         }
-        return array_filter($files, fn($file) => strtolower(pathinfo($file, PATHINFO_EXTENSION)) === $this->suffix);
+        return array_filter($files, fn($file) => in_array(
+            strtolower(pathinfo($file, PATHINFO_EXTENSION)),
+            $this->suffixes,
+            true
+        ));
     }
 }

tests/unit/Hook/Condition/FileStaged/ThatIsTest.php

@@ -43,6 +43,34 @@ public function testStagedTrueType(): void
         $this->assertTrue($thatIs->isTrue($io, $repo));
     }
 
+    /**
+     * Tests ThatIs::isTrue
+     */
+    public function testStagedTrueMultipleType(): void
+    {
+        $io    = $this->createIOMock();
+        $repo  = $this->createRepositoryMock();
+        $index = $this->createGitIndexOperator(['foo.php', 'bar.php']);
+        $repo->expects($this->once())->method('getIndexOperator')->willReturn($index);
+
+        $thatIs = new ThatIs(['ofType' => ['php', 'js']]);
+        $this->assertTrue($thatIs->isTrue($io, $repo));
+    }
+
+    /**
+     * Tests ThatIs::isTrue
+     */
+    public function testStagedFalseMultipleType(): void
+    {
+        $io    = $this->createIOMock();
+        $repo  = $this->createRepositoryMock();
+        $index = $this->createGitIndexOperator(['foo.php', 'bar.php']);
+        $repo->expects($this->once())->method('getIndexOperator')->willReturn($index);
+
+        $thatIs = new ThatIs(['ofType' => ['ts', 'js']]);
+        $this->assertFalse($thatIs->isTrue($io, $repo));
+    }
+
     /**
      * Tests ThatIs::isTrue
      */
@@ -57,6 +85,48 @@ public function testStagedTrueDirectory(): void
         $this->assertTrue($thatIs->isTrue($io, $repo));
     }
 
+    /**
+     * Tests ThatIs::isTrue
+     */
+    public function testStagedFalsePartialDirectory(): void
+    {
+        $io    = $this->createIOMock();
+        $repo  = $this->createRepositoryMock();
+        $index = $this->createGitIndexOperator(['foo/foo.php', 'foo/bar/bar.js', 'fiz/baz.txt']);
+        $repo->expects($this->once())->method('getIndexOperator')->willReturn($index);
+
+        $thatIs = new ThatIs(['inDirectory' => 'bar/']);
+        $this->assertFalse($thatIs->isTrue($io, $repo));
+    }
+
+    /**
+     * Tests ThatIs::isTrue
+     */
+    public function testStagedTrueMultipleDirectory(): void
+    {
+        $io = $this->createIOMock();
+        $repo = $this->createRepositoryMock();
+        $index = $this->createGitIndexOperator(['foo/foo.php', 'bar/bar.js', 'fiz/baz.txt']);
+        $repo->expects($this->once())->method('getIndexOperator')->willReturn($index);
+
+        $thatIs = new ThatIs(['inDirectory' => ['bar/', 'baz/']]);
+        $this->assertTrue($thatIs->isTrue($io, $repo));
+    }
+
+    /**
+     * Tests ThatIs::isTrue
+     */
+    public function testStagedFalseMultipleDirectory(): void
+    {
+        $io = $this->createIOMock();
+        $repo = $this->createRepositoryMock();
+        $index = $this->createGitIndexOperator(['foo/foo.php', 'bar/bar.js', 'fiz/baz.txt']);
+        $repo->expects($this->once())->method('getIndexOperator')->willReturn($index);
+
+        $thatIs = new ThatIs(['inDirectory' => ['foobar/', 'baz/']]);
+        $this->assertFalse($thatIs->isTrue($io, $repo));
+    }
+
     /**
      * Tests ThatIs::isTrue
      */