Merge pull request #25 from marcelthole/resolve-24

Add Option to match files instead of providing each file as additiona…

Author: marcelthole

.github/workflows/build.yml

@@ -62,11 +62,11 @@ jobs:
         run: "composer show"
 
       - name: "Run code style check"
-        run: "composer run-script cs-check"
+        run:  "composer run-script cs-check"
         if: ${{ matrix.composer-deps == 'latest' && matrix.php-version == '7.4' }}
 
       - name: "Run CI"
-        run: "composer run-script ci"
+        run: "composer run-script phpunit"
 
   tests-with-coverage:
     name: "Tests with coverage and PR Comments"
@@ -124,6 +124,9 @@ jobs:
           git fetch --depth=1 origin $GITHUB_BASE_REF
           composer run-script infection -- --git-diff-filter=AM --git-diff-base=origin/$GITHUB_BASE_REF --logger-github --ignore-msi-with-no-mutations --only-covered
 
+      - name: Run PHPStan
+        run: composer run-script phpstan -- --error-format=github
+
   test-runs-on-docker:
     name: "Test if tests pass in the Docker container"
     runs-on: ubuntu-latest

README.md

@@ -27,6 +27,14 @@ Usage:
 
 ```
 
+### Arguments
+| Argument | Meaning |
+| --- | ---  |
+| --match[=MATCH] | Use a RegEx pattern to determine the additionalFiles. If this option is set the additionalFiles could be omitted (multiple values allowed) |
+| --resolve-references[=RESOLVE-REFERENCES] | Resolve the "$refs" in the given files [default: true] |
+| -o, --outputfile[=OUTPUTFILE] | Defines the output file for the result. Defaults the result will printed to stdout |
+
+
 ## Docker
 Run the `openapi-merge` command within a docker container
 ```

bin/openapi-merge

@@ -2,6 +2,7 @@
 <?php
 
 use Mthole\OpenApiMerge\Console\Command\MergeCommand;
+use Mthole\OpenApiMerge\FileHandling\RegexFinder;
 use Mthole\OpenApiMerge\Merge\PathMerger;
 use Mthole\OpenApiMerge\OpenApiMerge;
 use Mthole\OpenApiMerge\Merge\ReferenceNormalizer;
@@ -30,7 +31,8 @@ $application->add(new MergeCommand(
         new PathMerger(),
         new ReferenceNormalizer()
     ),
-    new DefinitionWriter()
+    new DefinitionWriter(),
+    new RegexFinder()
 ));
 $application->setDefaultCommand(MergeCommand::COMMAND_NAME, true);
 $application->run();

src/Console/Command/MergeCommand.php

@@ -6,6 +6,7 @@
 
 use Exception;
 use Mthole\OpenApiMerge\FileHandling\File;
+use Mthole\OpenApiMerge\FileHandling\Finder;
 use Mthole\OpenApiMerge\FileHandling\SpecificationFile;
 use Mthole\OpenApiMerge\OpenApiMergeInterface;
 use Mthole\OpenApiMerge\Writer\DefinitionWriterInterface;
@@ -16,8 +17,8 @@
 use Symfony\Component\Console\Output\OutputInterface;
 
 use function array_map;
+use function count;
 use function file_put_contents;
-use function is_array;
 use function is_string;
 use function sprintf;
 use function touch;
@@ -28,14 +29,17 @@ final class MergeCommand extends Command
 
     private OpenApiMergeInterface $merger;
     private DefinitionWriterInterface $definitionWriter;
+    private Finder $fileFinder;
 
     public function __construct(
         OpenApiMergeInterface $openApiMerge,
-        DefinitionWriterInterface $definitionWriter
+        DefinitionWriterInterface $definitionWriter,
+        Finder $fileFinder
     ) {
         parent::__construct(self::COMMAND_NAME);
         $this->merger           = $openApiMerge;
         $this->definitionWriter = $definitionWriter;
+        $this->fileFinder       = $fileFinder;
     }
 
     protected function configure(): void
@@ -53,7 +57,14 @@ protected function configure(): void
                 HELP
             )
             ->addArgument('basefile', InputArgument::REQUIRED)
-            ->addArgument('additionalFiles', InputArgument::IS_ARRAY)
+            ->addArgument('additionalFiles', InputArgument::IS_ARRAY | InputArgument::OPTIONAL)
+            ->addOption(
+                'match',
+                null,
+                InputOption::VALUE_OPTIONAL | InputOption::VALUE_IS_ARRAY,
+                'Use a RegEx pattern to determine the additionalFiles. '
+                . 'If this option is set the additionalFiles could be omitted'
+            )
             ->addOption(
                 'resolve-references',
                 null,
@@ -74,7 +85,13 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         $baseFile        = $input->getArgument('basefile');
         $additionalFiles = $input->getArgument('additionalFiles');
 
-        if (! is_string($baseFile) || ! is_array($additionalFiles)) {
+        if (count($additionalFiles) === 0) {
+            foreach ($input->getOption('match') as $regex) {
+                $additionalFiles = [...$additionalFiles, ...$this->fileFinder->find('.', $regex)];
+            }
+        }
+
+        if (! is_string($baseFile) || count($additionalFiles) === 0) {
             throw new Exception('Invalid arguments given');
         }
 

src/FileHandling/Finder.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Mthole\OpenApiMerge\FileHandling;
+
+interface Finder
+{
+    /**
+     * @return list<string>
+     */
+    public function find(string $baseDirectory, string $searchString): array;
+}

src/FileHandling/RegexFinder.php

@@ -0,0 +1,59 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Mthole\OpenApiMerge\FileHandling;
+
+use RecursiveCallbackFilterIterator;
+use RecursiveDirectoryIterator;
+use RecursiveIterator;
+use RecursiveIteratorIterator;
+
+use function array_values;
+use function iterator_to_array;
+use function preg_match;
+use function sprintf;
+use function str_replace;
+use function strlen;
+use function substr;
+
+class RegexFinder implements Finder
+{
+    /**
+     * @return list<string>
+     */
+    public function find(string $baseDirectory, string $searchString): array
+    {
+        $directoryIterator = new RecursiveDirectoryIterator(
+            $baseDirectory,
+            RecursiveDirectoryIterator::CURRENT_AS_PATHNAME | RecursiveDirectoryIterator::SKIP_DOTS
+        );
+
+        $regexIterator = new RecursiveCallbackFilterIterator(
+            $directoryIterator,
+            static function (
+                string $current,
+                string $key,
+                RecursiveIterator $iterator
+            ) use (
+                $baseDirectory,
+                $searchString
+            ) {
+                if ($iterator->hasChildren()) {
+                    return true;
+                }
+
+                $relativeFileName = '.' . substr($current, strlen($baseDirectory));
+
+                return preg_match(
+                    sprintf('~%s~i', str_replace('~', '\~', $searchString)),
+                    $relativeFileName
+                ) === 1;
+            }
+        );
+
+        $recursiveIterator = new RecursiveIteratorIterator($regexIterator);
+
+        return array_values(iterator_to_array($recursiveIterator));
+    }
+}

src/Merge/ReferenceNormalizer.php

@@ -55,7 +55,7 @@ public function normalizeInlineReferences(
                                     $example,
                                     $refFileCollection
                                 );
-                            } elseif ($example !== null) {
+                            } else {
                                 $newExamples[$key] = $example;
                             }
                         }
@@ -77,7 +77,7 @@ public function normalizeInlineReferences(
     }
 
     /**
-     * @param array<int, string> $refFileCollection
+     * @param list<string> $refFileCollection
      */
     private function normalizeReference(Reference $reference, array &$refFileCollection): Reference
     {
@@ -95,9 +95,9 @@ private function normalizeReference(Reference $reference, array &$refFileCollect
     }
 
     /**
-     * @param array<int, string> $refFileCollection
+     * @param list<string> $refFileCollection
      *
-     * @return array<int, File>
+     * @return list<File>
      */
     private function normalizeFilePaths(File $openApiFile, array $refFileCollection): array
     {

src/Merge/ReferenceResolverResult.php

@@ -10,11 +10,11 @@
 final class ReferenceResolverResult
 {
     private OpenApi $openApiSpecification;
-    /** @var array<int, File> */
+    /** @var list<File> */
     private array $foundReferenceFiles;
 
     /**
-     * @param array<int, File> $foundReferenceFiles
+     * @param list<File> $foundReferenceFiles
      */
     public function __construct(
         OpenApi $openApiSpecification,
@@ -29,7 +29,7 @@ public function getNormalizedDefinition(): OpenApi
         return $this->openApiSpecification;
     }
 
-    /** @return array<int, File> */
+    /** @return list<File> */
     public function getFoundReferenceFiles(): array
     {
         return $this->foundReferenceFiles;

src/OpenApiMerge.php

@@ -32,7 +32,7 @@ public function __construct(
         $this->referenceNormalizer = $referenceResolver;
     }
 
-    /** @param array<int, File> $additionalFiles */
+    /** @param list<File> $additionalFiles */
     public function mergeFiles(File $baseFile, array $additionalFiles, bool $resolveReference = true): SpecificationFile
     {
         $mergedOpenApiDefinition = $this->openApiReader->readFile($baseFile, $resolveReference)->getOpenApi();

src/OpenApiMergeInterface.php

@@ -9,7 +9,7 @@
 
 interface OpenApiMergeInterface
 {
-    /** @param array<int, File> $additionalFiles */
+    /** @param list<File> $additionalFiles */
     public function mergeFiles(
         File $baseFile,
         array $additionalFiles,