feat(config): make min-requirements configurable through file

Author: yhortuk

src/Application/ConfigResolver.php

@@ -103,6 +103,31 @@ public static function guess(Composer $composer): string
         return self::DEFAULT_PRESET;
     }
 
+    /**
+     * Merge requirements config from console input.
+     *
+     * @param array<string, string|array>                     $config
+     * @param \Symfony\Component\Console\Input\InputInterface $input
+     *
+     * @return array<string, string|array>
+     */
+    public static function mergeInputRequirements(array $config, InputInterface $input): array
+    {
+        $requirements = [
+            'min-quality',
+            'min-complexity',
+            'min-architecture',
+            'min-style',
+            'disable-security-check',
+        ];
+        foreach ($requirements as $requirement) {
+            if ($input->hasParameterOption('--'.$requirement)) {
+                $config['requirements'][$requirement] = $input->getOption($requirement);
+            }
+        }
+        return $config;
+    }
+
     /**
      * @see https://www.php.net/manual/en/function.array-merge-recursive.php#96201
      *

src/Application/Console/Commands/AnalyseCommand.php

@@ -8,6 +8,7 @@
 use NunoMaduro\PhpInsights\Application\Console\Formatters\FormatResolver;
 use NunoMaduro\PhpInsights\Application\Console\OutputDecorator;
 use NunoMaduro\PhpInsights\Application\Console\Style;
+use NunoMaduro\PhpInsights\Domain\Configuration;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\ConsoleOutputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
@@ -24,14 +25,21 @@ final class AnalyseCommand
      */
     private $analyser;
 
+    /**
+     * @var \NunoMaduro\PhpInsights\Domain\Configuration
+     */
+    private $configuration;
+
     /**
      * Creates a new instance of the Analyse Command.
      *
      * @param \NunoMaduro\PhpInsights\Application\Console\Analyser $analyser
+     * @param \NunoMaduro\PhpInsights\Domain\Configuration         $configuration
      */
-    public function __construct(Analyser $analyser)
+    public function __construct(Analyser $analyser, Configuration $configuration)
     {
         $this->analyser = $analyser;
+        $this->configuration = $configuration;
     }
 
     /**
@@ -64,27 +72,27 @@ public function __invoke(InputInterface $input, OutputInterface $output): int
         );
 
         $hasError = false;
-        if ($input->getOption('min-quality') > $results->getCodeQuality()) {
+        if ($this->configuration->getMinQuality() > $results->getCodeQuality()) {
             $consoleStyle->error('The code quality score is too low');
             $hasError = true;
         }
 
-        if ($input->getOption('min-complexity') > $results->getComplexity()) {
+        if ($this->configuration->getMinComplexity() > $results->getComplexity()) {
             $consoleStyle->error('The complexity score is too low');
             $hasError = true;
         }
 
-        if ($input->getOption('min-architecture') > $results->getStructure()) {
+        if ($this->configuration->getMinArchitecture() > $results->getStructure()) {
             $consoleStyle->error('The architecture score is too low');
             $hasError = true;
         }
 
-        if ($input->getOption('min-style') > $results->getStyle()) {
+        if ($this->configuration->getMinStyle() > $results->getStyle()) {
             $consoleStyle->error('The style score is too low');
             $hasError = true;
         }
 
-        if (! (bool) $input->getOption('disable-security-check') && $results->getTotalSecurityIssues() > 0) {
+        if (! $this->configuration->getDisableSecurityCheck() && $results->getTotalSecurityIssues() > 0) {
             $hasError = true;
         }
 

src/Application/Injectors/Configuration.php

@@ -41,6 +41,7 @@ public function __invoke(): array
                     $config = require $configPath;
                 }
 
+                $config = ConfigResolver::mergeInputRequirements($config, $input);
                 return ConfigResolver::resolve($config, DirectoryResolver::resolve($input));
             },
         ];

src/Domain/Configuration.php

@@ -67,6 +67,13 @@ final class Configuration
      */
     private $remove;
 
+    /**
+     * List of requirements.
+     *
+     * @var array<string>
+     */
+    private $requirements;
+
     /**
      * List of custom configuration by insight.
      *
@@ -160,6 +167,46 @@ public function getPreset(): string
         return $this->preset;
     }
 
+    /**
+     * @return float
+     */
+    public function getMinQuality(): float
+    {
+        return (float) ($this->requirements['min-quality'] ?? 0);
+    }
+
+    /**
+     * @return float
+     */
+    public function getMinComplexity(): float
+    {
+        return (float) ($this->requirements['min-complexity'] ?? 0);
+    }
+
+    /**
+     * @return float
+     */
+    public function getMinArchitecture(): float
+    {
+        return (float) ($this->requirements['min-architecture'] ?? 0);
+    }
+
+    /**
+     * @return float
+     */
+    public function getMinStyle(): float
+    {
+        return (float) ($this->requirements['min-style'] ?? 0);
+    }
+
+    /**
+     * @return bool
+     */
+    public function getDisableSecurityCheck(): bool
+    {
+        return (bool) $this->requirements['disable-security-check'] ?? false;
+    }
+
     /**
      * @return FileLinkFormatterContract
      */
@@ -179,6 +226,7 @@ private function resolveConfig(array $config): void
             'directory' => (string) getcwd(),
             'exclude' => [],
             'add' => [],
+            'requirements' => [],
             'remove' => [],
             'config' => [],
         ]);
@@ -201,6 +249,7 @@ private function resolveConfig(array $config): void
         $this->add = $config['add'];
         $this->remove = $config['remove'];
         $this->config = $config['config'];
+        $this->requirements = $config['requirements'];
 
         if (
             array_key_exists('ide', $config)

stubs/config.php

@@ -70,4 +70,12 @@
         //  ],
     ],
 
+    'requirements' => [
+//        'min-quality' => 0,
+//        'min-complexity' => 0,
+//        'min-architecture' => 0,
+//        'min-style' => 0,
+//        'disable-security-check' => false,
+    ],
+
 ];

stubs/drupal.php

@@ -70,4 +70,12 @@
         //  ],
     ],
 
+    'requirements' => [
+//        'min-quality' => 0,
+//        'min-complexity' => 0,
+//        'min-architecture' => 0,
+//        'min-style' => 0,
+//        'disable-security-check' => false,
+    ],
+
 ];

stubs/laravel.php

@@ -91,4 +91,12 @@
         ],
     ],
 
+    'requirements' => [
+//        'min-quality' => 0,
+//        'min-complexity' => 0,
+//        'min-architecture' => 0,
+//        'min-style' => 0,
+//        'disable-security-check' => false,
+    ],
+
 ];

stubs/magento2.php

@@ -68,4 +68,12 @@
         //  ],
     ],
 
+    'requirements' => [
+//        'min-quality' => 0,
+//        'min-complexity' => 0,
+//        'min-architecture' => 0,
+//        'min-style' => 0,
+//        'disable-security-check' => false,
+    ],
+
 ];

stubs/symfony.php

@@ -68,4 +68,12 @@
         //  ],
     ],
 
+    'requirements' => [
+//        'min-quality' => 0,
+//        'min-complexity' => 0,
+//        'min-architecture' => 0,
+//        'min-style' => 0,
+//        'disable-security-check' => false,
+    ],
+
 ];

tests/Application/ConfigResolverTest.php

@@ -12,6 +12,9 @@
 use NunoMaduro\PhpInsights\Domain\LinkFormatter\NullFileLinkFormatter;
 use PHPUnit\Framework\TestCase;
 use SlevomatCodingStandard\Sniffs\Commenting\DocCommentSpacingSniff;
+use Symfony\Component\Console\Input\ArrayInput;
+use Symfony\Component\Console\Input\InputDefinition;
+use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\OptionsResolver\Exception\InvalidOptionsException;
 
 final class ConfigResolverTest extends TestCase
@@ -176,6 +179,28 @@ public function testResolveWithIdePattern(): void
         self::assertNotInstanceOf(NullFileLinkFormatter::class, $config->getFileLinkFormatter());
     }
 
+    public function testMergeInputRequirements(): void
+    {
+        $input = new ArrayInput([
+                '--not-whitelisted' => 1,
+                '--min-complexity' => 1,
+            ],
+            new InputDefinition([
+                new InputOption('min-complexity'),
+                new InputOption('disable-security-check'),
+                new InputOption('not-whitelisted'),
+            ])
+        );
+
+        $config = ConfigResolver::mergeInputRequirements([], $input);
+
+        self::assertEquals([
+            'requirements' => [
+                'min-complexity' => 1,
+            ]
+        ], $config);
+    }
+
     /**
      * @return array<string, array<string>>
      */