Parsedown::blockNote() - Code Metrics - Inspection of "Update Serve.php" - Cecilapp/Cecil - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — fix/serve-timeout ( 697f77...233bc8 )

by Arnaud

created 2022-06-05 22:01 UTC

Parsedown::blockNote() A

↳ Parent: Parsedown

Complexity

Conditions	2
Paths	2

Size

Total Lines	10
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	2
eloc	8
nc	2
nop	1
dl	0
loc	10
ccs	0
cts	0
cp	0
crap	6
rs	10
c	1
b	0
f	0

<?php

declare(strict_types=1);

/*
 * This file is part of Cecil.
 *
 * Copyright (c) Arnaud Ligny <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Cecil\Converter;

use Cecil\Assets\Asset;
use Cecil\Assets\Image;
use Cecil\Builder;
use Cecil\Exception\RuntimeException;
use Cecil\Util;

class Parsedown extends \ParsedownToC
{
    /** @var Builder */
    protected $builder;

    /** {@inheritdoc} */
    protected $regexAttribute = '(?:[#.][-\w:\\\]+[ ]*|[-\w:\\\]+(?:=(?:["\'][^\n]*?["\']|[^\s]+)?)?[ ]*)';

    /** Regex to verify there is an image in <figure> block */
    private $MarkdownImageRegex = "~^!\[.*?\]\(.*?\)~";

    public function __construct(Builder $builder)
    {
        $this->builder = $builder;

        // "insert" line block: ++text++ -> <ins>text</ins>
        $this->InlineTypes['+'][] = 'Insert';
        $this->inlineMarkerList = implode('', array_keys($this->InlineTypes));
        $this->specialCharacters[] = '+';
        // add caption to image block
        if ($this->builder->getConfig()->get('body.images.caption.enabled')) {
            $this->BlockTypes['!'][] = 'Image';
        }
        // "notes" block
        if ($this->builder->getConfig()->get('body.notes.enabled')) {
            $this->BlockTypes[':'][] = 'Note';
        }

        parent::__construct(['selectors' => $this->builder->getConfig()->get('body.toc')]);
    }

    /**
     * Insert inline.
     * e.g.: ++text++ -> <ins>text</ins>.
     */
    protected function inlineInsert($Excerpt)
    {
        if (!isset($Excerpt['text'][1])) {
            return;
        }

        if ($Excerpt['text'][1] === '+' && preg_match('/^\+\+(?=\S)(.+?)(?<=\S)\+\+/', $Excerpt['text'], $matches)) {
            return [
                'extent'  => strlen($matches[0]),
                'element' => [
                    'name'    => 'ins',
                    'text'    => $matches[1],
                    'handler' => 'line',
                ],
            ];
        }
    }

    /**
     * {@inheritdoc}
     */
    protected function inlineImage($excerpt)
    {
        $image = parent::inlineImage($excerpt);
        if (!isset($image)) {
            return null;
        }
        // clean source path / URL
        $image['element']['attributes']['src'] = trim($this->removeQuery($image['element']['attributes']['src']));
        // should be lazy loaded?
        if ($this->builder->getConfig()->get('body.images.lazy.enabled')) {
            $image['element']['attributes']['loading'] = 'lazy';
        }
        // disable remote image handling
        if (Util\Url::isUrl($image['element']['attributes']['src']) && !$this->builder->getConfig()->get('body.images.remote.enabled') ?? true) {
            return $image;
        }
        // create asset
        $asset = new Asset($this->builder, $image['element']['attributes']['src'], ['force_slash' => false]);
        // get width
        $width = $asset->getWidth();
        $image['element']['attributes']['src'] = $asset;
        /**
         * Should be resized?
         */
        $assetResized = null;
        if (isset($image['element']['attributes']['width'])
            && (int) $image['element']['attributes']['width'] < $width
            && $this->builder->getConfig()->get('body.images.resize.enabled')
        ) {
            $width = (int) $image['element']['attributes']['width'];

            try {
                $assetResized = $asset->resize($width);
            } catch (\Exception $e) {
                $this->builder->getLogger()->debug($e->getMessage());

                return $image;
            }
            $image['element']['attributes']['src'] = $assetResized;
        }
        // set width
        if (!isset($image['element']['attributes']['width'])) {
            $image['element']['attributes']['width'] = $width;
        }
        // set height
        if (!isset($image['element']['attributes']['height'])) {
            $image['element']['attributes']['height'] = ($assetResized ?? $asset)->getHeight();
        }
        /**
         * Should be responsive?
         */
        if ($this->builder->getConfig()->get('body.images.responsive.enabled')) {
            if ($srcset = Image::buildSrcset(
                $assetResized ?? $asset,
                $this->builder->getConfig()->get('assets.images.responsive.widths') ?? [480, 640, 768, 1024, 1366, 1600, 1920]
            )) {
                $image['element']['attributes']['srcset'] = $srcset;
                $image['element']['attributes']['sizes'] = $this->builder->getConfig()->get('assets.images.responsive.sizes.default');
            }
        }

        return $image;
    }

    /**
     * {@inheritdoc}
     */
    protected function parseAttributeData($attributeString)
    {
        $attributes = preg_split('/[ ]+/', $attributeString, -1, PREG_SPLIT_NO_EMPTY);
        $Data = [];
        $HtmlAtt = [];

        foreach ($attributes as $attribute) {
            switch ($attribute[0]) {
                case '#': // ID
                    $Data['id'] = substr($attribute, 1);
                    break;
                case '.': // Classes
                    $classes[] = substr($attribute, 1);
                    break;
                default:  // Attributes
                    parse_str($attribute, $parsed);
                    $HtmlAtt = array_merge($HtmlAtt, $parsed);
            }
        }

        if (isset($classes)) {
            $Data['class'] = implode(' ', $classes);
        }
        if (!empty($HtmlAtt)) {
            foreach ($HtmlAtt as $a => $v) {
                $Data[$a] = trim($v, '"');
            }
        }

        return $Data;
    }

    /**
     * Enhanced image block with <figure>/<figcaption>.
     */
    protected function blockImage($Line)
    {
        if (1 !== preg_match($this->MarkdownImageRegex, $Line['text'])) {
            return;
        }

        $InlineImage = $this->inlineImage($Line);
        if (!isset($InlineImage)) {
            return;
        }

        $block = $InlineImage;

        /*
        <figure>
            <picture>
                <source type="image/webp"
                    srcset="..."
                    sizes="..."
                >
                <img src="..."
                    srcset="..."
                    sizes="..."
                >
            </picture>
            <figcaption>...</figcaption>
        </figure>
        */

        // creates a <picture> element with a <source> (WebP) and an <img> element
        if ($this->builder->getConfig()->get('body.images.webp.enabled') ?? false && !Image::isAnimatedGif($InlineImage['element']['attributes']['src'])) {
            try {
                if (is_string($InlineImage['element']['attributes']['src'])) {
                    throw new RuntimeException(\sprintf('Asset "%s" can\'t be converted to WebP', $InlineImage['element']['attributes']['src']));
                }
                $assetWebp = Image::convertTopWebp($InlineImage['element']['attributes']['src'], $this->builder->getConfig()->get('assets.images.quality') ?? 75);
                $srcset = '';
                if ($this->builder->getConfig()->get('body.images.responsive.enabled')) {
                    $srcset = Image::buildSrcset(
                        $assetWebp,
                        $this->builder->getConfig()->get('assets.images.responsive.widths') ?? [480, 640, 768, 1024, 1366, 1600, 1920]
                    );
                }
                if (empty($srcset)) {
                    $srcset = (string) $assetWebp;
                }
                $PictureBlock = [
                    'element' => [
                        'name'    => 'picture',
                        'handler' => 'elements',
                    ],
                ];
                $source = [
                    'element' => [
                        'name'       => 'source',
                        'attributes' => [
                            'type'   => 'image/webp',
                            'srcset' => $srcset,
                            'sizes'  => $this->builder->getConfig()->get('assets.images.responsive.sizes.default'),
                        ],
                    ],
                ];
                $PictureBlock['element']['text'][] = $source['element'];
                $PictureBlock['element']['text'][] = $InlineImage['element'];
                $block = $PictureBlock;
            } catch (RuntimeException $e) {
                $this->builder->getLogger()->debug($e->getMessage());
            }
        }

        // put <img> (or <picture>) in a <figure> element if there is a title (<figcaption>)
        if (!empty($InlineImage['element']['attributes']['title'])) {
            $FigureBlock = [
                'element' => [
                    'name'    => 'figure',
                    'handler' => 'elements',
                    'text'    => [
                        $block['element'],
                    ],
                ],
            ];
            $InlineFigcaption = [
                'element' => [
                    'name' => 'figcaption',
                    'text' => $InlineImage['element']['attributes']['title'],
                ],
            ];
            $FigureBlock['element']['text'][] = $InlineFigcaption['element'];

            return $FigureBlock;
        }

        return $block;
    }

    /**
     * Note block-level markup.
     *
     * :::tip
     * **Tip:** This is an advice.
     * :::
     *
     * Code inspired by https://github.com/sixlive/parsedown-alert from TJ Miller (@sixlive).
     */
    protected function blockNote($block)
    {
        if (preg_match('/:::(.*)/', $block['text'], $matches)) {
            return [
                'char'    => ':',
                'element' => [
                    'name'       => 'aside',
                    'text'       => '',
                    'attributes' => [
                        'class' => "note note-{$matches[1]}",
                    ],
                ],
            ];
        }
    }

    protected function blockNoteContinue($line, $block)
    {
        if (isset($block['complete'])) {
            return;
        }
        if (preg_match('/:::/', $line['text'])) {
            $block['complete'] = true;

            return $block;
        }
        $block['element']['text'] .= $line['text']."\n";

        return $block;
    }

    protected function blockNoteComplete($block)
    {
        $block['element']['rawHtml'] = $this->text($block['element']['text']);
        unset($block['element']['text']);

        return $block;
    }

    /**
     * Removes query string from URL.
     */
    private function removeQuery(string $path): string
    {
        return strtok($path, '?');
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		/*
6		* This file is part of Cecil.
7		*
8		* Copyright (c) Arnaud Ligny <[email protected]>
9		*
10		* For the full copyright and license information, please view the LICENSE
11		* file that was distributed with this source code.
12		*/
13
14		namespace Cecil\Converter;
15
16		use Cecil\Assets\Asset;
17		use Cecil\Assets\Image;
18		use Cecil\Builder;
19		use Cecil\Exception\RuntimeException;
20		use Cecil\Util;
21
22		class Parsedown extends \ParsedownToC
23		{
24		/** @var Builder */
25		protected $builder;
26
27		/** {@inheritdoc} */
28	1	protected $regexAttribute = '(?:[#.][-\w:\\\]+[ ]\|[-\w:\\\]+(?:=(?:["\'][^\n]?["\']\|[^\s]+)?)?[ ]*)';
29
30	1	/** Regex to verify there is an image in <figure> block */
31	1	private $MarkdownImageRegex = "~^!\[.?\]\(.?\)~";
32
33		public function __construct(Builder $builder)
34	1	{
35	1	$this->builder = $builder;
36
37		// "insert" line block: ++text++ -> <ins>text</ins>
38		$this->InlineTypes['+'][] = 'Insert';
39		$this->inlineMarkerList = implode('', array_keys($this->InlineTypes));
40	1	$this->specialCharacters[] = '+';
41		// add caption to image block
42	1	if ($this->builder->getConfig()->get('body.images.caption.enabled')) {
43	1	$this->BlockTypes['!'][] = 'Image';
44		}
45		// "notes" block
46		if ($this->builder->getConfig()->get('body.notes.enabled')) {
47	1	$this->BlockTypes[':'][] = 'Note';
48		}
49	1
50		parent::__construct(['selectors' => $this->builder->getConfig()->get('body.toc')]);
51	1	}
52
53		/**
54	1	* Insert inline.
55		* e.g.: ++text++ -> <ins>text</ins>.
56		*/
57		protected function inlineInsert($Excerpt)
58	1	{
59	1	if (!isset($Excerpt['text'][1])) {
60		return;
61		}
62
63		if ($Excerpt['text'][1] === '+' && preg_match('/^\+\+(?=\S)(.+?)(?<=\S)\+\+/', $Excerpt['text'], $matches)) {
64	1	return [
65	1	'extent' => strlen($matches[0]),
66	1	'element' => [
67	1	'name' => 'ins',
68		'text' => $matches[1],
69	1	'handler' => 'line',
70		],
71		];
72	1	}
73		}
74
75		/**
76		* {@inheritdoc}
77		*/
78	1	protected function inlineImage($excerpt)
79		{
80		$image = parent::inlineImage($excerpt);
81	1	if (!isset($image)) {
82	1	return null;
83		}
84		// clean source path / URL
85	1	$image['element']['attributes']['src'] = trim($this->removeQuery($image['element']['attributes']['src']));
86	1	// should be lazy loaded?
87		if ($this->builder->getConfig()->get('body.images.lazy.enabled')) {
88		$image['element']['attributes']['loading'] = 'lazy';
89		}
90		// disable remote image handling
91	1	if (Util\Url::isUrl($image['element']['attributes']['src']) && !$this->builder->getConfig()->get('body.images.remote.enabled') ?? true) {
92	1	return $image;
93	1	}
94	1	// create asset
95	1	$asset = new Asset($this->builder, $image['element']['attributes']['src'], ['force_slash' => false]);
96	1	// get width
97		$width = $asset->getWidth();
98	1	$image['element']['attributes']['src'] = $asset;
99	1	/**
100		* Should be resized?
101		*/
102		$assetResized = null;
103	1	if (isset($image['element']['attributes']['width'])
104		&& (int) $image['element']['attributes']['width'] < $width
105		&& $this->builder->getConfig()->get('body.images.resize.enabled')
106		) {
107		$width = (int) $image['element']['attributes']['width'];
108
109	1	try {
110		$assetResized = $asset->resize($width);
111	1	} catch (\Exception $e) {
112	1	$this->builder->getLogger()->debug($e->getMessage());
113	1
114		return $image;
115	1	}
116	1	$image['element']['attributes']['src'] = $assetResized;
117	1	}
118		// set width
119		if (!isset($image['element']['attributes']['width'])) {
120	1	$image['element']['attributes']['width'] = $width;
121		}
122		// set height
123		if (!isset($image['element']['attributes']['height'])) {
124	1	$image['element']['attributes']['height'] = ($assetResized ?? $asset)->getHeight();
125	1	}
126		/**
127		* Should be responsive?
128		*/
129	1	if ($this->builder->getConfig()->get('body.images.responsive.enabled')) {
130		if ($srcset = Image::buildSrcset(
131		$assetResized ?? $asset,
132	1	$this->builder->getConfig()->get('assets.images.responsive.widths') ?? [480, 640, 768, 1024, 1366, 1600, 1920]
133	1	)) {
134	1	$image['element']['attributes']['srcset'] = $srcset;
135		$image['element']['attributes']['sizes'] = $this->builder->getConfig()->get('assets.images.responsive.sizes.default');
136		}
137		}
138	1
139		return $image;
140		}
141
142		/**
143		* {@inheritdoc}
144		*/
145		protected function parseAttributeData($attributeString)
146		{
147		$attributes = preg_split('/[ ]+/', $attributeString, -1, PREG_SPLIT_NO_EMPTY);
148		$Data = [];
149		$HtmlAtt = [];
150
151		foreach ($attributes as $attribute) {
152		switch ($attribute[0]) {
153		case '#': // ID
154		$Data['id'] = substr($attribute, 1);
155		break;
156		case '.': // Classes
157		$classes[] = substr($attribute, 1);
158		break;
159		default: // Attributes
160		parse_str($attribute, $parsed);
161		$HtmlAtt = array_merge($HtmlAtt, $parsed);
162		}
163		}
164
165		if (isset($classes)) {
166		$Data['class'] = implode(' ', $classes);
167		}
168		if (!empty($HtmlAtt)) {
169		foreach ($HtmlAtt as $a => $v) {
170		$Data[$a] = trim($v, '"');
171		}
172		}
173
174		return $Data;
175		}
176
177		/**
178		* Enhanced image block with <figure>/<figcaption>.
179		*/
180		protected function blockImage($Line)
181		{
182		if (1 !== preg_match($this->MarkdownImageRegex, $Line['text'])) {
183		return;
184		}
185
186		$InlineImage = $this->inlineImage($Line);
187		if (!isset($InlineImage)) {
188		return;
189		}
190
191		$block = $InlineImage;
192
193		/*
194		<figure>
195		<picture>
196		<source type="image/webp"
197		srcset="..."
198		sizes="..."
199		>
200		<img src="..."
201		srcset="..."
202		sizes="..."
203		>
204		</picture>
205		<figcaption>...</figcaption>
206		</figure>
207		*/
208
209		// creates a <picture> element with a <source> (WebP) and an <img> element
210		if ($this->builder->getConfig()->get('body.images.webp.enabled') ?? false && !Image::isAnimatedGif($InlineImage['element']['attributes']['src'])) {
211		try {
212		if (is_string($InlineImage['element']['attributes']['src'])) {
213		throw new RuntimeException(\sprintf('Asset "%s" can\'t be converted to WebP', $InlineImage['element']['attributes']['src']));
214		}
215		$assetWebp = Image::convertTopWebp($InlineImage['element']['attributes']['src'], $this->builder->getConfig()->get('assets.images.quality') ?? 75);
216		$srcset = '';
217		if ($this->builder->getConfig()->get('body.images.responsive.enabled')) {
218		$srcset = Image::buildSrcset(
219		$assetWebp,
220		$this->builder->getConfig()->get('assets.images.responsive.widths') ?? [480, 640, 768, 1024, 1366, 1600, 1920]
221		);
222		}
223		if (empty($srcset)) {
224		$srcset = (string) $assetWebp;
225		}
226		$PictureBlock = [
227		'element' => [
228		'name' => 'picture',
229		'handler' => 'elements',
230		],
231		];
232		$source = [
233		'element' => [
234	1	'name' => 'source',
235		'attributes' => [
236	1	'type' => 'image/webp',
237		'srcset' => $srcset,
238		'sizes' => $this->builder->getConfig()->get('assets.images.responsive.sizes.default'),
239		],
240		],
241		];
242		$PictureBlock['element']['text'][] = $source['element'];
243		$PictureBlock['element']['text'][] = $InlineImage['element'];
244		$block = $PictureBlock;
245		} catch (RuntimeException $e) {
246		$this->builder->getLogger()->debug($e->getMessage());
247		}
248		}
249
250		// put <img> (or <picture>) in a <figure> element if there is a title (<figcaption>)
251		if (!empty($InlineImage['element']['attributes']['title'])) {
252		$FigureBlock = [
253		'element' => [
254		'name' => 'figure',
255		'handler' => 'elements',
256		'text' => [
257		$block['element'],
258		],
259		],
260		];
261		$InlineFigcaption = [
262		'element' => [
263		'name' => 'figcaption',
264		'text' => $InlineImage['element']['attributes']['title'],
265		],
266		];
267		$FigureBlock['element']['text'][] = $InlineFigcaption['element'];
268
269		return $FigureBlock;
270		}
271
272		return $block;
273		}
274
275		/**
276		* Note block-level markup.
277		*
278		* :::tip
279		* Tip: This is an advice.
280		* :::
281		*
282		* Code inspired by https://github.com/sixlive/parsedown-alert from TJ Miller (@sixlive).
283		*/
284		protected function blockNote($block)
285		{
286		if (preg_match('/:::(.*)/', $block['text'], $matches)) {
287		return [
288		'char' => ':',
289		'element' => [
290		'name' => 'aside',
291		'text' => '',
292		'attributes' => [
293		'class' => "note note-{$matches[1]}",
294		],
295		],
296		];
297		}
298		}
299
300		protected function blockNoteContinue($line, $block)
301		{
302		if (isset($block['complete'])) {
303		return;
304		}
305		if (preg_match('/:::/', $line['text'])) {
306		$block['complete'] = true;
307
308		return $block;
309		}
310		$block['element']['text'] .= $line['text']."\n";
311
312		return $block;
313		}
314
315		protected function blockNoteComplete($block)
316		{
317		$block['element']['rawHtml'] = $this->text($block['element']['text']);
318		unset($block['element']['text']);
319
320		return $block;
321		}
322
323		/**
324		* Removes query string from URL.
325		*/
326		private function removeQuery(string $path): string
327		{
328		return strtok($path, '?');
329		}
330		}
331

Cecilapp / Cecil

Push — fix/serve-timeout ( 697f77...233bc8 )

Parsedown::blockNote() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like