Added reason option into the configuration

.php-cs-fixer.dist.php

@@ -35,6 +35,11 @@
         'ereg_to_preg' => true,
         'dir_constant' => true,
         'method_chaining_indentation' => false,
+        'string_implicit_backslashes' => [
+            'single_quoted' => 'escape',
+            'heredoc' => 'escape',
+            'double_quoted' => 'escape'
+        ]
     ])
     ->setFinder($finder)
     ->setCacheFile('.php-cs-fixer.cache') // forward compatibility with 3.x line

src/Action/ConfigurationApplier.php

@@ -10,7 +10,7 @@
 
 final class ConfigurationApplier
 {
-    private ?Satellite\Action\Action $action = null;
+    private ?Action $action = null;
     private array $packages = [];
 
     public function __construct(
@@ -22,7 +22,7 @@ public function __construct(
 
     public function withAction(): self
     {
-        $this->action = new Satellite\Action\Action($this->plugin, clone $this->interpreter);
+        $this->action = new Action($this->plugin, clone $this->interpreter);
 
         return $this;
     }

src/Action/Custom/Factory/Action.php

@@ -63,7 +63,7 @@ public function validate(array $config): bool
     /**
      * @throws Configurator\ConfigurationExceptionInterface
      */
-    public function compile(array $config): Custom\Factory\Repository\Action
+    public function compile(array $config): Repository\Action
     {
         $containerName = sprintf('ProjectServiceContainer%s', ByteString::fromRandom(8)->toString());
 
@@ -74,7 +74,7 @@ public function compile(array $config): Custom\Factory\Repository\Action
 
         $container = (new SatelliteDependencyInjection(...$this->providers))($config);
 
-        $repository = new Custom\Factory\Repository\Action($builder);
+        $repository = new Repository\Action($builder);
 
         $dumper = new PhpDumper($container);
         $repository->addFiles(

src/Action/Custom/Service.php

@@ -4,7 +4,6 @@
 
 namespace Kiboko\Component\Satellite\Action\Custom;
 
-use Kiboko\Component\Satellite\Action\Custom;
 use Kiboko\Component\Satellite\ExpressionLanguage as Satellite;
 use Kiboko\Contract\Configurator;
 use Symfony\Component\Config\Definition\Exception as Symfony;
@@ -26,7 +25,7 @@ public function __construct(
         private ExpressionLanguage $interpreter = new Satellite\ExpressionLanguage()
     ) {
         $this->processor = new Processor();
-        $this->configuration = new Custom\Configuration();
+        $this->configuration = new Configuration();
     }
 
     public function interpreter(): ExpressionLanguage
@@ -78,7 +77,7 @@ public function compile(array $config): Configurator\RepositoryInterface
             }
         }
 
-        $actionFactory = new Custom\Factory\Action($this->interpreter);
+        $actionFactory = new Factory\Action($this->interpreter);
 
         return $actionFactory->compile($config);
     }

src/Adapter/ComposerFailureException.php

@@ -6,7 +6,7 @@
 
 final class ComposerFailureException extends \RuntimeException
 {
-    public function __construct(private readonly string $command = '', string $message = '', int $code = 0, \Throwable $previous = null)
+    public function __construct(private readonly string $command = '', string $message = '', int $code = 0, ?\Throwable $previous = null)
     {
         parent::__construct($message, $code, $previous);
     }

src/Adapter/Docker/SatelliteBuilder.php

@@ -23,8 +23,8 @@ final class SatelliteBuilder implements Configurator\SatelliteBuilderInterface
     private iterable $command = [];
     /** @var iterable<string> */
     private iterable $tags = [];
-    private null|PackagingContract\AssetInterface|PackagingContract\FileInterface $composerJsonFile = null;
-    private null|PackagingContract\AssetInterface|PackagingContract\FileInterface $composerLockFile = null;
+    private PackagingContract\AssetInterface|PackagingContract\FileInterface|null $composerJsonFile = null;
+    private PackagingContract\AssetInterface|PackagingContract\FileInterface|null $composerLockFile = null;
     /** @var iterable<array<string, string>> */
     private iterable $paths = [];
     /** @var \AppendIterator<string,PackagingContract\FileInterface, \Iterator<string,PackagingContract\FileInterface>> */
@@ -67,7 +67,7 @@ public function withComposerRequire(string ...$package): self
 
     public function withComposerFile(
         PackagingContract\AssetInterface|PackagingContract\FileInterface $composerJsonFile,
-        PackagingContract\AssetInterface|PackagingContract\FileInterface $composerLockFile = null
+        PackagingContract\AssetInterface|PackagingContract\FileInterface|null $composerLockFile = null
     ): self {
         $this->composerJsonFile = $composerJsonFile;
         $this->composerLockFile = $composerLockFile;
@@ -77,7 +77,7 @@ public function withComposerFile(
 
     public function withFile(
         PackagingContract\AssetInterface|PackagingContract\FileInterface $source,
-        string $destinationPath = null
+        ?string $destinationPath = null
     ): self {
         if (!$source instanceof PackagingContract\FileInterface) {
             $source = new Packaging\VirtualFile($source);
@@ -92,7 +92,7 @@ public function withFile(
         return $this;
     }
 
-    public function withDirectory(PackagingContract\DirectoryInterface $source, string $destinationPath = null): self
+    public function withDirectory(PackagingContract\DirectoryInterface $source, ?string $destinationPath = null): self
     {
         $this->paths[] = [$source->getPath(), $destinationPath ?? $source->getPath()];
 

src/Adapter/Filesystem/SatelliteBuilder.php

@@ -20,8 +20,8 @@ final class SatelliteBuilder implements Configurator\SatelliteBuilderInterface
     ];
     private array $authenticationTokens = [];
     private array $repositories = [];
-    private null|PackagingContract\AssetInterface|PackagingContract\FileInterface $composerJsonFile = null;
-    private null|PackagingContract\AssetInterface|PackagingContract\FileInterface $composerLockFile = null;
+    private PackagingContract\AssetInterface|PackagingContract\FileInterface|null $composerJsonFile = null;
+    private PackagingContract\AssetInterface|PackagingContract\FileInterface|null $composerLockFile = null;
     /** @var iterable<array<string, string>> */
     private iterable $paths = [];
     /** @var \AppendIterator<string,PackagingContract\FileInterface, \Iterator<string,PackagingContract\FileInterface>> */
@@ -55,7 +55,7 @@ public function withComposerRequire(string ...$package): self
 
     public function withComposerFile(
         PackagingContract\AssetInterface|PackagingContract\FileInterface $composerJsonFile,
-        PackagingContract\AssetInterface|PackagingContract\FileInterface $composerLockFile = null
+        PackagingContract\AssetInterface|PackagingContract\FileInterface|null $composerLockFile = null
     ): self {
         $this->composerJsonFile = $composerJsonFile;
         $this->composerLockFile = $composerLockFile;
@@ -65,7 +65,7 @@ public function withComposerFile(
 
     public function withFile(
         PackagingContract\AssetInterface|PackagingContract\FileInterface $source,
-        string $destinationPath = null
+        ?string $destinationPath = null
     ): self {
         if (!$source instanceof PackagingContract\FileInterface) {
             $source = new Packaging\VirtualFile($source);
@@ -80,7 +80,7 @@ public function withFile(
         return $this;
     }
 
-    public function withDirectory(PackagingContract\DirectoryInterface $source, string $destinationPath = null): self
+    public function withDirectory(PackagingContract\DirectoryInterface $source, ?string $destinationPath = null): self
     {
         $this->paths[] = [$source->getPath(), $destinationPath ?? $source->getPath()];
 

src/Adapter/Tar/SatelliteBuilder.php

@@ -13,8 +13,8 @@ final class SatelliteBuilder implements Configurator\SatelliteBuilderInterface
 {
     /** @var iterable<string> */
     private iterable $composerRequire = [];
-    private null|PackagingContract\AssetInterface|PackagingContract\FileInterface $composerJsonFile = null;
-    private null|PackagingContract\AssetInterface|PackagingContract\FileInterface $composerLockFile = null;
+    private PackagingContract\AssetInterface|PackagingContract\FileInterface|null $composerJsonFile = null;
+    private PackagingContract\AssetInterface|PackagingContract\FileInterface|null $composerLockFile = null;
     /** @var \AppendIterator<string,PackagingContract\FileInterface, \Iterator<string,PackagingContract\FileInterface>> */
     private readonly iterable $files;
     /** @var array<string, array<string, string>> */
@@ -48,7 +48,7 @@ public function withComposerRequire(string ...$package): self
 
     public function withComposerFile(
         PackagingContract\AssetInterface|PackagingContract\FileInterface $composerJsonFile,
-        PackagingContract\AssetInterface|PackagingContract\FileInterface $composerLockFile = null
+        PackagingContract\AssetInterface|PackagingContract\FileInterface|null $composerLockFile = null
     ): self {
         $this->composerJsonFile = $composerJsonFile;
         $this->composerLockFile = $composerLockFile;
@@ -58,7 +58,7 @@ public function withComposerFile(
 
     public function withFile(
         PackagingContract\AssetInterface|PackagingContract\FileInterface $source,
-        string $destinationPath = null
+        ?string $destinationPath = null
     ): self {
         if (!$source instanceof PackagingContract\FileInterface) {
             $source = new Packaging\VirtualFile($source);
@@ -71,7 +71,7 @@ public function withFile(
         return $this;
     }
 
-    public function withDirectory(PackagingContract\DirectoryInterface $source, string $destinationPath = null): self
+    public function withDirectory(PackagingContract\DirectoryInterface $source, ?string $destinationPath = null): self
     {
         $this->files->append(new \RecursiveIteratorIterator($source, \RecursiveIteratorIterator::SELF_FIRST));
 

src/Cloud/Auth.php

@@ -13,7 +13,7 @@ final class Auth
     private string $pathName;
     private array $configuration;
 
-    public function __construct(string $pathName = null)
+    public function __construct(?string $pathName = null)
     {
         if (null === $pathName) {
             $this->pathName = getenv('HOME').'/.gyroscops/';

src/Cloud/CommandBus.php

@@ -5,7 +5,6 @@
 namespace Kiboko\Component\Satellite\Cloud;
 
 use Gyroscops\Api\Client;
-use Kiboko\Component\Satellite;
 use React\Promise\Deferred;
 use React\Promise\PromiseInterface;
 
@@ -22,16 +21,16 @@ public function __construct(
     public static function withStandardHandlers(Client $client): self
     {
         return new self([
-            Satellite\Cloud\Command\Pipeline\DeclarePipelineCommand::class => new Satellite\Cloud\Handler\Pipeline\DeclarePipelineCommandHandler($client),
-            Satellite\Cloud\Command\Pipeline\AddPipelineComposerPSR4AutoloadCommand::class => new Satellite\Cloud\Handler\Pipeline\AddPipelineComposerPSR4AutoloadCommandHandler($client),
-            Satellite\Cloud\Command\Pipeline\AppendPipelineStepCommand::class => new Satellite\Cloud\Handler\Pipeline\AppendPipelineStepCommandHandler($client),
-            Satellite\Cloud\Command\Pipeline\RemovePipelineCommand::class => new Satellite\Cloud\Handler\Pipeline\RemovePipelineCommandHandler($client),
-            Satellite\Cloud\Command\Pipeline\AddAfterPipelineStepCommand::class => new Satellite\Cloud\Handler\Pipeline\AddAfterPipelineStepCommandHandler($client),
-            Satellite\Cloud\Command\Pipeline\AddBeforePipelineStepCommand::class => new Satellite\Cloud\Handler\Pipeline\AddBeforePipelineStepCommandHandler($client),
-            Satellite\Cloud\Command\Pipeline\ReplacePipelineStepCommand::class => new Satellite\Cloud\Handler\Pipeline\ReplacePipelineStepCommandHandler($client),
-            Satellite\Cloud\Command\Pipeline\RemovePipelineStepCommand::class => new Satellite\Cloud\Handler\Pipeline\RemovePipelineStepCommandHandler($client),
-            Satellite\Cloud\Command\Workflow\DeclareWorkflowCommand::class => new Satellite\Cloud\Handler\Workflow\DeclareWorkflowCommandHandler($client),
-            Satellite\Cloud\Command\Workflow\RemoveWorkflowCommand::class => new Satellite\Cloud\Handler\Workflow\RemoveWorkflowCommandHandler($client),
+            Command\Pipeline\DeclarePipelineCommand::class => new Handler\Pipeline\DeclarePipelineCommandHandler($client),
+            Command\Pipeline\AddPipelineComposerPSR4AutoloadCommand::class => new Handler\Pipeline\AddPipelineComposerPSR4AutoloadCommandHandler($client),
+            Command\Pipeline\AppendPipelineStepCommand::class => new Handler\Pipeline\AppendPipelineStepCommandHandler($client),
+            Command\Pipeline\RemovePipelineCommand::class => new Handler\Pipeline\RemovePipelineCommandHandler($client),
+            Command\Pipeline\AddAfterPipelineStepCommand::class => new Handler\Pipeline\AddAfterPipelineStepCommandHandler($client),
+            Command\Pipeline\AddBeforePipelineStepCommand::class => new Handler\Pipeline\AddBeforePipelineStepCommandHandler($client),
+            Command\Pipeline\ReplacePipelineStepCommand::class => new Handler\Pipeline\ReplacePipelineStepCommandHandler($client),
+            Command\Pipeline\RemovePipelineStepCommand::class => new Handler\Pipeline\RemovePipelineStepCommandHandler($client),
+            Command\Workflow\DeclareWorkflowCommand::class => new Handler\Workflow\DeclareWorkflowCommandHandler($client),
+            Command\Workflow\RemoveWorkflowCommand::class => new Handler\Workflow\RemoveWorkflowCommandHandler($client),
         ]);
     }
 

src/Cloud/DTO/JobList.php

@@ -4,14 +4,12 @@
 
 namespace Kiboko\Component\Satellite\Cloud\DTO;
 
-use Kiboko\Component\Satellite\Cloud\DTO;
-
 readonly class JobList implements \Countable, \IteratorAggregate
 {
     private array $jobs;
 
     public function __construct(
-        DTO\Workflow\JobInterface ...$job,
+        Workflow\JobInterface ...$job,
     ) {
         $this->jobs = $job;
     }
@@ -21,7 +19,7 @@ public function getIterator(): \Traversable
         $jobs = $this->jobs;
 
         /* @phpstan-ignore-next-line */
-        usort($jobs, fn (DTO\Workflow\JobInterface $left, DTO\Workflow\JobInterface $right) => $left->order <=> $right->order);
+        usort($jobs, fn (Workflow\JobInterface $left, Workflow\JobInterface $right) => $left->order <=> $right->order);
 
         return new \ArrayIterator($jobs);
     }
@@ -31,13 +29,13 @@ public function codes(): array
         $jobs = $this->jobs;
 
         /* @phpstan-ignore-next-line */
-        usort($jobs, fn (DTO\Workflow\JobInterface $left, DTO\Workflow\JobInterface $right) => $left->order <=> $right->order);
+        usort($jobs, fn (Workflow\JobInterface $left, Workflow\JobInterface $right) => $left->order <=> $right->order);
 
         /* @phpstan-ignore-next-line */
-        return array_map(fn (DTO\Workflow\JobInterface $job) => $job->code->asString(), $jobs);
+        return array_map(fn (Workflow\JobInterface $job) => $job->code->asString(), $jobs);
     }
 
-    public function get(string $code): DTO\Workflow\JobInterface
+    public function get(string $code): Workflow\JobInterface
     {
         foreach ($this->jobs as $job) {
             if ($job->code->asString() === $code) {

src/Cloud/Normalizer/ExpressionNormalizer.php

@@ -9,12 +9,12 @@
 
 class ExpressionNormalizer implements NormalizerInterface
 {
-    public function normalize(mixed $object, string $format = null, array $context = []): string
+    public function normalize(mixed $object, ?string $format = null, array $context = []): string
     {
         return (string) $object;
     }
 
-    public function supportsNormalization(mixed $data, string $format = null): bool
+    public function supportsNormalization(mixed $data, ?string $format = null): bool
     {
         return $data instanceof Expression;
     }

src/ConfigLoader.php

@@ -4,11 +4,10 @@
 
 namespace Kiboko\Component\Satellite;
 
-use Kiboko\Component\Satellite;
 use Kiboko\Contract\Configurator\InvalidConfigurationException;
 use Symfony\Component\Config;
 
-class ConfigLoader implements Satellite\ConfigLoaderInterface
+class ConfigLoader implements ConfigLoaderInterface
 {
     public function __construct(private readonly string $basePath)
     {
@@ -120,8 +119,8 @@ public function loadFile(string $file): array
         $locator = new Config\FileLocator([$this->basePath]);
 
         $loaderResolver = new Config\Loader\LoaderResolver([
-            new Satellite\Console\Config\YamlFileLoader($locator),
-            new Satellite\Console\Config\JsonFileLoader($locator),
+            new Console\Config\YamlFileLoader($locator),
+            new Console\Config\JsonFileLoader($locator),
         ]);
 
         $delegatingLoader = new Config\Loader\DelegatingLoader($loaderResolver);

src/ExpressionLanguage/ExpressionLanguage.php

@@ -9,7 +9,7 @@
 
 final class ExpressionLanguage extends BaseExpressionLanguage
 {
-    public function __construct(CacheItemPoolInterface $cache = null, array $providers = [])
+    public function __construct(?CacheItemPoolInterface $cache = null, array $providers = [])
     {
         parent::__construct($cache, [
             ...$providers,

src/Feature/Logger/Builder/Monolog/GelfBuilder.php

@@ -25,7 +25,7 @@ public function withLevel(string $level): self
         return $this;
     }
 
-    public function withTCPTransport(string $host = null, int $port = null): self
+    public function withTCPTransport(?string $host = null, ?int $port = null): self
     {
         $this->transport = 'tcp';
         $this->host = $host;
@@ -34,7 +34,7 @@ public function withTCPTransport(string $host = null, int $port = null): self
         return $this;
     }
 
-    public function withAMQPTransport(string $queue, string $channel, string $vhost, string $host = null, int $port = null, float $timeout = null): self
+    public function withAMQPTransport(string $queue, string $channel, string $vhost, ?string $host = null, ?int $port = null, ?float $timeout = null): self
     {
         $this->transport = 'amqp';
         $this->queue = $queue;

src/Feature/Logger/Factory/ElasticSearchFactory.php

@@ -53,7 +53,7 @@ public function validate(array $config): bool
         return false;
     }
 
-    public function compile(array $config): Logger\Factory\Repository\ElasticSearchRepository
+    public function compile(array $config): Repository\ElasticSearchRepository
     {
         $builder = new Logger\Builder\Monolog\ElasticSearchBuilder($this->interpreter);
 
@@ -69,6 +69,6 @@ public function compile(array $config): Logger\Factory\Repository\ElasticSearchR
             $builder->withIndex($config['index']);
         }
 
-        return new Logger\Factory\Repository\ElasticSearchRepository($builder);
+        return new Repository\ElasticSearchRepository($builder);
     }
 }

src/Feature/Logger/Factory/GelfFactory.php

@@ -50,7 +50,7 @@ public function validate(array $config): bool
         return false;
     }
 
-    public function compile(array $config): Logger\Factory\Repository\GelfRepository
+    public function compile(array $config): Repository\GelfRepository
     {
         $builder = new Logger\Builder\Monolog\GelfBuilder();
 
@@ -74,6 +74,6 @@ public function compile(array $config): Logger\Factory\Repository\GelfRepository
             );
         }
 
-        return new Logger\Factory\Repository\GelfRepository($builder);
+        return new Repository\GelfRepository($builder);
     }
 }

src/Feature/Logger/Factory/StreamFactory.php

@@ -50,7 +50,7 @@ public function validate(array $config): bool
         return false;
     }
 
-    public function compile(array $config): Logger\Factory\Repository\StreamRepository
+    public function compile(array $config): Repository\StreamRepository
     {
         $builder = new Logger\Builder\Monolog\StreamBuilder($config['path']);
 
@@ -66,6 +66,6 @@ public function compile(array $config): Logger\Factory\Repository\StreamReposito
             $builder->withLocking($config['use_locking']);
         }
 
-        return new Logger\Factory\Repository\StreamRepository($builder);
+        return new Repository\StreamRepository($builder);
     }
 }