Allow to deselect option of <select> by partial text

Author: OndraM

lib/WebDriverSelect.php

@@ -40,9 +40,7 @@ public function __construct(WebDriverElement $element)
     }
 
     /**
-     * @return bool Whether this select element support selecting multiple
-     *              options. This is done by checking the value of the 'multiple'
-     *              attribute.
+     * @return bool Whether this select element support selecting multiple options.
      */
     public function isMultiple()
     {
@@ -89,26 +87,6 @@ public function getFirstSelectedOption()
         throw new NoSuchElementException('No options are selected');
     }
 
-    /**
-     * Deselect all options in multiple select tag.
-     *
-     * @throws UnsupportedOperationException
-     */
-    public function deselectAll()
-    {
-        if (!$this->isMultiple()) {
-            throw new UnsupportedOperationException(
-                'You may only deselect all options of a multi-select'
-            );
-        }
-
-        foreach ($this->getOptions() as $option) {
-            if ($option->isSelected()) {
-                $option->click();
-            }
-        }
-    }
-
     /**
      * Select the option at the given index.
      *
@@ -252,6 +230,24 @@ public function selectByVisiblePartialText($text)
         }
     }
 
+    /**
+     * Deselect all options in multiple select tag.
+     *
+     * @throws UnsupportedOperationException If the SELECT does not support multiple selections
+     */
+    public function deselectAll()
+    {
+        if (!$this->isMultiple()) {
+            throw new UnsupportedOperationException('You may only deselect all options of a multi-select');
+        }
+
+        foreach ($this->getOptions() as $option) {
+            if ($option->isSelected()) {
+                $option->click();
+            }
+        }
+    }
+
     /**
      * Deselect the option at the given index.
      *
@@ -268,7 +264,7 @@ public function deselectByIndex($index)
 
     /**
      * Deselect all options that have value attribute matching the argument. That
-     * is, when given "foo" this would select an option like:
+     * is, when given "foo" this would deselect an option like:
      *
      * <option value="foo">Bar</option>;
      *
@@ -287,7 +283,7 @@ public function deselectByValue($value)
 
     /**
      * Deselect all options that display text matching the argument. That is, when
-     * given "Bar" this would select an option like:
+     * given "Bar" this would deselect an option like:
      *
      * <option value="foo">Bar</option>;
      *
@@ -304,6 +300,30 @@ public function deselectByVisibleText($text)
         }
     }
 
+    /**
+     * Deselect all options that display text matching the argument. That is, when
+     * given "Bar" this would deselect an option like:
+     *
+     * <option value="foo">Foo Bar Baz</option>;
+     *
+     * @param string $text The visible text to match against.
+     * @throws UnsupportedOperationException If the SELECT does not support multiple selections
+     */
+    public function deselectByVisiblePartialText($text)
+    {
+        if (!$this->isMultiple()) {
+            throw new UnsupportedOperationException('You may only deselect options of a multi-select');
+        }
+
+        $xpath = './/option[contains(normalize-space(.), ' . $this->escapeQuotes($text) . ')]';
+        $options = $this->element->findElements(WebDriverBy::xpath($xpath));
+        foreach ($options as $option) {
+            if ($option->isSelected()) {
+                $option->click();
+            }
+        }
+    }
+
     /**
      * Convert strings with both quotes and ticks into:
      *   foo'"bar -> concat("foo'", '"', "bar")

tests/functional/WebDriverSelectTest.php

@@ -353,6 +353,38 @@ public function testShouldDeselectOptionByVisibleText()
         $this->assertContainsOptionsWithValues(['second'], $select->getAllSelectedOptions());
     }
 
+    public function testShouldDeselectOptionByVisiblePartialText()
+    {
+        $select = $this->getWebDriverSelectForMultipleSelect();
+        $select->selectByValue('fourth'); // text 'Fourth  with   spaces   inside'
+        $select->selectByValue('fifth'); // text '   Fifth surrounded by spaces    '
+        $select->selectByValue('second'); // text 'This is second option'
+        $select->selectByValue('third'); // text 'This is not second option'
+        $select->selectByValue('first'); // text 'First'
+        $this->assertCount(5, $select->getAllSelectedOptions());
+
+        $select->deselectByVisiblePartialText('second'); // should deselect two options
+        $this->assertContainsOptionsWithValues(['first', 'fourth', 'fifth'], $select->getAllSelectedOptions());
+
+        $select->deselectByVisiblePartialText('Fourth with spaces');
+        $select->deselectByVisiblePartialText('Fourth with spaces'); // should be deselected even if deselected again
+        $this->assertContainsOptionsWithValues(['first', 'fifth'], $select->getAllSelectedOptions());
+
+        $select->deselectByVisiblePartialText('Fifth surrounded');
+        $this->assertContainsOptionsWithValues(['first'], $select->getAllSelectedOptions());
+    }
+
+    public function testShouldThrowExceptionIfDeselectingSimpleSelectByVisiblePartialText()
+    {
+        $select = $this->getWebDriverSelectForSimpleSelect();
+
+        $this->setExpectedException(
+            UnsupportedOperationException::class,
+            'You may only deselect options of a multi-select'
+        );
+        $select->deselectByVisiblePartialText('First');
+    }
+
     /**
      * @return WebDriverSelect
      */