TableParser::addLine() - Code Metrics - Inspection of "Refactor the parser implementation" - thephpleague/commonmark - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — refactor-parsing ( adbb6b...fbe6de )

by Colin

created 2020-05-03 14:10 UTC

TableParser::addLine() A

↳ Parent: TableParser

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	2

Importance

Changes

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

<?php

declare(strict_types=1);

/*
 * This is part of the league/commonmark package.
 *
 * (c) Martin Hasoň <[email protected]>
 * (c) Webuni s.r.o. <[email protected]>
 * (c) Colin O'Dell <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace League\CommonMark\Extension\Table;

use League\CommonMark\Node\Block\AbstractBlock;
use League\CommonMark\Parser\Block\AbstractBlockContinueParser;
use League\CommonMark\Parser\Block\BlockContinue;
use League\CommonMark\Parser\Block\BlockContinueParserInterface;
use League\CommonMark\Parser\Cursor;
use League\CommonMark\Parser\InlineParserEngineInterface;
use League\CommonMark\Util\ArrayCollection;

final class TableParser extends AbstractBlockContinueParser
{
    /** @var Table */
    private $block;

    /** @var ArrayCollection<int, string> */
    private $bodyLines;

    /** @var array<int, string> */
    private $columns;

    /** @var array<int, string> */
    private $headerCells;

    /** @var bool */
    private $nextIsSeparatorLine = true;

    /**
     * TableParser constructor.
     *
     * @param array<int, string> $columns
     * @param array<int, string> $headerCells
     */
    public function __construct(array $columns, array $headerCells)
    {
        $this->block = new Table();
        $this->bodyLines = new ArrayCollection();
        $this->columns = $columns;
        $this->headerCells = $headerCells;
    }

    public function canHaveLazyContinuationLines(): bool
    {
        return true;
    }

    /**
     * @return Table
     */
    public function getBlock(): AbstractBlock
    {
        return $this->block;
    }

    public function tryContinue(Cursor $cursor, BlockContinueParserInterface $activeBlockParser): ?BlockContinue
    {
        if (\strpos($cursor->getLine(), '|') === false) {
            return BlockContinue::none();
        }

        return BlockContinue::at($cursor);
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

    public function addLine(string $line): void
    {
        if ($this->nextIsSeparatorLine) {
            $this->nextIsSeparatorLine = false;
        } else {
            $this->bodyLines[] = $line;
        }
    }

    public function parseInlines(InlineParserEngineInterface $inlineParser): void
    {
        $headerColumns = \count($this->headerCells);

        $head = new TableSection(TableSection::TYPE_HEAD);
        $this->block->appendChild($head);

        $headerRow = new TableRow();
        $head->appendChild($headerRow);
        for ($i = 0; $i < $headerColumns; $i++) {
            $cell = $this->headerCells[$i];
            $tableCell = self::parseCell($cell, $i, $inlineParser);
            $tableCell->setType(TableCell::TYPE_HEAD);
            $headerRow->appendChild($tableCell);
        }

        $body = null;
        foreach ($this->bodyLines as $rowLine) {
            $cells = self::split($rowLine);
            $row = new TableRow();

            // Body can not have more columns than head
            for ($i = 0; $i < $headerColumns; $i++) {
                $cell = $cells[$i] ?? '';
                $tableCell = self::parseCell($cell, $i, $inlineParser);
                $row->appendChild($tableCell);
            }

            if ($body === null) {
                // It's valid to have a table without body. In that case, don't add an empty TableBody node.
                $body = new TableSection();
                $this->block->appendChild($body);
            }
            $body->appendChild($row);
        }
    }

    private function parseCell(string $cell, int $column, InlineParserEngineInterface $inlineParser): TableCell
    {
        $tableCell = new TableCell();

        if ($column < \count($this->columns)) {
            $tableCell->setAlign($this->columns[$column]);
        }

        $inlineParser->parse(\trim($cell), $tableCell);

        return $tableCell;
    }

    /**
     * @param string $line
     *
     * @return array<int, string>

     *
     * @internal
     */
    public static function split(string $line): array
    {
        $cursor = new Cursor(\trim($line));

        if ($cursor->getCharacter() === '|') {
            $cursor->advanceBy(1);
        }

        $cells = [];
        $sb = '';

        while (!$cursor->isAtEnd()) {
            switch ($c = $cursor->getCharacter()) {
                case '\\':
                    if ($cursor->peek() === '|') {
                        // Pipe is special for table parsing. An escaped pipe doesn't result in a new cell, but is
                        // passed down to inline parsing as an unescaped pipe. Note that that applies even for the `\|`
                        // in an input like `\\|` - in other words, table parsing doesn't support escaping backslashes.
                        $sb .= '|';
                        $cursor->advanceBy(1);
                    } else {
                        // Preserve backslash before other characters or at end of line.
                        $sb .= '\\';
                    }
                    break;
                case '|':
                    $cells[] = $sb;
                    $sb = '';
                    break;
                default:
                    $sb .= $c;
            }
            $cursor->advanceBy(1);
        }

        if ($sb !== '') {
            $cells[] = $sb;
        }

        return $cells;
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		/*
6		* This is part of the league/commonmark package.
7		*
8		* (c) Martin Hasoň <[email protected]>
9		* (c) Webuni s.r.o. <[email protected]>
10		* (c) Colin O'Dell <[email protected]>
11		*
12		* For the full copyright and license information, please view the LICENSE
13		* file that was distributed with this source code.
14		*/
15
16		namespace League\CommonMark\Extension\Table;
17
18		use League\CommonMark\Node\Block\AbstractBlock;
19		use League\CommonMark\Parser\Block\AbstractBlockContinueParser;
20		use League\CommonMark\Parser\Block\BlockContinue;
21		use League\CommonMark\Parser\Block\BlockContinueParserInterface;
22		use League\CommonMark\Parser\Cursor;
23		use League\CommonMark\Parser\InlineParserEngineInterface;
24		use League\CommonMark\Util\ArrayCollection;
25
26		final class TableParser extends AbstractBlockContinueParser
27		{
28		/** @var Table */
29		private $block;
30
31		/** @var ArrayCollection<int, string> */
32		private $bodyLines;
33
34		/** @var array<int, string> */
35		private $columns;
36
37		/** @var array<int, string> */
38		private $headerCells;
39
40		/** @var bool */
41		private $nextIsSeparatorLine = true;
42
43		/**
44		* TableParser constructor.
45		*
46		* @param array<int, string> $columns
47		* @param array<int, string> $headerCells
48		*/
49	69	public function __construct(array $columns, array $headerCells)
50		{
51	69	$this->block = new Table();
52	69	$this->bodyLines = new ArrayCollection();
53	69	$this->columns = $columns;
54	69	$this->headerCells = $headerCells;
55	69	}
56
57	12	public function canHaveLazyContinuationLines(): bool
58		{
59	12	return true;
60		}
61
62		/**
63		* @return Table
64		*/
65	69	public function getBlock(): AbstractBlock
66		{
67	69	return $this->block;
68		}
69
70	66	public function tryContinue(Cursor $cursor, BlockContinueParserInterface $activeBlockParser): ?BlockContinue
71		{
72	66	if (\strpos($cursor->getLine(), '\|') === false) {
73	21	return BlockContinue::none();
74		}
75
76	66	return BlockContinue::at($cursor);
		0 ignored issues – show Bug Best Practice introduced 2020-05-03 01:47 UTC by Report Bug Copy Issue Report The return type of `return \League\CommonMar...kContinue::at($cursor);` (`self`) is incompatible with the return type declared by the interface `League\CommonMark\Parser...rInterface::tryContinue` of type `League\CommonMark\Parser\Block\BlockContinue\|null`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
77		}
78
79	69	public function addLine(string $line): void
80		{
81	69	if ($this->nextIsSeparatorLine) {
82	69	$this->nextIsSeparatorLine = false;
83		} else {
84	66	$this->bodyLines[] = $line;
85		}
86	69	}
87
88	69	public function parseInlines(InlineParserEngineInterface $inlineParser): void
89		{
90	69	$headerColumns = \count($this->headerCells);
91
92	69	$head = new TableSection(TableSection::TYPE_HEAD);
93	69	$this->block->appendChild($head);
94
95	69	$headerRow = new TableRow();
96	69	$head->appendChild($headerRow);
97	69	for ($i = 0; $i < $headerColumns; $i++) {
98	69	$cell = $this->headerCells[$i];
99	69	$tableCell = self::parseCell($cell, $i, $inlineParser);
100	69	$tableCell->setType(TableCell::TYPE_HEAD);
101	69	$headerRow->appendChild($tableCell);
102		}
103
104	69	$body = null;
105	69	foreach ($this->bodyLines as $rowLine) {
106	66	$cells = self::split($rowLine);
107	66	$row = new TableRow();
108
109		// Body can not have more columns than head
110	66	for ($i = 0; $i < $headerColumns; $i++) {
111	66	$cell = $cells[$i] ?? '';
112	66	$tableCell = self::parseCell($cell, $i, $inlineParser);
113	66	$row->appendChild($tableCell);
114		}
115
116	66	if ($body === null) {
117		// It's valid to have a table without body. In that case, don't add an empty TableBody node.
118	66	$body = new TableSection();
119	66	$this->block->appendChild($body);
120		}
121	66	$body->appendChild($row);
122		}
123	69	}
124
125	69	private function parseCell(string $cell, int $column, InlineParserEngineInterface $inlineParser): TableCell
126		{
127	69	$tableCell = new TableCell();
128
129	69	if ($column < \count($this->columns)) {
130	69	$tableCell->setAlign($this->columns[$column]);
131		}
132
133	69	$inlineParser->parse(\trim($cell), $tableCell);
134
135	69	return $tableCell;
136		}
137
138		/**
139		* @param string $line
140		*
141		* @return array<int, string>
		0 ignored issues – show Documentation introduced 2020-04-26 17:35 UTC by Report Bug Copy Issue Report The doc-type `array<int,` could not be parsed: Expected ">" at position 5, but found "end of type". (view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
142		*
143		* @internal
144		*/
145	72	public static function split(string $line): array
146		{
147	72	$cursor = new Cursor(\trim($line));
148
149	72	if ($cursor->getCharacter() === '\|') {
150	54	$cursor->advanceBy(1);
151		}
152
153	72	$cells = [];
154	72	$sb = '';
155
156	72	while (!$cursor->isAtEnd()) {
157	72	switch ($c = $cursor->getCharacter()) {
158	72	case '\\':
159	12	if ($cursor->peek() === '\|') {
160		// Pipe is special for table parsing. An escaped pipe doesn't result in a new cell, but is
161		// passed down to inline parsing as an unescaped pipe. Note that that applies even for the `\\|`
162		// in an input like `\\\|` - in other words, table parsing doesn't support escaping backslashes.
163	12	$sb .= '\|';
164	12	$cursor->advanceBy(1);
165		} else {
166		// Preserve backslash before other characters or at end of line.
167	3	$sb .= '\\';
168		}
169	12	break;
170	72	case '\|':
171	72	$cells[] = $sb;
172	72	$sb = '';
173	72	break;
174		default:
175	72	$sb .= $c;
176		}
177	72	$cursor->advanceBy(1);
178		}
179
180	72	if ($sb !== '') {
181	33	$cells[] = $sb;
182		}
183
184	72	return $cells;
185		}
186		}
187

thephpleague / commonmark

Push — refactor-parsing ( adbb6b...fbe6de )

TableParser::addLine() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like