TableStartParser::getAlignment() - Code Metrics - Inspection of "Prepare to release 2.6.0" - thephpleague/commonmark - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — 2.6 ( d150f9 )

by Colin

created 2024-12-07 15:38 UTC

TableStartParser::getAlignment() A

↳ Parent: TableStartParser

Complexity

Conditions	5
Paths	4

Size

Total Lines	15
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	8
CRAP Score	5

Importance

Changes

Metric	Value
eloc	7
dl	0
loc	15
ccs	8
cts	8
cp	1
rs	9.6111
c	0
b	0
f	0
cc	5
nc	4
nop	2
crap	5

<?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\Parser\Block\BlockStart;
use League\CommonMark\Parser\Block\BlockStartParserInterface;
use League\CommonMark\Parser\Block\ParagraphParser;
use League\CommonMark\Parser\Cursor;
use League\CommonMark\Parser\MarkdownParserStateInterface;

final class TableStartParser implements BlockStartParserInterface
{
    private int $maxAutocompletedCells;

    public function __construct(int $maxAutocompletedCells = TableParser::DEFAULT_MAX_AUTOCOMPLETED_CELLS)
filter:
    dependency_paths: ["lib/*"]
    {
        $this->maxAutocompletedCells = $maxAutocompletedCells;
    }

    public function tryStart(Cursor $cursor, MarkdownParserStateInterface $parserState): ?BlockStart
    {
        $paragraph = $parserState->getParagraphContent();
        if ($paragraph === null || \strpos($paragraph, '|') === false) {
            return BlockStart::none();
        }

        $columns = self::parseSeparator($cursor);
        if (\count($columns) === 0) {
            return BlockStart::none();
        }

        $lastLineBreak = \strrpos($paragraph, "\n");
        $lastLine      = $lastLineBreak === false ? $paragraph : \substr($paragraph, $lastLineBreak + 1);

        $headerCells = TableParser::split($lastLine);
        if (\count($headerCells) > \count($columns)) {
            return BlockStart::none();
        }

        $cursor->advanceToEnd();

        $parsers = [];

        if ($lastLineBreak !== false) {
            $p = new ParagraphParser();
            $p->addLine(\substr($paragraph, 0, $lastLineBreak));
            $parsers[] = $p;
        }

        $parsers[] = new TableParser($columns, $headerCells, $this->maxAutocompletedCells);

        return BlockStart::of(...$parsers)
            ->at($cursor)
            ->replaceActiveBlockParser();
    }

    /**
     * @return array<int, string|null>
     *
     * @psalm-return array<int, TableCell::ALIGN_*|null>
     *
     * @phpstan-return array<int, TableCell::ALIGN_*|null>
     */
    private static function parseSeparator(Cursor $cursor): array
    {
        $columns = [];
        $pipes   = 0;
        $valid   = false;

        while (! $cursor->isAtEnd()) {
            switch ($c = $cursor->getCurrentCharacter()) {
                case '|':
                    $cursor->advanceBy(1);
                    $pipes++;
                    if ($pipes > 1) {
                        // More than one adjacent pipe not allowed
                        return [];
                    }

                    // Need at least one pipe, even for a one-column table
                    $valid = true;
                    break;
                case '-':
                case ':':
                    if ($pipes === 0 && \count($columns) > 0) {
                        // Need a pipe after the first column (first column doesn't need to start with one)
                        return [];
                    }

                    $left  = false;
                    $right = false;
                    if ($c === ':') {
                        $left = true;
                        $cursor->advanceBy(1);
                    }

                    if ($cursor->match('/^-+/') === null) {
                        // Need at least one dash
                        return [];
                    }

                    if ($cursor->getCurrentCharacter() === ':') {
                        $right = true;
                        $cursor->advanceBy(1);
                    }

                    $columns[] = self::getAlignment($left, $right);
                    // Next, need another pipe
                    $pipes = 0;
                    break;
                case ' ':
                case "\t":
                    // White space is allowed between pipes and columns
                    $cursor->advanceToNextNonSpaceOrTab();
                    break;
                default:
                    // Any other character is invalid
                    return [];
            }
        }

        if (! $valid) {
            return [];
        }

        return $columns;
    }

    /**
     * @psalm-return TableCell::ALIGN_*|null
     *
     * @phpstan-return TableCell::ALIGN_*|null
     *
     * @psalm-pure
     */
    private static function getAlignment(bool $left, bool $right): ?string
    {
        if ($left && $right) {
            return TableCell::ALIGN_CENTER;
        }

        if ($left) {
            return TableCell::ALIGN_LEFT;
        }

        if ($right) {
            return TableCell::ALIGN_RIGHT;
        }

        return null;
    }
}


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\Parser\Block\BlockStart;
19		use League\CommonMark\Parser\Block\BlockStartParserInterface;
20		use League\CommonMark\Parser\Block\ParagraphParser;
21		use League\CommonMark\Parser\Cursor;
22		use League\CommonMark\Parser\MarkdownParserStateInterface;
23
24		final class TableStartParser implements BlockStartParserInterface
25		{
26		private int $maxAutocompletedCells;
27
28	134	public function __construct(int $maxAutocompletedCells = TableParser::DEFAULT_MAX_AUTOCOMPLETED_CELLS)
		0 ignored issues – show Bug introduced 2024-12-07 15:48 UTC by Report Bug Copy Issue Report The type `League\CommonMark\Extension\Table\TableParser` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
29		{
30	134	$this->maxAutocompletedCells = $maxAutocompletedCells;
31		}
32
33	82	public function tryStart(Cursor $cursor, MarkdownParserStateInterface $parserState): ?BlockStart
34		{
35	82	$paragraph = $parserState->getParagraphContent();
36	82	if ($paragraph === null \|\| \strpos($paragraph, '\|') === false) {
37	66	return BlockStart::none();
38		}
39
40	60	$columns = self::parseSeparator($cursor);
41	60	if (\count($columns) === 0) {
42	2	return BlockStart::none();
43		}
44
45	60	$lastLineBreak = \strrpos($paragraph, "\n");
46	60	$lastLine = $lastLineBreak === false ? $paragraph : \substr($paragraph, $lastLineBreak + 1);
47
48	60	$headerCells = TableParser::split($lastLine);
49	60	if (\count($headerCells) > \count($columns)) {
50	2	return BlockStart::none();
51		}
52
53	58	$cursor->advanceToEnd();
54
55	58	$parsers = [];
56
57	58	if ($lastLineBreak !== false) {
58	6	$p = new ParagraphParser();
59	6	$p->addLine(\substr($paragraph, 0, $lastLineBreak));
60	6	$parsers[] = $p;
61		}
62
63	58	$parsers[] = new TableParser($columns, $headerCells, $this->maxAutocompletedCells);
64
65	58	return BlockStart::of(...$parsers)
66	58	->at($cursor)
67	58	->replaceActiveBlockParser();
68		}
69
70		/**
71		* @return array<int, string\|null>
72		*
73		* @psalm-return array<int, TableCell::ALIGN_*\|null>
74		*
75		* @phpstan-return array<int, TableCell::ALIGN_*\|null>
76		*/
77	60	private static function parseSeparator(Cursor $cursor): array
78		{
79	60	$columns = [];
80	60	$pipes = 0;
81	60	$valid = false;
82
83	60	while (! $cursor->isAtEnd()) {
84	60	switch ($c = $cursor->getCurrentCharacter()) {
85	60	case '\|':
86	60	$cursor->advanceBy(1);
87	60	$pipes++;
88	60	if ($pipes > 1) {
89		// More than one adjacent pipe not allowed
90		return [];
91		}
92
93		// Need at least one pipe, even for a one-column table
94	60	$valid = true;
95	60	break;
96	60	case '-':
97	54	case ':':
98	60	if ($pipes === 0 && \count($columns) > 0) {
99		// Need a pipe after the first column (first column doesn't need to start with one)
100		return [];
101		}
102
103	60	$left = false;
104	60	$right = false;
105	60	if ($c === ':') {
106	12	$left = true;
107	12	$cursor->advanceBy(1);
108		}
109
110	60	if ($cursor->match('/^-+/') === null) {
111		// Need at least one dash
112		return [];
113		}
114
115	60	if ($cursor->getCurrentCharacter() === ':') {
116	8	$right = true;
117	8	$cursor->advanceBy(1);
118		}
119
120	60	$columns[] = self::getAlignment($left, $right);
121		// Next, need another pipe
122	60	$pipes = 0;
123	60	break;
124	52	case ' ':
125	2	case "\t":
126		// White space is allowed between pipes and columns
127	52	$cursor->advanceToNextNonSpaceOrTab();
128	52	break;
129		default:
130		// Any other character is invalid
131	2	return [];
132		}
133		}
134
135	60	if (! $valid) {
136		return [];
137		}
138
139	60	return $columns;
140		}
141
142		/**
143		* @psalm-return TableCell::ALIGN_*\|null
144		*
145		* @phpstan-return TableCell::ALIGN_*\|null
146		*
147		* @psalm-pure
148		*/
149	60	private static function getAlignment(bool $left, bool $right): ?string
150		{
151	60	if ($left && $right) {
152	8	return TableCell::ALIGN_CENTER;
153		}
154
155	60	if ($left) {
156	8	return TableCell::ALIGN_LEFT;
157		}
158
159	58	if ($right) {
160	8	return TableCell::ALIGN_RIGHT;
161		}
162
163	54	return null;
164		}
165		}
166

thephpleague / commonmark

Push — 2.6 ( d150f9 )

TableStartParser::getAlignment() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like