PointParser::doAnchors() - Code Metrics - Inspection of "Very important whitespace fix." - skobkin/point-tools - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 88105a...84be9d )

by Alexey

created 2016-12-12 16:58 UTC

PointParser::doAnchors() B

↳ Parent: PointParser

Complexity

Conditions	4
Paths	5

Size

Total Lines	48
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	14
CRAP Score	4.0047

Importance

Changes

Metric	Value
dl	0
loc	48
ccs	14
cts	15
cp	0.9333
rs	8.7396
c	0
b	0
f	0
cc	4
eloc	13
nc	5
nop	1
crap	4.0047

<?php

namespace Skobkin\Bundle\PointToolsBundle\Service\Markdown;

use Knp\Bundle\MarkdownBundle\Parser\MarkdownParser;
use Symfony\Component\Routing\RouterInterface;

class PointParser extends MarkdownParser
{
    /**
     * @var RouterInterface
     */
    protected $router;

    /**
     * {@inheritdoc}
     */
    protected $features = array(
        'header' => true,
        'list' => true,
        'horizontal_rule' => true,
        'table' => false,
        'foot_note' => true,
        'fenced_code_block' => true,
        'abbreviation' => true,
        'definition_list' => true,
        'inline_link' => true, // [link text](url "optional title")

        'reference_link' => true, // [link text] [id]

        'shortcut_link' => true, // [link text]
        'images' => true,
        'block_quote' => true,
        'code_block' => true,
        'html_block' => false,
        'auto_link' => true,
        'auto_mailto' => true,
        'entities' => true,
        'no_html' => true,
        'point_usernames' => true, // @user
        'point_posts' => true, // #post
        'point_tags' => false, // @todo implement
        'point_inline_images' => true, // https://i.skobk.in/i/facepalm.jpg
    );

    public function __construct(array $features, RouterInterface $router)
    {
        $this->router = $router;

        parent::__construct($features);
    }

    /**
     * Point.im breaks Markdown rule about quotation on next line
     *
     * @param $text
     *
     * @return mixed
     */
    protected function doBlockQuotes($text) {
        $text = preg_replace_callback('/
              (               # Wrap whole match in $1
                (?>
                  ^[ ]*>[ ]?  # ">" at the start of a line
                    .+\n      # rest of the first line
                  \n*         # blanks
                )+
              )
            /xm',
            array($this, '_doBlockQuotes_callback'), $text
        );

        return $text;
    }

    /**
     * Point.im breaks Markdown double line wrap rule
     * {@inheritdoc}
     */
    protected function formParagraphs($text, $wrap_in_p = true) {
        // Strip leading and trailing lines:
        $text = preg_replace('/\A\n+|\n+\z/', '', $text);

        $grafs = preg_split('/\n+/', $text, -1, PREG_SPLIT_NO_EMPTY);

        // Wrap <p> tags and unhashify HTML blocks
        foreach ($grafs as $key => $value) {
            if (!preg_match('/^B\x1A[0-9]+B$/', $value)) {
                // Is a paragraph.
                $value = $this->runSpanGamut($value);
                if ($wrap_in_p) {
                    $value = preg_replace('/^([ ]*)/', "<p>", $value);
                    $value .= "</p>";
                }
                $grafs[$key] = $this->unhash($value);
            } else {
                // Is a block.
                // Modify elements of @grafs in-place...
                $graf = $value;
                $block = $this->html_hashes[$graf];
                $graf = $block;
                $grafs[$key] = $graf;
            }
        }

        return implode("\n\n", $grafs);
    }

    /**
     * @param string $text
     *
     * @return string
     */
    public function doAutoLinks($text)
    {
        if ($this->features['point_inline_images']) {
            return preg_replace_callback('{((https?):\/\/[^\'">\s]+\.(jpg|jpeg|png|gif))}i', array(&$this, 'doAutoLinksInlineImageCallback'), $text);
        }

        return parent::doAutoLinks($text);
    }

    public function doAnchors($text)
    {
        $text = parent::doAnchors($text);

        #
        # Turn Markdown link shortcuts into XHTML <a> tags.
        #
        if ($this->in_anchor) {
            return $text;
        }
        $this->in_anchor = true;

        #
        # Handling username links: @some-point-username
        #
        if ($this->features['point_usernames']) {
            $text = preg_replace_callback('{
                (               # wrap whole match in $1
                  @
                    (
                        [a-zA-Z0-9\-]+? # username = $2
                    )
                )
                ([^a-zA-Z0-9\-]|$) # Tail of username
                }xs',
                array(&$this, 'doAnchorsPointUsernameCallback'), $text);
        }

        #
        # Handling post links: #somepost
        #
        if ($this->features['point_posts']) {
            $text = preg_replace_callback('{
                (               # wrap whole match in $1
                  \#
                    (
                        [a-zA-Z]+? # post id = $2
                    )
                )
                ([^a-zA-Z]|$) # Tail of post
                }xs',
                array(&$this, 'doAnchorsPointPostCallback'), $text);
        }

        $this->in_anchor = false;

        return $text;
    }

    protected function doAutoLinksInlineImageCallback($matches)
    {
        $url = trim($matches[1]);
        $ext = $matches[2];

        return $this->hashPart('<a href="'.$url.'" class="post-image '
            .('gif' === $ext ? ' img-gif':'').'"><img src="'.$url.'" class="img-thumbnail" alt="Inline image"></a>');
    }

    protected function doAnchorsPointUsernameCallback($matches)

    {
        //$wholeMatch = $matches[1];

        $username = $matches[2];
        $href = $this->router->generate('user_show', ['login' => $username]);
        $tail = htmlspecialchars($matches[3]);
        
        return $this->hashPart('<a href="'.$href.'" class="user">@'.$username.'</a>'.$tail);
    }

    protected function doAnchorsPointPostCallback($matches)

    {
        //$wholeMatch = $matches[1];

        $postId = $matches[2];
        $href = $this->router->generate('post_show', ['id' => $postId]);
        $tail = htmlspecialchars($matches[3]);

        return $this->hashPart(
            '<a href="'.$href.'" class="post">#'.$postId.'</a>'
            //.'<a href="https://point.im/'.$postId.'"><span class="glyphicon glyphicon-link"></span></a>'

            .$tail
        );
    }
}

1			<?php
2
3			namespace Skobkin\Bundle\PointToolsBundle\Service\Markdown;
4
5			use Knp\Bundle\MarkdownBundle\Parser\MarkdownParser;
6			use Symfony\Component\Routing\RouterInterface;
7
8			class PointParser extends MarkdownParser
9			{
10			/**
11			* @var RouterInterface
12			*/
13			protected $router;
14
15			/**
16			* {@inheritdoc}
17			*/
18			protected $features = array(
19			'header' => true,
20			'list' => true,
21			'horizontal_rule' => true,
22			'table' => false,
23			'foot_note' => true,
24			'fenced_code_block' => true,
25			'abbreviation' => true,
26			'definition_list' => true,
27			'inline_link' => true, // [link text](url "optional title")
			1 ignored issue – show Unused Code Comprehensibility introduced 2016-12-11 04:16 UTC by Report Bug Copy Issue Report `46%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
28			'reference_link' => true, // [link text] [id]
			1 ignored issue – show Unused Code Comprehensibility introduced 2016-12-11 04:16 UTC by Report Bug Copy Issue Report `40%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
29			'shortcut_link' => true, // [link text]
30			'images' => true,
31			'block_quote' => true,
32			'code_block' => true,
33			'html_block' => false,
34			'auto_link' => true,
35			'auto_mailto' => true,
36			'entities' => true,
37			'no_html' => true,
38			'point_usernames' => true, // @user
39			'point_posts' => true, // #post
40			'point_tags' => false, // @todo implement
41			'point_inline_images' => true, // https://i.skobk.in/i/facepalm.jpg
42			);
43
44	12		public function __construct(array $features, RouterInterface $router)
45			{
46	12		$this->router = $router;
47
48	12		parent::__construct($features);
49	12		}
50
51			/**
52			* Point.im breaks Markdown rule about quotation on next line
53			*
54			* @param $text
55			*
56			* @return mixed
57			*/
58	1		protected function doBlockQuotes($text) {
59	1		$text = preg_replace_callback('/
60			( # Wrap whole match in $1
61			(?>
62			^[ ]*>[ ]? # ">" at the start of a line
63			.+\n # rest of the first line
64			\n* # blanks
65			)+
66			)
67	1		/xm',
68	1		array($this, '_doBlockQuotes_callback'), $text
69			);
70
71	1		return $text;
72			}
73
74			/**
75			* Point.im breaks Markdown double line wrap rule
76			* {@inheritdoc}
77			*/
78	1		protected function formParagraphs($text, $wrap_in_p = true) {
79			// Strip leading and trailing lines:
80	1		$text = preg_replace('/\A\n+\|\n+\z/', '', $text);
81
82	1		$grafs = preg_split('/\n+/', $text, -1, PREG_SPLIT_NO_EMPTY);
83
84			// Wrap <p> tags and unhashify HTML blocks
85	1		foreach ($grafs as $key => $value) {
86	1		if (!preg_match('/^B\x1A[0-9]+B$/', $value)) {
87			// Is a paragraph.
88	1		$value = $this->runSpanGamut($value);
89	1		if ($wrap_in_p) {
90	1		$value = preg_replace('/^([ ]*)/', "<p>", $value);
91	1		$value .= "</p>";
92			}
93	1		$grafs[$key] = $this->unhash($value);
94			} else {
95			// Is a block.
96			// Modify elements of @grafs in-place...
97			$graf = $value;
98			$block = $this->html_hashes[$graf];
99			$graf = $block;
100	1		$grafs[$key] = $graf;
101			}
102			}
103
104	1		return implode("\n\n", $grafs);
105			}
106
107			/**
108			* @param string $text
109			*
110			* @return string
111			*/
112	1		public function doAutoLinks($text)
113			{
114	1		if ($this->features['point_inline_images']) {
115	1		return preg_replace_callback('{((https?):\/\/[^\'">\s]+\.(jpg\|jpeg\|png\|gif))}i', array(&$this, 'doAutoLinksInlineImageCallback'), $text);
116			}
117
118			return parent::doAutoLinks($text);
119			}
120
121	1		public function doAnchors($text)
122			{
123	1		$text = parent::doAnchors($text);
124
125			#
126			# Turn Markdown link shortcuts into XHTML <a> tags.
127			#
128	1		if ($this->in_anchor) {
129			return $text;
130			}
131	1		$this->in_anchor = true;
132
133			#
134			# Handling username links: @some-point-username
135			#
136	1		if ($this->features['point_usernames']) {
137	1		$text = preg_replace_callback('{
138			( # wrap whole match in $1
139			@
140			(
141			[a-zA-Z0-9\-]+? # username = $2
142			)
143			)
144			([^a-zA-Z0-9\-]\|$) # Tail of username
145	1		}xs',
146	1		array(&$this, 'doAnchorsPointUsernameCallback'), $text);
147			}
148
149			#
150			# Handling post links: #somepost
151			#
152	1		if ($this->features['point_posts']) {
153	1		$text = preg_replace_callback('{
154			( # wrap whole match in $1
155			\#
156			(
157			[a-zA-Z]+? # post id = $2
158			)
159			)
160			([^a-zA-Z]\|$) # Tail of post
161	1		}xs',
162	1		array(&$this, 'doAnchorsPointPostCallback'), $text);
163			}
164
165	1		$this->in_anchor = false;
166
167	1		return $text;
168			}
169
170			protected function doAutoLinksInlineImageCallback($matches)
171			{
172			$url = trim($matches[1]);
173			$ext = $matches[2];
174
175			return $this->hashPart('<a href="'.$url.'" class="post-image '
176			.('gif' === $ext ? ' img-gif':'').'"><img src="'.$url.'" class="img-thumbnail" alt="Inline image"></a>');
177			}
178
179		View Code Duplication	protected function doAnchorsPointUsernameCallback($matches)
			0 ignored issues – show Duplication introduced 2016-12-11 04:16 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
180			{
181			//$wholeMatch = $matches[1];
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-12-11 04:16 UTC by Report Bug Copy Issue Report `67%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
182			$username = $matches[2];
183			$href = $this->router->generate('user_show', ['login' => $username]);
184			$tail = htmlspecialchars($matches[3]);
185
186			return $this->hashPart('<a href="'.$href.'" class="user">@'.$username.'</a>'.$tail);
187			}
188
189		View Code Duplication	protected function doAnchorsPointPostCallback($matches)
			0 ignored issues – show Duplication introduced 2016-12-11 04:16 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
190			{
191			//$wholeMatch = $matches[1];
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-12-11 04:16 UTC by Report Bug Copy Issue Report `67%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
192			$postId = $matches[2];
193			$href = $this->router->generate('post_show', ['id' => $postId]);
194			$tail = htmlspecialchars($matches[3]);
195
196			return $this->hashPart(
197			'<a href="'.$href.'" class="post">#'.$postId.'</a>'
198			//.'<a href="https://point.im/'.$postId.'"><span class="glyphicon glyphicon-link"></span></a>'
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-12-11 04:16 UTC by Report Bug Copy Issue Report `50%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
199			.$tail
200			);
201			}
202			}

skobkin / point-tools

Push — master ( 88105a...84be9d )

PointParser::doAnchors() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like