Add maml init command

Author: antonmedv

src/Command/CommandCommon.php

@@ -12,13 +12,11 @@
 
 use Deployer\Deployer;
 use Deployer\Support\Reporter;
+use function Deployer\Support\ci_name;
 
 trait CommandCommon
 {
     /**
-     * Collecting anonymous stat helps Deployer team improve developer experience.
-     * If you are not comfortable with this, you will always be able to disable this
-     * by setting DO_NOT_TRACK environment variable to `1`.
      * @codeCoverageIgnore
      */
     protected function telemetry(array $data = []): void
@@ -33,6 +31,7 @@ protected function telemetry(array $data = []): void
                 'deployer_phar' => Deployer::isPharArchive(),
                 'php_version' => phpversion(),
                 'os' => defined('PHP_OS_FAMILY') ? PHP_OS_FAMILY : (stristr(PHP_OS, 'DAR') ? 'OSX' : (stristr(PHP_OS, 'WIN') ? 'WIN' : (stristr(PHP_OS, 'LINUX') ? 'LINUX' : PHP_OS))),
+                'ci' => ci_name(),
             ], $data));
         } catch (\Throwable $e) {
             return;

src/Command/InitCommand.php

@@ -10,6 +10,7 @@
 
 namespace Deployer\Command;
 
+use Maml\Maml;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputOption;
@@ -72,7 +73,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         $io = new SymfonyStyle($input, $output);
         $recipePath = $input->getOption('path');
 
-        $language = $io->choice('Select recipe language', ['php', 'yaml'], 'php');
+        $language = $io->choice('Select recipe language', ['php', 'maml'], 'php');
         if (empty($recipePath)) {
             $recipePath = "deploy.$language";
         }
@@ -148,7 +149,14 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             $hosts = [];
         }
 
-        file_put_contents($recipePath, $this->$language($template, $project, $repository, $hosts));
+
+        $code = match ($language) {
+            'php' => $this->php($template, $project, $repository, $hosts),
+            'maml' => $this->maml($template, $project, $repository, $hosts),
+            default => $default,
+        };
+
+        file_put_contents($recipePath, $code);
 
         $this->telemetry();
         $output->writeln(sprintf(
@@ -191,51 +199,33 @@ private function php(string $template, string $project, string $repository, arra
             PHP;
     }
 
-    private function yaml(string $template, string $project, string $repository, array $hosts): string
+    private function maml(string $template, string $project, string $repository, array $hosts): string
     {
-        $h = "";
-        foreach ($hosts as $host) {
-            $h .= "  $host:\n"
-                . "    remote_user: deployer\n"
-                . "    deploy_path: '~/{$project}'\n";
-        }
-
-        $additionalConfigs = $this->getAdditionalConfigs($template);
-
-        return <<<YAML
-            import: 
-              - recipe/$template.php
+        $recipe = [
+            "import" => [
+                "recipe/$template.php",
+            ],
+            "config" => [
+                "repository" => "$repository",
+            ],
+            "hosts" => [],
+            "tasks" => [
+                "example" => [
+                    [
+                        "run" => "date",
+                    ],
+                ],
+            ],
+        ];
 
-            config:
-              repository: '$repository'
-            $additionalConfigs
-            hosts:
-            $h
-            tasks:
-              build:
-                - run: uptime  
-
-            after:
-              deploy:failed: deploy:unlock
-
-            YAML;
-    }
-
-    private function getAdditionalConfigs(string $template): string
-    {
-        if ($template !== 'common') {
-            return '';
+        foreach ($hosts as $host) {
+            $recipe['hosts'][$host] = [
+                "remote_user" => "deployer",
+                "deploy_path" => "~/$project",
+            ];
         }
 
-        return <<<YAML
-              shared_files:
-                - .env
-              shared_dirs:
-                - uploads
-              writable_dirs:
-                - uploads
-              
-            YAML;
+        return Maml::stringify($recipe);
     }
 
     private function recipes(): array

src/Logger/Logger.php

@@ -12,13 +12,12 @@
 
 use Deployer\Exception\Exception;
 use Deployer\Exception\RunException;
-use Deployer\Exception\SchemaException;
 use Deployer\Host\Host;
 use Deployer\Logger\Handler\HandlerInterface;
 use Deployer\Task\Task;
-use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 use Throwable;
+use function Deployer\Support\ci_name;
 
 class Logger
 {
@@ -62,9 +61,10 @@ public function print(Host $host, string $buffer, bool $force = false): void
     public function startTask(Task $task): void
     {
         $this->startTime = round(microtime(true) * 1000);
-        if (getenv('GITHUB_WORKFLOW')) {
+        $ci = ci_name();
+        if ($ci === 'github') {
             $this->output->writeln("::group::task {$task->getName()}");
-        } elseif (getenv('GITLAB_CI')) {
+        } elseif ($ci === 'gitlab') {
             $sectionId = md5($task->getName());
             $start = round($this->startTime / 1000);
             $this->output->writeln("\e[0Ksection_start:{$start}:{$sectionId}\r\e[0K{$task->getName()}");
@@ -86,9 +86,10 @@ public function endTask(Task $task): void
         $millis = $millis - $seconds * 1000;
         $taskTime = ($seconds > 0 ? "{$seconds}s " : "") . "{$millis}ms";
 
-        if (getenv('GITHUB_WORKFLOW')) {
+        $ci = ci_name();
+        if ($ci === 'github') {
             $this->output->writeln("::endgroup::");
-        } elseif (getenv('GITLAB_CI')) {
+        } elseif ($ci === 'gitlab') {
             $sectionId = md5($task->getName());
             $endTime = round($endTime / 1000);
             $this->output->writeln("\e[0Ksection_end:{$endTime}:{$sectionId}\r\e[0K");

src/Support/Reporter.php

@@ -10,7 +10,6 @@
 
 namespace Deployer\Support;
 
-use Deployer\Utility\Httpie;
 use Symfony\Component\Process\PhpProcess;
 
 /**

src/Support/helpers.php

@@ -210,9 +210,15 @@ function colorize_host(string $alias): string
     return "<$tag>$alias</>";
 }
 
-function escape_shell_argument(string $argument): string
+function ci_name(): ?string
 {
-    return "'" . str_replace("'", "'\\''", $argument) . "'";
+    if (getenv('GITHUB_WORKFLOW')) {
+        return 'github';
+    }
+    if (getenv('GITLAB_CI')) {
+        return 'gitlab';
+    }
+    return null;
 }
 
 function deployer_root(): string

tests/src/Support/HelpersTest.php

@@ -59,9 +59,4 @@ public function testParseHomeDir()
         $this->assertStringStartsWith('~', parse_home_dir('~path'));
         $this->assertStringEndsWith('~', parse_home_dir('path~'));
     }
-
-    public function testEscapeShellArgument()
-    {
-        $this->assertEquals('\'{"foobar":"Lorem ipsum\'\\\'\'s dolor"}\'', escape_shell_argument(json_encode(['foobar' => 'Lorem ipsum\'s dolor'])));
-    }
 }