Rename validation prefix ton validate, initialize to configure, add source code urls configuration and validation

Author: steevanb

docker/phpcs.bootstrap.php

@@ -8,10 +8,14 @@
 Steevanb_Sniffs_Uses_GroupUsesSniff::addSymfonyPrefixs();
 
 Steevanb_Sniffs_Functions_DisallowMultipleReturnSniff::addAllowedFunction(
-    '/var/phpcs/Command/InitializeBranchCommand.php',
-    'createComponentConfiguration'
+    '/var/phpcs/Command/Configure/ConfigureComponentCommand.php',
+    'createConfiguration'
 );
 Steevanb_Sniffs_Functions_DisallowMultipleReturnSniff::addAllowedFunction(
-    '/var/phpcs/Command/InitializeBranchCommand.php',
-    'defineAbstractComponentConfigurationCodeDependencyName'
+    '/var/phpcs/Command/Configure/ConfigureComponentCommand.php',
+    'defineCodeDependencyName'
+);
+Steevanb_Sniffs_Functions_DisallowMultipleReturnSniff::addAllowedFunction(
+    '/var/phpcs/Command/Configure/ConfigureComponentCommand.php',
+    'defineSourceCodeUrls'
 );

src/Command/AbstractCommand.php

@@ -29,36 +29,42 @@ abstract protected function doExecute(): self;
     /** @var OutputInterface */
     private $output;
 
-    /** @var ?string */
-    private $validationPrefix;
-
     private $validateProd = true;
 
-    private $repositoriesCreated = true;
+    private $skipBranchName = true;
+
+    private $skipSourceCodeUrls = false;
 
-    public function isValidateProd()
+    public function validateProd(): bool
     {
         return $this->validateProd;
     }
 
-    public function isRepositoriesCreated()
+    public function skipBranchName(): bool
+    {
+        return $this->skipBranchName;
+    }
+
+    public function skipSourceCodeUrls(): bool
     {
-        return $this->repositoriesCreated;
+        return $this->skipSourceCodeUrls;
     }
 
     protected function configure()
     {
         $this
             ->addOption('validate-prod', 'p', null, 'Validate data for prod instead of dev')
-            ->addOption('skip-branch-name', 'sbn', null, 'Do not validate branch name');
+            ->addOption('skip-branch-name', null, null, 'Do not validate branch name')
+            ->addOption('skip-source-code-urls', null, null, 'Do not validate source code urls');
     }
 
     protected function execute(InputInterface $input, OutputInterface $output)
     {
         $this->input = $input;
         $this->output = $output;
         $this->validateProd = $input->getOption('validate-prod');
-        $this->repositoriesCreated = $input->getOption('skip-branch-name') === false;
+        $this->skipBranchName = $input->getOption('skip-branch-name');
+        $this->skipSourceCodeUrls = $input->getOption('skip-source-code-urls');
 
         $return = 0;
         try {
@@ -90,13 +96,6 @@ protected function getOutput(): OutputInterface
         return $this->output;
     }
 
-    protected function setValidationPrefix(?string $prefix): self
-    {
-        $this->validationPrefix = $prefix;
-
-        return $this;
-    }
-
     /** @return $this */
     protected function title(string $title): self
     {
@@ -108,22 +107,23 @@ protected function title(string $title): self
     /** @return $this */
     protected function success(string $message): self
     {
-        $this->output->writeln("  \e[42m > \e[00m " . $this->validationPrefix . $message);
+        $this->output->writeln("  \e[42m > \e[00m " . $message);
 
         return $this;
     }
 
     /** @return $this */
-    protected function warning(string $message): self
+    protected function warning(string $message, bool $indent = true): self
     {
-        $this->output->writeln("  \e[43m > \e[00m \e[43m " . $this->validationPrefix . $message . " \e[00m");
+        $prefix = $indent ? "  \e[43m > \e[00m " : null;
+        $this->output->writeln($prefix . "\e[43m " . $message . " \e[00m");
 
         return $this;
     }
 
     protected function error(string $error = null): void
     {
-        throw new ValidationException($this->validationPrefix . $error);
+        throw new ValidationException($error);
     }
 
     /** @return $this */
@@ -195,12 +195,15 @@ protected function definePhpCliVersion(string $version): self
     /** @return $this */
     protected function runCommand(string $name, array $arguments = []): self
     {
-        if ($this->isValidateProd()) {
+        if ($this->validateProd()) {
             $arguments['--validate-prod'] = true;
         }
-        if ($this->isRepositoriesCreated() === false) {
+        if ($this->skipBranchName()) {
             $arguments['--skip-branch-name'] = true;
         }
+        if ($this->skipSourceCodeUrls()) {
+            $arguments['--skip-source-code-urls'] = true;
+        }
 
         $returnCode = $this
             ->getApplication()
@@ -267,21 +270,10 @@ protected function choiceQuestion(string $question, array $choices): string
     protected function assertFileExist(string $filePath, string $shortFilePath): self
     {
         if (is_readable($filePath) === false) {
-            $this->error('File ' . $shortFilePath . ' does not exist. Use "phpbench initialize:branch" to create it.');
+            $this->error('File ' . $shortFilePath . ' does not exist. Use "phpbench configure:all" to create it.');
         }
         $this->success('File ' . $shortFilePath . ' exist.');
 
         return $this;
     }
-
-    protected function skipBranchNameWarning(): self
-    {
-        $this->warning(
-            'Branch name is not validated.'
-            . ' Don\'t forget to remove "--skip-branch-name"'
-            . ' parameter to validate it.'
-        );
-
-        return $this;
-    }
 }

src/Command/ComposerUpdateCommand.php

@@ -14,7 +14,7 @@ protected function configure()
 
         $this
             ->setName('composer:update')
-            ->setDescription('Execute composer update for all enabled PHP versions, and create composer.lock.phpX.Y');
+            ->setDescription('Execute composer update for all enabled PHP versions and create composer.lock.phpX.Y');
     }
 
     protected function doExecute(): parent

src/Command/AbstractInitializeConfigurationCommand.php renamed to src/Command/Configure/AbstractConfigureCommand.php

@@ -2,9 +2,11 @@
 
 declare(strict_types=1);
 
-namespace App\Command;
+namespace App\Command\Configure;
 
-abstract class AbstractInitializeConfigurationCommand extends AbstractCommand
+use App\Command\AbstractCommand;
+
+abstract class AbstractConfigureCommand extends AbstractCommand
 {
     protected function copyDefaultConfigurationFile(
         string $file,

src/Command/Configure/AbstractConfigureComponentCommand.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Command\Configure;
+
+abstract class AbstractConfigureComponentCommand extends AbstractConfigureCommand
+{
+    protected function defineVariable(string $name, callable $getValue): self
+    {
+        $filePath = $this->getConfigurationPath() . '/AbstractComponentConfiguration.php';
+        $content = file_get_contents($filePath);
+
+        if (strpos($content, $name) !== false) {
+            $value = call_user_func($getValue);
+            file_put_contents($filePath, str_replace($name, $value, $content));
+            $this->success($name . ' defined to ' . $value . '.');
+        }
+
+        return $this;
+    }
+}

src/Command/Configure/ConfigureAllCommand.php

@@ -0,0 +1,40 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Command\Configure;
+
+use App\Command\AbstractCommand;
+
+class ConfigureAllCommand extends AbstractCommand
+{
+    protected function configure()
+    {
+        parent::configure();
+
+        $this
+            ->setName('configure:all')
+            ->setDescription('Call all configure commands');
+    }
+
+    protected function doExecute(): parent
+    {
+        return $this
+            ->runCommand('configure:directory')
+            ->runCommand('configure:component')
+            ->warningSourceCodeUrls()
+            ->runCommand('configure:component:sourceCodeUrls', ['--skip-component-creation' => true])
+            ->runCommand('configure:initBenchmark')
+            ->runCommand('configure:vhost')
+            ->runCommand('configure:responseBody');
+    }
+
+    protected function warningSourceCodeUrls(): self
+    {
+        if ($this->skipSourceCodeUrls() === false) {
+            $this->warning('You can skip source code urls configuration with --skip-source-code-urls parameter.', false);
+        }
+
+        return $this;
+    }
+}

src/Command/InitializeConfigurationComponentCommand.php renamed to src/Command/Configure/ConfigureComponentCommand.php

@@ -2,22 +2,23 @@
 
 declare(strict_types=1);
 
-namespace App\Command;
+namespace App\Command\Configure;
 
+use AbstractComponentConfiguration\AbstractComponentConfiguration;
 use App\{
     Benchmark\BenchmarkType,
     Component\ComponentType,
     PhpVersion\PhpVersion
 };
 
-class InitializeConfigurationComponentCommand extends AbstractInitializeConfigurationCommand
+class ConfigureComponentCommand extends AbstractConfigureComponentCommand
 {
     protected function configure()
     {
         parent::configure();
 
         $this
-            ->setName('initialize:configuration:component')
+            ->setName('configure:component')
             ->setDescription('Create .phpbenchmarks/AbstractComponentConfiguration.php and configure it');
     }
 
@@ -44,7 +45,9 @@ protected function createConfiguration(): self
 
         $this->defineVariable(
             '____NAMESPACE____',
-            function () { return 'AbstractComponentConfiguration'; }
+            function () {
+                return 'AbstractComponentConfiguration';
+            }
         );
 
         $this->defineVariable(
@@ -182,16 +185,4 @@ protected function createFile(): self
 
         return $this;
     }
-
-    protected function defineVariable(string $name, callable $getValue): self
-    {
-        $filePath = $this->getConfigurationPath() . '/AbstractComponentConfiguration.php';
-        $content = file_get_contents($filePath);
-
-        if (strpos($content, $name) !== false) {
-            file_put_contents($filePath, str_replace($name, call_user_func($getValue), $content));
-        }
-
-        return $this;
-    }
 }