Add Mago as task

composer.json

@@ -53,6 +53,7 @@
         "atoum/atoum": "Lets GrumPHP run your unit tests.",
         "behat/behat": "Lets GrumPHP validate your project features.",
         "brianium/paratest": "Lets GrumPHP run PHPUnit in parallel.",
+        "carthage-software/mago": "Lets GrumPHP help you write better PHP code.",
         "codeception/codeception": "Lets GrumPHP run your project's full stack tests",
         "consolidation/robo": "Lets GrumPHP run your automated PHP tasks.",
         "designsecurity/progpilot": "Lets GrumPHP be sure that there are no vulnerabilities in your code.",

doc/tasks.md

@@ -32,6 +32,7 @@ grumphp:
         infection: ~
         jsonlint: ~
         kahlan: ~
+        mago: ~
         make: ~
         npm_script: ~
         paratest: ~
@@ -99,6 +100,7 @@ Every task has its own default configuration. It is possible to overwrite the pa
 - [Infection](tasks/infection.md)
 - [JsonLint](tasks/jsonlint.md)
 - [Kahlan](tasks/kahlan.md)
+- [Mago](tasks/mago.md)
 - [Make](tasks/make.md)
 - [NPM script](tasks/npm_script.md)
 - [Paratest](tasks/paratest.md)

doc/tasks/mago.md

@@ -0,0 +1,91 @@
+# Mago
+
+The Mago task runs the Mago's toolchain.
+
+***Composer***
+
+```
+composer require --dev carthage-software/mago
+```
+
+***Config***
+
+The task lives under the `mago` namespace and has following configurable parameters:
+
+```yaml
+# grumphp.yml
+grumphp:
+    tasks:
+        mago:
+            formatter: ~
+            formatter_options: ~
+            linter: ~
+            linter_options: ~
+            analyzer: ~
+            analyzer_options: ~
+            guard: ~
+            guard_options: ~
+```
+
+**formatter**
+
+*Default: `true`*
+
+Enable the Mago's formatter.
+
+
+**formatter_options**
+
+*Default: `['--staged']`*
+
+[Options](https://mago.carthage.software/tools/formatter/command-reference#options) for the `mago format` command.  
+Each option must be an array's element.  
+If the option needs a value, add it after the option name with an equal sign like this: `--option=value`.
+
+
+**linter**
+
+*Default: `true`*
+
+Enable the Mago's linter.
+
+
+**linter_options**
+
+*Default: `['--staged']`*
+
+[Options](https://mago.carthage.software/tools/linter/command-reference#options) for the `mago lint` command.  
+Each option must be an array's element.  
+If the option needs a value, add it after the option name with an equal sign like this: `--option=value`.
+
+
+**analyzer**
+
+*Default: `true`*
+
+Enable the Mago's analyzer.
+
+
+**analyzer_options**
+
+*Default: `['--staged']`*
+
+[Options](https://mago.carthage.software/tools/analyzer/command-reference#options) for the `mago analyze` command.  
+Each option must be an array's element.  
+If the option needs a value, add it after the option name with an equal sign like this: `--option=value`.
+
+
+**guard**
+
+*Default: `false`*
+
+Enable the architectural guard.
+
+
+**guard_options**
+
+*Default: `[]`*
+
+[Options](https://mago.carthage.software/tools/guard/command-reference#options) for the `mago guard` command.  
+Each option must be an array's element.  
+If the option needs a value, add it after the option name with an equal sign like this: `--option=value`.

resources/config/tasks.yml

@@ -169,6 +169,13 @@ services:
         tags:
             - {name: grumphp.task, task: kahlan}
 
+    GrumPHP\Task\Mago:
+      arguments:
+        - '@process_builder'
+        - '@formatter.raw_process'
+      tags:
+        - {name: grumphp.task, task: mago}
+
     GrumPHP\Task\Make:
         arguments:
             - '@process_builder'

src/Task/Mago.php

@@ -0,0 +1,97 @@
+<?php
+
+declare(strict_types=1);
+
+namespace GrumPHP\Task;
+
+use GrumPHP\Formatter\ProcessFormatterInterface;
+use GrumPHP\Runner\TaskResult;
+use GrumPHP\Runner\TaskResultInterface;
+use GrumPHP\Task\Config\ConfigOptionsResolver;
+use GrumPHP\Task\Context\ContextInterface;
+use GrumPHP\Task\Context\GitPreCommitContext;
+use GrumPHP\Task\Context\RunContext;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+
+/**
+ * @extends AbstractExternalTask<ProcessFormatterInterface>
+ */
+class Mago extends AbstractExternalTask
+{
+
+    public static function getConfigurableOptions(): ConfigOptionsResolver
+    {
+        $resolver = new OptionsResolver();
+        $resolver->setDefaults([
+            'formatter' => true,
+            'formatter_options' => ['--staged'],
+            'linter' => true,
+            'linter_options' => ['--staged'],
+            'analyzer' => true,
+            'analyzer_options' => ['--staged'],
+            'guard' => false,
+            'guard_options' => [],
+        ]);
+
+        $resolver->addAllowedTypes('formatter', ['bool']);
+        $resolver->addAllowedTypes('formatter_options', ['array']);
+        $resolver->addAllowedTypes('linter', ['bool']);
+        $resolver->addAllowedTypes('linter_options', ['array']);
+        $resolver->addAllowedTypes('analyzer', ['bool']);
+        $resolver->addAllowedTypes('analyzer_options', ['array']);
+        $resolver->addAllowedTypes('guard', ['bool']);
+        $resolver->addAllowedTypes('guard_options', ['array']);
+
+        return ConfigOptionsResolver::fromOptionsResolver($resolver);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function canRunInContext(ContextInterface $context): bool
+    {
+        return $context instanceof GitPreCommitContext || $context instanceof RunContext;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function run(ContextInterface $context): TaskResultInterface
+    {
+        $config = $this->getConfig()->getOptions();
+
+        if ($config['formatter'] === false
+            && $config['linter'] === false
+            && $config['analyzer'] === false
+            && $config['guard'] === false) {
+            return TaskResult::createSkipped($this, $context);
+        }
+
+        $commandMap = [
+            'formatter' => 'fmt',
+            'linter' => 'lint',
+            'analyzer' => 'analyze',
+            'guard' => 'guard',
+        ];
+
+        foreach ($commandMap as $configKey => $command) {
+            if ($config[$configKey] !== true) {
+                continue;
+            }
+
+            $arguments = $this->processBuilder->createArgumentsForCommand('mago');
+            $arguments->add($command);
+
+            $arguments->addArgumentArray('%s', $config[$configKey . '_options']);
+
+            $process = $this->processBuilder->buildProcess($arguments);
+            $process->run();
+
+            if (!$process->isSuccessful()) {
+                return TaskResult::createFailed($this, $context, $this->formatter->format($process));
+            }
+        }
+
+        return TaskResult::createPassed($this, $context);
+    }
+}