Adds the --preset option to the validate command

Author: raphaelstolt

phpstan.neon.dist

@@ -19,3 +19,4 @@ parameters:
         - '#TMock#'
         - '#unknown class#'
         - '#set_error_handler expects#'
+        - '#getPresetByLanguageName#'

src/Analyser.php

@@ -2,10 +2,10 @@
 
 namespace Stolt\LeanPackage;
 
-use PHPStan\Type\Php\DateIntervalDynamicReturnTypeExtension;
 use Stolt\LeanPackage\Exceptions\InvalidGlobPattern;
 use Stolt\LeanPackage\Exceptions\InvalidGlobPatternFile;
 use Stolt\LeanPackage\Exceptions\NonExistentGlobPatternFile;
+use Stolt\LeanPackage\Exceptions\PresetNotAvailable;
 use Stolt\LeanPackage\Presets\Finder;
 
 class Analyser
@@ -47,7 +47,7 @@ class Analyser
     private string $globPattern;
 
     /**
-     * The preferred end of line sequence
+     * The preferred end-of-line sequence
      *
      * @var string
      */
@@ -128,7 +128,7 @@ class Analyser
     private string $keepGlobPattern = '';
 
     /**
-     * Whether to align the export-ignores on create or overwrite
+     * Whether to align the export-ignores on creation or overwrite
      * or not.
      *
      * @var boolean
@@ -961,8 +961,9 @@ public function hasCompleteExportIgnores(): bool
 
         $actualExportIgnores = $this->getPresentExportIgnores();
 
+        $staleExportIgnores = [];
+
         if ($this->isStaleExportIgnoresComparisonEnabled()) {
-            $staleExportIgnores = [];
             $unfilteredExportIgnores = $this->getPresentExportIgnores(false);
             foreach ($unfilteredExportIgnores as $unfilteredExportIgnore) {
                 if (false === \file_exists($unfilteredExportIgnore)) {
@@ -983,4 +984,12 @@ public function hasCompleteExportIgnores(): bool
 
         return \array_values($expectedExportIgnores) === \array_values($actualExportIgnores);
     }
+
+    /**
+     * @throws PresetNotAvailable
+     */
+    public function setGlobPatternFromPreset(string $preset): void
+    {
+        $this->globPattern = '{' . \implode(',', $this->finder->getPresetGlobByLanguageName($preset)) . '}*';
+    }
 }

src/Commands/ValidateCommand.php

@@ -17,6 +17,7 @@
 use Stolt\LeanPackage\Exceptions\InvalidGlobPatternFile;
 use Stolt\LeanPackage\Exceptions\NoLicenseFilePresent;
 use Stolt\LeanPackage\Exceptions\NonExistentGlobPatternFile;
+use Stolt\LeanPackage\Exceptions\PresetNotAvailable;
 use Stolt\LeanPackage\Helpers\InputReader;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputArgument;
@@ -33,6 +34,8 @@ final class ValidateCommand extends Command
      */
     protected string $defaultLpvFile = WORKING_DIRECTORY . DIRECTORY_SEPARATOR . '.lpv';
 
+    protected string $defaultPreset = 'Php';
+
     /**
      * Package analyser.
      *
@@ -108,6 +111,7 @@ protected function configure(): void
             . 'export-ignored';
         $globPatternFileDescription = 'Use this file with glob patterns '
             . 'to match artifacts which should be export-ignored';
+        $presetDescription = 'Use the glob pattern of the given language preset';
 
         $keepLicenseDescription = 'Do not export-ignore the license file';
         $keepReadmeDescription = 'Do not export-ignore the README file';
@@ -152,6 +156,13 @@ protected function configure(): void
             $globPatternFileDescription,
             $this->defaultLpvFile
         );
+        $this->addOption(
+            'preset',
+            null,
+            InputOption::VALUE_OPTIONAL,
+            $presetDescription,
+            $this->defaultPreset
+        );
         $this->addOption(
             'keep-license',
             null,
@@ -216,6 +227,7 @@ protected function configure(): void
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
         $directory = (string) $input->getArgument('directory');
+        $chosenPreset = (string) $input->getOption('preset');
 
         if ($directory !== WORKING_DIRECTORY) {
             try {
@@ -380,6 +392,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 
                     $this->analyser->setGlobPatternFromFile($globPatternFile);
                 }
+
             } catch (NonExistentGlobPatternFile $e) {
                 $warning = "Warning: The provided glob pattern file "
                     . "'$globPatternFile' doesn't exist.";
@@ -397,6 +410,20 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 
                 $output->writeln($e->getMessage(), OutputInterface::VERBOSITY_DEBUG);
 
+                return Command::FAILURE;
+            }
+        } elseif ($chosenPreset) {
+            try {
+
+                $verboseOutput = '+ Using the ' . $chosenPreset . ' language preset.';
+                $output->writeln($verboseOutput, OutputInterface::VERBOSITY_VERBOSE);
+
+                $this->analyser->setGlobPatternFromPreset($chosenPreset);
+            } catch (PresetNotAvailable $e) {
+                $warning = 'Warning: The chosen language preset ' . $chosenPreset . ' is not available. Maybe contribute it?.';
+                $outputContent = '<error>' . $warning . '</error>';
+                $output->writeln($outputContent);
+
                 return Command::FAILURE;
             }
         }
@@ -456,7 +483,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
                 . 'content.</info>';
             $output->writeln($outputContent);
 
-            return 1;
+            return Command::FAILURE;
         } elseif ($validateArchive) {
             try {
                 $verboseOutput = '+ Validating Git archive.';

src/Presets/Finder.php

@@ -47,6 +47,18 @@ public function getAvailablePresets(): array
      * @return array
      */
     public function getPresetGlobByLanguageName(string $name): array
+    {
+        $preset = $this->getPresetByLanguageName($name);
+
+        return $preset->getPresetGlob();
+    }
+
+    /**
+     * @param string $name
+     * @throws PresetNotAvailable
+     * @return Preset
+     */
+    public function getPresetByLanguageName(string $name): Preset
     {
         $name = \ucfirst(\strtolower($name));
 
@@ -57,10 +69,7 @@ public function getPresetGlobByLanguageName(string $name): array
 
         $presetClassName = \sprintf('Stolt\LeanPackage\Presets\%sPreset', $name);
 
-        /** @var Preset $preset **/
-        $preset = new $presetClassName();
-
-        return $preset->getPresetGlob();
+        return new $presetClassName();
     }
 
     /**

tests/Commands/ValidateCommandTest.php

@@ -17,6 +17,7 @@
 use Stolt\LeanPackage\Archive;
 use Stolt\LeanPackage\Archive\Validator;
 use Stolt\LeanPackage\Commands\ValidateCommand;
+use Stolt\LeanPackage\Exceptions\InvalidGlobPattern;
 use Stolt\LeanPackage\Exceptions\NoLicenseFilePresent;
 use Stolt\LeanPackage\Helpers\Str as OsHelper;
 use Stolt\LeanPackage\Presets\Finder;
@@ -195,9 +196,10 @@ public function showsDifferenceBetweenActualAndExpectedGitattributesContent(): v
     #[Test]
     public function filesInGlobalGitignoreAreExportIgnored(): void
     {
-        $analyserMock = Mockery::mock(Analyser::class)->makePartial();
-
         $globPattern = '{' . \implode(',', (new PhpPreset())->getPresetGlob()) . '}*';
+
+        $analyserMock = Mockery::mock(Analyser::class, [new Finder(new PhpPreset())])->makePartial();
+
         $analyserMock->setGlobPattern($globPattern);
 
         $application = $this->getApplicationWithMockedAnalyser($analyserMock);
@@ -265,7 +267,7 @@ public function filesInGlobalGitignoreAreExportIgnored(): void
     #[Ticket('https://github.com/raphaelstolt/lean-package-validator/issues/16')]
     public function gitattributesFileWithNoExportIgnoresContentShowsExpectedContent(): void
     {
-        $analyserMock = Mockery::mock(Analyser::class)->makePartial();
+        $analyserMock = Mockery::mock(Analyser::class, [new Finder(new PhpPreset())])->makePartial();
 
         $globPattern = '{' . \implode(',', (new PhpPreset())->getPresetGlob()) . '}*';
         $analyserMock->setGlobPattern($globPattern);
@@ -1302,10 +1304,13 @@ public function nonLeanArchiveIsNotConsideredLeanSingular(): void
         $this->assertTrue($commandTester->getStatusCode() > Command::SUCCESS);
     }
 
+    /**
+     * @throws InvalidGlobPattern
+     */
     #[Test]
     public function impossibilityToResolveExpectedGitattributesFileContentIsInfoed(): void
     {
-        $mock = Mockery::mock(Analyser::class)->makePartial();
+        $mock = Mockery::mock(Analyser::class, [new Finder(new PhpPreset())])->makePartial();
 
         $globPattern = '{' . \implode(',', (new PhpPreset())->getPresetGlob()) . '}*';
         $mock->setGlobPattern($globPattern);