Renamed most of the browser operations and changed the API to be non-fluent

- Names now reflect what the classes responsibilities are - getter methods on browser have not been changed since their names are based on API calls
- Instead of returning the linked Browser instance most operation methods now return void. The fluent API had some drawbacks which need to be addressed in future releases.

Author: slu-it

webtester-core/src/main/java/info/novatec/testit/webtester/browser/Browser.java

@@ -3,13 +3,13 @@
 import org.openqa.selenium.WebDriver;
 
 import info.novatec.testit.webtester.browser.operations.AlertHandler;
-import info.novatec.testit.webtester.browser.operations.Focus;
-import info.novatec.testit.webtester.browser.operations.JavaScript;
-import info.novatec.testit.webtester.browser.operations.Navigate;
-import info.novatec.testit.webtester.browser.operations.Open;
-import info.novatec.testit.webtester.browser.operations.PageSource;
-import info.novatec.testit.webtester.browser.operations.Screenshot;
-import info.novatec.testit.webtester.browser.operations.Window;
+import info.novatec.testit.webtester.browser.operations.FocusSetter;
+import info.novatec.testit.webtester.browser.operations.JavaScriptExecutor;
+import info.novatec.testit.webtester.browser.operations.Navigator;
+import info.novatec.testit.webtester.browser.operations.UrlOpener;
+import info.novatec.testit.webtester.browser.operations.PageSourceSaver;
+import info.novatec.testit.webtester.browser.operations.ScreenshotTaker;
+import info.novatec.testit.webtester.browser.operations.CurrentWindow;
 import info.novatec.testit.webtester.config.Configuration;
 import info.novatec.testit.webtester.events.EventSystem;
 import info.novatec.testit.webtester.pagefragments.PageFragment;
@@ -54,14 +54,14 @@
  * @see BrowserBuilder
  * @see BrowserFactory
  * @see Configuration
- * @see Open
- * @see Window
- * @see Navigate
- * @see Focus
+ * @see UrlOpener
+ * @see CurrentWindow
+ * @see Navigator
+ * @see FocusSetter
  * @see AlertHandler
- * @see Screenshot
- * @see PageSource
- * @see JavaScript
+ * @see ScreenshotTaker
+ * @see PageSourceSaver
+ * @see JavaScriptExecutor
  * @since 2.0
  */
 public interface Browser extends OffersPageCreation, OffersAdHocFinding {
@@ -98,44 +98,45 @@ public interface Browser extends OffersPageCreation, OffersAdHocFinding {
 	 
      * @param url the URL to open
      * @return the same instance for fluent API use
-     * @see Open#url(String)
+     * @see UrlOpener#url(String)
      * @since 2.0
      */
     default Browser open(String url) {
-        return open().url(url);
+        open().url(url);
+        return this;
     }
 
     /**
-     * Returns this {@link Browser browser's} {@link Open open} operations.
+     * Returns this {@link Browser browser's} {@link UrlOpener open} operations.
      *
      * @return the open operations
      * @since 2.0
      */
-    Open open();
+    UrlOpener open();
 
     /**
-     * Returns this {@link Browser browser's} {@link Window window} operations.
+     * Returns this {@link Browser browser's} {@link CurrentWindow window} operations.
      *
      * @return the window operations
      * @since 2.0
      */
-    Window currentWindow();
+    CurrentWindow currentWindow();
 
     /**
-     * Returns this {@link Browser browser's} {@link Navigate navigation} operations.
+     * Returns this {@link Browser browser's} {@link Navigator navigation} operations.
      *
      * @return the navigation operations
      * @since 2.0
      */
-    Navigate navigate();
+    Navigator navigate();
 
     /**
-     * Returns this {@link Browser browser's} {@link Focus focus} operations.
+     * Returns this {@link Browser browser's} {@link FocusSetter focus} operations.
      *
      * @return the focus operations
      * @since 2.0
      */
-    Focus focus();
+    FocusSetter focus();
 
     /**
      * Returns this {@link Browser browser's} {@link AlertHandler alert} operations.
@@ -146,28 +147,28 @@ default Browser open(String url) {
     AlertHandler alert();
 
     /**
-     * Returns this {@link Browser browser's} {@link Screenshot screenshot} operations.
+     * Returns this {@link Browser browser's} {@link ScreenshotTaker screenshot} operations.
      *
      * @return the screenshot operations
      * @since 2.0
      */
-    Screenshot screenshot();
+    ScreenshotTaker screenshot();
 
     /**
-     * Returns this {@link Browser browser's} {@link PageSource page source} operations.
+     * Returns this {@link Browser browser's} {@link PageSourceSaver page source} operations.
      *
      * @return the page source operations
      * @since 2.0
      */
-    PageSource pageSource();
+    PageSourceSaver pageSource();
 
     /**
-     * Returns this {@link Browser browser's} {@link JavaScript} operations.
+     * Returns this {@link Browser browser's} {@link JavaScriptExecutor} operations.
      *
      * @return the JavaScript operations
      * @since 2.0
      */
-    JavaScript javaScript();
+    JavaScriptExecutor javaScript();
 
 
     /**

webtester-core/src/main/java/info/novatec/testit/webtester/browser/WebDriverBrowser.java

@@ -6,13 +6,13 @@
 import lombok.extern.slf4j.Slf4j;
 
 import info.novatec.testit.webtester.browser.operations.AlertHandler;
-import info.novatec.testit.webtester.browser.operations.Focus;
-import info.novatec.testit.webtester.browser.operations.JavaScript;
-import info.novatec.testit.webtester.browser.operations.Navigate;
-import info.novatec.testit.webtester.browser.operations.Open;
-import info.novatec.testit.webtester.browser.operations.PageSource;
-import info.novatec.testit.webtester.browser.operations.Screenshot;
-import info.novatec.testit.webtester.browser.operations.Window;
+import info.novatec.testit.webtester.browser.operations.FocusSetter;
+import info.novatec.testit.webtester.browser.operations.JavaScriptExecutor;
+import info.novatec.testit.webtester.browser.operations.Navigator;
+import info.novatec.testit.webtester.browser.operations.UrlOpener;
+import info.novatec.testit.webtester.browser.operations.PageSourceSaver;
+import info.novatec.testit.webtester.browser.operations.ScreenshotTaker;
+import info.novatec.testit.webtester.browser.operations.CurrentWindow;
 import info.novatec.testit.webtester.config.Configuration;
 import info.novatec.testit.webtester.config.builders.DefaultConfigurationBuilder;
 import info.novatec.testit.webtester.events.EventSystem;
@@ -47,33 +47,33 @@ public final class WebDriverBrowser implements Browser {
 
     private final WebDriver webDriver;
 
-    private final Open open;
-    private final Window window;
-    private final Navigate navigate;
+    private final UrlOpener open;
+    private final CurrentWindow window;
+    private final Navigator navigate;
     private final AlertHandler alert;
-    private final Screenshot screenshot;
-    private final PageSource pageSource;
-    private final JavaScript javaScript;
+    private final ScreenshotTaker screenshot;
+    private final PageSourceSaver pageSource;
+    private final JavaScriptExecutor javaScript;
     private final EventSystem eventSystem;
     private final AdHocFinder adHocFinder;
     private final PageFactory pageFactory;
 
-    private final Focus focus;
+    private final FocusSetter focus;
     private boolean closed;
 
     private WebDriverBrowser(Configuration configuration, WebDriver webDriver) {
 
         this.configuration = configuration;
         this.webDriver = webDriver;
 
-        this.open = new Open(this);
-        this.window = new Window(this);
-        this.navigate = new Navigate(this);
+        this.open = new UrlOpener(this);
+        this.window = new CurrentWindow(this);
+        this.navigate = new Navigator(this);
         this.alert = new AlertHandler(this);
-        this.screenshot = new Screenshot(this);
-        this.pageSource = new PageSource(this);
-        this.javaScript = new JavaScript(this);
-        this.focus = new Focus(this);
+        this.screenshot = new ScreenshotTaker(this);
+        this.pageSource = new PageSourceSaver(this);
+        this.javaScript = new JavaScriptExecutor(this);
+        this.focus = new FocusSetter(this);
         this.eventSystem = new EventSystemImpl(this);
         this.adHocFinder = new AdHocFinder(this);
         this.pageFactory = new PageFactory(this);
@@ -124,22 +124,22 @@ public WebDriver webDriver() {
     }
 
     @Override
-    public Open open() {
+    public UrlOpener open() {
         return open;
     }
 
     @Override
-    public Window currentWindow() {
+    public CurrentWindow currentWindow() {
         return window;
     }
 
     @Override
-    public Focus focus() {
+    public FocusSetter focus() {
         return focus;
     }
 
     @Override
-    public Navigate navigate() {
+    public Navigator navigate() {
         return navigate;
     }
 
@@ -149,17 +149,17 @@ public AlertHandler alert() {
     }
 
     @Override
-    public Screenshot screenshot() {
+    public ScreenshotTaker screenshot() {
         return screenshot;
     }
 
     @Override
-    public PageSource pageSource() {
+    public PageSourceSaver pageSource() {
         return pageSource;
     }
 
     @Override
-    public JavaScript javaScript() {
+    public JavaScriptExecutor javaScript() {
         return javaScript;
     }
 

webtester-core/src/main/java/info/novatec/testit/webtester/browser/operations/AlertHandler.java

@@ -44,13 +44,12 @@ public AlertHandler(Browser browser) {
      *
      * @param username the username to use
      * @param password the password to use
-     * @return the original browser of this operation
      * @see Alert#authenticateUsing(Credentials)
      * @since 2.0
      */
     @Beta
-    public Browser authenticateWith(String username, String password) {
-        return authenticateWith(new UserAndPassword(username, password));
+    public void authenticateWith(String username, String password) {
+        authenticateWith(new UserAndPassword(username, password));
     }
 
     /**
@@ -59,15 +58,13 @@ public Browser authenticateWith(String username, String password) {
      * This operation is decalred as "BETA" by the Selenium developers and might break in the future in case it changes.
      *
      * @param credentials the credentials to use
-     * @return the original browser of this operation
      * @see Alert#authenticateUsing(Credentials)
      * @since 2.0
      */
     @Beta
-    public Browser authenticateWith(Credentials credentials) {
+    public void authenticateWith(Credentials credentials) {
         ActionTemplate.browser(browser()).execute(browser -> webDriver().switchTo().alert().authenticateUsing(credentials));
         log.debug("authenticated using credentials: {}", credentials);
-        return browser();
     }
 
     /**
@@ -76,38 +73,35 @@ public Browser authenticateWith(Credentials credentials) {
      * <p>
      * Fires {@link AcceptedAlertEvent} in case a alert was successfully accepted.
      *
-     * @return the original browser of this operation
      * @see Alert#accept()
      * @since 2.0
      */
-    public Browser acceptIfPresent() {
+    public void acceptIfPresent() {
         if (isPresent()) {
             log.debug("alert was visible");
-            return accept();
+            accept();
+        } else {
+            log.debug("alert was not visible");
         }
-        log.debug("alert was not visible");
-        return browser();
     }
 
     /**
      * Accept any displayed alert message. If no alert is displayed, an exception will be thrown.
      * <p>
      * Fires {@link AcceptedAlertEvent} in case a alert was successfully accepted.
      *
-     * @return the original browser of this operation
      * @throws NoAlertPresentException in case no alert is present
      * @see Alert#accept()
      * @since 2.0
      */
-    public Browser accept() throws NoAlertPresentException {
+    public void accept() throws NoAlertPresentException {
         StringBuilder builder = new StringBuilder();
         ActionTemplate.browser(browser()).execute(browser -> {
             Alert alert = webDriver().switchTo().alert();
             builder.append(alert.getText());
             alert.accept();
         }).fireEvent(browser -> new AcceptedAlertEvent(builder.toString()));
         log.debug("alert was accepted");
-        return browser();
     }
 
     /**
@@ -116,38 +110,35 @@ public Browser accept() throws NoAlertPresentException {
      * <p>
      * Fires {@link DeclinedAlertEvent} in case a alert was successfully accepted.
      *
-     * @return the original browser of this operation
      * @see Alert#dismiss()
      * @since 2.0
      */
-    public Browser declineIfPresent() {
+    public void declineIfPresent() {
         if (isPresent()) {
             log.debug("alert was visible");
-            return decline();
+            decline();
+        } else {
+            log.debug("alert was not visible");
         }
-        log.debug("alert was not visible");
-        return browser();
     }
 
     /**
      * Declines any displayed alert message. If no alert is displayed, an exception will be thrown.
      * <p>
      * Fires {@link DeclinedAlertEvent} in case a alert was successfully accepted.
      *
-     * @return the original browser of this operation
      * @throws NoAlertPresentException in case no alert is present
      * @see Alert#dismiss()
      * @since 2.0
      */
-    public Browser decline() throws NoAlertPresentException {
+    public void decline() throws NoAlertPresentException {
         StringBuilder builder = new StringBuilder();
         ActionTemplate.browser(browser()).execute(browser -> {
             Alert alert = webDriver().switchTo().alert();
             builder.append(alert.getText());
             alert.dismiss();
         }).fireEvent(browser -> new DeclinedAlertEvent(builder.toString()));
         log.debug("alert was declined");
-        return browser();
     }
 
     /**

webtester-core/src/main/java/info/novatec/testit/webtester/browser/operations/BaseBrowserOperation.java

@@ -15,15 +15,15 @@ protected BaseBrowserOperation(Browser browser) {
         this.browser = browser;
     }
 
-    protected final Browser browser() {
+    protected Browser browser() {
         return browser;
     }
 
-    protected final Configuration configuration() {
+    protected Configuration configuration() {
         return browser.configuration();
     }
 
-    protected final WebDriver webDriver() {
+    protected WebDriver webDriver() {
         return browser.webDriver();
     }