- Declaring the variables array as string array

- Added StringReplace variable replacer

Author: bastianschwarz

src/steps/CopyTemplateFolder.php

@@ -25,6 +25,12 @@
  */
 final class CopyTemplateFolder implements iStep {
 
+  /**
+   * @param iTemplateCopy $templateCopy Actually copies the files while treating them as templates
+   * @param string $templateFolder The base folders where the templates are located
+   * @param string $targetFolder The target folder where the template structure will be recreated
+   * @param string[] $variables The variables used to replace the placeholders in paths and templates
+   */
   public function __construct(public iTemplateCopy $templateCopy, public string $templateFolder, public string $targetFolder, public array $variables) { }
 
   public function run() : void {

src/templateCopy/directoryHandler/iDirectoryHandler.php

@@ -27,7 +27,7 @@ interface iDirectoryHandler {
    * correctly
    *
    * @param string $target The target path of the folder, e.g. the folder where the templates are installed to
-   * @param array $variables The variables to use to replace any variables in the path
+   * @param string[] $variables The variables to use to replace any variables in the path
    */
   public function handle(string $target, array $variables) : void;
 }

src/templateCopy/fileHandler/iFileHandler.php

@@ -28,7 +28,7 @@ interface iFileHandler {
    *
    * @param string $source The source path of the template being copied
    * @param string $target The target path to where the template should be rendered to
-   * @param array $variables The variables that should be used to replace placeholders in the paths and the file
+   * @param string[] $variables The variables that should be used to replace placeholders in the paths and the file
    */
   public function handle(string $source, string $target, array $variables) : void;
 }

src/templateCopy/iTemplateCopy.php

@@ -30,7 +30,7 @@ interface iTemplateCopy {
    *
    * @param string $source The absolute path to the source file or folder
    * @param string $target The absolute path to the target file or folder
-   * @param array $variables An array of variables that will be used for replacing placeholders
+   * @param string[] $variables An array of variables that will be used for replacing placeholders
    */
   public function copy(string $source, string $target, array $variables) : void;
 }

src/templateCopy/variableReplacer/StringReplace.php

@@ -0,0 +1,34 @@
+<?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\templateCopy\variableReplacer;
+
+/**
+ * Uses str_replace to replace all placeholders in the path with the variables array the name matching must be 1:1
+ */
+final class StringReplace implements iVariableReplacer {
+  /**
+   * Passes the array kes of the variables which are the names of the placeholders as search, the values as replace and the path as subject and returns
+   * the result.
+   *
+   * @inheritDoc
+   */
+  public function replace(string $path, array $variables) : string {
+    return str_replace(array_keys($variables), $variables, $path);
+  }
+}

src/templateCopy/variableReplacer/iVariableReplacer.php

@@ -27,7 +27,7 @@ interface iVariableReplacer {
    * Implementations MUST make sure that all variables are replaced and return the final path
    *
    * @param string $path The path containing the placeholders
-   * @param array $variables The variables to use to replace the placeholders
+   * @param string[] $variables The variables to use to replace the placeholders
    * @return string The path with the placeholders replaced
    */
   public function replace(string $path, array $variables) : string;

test/templateCopy/variableReplacer/StringReplaceTest.php

@@ -0,0 +1,38 @@
+<?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\templateCopy\variableReplacer;
+
+use de\codenamephp\installer\templateCopy\variableReplacer\StringReplace;
+use PHPUnit\Framework\TestCase;
+
+class StringReplaceTest extends TestCase {
+
+  private StringReplace $sut;
+
+  protected function setUp() : void {
+    $this->sut = new StringReplace();
+  }
+
+  public function testReplace() : void {
+    self::assertEquals('/some/path/without/placeholders/path', $this->sut->replace(
+        '/some/__placeholder1__/without/__placeholder2__/__placeholder1__',
+        ['__placeholder1__' => 'path', '__placeholder2__' => 'placeholders'])
+    );
+  }
+}