App\Docsets\LaravelZero

Complexity

Total Complexity

17

Size/Duplication

Total Lines	155
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	3
Bugs	2	Features	0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	entries()	0	9	1
A	is404OrIndex()	0	4	2
A	updateBottomMargin()	0	7	1
A	removeEditThisPageLink()	0	3	1
A	removeFooter()	0	3	1
A	insertDashTableOfContents()	0	8	1
A	hideHeader()	0	9	1
A	insertOnlineRedirection()	0	5	1
A	removeLeftSidebar()	0	4	1
A	sectionEntries()	0	15	2
A	updateTopMargin()	0	4	1
A	updateContainerWidth()	0	11	1
A	guideEntries()	0	15	2
A	format()	0	17	1

<?php

namespace App\Docsets;

use Godbout\DashDocsetBuilder\Docsets\BaseDocset;
use Illuminate\Support\Collection;
use Illuminate\Support\Facades\Storage;
use Illuminate\Support\Str;
use Wa72\HtmlPageDom\HtmlPage;
use Wa72\HtmlPageDom\HtmlPageCrawler;

class LaravelZero extends BaseDocset
{
    public const CODE = 'laravel-zero';
    public const NAME = 'Laravel Zero';
    public const URL = 'laravel-zero.com';
    public const INDEX = 'docs/introduction.html';
    public const PLAYGROUND = '';
    public const ICON_16 = '../../icons/icon.png';
    public const ICON_32 = '../../icons/icon@2x.png';
    public const EXTERNAL_DOMAINS = [
        'raw.githubusercontent.com',
        'googleapis.com',
    ];

    public function entries(string $file): Collection
    {
        $crawler = HtmlPageCrawler::create(Storage::get($file));

        $entries = collect();
        $entries = $entries->merge($this->guideEntries($crawler, $file));
        $entries = $entries->merge($this->sectionEntries($crawler, $file));

        return $entries;
    }

    protected function guideEntries(HtmlPageCrawler $crawler, string $file)
    {
        $entries = collect();

        if (Str::contains($file, "{$this->url()}/docs/introduction.html")) {
            $crawler->filter('.docs-nav a')->each(function (HtmlPageCrawler $node) use ($entries) {
                $entries->push([
                    'name' => trim($node->text()),
                    'type' => 'Guide',
                    'path' => $this->url() . '/docs/' . $node->attr('href')
                ]);
            });
        }

        return $entries;
    }

    protected function sectionEntries(HtmlPageCrawler $crawler, string $file)
    {
        $entries = collect();

        if (! $this->is404OrIndex($file)) {
            $crawler->filter('h2, h3, h4')->each(function (HtmlPageCrawler $node) use ($entries, $file) {
                $entries->push([
                    'name' => trim($node->text()),
                    'type' => 'Section',
                    'path' => Str::after($file . '#' . Str::slug($node->text()), $this->innerDirectory()),
                ]);
            });
        }

        return $entries;
    }

    protected function is404OrIndex($file)
    {
        return Str::contains($file, "{$this->url()}/index.html")
            || Str::contains($file, "{$this->url()}/404/index.html");
    }

    public function format(string $file): string
    {
        $crawler = HtmlPageCrawler::create(Storage::get($file));

        $this->hideHeader($crawler);
        $this->removeLeftSidebar($crawler);
        $this->removeEditThisPageLink($crawler);
        $this->removeFooter($crawler);

        $this->updateTopMargin($crawler);
        $this->updateContainerWidth($crawler);
        $this->updateBottomMargin($crawler);

        $this->insertOnlineRedirection($crawler, $file);
        $this->insertDashTableOfContents($crawler);

        return $crawler->saveHTML();
    }

    protected function hideHeader(HtmlPageCrawler $crawler)
    {
        /**
         * hide rather than remove
         *
         * if we remove the header, the code formatting stops working
         * so we hide it instead. genius.
         */
        $crawler->filter('body > header')->addClass('hidden');
    }

    protected function removeLeftSidebar(HtmlPageCrawler $crawler)
    {
        $crawler->filter('.docs-nav')->remove();
        $crawler->filter('nav.hidden.mt-1')->remove();
    }

    protected function removeEditThisPageLink(HtmlPageCrawler $crawler)
    {
        $crawler->filter('.DocSearch-content > div')->remove();
    }

    protected function removeFooter(HtmlPageCrawler $crawler)
    {
        $crawler->filter('body > footer')->remove();
    }

    protected function updateTopMargin(HtmlPageCrawler $crawler)
    {
        $crawler->filter('h1')
            ->css('margin-top', '1rem')
        ;
    }

    protected function updateContainerWidth(HtmlPageCrawler $crawler)
    {
        $container = $crawler->filter('.DocSearch-content');

        $container->removeClass('lg:ml-10')
            ->removeClass('lg:px-0')
            ->removeClass('xl:ml-16')
            ->removeClass('px-3')
        ;

        $container->addClass('px-6');
    }

    protected function updateBottomMargin(HtmlPageCrawler $crawler)
    {
        $content = $crawler->filter('section > div > div');

        $content->removeClass('mb-20');

        $content->css('margin-bottom', '4rem');
    }

    protected function insertOnlineRedirection(HtmlPageCrawler $crawler, string $file)
    {
        $onlineUrl = Str::substr(Str::after($file, $this->innerDirectory()), 1, -5);

        $crawler->filter('html')->prepend("<!-- Online page at https://$onlineUrl -->");
    }

    protected function insertDashTableOfContents(HtmlPageCrawler $crawler)
    {
        $crawler->filter('h1')
            ->before('<a name="//apple_ref/cpp/Section/Top" class="dashAnchor"></a>');

        $crawler->filter('h2, h3, h4')->each(static function (HtmlPageCrawler $node) {
            $node->before(
                '<a id="' . Str::slug($node->text()) . '" name="//apple_ref/cpp/Section/' . rawurlencode($node->text()) . '" class="dashAnchor"></a>'
            );
        });
    }
}