Extract common "wait for" functions to a helper class

Signed-off-by: Daniel Calviño Sánchez <danxuliu@gmail.com>

tests/acceptance/features/bootstrap/FilesAppContext.php

@@ -279,7 +279,8 @@ class FilesAppContext implements Context, ActorAwareInterface {
 		// The shared link field always exists in the DOM (once the "Sharing"
 		// tab is loaded), but its value is the actual shared link only when it
 		// is visible.
-		if (!$this->waitForElementToBeEventuallyShown(
+		if (!WaitFor::elementToBeEventuallyShown(
+				$this->actor,
 				self::shareLinkField(),
 				$timeout = 10 * $this->actor->getFindTimeoutMultiplier())) {
 			PHPUnit_Framework_Assert::fail("The shared link was not shown yet after $timeout seconds");
@@ -419,7 +420,8 @@ class FilesAppContext implements Context, ActorAwareInterface {
 	 * @When I see that the :tabName tab in the details view is eventually loaded
 	 */
 	public function iSeeThatTheTabInTheDetailsViewIsEventuallyLoaded($tabName) {
-		if (!$this->waitForElementToBeEventuallyNotShown(
+		if (!WaitFor::elementToBeEventuallyNotShown(
+				$this->actor,
 				self::loadingIconForTabInCurrentSectionDetailsViewNamed($tabName),
 				$timeout = 10 * $this->actor->getFindTimeoutMultiplier())) {
 			PHPUnit_Framework_Assert::fail("The $tabName tab in the details view has not been loaded after $timeout seconds");
@@ -437,7 +439,8 @@ class FilesAppContext implements Context, ActorAwareInterface {
 	 * @Then I see that the working icon for password protect is eventually not shown
 	 */
 	public function iSeeThatTheWorkingIconForPasswordProtectIsEventuallyNotShown() {
-		if (!$this->waitForElementToBeEventuallyNotShown(
+		if (!WaitFor::elementToBeEventuallyNotShown(
+				$this->actor,
 				self::passwordProtectWorkingIcon(),
 				$timeout = 10 * $this->actor->getFindTimeoutMultiplier())) {
 			PHPUnit_Framework_Assert::fail("The working icon for password protect is still shown after $timeout seconds");
@@ -454,31 +457,4 @@ class FilesAppContext implements Context, ActorAwareInterface {
 		$this->iSeeThatTheWorkingIconForPasswordProtectIsEventuallyNotShown();
 	}
 
-	private function waitForElementToBeEventuallyShown($elementLocator, $timeout = 10, $timeoutStep = 1) {
-		$actor = $this->actor;
-
-		$elementShownCallback = function() use ($actor, $elementLocator) {
-			try {
-				return $actor->find($elementLocator)->isVisible();
-			} catch (NoSuchElementException $exception) {
-				return false;
-			}
-		};
-
-		return Utils::waitFor($elementShownCallback, $timeout, $timeoutStep);
-	}
-
-	private function waitForElementToBeEventuallyNotShown($elementLocator, $timeout = 10, $timeoutStep = 1) {
-		$actor = $this->actor;
-
-		$elementNotShownCallback = function() use ($actor, $elementLocator) {
-			try {
-				return !$actor->find($elementLocator)->isVisible();
-			} catch (NoSuchElementException $exception) {
-				return true;
-			}
-		};
-
-		return Utils::waitFor($elementNotShownCallback, $timeout, $timeoutStep);
-	}
 }

tests/acceptance/features/bootstrap/FilesSharingAppContext.php

@@ -185,8 +185,8 @@ class FilesSharingAppContext implements Context, ActorAwareInterface {
 		// Unlike other menus, the Share menu is always present in the DOM, so
 		// the element could be found when it was no made visible yet due to the
 		// command not having been processed by the browser.
-		if (!$this->waitForElementToBeEventuallyShown(
-				self::shareMenu(), $timeout = 10 * $this->actor->getFindTimeoutMultiplier())) {
+		if (!WaitFor::elementToBeEventuallyShown(
+				$this->actor, self::shareMenu(), $timeout = 10 * $this->actor->getFindTimeoutMultiplier())) {
 			PHPUnit_Framework_Assert::fail("The Share menu is not visible yet after $timeout seconds");
 		}
 
@@ -205,18 +205,4 @@ class FilesSharingAppContext implements Context, ActorAwareInterface {
 		PHPUnit_Framework_Assert::assertContains($text, $this->actor->find(self::textPreview(), 10)->getText());
 	}
 
-	private function waitForElementToBeEventuallyShown($elementLocator, $timeout = 10, $timeoutStep = 1) {
-		$actor = $this->actor;
-
-		$elementShownCallback = function() use ($actor, $elementLocator) {
-			try {
-				return $actor->find($elementLocator)->isVisible();
-			} catch (NoSuchElementException $exception) {
-				return false;
-			}
-		};
-
-		return Utils::waitFor($elementShownCallback, $timeout, $timeoutStep);
-	}
-
 }

tests/acceptance/features/bootstrap/WaitFor.php

@@ -0,0 +1,78 @@
+<?php
+
+/**
+ *
+ * @copyright Copyright (c) 2018, Daniel Calviño Sánchez (danxuliu@gmail.com)
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+/**
+ * Helper class with common "wait for" functions.
+ */
+class WaitFor {
+
+	/**
+	 * Waits for the element to be visible.
+	 *
+	 * @param Actor $actor the Actor used to find the element.
+	 * @param Locator $elementLocator the locator for the element.
+	 * @param float $timeout the number of seconds (decimals allowed) to wait at
+	 *        most for the element to be visible.
+	 * @param float $timeoutStep the number of seconds (decimals allowed) to
+	 *        wait before checking the visibility again.
+	 * @return boolean true if the element is visible before (or exactly when)
+	 *         the timeout expires, false otherwise.
+	 */
+	public static function elementToBeEventuallyShown(Actor $actor, Locator $elementLocator, $timeout = 10, $timeoutStep = 1) {
+		$elementShownCallback = function() use ($actor, $elementLocator) {
+			try {
+				return $actor->find($elementLocator)->isVisible();
+			} catch (NoSuchElementException $exception) {
+				return false;
+			}
+		};
+
+		return Utils::waitFor($elementShownCallback, $timeout, $timeoutStep);
+	}
+
+	/**
+	 * Waits for the element to be hidden (either not visible or not found in
+	 * the DOM).
+	 *
+	 * @param Actor $actor the Actor used to find the element.
+	 * @param Locator $elementLocator the locator for the element.
+	 * @param float $timeout the number of seconds (decimals allowed) to wait at
+	 *        most for the element to be hidden.
+	 * @param float $timeoutStep the number of seconds (decimals allowed) to
+	 *        wait before checking the visibility again.
+	 * @return boolean true if the element is hidden before (or exactly when)
+	 *         the timeout expires, false otherwise.
+	 */
+	public static function elementToBeEventuallyNotShown(Actor $actor, Locator $elementLocator, $timeout = 10, $timeoutStep = 1) {
+		$elementNotShownCallback = function() use ($actor, $elementLocator) {
+			try {
+				return !$actor->find($elementLocator)->isVisible();
+			} catch (NoSuchElementException $exception) {
+				return true;
+			}
+		};
+
+		return Utils::waitFor($elementNotShownCallback, $timeout, $timeoutStep);
+	}
+
+}