FileSystem events and console logger improvements.

packages/documentator/src/Processor/Contracts/Dependency.php

@@ -11,7 +11,7 @@
 use Traversable;
 
 /**
- * Task dependency (= another file).
+ * Task dependency (= another file or directory).
  *
  * @template TValue of Traversable<mixed, Directory|File>|Directory|File|null
  */
@@ -23,5 +23,8 @@ interface Dependency {
      */
     public function __invoke(FileSystem $fs): mixed;
 
-    public function getPath(): DirectoryPath|FilePath;
+    /**
+     * Used only for events. Relative path will be resolved based on {@see FileSystem::$input}.
+     */
+    public function getPath(FileSystem $fs): Directory|DirectoryPath|File|FilePath;
 }

packages/documentator/src/Processor/Dependencies/DirectoryIterator.php

@@ -47,11 +47,9 @@ public function __invoke(FileSystem $fs): mixed {
     }
 
     #[Override]
-    public function getPath(): DirectoryPath {
-        return match (true) {
-            $this->directory instanceof Directory => $this->directory->getPath(),
-            is_string($this->directory)           => new DirectoryPath($this->directory),
-            default                               => $this->directory,
-        };
+    public function getPath(FileSystem $fs): Directory|DirectoryPath {
+        return is_string($this->directory)
+            ? new DirectoryPath($this->directory)
+            : $this->directory;
     }
 }

packages/documentator/src/Processor/Dependencies/DirectoryIteratorTest.php

@@ -12,7 +12,6 @@
 use function array_map;
 use function basename;
 use function iterator_to_array;
-use function sprintf;
 
 /**
  * @internal
@@ -26,9 +25,12 @@ public function testGetPath(): void {
         $directory  = $filesystem->getDirectory(__DIR__);
         $path       = $directory->getPath();
 
-        self::assertEquals('path/to/directory', (string) (new DirectoryIterator('path/to/directory'))->getPath());
-        self::assertEquals((string) $directory, (string) (new DirectoryIterator($directory))->getPath());
-        self::assertEquals((string) $path, (string) (new DirectoryIterator($path))->getPath());
+        self::assertEquals(
+            'path/to/directory',
+            (string) (new DirectoryIterator('path/to/directory'))->getPath($filesystem),
+        );
+        self::assertEquals((string) $directory, (string) (new DirectoryIterator($directory))->getPath($filesystem));
+        self::assertEquals((string) $path, (string) (new DirectoryIterator($path))->getPath($filesystem));
     }
 
     public function testInvoke(): void {
@@ -59,12 +61,7 @@ public function testInvokeNotFound(): void {
         $path = 'path/to/directory';
 
         self::expectException(DependencyUnresolvable::class);
-        self::expectExceptionMessage(
-            sprintf(
-                'Dependency `%s` not found.',
-                $path,
-            ),
-        );
+        self::expectExceptionMessage('Dependency not found.');
 
         iterator_to_array(
             (new DirectoryIterator($path))($fs),

packages/documentator/src/Processor/Dependencies/DirectoryReference.php

@@ -32,10 +32,9 @@ public function __invoke(FileSystem $fs): mixed {
     }
 
     #[Override]
-    public function getPath(): DirectoryPath {
-        return match (true) {
-            is_string($this->reference) => new DirectoryPath($this->reference),
-            default                     => $this->reference,
-        };
+    public function getPath(FileSystem $fs): DirectoryPath {
+        return is_string($this->reference)
+            ? new DirectoryPath($this->reference)
+            : $this->reference;
     }
 }

packages/documentator/src/Processor/Dependencies/DirectoryReferenceTest.php

@@ -8,8 +8,6 @@
 use LastDragon_ru\LaraASP\Documentator\Testing\Package\WithProcessor;
 use PHPUnit\Framework\Attributes\CoversClass;
 
-use function sprintf;
-
 /**
  * @internal
  */
@@ -18,10 +16,14 @@ final class DirectoryReferenceTest extends TestCase {
     use WithProcessor;
 
     public function testGetPath(): void {
-        $path = (new DirectoryPath(__DIR__))->getNormalizedPath();
+        $filesystem = $this->getFileSystem(__DIR__);
+        $path       = (new DirectoryPath(__DIR__))->getNormalizedPath();
 
-        self::assertEquals('path/to/directory', (string) (new DirectoryReference('path/to/directory'))->getPath());
-        self::assertEquals((string) $path, (string) (new DirectoryReference($path))->getPath());
+        self::assertEquals(
+            'path/to/directory',
+            (string) (new DirectoryReference('path/to/directory'))->getPath($filesystem),
+        );
+        self::assertEquals((string) $path, (string) (new DirectoryReference($path))->getPath($filesystem));
     }
 
     public function testInvoke(): void {
@@ -41,12 +43,7 @@ public function testInvokeNotFound(): void {
         $path = 'path/to/directory';
 
         self::expectException(DependencyUnresolvable::class);
-        self::expectExceptionMessage(
-            sprintf(
-                'Dependency `%s` not found.',
-                $path,
-            ),
-        );
+        self::expectExceptionMessage('Dependency not found.');
 
         (new DirectoryReference($path))($fs);
     }

packages/documentator/src/Processor/Dependencies/FileCreate.php

@@ -9,6 +9,8 @@
 use Override;
 use Stringable;
 
+use function is_string;
+
 /**
  * @implements Dependency<File>
  */
@@ -26,10 +28,9 @@ public function __invoke(FileSystem $fs): mixed {
     }
 
     #[Override]
-    public function getPath(): FilePath {
-        return match (true) {
-            $this->file instanceof FilePath => $this->file,
-            default                         => new FilePath($this->file),
-        };
+    public function getPath(FileSystem $fs): FilePath {
+        return $fs->output->getPath(
+            is_string($this->file) ? new FilePath($this->file) : $this->file,
+        );
     }
 }

packages/documentator/src/Processor/Dependencies/FileCreateTest.php

@@ -10,6 +10,8 @@
 use Mockery;
 use PHPUnit\Framework\Attributes\CoversClass;
 
+use function dirname;
+
 /**
  * @internal
  */
@@ -18,10 +20,14 @@ final class FileCreateTest extends TestCase {
     use WithProcessor;
 
     public function testGetPath(): void {
-        $path = (new FilePath(__FILE__))->getNormalizedPath();
+        $filesystem = $this->getFileSystem(dirname(__DIR__), __DIR__);
+        $path       = (new FilePath(__FILE__))->getNormalizedPath();
 
-        self::assertEquals('path/to/file', (string) (new FileCreate('path/to/file', ''))->getPath());
-        self::assertEquals((string) $path, (string) (new FileCreate($path, ''))->getPath());
+        self::assertEquals(
+            (string) $filesystem->output->getFilePath('path/to/file'),
+            (string) (new FileCreate('path/to/file', ''))->getPath($filesystem),
+        );
+        self::assertEquals((string) $path, (string) (new FileCreate($path, ''))->getPath($filesystem));
     }
 
     public function testInvoke(): void {

packages/documentator/src/Processor/Dependencies/FileIterator.php

@@ -48,11 +48,9 @@ public function __invoke(FileSystem $fs): mixed {
     }
 
     #[Override]
-    public function getPath(): DirectoryPath {
-        return match (true) {
-            $this->directory instanceof Directory => $this->directory->getPath(),
-            is_string($this->directory)           => new DirectoryPath($this->directory),
-            default                               => $this->directory,
-        };
+    public function getPath(FileSystem $fs): Directory|DirectoryPath {
+        return is_string($this->directory)
+            ? new DirectoryPath($this->directory)
+            : $this->directory;
     }
 }

packages/documentator/src/Processor/Dependencies/FileIteratorTest.php

@@ -13,7 +13,6 @@
 use function array_map;
 use function basename;
 use function iterator_to_array;
-use function sprintf;
 
 /**
  * @internal
@@ -27,9 +26,9 @@ public function testGetPath(): void {
         $directory  = $filesystem->getDirectory(__DIR__);
         $path       = $directory->getPath();
 
-        self::assertEquals('path/to/directory', (string) (new FileIterator('path/to/directory'))->getPath());
-        self::assertEquals((string) $directory, (string) (new FileIterator($directory))->getPath());
-        self::assertEquals((string) $path, (string) (new FileIterator($path))->getPath());
+        self::assertEquals('path/to/directory', (string) (new FileIterator('path/to/directory'))->getPath($filesystem));
+        self::assertEquals((string) $directory, (string) (new FileIterator($directory))->getPath($filesystem));
+        self::assertEquals((string) $path, (string) (new FileIterator($path))->getPath($filesystem));
     }
 
     public function testInvoke(): void {
@@ -62,12 +61,7 @@ public function testInvokeNotFound(): void {
         $path = 'path/to/directory';
 
         self::expectException(DependencyUnresolvable::class);
-        self::expectExceptionMessage(
-            sprintf(
-                'Dependency `%s` not found.',
-                $path,
-            ),
-        );
+        self::expectExceptionMessage('Dependency not found.');
 
         iterator_to_array(
             (new FileIterator($path))($fs),

packages/documentator/src/Processor/Dependencies/FileReference.php

@@ -32,10 +32,9 @@ public function __invoke(FileSystem $fs): mixed {
     }
 
     #[Override]
-    public function getPath(): FilePath {
-        return match (true) {
-            is_string($this->reference) => new FilePath($this->reference),
-            default                     => $this->reference,
-        };
+    public function getPath(FileSystem $fs): FilePath {
+        return is_string($this->reference)
+            ? new FilePath($this->reference)
+            : $this->reference;
     }
 }

packages/documentator/src/Processor/Dependencies/FileReferenceTest.php

@@ -9,7 +9,6 @@
 use PHPUnit\Framework\Attributes\CoversClass;
 
 use function basename;
-use function sprintf;
 
 /**
  * @internal
@@ -19,10 +18,11 @@ final class FileReferenceTest extends TestCase {
     use WithProcessor;
 
     public function testGetPath(): void {
-        $path = (new FilePath(__FILE__))->getNormalizedPath();
+        $filesystem = $this->getFileSystem(__DIR__);
+        $path       = (new FilePath(__FILE__))->getNormalizedPath();
 
-        self::assertEquals('path/to/file', (string) (new FileReference('path/to/file'))->getPath());
-        self::assertEquals((string) $path, (string) (new FileReference($path))->getPath());
+        self::assertEquals('path/to/file', (string) (new FileReference('path/to/file'))->getPath($filesystem));
+        self::assertEquals((string) $path, (string) (new FileReference($path))->getPath($filesystem));
     }
 
     public function testInvoke(): void {
@@ -43,12 +43,7 @@ public function testInvokeNotFound(): void {
         $path = 'path/to/file';
 
         self::expectException(DependencyUnresolvable::class);
-        self::expectExceptionMessage(
-            sprintf(
-                'Dependency `%s` not found.',
-                $path,
-            ),
-        );
+        self::expectExceptionMessage('Dependency not found.');
 
         (new FileReference($path))($fs);
     }

packages/documentator/src/Processor/Dependencies/FileSave.php

@@ -2,7 +2,6 @@
 
 namespace LastDragon_ru\LaraASP\Documentator\Processor\Dependencies;
 
-use LastDragon_ru\LaraASP\Core\Path\FilePath;
 use LastDragon_ru\LaraASP\Documentator\Processor\Contracts\Dependency;
 use LastDragon_ru\LaraASP\Documentator\Processor\FileSystem\File;
 use LastDragon_ru\LaraASP\Documentator\Processor\FileSystem\FileSystem;
@@ -28,7 +27,7 @@ public function __invoke(FileSystem $fs): mixed {
     }
 
     #[Override]
-    public function getPath(): FilePath {
-        return $this->file->getPath();
+    public function getPath(FileSystem $fs): File {
+        return $this->file;
     }
 }

packages/documentator/src/Processor/Dependencies/FileSaveTest.php

@@ -20,7 +20,7 @@ public function testGetPath(): void {
         $fs   = $this->getFileSystem(__DIR__);
         $file = $fs->getFile(__FILE__);
 
-        self::assertEquals((string) $file, (string) (new FileSave($file, ''))->getPath());
+        self::assertEquals((string) $file, (string) (new FileSave($file, ''))->getPath($fs));
     }
 
     public function testInvoke(): void {

packages/documentator/src/Processor/Dependencies/Optional.php

@@ -41,7 +41,7 @@ public function __invoke(FileSystem $fs): mixed {
     }
 
     #[Override]
-    public function getPath(): DirectoryPath|FilePath {
-        return $this->dependency->getPath();
+    public function getPath(FileSystem $fs): Directory|DirectoryPath|File|FilePath {
+        return $this->dependency->getPath($fs);
     }
 }

packages/documentator/src/Processor/Dependencies/OptionalTest.php

@@ -14,10 +14,11 @@ final class OptionalTest extends TestCase {
     use WithProcessor;
 
     public function testGetPath(): void {
+        $filesystem = $this->getFileSystem(__DIR__);
         $dependency = new FileReference('path/to/file');
         $optional   = new Optional($dependency);
 
-        self::assertEquals($dependency->getPath(), $optional->getPath());
+        self::assertEquals($dependency->getPath($filesystem), $optional->getPath($filesystem));
     }
 
     public function testInvoke(): void {

packages/documentator/src/Processor/Dispatcher.php

@@ -0,0 +1,13 @@
+<?php declare(strict_types = 1);
+
+namespace LastDragon_ru\LaraASP\Documentator\Processor;
+
+use LastDragon_ru\LaraASP\Core\Observer\Dispatcher as CoreDispatcher;
+use LastDragon_ru\LaraASP\Documentator\Processor\Events\Event;
+
+/**
+ * @extends CoreDispatcher<Event>
+ */
+class Dispatcher extends CoreDispatcher {
+    // empty
+}

packages/documentator/src/Processor/Events/DependencyResolved.php

@@ -2,14 +2,8 @@
 
 namespace LastDragon_ru\LaraASP\Documentator\Processor\Events;
 
-use LastDragon_ru\LaraASP\Documentator\Processor\Contracts\Dependency;
-
 readonly class DependencyResolved implements Event {
     public function __construct(
-        /**
-         * @var class-string<Dependency<*>>
-         */
-        public string $dependency,
         /**
          * @var non-empty-string
          */

packages/documentator/src/Processor/Events/FileSystemModified.php

@@ -0,0 +1,15 @@
+<?php declare(strict_types = 1);
+
+namespace LastDragon_ru\LaraASP\Documentator\Processor\Events;
+
+readonly class FileSystemModified implements Event {
+    public function __construct(
+        /**
+         * @var non-empty-string
+         */
+        public string $path,
+        public FileSystemModifiedType $type,
+    ) {
+        // empty
+    }
+}

packages/documentator/src/Processor/Events/FileSystemModifiedType.php

@@ -0,0 +1,8 @@
+<?php declare(strict_types = 1);
+
+namespace LastDragon_ru\LaraASP\Documentator\Processor\Events;
+
+enum FileSystemModifiedType {
+    case Created;
+    case Updated;
+}