Parsedown::blockImage() - Code Metrics - Inspection of "Apply fixes from StyleCI" - Cecilapp/Cecil - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — analysis-M1kQmj ( 05e4b4 )

by Arnaud

created 2022-05-23 20:49 UTC

Parsedown::blockImage() B

↳ Parent: Parsedown

Complexity

Conditions	9
Paths	12

Size

Total Lines	86
Code Lines	43

Duplication

Lines	0
Ratio	0 %

Importance

Changes	3
Bugs	1	Features	0

Metric	Value
cc	9
eloc	43
c	3
b	1
f	0
nc	12
nop	1
dl	0
loc	86
rs	7.6764

How to fix Long Method

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

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] === '+' and 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 image handling
        if (!$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'] = $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.remote.enabled') ?? true) && ($this->builder->getConfig()->get('body.images.webp.enabled') ?? false) && !Image::isAnimatedGif($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;
        }

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

Cecilapp / Cecil

Push — analysis-M1kQmj ( 05e4b4 )

Parsedown::blockImage() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like