Phln\Build\Command\CreateDocsCommand

Complexity

Total Complexity

12

Size/Duplication

Total Lines	135
Duplicated Lines	0 %

Importance

Changes

0

<?php
class CreateDocsCommand extends Command
{
    protected $signature = 'create:docs';

    private $docBlockFactory;

    private $paths = [
        'functions' => __DIR__.'/../../docs/functions/',
    ];

    /**
     * @var Factory
     */
    private $view;

    /**
     * @var Filesystem
     */
    private $filesystem;

    public function __construct(Factory $view, Filesystem $filesystem)
    {
        parent::__construct();
        $this->docBlockFactory = DocBlockFactory::createInstance();
        $this->view = $view;
        $this->filesystem = $filesystem;
    }

    public function handle()
    {
        $this->output->writeln('Preparing directories');
        $this->cleanup();

        $this->output->writeln('Extracting contents');
        $phlnReflection = new \ReflectionClass(Phln::class);
        $docBlocks = $this->extractDocBlocks($phlnReflection);

        foreach ($docBlocks as $category => $methods) {
            $this->output->writeln("Exporting docs for {$category}");
            $this->exportCategoryDocs($category, $methods);
        }

        $this->output->writeln('<info>Done</info>');
    }

    private function cleanup()
    {
        foreach ($this->paths as $path) {

            if ($this->filesystem->isDirectory($path)) {
                $this->filesystem->cleanDirectory($path);
            } else {
                $this->filesystem->delete($this->paths);
            }
        }
    }

    /**
     * Extract doc blocks of methods and group them by `@phlnCategory` tag
     *
     * @param \ReflectionClass $reflection
     * @return array
     */
    private function extractDocBlocks(\ReflectionClass $reflection): array
    {
        $methods = $reflection->getMethods();

        return apply(
            pipe([
                map(function (\ReflectionMethod $method) {
                    $comment = $method->getDocComment();

                    return [
                        'name' => $method->getName(),
                        'docBlock' => $this->docBlockFactory->create($comment),
                    ];
                }),
                reduce(function ($carry, array $method) {
                    $category = (string)$this->getDocBlockTag('phlnCategory', $method['docBlock']->getTags());

                    if (true === empty($category)) {
                        throw new \RuntimeException("Missing category for function: {$method['name']}");
                    }

                    return array_merge($carry, [
                        $category => array_merge(pathOr($category, [], $carry), [$this->getMethodToView($method)]),
                    ]);
                }, [])
            ]),
            [$methods]
        );
    }

    private function getDocBlockTag(string $name, array $tags)
    {
        return \phln\collection\head($this->getDocBlockTagsList($name, $tags));
    }

    /**
     * @param string $name
     * @param BaseTag[] $tags
     * @return array
     */
    private function getDocBlockTagsList(string $name, array $tags): array
    {
        return filter(function (BaseTag $tag) use ($name) {
            return $name === $tag->getName();
        }, $tags);
    }

    /**
     * @param string $category
     * @param array $methods
     */
    private function exportCategoryDocs(string $category, array $methods)
    {
        $rendered = $this->view->make('docs.category')
            ->with(compact('category', 'methods'))
            ->render();

        $this->filesystem->append($this->paths['functions']."/{$category}.md", $rendered);
    }

    public function getMethodToView(array $method): array
    {
        /** @var DocBlock $docBlock */
        $docBlock = $method['docBlock'];
        $tags = $docBlock->getTags();
        $name = $method['name'];
        $signatures = $this->getDocBlockTagsList('phlnSignature', $tags);
        $example = $this->getDocBlockTag('example', $tags);
        $summary = $docBlock->getSummary();
        $description = $docBlock->getDescription();

        return compact('name', 'signatures', 'example', 'summary', 'description');
    }