Merge pull request #22 from andreaswolf/issue-13

[FEATURE] Add option to run process command in dry-run mode

Author: sabbelasichon

fractor/src/Application/Contract/FilePrinter.php fractor/src/Application/Contract/FileWriter.php

@@ -6,7 +6,7 @@
 
 use a9f\Fractor\Application\ValueObject\File;
 
-interface FilePrinter
+interface FileWriter
 {
-    public function printFile(File $file): void;
+    public function write(File $file): void;
 }

fractor/src/Application/FractorRunner.php

@@ -2,8 +2,8 @@
 
 namespace a9f\Fractor\Application;
 
-use a9f\Fractor\Application\Contract\FilePrinter;
 use a9f\Fractor\Application\Contract\FileProcessor;
+use a9f\Fractor\Application\Contract\FileWriter;
 use a9f\Fractor\Application\ValueObject\File;
 use a9f\Fractor\Configuration\ValueObject\Configuration;
 use a9f\Fractor\Console\Contract\Output;
@@ -19,7 +19,7 @@
     /**
      * @param FileProcessor[] $processors
      */
-    public function __construct(private FilesFinder $fileFinder, private FilesCollector $fileCollector, private iterable $processors, private Configuration $configuration, private FilePrinter $filePrinter)
+    public function __construct(private FilesFinder $fileFinder, private FilesCollector $fileCollector, private iterable $processors, private Configuration $configuration, private FileWriter $fileWriter)
     {
     }
 
@@ -51,7 +51,7 @@ public function run(Output $output, bool $dryRun = false): void
                 continue;
             }
 
-            $this->filePrinter->printFile($file);
+            $this->fileWriter->write($file);
         }
 
         $output->progressFinish();

fractor/src/Application/LocalFileSystemPrinter.php fractor/src/Application/LocalFileSystemWriter.php

@@ -4,13 +4,13 @@
 
 namespace a9f\Fractor\Application;
 
-use a9f\Fractor\Application\Contract\FilePrinter;
+use a9f\Fractor\Application\Contract\FileWriter;
 use a9f\Fractor\Application\ValueObject\File;
 use Nette\Utils\FileSystem;
 
-final class LocalFileSystemPrinter implements FilePrinter
+final class LocalFileSystemWriter implements FileWriter
 {
-    public function printFile(File $file): void
+    public function write(File $file): void
     {
         FileSystem::write($file->getFilePath(), $file->getContent());
     }

fractor/src/Configuration/Option.php

@@ -6,6 +6,25 @@
 
 final class Option
 {
+    /**
+     * @var string
+     */
     public const PATHS = 'paths';
+    /**
+     * @var string
+     */
     public const SKIP = 'skip';
+    /**
+     * @var string
+     */
+    public const DRY_RUN = 'dry-run';
+
+    /**
+     * @var string
+     */
+    public const CONFIG = 'config';
+    /**
+     * @var string
+     */
+    public const CONFIG_SHORT = 'c';
 }

fractor/src/Console/Command/ProcessCommand.php

@@ -3,6 +3,7 @@
 namespace a9f\Fractor\Console\Command;
 
 use a9f\Fractor\Application\FractorRunner;
+use a9f\Fractor\Configuration\Option;
 use a9f\Fractor\Console\Output\SymfonyConsoleOutput;
 use Symfony\Component\Console\Attribute\AsCommand;
 use Symfony\Component\Console\Command\Command;
@@ -21,16 +22,25 @@ public function __construct(private readonly FractorRunner $runner)
     protected function configure(): void
     {
         $this->addOption(
-            'config',
-            'c',
+            Option::CONFIG,
+            Option::CONFIG_SHORT,
             InputOption::VALUE_REQUIRED,
             'The configuration file to use. Default: fractor.php in the current directory.'
         );
+
+        $this->addOption(
+            Option::DRY_RUN,
+            null,
+            InputOption::VALUE_NONE,
+            'Only see the diff of changes, do not save them to files.'
+        );
     }
 
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
-        $this->runner->run(new SymfonyConsoleOutput($output));
+        $isDryRun = (bool) $input->getOption(Option::DRY_RUN);
+
+        $this->runner->run(new SymfonyConsoleOutput($output), $isDryRun);
 
         return Command::SUCCESS;
     }