refactor(documentator)!: Preprocessor moved to Processor namespace (#176)

Author: LastDragon-ru

packages/dev/src/App/Example.php

@@ -6,8 +6,8 @@
 use Illuminate\Contracts\Foundation\Application;
 use LastDragon_ru\LaraASP\Core\Application\ApplicationResolver;
 use LastDragon_ru\LaraASP\Core\Utils\ConfigMerger;
-use LastDragon_ru\LaraASP\Documentator\Preprocessor\Instructions\IncludeExample\Contracts\Runner;
 use LastDragon_ru\LaraASP\Documentator\Processor\FileSystem\File;
+use LastDragon_ru\LaraASP\Documentator\Processor\Tasks\Preprocess\Instructions\IncludeExample\Contracts\Runner;
 use LogicException;
 use Override;
 use PhpParser\ErrorHandler\Collecting;

packages/dev/src/App/Provider.php

@@ -3,7 +3,7 @@
 namespace LastDragon_ru\LaraASP\Dev\App;
 
 use Illuminate\Support\ServiceProvider;
-use LastDragon_ru\LaraASP\Documentator\Preprocessor\Instructions\IncludeExample\Contracts\Runner;
+use LastDragon_ru\LaraASP\Documentator\Processor\Tasks\Preprocess\Instructions\IncludeExample\Contracts\Runner;
 use Override;
 
 class Provider extends ServiceProvider {

packages/documentator/UPGRADE.md

@@ -38,10 +38,10 @@ Please also see [changelog](https://github.com/LastDragon-ru/lara-asp/releases)
 [//]: # (end: 470dd21d18d5886f1873b1247130ac8173ed99258e41418c6bd32162325d628b)
 
 * [ ] Migrate to the new contract:
-  * `\LastDragon_ru\LaraASP\Documentator\Preprocessor\Contracts\Instruction`
-  * `\LastDragon_ru\LaraASP\Documentator\Preprocessor\Contracts\Parameters`.
+  * `\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\Preprocess\Contracts\Instruction`
+  * `\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\Preprocess\Contracts\Parameters`.
 
-* [ ] Instruction `include:example` not check/run `<example>.run` file anymore. The `\LastDragon_ru\LaraASP\Documentator\Preprocessor\Instructions\IncludeExample\Contracts\Runner` should be used/provided instead.
+* [ ] Instruction `include:example` not check/run `<example>.run` file anymore. The `\LastDragon_ru\LaraASP\Documentator\Processor\Tasks\Preprocess\Instructions\IncludeExample\Contracts\Runner` should be used/provided instead.
 
 * [ ] `LastDragon_ru\LaraASP\Documentator\Processor\Contracts\Task::__invoke()` should yield a `LastDragon_ru\LaraASP\Documentator\Processor\Contracts\Dependency` instead of file.
 

packages/documentator/src/Commands/Commands.php

@@ -16,8 +16,6 @@
 
 use function is_dir;
 
-// @phpcs:disable Generic.Files.LineLength.TooLong
-
 #[AsCommand(
     name       : Commands::Name,
     description: 'Saves help for each command in the `namespace` into a separate file in the `target` directory.',

packages/documentator/src/Commands/Preprocess.php

@@ -6,11 +6,11 @@
 use LastDragon_ru\LaraASP\Core\Utils\Cast;
 use LastDragon_ru\LaraASP\Core\Utils\Path;
 use LastDragon_ru\LaraASP\Documentator\Package;
-use LastDragon_ru\LaraASP\Documentator\Preprocessor\Contracts\Instruction;
-use LastDragon_ru\LaraASP\Documentator\Preprocessor\Contracts\Parameters;
-use LastDragon_ru\LaraASP\Documentator\Preprocessor\Preprocessor;
 use LastDragon_ru\LaraASP\Documentator\Processor\Processor;
 use LastDragon_ru\LaraASP\Documentator\Processor\Result;
+use LastDragon_ru\LaraASP\Documentator\Processor\Tasks\Preprocess\Contracts\Instruction;
+use LastDragon_ru\LaraASP\Documentator\Processor\Tasks\Preprocess\Contracts\Parameters;
+use LastDragon_ru\LaraASP\Documentator\Processor\Tasks\Preprocess\Task;
 use LastDragon_ru\LaraASP\Documentator\Utils\Markdown;
 use LastDragon_ru\LaraASP\Documentator\Utils\PhpDoc;
 use LastDragon_ru\LaraASP\Formatter\Formatter;
@@ -39,7 +39,7 @@
 use function var_export;
 
 /**
- * @see Preprocessor
+ * @see Task
  */
 #[AsCommand(
     name       : Preprocess::Name,
@@ -70,7 +70,7 @@ class Preprocess extends Command {
         HELP;
 
     public function __construct(
-        protected readonly Preprocessor $preprocessor,
+        protected readonly Task $preprocess,
     ) {
         parent::__construct();
     }
@@ -100,7 +100,7 @@ public function __invoke(Formatter $formatter): void {
         };
 
         $duration = (new Processor())
-            ->task($this->preprocessor)
+            ->task($this->preprocess)
             ->run($path, $exclude, $listener);
 
         $this->output->newLine();
@@ -116,11 +116,11 @@ public function getProcessedHelp(): string {
     }
 
     protected function getProcessedHelpDescription(): string {
-        return $this->getDocBlock(new ReflectionClass(Preprocessor::class));
+        return $this->getDocBlock(new ReflectionClass(Task::class));
     }
 
     protected function getProcessedHelpInstructions(): string {
-        $instructions = $this->preprocessor->getInstructions();
+        $instructions = $this->preprocess->getInstructions();
         $help         = [];
 
         foreach ($instructions as $instruction) {

packages/documentator/src/Commands/PreprocessTest.php

@@ -2,10 +2,10 @@
 
 namespace LastDragon_ru\LaraASP\Documentator\Commands;
 
-use LastDragon_ru\LaraASP\Documentator\Preprocessor\Context;
-use LastDragon_ru\LaraASP\Documentator\Preprocessor\Contracts\Instruction;
-use LastDragon_ru\LaraASP\Documentator\Preprocessor\Contracts\Parameters;
-use LastDragon_ru\LaraASP\Documentator\Preprocessor\Preprocessor;
+use LastDragon_ru\LaraASP\Documentator\Processor\Tasks\Preprocess\Context;
+use LastDragon_ru\LaraASP\Documentator\Processor\Tasks\Preprocess\Contracts\Instruction;
+use LastDragon_ru\LaraASP\Documentator\Processor\Tasks\Preprocess\Contracts\Parameters;
+use LastDragon_ru\LaraASP\Documentator\Processor\Tasks\Preprocess\Task;
 use LastDragon_ru\LaraASP\Documentator\Testing\Package\TestCase;
 use LastDragon_ru\LaraASP\Serializer\Contracts\Serializable;
 use Mockery;
@@ -18,9 +18,9 @@
 #[CoversClass(Preprocess::class)]
 final class PreprocessTest extends TestCase {
     public function testGetProcessedHelpInstructions(): void {
-        $preprocessor = Mockery::mock(Preprocessor::class);
-        $preprocessor->shouldAllowMockingProtectedMethods();
-        $preprocessor
+        $preprocess = Mockery::mock(Task::class);
+        $preprocess->shouldAllowMockingProtectedMethods();
+        $preprocess
             ->shouldReceive('getInstructions')
             ->once()
             ->andReturn([
@@ -29,7 +29,7 @@ public function testGetProcessedHelpInstructions(): void {
                 PreprocessTest__InstructionNotSerializable::class,
             ]);
 
-        $command = new class($preprocessor) extends Preprocess {
+        $command = new class($preprocess) extends Preprocess {
             #[Override]
             public function getProcessedHelpInstructions(): string {
                 return parent::getProcessedHelpInstructions();
@@ -79,8 +79,8 @@ public function getProcessedHelpInstructions(): string {
     }
 
     public function testGetProcessedHelpInstructionTarget(): void {
-        $preprocessor = Mockery::mock(Preprocessor::class);
-        $command      = new class($preprocessor) extends Preprocess {
+        $preprocess = Mockery::mock(Task::class);
+        $command    = new class($preprocess) extends Preprocess {
             #[Override]
             public function getProcessedHelpInstructionTarget(
                 string $instruction,
@@ -107,8 +107,8 @@ public function getProcessedHelpInstructionTarget(
     }
 
     public function testGetProcessedHelpInstructionParameters(): void {
-        $preprocessor = Mockery::mock(Preprocessor::class);
-        $command      = new class($preprocessor) extends Preprocess {
+        $preprocess = Mockery::mock(Task::class);
+        $command    = new class($preprocess) extends Preprocess {
             #[Override]
             public function getProcessedHelpInstructionParameters(
                 string $instruction,
@@ -138,8 +138,8 @@ public function getProcessedHelpInstructionParameters(
     }
 
     public function testGetProcessedHelpInstructionParametersNoParameters(): void {
-        $preprocessor = Mockery::mock(Preprocessor::class);
-        $command      = new class($preprocessor) extends Preprocess {
+        $preprocess = Mockery::mock(Task::class);
+        $command    = new class($preprocess) extends Preprocess {
             #[Override]
             public function getProcessedHelpInstructionParameters(
                 string $instruction,
@@ -160,8 +160,8 @@ public function getProcessedHelpInstructionParameters(
     }
 
     public function testGetProcessedHelpInstructionParametersNotSerializable(): void {
-        $preprocessor = Mockery::mock(Preprocessor::class);
-        $command      = new class($preprocessor) extends Preprocess {
+        $preprocess = Mockery::mock(Task::class);
+        $command    = new class($preprocess) extends Preprocess {
             #[Override]
             public function getProcessedHelpInstructionParameters(
                 string $instruction,

packages/documentator/src/Preprocessor/Exceptions/PreprocessorError.php

@@ -1,6 +1,6 @@
 <?php declare(strict_types = 1);
 
-namespace LastDragon_ru\LaraASP\Documentator\Preprocessor;
+namespace LastDragon_ru\LaraASP\Documentator\Processor\Tasks\Preprocess;
 
 use LastDragon_ru\LaraASP\Documentator\Processor\FileSystem\Directory;
 use LastDragon_ru\LaraASP\Documentator\Processor\FileSystem\File;

packages/documentator/src/Preprocessor/Exceptions/TargetIsNotDirectory.php

@@ -1,10 +1,10 @@
 <?php declare(strict_types = 1);
 
-namespace LastDragon_ru\LaraASP\Documentator\Preprocessor\Contracts;
+namespace LastDragon_ru\LaraASP\Documentator\Processor\Tasks\Preprocess\Contracts;
 
 use Generator;
-use LastDragon_ru\LaraASP\Documentator\Preprocessor\Context;
 use LastDragon_ru\LaraASP\Documentator\Processor\Contracts\Dependency;
+use LastDragon_ru\LaraASP\Documentator\Processor\Tasks\Preprocess\Context;
 
 /**
  * @template TParameters of Parameters

packages/documentator/src/Preprocessor/Context.php packages/documentator/src/Processor/Tasks/Preprocess/Context.php

@@ -1,6 +1,6 @@
 <?php declare(strict_types = 1);
 
-namespace LastDragon_ru\LaraASP\Documentator\Preprocessor\Contracts;
+namespace LastDragon_ru\LaraASP\Documentator\Processor\Tasks\Preprocess\Contracts;
 
 /**
  * @property-read string $target

packages/documentator/src/Preprocessor/Contracts/Instruction.php packages/documentator/src/Processor/Tasks/Preprocess/Contracts/Instruction.php

@@ -1,8 +1,8 @@
 <?php declare(strict_types = 1);
 
-namespace LastDragon_ru\LaraASP\Documentator\Preprocessor\Exceptions;
+namespace LastDragon_ru\LaraASP\Documentator\Processor\Tasks\Preprocess\Exceptions;
 
-use LastDragon_ru\LaraASP\Documentator\Preprocessor\Context;
+use LastDragon_ru\LaraASP\Documentator\Processor\Tasks\Preprocess\Context;
 use Throwable;
 
 use function sprintf;

packages/documentator/src/Preprocessor/Contracts/Parameters.php packages/documentator/src/Processor/Tasks/Preprocess/Contracts/Parameters.php

@@ -1,11 +1,11 @@
 <?php declare(strict_types = 1);
 
-namespace LastDragon_ru\LaraASP\Documentator\Preprocessor\Exceptions;
+namespace LastDragon_ru\LaraASP\Documentator\Processor\Tasks\Preprocess\Exceptions;
 
-use LastDragon_ru\LaraASP\Documentator\Preprocessor\Context;
+use LastDragon_ru\LaraASP\Documentator\Processor\Tasks\Preprocess\Context;
 use Throwable;
 
-abstract class InstructionFailed extends PreprocessorError {
+abstract class InstructionFailed extends PreprocessError {
     public function __construct(
         private readonly Context $context,
         string $message,

packages/documentator/src/Preprocessor/Exceptions/DependencyIsMissing.php packages/documentator/src/Processor/Tasks/Preprocess/Exceptions/DependencyIsMissing.php

@@ -0,0 +1,9 @@
+<?php declare(strict_types = 1);
+
+namespace LastDragon_ru\LaraASP\Documentator\Processor\Tasks\Preprocess\Exceptions;
+
+use LastDragon_ru\LaraASP\Documentator\Processor\Exceptions\ProcessorError;
+
+abstract class PreprocessError extends ProcessorError {
+    // empty
+}

packages/documentator/src/Preprocessor/Exceptions/InstructionFailed.php packages/documentator/src/Processor/Tasks/Preprocess/Exceptions/InstructionFailed.php

@@ -1,11 +1,10 @@
 <?php declare(strict_types = 1);
 
-namespace LastDragon_ru\LaraASP\Documentator\Preprocessor\Exceptions;
+namespace LastDragon_ru\LaraASP\Documentator\Processor\Tasks\Preprocess\Exceptions;
 
-use LastDragon_ru\LaraASP\Documentator\PackageException;
 use Throwable;
 
-class PreprocessingFailed extends PackageException {
+class PreprocessFailed extends PreprocessError {
     public function __construct(
         Throwable $previous = null,
     ) {

packages/documentator/src/Processor/Tasks/Preprocess/Exceptions/PreprocessError.php

@@ -1,9 +1,9 @@
 <?php declare(strict_types = 1);
 
-namespace LastDragon_ru\LaraASP\Documentator\Preprocessor\Instructions\IncludeArtisan\Exceptions;
+namespace LastDragon_ru\LaraASP\Documentator\Processor\Tasks\Preprocess\Instructions\IncludeArtisan\Exceptions;
 
-use LastDragon_ru\LaraASP\Documentator\Preprocessor\Context;
-use LastDragon_ru\LaraASP\Documentator\Preprocessor\Exceptions\InstructionFailed;
+use LastDragon_ru\LaraASP\Documentator\Processor\Tasks\Preprocess\Context;
+use LastDragon_ru\LaraASP\Documentator\Processor\Tasks\Preprocess\Exceptions\InstructionFailed;
 use Throwable;
 
 use function sprintf;

packages/documentator/src/Preprocessor/Exceptions/PreprocessingFailed.php packages/documentator/src/Processor/Tasks/Preprocess/Exceptions/PreprocessFailed.php

@@ -1,9 +1,9 @@
 <?php declare(strict_types = 1);
 
-namespace LastDragon_ru\LaraASP\Documentator\Preprocessor\Instructions\IncludeArtisan\Exceptions;
+namespace LastDragon_ru\LaraASP\Documentator\Processor\Tasks\Preprocess\Instructions\IncludeArtisan\Exceptions;
 
-use LastDragon_ru\LaraASP\Documentator\Preprocessor\Context;
-use LastDragon_ru\LaraASP\Documentator\Preprocessor\Exceptions\InstructionFailed;
+use LastDragon_ru\LaraASP\Documentator\Processor\Tasks\Preprocess\Context;
+use LastDragon_ru\LaraASP\Documentator\Processor\Tasks\Preprocess\Exceptions\InstructionFailed;
 use Throwable;
 
 use function sprintf;

packages/documentator/src/Preprocessor/Instructions/IncludeArtisan/Exceptions/ArtisanCommandError.php packages/documentator/src/Processor/Tasks/Preprocess/Instructions/IncludeArtisan/Exceptions/ArtisanCommandError.php

@@ -1,15 +1,15 @@
 <?php declare(strict_types = 1);
 
-namespace LastDragon_ru\LaraASP\Documentator\Preprocessor\Instructions\IncludeArtisan;
+namespace LastDragon_ru\LaraASP\Documentator\Processor\Tasks\Preprocess\Instructions\IncludeArtisan;
 
 use Exception;
 use Illuminate\Contracts\Console\Kernel;
 use LastDragon_ru\LaraASP\Core\Application\ApplicationResolver;
-use LastDragon_ru\LaraASP\Documentator\Preprocessor\Context;
-use LastDragon_ru\LaraASP\Documentator\Preprocessor\Contracts\Instruction as InstructionContract;
-use LastDragon_ru\LaraASP\Documentator\Preprocessor\Exceptions\InstructionFailed;
-use LastDragon_ru\LaraASP\Documentator\Preprocessor\Instructions\IncludeArtisan\Exceptions\ArtisanCommandError;
-use LastDragon_ru\LaraASP\Documentator\Preprocessor\Instructions\IncludeArtisan\Exceptions\ArtisanCommandFailed;
+use LastDragon_ru\LaraASP\Documentator\Processor\Tasks\Preprocess\Context;
+use LastDragon_ru\LaraASP\Documentator\Processor\Tasks\Preprocess\Contracts\Instruction as InstructionContract;
+use LastDragon_ru\LaraASP\Documentator\Processor\Tasks\Preprocess\Exceptions\InstructionFailed;
+use LastDragon_ru\LaraASP\Documentator\Processor\Tasks\Preprocess\Instructions\IncludeArtisan\Exceptions\ArtisanCommandError;
+use LastDragon_ru\LaraASP\Documentator\Processor\Tasks\Preprocess\Instructions\IncludeArtisan\Exceptions\ArtisanCommandFailed;
 use Override;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\StringInput;

packages/documentator/src/Preprocessor/Instructions/IncludeArtisan/Exceptions/ArtisanCommandFailed.php packages/documentator/src/Processor/Tasks/Preprocess/Instructions/IncludeArtisan/Exceptions/ArtisanCommandFailed.php

@@ -1,16 +1,16 @@
 <?php declare(strict_types = 1);
 
-namespace LastDragon_ru\LaraASP\Documentator\Preprocessor\Instructions\IncludeArtisan;
+namespace LastDragon_ru\LaraASP\Documentator\Processor\Tasks\Preprocess\Instructions\IncludeArtisan;
 
 use Composer\InstalledVersions;
 use Composer\Semver\VersionParser;
 use Illuminate\Contracts\Console\Kernel;
 use LastDragon_ru\LaraASP\Core\Application\ApplicationResolver;
 use LastDragon_ru\LaraASP\Core\Utils\Path;
-use LastDragon_ru\LaraASP\Documentator\Preprocessor\Context;
-use LastDragon_ru\LaraASP\Documentator\Preprocessor\Instructions\IncludeArtisan\Exceptions\ArtisanCommandFailed;
 use LastDragon_ru\LaraASP\Documentator\Processor\FileSystem\Directory;
 use LastDragon_ru\LaraASP\Documentator\Processor\FileSystem\File;
+use LastDragon_ru\LaraASP\Documentator\Processor\Tasks\Preprocess\Context;
+use LastDragon_ru\LaraASP\Documentator\Processor\Tasks\Preprocess\Instructions\IncludeArtisan\Exceptions\ArtisanCommandFailed;
 use LastDragon_ru\LaraASP\Documentator\Testing\Package\ProcessorHelper;
 use LastDragon_ru\LaraASP\Documentator\Testing\Package\TestCase;
 use Mockery;

packages/documentator/src/Preprocessor/Instructions/IncludeArtisan/Instruction.php packages/documentator/src/Processor/Tasks/Preprocess/Instructions/IncludeArtisan/Instruction.php

@@ -1,8 +1,8 @@
 <?php declare(strict_types = 1);
 
-namespace LastDragon_ru\LaraASP\Documentator\Preprocessor\Instructions\IncludeArtisan;
+namespace LastDragon_ru\LaraASP\Documentator\Processor\Tasks\Preprocess\Instructions\IncludeArtisan;
 
-use LastDragon_ru\LaraASP\Documentator\Preprocessor\Contracts\Parameters as ParametersContract;
+use LastDragon_ru\LaraASP\Documentator\Processor\Tasks\Preprocess\Contracts\Parameters as ParametersContract;
 use LastDragon_ru\LaraASP\Serializer\Contracts\Serializable;
 
 class Parameters implements ParametersContract, Serializable {

packages/documentator/src/Preprocessor/Instructions/IncludeArtisan/InstructionTest.php packages/documentator/src/Processor/Tasks/Preprocess/Instructions/IncludeArtisan/InstructionTest.php

@@ -1,9 +1,9 @@
 <?php declare(strict_types = 1);
 
-namespace LastDragon_ru\LaraASP\Documentator\Preprocessor\Instructions\IncludeDocBlock\Exceptions;
+namespace LastDragon_ru\LaraASP\Documentator\Processor\Tasks\Preprocess\Instructions\IncludeDocBlock\Exceptions;
 
-use LastDragon_ru\LaraASP\Documentator\Preprocessor\Context;
-use LastDragon_ru\LaraASP\Documentator\Preprocessor\Exceptions\InstructionFailed;
+use LastDragon_ru\LaraASP\Documentator\Processor\Tasks\Preprocess\Context;
+use LastDragon_ru\LaraASP\Documentator\Processor\Tasks\Preprocess\Exceptions\InstructionFailed;
 use Throwable;
 
 use function sprintf;