testa_appium_driver 0.1.30 → 0.1.31

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3521033bcda4e9b61fd523c8aa716c6bcfd99dc9e2ff820bf823adea8f4582c0
-  data.tar.gz: 2443236705abef799f76de8a03db745b972f3ff9092b9b19a689a20aba329c21
+  metadata.gz: 65be3b1fd729bc6fae7bd56227ac9fd4e2167b0e132657ac19e40a0ad184adcf
+  data.tar.gz: bceb63d4ee18a492482d0b45ed41167a655cff3e565443fafeabf489672bcea2
 SHA512:
-  metadata.gz: 6648e41a86d22e367bfef3b77d9db4ae5381b2bd5d787a875d2f77d8c842c7bcc4b65a450d608bbe7a0b006af47ab0fe21ccb120cb26b9c8e1f2f441c7f22d02
-  data.tar.gz: edd62bab2c971aa7334bf2521a9a5c91447a8892e94a1834a74c7e09fb69368c5c3b91b9d2bea20c14c9f5b36a751dc85932896b4c4b917db0cb44a4f34f570c
+  metadata.gz: 2ac6d2ae6a120827a412f1ce018bef76d50080538607588cae5240db1cedc4d52599b13e6a4c1e7150f2d607495a76e890e0154a6abae147b501b6b22a69b5f0
+  data.tar.gz: 9dce5768f0f217de3ab7730a7b3d5645d66a5cbc0cb326f71c6df8cc9dca2d23351fb80661e52d6782d07f3e5f01fbfe21f8e56bf39f58ee954a73154e055f12

data/Gemfile

@@ -9,5 +9,5 @@ gem "rake", "~> 13.0"
 
 gem "rspec", "~> 3.0"
 
-gem "rubocop", "~> 1.26.0", require: false
+gem "rubocop", require: false
 gem "rubocop-performance", require: false

data/lib/testa_appium_driver/common/locator/scroll_actions.rb

@@ -67,13 +67,14 @@ module TestaAppiumDriver
     # If the distance is greater than the threshold, it will attempt to realign it up to 2 more times.
     # The retry mechanism allows alignment even for dynamic layouts when elements are hidden/show when scrolling to certain direction
     # @return [TestaAppiumDriver::Locator]
-    def align(with = :top, top: nil, bottom: nil, right: nil, left: nil, scroll_to_find: false, max_attempts: 3)
+    def align(with = :top, top: nil, bottom: nil, right: nil, left: nil, scroll_to_find: false, max_attempts: 3, bounds_from_cache_element: true)
       deadzone = _process_deadzone(top, bottom, right, left)
       deadzone = @scrollable_locator.scroll_deadzone if deadzone.nil? && !@scrollable_locator.nil?
       sa = ScrollActions.new(@scrollable_locator,
                              locator: self,
                              deadzone: deadzone,
-                             default_scroll_strategy: @default_scroll_strategy)
+                             default_scroll_strategy: @default_scroll_strategy,
+                             bounds_from_cache_element: bounds_from_cache_element)
       sa.align(with, scroll_to_find, max_attempts)
       self
     end
@@ -83,8 +84,8 @@ module TestaAppiumDriver
     # If the distance is greater than the threshold, it will attempt to realign it up to 2 more times.
     # The retry mechanism allows alignment even for dynamic layouts when elements are hidden/show when scrolling to certain direction
     # @return [TestaAppiumDriver::Locator]
-    def align_top(top: nil, bottom: nil, right: nil, left: nil, max_attempts: 3)
-      align(:top, top: top, bottom: bottom, right: right, left: left, max_attempts: max_attempts)
+    def align_top(top: nil, bottom: nil, right: nil, left: nil, max_attempts: 3, bounds_from_cache_element: true)
+      align(:top, top: top, bottom: bottom, right: right, left: left, max_attempts: max_attempts, bounds_from_cache_element: bounds_from_cache_element)
     end
 
     # Aligns element on bottom of the scrollable container, if the element does not exists it will scroll to find it
@@ -92,8 +93,8 @@ module TestaAppiumDriver
     # If the distance is greater than the threshold, it will attempt to realign it up to 2 more times.
     # The retry mechanism allows alignment even for dynamic layouts when elements are hidden/show when scrolling to certain direction
     # @return [TestaAppiumDriver::Locator]
-    def align_bottom(top: nil, bottom: nil, right: nil, left: nil, max_attempts: 3)
-      align(:bottom, top: top, bottom: bottom, right: right, left: left, max_attempts: max_attempts)
+    def align_bottom(top: nil, bottom: nil, right: nil, left: nil, max_attempts: 3, bounds_from_cache_element: true)
+      align(:bottom, top: top, bottom: bottom, right: right, left: left, max_attempts: max_attempts, bounds_from_cache_element: bounds_from_cache_element)
     end
 
     # Aligns element on left of the scrollable container, if the element does not exists it will scroll to find it
@@ -101,8 +102,8 @@ module TestaAppiumDriver
     # If the distance is greater than the threshold, it will attempt to realign it up to 2 more times.
     # The retry mechanism allows alignment even for dynamic layouts when elements are hidden/show when scrolling to certain direction
     # @return [TestaAppiumDriver::Locator]
-    def align_left(top: nil, bottom: nil, right: nil, left: nil, max_attempts: 3)
-      align(:left, top: top, bottom: bottom, right: right, left: left, max_attempts: max_attempts)
+    def align_left(top: nil, bottom: nil, right: nil, left: nil, max_attempts: 3, bounds_from_cache_element: true)
+      align(:left, top: top, bottom: bottom, right: right, left: left, max_attempts: max_attempts, bounds_from_cache_element: bounds_from_cache_element)
     end
 
     # Aligns element on right of the scrollable container, if the element does not exists it will scroll to find it
@@ -110,8 +111,8 @@ module TestaAppiumDriver
     # If the distance is greater than the threshold, it will attempt to realign it up to 2 more times.
     # The retry mechanism allows alignment even for dynamic layouts when elements are hidden/show when scrolling to certain direction
     # @return [TestaAppiumDriver::Locator]
-    def align_right(top: nil, bottom: nil, right: nil, left: nil,  max_attempts: 3)
-      align(:right, top: top, bottom: bottom, right: right, left: left, max_attempts: max_attempts)
+    def align_right(top: nil, bottom: nil, right: nil, left: nil,  max_attempts: 3, bounds_from_cache_element: true)
+      align(:right, top: top, bottom: bottom, right: right, left: left, max_attempts: max_attempts, bounds_from_cache_element: bounds_from_cache_element)
     end
 
     # Aligns element (by default) on top of the scrollable container, if the element does not exists it raise an exception
@@ -119,8 +120,8 @@ module TestaAppiumDriver
     # If the distance is greater than the threshold, it will attempt to realign it up to 2 more times.
     # The retry mechanism allows alignment even for dynamic layouts when elements are hidden/show when scrolling to certain direction
     # @return [TestaAppiumDriver::Locator]
-    def align!(with = :top, top: nil, bottom: nil, right: nil, left: nil,  max_attempts: 3)
-      align(with, top: top, bottom: bottom, right: right, left: left, scroll_to_find: true, max_attempts: max_attempts)
+    def align!(with = :top, top: nil, bottom: nil, right: nil, left: nil,  max_attempts: 3, bounds_from_cache_element: true)
+      align(with, top: top, bottom: bottom, right: right, left: left, scroll_to_find: true, max_attempts: max_attempts, bounds_from_cache_element: bounds_from_cache_element)
     end
 
     # Aligns element on top of the scrollable container, if the element does not exists it raise an exception
@@ -128,8 +129,8 @@ module TestaAppiumDriver
     # If the distance is greater than the threshold, it will attempt to realign it up to 2 more times.
     # The retry mechanism allows alignment even for dynamic layouts when elements are hidden/show when scrolling to certain direction
     # @return [TestaAppiumDriver::Locator]
-    def align_top!(top: nil, bottom: nil, right: nil, left: nil, max_attempts: 3)
-      align(:top, top: top, bottom: bottom, right: right, left: left, scroll_to_find: true, max_attempts: max_attempts)
+    def align_top!(top: nil, bottom: nil, right: nil, left: nil, max_attempts: 3, bounds_from_cache_element: true)
+      align(:top, top: top, bottom: bottom, right: right, left: left, scroll_to_find: true, max_attempts: max_attempts, bounds_from_cache_element: bounds_from_cache_element)
     end
 
     # Aligns element on bottom of the scrollable container, if the element does not exists it raise an exception
@@ -137,8 +138,8 @@ module TestaAppiumDriver
     # If the distance is greater than the threshold, it will attempt to realign it up to 2 more times.
     # The retry mechanism allows alignment even for dynamic layouts when elements are hidden/show when scrolling to certain direction
     # @return [TestaAppiumDriver::Locator]
-    def align_bottom!(top: nil, bottom: nil, right: nil, left: nil,  max_attempts: 3)
-      align(:bottom, top: top, bottom: bottom, right: right, left: left, scroll_to_find: true, max_attempts: max_attempts)
+    def align_bottom!(top: nil, bottom: nil, right: nil, left: nil,  max_attempts: 3, bounds_from_cache_element: true)
+      align(:bottom, top: top, bottom: bottom, right: right, left: left, scroll_to_find: true, max_attempts: max_attempts, bounds_from_cache_element: bounds_from_cache_element)
     end
 
     # Aligns element on left of the scrollable container, if the element does not exists it raise an exception
@@ -146,8 +147,8 @@ module TestaAppiumDriver
     # If the distance is greater than the threshold, it will attempt to realign it up to 2 more times.
     # The retry mechanism allows alignment even for dynamic layouts when elements are hidden/show when scrolling to certain direction
     # @return [TestaAppiumDriver::Locator]
-    def align_left!(top: nil, bottom: nil, right: nil, left: nil,  max_attempts: 3)
-      align(:left, top: top, bottom: bottom, right: right, left: left, scroll_to_find: true, max_attempts: max_attempts)
+    def align_left!(top: nil, bottom: nil, right: nil, left: nil,  max_attempts: 3, bounds_from_cache_element: true)
+      align(:left, top: top, bottom: bottom, right: right, left: left, scroll_to_find: true, max_attempts: max_attempts, bounds_from_cache_element: bounds_from_cache_element)
     end
 
     # Aligns element on right of the scrollable container, if the element does not exists it raise an exception
@@ -155,8 +156,8 @@ module TestaAppiumDriver
     # If the distance is greater than the threshold, it will attempt to realign it up to 2 more times.
     # The retry mechanism allows alignment even for dynamic layouts when elements are hidden/show when scrolling to certain direction
     # @return [TestaAppiumDriver::Locator]
-    def align_right!(top: nil, bottom: nil, right: nil, left: nil,  max_attempts: 3)
-      align(:right, top: top, bottom: bottom, right: right, left: left, scroll_to_find: true, max_attempts: max_attempts)
+    def align_right!(top: nil, bottom: nil, right: nil, left: nil,  max_attempts: 3, bounds_from_cache_element: true)
+      align(:right, top: top, bottom: bottom, right: right, left: left, scroll_to_find: true, max_attempts: max_attempts, bounds_from_cache_element: bounds_from_cache_element)
     end
 
     # First scrolls to the beginning of the scrollable container and then scrolls down until element is found or end is reached

data/lib/testa_appium_driver/common/scroll_actions/w3c_scroll_actions.rb

@@ -186,7 +186,7 @@ module ::TestaAppiumDriver
       stale_retries = 0
       begin
         until is_aligned?(with, element) || timeout == max_attempts
-          # $ctx.puts("align roudn: #{timeout}")
+          #           $ctx.puts("align roudn: #{timeout}")
           w3c_attempt_align(with, speed_coef)
           timeout += 1
         end
@@ -194,12 +194,12 @@ module ::TestaAppiumDriver
         # if boundElementsByIndex is enabled, we can get stale element reference while doing scroll each
         stale_retries += 1
         sleep 0.2
-        # $ctx.puts "Looking for #{@locator.xpath_selector}"
+        #         $ctx.puts "Looking for #{@locator.xpath_selector}"
         element = @locator.execute if @locator.instance_of?(TestaAppiumDriver::Locator)
         retry if stale_retries < 4
         raise
       end
-      # $ctx.puts("end align")
+      #       $ctx.puts("end align")
     end
 
     def w3c_attempt_align(with, speed_coef)
@@ -240,9 +240,9 @@ module ::TestaAppiumDriver
       rounds = 0
       max_scrolls_reached = false
       end_of_scroll_reached = false
-      # $ctx.puts("starting scroll to")
+      #       $ctx.puts("starting scroll to")
       until (element_found = ((@driver.android? && @locator.exists?) || (@driver.ios? && @locator.exists? && @locator.in_viewport?))) || end_of_scroll_reached
-        # $ctx.puts("Scroll to round: #{rounds}")
+        #         $ctx.puts("Scroll to round: #{rounds}")
         end_of_scroll_reached = is_end_of_scroll?
         case direction
         when :down
@@ -268,7 +268,7 @@ module ::TestaAppiumDriver
         max_scrolls_reached = true if rounds == @max_scrolls
         break if rounds == @max_scrolls
       end
-      # $ctx.puts("end scroll to")
+      #       $ctx.puts("end scroll to")
       raise Selenium::WebDriver::Error::NoSuchElementError if (max_scrolls_reached || end_of_scroll_reached) && !element_found
     end
 
@@ -362,8 +362,8 @@ module ::TestaAppiumDriver
         f1.create_pointer_move(duration: overscroll_pause, x: x1, y: y1, origin: ::Selenium::WebDriver::Interactions::PointerMove::VIEWPORT)
       end
       f1.create_pointer_up(:left)
-      puts "Scroll execute[w3c_action]:  #{type}: {x0: #{x0}, y0: #{y0}} => (duration: #{duration}) => {x1: #{x1}, y1: #{y1}}"
-      # $ctx.puts "Scroll execute[w3c_action]:  #{type}: {x0: #{x0}, y0: #{y0}} => (duration: #{duration}) => {x1: #{x1}, y1: #{y1}}"
+      # puts "Scroll execute[w3c_action]:  #{type}: {x0: #{x0}, y0: #{y0}} => (duration: #{duration}) => {x1: #{x1}, y1: #{y1}}"
+      #       $ctx.puts "Scroll execute[w3c_action]:  #{type}: {x0: #{x0}, y0: #{y0}} => (duration: #{duration}) => {x1: #{x1}, y1: #{y1}}"
       @driver.perform_actions [f1]
     end
 

data/lib/testa_appium_driver/common/scroll_actions.rb

@@ -16,6 +16,7 @@ module ::TestaAppiumDriver
     #     - deadzone - [Hash] that stores top, bottom, left and right deadzone values. If deadzone[:top] is 200 then 200px from top of the scrollable container will not be used for scrolling
     #     - max_scrolls - [Integer] maximum number of scrolls before exception is thrown
     #     - default_scroll_strategy - defines which scroll strategy will be used if a scroll action is valid for multiple strategies
+    #     - bounds_from_cache_element - true by default, use the cached element to get element bounds
     def initialize(scrollable, params = {})
       @scrollable = scrollable
       @locator = params[:locator]
@@ -23,6 +24,9 @@ module ::TestaAppiumDriver
       @deadzone = params[:deadzone]
       @max_scrolls = params[:max_scrolls]
       @default_scroll_strategy = params[:default_scroll_strategy]
+      @bounds_from_cache_element = params[:bounds_from_cache_element]
+      @bounds_from_cache_element = true if @bounds_from_cache_element.nil?
+
       @driver = @locator.driver
 
       if @scrollable.nil?
@@ -201,7 +205,20 @@ module ::TestaAppiumDriver
     end
 
     def is_aligned?(with, element)
-      align_bounds = @locator.bounds(force_cache_element: element)
+      if @bounds_from_cache_element
+        # in some cases, the cached element returns the same bounds, even though it was scrolled a split second ago
+        align_bounds = @locator.bounds(force_cache_element: element)
+      else
+        align_bounds = @locator.bounds
+      end
+
+      # $ctx.puts("Align bounds: ")
+      # $ctx.puts(align_bounds)
+      # $ctx.puts("Scrollable bounds: ")
+      # $ctx.puts(@bounds)
+
+      # $ctx.puts("Deadzone: ")
+      # $ctx.puts(@deadzone)
       case with
       when :top
         @align_offset = align_bounds.top_left.y - @bounds.top_left.y - @deadzone[:top]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: testa_appium_driver
 version: !ruby/object:Gem::Version
-  version: 0.1.30
+  version: 0.1.31
 platform: ruby
 authors:
 - karlo.razumovic
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-06 00:00:00.000000000 Z
+date: 2024-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appium_lib_core
@@ -90,7 +90,7 @@ metadata:
   homepage_uri: https://github.com/Karazum/testa_appium_driver
   source_code_uri: https://github.com/Karazum/testa_appium_driver
   changelog_uri: https://github.com/Karazum/testa_appium_driver
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -106,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.6
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Appium made easy
 test_files: []