Deployer\Documentation\DocGen::gen()

Complexity

Conditions	49
Paths	433

Size

Total Lines	271
Code Lines	185

Duplication

Lines	0
Ratio	0 %

Importance

Changes	7
Bugs	0	Features	0

<?php
    public function gen(string $destination): ?string
    {
        foreach ($this->recipes as $recipe) {
            // $find will try to return DocConfig for a given config $name.
            $findConfig = function (string $name) use ($recipe): ?DocConfig {
                if (array_key_exists($name, $recipe->config)) {
                    return $recipe->config[$name];
                }
                foreach ($recipe->require as $r) {
                    if (array_key_exists($r, $this->recipes)) {
                        if (array_key_exists($name, $this->recipes[$r]->config)) {
                            return $this->recipes[$r]->config[$name];
                        }
                    }
                }
                foreach ($this->recipes as $r) {
                    if (array_key_exists($name, $r->config)) {
                        return $r->config[$name];
                    }
                }
                return null;
            };
            $findConfigOverride = function (DocRecipe $recipe, string $name) use (&$findConfigOverride): ?DocConfig {
                foreach ($recipe->require as $r) {
                    if (array_key_exists($r, $this->recipes)) {
                        if (array_key_exists($name, $this->recipes[$r]->config)) {
                            return $this->recipes[$r]->config[$name];
                        }
                    }
                }
                foreach ($recipe->require as $r) {
                    if (array_key_exists($r, $this->recipes)) {
                        return $findConfigOverride($this->recipes[$r], $name);
                    }
                }
                return null;
            };
            // Replace all {{name}} with link to correct config declaration.
            $replaceLinks = function (string $comment) use ($findConfig): string {
                $output = '';
                $code = false;
                foreach (explode("\n", $comment) as $i => $line) {
                    if (str_starts_with($line, '```') || str_starts_with($line, '~~~')) {
                        $code = !$code;

The condition $code is always false.

                    }
                    if ($code) {
                        $output .= $line;
                        $output .= "\n";
                        continue;
                    }
                    $output .= preg_replace_callback('#(\{\{(?<name>[\w_:\-/]+)\}\})#', function ($m) use ($findConfig) {
                        $name = $m['name'];
                        $config = $findConfig($name);
                        if ($config !== null) {
                            $md = php_to_md($config->recipePath);
                            $anchor = anchor($name);
                            return "[$name](/docs/$md#$anchor)";
                        }
                        return "{{" . $name . "}}";
                    }, $line);
                    $output .= "\n";
                }
                return $output;
            };
            $findTask = function (string $name, bool $searchOtherRecipes = true) use ($recipe): ?DocTask {
                if (array_key_exists($name, $recipe->tasks)) {
                    return $recipe->tasks[$name];
                }
                foreach ($recipe->require as $r) {
                    if (array_key_exists($r, $this->recipes)) {
                        if (array_key_exists($name, $this->recipes[$r]->tasks)) {
                            return $this->recipes[$r]->tasks[$name];
                        }
                    }
                }
                if ($searchOtherRecipes) {
                    foreach ($this->recipes as $r) {
                        if (array_key_exists($name, $r->tasks)) {
                            return $r->tasks[$name];
                        }
                    }
                }
                return null;
            };

            $title = join(' ', array_map('ucfirst', explode('_', $recipe->recipeName))) . ' Recipe';
            $config = '';
            $tasks = '';
            $intro = <<<MD
                ```php
                require '$recipe->recipePath';
                ```

                [Source](/$recipe->recipePath)


                MD;
            if (is_framework_recipe($recipe)) {
                $brandName = framework_brand_name($recipe->recipeName);
                $typeOfProject = preg_match('/^symfony/i', $recipe->recipeName) ? 'Application' : 'Project';
                $title = "How to Deploy a $brandName $typeOfProject";

                $intro .= <<<MARKDOWN
                    Deployer is a free and open source deployment tool written in PHP. 
                    It helps you to deploy your $brandName application to a server. 
                    It is very easy to use and has a lot of features. 

                    Three main features of Deployer are:
                    - **Provisioning** - provision your server for you.
                    - **Zero downtime deployment** - deploy your application without a downtime.
                    - **Rollbacks** - rollback your application to a previous version, if something goes wrong.

                    Additionally, Deployer has a lot of other features, like:
                    - **Easy to use** - Deployer is very easy to use. It has a simple and intuitive syntax.
                    - **Fast** - Deployer is very fast. It uses parallel connections to deploy your application.
                    - **Secure** - Deployer uses SSH to connect to your server.
                    - **Supports all major PHP frameworks** - Deployer supports all major PHP frameworks.

                    You can read more about Deployer in [Getting Started](/docs/getting-started.md).


                    MARKDOWN;

                $map = function (DocTask $task, $ident = '') use (&$map, $findTask, &$intro): void {
                    foreach ($task->group as $taskName) {
                        $t = $findTask($taskName);
                        if ($t !== null) {
                            $intro .= "$ident* {$t->mdLink()} – $t->desc\n";
                            if ($t->group !== null) {
                                $map($t, $ident . '  ');
                            }
                        }
                    }
                };
                $deployTask = $findTask('deploy');
                if ($deployTask !== null) {
                    $intro .= "The [deploy](#deploy) task of **$brandName** consists of:\n";
                    $map($deployTask);
                }

                $intro .= "\n\n";

                $artifactBuildTask = $findTask('artifact:build', false);
                $artifactDeployTask = $findTask('artifact:deploy', false);
                if ($artifactDeployTask !== null && $artifactBuildTask !== null) {
                    $intro .= "In addition the **$brandName** recipe contains an artifact deployment.\n";
                    $intro .= <<<MD
                        This is a two step process where you first execute

                        ```php
                        bin/dep artifact:build [options] [localhost]
                        ```

                        to build an artifact, which then is deployed on a server with

                        ```php
                        bin/dep artifact:deploy [host]
                        ```

                        The `localhost` to build the artifact on has to be declared local, so either add
                        ```php
                        localhost()
                            ->set('local', true);
                        ```
                        to your deploy.php or
                        ```yaml
                        hosts:
                            localhost:
                                local: true
                        ```
                        to your deploy yaml.

                        The [artifact:build](#artifact:build) command of **$brandName** consists of: 
                        MD;
                    $map($artifactBuildTask);

                    $intro .= "\n\n The [artifact:deploy](#artifact:deploy) command of **$brandName** consists of:\n";

                    $map($artifactDeployTask);

                    $intro .= "\n\n";
                }
            }
            if (count($recipe->require) > 0) {
                if (is_framework_recipe($recipe)) {
                    $link = recipe_to_md_link($recipe->require[0]);
                    $intro .= "The $recipe->recipeName recipe is based on the $link recipe.\n";
                } else {
                    $intro .= "* Requires\n";
                    foreach ($recipe->require as $r) {
                        $link = recipe_to_md_link($r);
                        $intro .= "  * {$link}\n";
                    }
                }
            }
            if (!empty($recipe->comment)) {
                $intro .= "\n$recipe->comment\n";
            }
            if (count($recipe->config) > 0) {
                $config .= "## Configuration\n";
                foreach ($recipe->config as $c) {
                    $config .= "### {$c->name}\n";
                    $config .= "[Source](https://github.com/deployphp/deployer/blob/master/{$c->recipePath}#L{$c->lineNumber})\n\n";
                    $o = $findConfigOverride($recipe, $c->name);
                    if ($o !== null) {
                        $md = php_to_md($o->recipePath);
                        $anchor = anchor($c->name);
                        $config .= "Overrides [{$c->name}](/docs/$md#$anchor) from `$o->recipePath`.\n\n";
                    }
                    $config .= $replaceLinks($c->comment);
                    $config .= "\n";
                    if (
                        !empty($c->defaultValue)
                        && $c->defaultValue !== "''"
                        && $c->defaultValue !== '[]'
                    ) {
                        $config .= "```php title=\"Default value\"\n";
                        $config .= $c->defaultValue;
                        $config .= "\n";
                        $config .= "```\n";
                    }
                    $config .= "\n\n";
                }
            }
            if (count($recipe->tasks) > 0) {
                $tasks .= "## Tasks\n\n";
                foreach ($recipe->tasks as $t) {
                    $anchorTag = '{#' . anchor($t->name) . '}';
                    $name = title($t->name);
                    $tasks .= "### $name $anchorTag\n";
                    $tasks .= "[Source](https://github.com/deployphp/deployer/blob/master/{$t->recipePath}#L{$t->lineNumber})\n\n";
                    $tasks .= add_tailing_dot($t->desc) . "\n\n";
                    $tasks .= $replaceLinks($t->comment);
                    if (is_array($t->group)) {
                        $tasks .= "\n\n";
                        $tasks .= "This task is group task which contains next tasks:\n";
                        foreach ($t->group as $taskName) {
                            $t = $findTask($taskName);
                            if ($t !== null) {
                                $tasks .= "* {$t->mdLink()}\n";
                            } else {
                                $tasks .= "* `$taskName`\n";
                            }
                        }
                    }
                    $tasks .= "\n\n";
                }
            }

            $output = <<<MD
                <!-- DO NOT EDIT THIS FILE! -->
                <!-- Instead edit $recipe->recipePath -->
                <!-- Then run bin/docgen -->

                # $title

                $intro
                $config
                $tasks
                MD;

            $filePath = "$destination/" . php_to_md($recipe->recipePath);
            if (!file_exists(dirname($filePath))) {
                mkdir(dirname($filePath), 0o755, true);
            }
            $output = remove_text_emoji($output);
            file_put_contents($filePath, $output);
        }
        $this->generateRecipesIndex($destination);
        $this->generateContribIndex($destination);
        return null;
    }