Housekeeping for line endings

Author: Bruce Wells

.gitiattributes

@@ -0,0 +1,7 @@
+# no binary files in this repo and store all files with LF line endings.
+
+# for windows do the following:
+# git config --global core.eol native
+# git config --global core.autocrlf true
+
+* text=auto

.gitignore

@@ -4,3 +4,4 @@ bin/
 composer.lock
 .php_cs.cache
 .phpunit.result.cache
+phpunit.xml

README.md

@@ -17,14 +17,13 @@ It is recommended you run [https://github.com/validator/validator](https://githu
 ```
 java -Xss512k -cp vnu.jar nu.validator.servlet.Main 8888
 ```
-In your phpunit.xml.dist config file, add the following lines in the **phpunit** element:
+If you are not using a local server, you will need to add the following lines to your phpunit.xml config in the **phpunit** element:
 ```xml
 <php>
-	<env name="PHPFUI\HTMLUnitTester\Extensions_url" value="http://127.0.0.1:8888"/>
-	<env name="PHPFUI\HTMLUnitTester\Extensions_delay" value="0"/>
+  <env name="PHPFUI\HTMLUnitTester\Extensions_url" value="http://validator.w3.org/nu"/>
+  <env name="PHPFUI\HTMLUnitTester\Extensions_delay" value="500000"/>
 </php>
 ```
-You can run against the online version at (http://validator.w3.org/nu/), but is recomended to use a delay of 500000 or higher to avoid overloading the server.
 
 ## Usage
 Extend your unit tests from \PHPFUI\HTMLUnitTester\Extensions

src/PHPFUI/HTMLUnitTester/ErrorConstraint.php

@@ -1,16 +1,16 @@
 <?php
-
+
 /*
  * This file is part of the HTMLUnitTester package.
  *
  * (c) Bruce Wells <brucekwells@gmail.com>
  *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
- */
-
-namespace PHPFUI\HTMLUnitTester;
-
+ */
+
+namespace PHPFUI\HTMLUnitTester;
+
 class ErrorConstraint extends \PHPUnit\Framework\Constraint\Constraint
 	{
 	/**
@@ -20,8 +20,8 @@ class ErrorConstraint extends \PHPUnit\Framework\Constraint\Constraint
 	public function toString() : string
 		{
 		return 'is valid';
-		}
-
+		}
+
 	/**
 	* Return additional failure description where needed.
 	*
@@ -34,8 +34,8 @@ public function toString() : string
 	protected function additionalFailureDescription($other) : string
 		{
 		return implode("\n", $other->getErrors());
-		}
-
+		}
+
 	/**
 	* Returns the description of the failure.
 	*
@@ -48,8 +48,8 @@ protected function additionalFailureDescription($other) : string
 	protected function failureDescription($other) : string
 		{
 		return 'the markup ' . $this->toString();
-		}
-
+		}
+
 	/**
 	* Evaluates the constraint for parameter $other. Returns TRUE if the
 	* constraint is met, FALSE otherwise.
@@ -60,6 +60,6 @@ protected function failureDescription($other) : string
 	protected function matches($other) : bool
 		{
 		return ! $other->hasErrors();
-		}
-
-	}
+		}
+
+	}

src/PHPFUI/HTMLUnitTester/Extensions.php

@@ -1,5 +1,5 @@
 <?php
-
+
 /**
  * This file is part of the PHPFUI/HTMLUnitTester package
  *
@@ -8,159 +8,159 @@
  * For the full copyright and license information, please view
  * the LICENSE.md file that was distributed with this source
  * code
- */
-
-namespace PHPFUI\HTMLUnitTester;
-
+ */
+
+namespace PHPFUI\HTMLUnitTester;
+
 class Extensions extends \PHPUnit\Framework\TestCase implements \PHPUnit\Runner\Hook
-	{
-
+	{
+
 	private static $throttle;
-	private static $validator;
-
+	private static $validator;
+
 	public static function setUpBeforeClass() : void
 		{
 		$url = $_ENV[__CLASS__ . '_url'] ?? 'http://127.0.0.1:8888';
 		$throttleMicroSeconds = $_ENV[__CLASS__ . '_delay'] ?? 0;
 		if (! filter_var($url, FILTER_VALIDATE_URL))
 			{
 			throw new \PHPUnit\Framework\Exception($url . ' is not a valid URL');
-			}
-
+			}
+
 		self::$throttle = new Throttle($throttleMicroSeconds);
 		self::$validator = new \HtmlValidator\Validator($url);
-		}
-
+		}
+
 	public function assertNotWarningCss(string $css, string $message = '') : void
 		{
 		$response = $this->validateCss($css);
 		self::assertThat($response, new WarningConstraint(), $message);
-		}
-
+		}
+
 	public function assertNotWarningCssFile(string $file, string $message = '') : void
 		{
 		$response = $this->validateCss($this->getFromFile($file));
 		self::assertThat($response, new WarningConstraint(), $message);
-		}
-
+		}
+
 	public function assertNotWarningCssUrl(string $url, string $message = '') : void
 		{
 		$response = $this->validateCss($this->getFromUrl($url));
 		self::assertThat($response, new WarningConstraint(), $message);
-		}
-
+		}
+
 	public function assertNotWarningFile(string $file, string $message = '') : void
 		{
 		$response = $this->validateHtml($this->getFromFile($file));
 		self::assertThat($response, new WarningConstraint(), $message);
-		}
-
+		}
+
 	public function assertNotWarningHtml(string $html, string $message = '') : void
 		{
 		$response = $this->validateHtml($html);
 		self::assertThat($response, new WarningConstraint(), $message);
-		}
-
+		}
+
 	public function assertNotWarningUrl(string $url, string $message = '') : void
 		{
 		$response = $this->validateHtml($this->getFromUrl($url));
 		self::assertThat($response, new ErrorConstraint(), $message);
-		}
-
+		}
+
 	public function assertValidCss(string $css, string $message = '') : void
 		{
 		$response = $this->validateCss($css);
 		self::assertThat($response, new ErrorConstraint(), $message);
-		}
-
+		}
+
 	public function assertValidCssFile(string $file, string $message = '') : void
 		{
 		$response = $this->validateCss($this->getFromFile($file));
 		self::assertThat($response, new ErrorConstraint(), $message);
-		}
-
+		}
+
 	public function assertValidCssUrl(string $url, string $message = '') : void
 		{
 		$response = $this->validateCss($this->getFromUrl($url));
 		self::assertThat($response, new ErrorConstraint(), $message);
-		}
-
+		}
+
 	public function assertValidFile(string $file, string $message = '') : void
 		{
 		$response = $this->validateHtml($this->getFromFile($file));
 		self::assertThat($response, new ErrorConstraint(), $message);
-		}
-
+		}
+
 	public function assertValidHtml(string $html, string $message = '') : void
 		{
 		$response = $this->validateHtml($html);
 		self::assertThat($response, new ErrorConstraint(), $message);
-		}
-
+		}
+
 	public function assertValidUrl(string $url, string $message = '') : void
 		{
 		$response = $this->validateHtml($this->getFromUrl($url));
 		self::assertThat($response, new ErrorConstraint(), $message);
-		}
-
+		}
+
 	private function getFromFile(string $file) : string
 		{
 		if (! file_exists($file))
 			{
 			throw new \PHPUnit\Framework\Exception("File {$file} was not found.\n");
-			}
-
+			}
+
 		if (! is_readable($file))
 			{
 			throw new \PHPUnit\Framework\Exception("File {$file} is not readable.\n");
 			}
-		$html = file_get_contents($file);
-
+		$html = file_get_contents($file);
+
 		return $html;
-		}
-
+		}
+
 	private function getFromUrl(string $url) : string
 		{
 		// Check that $url is a valid url
 		if (false === filter_var($url, FILTER_VALIDATE_URL))
 			{
 			throw new \PHPUnit\Framework\Exception("Url {$url} is not valid.\n");
-			}
-
+			}
+
 		$context  = stream_context_create(['http' => ['user_agent' => 'Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:69.0) Gecko/20100101 Firefox/69.0']]);
-		$html = file_get_contents($url, false, $context);
-
+		$html = file_get_contents($url, false, $context);
+
 		// Check that something was returned
 		if (! strlen($html))
 			{
 			throw new \PHPUnit\Framework\Exception("{$url} is empty.\n");
-			}
-
+			}
+
 		return $html;
-		}
-
+		}
+
 	private function validateCss(string $css) : \HtmlValidator\Response
 		{
 		if (false === stripos($css, 'html>'))
 			{
 			$css = '<!DOCTYPE html><html><head><meta charset="utf-8" /><title>Title</title><style>' . $css . '</style></head><body><hr></body></html>';
 			}
 		self::$throttle->delay();
-		$response = self::$validator->validateDocument($css);
-
+		$response = self::$validator->validateDocument($css);
+
 		return $response;
-		}
-
+		}
+
 	private function validateHtml(string $html) : \HtmlValidator\Response
 		{
 		if (false === stripos($html, 'html>'))
 			{
 			$html = '<!DOCTYPE html><html><head><meta charset="utf-8" /><title>Title</title></head><body>' . $html . '</body></html>';
 			}
 		self::$throttle->delay();
-		$response = self::$validator->validateDocument($html);
-
+		$response = self::$validator->validateDocument($html);
+
 		return $response;
-		}
-
+		}
+
 	}

src/PHPFUI/HTMLUnitTester/WarningConstraint.php

@@ -1,16 +1,16 @@
 <?php
-
+
 /*
  * This file is part of the HTMLUnitTester package.
  *
  * (c) Bruce Wells <brucekwells@gmail.com>
  *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
- */
-
-namespace PHPFUI\HTMLUnitTester;
-
+ */
+
+namespace PHPFUI\HTMLUnitTester;
+
 class WarningConstraint extends \PHPUnit\Framework\Constraint\Constraint
 	{
 	/**
@@ -20,8 +20,8 @@ class WarningConstraint extends \PHPUnit\Framework\Constraint\Constraint
 	public function toString() : string
 		{
 		return 'is valid';
-		}
-
+		}
+
 	/**
 	* Return additional failure description where needed.
 	*
@@ -34,8 +34,8 @@ public function toString() : string
 	protected function additionalFailureDescription($other) : string
 		{
 		return implode("\n", $other->getWarnings());
-		}
-
+		}
+
 	/**
 	* Returns the description of the failure.
 	*
@@ -48,8 +48,8 @@ protected function additionalFailureDescription($other) : string
 	protected function failureDescription($other) : string
 		{
 		return 'the markup ' . $this->toString();
-		}
-
+		}
+
 	/**
 	* Evaluates the constraint for parameter $other. Returns TRUE if the
 	* constraint is met, FALSE otherwise.
@@ -60,6 +60,6 @@ protected function failureDescription($other) : string
 	protected function matches($other) : bool
 		{
 		return ! $other->hasWarnings();
-		}
-
-	}
+		}
+
+	}