Parsedown::blockImage() - Code Metrics - Inspection of "chore: enhances code" - Cecilapp/Cecil - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — chore ( 2f9919 )

by Arnaud

created 2021-12-01 00:50 UTC

Parsedown::blockImage() B

↳ Parent: Parsedown

Complexity

Conditions	6
Paths	8

Size

Total Lines	85
Code Lines	43

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	1	Features	0

Metric	Value
cc	6
eloc	43
c	2
b	1
f	0
nc	8
nop	1
dl	0
loc	85
rs	8.6097

How to fix Long Method

<?php
/**
 * This file is part of the Cecil/Cecil package.
 *
 * 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;
        if ($this->builder->getConfig()->get('body.images.caption.enabled')) {
            $this->BlockTypes['!'][] = 'Image';
        }
        parent::__construct(['selectors' => $this->builder->getConfig()->get('body.toc')]);
    }

    /**
     * {@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']));
        // create asset
        $asset = new Asset($this->builder, $image['element']['attributes']['src']);
        // is asset is valid? (if yes get width)
        if (false === $width = $asset->getWidth()) {
            return $image;
        }
        $image['element']['attributes']['src'] = $asset;
        /**
         * Should be lazy loaded?
         */
        if ($this->builder->getConfig()->get('body.images.lazy.enabled')) {
            $image['element']['attributes']['loading'] = 'lazy';
        }
        /**
         * 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::getSrcset(
                $assetResized ?? $asset,
                $this->builder->getConfig()->get('assets.images.responsive.width.steps') ?? 5,
                $this->builder->getConfig()->get('assets.images.responsive.width.min') ?? 320,
                $this->builder->getConfig()->get('assets.images.responsive.width.max') ?? 1280
            )) {
                $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 <source> and <img> elements
        if ($this->builder->getConfig()->get('body.images.webp.enabled') ?? false) {
            $assetWebp = Image::convertTopWebp($InlineImage['element']['attributes']['src'], $this->builder->getConfig()->get('assets.images.quality') ?? 85);
            $srcset = Image::getSrcset(
                $assetWebp,
                $this->builder->getConfig()->get('assets.images.responsive.width.steps') ?? 5,
                $this->builder->getConfig()->get('assets.images.responsive.width.min') ?? 320,
                $this->builder->getConfig()->get('assets.images.responsive.width.max') ?? 1280
            );
            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
        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;
    }

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


1			<?php
2			/**
3			* This file is part of the Cecil/Cecil package.
4			*
5			* Copyright (c) Arnaud Ligny <[email protected]>
6			*
7			* For the full copyright and license information, please view the LICENSE
8			* file that was distributed with this source code.
9			*/
10
11			namespace Cecil\Converter;
12
13			use Cecil\Assets\Asset;
14			use Cecil\Assets\Image;
15			use Cecil\Builder;
16
17			class Parsedown extends \ParsedownToC
18			{
19			/** @var Builder */
20			protected $builder;
21
22			/** {@inheritdoc} */
23			protected $regexAttribute = '(?:[#.][-\w:\\\]+[ ]\|[-\w:\\\]+(?:=(?:["\'][^\n]?["\']\|[^\s]+)?)?[ ]*)';
24
25			/** Regex to verify there is an image in <figure> block */
26			private $MarkdownImageRegex = "~^!\[.?\]\(.?\)~";
27
28			public function __construct(Builder $builder)
29			{
30			$this->builder = $builder;
31			if ($this->builder->getConfig()->get('body.images.caption.enabled')) {
32			$this->BlockTypes['!'][] = 'Image';
33			}
34			parent::__construct(['selectors' => $this->builder->getConfig()->get('body.toc')]);
35			}
36
37			/**
38			* {@inheritdoc}
39			*/
40			protected function inlineImage($excerpt)
41			{
42			$image = parent::inlineImage($excerpt);
43			if (!isset($image)) {
44			return null;
45			}
46			// clean source path / URL
47			$image['element']['attributes']['src'] = trim($this->removeQuery($image['element']['attributes']['src']));
48			// create asset
49			$asset = new Asset($this->builder, $image['element']['attributes']['src']);
50			// is asset is valid? (if yes get width)
51			if (false === $width = $asset->getWidth()) {
52			return $image;
53			}
54			$image['element']['attributes']['src'] = $asset;
55			/**
56			* Should be lazy loaded?
57			*/
58			if ($this->builder->getConfig()->get('body.images.lazy.enabled')) {
59			$image['element']['attributes']['loading'] = 'lazy';
60			}
61			/**
62			* Should be resized?
63			*/
64			$assetResized = null;
65			if (isset($image['element']['attributes']['width'])
66			&& (int) $image['element']['attributes']['width'] < $width
67			&& $this->builder->getConfig()->get('body.images.resize.enabled')
68			) {
69			$width = (int) $image['element']['attributes']['width'];
70
71			try {
72			$assetResized = $asset->resize($width);
73			} catch (\Exception $e) {
74			$this->builder->getLogger()->debug($e->getMessage());
75
76			return $image;
77			}
78			$image['element']['attributes']['src'] = $assetResized;
79			}
80			// set width
81			if (!isset($image['element']['attributes']['width'])) {
82			$image['element']['attributes']['width'] = $width;
83			}
84			// set height
85			if (!isset($image['element']['attributes']['height'])) {
86			$image['element']['attributes']['height'] = $asset->getHeight();
87			}
88			/**
89			* Should be responsive?
90			*/
91			if ($this->builder->getConfig()->get('body.images.responsive.enabled')) {
92			if ($srcset = Image::getSrcset(
93			$assetResized ?? $asset,
94			$this->builder->getConfig()->get('assets.images.responsive.width.steps') ?? 5,
95			$this->builder->getConfig()->get('assets.images.responsive.width.min') ?? 320,
96			$this->builder->getConfig()->get('assets.images.responsive.width.max') ?? 1280
97			)) {
98			$image['element']['attributes']['srcset'] = $srcset;
99			$image['element']['attributes']['sizes'] = $this->builder->getConfig()->get('assets.images.responsive.sizes.default');
100			}
101			}
102
103			return $image;
104			}
105
106			/**
107			* {@inheritdoc}
108			*/
109			protected function parseAttributeData($attributeString)
110			{
111			$attributes = preg_split('/[ ]+/', $attributeString, -1, PREG_SPLIT_NO_EMPTY);
112			$Data = [];
113			$HtmlAtt = [];
114
115			foreach ($attributes as $attribute) {
116			switch ($attribute[0]) {
117			case '#': // ID
118			$Data['id'] = substr($attribute, 1);
119			break;
120			case '.': // Classes
121			$classes[] = substr($attribute, 1);
122			break;
123			default: // Attributes
124			parse_str($attribute, $parsed);
125			$HtmlAtt = array_merge($HtmlAtt, $parsed);
126			}
127			}
128
129			if (isset($classes)) {
130			$Data['class'] = implode(' ', $classes);
131			}
132			if (!empty($HtmlAtt)) {
133			foreach ($HtmlAtt as $a => $v) {
134			$Data[$a] = trim($v, '"');
135			}
136			}
137
138			return $Data;
139			}
140
141			/**
142			* Enhanced image block with <figure>/<figcaption>.
143			*/
144			protected function blockImage($Line)
145			{
146			if (1 !== preg_match($this->MarkdownImageRegex, $Line['text'])) {
147			return;
148			}
149
150			$InlineImage = $this->inlineImage($Line);
151			if (!isset($InlineImage)) {
152			return;
153			}
154
155			$block = $InlineImage;
156
157			/*
158			<figure>
159			<picture>
160			<source type="image/webp"
161			srcset="..."
162			sizes="..."
163			>
164			<img src="..."
165			srcset="..."
166			sizes="..."
167			>
168			</picture>
169			<figcaption>...</figcaption>
170			</figure>
171			*/
172
173			// creates a <picture> element with <source> and <img> elements
174			if ($this->builder->getConfig()->get('body.images.webp.enabled') ?? false) {
175			$assetWebp = Image::convertTopWebp($InlineImage['element']['attributes']['src'], $this->builder->getConfig()->get('assets.images.quality') ?? 85);
176			$srcset = Image::getSrcset(
177			$assetWebp,
178			$this->builder->getConfig()->get('assets.images.responsive.width.steps') ?? 5,
179			$this->builder->getConfig()->get('assets.images.responsive.width.min') ?? 320,
180			$this->builder->getConfig()->get('assets.images.responsive.width.max') ?? 1280
181			);
182			if (empty($srcset)) {
183			$srcset = (string) $assetWebp;
184			}
185			$PictureBlock = [
186			'element' => [
187			'name' => 'picture',
188			'handler' => 'elements',
189			],
190			];
191			$source = [
192			'element' => [
193			'name' => 'source',
194			'attributes' => [
195			'type' => 'image/webp',
196			'srcset' => $srcset,
197			'sizes' => $this->builder->getConfig()->get('assets.images.responsive.sizes.default'),
198			],
199			],
200			];
201			$PictureBlock['element']['text'][] = $source['element'];
202			$PictureBlock['element']['text'][] = $InlineImage['element'];
203			$block = $PictureBlock;
204			}
205
206			// put <img> or <picture> in a <figure> element if there is a title
207			if (!empty($InlineImage['element']['attributes']['title'])) {
208			$FigureBlock = [
209			'element' => [
210			'name' => 'figure',
211			'handler' => 'elements',
212			'text' => [
213			$block['element'],
214			],
215			],
216			];
217			$InlineFigcaption = [
218			'element' => [
219			'name' => 'figcaption',
220			'text' => $InlineImage['element']['attributes']['title'],
221			],
222			];
223			$FigureBlock['element']['text'][] = $InlineFigcaption['element'];
224
225			return $FigureBlock;
226			}
227
228			return $block;
229			}
230
231			/**
232			* Removes query string from URL.
233			*/
234			private function removeQuery(string $path): string
235			{
236			return strtok($path, '?');
237			}
238			}
239

Cecilapp / Cecil

Push — chore ( 2f9919 )

Parsedown::blockImage() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like