App\Docsets\Alpinejs

Complexity

Total Complexity

16

Size/Duplication

Total Lines	169
Duplicated Lines	0 %

Importance

Changes	9
Bugs	1	Features	1

14 Methods

Rating	Name	Duplication	Size	Complexity
A	grab()	0	20	1
A	entries()	0	10	1
A	removeLeftSidebar()	0	3	1
A	updateContainerWidthAndMargins()	0	5	1
A	removeRightSidebar()	0	3	1
A	updateBottomPadding()	0	5	1
A	updateTopPadding()	0	5	1
A	removeHeader()	0	3	1
A	insertDashTableOfContents()	0	12	1
A	insertOnlineRedirection()	0	5	1
A	format()	0	16	1
A	updateLeftPadding()	0	10	1
A	sectionEntries()	0	15	2
A	guideEntries()	0	15	2

<?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\HtmlPageCrawler;

class Alpinejs extends BaseDocset
{
    public const CODE = 'alpinejs';
    public const NAME = 'Alpine.js';
    public const URL = 'alpinejs.dev';
    public const INDEX = 'start-here.html';
    public const PLAYGROUND = 'https://alpinejs.codewithhugo.com';
    public const ICON_16 = '../../icons/icon.png';
    public const ICON_32 = '../../icons/icon@2x.png';
    public const EXTERNAL_DOMAINS = [];


    public function grab(): bool
    {
        system(
            "echo; wget github.com/alpinejs/alpine \
                --mirror \
                --trust-server-names \
                --ignore-case \
                --page-requisites \
                --adjust-extension \
                --convert-links \
                --span-hosts \
                --domains={$this->externalDomains()} \
                --directory-prefix=storage/{$this->downloadedDirectory()} \
                -e robots=off \
                --quiet \
                --show-progress",
            $result
        );

        return $result === 0;
    }

    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()}/start-here.html")) {
            $crawler->filter('body > aside:first-of-type ul > li > ul > li')->each(function (HtmlPageCrawler $node) use ($entries) {
                $entries->push([
                    'name' => trim($node->text()),
                    'type' => 'Guide',
                    'path' => $this->url() . '/' . $node->children('a')->attr('href')
                ]);
            });
        }

        return $entries;
    }

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

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

        return $entries;
    }

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

        $this->removeHeader($crawler);
        $this->removeLeftSidebar($crawler);
        $this->removeRightSidebar($crawler);
        $this->updateTopPadding($crawler);
        $this->updateLeftPadding($crawler);
        $this->updateContainerWidthAndMargins($crawler);
        $this->updateBottomPadding($crawler);

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

        return $crawler->saveHTML();
    }

    protected function removeHeader(HtmlPageCrawler $crawler)
    {
        $crawler->filter('header')->remove();
    }

    protected function removeLeftSidebar(HtmlPageCrawler $crawler)
    {
        $crawler->filter('body > aside:first-of-type')->remove();
    }

    protected function removeRightSidebar(HtmlPageCrawler $crawler)
    {
        $crawler->filter('body > aside:last-of-type')->remove();
    }

    protected function updateTopPadding(HtmlPageCrawler $crawler)
    {
        $crawler->filter('main')
            ->removeClass('pt-24')
            ->addClass('pt-6')
        ;
    }

    protected function updateLeftPadding(HtmlPageCrawler $crawler)
    {
        $crawler->filter('main')
            ->removeClass('md:pl-48')
            ->removeClass('lg:pl-64')
            ->removeClass('pl-0')
            ->addClass('pl-6')
            ->removeClass('xl:pr-64')
            ->removeClass('pr-0')
            ->addClass('pr-6')
        ;
    }

    protected function updateContainerWidthAndMargins(HtmlPageCrawler $crawler)
    {
        $crawler->filter('main > div:first-of-type')
            ->removeClass('m-auto')
            ->removeClass('max-w-3xl')
        ;
    }

    protected function updateBottomPadding(HtmlPageCrawler $crawler)
    {
        $crawler->filter('main > div:first-of-type')
            ->removeClass('pb-24')
            ->addClass('pb-6')
        ;
    }

    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('head')
            ->before('<a name="//apple_ref/cpp/Section/Top" class="dashAnchor"></a>');

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