Merge pull request #1167 from evs-xsarus/feature/1157-triggered_by_filenames

Ticket #1157: support specific filenames as trigger for Shell.

Author: veewee

doc/tasks/shell.md

@@ -9,6 +9,8 @@ grumphp:
     tasks:
         shell:
             scripts: []
+            ignore_patterns: [],
+            whitelist_patterns: [],
             triggered_by: [php]
 ```
 
@@ -35,11 +37,30 @@ grumphp:
 
 *Note:* When using the `-c` option, the next argument should contain the full executable with all parameters. Be careful: quotes will be escaped!
 
+**ignore_patterns**
+
+*Default: []*
+
+This is a list of file patterns that will be ignored by the shell tasks.
+Leave this option blank to run the task for all files defined in the whitelist_patterns and or triggered_by extensions.
+
+**whitelist_patterns**
+
+*Default: []*
+
+This is a list of regex patterns that will filter files to validate. With this option you can skip files like tests.
+This option is used in relation with the parameter `triggered_by`.
+For example: whitelist files in `src/FolderA/` and `src/FolderB/` you can use
+```yaml
+whitelist_patterns:
+    - /^src\/FolderA\/(.*)/
+    - /^src\/FolderB\/(.*)/
+```
 
 **triggered_by**
 
 *Default: [php]*
 
 This option will specify which file extensions will trigger the shell tasks.
-By default, Shell will be triggered by altering a PHP file. 
+By default, Shell will be triggered by altering a PHP file.
 You can overwrite this option to whatever file you want to use!

src/Task/Shell.php

@@ -4,6 +4,7 @@
 
 namespace GrumPHP\Task;
 
+use GrumPHP\Collection\FilesCollection;
 use GrumPHP\Exception\RuntimeException;
 use GrumPHP\Formatter\ProcessFormatterInterface;
 use GrumPHP\Runner\TaskResult;
@@ -25,10 +26,14 @@ public static function getConfigurableOptions(): ConfigOptionsResolver
         $resolver = new OptionsResolver();
         $resolver->setDefaults([
             'scripts' => [],
+            'ignore_patterns' => [],
+            'whitelist_patterns' => [],
             'triggered_by' => ['php'],
         ]);
 
         $resolver->addAllowedTypes('scripts', ['array']);
+        $resolver->addAllowedTypes('ignore_patterns', ['array']);
+        $resolver->addAllowedTypes('whitelist_patterns', ['array']);
         $resolver->addAllowedTypes('triggered_by', ['array']);
         $resolver->setNormalizer('scripts', function (Options $options, array $scripts) {
             return array_map(
@@ -59,7 +64,11 @@ public function canRunInContext(ContextInterface $context): bool
     public function run(ContextInterface $context): TaskResultInterface
     {
         $config = $this->getConfig()->getOptions();
-        $files = $context->getFiles()->extensions($config['triggered_by']);
+
+        $files = $context->getFiles()
+            ->extensions($config['triggered_by'])
+            ->paths($config['whitelist_patterns'] ?? [])
+            ->notPaths($config['ignore_patterns'] ?? []);
         if (0 === \count($files)) {
             return TaskResult::createSkipped($this, $context);
         }

test/Unit/Task/ShellTest.php

@@ -26,6 +26,8 @@ public function provideConfigurableOptions(): iterable
             [],
             [
                 'scripts' => [],
+                'ignore_patterns' => [],
+                'whitelist_patterns' => [],
                 'triggered_by' => ['php'],
             ]
         ];
@@ -37,6 +39,8 @@ public function provideConfigurableOptions(): iterable
                 'scripts' => [
                     ['phpunit']
                 ],
+                'ignore_patterns' => [],
+                'whitelist_patterns' => [],
                 'triggered_by' => ['php'],
             ]
         ];
@@ -50,6 +54,8 @@ public function provideConfigurableOptions(): iterable
                 'scripts' => [
                     ['phpunit', 'tests']
                 ],
+                'ignore_patterns' => [],
+                'whitelist_patterns' => [],
                 'triggered_by' => ['php'],
             ]
         ];
@@ -129,6 +135,22 @@ public function provideSkipsOnStuff(): iterable
             $this->mockContext(RunContext::class),
             function () {}
         ];
+        yield 'no-files-after-ignore-patterns' => [
+            [
+                'ignore_patterns' => ['test/'],
+            ],
+            $this->mockContext(RunContext::class, ['test/file.php']),
+            function() {
+            }
+        ];
+        yield 'no-files-after-whitelist-patterns' => [
+            [
+                'whitelist_patterns' => ['src/'],
+            ],
+            $this->mockContext(RunContext::class, ['config/file.php']),
+            function() {
+            }
+        ];
         yield 'no-files-after-triggered-by' => [
             [],
             $this->mockContext(RunContext::class, ['notatwigfile.txt']),