Added step to create folders

Author: bastianschwarz

README.md

@@ -36,7 +36,7 @@ so you can change the final structure on the fly (e.g. have a folder structure t
 ```php
 use de\codenamephp\installer\StepExecutor;
 use de\codenamephp\installer\steps\CopyTemplateFolder;
-use de\codenamephp\installer\steps\DeleteFilesAndFolders;
+use de\codenamephp\installer\steps\CreateFolders;use de\codenamephp\installer\steps\DeleteFilesAndFolders;
 use de\codenamephp\installer\steps\SequentialCollection;
 use de\codenamephp\installer\templateCopy\directoryHandler\CreateDirectoryWithSymfonyFilesystem;
 use de\codenamephp\installer\templateCopy\fileHandler\RenderWithTwigAndDumpWithSymfonyFilesystem;
@@ -51,7 +51,12 @@ return call_user_func(static function() {
   $filesystem = new Filesystem();
   $variableReplacer = new FramedStringReplace();
   $componentName = basename(shell_exec("git config --get remote.origin.url"), '.git');
-  
+  $variables = [
+            'vendor' => 'codenamephp',
+            'componentName' => $componentName,
+            'namespace' => implode('\\', array_merge(['de', 'codenamephp'], explode('.', $componentName)))
+          ];
+          
   (new StepExecutor(
     new SequentialCollection(
       new CopyTemplateFolder(
@@ -61,12 +66,9 @@ return call_user_func(static function() {
           ),
           __DIR__ . '/templates',
           __DIR__ . '/..',
-          [
-            'vendor' => 'codenamephp',
-            'componentName' => $componentName,
-            'namespace' => implode('\\', array_merge(['de', 'codenamephp'], explode('.', $componentName)))
-          ] 
+          $variables 
       ),
+      new CreateFolders($variableReplacer, $filesystem, [__DIR__ . '/../src', __DIR__ . '/../test'], $variables),
       new DeleteFilesAndFolders($filesystem, [
         __DIR__      
       ]),

src/steps/CreateFolders.php

@@ -0,0 +1,50 @@
+<?php declare(strict_types=1);
+/**
+ * Copyright 2021 Bastian Schwarz <bastian@codename-php.de>.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+namespace de\codenamephp\installer\steps;
+
+use de\codenamephp\installer\templateCopy\variableReplacer\iVariableReplacer;
+use Symfony\Component\Filesystem\Exception\IOException;
+use Symfony\Component\Filesystem\Filesystem;
+
+/**
+ * Step to create folders since git doesn't commit empty folders. This way we don't have to create folders in the base template and place .gitkeep files in them
+ */
+final class CreateFolders implements iStep {
+
+  /**
+   * @param iVariableReplacer $variableReplacer Used to replace variables in the folder paths
+   * @param Filesystem $filesystem Used to create the folders
+   * @param array<string> $folders The absolute paths of the folders to be created
+   * @param array<string, string> $variables Used in variable replacement in the folder paths
+   */
+  public function __construct(public iVariableReplacer $variableReplacer, public Filesystem $filesystem, public array $folders, public array $variables) { }
+
+  /**
+   * Iterates over all folders, replaces the variables in each path using the variables and the variableReplacer passes each path to symfony filesystem to
+   * create the folders
+   *
+   * @inheritDoc
+   * @throws IOException
+   */
+  public function run() : void {
+    foreach($this->folders as $folder) {
+      $this->filesystem->mkdir($this->variableReplacer->replace($folder, $this->variables));
+    }
+  }
+}

test/steps/CreateFoldersTest.php

@@ -0,0 +1,60 @@
+<?php declare(strict_types=1);
+/**
+ * Copyright 2021 Bastian Schwarz <bastian@codename-php.de>.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+namespace de\codenamephp\installer\test\steps;
+
+use de\codenamephp\installer\steps\CreateFolders;
+use de\codenamephp\installer\templateCopy\variableReplacer\iVariableReplacer;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Filesystem\Filesystem;
+
+class CreateFoldersTest extends TestCase {
+
+  private CreateFolders $sut;
+
+  protected function setUp() : void {
+    $variableReplacer = $this->createMock(iVariableReplacer::class);
+    $filesystem = $this->createMock(Filesystem::class);
+
+    $this->sut = new CreateFolders($variableReplacer, $filesystem, [], []);
+  }
+
+  public function testRun() : void {
+    $this->sut->variables = ['some', 'vars'];
+    $this->sut->folders = ['folder1', 'folder2', 'folder3'];
+
+    $this->sut->variableReplacer = $this->createMock(iVariableReplacer::class);
+    $this->sut->variableReplacer
+        ->expects(self::exactly(3))
+        ->method('replace')
+        ->withConsecutive(
+            [$this->sut->folders[0], $this->sut->variables],
+            [$this->sut->folders[1], $this->sut->variables],
+            [$this->sut->folders[2], $this->sut->variables],
+        )
+        ->willReturnOnConsecutiveCalls('replaced1', 'replaced2', 'replaced3');
+
+    $this->sut->filesystem = $this->createMock(Filesystem::class);
+    $this->sut->filesystem
+        ->expects(self::exactly(3))
+        ->method('mkdir')
+        ->withConsecutive(['replaced1'], ['replaced2'], ['replaced3']);
+
+    $this->sut->run();
+  }
+}