Select element implementation (#10)

* Implement required select field * Implement <select> option matching, closes #3
PhpGt · Jan 1, 2020 · a771f4f · a771f4f
1 parent ef1d4b1
commit a771f4f
Show file tree

Hide file tree

Showing 6 changed files with 219 additions and 3 deletions.
diff --git a/src/DefaultValidationRules.php b/src/DefaultValidationRules.php
@@ -3,6 +3,7 @@
 
 use Gt\DomValidation\Rule\Pattern;
 use Gt\DomValidation\Rule\Required;
+use Gt\DomValidation\Rule\SelectElement;
 use Gt\DomValidation\Rule\TypeDate;
 use Gt\DomValidation\Rule\TypeEmail;
 use Gt\DomValidation\Rule\TypeNumber;
@@ -17,6 +18,7 @@ protected function setRuleList() {
 			new TypeEmail(),
 			new TypeUrl(),
 			new TypeDate(),
+			new SelectElement(),
 		];
 	}
 }
diff --git a/src/Rule/Rule.php b/src/Rule/Rule.php
@@ -10,7 +10,9 @@ abstract class Rule {
 	 * equals sign (e.g. "type=email"). For attributes without a value, pass the
 	 * attribute name on its own (e.g. "required").
 	 */
-	protected $attributes;
+	protected $attributes = [
+		"name"
+	];
 
 	public function getAttributes():array {
 		return $this->attributes;

diff --git a/src/Rule/SelectElement.php b/src/Rule/SelectElement.php
@@ -0,0 +1,44 @@
+<?php
+namespace Gt\DomValidation\Rule;
+
+use DOMElement;
+
+class SelectElement extends Rule {
+	public function isValid(DOMElement $element, string $value):bool {
+		$availableValues = [];
+
+		if($element->tagName !== "select") {
+			return true;
+		}
+
+		if($value === "") {
+			return true;
+		}
+
+		$optionElementList = $element->getElementsByTagName("option");
+		for($i = 0, $len = $optionElementList->length; $i < $len; $i++) {
+			$option = $optionElementList->item($i);
+
+			if($option->hasAttribute("value")) {
+				$optionValue = $option->getAttribute("value");
+			}
+			else {
+				$optionValue = $option->nodeValue;
+			}
+
+			if($optionValue !== "") {
+				$availableValues []= $optionValue;
+			}
+		}
+
+		if(!in_array($value, $availableValues)) {
+			return false;
+		}
+
+		return true;
+	}
+
+	public function getHint(DOMElement $element, string $value):string {
+		return "This field's value must match one of the available options";
+	}
+}
diff --git a/src/Validator.php b/src/Validator.php
@@ -33,10 +33,11 @@ public function validate(DOMElement $form, array $input):void {
 		foreach($this->rules->getAttributeRuleList() as $attrString => $ruleArray) {
 			/** @var Rule[] $ruleArray */
 
-			$xpath = new DOMXPath($form->ownerDocument);
+			$cssSelector = "[$attrString]";
 
+			$xpath = new DOMXPath($form->ownerDocument);
 			$inputElementList = $xpath->query(
-				new Translator("[$attrString]")
+				new Translator($cssSelector)
 			);
 
 			for($i = 0, $len = $inputElementList->length; $i < $len; $i++) {

diff --git a/test/phpunit/Helper/Helper.php b/test/phpunit/Helper/Helper.php
@@ -141,6 +141,37 @@ class Helper {
 </form>
 HTML;
 
+	const HTML_SELECT = <<<HTML
+<!doctype html>
+<form method="post">
+	<label>
+		<span>Currency</span>
+		<select name="currency" required>
+			<option></option>
+			<option value="GBP">£ Pound (GBP)</option>		
+			<option value="USD">$ Dollar (USD)</option>		
+			<option value="EUR">€ Euro (EUR)</option>		
+		</select>	
+	</label>
+	
+	<label>
+		<span>Sort order</span>
+		<select name="sort">
+			<option>Ascending</option>		
+			<option>Descending</option>		
+		</select>
+	</label>
+	
+	<label>
+		<span>Show connections</span>
+		<select name="connections">
+			<option value="">All</option>
+			<option value="native">Native only</option>
+			<option value="complex">Complex only</option>
+		</select>
+	</label>
+</form>
+HTML;
 
 
 }
diff --git a/test/phpunit/Rule/SelectElementTest.php b/test/phpunit/Rule/SelectElementTest.php
@@ -0,0 +1,136 @@
+<?php
+namespace Gt\DomValidation\Test\Rule;
+
+use Gt\DomValidation\Test\DomValidationTestCase;
+use Gt\DomValidation\Test\Helper\Helper;
+use Gt\DomValidation\ValidationException;
+use Gt\DomValidation\Validator;
+
+class SelectElementTest extends DomValidationTestCase {
+	public function testSelect() {
+		$form = self::getFormFromHtml(Helper::HTML_SELECT);
+		$validator = new Validator();
+
+		$exception = null;
+
+		try {
+			$validator->validate($form, [
+				"currency" => "GBP",
+			]);
+		}
+		catch(ValidationException $exception) {}
+
+		self::assertNull($exception);
+	}
+
+	public function testSelectMissingRequired() {
+		$form = self::getFormFromHtml(Helper::HTML_SELECT);
+		$validator = new Validator();
+
+		try {
+			$validator->validate($form, [
+				"currency" => "",
+			]);
+		}
+		catch(ValidationException $exception) {
+			$errorArray = iterator_to_array($validator->getLastErrorList());
+			self::assertCount(1, $errorArray);
+			$currencyErrorArray = $errorArray["currency"];
+			self::assertContains(
+				"This field is required",
+				$currencyErrorArray
+			);
+		}
+	}
+
+	public function testSelectTextContent() {
+		$form = self::getFormFromHtml(Helper::HTML_SELECT);
+		$validator = new Validator();
+
+		$exception = null;
+
+		try {
+			$validator->validate($form, [
+				"currency" => "USD",
+				"sort" => "Descending",
+			]);
+		}
+		catch(ValidationException $exception) {}
+
+		self::assertNull($exception);
+	}
+
+	public function testSelectTextContentInvalid() {
+		$form = self::getFormFromHtml(Helper::HTML_SELECT);
+		$validator = new Validator();
+
+		try {
+			$validator->validate($form, [
+				"currency" => "USD",
+				"sort" => "Random", // This <option> does not exist
+			]);
+		}
+		catch(ValidationException $exception) {
+			$errorArray = iterator_to_array($validator->getLastErrorList());
+			self::assertCount(1, $errorArray);
+			$currencyErrorArray = $errorArray["sort"];
+			self::assertContains(
+				"This field's value must match one of the available options",
+				$currencyErrorArray
+			);
+		}
+	}
+
+	public function testSelectValueInvalid() {
+		$form = self::getFormFromHtml(Helper::HTML_SELECT);
+		$validator = new Validator();
+
+		try {
+			$validator->validate($form, [
+				"currency" => "USD",
+				"connections" => "All", // This is invalid
+// There is an <option> with "All" as its text content, but not with this value.
+			]);
+		}
+		catch(ValidationException $exception) {
+			$errorArray = iterator_to_array($validator->getLastErrorList());
+			self::assertCount(1, $errorArray);
+			$currencyErrorArray = $errorArray["connections"];
+			self::assertContains(
+				"This field's value must match one of the available options",
+				$currencyErrorArray
+			);
+		}
+	}
+
+	public function testSelectTwoInvalidOptionsAndOneMissing() {
+		$form = self::getFormFromHtml(Helper::HTML_SELECT);
+		$validator = new Validator();
+
+		try {
+			$validator->validate($form, [
+				"connections" => "none",
+				"sort" => "random",
+			]);
+		}
+		catch(ValidationException $exception) {
+			$errorArray = iterator_to_array($validator->getLastErrorList());
+			self::assertCount(3, $errorArray);
+			$currencyErrorArray = $errorArray["currency"];
+			$sortErrorArray = $errorArray["sort"];
+			$connectionsErrorArray = $errorArray["connections"];
+			self::assertContains(
+				"This field is required",
+				$currencyErrorArray
+			);
+			self::assertContains(
+				"This field's value must match one of the available options",
+				$sortErrorArray
+			);
+			self::assertContains(
+				"This field's value must match one of the available options",
+				$connectionsErrorArray
+			);
+		}
+	}
+}