XMLParser::chunk() - Code Metrics - Inspection of "Parse in chunks and stop the parser" - Rodenastyle/stream-parser - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#6)

unknown

created 2018-07-21 16:54 UTC

XMLParser::chunk() B

↳ Parent: XMLParser

Complexity

Conditions	7
Paths	47

Size

Total Lines	32
Code Lines	18

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	18
CRAP Score	7.0071

Importance

Changes

Metric	Value
cc	7
eloc	18
nc	47
nop	2
dl	0
loc	32
ccs	18
cts	19
cp	0.9474
crap	7.0071
rs	8.8333
c	0
b	0
f	0

<?php
/**
 * Created by PhpStorm.
 * User: sergio.rodenas
 * Date: 12/5/18
 * Time: 0:09
 */

namespace Rodenastyle\StreamParser\Parsers;


use Rodenastyle\StreamParser\Exceptions\IncompleteParseException;
use Rodenastyle\StreamParser\Exceptions\StopParseException;
use Rodenastyle\StreamParser\StreamParserInterface;
use Tightenco\Collect\Support\Collection;
use XMLReader;


class XMLParser implements StreamParserInterface
{
	protected $reader,$source;

	protected $skipFirstElement = true;

	public function from(String $source): StreamParserInterface
	{
		$this->source = $source;

		return $this;
	}

	public function withoutSkippingFirstElement(){
		$this->skipFirstElement = false;

		return $this;
	}

	public function each(callable $function)
	{
		$this->start();
		try {
			while($this->reader->read()){
				if($this->searchElement($function) === false) {
					break;
				}
			}
		} catch (StopParseException $e) {

		} finally {
			$this->stop();
		}
	}

	public function chunk($count, callable $function)
	{
		if($count <= 0) {
			return;
		}

		$this->start();
		try {
			$chunk = new Collection();

			while($this->reader->read()){
				$this->searchElement(function($item) use (&$chunk) {
					$chunk->push($item);
				});

				if($chunk->count() >= $count) {
					$stop = $function($chunk) === false;

					$chunk = new Collection();

					if($stop) {
						break;
					}
				}
			}

			if($chunk->count() > 0) {
				$function($chunk);
			}
		} catch (StopParseException $e) {

		} finally {
			$this->stop();
		}
	}

	private function searchElement(callable $function)
	{
		if($this->isElement() && ! $this->shouldBeSkipped()){
			return $function($this->extractElement($this->reader->name));
		}
	}

	private function extractElement(String $elementName, $couldBeAnElementsList = false)
	{
		$elementCollection = (new Collection())->merge($this->getCurrentElementAttributes());

		while($this->reader->read()){
			if($this->isEndElement($elementName)){
				break;
			}
			if($this->isValue()){
				if($elementCollection->isEmpty()){
					return trim($this->reader->value);
				} else {
					return $elementCollection->put($elementName, trim($this->reader->value));
				}
			}
			if($this->isElement()){
				if($couldBeAnElementsList){
					$foundElementName = $this->reader->name;
					$elementCollection->push(new Collection($this->extractElement($foundElementName)));
				} else {
					$foundElementName = $this->reader->name;
					$elementCollection->put($foundElementName, $this->extractElement($foundElementName, true));
				}
			}
		}

		return $elementCollection;
	}

	private function getCurrentElementAttributes(){
		$attributes = new Collection();
		if($this->reader->hasAttributes)  {
			while($this->reader->moveToNextAttribute()) {
				$attributes->put($this->reader->name, $this->reader->value);
			}
		}
		return $attributes;
	}

	private function start()
	{
		$this->reader = new XMLReader();
		$this->reader->open($this->source);

		return $this;
	}

	private function stop()
	{
		if( ! $this->reader->close()){
			throw new IncompleteParseException();
		}
	}

	private function shouldBeSkipped(){
		if($this->skipFirstElement){
			$this->skipFirstElement = false;
			return true;
		}

		return false;
	}

	private function isElement(String $elementName = null){
		if($elementName){
			return $this->reader->nodeType == XMLReader::ELEMENT && $this->reader->name === $elementName;
		} else {
			return $this->reader->nodeType == XMLReader::ELEMENT;
		}
	}

	private function isEndElement(String $elementName = null){
		if($elementName){
			return $this->reader->nodeType == XMLReader::END_ELEMENT && $this->reader->name === $elementName;
		} else {
			return $this->reader->nodeType == XMLReader::END_ELEMENT;
		}
	}

	private function isValue(){
		return $this->reader->nodeType == XMLReader::TEXT || $this->reader->nodeType === XMLReader::CDATA;
	}
}


1		<?php
2		/**
3		* Created by PhpStorm.
4		* User: sergio.rodenas
5		* Date: 12/5/18
6		* Time: 0:09
7		*/
8
9		namespace Rodenastyle\StreamParser\Parsers;
10
11
12		use Rodenastyle\StreamParser\Exceptions\IncompleteParseException;
13		use Rodenastyle\StreamParser\Exceptions\StopParseException;
14		use Rodenastyle\StreamParser\StreamParserInterface;
15		use Tightenco\Collect\Support\Collection;
16		use XMLReader;
17
18
19		class XMLParser implements StreamParserInterface
20		{
21		protected $reader,$source;
22
23		protected $skipFirstElement = true;
24
25	7	public function from(String $source): StreamParserInterface
26		{
27	7	$this->source = $source;
28
29	7	return $this;
30		}
31
32		public function withoutSkippingFirstElement(){
33		$this->skipFirstElement = false;
34
35		return $this;
36		}
37
38	7	public function each(callable $function)
39		{
40	7	$this->start();
41		try {
42	7	while($this->reader->read()){
43	7	if($this->searchElement($function) === false) {
44	1	break;
45		}
46		}
47	1	} catch (StopParseException $e) {
		0 ignored issues – show Coding Style Comprehensibility introduced 2018-07-21 16:56 UTC by Report Bug Copy Issue Report Consider adding a comment why this CATCH block is empty. Loading history...
48	7	} finally {
49	7	$this->stop();
50		}
51	7	}
52
53	7	public function chunk($count, callable $function)
54		{
55	7	if($count <= 0) {
56		return;
57		}
58
59	7	$this->start();
60		try {
61	7	$chunk = new Collection();
62
63	7	while($this->reader->read()){
64	7	$this->searchElement(function($item) use (&$chunk) {
65	7	$chunk->push($item);
66	7	});
67
68	7	if($chunk->count() >= $count) {
69	7	$stop = $function($chunk) === false;
70
71	7	$chunk = new Collection();
72
73	7	if($stop) {
74	1	break;
75		}
76		}
77		}
78
79	7	if($chunk->count() > 0) {
80	7	$function($chunk);
81		}
82	1	} catch (StopParseException $e) {
		0 ignored issues – show Coding Style Comprehensibility introduced 2018-07-21 16:56 UTC by Report Bug Copy Issue Report Consider adding a comment why this CATCH block is empty. Loading history...
83	7	} finally {
84	7	$this->stop();
85		}
86	7	}
87
88	7	private function searchElement(callable $function)
89		{
90	7	if($this->isElement() && ! $this->shouldBeSkipped()){
91	7	return $function($this->extractElement($this->reader->name));
92		}
93	7	}
94
95	7	private function extractElement(String $elementName, $couldBeAnElementsList = false)
96		{
97	7	$elementCollection = (new Collection())->merge($this->getCurrentElementAttributes());
98
99	7	while($this->reader->read()){
100	7	if($this->isEndElement($elementName)){
101	7	break;
102		}
103	7	if($this->isValue()){
104	7	if($elementCollection->isEmpty()){
105	7	return trim($this->reader->value);
106		} else {
107	7	return $elementCollection->put($elementName, trim($this->reader->value));
108		}
109		}
110	7	if($this->isElement()){
111	7	if($couldBeAnElementsList){
112	7	$foundElementName = $this->reader->name;
113	7	$elementCollection->push(new Collection($this->extractElement($foundElementName)));
114		} else {
115	7	$foundElementName = $this->reader->name;
116	7	$elementCollection->put($foundElementName, $this->extractElement($foundElementName, true));
117		}
118		}
119		}
120
121	7	return $elementCollection;
122		}
123
124	7	private function getCurrentElementAttributes(){
125	7	$attributes = new Collection();
126	7	if($this->reader->hasAttributes) {
127	7	while($this->reader->moveToNextAttribute()) {
128	7	$attributes->put($this->reader->name, $this->reader->value);
129		}
130		}
131	7	return $attributes;
132		}
133
134	7	private function start()
135		{
136	7	$this->reader = new XMLReader();
137	7	$this->reader->open($this->source);
138
139	7	return $this;
140		}
141
142	7	private function stop()
143		{
144	7	if( ! $this->reader->close()){
145		throw new IncompleteParseException();
146		}
147	7	}
148
149	7	private function shouldBeSkipped(){
150	7	if($this->skipFirstElement){
151	7	$this->skipFirstElement = false;
152	7	return true;
153		}
154
155	7	return false;
156		}
157
158	7	private function isElement(String $elementName = null){
159	7	if($elementName){
160		return $this->reader->nodeType == XMLReader::ELEMENT && $this->reader->name === $elementName;
161		} else {
162	7	return $this->reader->nodeType == XMLReader::ELEMENT;
163		}
164		}
165
166	7	private function isEndElement(String $elementName = null){
167	7	if($elementName){
168	7	return $this->reader->nodeType == XMLReader::END_ELEMENT && $this->reader->name === $elementName;
169		} else {
170		return $this->reader->nodeType == XMLReader::END_ELEMENT;
171		}
172		}
173
174	7	private function isValue(){
175	7	return $this->reader->nodeType == XMLReader::TEXT \|\| $this->reader->nodeType === XMLReader::CDATA;
176		}
177		}
178

Rodenastyle / stream-parser

Pull Request — master (#6)

XMLParser::chunk() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like