ChildElementMatcher::describeTo() - Code Metrics - Inspection of "[WIP] Optimize all matchers for performance" - wmde/hamcrest-html-matchers - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#9)

by no

created 2018-04-18 13:15 UTC

ChildElementMatcher::describeTo() A

↳ Parent: ChildElementMatcher

Complexity

Conditions	3
Paths	3

Size

Total Lines	10
Code Lines	7

Duplication

Lines	10
Ratio	100 %

Code Coverage

Tests	8
CRAP Score	3.0123

Importance

Changes

Metric	Value
cc	3
eloc	7
nc	3
nop	1
dl	10
loc	10
ccs	8
cts	9
cp	0.8889
crap	3.0123
rs	9.4285
c	0
b	0
f	0

<?php

namespace WMDE\HamcrestHtml;

use Hamcrest\Description;
use Hamcrest\Matcher;
use Hamcrest\TypeSafeDiagnosingMatcher;

class ChildElementMatcher extends TypeSafeDiagnosingMatcher {

	/**
	 * @var Matcher|string|null
	 */
	private $matcher;

	/**
	 * @param Matcher|string|null $elementMatcher
	 *
	 * @return self
	 */
	public static function havingChild( $elementMatcher = null ) {
		return new static( $elementMatcher );
	}

	/**
	 * @param Matcher|string|null $matcher
	 */
	public function __construct( $matcher = null ) {
		parent::__construct( \DOMNode::class );
		$this->matcher = $matcher;
	}

	public function describeTo( Description $description ) {

		$description->appendText( 'having child ' );
		if ( $this->matcher ) {
			if ( $this->matcher instanceof Matcher ) {
				$description->appendDescriptionOf( $this->matcher );
			} else {
				$description->appendValue( $this->matcher );
			}
		}
	}

	/**
	 * @param \DOMDocument|\DOMNode $item
	 * @param Description $mismatchDescription
	 *
	 * @return bool
	 */
	protected function matchesSafelyWithDiagnosticDescription( $item, Description $mismatchDescription ) {
		if ( $item instanceof \DOMDocument ) {
			$item = $item->documentElement->childNodes->item( 0 );
			/** @var \DOMElement $item */
		}
		$directChildren = $item->childNodes;

		if ( $directChildren->length === 0 ) {
			$mismatchDescription->appendText( 'having no children' );
			return false;
		}

		if ( !$this->matcher ) {
			return true;
		}

		if ( $this->matcher instanceof Matcher ) {
			foreach ( new XmlNodeRecursiveIterator( $directChildren ) as $child ) {
				if ( $this->matcher->matches( $child ) ) {
					return true;
				}
			}
		} else {
			if ( $item->getElementsByTagName( $this->matcher )->length !== 0 ) {
				return true;
			}
		}

		$mismatchDescription->appendText( 'having no children ' )->appendDescriptionOf( $this->matcher );
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
		return false;
	}

}


1			<?php
2
3			namespace WMDE\HamcrestHtml;
4
5			use Hamcrest\Description;
6			use Hamcrest\Matcher;
7			use Hamcrest\TypeSafeDiagnosingMatcher;
8
9			class ChildElementMatcher extends TypeSafeDiagnosingMatcher {
10
11			/**
12			* @var Matcher\|string\|null
13			*/
14			private $matcher;
15
16			/**
17			* @param Matcher\|string\|null $elementMatcher
18			*
19			* @return self
20			*/
21			public static function havingChild( $elementMatcher = null ) {
22			return new static( $elementMatcher );
23			}
24
25			/**
26			* @param Matcher\|string\|null $matcher
27			*/
28			public function __construct( $matcher = null ) {
29			parent::__construct( \DOMNode::class );
30			$this->matcher = $matcher;
31			}
32
33	7	View Code Duplication	public function describeTo( Description $description ) {
			0 ignored issues – show Duplication introduced 2018-04-16 08:47 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
34	7		$description->appendText( 'having child ' );
35	7		if ( $this->matcher ) {
36	6		if ( $this->matcher instanceof Matcher ) {
37	6		$description->appendDescriptionOf( $this->matcher );
38	6		} else {
39			$description->appendValue( $this->matcher );
40			}
41	6		}
42	7		}
43
44			/**
45			* @param \DOMDocument\|\DOMNode $item
46			* @param Description $mismatchDescription
47			*
48			* @return bool
49			*/
50	17		protected function matchesSafelyWithDiagnosticDescription( $item, Description $mismatchDescription ) {
51	17		if ( $item instanceof \DOMDocument ) {
52	16		$item = $item->documentElement->childNodes->item( 0 );
53			/** @var \DOMElement $item */
54	16		}
55	17		$directChildren = $item->childNodes;
56
57	17		if ( $directChildren->length === 0 ) {
58	1		$mismatchDescription->appendText( 'having no children' );
59	1		return false;
60			}
61
62	16		if ( !$this->matcher ) {
63			return true;
64			}
65
66	16		if ( $this->matcher instanceof Matcher ) {
67	16		foreach ( new XmlNodeRecursiveIterator( $directChildren ) as $child ) {
68	16		if ( $this->matcher->matches( $child ) ) {
69	10		return true;
70			}
71	11		}
72	6		} else {
73			if ( $item->getElementsByTagName( $this->matcher )->length !== 0 ) {
74			return true;
75			}
76			}
77
78	6		$mismatchDescription->appendText( 'having no children ' )->appendDescriptionOf( $this->matcher );
			0 ignored issues – show Bug introduced 2018-04-16 08:47 UTC by Report Bug Copy Issue Report It seems like `$this->matcher` can also be of type `string`; however, `Hamcrest\Description::appendDescriptionOf()` does only seem to accept `object<Hamcrest\SelfDescribing>`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
79	6		return false;
80			}
81
82			}
83

wmde / hamcrest-html-matchers

GitHub Access Token became invalid

Pull Request — master (#9)

ChildElementMatcher::describeTo() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like