Add common interface for WebDriverNavigation classes to improve LSP

Author: OndraM

CHANGELOG.md

@@ -14,6 +14,7 @@ This project versioning adheres to [Semantic Versioning](http://semver.org/).
 - Rename environment variable used to pass path to ChromeDriver executable from `webdriver.chrome.driver` to `WEBDRIVER_CHROME_DRIVER`. However the old one also still works to keep backward compatibility
 - If subdirectories in a path to screenshot destination does not exists (using `takeScreenshot()` or `takeElementScreenshot()` methods), they are automatically created.
 - When zip archive cannot be crated during file upload, throw exception instead of silently returning false.
+- `WebDriverNavigation` and `EventFiringWebDriverNavigation` now both implement new `WebDriverNavigationInterface`.
 
 ### Fixed
 - `WebDriverExpectedCondition::presenceOfElementLocated()` works correctly when used within `WebDriverExpectedCondition::not()`.

lib/Support/Events/EventFiringWebDriverNavigation.php

@@ -17,12 +17,12 @@
 
 use Facebook\WebDriver\Exception\WebDriverException;
 use Facebook\WebDriver\WebDriverDispatcher;
-use Facebook\WebDriver\WebDriverNavigation;
+use Facebook\WebDriver\WebDriverNavigationInterface;
 
-class EventFiringWebDriverNavigation
+class EventFiringWebDriverNavigation implements WebDriverNavigationInterface
 {
     /**
-     * @var WebDriverNavigation
+     * @var WebDriverNavigationInterface
      */
     protected $navigator;
     /**
@@ -31,10 +31,10 @@ class EventFiringWebDriverNavigation
     protected $dispatcher;
 
     /**
-     * @param WebDriverNavigation $navigator
+     * @param WebDriverNavigationInterface $navigator
      * @param WebDriverDispatcher $dispatcher
      */
-    public function __construct(WebDriverNavigation $navigator, WebDriverDispatcher $dispatcher)
+    public function __construct(WebDriverNavigationInterface $navigator, WebDriverDispatcher $dispatcher)
     {
         $this->navigator = $navigator;
         $this->dispatcher = $dispatcher;
@@ -49,17 +49,13 @@ public function getDispatcher()
     }
 
     /**
-     * @return WebDriverNavigation
+     * @return WebDriverNavigationInterface
      */
     public function getNavigator()
     {
         return $this->navigator;
     }
 
-    /**
-     * @throws WebDriverException
-     * @return $this
-     */
     public function back()
     {
         $this->dispatch(
@@ -79,10 +75,6 @@ public function back()
         return $this;
     }
 
-    /**
-     * @throws WebDriverException
-     * @return $this
-     */
     public function forward()
     {
         $this->dispatch(
@@ -102,10 +94,6 @@ public function forward()
         return $this;
     }
 
-    /**
-     * @throws WebDriverException
-     * @return $this
-     */
     public function refresh()
     {
         try {
@@ -118,11 +106,6 @@ public function refresh()
         }
     }
 
-    /**
-     * @param mixed $url
-     * @throws WebDriverException
-     * @return $this
-     */
     public function to($url)
     {
         $this->dispatch(

lib/WebDriver.php

@@ -115,7 +115,7 @@ public function manage();
      * An abstraction allowing the driver to access the browser's history and to
      * navigate to a given URL.
      *
-     * @return WebDriverNavigation
+     * @return WebDriverNavigationInterface
      * @see WebDriverNavigation
      */
     public function navigate();

lib/WebDriverNavigation.php

@@ -18,16 +18,7 @@
 use Facebook\WebDriver\Remote\DriverCommand;
 use Facebook\WebDriver\Remote\ExecuteMethod;
 
-/**
- * An abstraction allowing the driver to access the browser's history and to
- * navigate to a given URL.
- *
- * Note that they are all blocking functions until the page is loaded by
- * by default. It could be overridden by 'webdriver.load.strategy' in the
- * FirefoxProfile preferences.
- * https://github.com/SeleniumHQ/selenium/wiki/DesiredCapabilities#firefoxprofile-settings
- */
-class WebDriverNavigation
+class WebDriverNavigation implements WebDriverNavigationInterface
 {
     protected $executor;
 
@@ -36,49 +27,27 @@ public function __construct(ExecuteMethod $executor)
         $this->executor = $executor;
     }
 
-    /**
-     * Move back a single entry in the browser's history, if possible.
-     *
-     * @return WebDriverNavigation The instance.
-     */
     public function back()
     {
         $this->executor->execute(DriverCommand::GO_BACK);
 
         return $this;
     }
 
-    /**
-     * Move forward a single entry in the browser's history, if possible.
-     *
-     * @return WebDriverNavigation The instance.
-     */
     public function forward()
     {
         $this->executor->execute(DriverCommand::GO_FORWARD);
 
         return $this;
     }
 
-    /**
-     * Refresh the current page.
-     *
-     * @return WebDriverNavigation The instance.
-     */
     public function refresh()
     {
         $this->executor->execute(DriverCommand::REFRESH);
 
         return $this;
     }
 
-    /**
-     * Navigate to the given URL.
-     *
-     * @see WebDriver::get()
-     * @param string $url
-     * @return WebDriverNavigation The instance.
-     */
     public function to($url)
     {
         $params = ['url' => (string) $url];

lib/WebDriverNavigationInterface.php

@@ -0,0 +1,43 @@
+<?php
+
+namespace Facebook\WebDriver;
+
+/**
+ * An abstraction allowing the driver to access the browser's history and to
+ * navigate to a given URL.
+ */
+interface WebDriverNavigationInterface
+{
+    /**
+     * Move back a single entry in the browser's history, if possible.
+     * This is equivalent to pressing the back button in the browser or invoking window.history.back.
+     *
+     * @return self
+     */
+    public function back();
+
+    /**
+     * Move forward a single entry in the browser's history, if possible.
+     * This is equivalent to pressing the forward button in the browser or invoking window.history.back.
+     *
+     * @return self
+     */
+    public function forward();
+
+    /**
+     * Refresh the current page
+     * This is equivalent to pressing the refresh button in the browser.
+     *
+     * @return self
+     */
+    public function refresh();
+
+    /**
+     * Navigate to the given URL
+     *
+     * @param string $url
+     * @return self
+     * @see WebDriver::get()
+     */
+    public function to($url);
+}