Passed
Push — master ( 3afcce...e044cf )
by Guillaume
08:13
created

Jigsaw::removeHeader()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 0
CRAP Score 2

Importance

Changes 0
Metric Value
cc 1
eloc 2
nc 1
nop 1
dl 0
loc 4
ccs 0
cts 3
cp 0
crap 2
rs 10
c 0
b 0
f 0
1
<?php
2
3
namespace App\Docsets;
4
5
use Illuminate\Support\Str;
6
use Illuminate\Support\Collection;
7
use Wa72\HtmlPageDom\HtmlPageCrawler;
8
use Illuminate\Support\Facades\Storage;
9
use Godbout\DashDocsetBuilder\Docsets\BaseDocset;
10
11
class Jigsaw extends BaseDocset
12
{
13
    public const CODE = 'jigsaw';
14
    public const NAME = 'Jigsaw';
15
    public const URL = 'jigsaw.tighten.co';
16
    public const INDEX = 'docs/installation/index.html';
17
    public const PLAYGROUND = '';
18
    public const ICON_16 = '../../icons/icon.png';
19
    public const ICON_32 = '../../icons/[email protected]';
20
    public const EXTERNAL_DOMAINS = [
21
        'googleapis.com',
22
        'typekit.net',
23
    ];
24
25
26
    public function entries(string $file): Collection
27
    {
28
        $crawler = HtmlPageCrawler::create(Storage::get($file));
29
30
        $entries = collect();
31
        $entries = $entries->merge($this->guideEntries($crawler, $file));
32
        $entries = $entries->merge($this->sectionEntries($crawler, $file));
33
34
        return $entries;
35
    }
36
37
    protected function guideEntries(HtmlPageCrawler $crawler, string $file)
38
    {
39
        $entries = collect();
40
41
        if (! Str::contains($file, "{$this->url()}/index.html")) {
42
            $crawler->filter('h2')->each(function (HtmlPageCrawler $node) use ($entries, $file) {
43
                $entries->push([
44
                    'name' => trim($node->text()),
45
                    'type' => 'Guide',
46
                    'path' => Str::after($file . '#' . Str::slug($node->text()), $this->innerDirectory()),
47
                ]);
48
            });
49
        }
50
51
        return $entries;
52
    }
53
54
    protected function sectionEntries(HtmlPageCrawler $crawler, string $file)
55
    {
56
        $entries = collect();
57
58
        if (! Str::contains($file, "{$this->url()}/index.html")) {
59
            $crawler->filter('h3')->each(function (HtmlPageCrawler $node) use ($entries, $file) {
60
                $entries->push([
61
                    'name' => trim($node->text()),
62
                    'type' => 'Section',
63
                    'path' => Str::after($file . '#' . Str::slug($node->text()), $this->innerDirectory()),
64
                ]);
65
            });
66
        }
67
68
        return $entries;
69
    }
70
71
    public function format(string $html): string
72
    {
73
        $crawler = HtmlPageCrawler::create($html);
74
75
        $this->removeLeftSidebar($crawler);
76
        $this->removeRightSidebar($crawler);
77
        $this->removeHeader($crawler);
78
        $this->removeFooter($crawler);
79
        $this->updateTopPadding($crawler);
80
        $this->updateContainer($crawler);
81
        $this->updateTextSize($crawler);
82
        $this->updateH4Padding($crawler);
83
        $this->removeUnwantedCSS($crawler);
84
        $this->removeUnwantedJavaScript($crawler);
85
        $this->insertDashTableOfContents($crawler);
86
87
        return $crawler->saveHTML();
88
    }
89
90
    protected function removeLeftSidebar(HtmlPageCrawler $crawler)
91
    {
92
        $crawler->filterXPath('//main[@id="vue-app"]//navigation')->remove();
93
    }
94
95
    protected function removeRightSidebar(HtmlPageCrawler $crawler)
96
    {
97
        $crawler->filterXPath('//main[@id="vue-app"]//navigation-on-page')->remove();
98
    }
99
100
    protected function removeHeader(HtmlPageCrawler $crawler)
101
    {
102
        $crawler->filter('#vue-app > div:first-child')->remove();
103
        $crawler->filter('#vue-app > header')->remove();
104
    }
105
106
    protected function removeFooter(HtmlPageCrawler $crawler)
107
    {
108
        $crawler->filter('footer')->remove();
109
    }
110
111
    protected function updateTopPadding(HtmlPageCrawler $crawler)
112
    {
113
        $crawler->filter('#vue-app > div > div > div')
114
            ->removeClass('pt-4')
115
            ->css('margin-top', '-1.5rem')
116
        ;
117
    }
118
119
    protected function updateContainer(HtmlPageCrawler $crawler)
120
    {
121
        $crawler->filter('#vue-app > div')
122
            ->removeClass('pt-16')
123
            ->removeClass('md:pt-24')
124
            ->removeClass('lg:pt-32')
125
            ->removeClass('md:px-6')
126
        ;
127
128
        $crawler->filter('#vue-app > div > div')
129
            ->removeClass('max-w-3xl')
130
        ;
131
132
        $crawler->filter('div.markdown')
133
            ->removeClass('lg:max-w-md')
134
            ->removeClass('xl:max-w-lg')
135
            ->removeClass('md:mb-6')
136
            ->removeClass('lg:mb-10')
137
            ->removeClass('xl:px-10')
138
            ->removeClass('sm:shadow')
139
            ->removeClass('md:rounded-lg')
140
        ;
141
    }
142
143
    protected function updateTextSize(HtmlPageCrawler $crawler)
144
    {
145
        $crawler->filter('h2')
146
            ->addClass('text-3xl')
147
        ;
148
149
        $crawler->filter('h3')
150
            ->css('font-size', '1.5rem')
151
        ;
152
    }
153
154
    protected function updateH4Padding(HtmlPageCrawler $crawler)
155
    {
156
        $crawler->filter('h4')
157
            ->css('margin-top', '2.5rem')
158
        ;
159
    }
160
161
    protected function removeUnwantedCSS(HtmlPageCrawler $crawler)
162
    {
163
        $crawler->filter('link[href*="docsearch.min.css"]')->remove();
164
    }
165
166
    protected function removeUnwantedJavaScript(HtmlPageCrawler $crawler)
167
    {
168
        $crawler->filter('script[src*=docsearch]')->remove();
169
        $crawler->filterXPath("//script[text()[contains(.,'docsearch')]]")->remove();
170
    }
171
172
    protected function insertDashTableOfContents(HtmlPageCrawler $crawler)
173
    {
174
        $crawler->filter('h2')
175
            ->before('<a name="//apple_ref/cpp/Section/Top" class="dashAnchor"></a>');
176
177
        $crawler->filter('h3')->each(static function (HtmlPageCrawler $node) {
178
            $node->before(
179
                '<a id="' . Str::slug($node->text()) . '" name="//apple_ref/cpp/Section/' . rawurlencode($node->text()) . '" class="dashAnchor"></a>'
180
            );
181
        });
182
    }
183
}
184