Multiple dirs class set (#400)

* Allow ClassSet to use several root dirs

This way we can specify just the directories we want it to scan, as opposed to include all dirs in the root and then excluding all dirs we don't want in the set.

* Renaming getDirs() to getDirsDescription() because now it's getting multiple dirs, and it's still a string so it's not atomic anymore.

Author: hgraca

README.md

@@ -118,7 +118,7 @@ use Arkitect\Expression\ForClasses\ResideInOneOfTheseNamespaces;
 use Arkitect\Rules\Rule;
 
 return static function (Config $config): void {
-    $mvcClassSet = ClassSet::fromDir(__DIR__.'/mvc');
+    $mvcClassSet = ClassSet::fromDir(__DIR__.'/mvc', __DIR__.'/lib/my-lib/src');
 
     $rules = [];
 

src/CLI/Progress/DebugProgress.php

@@ -17,7 +17,7 @@ public function __construct(OutputInterface $output)
 
     public function startFileSetAnalysis(ClassSet $set): void
     {
-        $this->output->writeln("Start analyze dir {$set->getDir()}");
+        $this->output->writeln("Start analyze dirs {$set->getDirsDescription()}");
     }
 
     public function startParsingFile(string $file): void

src/CLI/Progress/ProgressBarProgress.php

@@ -33,7 +33,7 @@ public function __construct(OutputInterface $output)
 
     public function startFileSetAnalysis(ClassSet $set): void
     {
-        $this->output->writeln("analyze class set {$set->getDir()}");
+        $this->output->writeln("analyze class set {$set->getDirsDescription()}");
         $this->output->writeln('');
         $this->progress = new ProgressBar($this->output, iterator_count($set));
 

src/ClassSet.php

@@ -11,13 +11,14 @@
  */
 class ClassSet implements \IteratorAggregate
 {
-    private string $directory;
+    /** @var string[] */
+    private array $directoryList;
 
     private array $exclude;
 
-    private function __construct(string $directory)
+    private function __construct(string ...$directoryList)
     {
-        $this->directory = $directory;
+        $this->directoryList = $directoryList;
         $this->exclude = [];
     }
 
@@ -28,21 +29,21 @@ public function excludePath(string $pattern): self
         return $this;
     }
 
-    public static function fromDir(string $directory): self
+    public static function fromDir(string ...$directoryList): self
     {
-        return new self($directory);
+        return new self(...$directoryList);
     }
 
-    public function getDir(): string
+    public function getDirsDescription(): string
     {
-        return $this->directory;
+        return implode(', ', $this->directoryList);
     }
 
     public function getIterator(): \Traversable
     {
         $finder = (new Finder())
             ->files()
-            ->in($this->directory)
+            ->in($this->directoryList)
             ->name('*.php')
             ->sortByName()
             ->followLinks()

tests/Unit/CLI/Progress/DebugProgressTest.php

@@ -28,8 +28,8 @@ public function test_it_should_generate_text_on_start_file_set_analysis(): void
         $output = $this->prophesize(OutputInterface::class);
         $debugProgress = new DebugProgress($output->reveal());
 
-        $output->writeln('Start analyze dir directory')->shouldBeCalled();
-        $debugProgress->startFileSetAnalysis(ClassSet::fromDir('directory'));
+        $output->writeln('Start analyze dirs directory1, directory2')->shouldBeCalled();
+        $debugProgress->startFileSetAnalysis(ClassSet::fromDir('directory1', 'directory2'));
     }
 
     public function test_it_should_not_generate_text_on_end_parsing_file(): void

tests/Unit/ClassSetTest.php

@@ -10,6 +10,30 @@
 
 class ClassSetTest extends TestCase
 {
+    public function test_can_exclude_files_or_directories_from_multiple_dir_class_set(): void
+    {
+        $path = $this->createMvcProjectStructure();
+
+        $set = ClassSet::fromDir($path.'/Controller', $path.'/Model')
+            ->excludePath('Repository');
+
+        $expected = [
+            $path.'/Controller/CatalogController.php',
+            $path.'/Controller/Foo.php',
+            $path.'/Controller/ProductsController.php',
+            $path.'/Controller/UserController.php',
+            $path.'/Controller/YieldController.php',
+            $path.'/Model/Catalog.php',
+            $path.'/Model/Products.php',
+            $path.'/Model/User.php',
+        ];
+        $actual = array_values(array_map(function ($item) {
+            /** @var \SplFileInfo $item */
+            return $item->getPathname();
+        }, iterator_to_array($set)));
+        self::assertEquals($expected, $actual);
+    }
+
     public function test_can_exclude_files_or_directories(): void
     {
         $path = $this->createMvcProjectStructure();