TailwindCSS::removeFooter() - Code Metrics - Inspection of "add remove footer, impl and tests" - godbout/tailwindcss-dash-docset - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — finetune-v3 ( 83f673...0666f9 )

by Guillaume

created 2021-12-14 11:11 UTC

TailwindCSS::removeFooter() A

↳ Parent: TailwindCSS

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	2
nc	1
nop	1
dl	0
loc	4
rs	10
c	0
b	0
f	0

<?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 TailwindCSS extends BaseDocset
{
    public const CODE = 'tailwindcss';
    public const NAME = 'Tailwind CSS';
    public const URL = 'tailwindcss.com';
    public const INDEX = 'docs/installation.html';
    public const PLAYGROUND = 'https://play.tailwindcss.com/';
    public const ICON_16 = 'favicon-16x16.png';
    public const ICON_32 = 'favicon-32x32.png';
    public const EXTERNAL_DOMAINS = [
    ];


    public function grab(): bool
    {
        $toIgnore = implode('|', [
            'blog.tailwindcss.com',
            'v1.tailwindcss.com',
            'v2.tailwindcss.com'
        ]);

        system(
            "echo; wget tailwindcss.com/docs \
                --mirror \
                --trust-server-names \
                --reject-regex='{$toIgnore}' \
                --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->union($this->resourceEntries($crawler, $file));
        $entries = $entries->union($this->guideEntries($crawler, $file));
        $entries = $entries->union($this->sectionEntries($crawler, $file));

        return $entries;
    }

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

        if (Str::contains($file, "{$this->url()}/resources.html")) {
            $crawler->filter('h2')->each(function (HtmlPageCrawler $node) use ($entries, $file) {
                $entries->push([
                    'name' => $this->cleanAnchorText($node->text()),
                    'type' => 'Resource',
                    'path' => Str::after($file . '#' . Str::slug($node->text()), $this->innerDirectory()),
                ]);
            });

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

            return $entries;
        }
    }

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

        if (Str::contains($file, "{$this->url()}/docs.html")) {
            $itemsToIgnore = collect(['Release Notes', 'Typography', 'Forms', 'Aspect Ratio', 'Line Clamp']);

            $crawler
                ->filter('nav#nav li.mt-8 a')
                ->each(function (HtmlPageCrawler $node) use ($entries, $itemsToIgnore) {
                    if (! $itemsToIgnore->contains($node->text())) {
                        $entries->push([
                            'name' => trim($node->text()),
                            'type' => 'Guide',
                            'path' => $this->url() . '/' . $node->attr('href'),
                        ]);
                    }
                });
        }

        return $entries;
    }

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

        $crawler->filter('h2')->each(function (HtmlPageCrawler $node) use ($entries, $file) {
            $entries->push([
                'name' => $this->cleanAnchorText($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->removeTopbar($crawler);
        $this->removeLeftSidebar($crawler);
        $this->removeRightSidebar($crawler);

        $this->updateContainerWidth($crawler);
        $this->removeFooter($crawler);

        $this->ignoreDarkModeForSomeColors($crawler);

        $this->removeUnwantedJavaScript($crawler);

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

        return $crawler->saveHTML();
    }

    protected function removeTopbar(HtmlPageCrawler $crawler)
    {
        $crawler->filter('div.sticky.top-0')->remove();
    }

    protected function removeLeftSidebar(HtmlPageCrawler $crawler)
    {
        $crawler->filter('div.hidden.fixed.z-20.inset-0.py-10.px-8.overflow-y-auto')->remove();
    }

    protected function removeRightSidebar(HtmlPageCrawler $crawler)
    {
        $crawler->filter('div.fixed.z-20.bottom-0.py-10.px-8.overflow-y-auto.hidden')->remove();
    }

    protected function updateContainerWidth(HtmlPageCrawler $crawler)
    {
        $crawler->filter('div.max-w-8xl.mx-auto.px-4 > div:first-child')
            ->removeClass('lg:pl-[19.5rem]')
        ;
        $crawler->filter('div.max-w-3xl.mx-auto.pt-10')
            ->removeClass('max-w-3xl')
            ->removeClass('mx-auto')
            ->removeClass('xl:max-w-none')
            ->removeClass('xl:mr-[15.5rem]')
            ->removeClass('xl:pr-16')
        ;
    }

    protected function removeFooter(HtmlPageCrawler $crawler)
    {
        $crawler->filter('div.pt-10.pb-28.border-t.border-gray-200.justify-between.text-gray-500')
            ->remove()
        ;
    }

    protected function ignoreDarkModeForSomeColors(HtmlPageCrawler $crawler)
    {
        $this->ignoreDarkModeForDefaultColorPaletteSection($crawler);
        $this->ignoreDarkModeForVariousColorTables($crawler);
    }

    protected function ignoreDarkModeForDefaultColorPaletteSection(HtmlPageCrawler $crawler)
    {
        $crawler->filter('div.h-10.w-full.rounded.ring-1.ring-inset')->addClass('dash-ignore-dark-mode');
    }

    protected function ignoreDarkModeForVariousColorTables(HtmlPageCrawler $crawler)
    {
        $crawler->filter('h2 + div td:last-child')->addClass('dash-ignore-dark-mode');
    }

    protected function removeUnwantedJavaScript(HtmlPageCrawler $crawler)
    {
        $crawler->filter('script')->remove();
    }

    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, string $file)
    {
        if (! Str::contains($file, "{$this->url()}/docs.html")) {
            $crawler->filter('body')
                ->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($this->cleanAnchorText($node->text())) . '" class="dashAnchor"></a>'
                );
            });
        }
    }

    protected function cleanAnchorText($anchorText)
    {
        return trim(preg_replace('/\s+/', ' ', $anchorText));
    }
}


1			<?php
2
3			namespace App\Docsets;
4
5			use Godbout\DashDocsetBuilder\Docsets\BaseDocset;
6			use Illuminate\Support\Collection;
7			use Illuminate\Support\Facades\Storage;
8			use Illuminate\Support\Str;
9			use Wa72\HtmlPageDom\HtmlPageCrawler;
10
11			class TailwindCSS extends BaseDocset
12			{
13			public const CODE = 'tailwindcss';
14			public const NAME = 'Tailwind CSS';
15			public const URL = 'tailwindcss.com';
16			public const INDEX = 'docs/installation.html';
17			public const PLAYGROUND = 'https://play.tailwindcss.com/';
18			public const ICON_16 = 'favicon-16x16.png';
19			public const ICON_32 = 'favicon-32x32.png';
20			public const EXTERNAL_DOMAINS = [
21			];
22
23
24			public function grab(): bool
25			{
26			$toIgnore = implode('\|', [
27			'blog.tailwindcss.com',
28			'v1.tailwindcss.com',
29			'v2.tailwindcss.com'
30			]);
31
32			system(
33			"echo; wget tailwindcss.com/docs \
34			--mirror \
35			--trust-server-names \
36			--reject-regex='{$toIgnore}' \
37			--page-requisites \
38			--adjust-extension \
39			--convert-links \
40			--span-hosts \
41			--domains={$this->externalDomains()} \
42			--directory-prefix=storage/{$this->downloadedDirectory()} \
43			-e robots=off \
44			--quiet \
45			--show-progress",
46			$result
47			);
48
49			return $result === 0;
50			}
51
52			public function entries(string $file): Collection
53			{
54			$crawler = HtmlPageCrawler::create(Storage::get($file));
55
56			$entries = collect();
57
58			$entries = $entries->union($this->resourceEntries($crawler, $file));
59			$entries = $entries->union($this->guideEntries($crawler, $file));
60			$entries = $entries->union($this->sectionEntries($crawler, $file));
61
62			return $entries;
63			}
64
65			protected function resourceEntries(HtmlPageCrawler $crawler, string $file)
66			{
67			$entries = collect();
68
69			if (Str::contains($file, "{$this->url()}/resources.html")) {
70			$crawler->filter('h2')->each(function (HtmlPageCrawler $node) use ($entries, $file) {
71			$entries->push([
72			'name' => $this->cleanAnchorText($node->text()),
73			'type' => 'Resource',
74			'path' => Str::after($file . '#' . Str::slug($node->text()), $this->innerDirectory()),
75			]);
76			});
77
78			$crawler->filter('h3')->each(function (HtmlPageCrawler $node) use ($entries, $file) {
79			$entries->push([
80			'name' => $this->cleanAnchorText($node->text()),
81			'type' => 'Section',
82			'path' => Str::after($file . '#' . Str::slug($node->text()), $this->innerDirectory()),
83			]);
84			});
85
86			return $entries;
87			}
88			}
89
90			protected function guideEntries(HtmlPageCrawler $crawler, string $file)
91			{
92			$entries = collect();
93
94			if (Str::contains($file, "{$this->url()}/docs.html")) {
95			$itemsToIgnore = collect(['Release Notes', 'Typography', 'Forms', 'Aspect Ratio', 'Line Clamp']);
96
97			$crawler
98			->filter('nav#nav li.mt-8 a')
99			->each(function (HtmlPageCrawler $node) use ($entries, $itemsToIgnore) {
100			if (! $itemsToIgnore->contains($node->text())) {
101			$entries->push([
102			'name' => trim($node->text()),
103			'type' => 'Guide',
104			'path' => $this->url() . '/' . $node->attr('href'),
105			]);
106			}
107			});
108			}
109
110			return $entries;
111			}
112
113			protected function sectionEntries(HtmlPageCrawler $crawler, string $file)
114			{
115			$entries = collect();
116
117			$crawler->filter('h2')->each(function (HtmlPageCrawler $node) use ($entries, $file) {
118			$entries->push([
119			'name' => $this->cleanAnchorText($node->text()),
120			'type' => 'Section',
121			'path' => Str::after($file . '#' . Str::slug($node->text()), $this->innerDirectory()),
122			]);
123			});
124
125			return $entries;
126			}
127
128			public function format(string $file): string
129			{
130			$crawler = HtmlPageCrawler::create(Storage::get($file));
131
132			$this->removeTopbar($crawler);
133			$this->removeLeftSidebar($crawler);
134			$this->removeRightSidebar($crawler);
135
136			$this->updateContainerWidth($crawler);
137			$this->removeFooter($crawler);
138
139			$this->ignoreDarkModeForSomeColors($crawler);
140
141			$this->removeUnwantedJavaScript($crawler);
142
143			$this->insertOnlineRedirection($crawler, $file);
144			$this->insertDashTableOfContents($crawler, $file);
145
146			return $crawler->saveHTML();
147			}
148
149			protected function removeTopbar(HtmlPageCrawler $crawler)
150			{
151			$crawler->filter('div.sticky.top-0')->remove();
152			}
153
154			protected function removeLeftSidebar(HtmlPageCrawler $crawler)
155			{
156			$crawler->filter('div.hidden.fixed.z-20.inset-0.py-10.px-8.overflow-y-auto')->remove();
157			}
158
159			protected function removeRightSidebar(HtmlPageCrawler $crawler)
160			{
161			$crawler->filter('div.fixed.z-20.bottom-0.py-10.px-8.overflow-y-auto.hidden')->remove();
162			}
163
164			protected function updateContainerWidth(HtmlPageCrawler $crawler)
165			{
166			$crawler->filter('div.max-w-8xl.mx-auto.px-4 > div:first-child')
167			->removeClass('lg:pl-[19.5rem]')
168			;
169			$crawler->filter('div.max-w-3xl.mx-auto.pt-10')
170			->removeClass('max-w-3xl')
171			->removeClass('mx-auto')
172			->removeClass('xl:max-w-none')
173			->removeClass('xl:mr-[15.5rem]')
174			->removeClass('xl:pr-16')
175			;
176			}
177
178			protected function removeFooter(HtmlPageCrawler $crawler)
179			{
180			$crawler->filter('div.pt-10.pb-28.border-t.border-gray-200.justify-between.text-gray-500')
181			->remove()
182			;
183			}
184
185			protected function ignoreDarkModeForSomeColors(HtmlPageCrawler $crawler)
186			{
187			$this->ignoreDarkModeForDefaultColorPaletteSection($crawler);
188			$this->ignoreDarkModeForVariousColorTables($crawler);
189			}
190
191			protected function ignoreDarkModeForDefaultColorPaletteSection(HtmlPageCrawler $crawler)
192			{
193			$crawler->filter('div.h-10.w-full.rounded.ring-1.ring-inset')->addClass('dash-ignore-dark-mode');
194			}
195
196			protected function ignoreDarkModeForVariousColorTables(HtmlPageCrawler $crawler)
197			{
198			$crawler->filter('h2 + div td:last-child')->addClass('dash-ignore-dark-mode');
199			}
200
201			protected function removeUnwantedJavaScript(HtmlPageCrawler $crawler)
202			{
203			$crawler->filter('script')->remove();
204			}
205
206			protected function insertOnlineRedirection(HtmlPageCrawler $crawler, string $file)
207			{
208			$onlineUrl = Str::substr(Str::after($file, $this->innerDirectory()), 1, -5);
209
210			$crawler->filter('html')->prepend("<!-- Online page at https://$onlineUrl -->");
211			}
212
213			protected function insertDashTableOfContents(HtmlPageCrawler $crawler, string $file)
214			{
215			if (! Str::contains($file, "{$this->url()}/docs.html")) {
216			$crawler->filter('body')
217			->before('<a name="//apple_ref/cpp/Section/Top" class="dashAnchor"></a>');
218
219			$crawler->filter('h2, h3')->each(function (HtmlPageCrawler $node) {
220			$node->prepend(
221			'<a id="' . Str::slug($node->text()) . '" name="//apple_ref/cpp/Section/' . rawurlencode($this->cleanAnchorText($node->text())) . '" class="dashAnchor"></a>'
222			);
223			});
224			}
225			}
226
227			protected function cleanAnchorText($anchorText)
228			{
229			return trim(preg_replace('/\s+/', ' ', $anchorText));
230			}
231			}
232

godbout / tailwindcss-dash-docset

Push — finetune-v3 ( 83f673...0666f9 )

TailwindCSS::removeFooter() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like