appium_lib 9.17.0 → 9.18.0

data/lib/appium_lib/android/element/button.rb

@@ -14,6 +14,7 @@ module Appium
         index = value
         raise "#{index} is not a valid index. Must be >= 1" if index <= 0
 
+        # 1 indexed
         return find_element :uiautomator, _button_visible_selectors(index: index)
       end
 
@@ -74,7 +75,6 @@ module Appium
       elements.first
     end
 
-    # @private
     def _button_visible_selectors(opts = {})
       button_index       = opts.fetch :button_index, false
       image_button_index = opts.fetch :image_button_index, false
@@ -88,14 +88,12 @@ module Appium
       end
     end
 
-    # @private
     def _button_exact_string(value)
       button       = string_visible_exact Button, value
       image_button = string_visible_exact ImageButton, value
       button + image_button
     end
 
-    # @private
     def _button_contains_string(value)
       button       = string_visible_contains Button, value
       image_button = string_visible_contains ImageButton, value

data/lib/appium_lib/android/espresso.rb

@@ -1,9 +1,11 @@
+require_relative 'espresso/helper'
+require_relative 'espresso/element'
 require_relative 'espresso/bridge'
 
 module Appium
   module Android
     module Espresso
       # parent
-    end # module Uiautomator2
+    end # module Espresso
   end # module Android
 end # module Appium

data/lib/appium_lib/android/espresso/bridge.rb

@@ -8,6 +8,8 @@ module Appium
           target.extend Appium::Android
           target.extend Appium::Android::Command
           target.extend Appium::Android::Espresso
+          target.extend Appium::Android::Espresso::Helper
+          target.extend Appium::Android::Espresso::Element
         end
       end
     end

data/lib/appium_lib/android/espresso/element.rb

@@ -0,0 +1,11 @@
+require_relative 'element/generic'
+require_relative 'element/button'
+
+module Appium
+  module Android
+    module Espresso
+      module Element
+      end # module Element
+    end # module Espresso
+  end # module Android
+end # module Appium

data/lib/appium_lib/android/espresso/element/button.rb

@@ -0,0 +1,124 @@
+module Appium
+  module Android
+    module Espresso
+      module Element
+        # Find the first button that contains value or by index.
+        # @param value [String, Integer] the value to exactly match.
+        # If int then the button at that index is returned.
+        # @return [Button]
+        def button(value)
+          # Don't use ele_index because that only works on one element type.
+          # Android needs to combine button and image button to match iOS.
+          if value.is_a? Numeric
+            index = value
+            raise "#{index} is not a valid index. Must be >= 1" if index <= 0
+
+            # zero index
+            _button_visible_selectors_xpath(index: index - 1)
+          end
+
+          i = find_elements :xpath, _button_contains_string_xpath(Button, value)
+          e = find_elements :xpath, _button_contains_string_xpath(ImageButton, value)
+
+          raise_no_such_element_if_empty(i + e)
+
+          (i + e)[0]
+        end
+
+        # Find all buttons containing value.
+        # If value is omitted, all buttons are returned.
+        # @param value [String] the value to search for
+        # @return [Array<Button>]
+        def buttons(value = false)
+          return _button_visible_selectors_xpath unless value
+
+          i = find_elements :xpath, _button_contains_string_xpath(Button, value)
+          e = find_elements :xpath, _button_contains_string_xpath(ImageButton, value)
+          i + e
+        end
+
+        # Find the first button.
+        # @return [Button]
+        def first_button
+          _button_visible_selectors_xpath(button_index: 0, image_button_index: 0)
+        end
+
+        # Find the last button.
+        # @return [Button]
+        def last_button
+          # uiautomator index doesn't support last
+          # and it's 0 indexed
+          button_index = tags(::Appium::Android::Button).length
+          button_index -= 1 if button_index > 0
+          image_button_index = tags(::Appium::Android::ImageButton).length
+          image_button_index -= 1 if image_button_index > 0
+
+          _button_visible_selectors_xpath(button_index: button_index,
+                                          image_button_index: image_button_index)
+        end
+
+        # Find the first button that exactly matches value.
+        # @param value [String] the value to match exactly
+        # @return [Button]
+        def button_exact(value)
+          i = find_elements :xpath, _button_exact_string_xpath(Button, value)
+          e = find_elements :xpath, _button_exact_string_xpath(ImageButton, value)
+
+          raise_no_such_element_if_empty(i + e)
+
+          (i + e)[0]
+        end
+
+        # Find all buttons that exactly match value.
+        # @param value [String] the value to match exactly
+        # @return [Array<Button>]
+        def buttons_exact(value)
+          i = find_elements :xpath, _button_exact_string_xpath(Button, value)
+          e = find_elements :xpath, _button_exact_string_xpath(ImageButton, value)
+          i + e
+        end
+
+        private
+
+        # @private
+        def raise_no_such_element_if_empty(elements)
+          raise _no_such_element if elements.empty?
+
+          elements.first
+        end
+
+        def _button_visible_selectors_xpath(opts = {})
+          button_index       = opts.fetch :button_index, false
+          image_button_index = opts.fetch :image_button_index, false
+
+          index = opts.fetch :index, false
+
+          b = find_elements :xpath, "//#{Button}"
+          i = find_elements :xpath, "//#{ImageButton}"
+
+          if index
+            raise_no_such_element_if_empty(b + i)
+            (b + i)[index]
+          elsif button_index && image_button_index
+            raise_no_such_element_if_empty(b + i)
+            b_index = button_index + image_button_index
+            (b + i)[b_index]
+          else
+            b + i
+          end
+        end
+
+        def _button_exact_string_xpath(class_name, value)
+          r_id = resource_id(value, " or @resource-id='#{value}'")
+          "//#{class_name}[@text='#{value}' or @content-desc='#{value}'#{r_id}]"
+        end
+
+        def _button_contains_string_xpath(class_name, value)
+          r_id = resource_id(value, " or @resource-id='#{value}'")
+          "//#{class_name}[contains(translate(@text,'#{value.upcase}', '#{value}'), '#{value}')" \
+            " or contains(translate(@content-desc,'#{value.upcase}', '#{value}'), '#{value}')#{r_id}]"
+        end
+      end # module Element
+    end # module Espresso
+  end # module Android
+end # module Appium

data/lib/appium_lib/android/espresso/element/generic.rb

@@ -0,0 +1,61 @@
+module Appium
+  module Android
+    module Espresso
+      module Element
+        # Scroll to the first element containing target text or description.
+        # Scroll happens upto 30 times in centre of device width.
+        # @param text [String] the text or resourceId to search for in the text value and content description
+        # @return [Element] the element scrolled to
+        def scroll_to(text)
+          err = nil
+          w_s = window_rect
+
+          (1..30).each do |_count|
+            begin
+              action
+                .move_to_location(w_s.width / 2, (w_s.height * 2) / 5) # pointer based magic number
+                .pointer_down(:left)
+                .move_to_location(0, w_s.height / 5)
+                .release
+                .perform
+              sleep 1 # we must wait finish scrolling
+
+              return text(text)
+            rescue StandardError => e
+              err = e
+            end
+          end
+
+          raise err
+        end
+
+        # Scroll to the first element with the exact target text or description.
+        # Scroll happens upto 30 times in centre of device width.
+        # @param text [String] the text or resourceId to search for in the text value and content description
+        # @return [Element] the element scrolled to
+        def scroll_to_exact(text)
+          err = nil
+          w_s = window_rect
+
+          (1..30).each do |_count|
+            begin
+              action
+                .move_to_location(w_s.width / 2, (w_s.height * 2) / 5) # pointer based magic number
+                .pointer_down(:left)
+                .move_to_location(0, w_s.height / 5)
+                .release
+                .perform
+              sleep 1 # we must wait finish scrolling
+
+              return text_exact(text)
+            rescue StandardError => e
+              err = e
+            end
+          end
+
+          raise err
+        end
+      end # module Element
+    end # module Espresso
+  end # module Android
+end # module Appium

data/lib/appium_lib/android/espresso/helper.rb

@@ -0,0 +1,39 @@
+module Appium
+  module Android
+    module Espresso
+      module Helper
+        # Find the first element that contains value
+        # @param class_name [String] the class name for the element
+        # @param value [String] the value to search for
+        # @return [Element]
+        def complex_find_contains(class_name, value)
+          find_element :xpath, string_visible_contains_xpath(class_name, value)
+        end
+
+        # Find all elements containing value
+        # @param class_name [String] the class name for the element
+        # @param value [String] the value to search for
+        # @return [Array<Element>]
+        def complex_finds_contains(class_name, value)
+          find_elements :xpath, string_visible_contains_xpath(class_name, value)
+        end
+
+        # Find the first element exactly matching value
+        # @param class_name [String] the class name for the element
+        # @param value [String] the value to search for
+        # @return [Element]
+        def complex_find_exact(class_name, value)
+          find_element :xpath, string_visible_exact_xpath(class_name, value)
+        end
+
+        # Find all elements exactly matching value
+        # @param class_name [String] the class name for the element
+        # @param value [String] the value to search for
+        # @return [Element]
+        def complex_finds_exact(class_name, value)
+          find_elements :xpath, string_visible_exact_xpath(class_name, value)
+        end
+      end # module Helper
+    end # module Espresso
+  end # module Android
+end # module Appium

data/lib/appium_lib/driver.rb

@@ -209,6 +209,8 @@ module Appium
         case automation_name
         when :uiautomator2
           ::Appium::Android::Uiautomator2::Bridge.for(self)
+        when :espresso
+          ::Appium::Android::Espresso::Bridge.for(self)
         else # default and UiAutomator
           ::Appium::Android::Bridge.for(self)
         end
@@ -226,8 +228,11 @@ module Appium
         # no windows specific extentions
         Appium::Logger.debug('windows')
       when :tizen
-        # no tizen specific extentions
+        # https://github.com/Samsung/appium-tizen-driver
         Appium::Logger.debug('tizen')
+      when :youiengine
+        # https://github.com/YOU-i-Labs/appium-youiengine-driver
+        Appium::Logger.debug('YouiEngine')
       else
         Appium::Logger.warn('no device matched')
       end
@@ -334,12 +339,12 @@ module Appium
     #     element = find_element(:id, "some id")
     #     action.click(element).perform # The `click` is a part of `PointerActions`
     #
-    def action(async = false)
+    def action
       if @driver.dialect != :w3c
         ::Appium::Logger.info('Calls TouchAction instead of W3C actions for MJSONWP module')
         TouchAction.new($driver || @driver)
       else
-        @driver.action async
+        @driver.action
       end
     end
 
@@ -475,6 +480,21 @@ module Appium
       @driver.window_size
     end
 
+    # Get the device window's rect.
+    # @return [Selenium::WebDriver::Rectangle]
+    #
+    # @example
+    #
+    #   size = @driver.window_size
+    #   size.width #=> Integer
+    #   size.height #=> Integer
+    #   size.x #=> Integer
+    #   size.y #=> Integer
+    #
+    def window_rect
+      @driver.window_rect
+    end
+
     # Creates a new global driver and quits the old one if it exists.
     # You can customise http_client as the following
     #

data/lib/appium_lib/version.rb

@@ -1,5 +1,5 @@
 module Appium
   # Version and Date are defined on the 'Appium' module, not 'Appium::Common'
-  VERSION = '9.17.0'.freeze unless defined? ::Appium::VERSION
-  DATE    = '2018-12-15'.freeze unless defined? ::Appium::DATE
+  VERSION = '9.18.0'.freeze unless defined? ::Appium::VERSION
+  DATE    = '2019-01-13'.freeze unless defined? ::Appium::DATE
 end

data/release_notes.md

@@ -1,3 +1,10 @@
+#### v9.18.0 2019-01-13
+
+- [32f3272](https://github.com/appium/ruby_lib/commit/32f327239055362ef630979d5975d0fac64d94c6) Release 9.18.0
+- [e0f3683](https://github.com/appium/ruby_lib/commit/e0f36830edf0c33617efa50907c44b4ddc58702d) Enhance espresso adaptation for text, button, finds wrappers (#844)
+- [fb49333](https://github.com/appium/ruby_lib/commit/fb49333c46a7b612920d05d2f9ebc51fd7bfdb20) Add ruby 260 (#843)
+
+
 #### v9.17.0 2018-12-15
 
 - [84f71e4](https://github.com/appium/ruby_lib/commit/84f71e47b86a2f7a1de71c13888adce68622a35b) Release 9.17.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appium_lib
 version: !ruby/object:Gem::Version
-  version: 9.17.0
+  version: 9.18.0
 platform: ruby
 authors:
 - code@bootstraponline.com
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-15 00:00:00.000000000 Z
+date: 2019-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appium_lib_core
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -155,14 +155,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.60.0
+        version: 0.61.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.60.0
+        version: 0.61.0
 - !ruby/object:Gem::Dependency
   name: spec
   requirement: !ruby/object:Gem::Requirement
@@ -238,6 +238,10 @@ files:
 - lib/appium_lib/android/element/textfield.rb
 - lib/appium_lib/android/espresso.rb
 - lib/appium_lib/android/espresso/bridge.rb
+- lib/appium_lib/android/espresso/element.rb
+- lib/appium_lib/android/espresso/element/button.rb
+- lib/appium_lib/android/espresso/element/generic.rb
+- lib/appium_lib/android/espresso/helper.rb
 - lib/appium_lib/android/uiautomator2.rb
 - lib/appium_lib/android/uiautomator2/bridge.rb
 - lib/appium_lib/android/uiautomator2/element.rb