[FEATURE] Introduce target file support for processed source files

This commit introduces a new schema configuration "target" for file
conditions within step configuration for processed source files and
processed shared source files. It allows to override the default
path determination behavior, e.g. when multiple files exist as
source files, while they should have the same target name, depending
on a given file condition.

Example:

Two source files `LICENSE.GPL-2.0.txt` and `LICENSE.GPL-3.0.txt` exist.
Both files must be named `LICENSE.txt` in the resulting project.
The file processing itself depends on given conditions: If the user
selects "GPL 2.0" as license, `LICENSE.GPL-2.0.txt` will be processed,
if "GPL 3.0" is selected, `LICENSE.GPL-3.0.txt` will be processed.

Example configuration:

steps:
  - type: processSourceFiles
    fileConditions:
      - path: 'LICENSE.GPL-2.0.txt'
        if: 'license == "GPL-2.0"'
        target: 'LICENSE.txt'
      - path: 'LICENSE.GPL-3.0.txt'
        if: 'license == "GPL-3.0"'
        target: 'LICENSE.txt'

resources/config.schema.json

@@ -289,6 +289,10 @@
 				"path": {
 					"type": "string",
 					"title": "Relative path to a file, can contain symbols processable by `fnmatch`"
+				},
+				"target": {
+					"type": "string",
+					"title": "Relative path to target file, can be used to override the default path"
 				}
 			},
 			"additionalProperties": false,

src/Builder/Config/ValueObject/FileCondition.php

@@ -36,6 +36,7 @@ final class FileCondition
     public function __construct(
         private string $path,
         string $if,
+        private ?string $target = null,
     ) {
         $this->if = $if;
     }
@@ -44,4 +45,9 @@ public function getPath(): string
     {
         return $this->path;
     }
+
+    public function getTarget(): ?string
+    {
+        return $this->target;
+    }
 }

src/Builder/Generator/Step/ProcessSharedSourceFilesStep.php

@@ -64,7 +64,7 @@ public function run(Builder\BuildResult $buildResult): bool
             );
 
             $writer = $this->writerFactory->get($sharedSourceFile->getPathname());
-            $processedFile = $writer->write($instructions, $sharedSourceFile);
+            $processedFile = $writer->write($instructions, $sharedSourceFile, $this->findTargetFile($sharedSourceFile));
 
             $this->processedFiles[] = new Resource\Local\ProcessedFile($sharedSourceFile, $processedFile);
 

src/Builder/Generator/Step/ProcessSourceFilesStep.php

@@ -63,7 +63,7 @@ public function run(Builder\BuildResult $buildResult): bool
             );
 
             $writer = $this->writerFactory->get($sourceFile->getPathname());
-            $processedFile = $writer->write($instructions, $sourceFile);
+            $processedFile = $writer->write($instructions, $sourceFile, $this->findTargetFile($sourceFile));
 
             $this->processedFiles[] = new Resource\Local\ProcessedFile($sourceFile, $processedFile);
 

src/Builder/Generator/Step/ProcessingFilesTrait.php

@@ -29,6 +29,8 @@
 use Symfony\Component\Filesystem;
 use Symfony\Component\Finder;
 
+use function fnmatch;
+
 /**
  * ProcessingFilesTrait.
  *
@@ -78,4 +80,15 @@ protected function shouldProcessFile(Finder\SplFileInfo $file, Builder\BuildInst
 
         return true;
     }
+
+    protected function findTargetFile(Finder\SplFileInfo $file): ?string
+    {
+        foreach ($this->config->getOptions()->getFileConditions() as $fileCondition) {
+            if (fnmatch($fileCondition->getPath(), $file->getRelativePathname())) {
+                return $fileCondition->getTarget();
+            }
+        }
+
+        return null;
+    }
 }

src/Builder/Writer/GenericFileWriter.php

@@ -41,10 +41,16 @@ public function __construct(
     ) {
     }
 
-    public function write(Builder\BuildInstructions $instructions, Finder\SplFileInfo $file): Finder\SplFileInfo
-    {
+    public function write(
+        Builder\BuildInstructions $instructions,
+        Finder\SplFileInfo $file,
+        ?string $targetFile = null,
+    ): Finder\SplFileInfo {
         $targetDirectory = $instructions->getTemporaryDirectory();
-        $targetFile = Helper\FilesystemHelper::createFileObject($targetDirectory, $file->getRelativePathname());
+        $targetFile = Helper\FilesystemHelper::createFileObject(
+            $targetDirectory,
+            $targetFile ?? $file->getRelativePathname(),
+        );
 
         $this->filesystem->copy($file->getPathname(), $targetFile->getPathname());
 

src/Builder/Writer/TemplateWriter.php

@@ -49,13 +49,14 @@ public function __construct(
     public function write(
         Builder\BuildInstructions $instructions,
         Finder\SplFileInfo $file,
+        ?string $targetFile = null,
         array $variables = [],
     ): Finder\SplFileInfo {
         $renderer = $this->renderer->withRootPath($file->getPath());
         $renderResult = $renderer->render($instructions, $file->getFilename(), $variables);
         $targetFile = Helper\FilesystemHelper::createFileObject(
             $instructions->getTemporaryDirectory(),
-            (string) preg_replace('/\.twig$/', '', $file->getRelativePathname()),
+            $targetFile ?? (string) preg_replace('/\.twig$/', '', $file->getRelativePathname()),
         );
 
         $this->filesystem->dumpFile($targetFile->getPathname(), $renderResult);

src/Builder/Writer/WriterInterface.php

@@ -34,7 +34,11 @@
  */
 interface WriterInterface
 {
-    public function write(Builder\BuildInstructions $instructions, Finder\SplFileInfo $file): Finder\SplFileInfo;
+    public function write(
+        Builder\BuildInstructions $instructions,
+        Finder\SplFileInfo $file,
+        ?string $targetFile = null,
+    ): Finder\SplFileInfo;
 
     public static function supports(string $file): bool;
 }

tests/src/Builder/Config/ConfigFactoryTest.php

@@ -82,13 +82,15 @@ public function buildFromFileReturnsHydratedConfigObject(): void
                     new Src\Builder\Config\ValueObject\StepOptions([
                         new Src\Builder\Config\ValueObject\FileCondition('dummy-2.'.$type, 'false'),
                         new Src\Builder\Config\ValueObject\FileCondition('*-3.'.$type, 'false'),
+                        new Src\Builder\Config\ValueObject\FileCondition('dummy-4.'.$type, 'true', 'overrides/dummy-4.'.$type),
                     ]),
                 ),
                 new Src\Builder\Config\ValueObject\Step(
                     'processSharedSourceFiles',
                     new Src\Builder\Config\ValueObject\StepOptions([
                         new Src\Builder\Config\ValueObject\FileCondition('shared-dummy-2.'.$type, 'false'),
                         new Src\Builder\Config\ValueObject\FileCondition('shared-*-3.'.$type, 'false'),
+                        new Src\Builder\Config\ValueObject\FileCondition('shared-dummy-4.'.$type, 'true', 'overrides/shared-dummy-4.'.$type),
                     ]),
                 ),
                 new Src\Builder\Config\ValueObject\Step('mirrorProcessedFiles'),

tests/src/Builder/Config/ValueObject/FileConditionTest.php

@@ -39,7 +39,7 @@ final class FileConditionTest extends TestCase
 
     protected function setUp(): void
     {
-        $this->subject = new Src\Config\ValueObject\FileCondition('foo', 'bar');
+        $this->subject = new Src\Config\ValueObject\FileCondition('foo', 'bar', 'target');
     }
 
     /**
@@ -76,4 +76,12 @@ public function conditionMatchesChecksIfConditionMatches(): void
         self::assertFalse($this->subject->conditionMatches($expressionLanguage, ['bar' => false]));
         self::assertTrue($this->subject->conditionMatches($expressionLanguage, ['bar' => true]));
     }
+
+    /**
+     * @test
+     */
+    public function getTargetReturnsTarget(): void
+    {
+        self::assertSame('target', $this->subject->getTarget());
+    }
 }

tests/src/Builder/Generator/Step/ProcessSharedSourceFilesStepTest.php

@@ -56,11 +56,14 @@ public function runProcessesSourceFilesAndAppliesStep(): void
         $actual = $this->subject->run($this->result);
 
         self::assertTrue($actual);
-        self::assertCount(1, $this->subject->getProcessedFiles());
-        self::assertSame('shared-dummy.yaml', $this->subject->getProcessedFiles()[0]->getTargetFile()->getRelativePathname());
+        self::assertCount(2, $this->subject->getProcessedFiles());
+        self::assertSame('overrides/shared-dummy-4.yaml', $this->subject->getProcessedFiles()[0]->getTargetFile()->getRelativePathname());
+        self::assertSame('shared-dummy.yaml', $this->subject->getProcessedFiles()[1]->getTargetFile()->getRelativePathname());
         self::assertFileExists($this->result->getInstructions()->getTemporaryDirectory().'/shared-dummy.yaml');
         self::assertFileDoesNotExist($this->result->getInstructions()->getTemporaryDirectory().'/shared-dummy-2.yaml');
         self::assertFileDoesNotExist($this->result->getInstructions()->getTemporaryDirectory().'/shared-dummy-3.yaml');
+        self::assertFileDoesNotExist($this->result->getInstructions()->getTemporaryDirectory().'/shared-dummy-4.yaml');
+        self::assertFileExists($this->result->getInstructions()->getTemporaryDirectory().'/overrides/shared-dummy-4.yaml');
         self::assertTrue($this->result->isStepApplied($this->subject));
     }
 

tests/src/Builder/Generator/Step/ProcessSourceFilesStepTest.php

@@ -56,11 +56,14 @@ public function runProcessesSourceFilesAndAppliesStep(): void
         $actual = $this->subject->run($this->result);
 
         self::assertTrue($actual);
-        self::assertCount(1, $this->subject->getProcessedFiles());
-        self::assertSame('dummy.yaml', $this->subject->getProcessedFiles()[0]->getTargetFile()->getRelativePathname());
+        self::assertCount(2, $this->subject->getProcessedFiles());
+        self::assertSame('overrides/dummy-4.yaml', $this->subject->getProcessedFiles()[0]->getTargetFile()->getRelativePathname());
+        self::assertSame('dummy.yaml', $this->subject->getProcessedFiles()[1]->getTargetFile()->getRelativePathname());
         self::assertFileExists($this->result->getInstructions()->getTemporaryDirectory().'/dummy.yaml');
         self::assertFileDoesNotExist($this->result->getInstructions()->getTemporaryDirectory().'/dummy-2.yaml');
         self::assertFileDoesNotExist($this->result->getInstructions()->getTemporaryDirectory().'/dummy-3.yaml');
+        self::assertFileDoesNotExist($this->result->getInstructions()->getTemporaryDirectory().'/dummy-4.yaml');
+        self::assertFileExists($this->result->getInstructions()->getTemporaryDirectory().'/overrides/dummy-4.yaml');
         self::assertTrue($this->result->isStepApplied($this->subject));
     }
 

tests/src/Builder/Writer/GenericFileWriterTest.php

@@ -66,4 +66,25 @@ public function writeCopiesGivenFileToTemporaryDirectory(): void
 
         (new Filesystem\Filesystem())->remove(dirname($expected));
     }
+
+    /**
+     * @test
+     */
+    public function writeCopiesGivenFileToGivenTargetFile(): void
+    {
+        $instructions = new Src\Builder\BuildInstructions(
+            self::$container->get('app.config'),
+            'foo',
+        );
+        $sourceFile = __FILE__;
+        $file = new Finder\SplFileInfo($sourceFile, dirname($sourceFile), basename($sourceFile));
+
+        $expected = $instructions->getTemporaryDirectory().'/overrides/foo.php';
+        $actual = $this->subject->write($instructions, $file, 'overrides/foo.php');
+
+        self::assertSame($expected, $actual->getPathname());
+        self::assertFileExists($expected);
+
+        (new Filesystem\Filesystem())->remove(dirname($expected));
+    }
 }

tests/src/Builder/Writer/TemplateWriterTest.php

@@ -62,7 +62,43 @@ public function writeWritesRenderedTemplateFileToTemporaryDirectory(): void
         $file = new Finder\SplFileInfo($templateFile, dirname($templateFile), basename($templateFile));
 
         $expected = $instructions->getTemporaryDirectory().'/dump.json';
-        $actual = $this->subject->write($instructions, $file, ['bar' => 'bar']);
+        $actual = $this->subject->write($instructions, $file, variables: ['bar' => 'bar']);
+
+        self::assertSame($expected, $actual->getPathname());
+        self::assertFileExists($expected);
+
+        $expectedJson = [
+            'instructions' => [
+                'sourceDirectory' => dirname(__DIR__, 2).'/templates/src',
+                'sharedSourceDirectory' => dirname(__DIR__, 2).'/templates/shared',
+            ],
+            'foo' => 'foo',
+            'bar' => 'bar',
+        ];
+
+        self::assertJson($actual->getContents());
+        self::assertSame($expectedJson, json_decode($actual->getContents(), true, 512, JSON_THROW_ON_ERROR));
+
+        (new Filesystem\Filesystem())->remove(dirname($expected));
+    }
+
+    /**
+     * @test
+     */
+    public function writeWritesRenderedTemplateFileToGivenTargetFile(): void
+    {
+        $instructions = new Src\Builder\BuildInstructions(
+            self::$container->get('app.config'),
+            'foo',
+        );
+        $instructions->addTemplateVariable('foo', 'foo');
+        $instructions->addTemplateVariable('bar', 'foo');
+
+        $templateFile = dirname(__DIR__, 3).'/templates/dump.json.twig';
+        $file = new Finder\SplFileInfo($templateFile, dirname($templateFile), basename($templateFile));
+
+        $expected = $instructions->getTemporaryDirectory().'/overrides/dump.json';
+        $actual = $this->subject->write($instructions, $file, 'overrides/dump.json', ['bar' => 'bar']);
 
         self::assertSame($expected, $actual->getPathname());
         self::assertFileExists($expected);

tests/src/Fixtures/Templates/json-template/config.json

@@ -15,6 +15,11 @@
 					{
 						"path": "*-3.json",
 						"if": "false"
+					},
+					{
+						"path": "dummy-4.json",
+						"if": "true",
+						"target": "overrides/dummy-4.json"
 					}
 				]
 			}
@@ -30,6 +35,11 @@
 					{
 						"path": "shared-*-3.json",
 						"if": "false"
+					},
+					{
+						"path": "shared-dummy-4.json",
+						"if": "true",
+						"target": "overrides/shared-dummy-4.json"
 					}
 				]
 			}

tests/src/Fixtures/Templates/json-template/templates/shared/shared-dummy/templates/src/shared-dummy-2.json

@@ -0,0 +1,3 @@
+{
+	"hello": "world"
+}

tests/src/Fixtures/Templates/json-template/templates/shared/shared-dummy/templates/src/shared-dummy-3.json

@@ -0,0 +1,3 @@
+{
+	"hello": "world"
+}

tests/src/Fixtures/Templates/json-template/templates/shared/shared-dummy/templates/src/shared-dummy-4.json

@@ -0,0 +1,3 @@
+{
+	"hello": "world"
+}

tests/src/Fixtures/Templates/json-template/templates/shared/shared-dummy/templates/src/shared-dummy.json.twig

@@ -0,0 +1,3 @@
+{
+	"name": "{{ bar.name }}"
+}

tests/src/Fixtures/Templates/json-template/templates/src/dummy-4.json

@@ -0,0 +1,3 @@
+{
+	"hello": "world"
+}

tests/src/Fixtures/Templates/yaml-template/config.yaml

@@ -9,13 +9,19 @@ steps:
           if: 'false'
         - path: '*-3.yaml'
           if: 'false'
+        - path: dummy-4.yaml
+          if: 'true'
+          target: 'overrides/dummy-4.yaml'
   - type: processSharedSourceFiles
     options:
       fileConditions:
         - path: shared-dummy-2.yaml
           if: 'false'
         - path: 'shared-*-3.yaml'
           if: 'false'
+        - path: shared-dummy-4.yaml
+          if: 'true'
+          target: 'overrides/shared-dummy-4.yaml'
   - type: mirrorProcessedFiles
 
 properties: