RectangleParser - Code Metrics - Inspection of "Kill Geocoders" - JeroenDeDauw/Maps - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — killgeocoders ( 08fbcb )

by Jeroen De

created 2017-09-28 11:08 UTC

RectangleParser A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	62
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes

Metric	Value
wmc	9
lcom	1
cbo	4
dl	0
loc	62
rs	10
c	0
b	0
f	0

3 Methods

Rating	Name	Size	Complexity
A	__construct()	3	1
B	parse()	31	6
A	stringToLatLongValue()	9	2

<?php

namespace Maps;

use Maps\Elements\Rectangle;
use ValueParsers\ParseException;
use ValueParsers\StringValueParser;
use ValueParsers\ValueParser;

/**
 * @since 3.0
 *
 * @licence GNU GPL v2+
 * @author Kim Eik
 * @author Jeroen De Dauw < [email protected] >
 */
class RectangleParser implements ValueParser {

	private $metaDataSeparator = '~';

	private $geocoder;

	public function __construct() {
		$this->geocoder = MapsFactory::newDefault()->newGeocoder();
	}

	/**
	 * @see StringValueParser::stringParse
	 *
	 * @since 3.0
	 *
	 * @param string $value
	 *
	 * @return Rectangle
	 */
	public function parse( $value ) {
		$metaData = explode( $this->metaDataSeparator , $value );
		$rectangleData = explode( ':' , array_shift( $metaData ) );

		$rectangle = new Rectangle(
			$this->stringToLatLongValue( $rectangleData[0] ),
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
			$this->stringToLatLongValue( $rectangleData[1] )
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
		);

		if ( $metaData !== [] ) {
			$rectangle->setTitle( array_shift( $metaData ) );
		}

		if ( $metaData !== [] ) {
			$rectangle->setText( array_shift( $metaData ) );
		}

		if ( $metaData !== [] ) {
			$rectangle->setStrokeColor( array_shift( $metaData ) );
		}

		if ( $metaData !== [] ) {
			$rectangle->setStrokeOpacity( array_shift( $metaData ) );
		}

		if ( $metaData !== [] ) {
			$rectangle->setStrokeWeight( array_shift( $metaData ) );
		}

		return $rectangle;
	}

	private function stringToLatLongValue( $location ) {
		$latLong = $this->geocoder->geocode( $location );

		if ( $location === null ) {
			throw new ParseException( 'Failed to parse or geocode' );
		}

		return $latLong;
	}

}


1			<?php
2
3			namespace Maps;
4
5			use Maps\Elements\Rectangle;
6			use ValueParsers\ParseException;
7			use ValueParsers\StringValueParser;
8			use ValueParsers\ValueParser;
9
10			/**
11			* @since 3.0
12			*
13			* @licence GNU GPL v2+
14			* @author Kim Eik
15			* @author Jeroen De Dauw < [email protected] >
16			*/
17			class RectangleParser implements ValueParser {
18
19			private $metaDataSeparator = '~';
20
21			private $geocoder;
22
23			public function __construct() {
24			$this->geocoder = MapsFactory::newDefault()->newGeocoder();
25			}
26
27			/**
28			* @see StringValueParser::stringParse
29			*
30			* @since 3.0
31			*
32			* @param string $value
33			*
34			* @return Rectangle
35			*/
36			public function parse( $value ) {
37			$metaData = explode( $this->metaDataSeparator , $value );
38			$rectangleData = explode( ':' , array_shift( $metaData ) );
39
40			$rectangle = new Rectangle(
41			$this->stringToLatLongValue( $rectangleData[0] ),
			0 ignored issues – show Bug introduced 2017-09-28 11:15 UTC by Report Bug Copy Issue Report It seems like `$this->stringToLatLongValue($rectangleData[0])` can be `null`; however, `__construct()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
42			$this->stringToLatLongValue( $rectangleData[1] )
			0 ignored issues – show Bug introduced 2017-09-28 11:15 UTC by Report Bug Copy Issue Report It seems like `$this->stringToLatLongValue($rectangleData[1])` can be `null`; however, `__construct()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
43			);
44
45			if ( $metaData !== [] ) {
46			$rectangle->setTitle( array_shift( $metaData ) );
47			}
48
49			if ( $metaData !== [] ) {
50			$rectangle->setText( array_shift( $metaData ) );
51			}
52
53			if ( $metaData !== [] ) {
54			$rectangle->setStrokeColor( array_shift( $metaData ) );
55			}
56
57			if ( $metaData !== [] ) {
58			$rectangle->setStrokeOpacity( array_shift( $metaData ) );
59			}
60
61			if ( $metaData !== [] ) {
62			$rectangle->setStrokeWeight( array_shift( $metaData ) );
63			}
64
65			return $rectangle;
66			}
67
68			private function stringToLatLongValue( $location ) {
69			$latLong = $this->geocoder->geocode( $location );
70
71			if ( $location === null ) {
72			throw new ParseException( 'Failed to parse or geocode' );
73			}
74
75			return $latLong;
76			}
77
78			}
79

JeroenDeDauw / Maps

Push — killgeocoders ( 08fbcb )

RectangleParser A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

3 Methods

Duplication Side-by-Side

Filter issues like