Normaliser::handleTxt() - Code Metrics - Inspection of "Issue 96 (#97)" - Badcow/DNS - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 72b670...3b819e )

by Sam

created 2021-01-21 22:21 UTC

Normaliser::handleTxt() B

↳ Parent: Normaliser

Complexity

Conditions	6
Paths	7

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	13
CRAP Score	6

Importance

Changes

Metric	Value
dl	0
loc	25
ccs	13
cts	13
cp	1
rs	8.8977
c	0
b	0
f	0
cc	6
nc	7
nop	0
crap	6

<?php

declare(strict_types=1);

/*
 * This file is part of Badcow DNS Library.
 *
 * (c) Samuel Williams <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Badcow\DNS\Parser;

class Normaliser
{
    /**
     * @var StringIterator
     */
    private $string;

    /**
     * @var string
     */
    private $normalisedString = '';

    /**
     * @var int
     */
    private $commentOptions;

    /**
     * @var string
     */
    private $comment = '';

    /**
     * Comments that are within a multiline context, i.e. between brackets.
     *
     * @var string
     */
    private $multilineComments = '';

    /**
     * Normaliser constructor.
     */
    public function __construct(string $zone, int $commentOptions = Comments::NONE)
    {
        //Remove Windows line feeds and tabs
        $zone = str_replace([Tokens::CARRIAGE_RETURN, Tokens::TAB], ['', Tokens::SPACE], $zone);

        $this->string = new StringIterator($zone);
        $this->commentOptions = $commentOptions;
    }

    /**
     * @throws ParseException
     */
    public static function normalise(string $zone, int $includeComments = Comments::NONE): string
    {
        return (new self($zone, $includeComments))->process();
    }

    /**
     * @throws ParseException
     */
    public function process(): string
    {
        while ($this->string->valid()) {
            $this->handleTxt();
            $this->handleMultiline();
            $this->handleComment(Comments::END_OF_ENTRY | Comments::ORPHAN);
            $this->append();
        }

        $this->removeWhitespace();

        return $this->normalisedString;
    }

    /**
     * Parses the comments.
     *
     * @param int $condition
     */
    private function handleComment($condition = Comments::ALL): void
    {
        if ($this->string->isNot(Tokens::SEMICOLON)) {
            return;
        }

        $this->string->next();

        while ($this->string->isNot(Tokens::LINE_FEED) && $this->string->valid()) {
            if ($this->commentOptions & $condition) {
                if ($condition & Comments::MULTILINE) {
                    $this->multilineComments .= $this->string->current();
                } else {
                    $this->comment .= $this->string->current();
                }
            }
            $this->string->next();
        }
    }

    /**
     * Handle text inside of double quotations. When this function is called, the String pointer MUST be at the
     * double quotation mark.
     *
     * @throws ParseException
     */
    private function handleTxt(): void
    {
        if ($this->string->isNot(Tokens::DOUBLE_QUOTES)) {
            return;
        }

        $this->append();

        while ($this->string->isNot(Tokens::DOUBLE_QUOTES)) {
            if (!$this->string->valid()) {
                throw new ParseException('Unbalanced double quotation marks. End of file reached.');
            }

            //If escape character
            if ($this->string->is(Tokens::BACKSLASH)) {
                $this->append();
            }

            if ($this->string->is(Tokens::LINE_FEED)) {
                throw new ParseException('Line Feed found within double quotation marks context.', $this->string);
            }

            $this->append();
        }
    }

    /**
     * Move multi-line records onto single line.
     *
     * @throws ParseException
     */
    private function handleMultiline(): void
    {
        if ($this->string->isNot(Tokens::OPEN_BRACKET)) {
            return;
        }

        $this->string->next();
        while ($this->string->valid()) {
            $this->handleTxt();
            $this->handleComment(Comments::MULTILINE);

            if ($this->string->is(Tokens::LINE_FEED)) {
                $this->string->next();
                continue;
            }

            if ($this->string->is(Tokens::CLOSE_BRACKET)) {
                $this->string->next();

                $this->process();

                return;
            }

            $this->append();
        }

        throw new ParseException('End of file reached. Unclosed bracket.');
    }

    /**
     * Remove superfluous whitespace characters from string.
     *
     * @throws \UnexpectedValueException
     */
    private function removeWhitespace(): void
    {
        if (null === $string = preg_replace('/ {2,}/', Tokens::SPACE, $this->normalisedString)) {
            throw new \UnexpectedValueException('Unexpected value returned from \preg_replace().');
        }

        $lines = [];

        foreach (explode(Tokens::LINE_FEED, $string) as $line) {
            if ('' !== $line = rtrim($line)) {
                $lines[] = $line;
            }
        }
        $this->normalisedString = implode(Tokens::LINE_FEED, $lines);
    }

    /**
     * Add current entry to normalisedString and moves iterator to next entry.
     */
    private function append(): void
    {
        if (($this->string->is(Tokens::LINE_FEED) || !$this->string->valid()) &&
            $this->commentOptions &&
            ('' !== $this->comment || '' !== $this->multilineComments)) {
            $this->appendComment();
        }

        $this->normalisedString .= $this->string->current();
        $this->string->next();
    }

    private function appendComment(): void
    {
        $zone = rtrim($this->normalisedString, Tokens::SPACE);

        //If there is no Resource Record on the line
        if ((Tokens::LINE_FEED === substr($zone, -1, 1) || 0 === strlen($zone))) {
            if ($this->commentOptions & Comments::ORPHAN) {
                $this->normalisedString = sprintf('%s;%s', $zone, trim($this->comment));
            }
            $this->comment = '';
            $this->multilineComments = '';

            return;
        }

        $comments = '';

        if (($this->commentOptions & Comments::MULTILINE) && '' !== $this->multilineComments) {
            $comments .= $this->multilineComments;
        }

        if (($this->commentOptions & Comments::END_OF_ENTRY) && '' !== $this->comment) {
            $comments .= $this->comment;
        }

        if ('' !== $comments = trim($comments)) {
            $this->normalisedString = sprintf('%s;%s', $zone, $comments);
        }

        $this->comment = '';
        $this->multilineComments = '';
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		/*
6		* This file is part of Badcow DNS Library.
7		*
8		* (c) Samuel Williams <[email protected]>
9		*
10		* For the full copyright and license information, please view the LICENSE
11		* file that was distributed with this source code.
12		*/
13
14		namespace Badcow\DNS\Parser;
15
16		class Normaliser
17		{
18		/**
19		* @var StringIterator
20		*/
21		private $string;
22
23		/**
24		* @var string
25		*/
26		private $normalisedString = '';
27
28		/**
29		* @var int
30		*/
31		private $commentOptions;
32
33		/**
34		* @var string
35		*/
36		private $comment = '';
37
38		/**
39		* Comments that are within a multiline context, i.e. between brackets.
40		*
41		* @var string
42		*/
43		private $multilineComments = '';
44
45		/**
46		* Normaliser constructor.
47		*/
48	40	public function __construct(string $zone, int $commentOptions = Comments::NONE)
49		{
50		//Remove Windows line feeds and tabs
51	40	$zone = str_replace([Tokens::CARRIAGE_RETURN, Tokens::TAB], ['', Tokens::SPACE], $zone);
52
53	40	$this->string = new StringIterator($zone);
54	40	$this->commentOptions = $commentOptions;
55	40	}
56
57		/**
58		* @throws ParseException
59		*/
60	40	public static function normalise(string $zone, int $includeComments = Comments::NONE): string
61		{
62	40	return (new self($zone, $includeComments))->process();
63		}
64
65		/**
66		* @throws ParseException
67		*/
68	40	public function process(): string
69		{
70	40	while ($this->string->valid()) {
71	40	$this->handleTxt();
72	40	$this->handleMultiline();
73	40	$this->handleComment(Comments::END_OF_ENTRY \| Comments::ORPHAN);
74	40	$this->append();
75		}
76
77	37	$this->removeWhitespace();
78
79	37	return $this->normalisedString;
80		}
81
82		/**
83		* Parses the comments.
84		*
85		* @param int $condition
86		*/
87	40	private function handleComment($condition = Comments::ALL): void
88		{
89	40	if ($this->string->isNot(Tokens::SEMICOLON)) {
90	40	return;
91		}
92
93	22	$this->string->next();
94
95	22	while ($this->string->isNot(Tokens::LINE_FEED) && $this->string->valid()) {
96	22	if ($this->commentOptions & $condition) {
97	10	if ($condition & Comments::MULTILINE) {
98	4	$this->multilineComments .= $this->string->current();
99		} else {
100	10	$this->comment .= $this->string->current();
101		}
102		}
103	22	$this->string->next();
104		}
105	22	}
106
107		/**
108		* Handle text inside of double quotations. When this function is called, the String pointer MUST be at the
109		* double quotation mark.
110		*
111		* @throws ParseException
112		*/
113	40	private function handleTxt(): void
114		{
115	40	if ($this->string->isNot(Tokens::DOUBLE_QUOTES)) {
116	40	return;
117		}
118
119	22	$this->append();
120
121	22	while ($this->string->isNot(Tokens::DOUBLE_QUOTES)) {
122	22	if (!$this->string->valid()) {
123	1	throw new ParseException('Unbalanced double quotation marks. End of file reached.');
124		}
125
126		//If escape character
127	22	if ($this->string->is(Tokens::BACKSLASH)) {
128	13	$this->append();
129		}
130
131	22	if ($this->string->is(Tokens::LINE_FEED)) {
132	1	throw new ParseException('Line Feed found within double quotation marks context.', $this->string);
133		}
134
135	22	$this->append();
136		}
137	20	}
138
139		/**
140		* Move multi-line records onto single line.
141		*
142		* @throws ParseException
143		*/
144	40	private function handleMultiline(): void
145		{
146	40	if ($this->string->isNot(Tokens::OPEN_BRACKET)) {
147	40	return;
148		}
149
150	19	$this->string->next();
151	19	while ($this->string->valid()) {
152	19	$this->handleTxt();
153	19	$this->handleComment(Comments::MULTILINE);
154
155	19	if ($this->string->is(Tokens::LINE_FEED)) {
156	19	$this->string->next();
157	19	continue;
158		}
159
160	19	if ($this->string->is(Tokens::CLOSE_BRACKET)) {
161	18	$this->string->next();
162
163	18	$this->process();
164
165	18	return;
166		}
167
168	19	$this->append();
169		}
170
171	1	throw new ParseException('End of file reached. Unclosed bracket.');
172		}
173
174		/**
175		* Remove superfluous whitespace characters from string.
176		*
177		* @throws \UnexpectedValueException
178		*/
179	37	private function removeWhitespace(): void
180		{
181	37	if (null === $string = preg_replace('/ {2,}/', Tokens::SPACE, $this->normalisedString)) {
182		throw new \UnexpectedValueException('Unexpected value returned from \preg_replace().');
183		}
184
185	37	$lines = [];
186
187	37	foreach (explode(Tokens::LINE_FEED, $string) as $line) {
188	37	if ('' !== $line = rtrim($line)) {
189	37	$lines[] = $line;
190		}
191		}
192	37	$this->normalisedString = implode(Tokens::LINE_FEED, $lines);
193	37	}
194
195		/**
196		* Add current entry to normalisedString and moves iterator to next entry.
197		*/
198	40	private function append(): void
199		{
200	40	if (($this->string->is(Tokens::LINE_FEED) \|\| !$this->string->valid()) &&
201	40	$this->commentOptions &&
202	40	('' !== $this->comment \|\| '' !== $this->multilineComments)) {
203	10	$this->appendComment();
204		}
205
206	40	$this->normalisedString .= $this->string->current();
207	40	$this->string->next();
208	40	}
209
210	10	private function appendComment(): void
211		{
212	10	$zone = rtrim($this->normalisedString, Tokens::SPACE);
213
214		//If there is no Resource Record on the line
215	10	if ((Tokens::LINE_FEED === substr($zone, -1, 1) \|\| 0 === strlen($zone))) {
216	8	if ($this->commentOptions & Comments::ORPHAN) {
217	5	$this->normalisedString = sprintf('%s;%s', $zone, trim($this->comment));
218		}
219	8	$this->comment = '';
220	8	$this->multilineComments = '';
221
222	8	return;
223		}
224
225	10	$comments = '';
226
227	10	if (($this->commentOptions & Comments::MULTILINE) && '' !== $this->multilineComments) {
228	4	$comments .= $this->multilineComments;
229		}
230
231	10	if (($this->commentOptions & Comments::END_OF_ENTRY) && '' !== $this->comment) {
232	10	$comments .= $this->comment;
233		}
234
235	10	if ('' !== $comments = trim($comments)) {
236	10	$this->normalisedString = sprintf('%s;%s', $zone, $comments);
237		}
238
239	10	$this->comment = '';
240	10	$this->multilineComments = '';
241	10	}
242		}
243

Badcow / DNS

Push — master ( 72b670...3b819e )

Normaliser::handleTxt() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like