Merge pull request #90 from sCShaimaaElbazedy/MobileClickFix

Enhancing mobile click functionality

Author: Umutayb

pom.xml

@@ -6,7 +6,7 @@
 
   <groupId>io.github.umutayb</groupId>
   <artifactId>Pickleib</artifactId>
-  <version>1.9.7</version>
+  <version>1.9.8</version>
   <packaging>jar</packaging>
 
   <name>Pickleib</name>
@@ -42,7 +42,7 @@
     <buildDirectory>${project.basedir}/out/artifacts/POM-Framework_jar</buildDirectory>
     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
     <maven.compiler.version>3.8.0</maven.compiler.version>
-    <java.utilities.version>1.6.0</java.utilities.version>
+    <java.utilities.version>1.6.1</java.utilities.version>
     <gpt.utilities.version>0.1.3</gpt.utilities.version>
     <docker-java.version>3.3.0</docker-java.version>
     <selenium.version>4.12.1</selenium.version>
@@ -181,6 +181,14 @@
       <version>1.15.4</version>
     </dependency>
 
+    <!-- Jsoup -->
+    <dependency>
+      <groupId>org.json</groupId>
+      <artifactId>json</artifactId>
+      <version>20231013</version>
+    </dependency>
+
+
     <!-- JUnit -->
     <dependency>
       <groupId>junit</groupId>

src/main/java/pickleib/mobile/interactions/MobileInteractions.java

@@ -3,7 +3,6 @@
 import org.openqa.selenium.*;
 import org.openqa.selenium.remote.RemoteWebDriver;
 import org.openqa.selenium.support.ui.WebDriverWait;
-import pickleib.driver.DriverFactory;
 import pickleib.enums.Direction;
 import pickleib.enums.ElementState;
 import pickleib.mobile.driver.PickleibAppiumDriver;
@@ -29,8 +28,7 @@ public MobileInteractions(RemoteWebDriver driver, WebDriverWait wait){
         this.wait = wait;
         interact = new ElementInteractions(
                 driver,
-                wait,
-                DriverFactory.DriverType.Mobile
+                wait
         );
     }
 
@@ -40,8 +38,7 @@ public MobileInteractions(){
         this.wait = PickleibAppiumDriver.wait;
         interact = new ElementInteractions(
                 driver,
-                wait,
-                DriverFactory.DriverType.Mobile
+                wait
         );
     }
 
@@ -190,8 +187,13 @@ public void scrollOrSwipeInDirection(Direction direction) {
         swiper(direction);
     }
 
-    public void clickButtonByText(String buttonText, Boolean scroll) {
-        interact.clickButtonByText(buttonText, scroll);
+    public void clickButtonByText(String buttonText, boolean scroll) {
+        if (scroll) interact.clickButtonByText(buttonText, this::centerElement);
+        else interact.clickButtonByText(buttonText);
+    }
+
+    public void clickButtonByText(String buttonText) {
+        interact.clickButtonByText(buttonText);
     }
 
     public void updateContext(String key, String value) {

src/main/java/pickleib/mobile/utilities/MobileUtilities.java

@@ -11,6 +11,7 @@
 import org.openqa.selenium.support.PageFactory;
 import pickleib.enums.Direction;
 import pickleib.enums.ElementState;
+import pickleib.exceptions.PickleibException;
 import pickleib.mobile.driver.PickleibAppiumDriver;
 import pickleib.utilities.Utilities;
 import java.time.Duration;
@@ -54,9 +55,56 @@ protected MobileUtilities(RemoteWebDriver driver){
         );
     }
 
-    @Override
-    public WebElement centerElement(WebElement element){
+    /**
+     * Clicks the specified {@code element} with retry mechanism and optional scrolling.
+     *
+     * <p>
+     * This method attempts to click the given {@code element} with a retry mechanism.
+     * It uses an implicit wait of 500 milliseconds during the retry attempts.
+     * The method supports an optional {@code scroller} for scrolling before clicking the element.
+     * If the {@code scroller} is provided, it scrolls towards the specified location before clicking.
+     * </p>
+     *
+     * <p>
+     * The method logs warning messages during the iteration process, indicating WebDriver exceptions.
+     * After the maximum time specified by {@code elementTimeout}, if the element is still not clickable,
+     * a {@code PickleibException} is thrown, including the last caught WebDriver exception.
+     * </p>
+     *
+     * @param element   The target {@code WebElement} to be clicked with retry mechanism.
+     * @throws PickleibException If the element is not clickable after the retry attempts, a {@code PickleibException} is thrown
+     *                          with the last caught WebDriver exception.
+     */
+    public void clickElement(WebElement element, boolean scroll){
+        if (scroll) clickElement(element, this::centerElement);
+        else clickElement(element);
+    }
+
+    /**
+     * Clears and fills a given input
+     *
+     * @param inputElement target input element
+     * @param inputText input text
+     * @param verify verifies the input text value equals to an expected text if true
+     */
+    protected void clearFillInput(WebElement inputElement, String inputText, boolean verify){
+        fillInputElement(inputElement, inputText, null, verify);
+    }
+
+    /**
+     * Clears and fills a given input
+     *
+     * @param inputElement target input element
+     * @param inputText input text
+     * @param verify verifies the input text value equals to an expected text if true
+     */
+    protected void clearFillInput(WebElement inputElement, String inputText, boolean scroll, boolean verify){
+        if (scroll) fillInputElement(inputElement, inputText, this::centerElement, verify);
+        else fillInputElement(inputElement, inputText, null, verify);
+    }
 
+    //TODO: Implement iterative scroll that will swipe or center depending on if the element can be found in view.
+    protected WebElement centerElement(WebElement element){
         Point center = new Point(
                 driver.manage().window().getSize().getWidth()/2,
                 driver.manage().window().getSize().getHeight()/2

src/main/java/pickleib/utilities/Interactions.java

@@ -345,9 +345,21 @@ void verifyPresenceOfListedElements(
      * Click on a button that contains {button text} text
      *
      * @param buttonText target button text
-     * @param scroll scrolls if true
      */
-    void clickButtonByText(String buttonText, Boolean scroll);
+    void clickButtonByText(String buttonText);
+
+    /**
+     * Clicks on a button with the specified text.
+     *
+     * <p>
+     * This method clicks on a button that contains the provided {@code buttonText} text.
+     * Optionally, it scrolls towards the button if {@code scroll} is set to true.
+     * </p>
+     *
+     * @param buttonText The text content of the target button.
+     * @param scroll     If true, scrolls towards the button before clicking; otherwise, clicks directly.
+     */
+    void clickButtonByText(String buttonText, boolean scroll);
 
     /**
      *

src/main/java/pickleib/utilities/PropertyLoader.java

@@ -1,7 +1,7 @@
 package pickleib.utilities;
 
 import context.ContextStore;
-import properties.PropertyUtility;
+import properties.PropertyUtilities;
 import java.util.Properties;
 
 public class PropertyLoader {
@@ -11,8 +11,8 @@ public class PropertyLoader {
 
     public static void load(){
         if (!loaded){
-            Properties properties = PropertyUtility.getProperties();
-            Properties pickleibProperties = PropertyUtility.loadPropertyFile("pickleib.properties");
+            Properties properties = PropertyUtilities.getProperties();
+            Properties pickleibProperties = PropertyUtilities.loadPropertyFile("pickleib.properties");
             ContextStore.loadProperties("pickleib.properties");
 
             if (!properties.isEmpty()){
@@ -21,7 +21,7 @@ public static void load(){
             }
             else properties = pickleibProperties;
 
-            PropertyUtility.properties.putAll(properties);
+            PropertyUtilities.properties.putAll(properties);
         }
         loaded = true;
     }

src/main/java/pickleib/utilities/ScrollFunction.java

@@ -0,0 +1,8 @@
+package pickleib.utilities;
+
+import org.openqa.selenium.WebElement;
+
+@FunctionalInterface
+public interface ScrollFunction {
+    WebElement scroll(WebElement element);
+}