Merge pull request #13 from pluswerk/feature/grumphp-0.19

✨ make bom fixer task compatible with grumphp 0.19

Author: Kanti

.travis.yml

@@ -8,6 +8,7 @@ git:
 php:
   - 7.2
   - 7.3
+  - 7.4
   - nightly
 
 env:

composer.json

@@ -26,7 +26,7 @@
     },
     "require": {
         "php": ">=7.2",
-        "phpro/grumphp": "0.16.* || 0.17.*"
+        "phpro/grumphp": "0.19.*"
     },
     "require-dev": {
         "squizlabs/php_codesniffer": ">=3.5.0 <4.0.0"

grumphp.yml

@@ -1,8 +1,4 @@
-parameters:
-    git_dir: .
-    bin_dir: vendor/bin
-    stop_on_failure: false
-    ignore_unstaged_changes: false #brocken
+grumphp:
     tasks:
         composer:
             with_dependencies: false
@@ -21,7 +17,7 @@ parameters:
             detect_key_conflicts: true
         phpcs:
             standard: "PSR12"
-            warning_severity: 900000
+            warning_severity: 0
             tab_width: 4
         yamllint: ~
         plus_bom_fixer:

src/BomFixerTask.php

@@ -4,20 +4,25 @@
 
 use GrumPHP\Runner\TaskResult;
 use GrumPHP\Runner\TaskResultInterface;
-use GrumPHP\Task\AbstractExternalTask;
+use GrumPHP\Task\Config\EmptyTaskConfig;
+use GrumPHP\Task\Config\TaskConfigInterface;
 use GrumPHP\Task\Context\ContextInterface;
 use GrumPHP\Task\Context\GitPreCommitContext;
 use GrumPHP\Task\Context\RunContext;
+use GrumPHP\Task\TaskInterface;
 use Symfony\Component\OptionsResolver\OptionsResolver;
 
-class BomFixerTask extends AbstractExternalTask
+final class BomFixerTask implements TaskInterface
 {
-    public function getName(): string
+    /** @var TaskConfigInterface */
+    private $config;
+
+    public function __construct()
     {
-        return 'plus_bom_fixer';
+        $this->config = new EmptyTaskConfig();
     }
 
-    public function getConfigurableOptions(): OptionsResolver
+    public static function getConfigurableOptions(): OptionsResolver
     {
         $resolver = new OptionsResolver();
         $resolver->setDefaults(
@@ -31,15 +36,27 @@ public function getConfigurableOptions(): OptionsResolver
         return $resolver;
     }
 
+    public function getConfig(): TaskConfigInterface
+    {
+        return $this->config;
+    }
+
+    public function withConfig(TaskConfigInterface $config): TaskInterface
+    {
+        $new = clone $this;
+        $new->config = $config;
+
+        return $new;
+    }
+
     public function canRunInContext(ContextInterface $context): bool
     {
-        return ($context instanceof GitPreCommitContext || $context instanceof RunContext);
+        return $context instanceof RunContext || $context instanceof GitPreCommitContext;
     }
 
     public function run(ContextInterface $context): TaskResultInterface
     {
-        $config = $this->getConfiguration();
-        $files = $context->getFiles()->extensions($config['triggered_by']);
+        $files = $context->getFiles()->extensions($this->config->getOptions()['triggered_by']);
         if (0 === count($files)) {
             return TaskResult::createSkipped($this, $context);
         }
@@ -64,18 +81,20 @@ public function run(ContextInterface $context): TaskResultInterface
         }
 
         if (count($shouldGetFixedLog) > 0) {
-            return TaskResult::createFailed(
-                $this,
-                $context,
-                implode(PHP_EOL, $shouldGetFixedLog) . PHP_EOL
+            $errorMessage = implode(PHP_EOL, $shouldGetFixedLog) . PHP_EOL
                 . 'you can use this to fix them:' . PHP_EOL
-                . $fixCommand
-            );
+                . $fixCommand;
+            return TaskResult::createFailed($this, $context, $errorMessage);
         }
         return TaskResult::createPassed($this, $context);
     }
 
-    protected function fileInfoSearch(string $filename, string $search): bool
+    private function isFileWithBOM(string $filename): bool
+    {
+        return $this->fileInfoSearch($filename, 'BOM');
+    }
+
+    private function fileInfoSearch(string $filename, string $search): bool
     {
         $output = [];
         exec('file ' . '"' . $filename . '"', $output, $returnVar);
@@ -84,9 +103,4 @@ protected function fileInfoSearch(string $filename, string $search): bool
         }
         return false;
     }
-
-    public function isFileWithBOM(string $filename): bool
-    {
-        return $this->fileInfoSearch($filename, 'BOM');
-    }
 }

src/ExtensionLoader.php

@@ -11,9 +11,8 @@ class ExtensionLoader implements ExtensionInterface
     public function load(ContainerBuilder $container)
     {
         return $container->register('task.plus_bom_fixer', BomFixerTask::class)
-            ->addArgument(new Reference('config'))
             ->addArgument(new Reference('process_builder'))
             ->addArgument(new Reference('formatter.raw_process'))
-            ->addTag('grumphp.task', ['config' => 'plus_bom_fixer']);
+            ->addTag('grumphp.task', ['task' => 'plus_bom_fixer']);
     }
 }