HtmlValidator - Code Metrics - Inspection of "Filtered" - SemanticMediaWiki/SemanticResultFormats - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#227)

by Stephan

created 2017-06-11 20:08 UTC

HtmlValidator A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	93
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

Metric	Value
wmc	12
lcom	1
cbo	1
dl	0
loc	93
rs	10
c	0
b	0
f	0

5 Methods

Rating	Name	Size	Complexity
A	assertThatHtmlIsValid()	5	1
A	assertThatHtmlContains()	8	4
B	loadHTML()	24	3
A	wrapHtmlFragment()	3	1
A	doAssert()	21	3

<?php

namespace SRF\Tests\Integration\JSONScript;

use DOMDocument;
use Symfony\Component\CssSelector\CssSelectorConverter;

/**
 * @license GNU GPL v2+
 * @since   2.5
 *
 * @author Stephan Gambke
 */
class HtmlValidator extends \PHPUnit_Framework_Assert {

	private $documentCache = [];

	/**
	 * @param string $actual
	 * @param string $message
	 */
	public function assertThatHtmlIsValid( $actual, $message = '' ) {

		$document = $this->loadHTML( $actual );
		self::assertNotFalse( $document, "Failed test `{$message}` (assertion HtmlIsValid) for $actual" );
	}

	/**
	 * @param string | string[] $expected
	 * @param string $actual
	 * @param string $message
	 */
	public function assertThatHtmlContains( $expected, $actual, $message = '' ) {

		$this->doAssert( $expected, $actual, function ( $rule, $count, $expectedCount = false ) use ( $message, $actual ) {
			$expectedCountText = $expectedCount === false? '' : ( $expectedCount . 'x ' );
			$message = "Failed test `{$message}` for assertion HtmlContains: $expectedCountText`$rule` for \n=====\n$actual\n=====";
$x = 1;
$callable = function() use ($x) {
    $x = 2; // Not visible in outer scope. If you would like this, how
            // about using a different variable name than $x?
};

$callable();
var_dump($x); // integer(1)
			self::assertTrue( ($expectedCount === false && $count > 0 ) || ( $count === $expectedCount ), $message );
		} );
	}

	/**
	 * @param string $fragment
	 * @return bool|DOMDocument
	 */
	protected function loadHTML( $fragment ) {

		$cacheKey = md5( $fragment );

		if ( !isset( $this->documentCache[ $cacheKey ] ) ) {

			$fragment = self::wrapHtmlFragment( $fragment );

			$document = new DOMDocument();
			$document->preserveWhiteSpace = false;

			libxml_use_internal_errors( true );
			$result = $document->loadHTML( $fragment );
			libxml_use_internal_errors( false );

			if ( $result === true ) {
				$this->documentCache[ $cacheKey ] = $document;
			} else {
				$this->documentCache[ $cacheKey ] = false;
			}
		}

		return $this->documentCache[ $cacheKey ];
	}

	/**
	 * @param string $fragment
	 * @return string
	 */
	protected static function wrapHtmlFragment( $fragment ) {
		return "<!DOCTYPE html><html><head><meta charset='utf-8'/><title>SomeTitle</title></head><body>$fragment</body></html>";
	}

	/**
	 * @param string[] $rules
	 * @param string $actual
	 * @param callable $cb
	 */
	private function doAssert( $rules, $actual, $cb ) {

		$document = $this->loadHTML( $actual );
		$xpath = new \DOMXPath( $document );
		$converter = new CssSelectorConverter();

		foreach ( $rules as $key => $rule ) {

			if ( is_array( $rule ) ) {
				$expectedCount = array_pop( $rule );
				$rule = array_shift( $rule );
			} else {
				$expectedCount = false;
			}

			$query = $converter->toXPath( $rule );
			$entries = $xpath->evaluate( $query );

			call_user_func( $cb, $rule, $entries->length, $expectedCount );
		}
	}

}


1			<?php
2
3			namespace SRF\Tests\Integration\JSONScript;
4
5			use DOMDocument;
6			use Symfony\Component\CssSelector\CssSelectorConverter;
7
8			/**
9			* @license GNU GPL v2+
10			* @since 2.5
11			*
12			* @author Stephan Gambke
13			*/
14			class HtmlValidator extends \PHPUnit_Framework_Assert {
15
16			private $documentCache = [];
17
18			/**
19			* @param string $actual
20			* @param string $message
21			*/
22			public function assertThatHtmlIsValid( $actual, $message = '' ) {
23
24			$document = $this->loadHTML( $actual );
25			self::assertNotFalse( $document, "Failed test `{$message}` (assertion HtmlIsValid) for $actual" );
26			}
27
28			/**
29			* @param string \| string[] $expected
30			* @param string $actual
31			* @param string $message
32			*/
33			public function assertThatHtmlContains( $expected, $actual, $message = '' ) {
34
35			$this->doAssert( $expected, $actual, function ( $rule, $count, $expectedCount = false ) use ( $message, $actual ) {
36			$expectedCountText = $expectedCount === false? '' : ( $expectedCount . 'x ' );
37			$message = "Failed test `{$message}` for assertion HtmlContains: $expectedCountText`$rule` for \n=====\n$actual\n=====";
			0 ignored issues – show Bug introduced 2017-06-11 20:05 UTC by Report Bug Copy Issue Report Consider using a different name than the imported variable `$message`, or did you forget to import by reference? It seems like you are assigning to a variable which was imported through a `use` statement which was not imported by reference. For clarity, we suggest to use a different name or import by reference depending on whether you would like to have the change visibile in outer-scope. Change not visible in outer-scope $x = 1; $callable = function() use ($x) { $x = 2; // Not visible in outer scope. If you would like this, how // about using a different variable name than $x? }; $callable(); var_dump($x); // integer(1) Change visible in outer-scope $x = 1; $callable = function() use (&$x) { $x = 2; }; $callable(); var_dump($x); // integer(2) Loading history...
38			self::assertTrue( ($expectedCount === false && $count > 0 ) \|\| ( $count === $expectedCount ), $message );
39			} );
40			}
41
42			/**
43			* @param string $fragment
44			* @return bool\|DOMDocument
45			*/
46			protected function loadHTML( $fragment ) {
47
48			$cacheKey = md5( $fragment );
49
50			if ( !isset( $this->documentCache[ $cacheKey ] ) ) {
51
52			$fragment = self::wrapHtmlFragment( $fragment );
53
54			$document = new DOMDocument();
55			$document->preserveWhiteSpace = false;
56
57			libxml_use_internal_errors( true );
58			$result = $document->loadHTML( $fragment );
59			libxml_use_internal_errors( false );
60
61			if ( $result === true ) {
62			$this->documentCache[ $cacheKey ] = $document;
63			} else {
64			$this->documentCache[ $cacheKey ] = false;
65			}
66			}
67
68			return $this->documentCache[ $cacheKey ];
69			}
70
71			/**
72			* @param string $fragment
73			* @return string
74			*/
75			protected static function wrapHtmlFragment( $fragment ) {
76			return "<!DOCTYPE html><html><head><meta charset='utf-8'/><title>SomeTitle</title></head><body>$fragment</body></html>";
77			}
78
79			/**
80			* @param string[] $rules
81			* @param string $actual
82			* @param callable $cb
83			*/
84			private function doAssert( $rules, $actual, $cb ) {
85
86			$document = $this->loadHTML( $actual );
87			$xpath = new \DOMXPath( $document );
88			$converter = new CssSelectorConverter();
89
90			foreach ( $rules as $key => $rule ) {
91
92			if ( is_array( $rule ) ) {
93			$expectedCount = array_pop( $rule );
94			$rule = array_shift( $rule );
95			} else {
96			$expectedCount = false;
97			}
98
99			$query = $converter->toXPath( $rule );
100			$entries = $xpath->evaluate( $query );
101
102			call_user_func( $cb, $rule, $entries->length, $expectedCount );
103			}
104			}
105
106			}
107

SemanticMediaWiki / SemanticResultFormats

Pull Request — master (#227)

HtmlValidator A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

5 Methods

Change not visible in outer-scope

Change visible in outer-scope

Duplication Side-by-Side

Filter issues like