MarkdownConverter::generateHeaderId() - Code Metrics - Inspection of "Merge pull request #6 from Symplify/php7-coverage" - Symplify/PHP7_Sculpin - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 91bd08...d24b22 )

by Tomáš

created 2016-09-21 15:39 UTC

MarkdownConverter::generateHeaderId() B

↳ Parent: MarkdownConverter

Complexity

Conditions	1
Paths	1

Size

Total Lines	35
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	35
ccs	0
cts	22
cp	0
rs	8.8571
c	0
b	0
f	0
cc	1
eloc	12
nc	1
nop	1
crap	2

<?php

/*
 * This file is a part of Sculpin.
 *
 * (c) Dragonfly Development Inc.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Symplify\PHP7_Sculpin\Bundle\MarkdownBundle;

use Symplify\PHP7_Sculpin\Core\Converter\SourceConverterContext;
use Symplify\PHP7_Sculpin\Core\Converter\ConverterInterface;
use Symplify\PHP7_Sculpin\Core\Converter\ParserInterface;

final class MarkdownConverter implements ConverterInterface
{
    /**
     * @var ParserInterface
     */
    private $markdown;

    public function __construct(ParserInterface $markdown)
    {
        $this->markdown = $markdown;
        $this->markdown->header_id_func = [$this, 'generateHeaderId'];
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
    }

    /**
     * {@inheritdoc}
     */
    public function convert(SourceConverterContext $converterContext)
    {
        $converterContext->setContent(
            $this->markdown->transform(
                $converterContext->content()
            )
        );
    }

    /**
     * This method is called to generate an id="" attribute for a header.
     */
    public function generateHeaderId(string $headerText) : string
    {
        // $headerText is completely raw markdown input. We need to strip it
        // from all markup, because we are only interested in the actual 'text'
        // part of it.

        // Step 1: Remove html tags.
        $result = strip_tags($headerText);

        // Step 2: Remove all markdown links. To do this, we simply remove
        // everything between ( and ) if the ( occurs right after a ].
        $result = preg_replace('%
            (?<= \\]) # Look behind to find ]
            (
                \\(     # match (
                [^\\)]* # match everything except )
                \\)     # match )
            )

            %x', '', $result);

        // Step 3: Convert spaces to dashes, and remove unwanted special
        // characters.
        $map = [
            ' ' => '-',
            '(' => '',
            ')' => '',
            '[' => '',
            ']' => '',
        ];

        return rawurlencode(strtolower(
            strtr($result, $map)
        ));
    }
}


1			<?php
2
3			/*
4			* This file is a part of Sculpin.
5			*
6			* (c) Dragonfly Development Inc.
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace Symplify\PHP7_Sculpin\Bundle\MarkdownBundle;
13
14			use Symplify\PHP7_Sculpin\Core\Converter\SourceConverterContext;
15			use Symplify\PHP7_Sculpin\Core\Converter\ConverterInterface;
16			use Symplify\PHP7_Sculpin\Core\Converter\ParserInterface;
17
18			final class MarkdownConverter implements ConverterInterface
19			{
20			/**
21			* @var ParserInterface
22			*/
23			private $markdown;
24
25			public function __construct(ParserInterface $markdown)
26			{
27			$this->markdown = $markdown;
28			$this->markdown->header_id_func = [$this, 'generateHeaderId'];
			0 ignored issues – show Bug introduced 2016-09-21 14:36 UTC by Report Bug Copy Issue Report Accessing `header_id_func` on the interface `Symplify\PHP7_Sculpin\Co...nverter\ParserInterface` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
29			}
30
31			/**
32			* {@inheritdoc}
33			*/
34			public function convert(SourceConverterContext $converterContext)
35			{
36			$converterContext->setContent(
37			$this->markdown->transform(
38			$converterContext->content()
39			)
40			);
41			}
42
43			/**
44			* This method is called to generate an id="" attribute for a header.
45			*/
46			public function generateHeaderId(string $headerText) : string
47			{
48			// $headerText is completely raw markdown input. We need to strip it
49			// from all markup, because we are only interested in the actual 'text'
50			// part of it.
51
52			// Step 1: Remove html tags.
53			$result = strip_tags($headerText);
54
55			// Step 2: Remove all markdown links. To do this, we simply remove
56			// everything between ( and ) if the ( occurs right after a ].
57			$result = preg_replace('%
58			(?<= \\]) # Look behind to find ]
59			(
60			\\( # match (
61			[^\\)]* # match everything except )
62			\\) # match )
63			)
64
65			%x', '', $result);
66
67			// Step 3: Convert spaces to dashes, and remove unwanted special
68			// characters.
69			$map = [
70			' ' => '-',
71			'(' => '',
72			')' => '',
73			'[' => '',
74			']' => '',
75			];
76
77			return rawurlencode(strtolower(
78			strtr($result, $map)
79			));
80			}
81			}
82

Symplify / PHP7_Sculpin

Push — master ( 91bd08...d24b22 )

MarkdownConverter::generateHeaderId() B

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like