Reworked commands to use factories which is much cleaner and more flexible

Signed-off-by: Bastian Schwarz <bastian@codename-php.de>

Author: bastianschwarz

src/command/WithBinaryFromDeployer.php

@@ -0,0 +1,37 @@
+<?php declare(strict_types=1);
+/*
+ *   Copyright 2022 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\deployer\npm\command;
+
+use de\codenamephp\deployer\base\functions\All;
+use de\codenamephp\deployer\base\functions\iGet;
+use de\codenamephp\deployer\command\Command;
+use de\codenamephp\deployer\command\iCommand;
+use de\codenamephp\deployer\command\runConfiguration\iRunConfiguration;
+use de\codenamephp\deployer\command\runConfiguration\SimpleContainer;
+
+/**
+ * Factory that gets the npm binary from deployer with a fallback to npm
+ */
+final class WithBinaryFromDeployer implements iNpmCommandFactory {
+
+  public function __construct(public iGet $deployer = new All()) {}
+
+  public function build(string $command, array $arguments = [], array $envVars = [], bool $sudo = false, iRunConfiguration $runConfiguration = null) : iCommand {
+    return new Command((string) $this->deployer->get('npm:binary', 'npm'), ['--prefix {{release_path}}', '--fund=false', $command, ...$arguments], $envVars, $sudo, $runConfiguration ?? new SimpleContainer());
+  }
+}

src/command/iNpmCommandFactory.php

@@ -0,0 +1,40 @@
+<?php declare(strict_types=1);
+/*
+ *   Copyright 2022 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\deployer\npm\command;
+
+use de\codenamephp\deployer\command\iCommand;
+use de\codenamephp\deployer\command\runConfiguration\iRunConfiguration;
+
+/**
+ * Interface to create commands geared towards npm on the fly. Implementations must take care of setting the npm binary. The npm command should be the first
+ * argument.
+ */
+interface iNpmCommandFactory {
+
+  /**
+   * Implementations MUST make sure the command gets the correct binary (e.g. from deployer) and that all parameters are passed on correctly
+   *
+   * @param string $command The npm command to run, e.g. 'install' or 'run'
+   * @param array<int, string> $arguments Array of arguments to pass to the command with numerical indexes so the arguments can be expanded, e.g. ['--production', '--fund=false']
+   * @param array<string, string> $envVars Array of env vars to pass to the command with the name as key.
+   * @param bool $sudo Flag if the command should be executed as root
+   * @param iRunConfiguration|null $runConfiguration The run configuration for the command. Defaults to an empty configuration
+   * @return iCommand The command to run
+   */
+  public function build(string $command, array $arguments = [], array $envVars = [], bool $sudo = false, iRunConfiguration $runConfiguration = null) : iCommand;
+}

src/command/run/DecorateCommandFactory.php

@@ -0,0 +1,35 @@
+<?php declare(strict_types=1);
+/*
+ *   Copyright 2022 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\deployer\npm\command\run;
+
+use de\codenamephp\deployer\command\iCommand;
+use de\codenamephp\deployer\command\runConfiguration\iRunConfiguration;
+use de\codenamephp\deployer\npm\command\iNpmCommandFactory;
+use de\codenamephp\deployer\npm\command\WithBinaryFromDeployer;
+
+/**
+ * Just decorates a command factory to build the command and makes sure the script name and "run" are passed on correctly using the arguments
+ */
+final class DecorateCommandFactory implements iNpmRunCommandFactory {
+
+  public function __construct(public iNpmCommandFactory $commandFactory = new WithBinaryFromDeployer()) {}
+
+  public function build(string $scriptName, array $arguments = [], array $envVars = [], bool $sudo = false, iRunConfiguration $runConfiguration = null) : iCommand {
+    return $this->commandFactory->build('run', [$scriptName, ...$arguments], $envVars, $sudo, $runConfiguration);
+  }
+}

src/command/run/iNpmRunCommandFactory.php

@@ -0,0 +1,40 @@
+<?php declare(strict_types=1);
+/*
+ *   Copyright 2022 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\deployer\npm\command\run;
+
+use de\codenamephp\deployer\command\iCommand;
+use de\codenamephp\deployer\command\runConfiguration\iRunConfiguration;
+
+/**
+ * Interface to create a command for running npm scripts. Implementations must make sure to set the command correctly together with the script name in the
+ * arguments
+ */
+interface iNpmRunCommandFactory {
+
+  /**
+   * Implementations MUST make sure the command gets the correct binary and command to run the script and pass on all parameters correctly
+   *
+   * @param string $scriptName The name of the script to run
+   * @param array<int, string> $arguments Array of arguments to pass to the command with numerical indexes so the arguments can be expanded, e.g. ['--production', '--fund=false']
+   * @param array<string, string> $envVars Array of env vars to pass to the command with the name as key.
+   * @param bool $sudo Flag if the command should be executed as root
+   * @param iRunConfiguration|null $runConfiguration The run configuration for the command. Defaults to an empty configuration
+   * @return iCommand The command to run
+   */
+  public function build(string $scriptName, array $arguments = [], array $envVars = [], bool $sudo = false, iRunConfiguration $runConfiguration = null) : iCommand;
+}

src/task/AbstractNpmTask.php

@@ -17,27 +17,18 @@
 
 namespace de\codenamephp\deployer\npm\task;
 
-use de\codenamephp\deployer\base\functions\All;
-use de\codenamephp\deployer\base\functions\iGet;
 use de\codenamephp\deployer\base\task\iTask;
-use de\codenamephp\deployer\command\Command;
-use de\codenamephp\deployer\command\iCommand;
 use de\codenamephp\deployer\command\runner\iRunner;
 use de\codenamephp\deployer\command\runner\WithDeployerFunctions;
+use de\codenamephp\deployer\npm\command\iNpmCommandFactory;
+use de\codenamephp\deployer\npm\command\WithBinaryFromDeployer;
 
 /**
  * Base class for npm command setting the binary to npm
  */
 abstract class AbstractNpmTask implements iTask {
 
-  public iCommand $command;
-
-  public function __construct(
-    public iRunner $runner = new WithDeployerFunctions(),
-    iGet           $deployer = new All()
-  ) {
-    $this->command = new Command((string) $deployer->get('npm:binary', 'npm'), [$this->getNpmCommand(), ...$this->getArguments()]);
-  }
+  public function __construct(public iNpmCommandFactory $commandFactory = new WithBinaryFromDeployer(), public iRunner $runner = new WithDeployerFunctions()) {}
 
   /**
    * Gets the command for npm, e.g. install or run-script
@@ -55,11 +46,9 @@ abstract public function getNpmCommand() : string;
    *
    * @return array<int,string>
    */
-  public function getArguments() : array {
-    return ['--prefix {{release_path}}', '--fund=false'];
-  }
+  abstract public function getArguments() : array;
 
   public function __invoke() : void {
-    $this->runner->run($this->command);
+    $this->runner->run($this->commandFactory->build($this->getNpmCommand(), $this->getArguments()));
   }
 }

src/task/install/Development.php

@@ -23,6 +23,6 @@
 final class Development extends AbstractInstallTask {
 
   public function getArguments() : array {
-    return [...parent::getArguments(), '--production=false'];
+    return ['--production=false'];
   }
 }

src/task/install/Production.php

@@ -23,6 +23,6 @@
 final class Production extends AbstractInstallTask {
 
   public function getArguments() : array {
-    return [...parent::getArguments(), '--production'];
+    return ['--production'];
   }
 }

src/task/run/AbstractRunTask.php

@@ -17,17 +17,28 @@
 
 namespace de\codenamephp\deployer\npm\task\run;
 
-use de\codenamephp\deployer\npm\task\AbstractNpmTask;
+use de\codenamephp\deployer\base\task\iTask;
+use de\codenamephp\deployer\command\runner\iRunner;
+use de\codenamephp\deployer\command\runner\WithDeployerFunctions;
+use de\codenamephp\deployer\npm\command\run\DecorateCommandFactory;
+use de\codenamephp\deployer\npm\command\run\iNpmRunCommandFactory;
 
-abstract class AbstractRunTask extends AbstractNpmTask {
+abstract class AbstractRunTask implements iTask {
+
+  public function __construct(public iNpmRunCommandFactory $commandFactory = new DecorateCommandFactory(), public iRunner $runner = new WithDeployerFunctions()) {}
 
   abstract public function getScriptName() : string;
 
-  public function getNpmCommand() : string {
-    return 'run';
-  }
+  /**
+   * Gets the arguments to pass to the command. Override this and add you commands and options as needed.
+   *
+   * The array has to be numerical so it can be expanded in the constructor
+   *
+   * @return array<int,string>
+   */
+  abstract public function getArguments() : array;
 
-  public function getArguments() : array {
-    return [$this->getScriptName(), ...parent::getArguments()];
+  public function __invoke() : void {
+    $this->runner->run($this->commandFactory->build($this->getScriptName(), $this->getArguments()));
   }
 }

src/task/run/Generic.php

@@ -17,10 +17,10 @@
 
 namespace de\codenamephp\deployer\npm\task\run;
 
-use de\codenamephp\deployer\base\functions\All;
-use de\codenamephp\deployer\base\functions\iGet;
 use de\codenamephp\deployer\command\runner\iRunner;
 use de\codenamephp\deployer\command\runner\WithDeployerFunctions;
+use de\codenamephp\deployer\npm\command\run\DecorateCommandFactory;
+use de\codenamephp\deployer\npm\command\run\iNpmRunCommandFactory;
 
 final class Generic extends AbstractRunTask {
 
@@ -33,21 +33,24 @@ final class Generic extends AbstractRunTask {
 
   /**
    * @param string $scriptName The name of the script to run, e.g. 'build'
-   * @param array<int,string> $arguments Additional arguments to pass to the script that will be appended to the defaults
-   * @param iRunner $runner The runner that runs the command
-   * @param iGet $deployer Deployer function to access the config. Will not be set in the instance
+   * @param array<int,string> $arguments Additional arguments to pass to the script
+   * @param iNpmRunCommandFactory $commandFactory The factory to build the command. Will be passed to parent.
+   * @param iRunner $runner The runner that runs the command. Will be passed to parent.
    */
-  public function __construct(string $scriptName, array $arguments = [], iRunner $runner = new WithDeployerFunctions(), iGet $deployer = new All()) {
+  public function __construct(string                $scriptName,
+                              array                 $arguments = [],
+                              iNpmRunCommandFactory $commandFactory = new DecorateCommandFactory(),
+                              iRunner               $runner = new WithDeployerFunctions()) {
+    parent::__construct($commandFactory, $runner);
     $this->scriptName = $scriptName;
     $this->arguments = $arguments;
-    parent::__construct($runner, $deployer);
   }
 
   public function getScriptName() : string {
     return $this->scriptName;
   }
 
   public function getArguments() : array {
-    return [...parent::getArguments(), ...$this->arguments];
+    return $this->arguments;
   }
 }

src/task/run/build/Development.php

@@ -27,4 +27,9 @@ final class Development extends AbstractRunTask {
   public function getScriptName() : string {
     return 'build:development';
   }
+
+  public function getArguments() : array {
+    return [];
+  }
+
 }