Merge pull request #494 from qheaden/visibility-multiple-elements

Add condition to check whether visibility of any of elements was located

Author: OndraM

CHANGELOG.md

@@ -5,6 +5,9 @@ This project versioning adheres to [Semantic Versioning](http://semver.org/).
 ### Changed
 - Drop PHP 5.5 support, the minimal required version of PHP is now PHP 5.6.
 
+### Added
+- Added a visibilityOfAnyElementsLocated method to WebDriverExpectedCondition.
+
 ## 1.4.1 - 2017-04-28
 ### Fixed
 - Do not throw notice `Constant CURLOPT_CONNECTTIMEOUT_MS already defined`.

lib/WebDriverExpectedCondition.php

@@ -193,6 +193,35 @@ function (WebDriver $driver) use ($by) {
         );
     }
 
+    /**
+     * An expectation for checking than at least one element in an array of elements is present on the
+     * DOM of a page and visible.
+     * Visibility means that the element is not only displayed but also has a height and width that is greater than 0.
+     *
+     * @param WebDriverBy $by The located used to find the element.
+     * @return WebDriverExpectedCondition<WebDriverElement> Condition returns the elements that are located and visible.
+     */
+    public static function visibilityOfAnyElementLocated(WebDriverBy $by)
+    {
+        return new static(
+            function (WebDriver $driver) use ($by) {
+                $elements = $driver->findElements($by);
+                $visibleElements = [];
+
+                foreach ($elements as $element) {
+                    try {
+                        if ($element->isDisplayed()) {
+                            $visibleElements[] = $element;
+                        }
+                    } catch (StateElementReferenceException $e) {
+                    }
+                }
+
+                return count($visibleElements) > 0 ? $visibleElements : null;
+            }
+        );
+    }
+
     /**
      * An expectation for checking that an element, known to be present on the DOM of a page, is visible.
      * Visibility means that the element is not only displayed but also has a height and width that is greater than 0.

tests/unit/WebDriverExpectedConditionTest.php

@@ -185,6 +185,36 @@ public function testShouldDetectVisibilityOfElementLocatedCondition()
         $this->assertSame($element, $this->wait->until($condition));
     }
 
+    public function testShouldDetectVisibilityOfAnyElementLocated()
+    {
+        $elementList = [
+            $this->createRemoteWebElementMock(),
+            $this->createRemoteWebElementMock(),
+            $this->createRemoteWebElementMock(),
+        ];
+
+        $elementList[0]->expects($this->once())
+            ->method('isDisplayed')
+            ->willReturn(false);
+
+        $elementList[1]->expects($this->once())
+            ->method('isDisplayed')
+            ->willReturn(true);
+
+        $elementList[2]->expects($this->once())
+            ->method('isDisplayed')
+            ->willReturn(true);
+
+        $this->driverMock->expects($this->once())
+            ->method('findElements')
+            ->with($this->isInstanceOf(WebDriverBy::class))
+            ->willReturn($elementList);
+
+        $condition = WebDriverExpectedCondition::visibilityOfAnyElementLocated(WebDriverBy::cssSelector('.foo'));
+
+        $this->assertSame([$elementList[1], $elementList[2]], $this->wait->until($condition));
+    }
+
     public function testShouldDetectInvisibilityOfElementLocatedConditionOnNoSuchElementException()
     {
         $element = $this->createRemoteWebElementMock();