appium_lib 2.1.0 → 3.0.0

data/lib/appium_lib/android/dynamic.rb

@@ -30,6 +30,9 @@ module Appium
       26  => ['classNameMatches(String regex)', 'SELECTOR_CLASS_REGEX', 26],
       27  => ['descriptionMatches(String regex)', 'SELECTOR_DESCRIPTION_REGEX', 27],
       28  => ['packageNameMatches(String regex)', 'SELECTOR_PACKAGE_NAME_REGEX', 28],
+      29  => ['resourceId(String id)', 'SELECTOR_RESOURCE_ID', 29],
+      30  => ['checkable(boolean val)', 'SELECTOR_CHECKABLE', 30],
+      31  => ['resourceIdMatches(String regex)', 'SELECTOR_RESOURCE_ID_REGEX', 31],
       # // start internal methods at 100
       100 => ['getStringAttribute("name")', 'GET_NAME', 100]
     }

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

@@ -7,12 +7,28 @@ module Appium
     private
 
     # @private
-    def _button_visible_string opts={}
-      index = opts.fetch :index, false
-      if index
-        %Q(//#{Button}[#{index}] | //#{ImageButton}[#{index}])
+    def _button_visible_selectors opts={}
+      button_index       = opts.fetch :button_index, false
+      image_button_index = opts.fetch :image_button_index, false
+
+      # complex_find(...)
+      # 4 = className(String className)
+      # 9 = instance(final int instance)
+
+      if button_index && image_button_index
+        [
+          # className().instance()
+          [[4, Button], [9, button_index]],
+          # className().instance()
+          [[4, ImageButton], [9, image_button_index]]
+        ]
       else
-        %Q(//#{Button} | //#{ImageButton})
+        [
+          # className()
+          [[4, Button]],
+          # className()
+          [[4, ImageButton]]
+        ]
       end
     end
 
@@ -20,14 +36,14 @@ module Appium
     def _button_exact_string value
       button       = string_visible_exact Button, value
       image_button = string_visible_exact ImageButton, value
-      "#{button} | #{image_button}"
+      button + image_button
     end
 
     # @private
     def _button_contains_string value
       button       = string_visible_contains Button, value
       image_button = string_visible_contains ImageButton, value
-      "#{button} | #{image_button}"
+      button + image_button
     end
 
     public
@@ -41,12 +57,12 @@ module Appium
       # Android needs to combine button and image button to match iOS.
       if value.is_a? Numeric
         index = value
-        raise "#{index} is not a valid xpath index. Must be >= 1" if index <= 0
+        raise "#{index} is not a valid index. Must be >= 1" if index <= 0
 
-        return xpath _button_visible_string index: index
+        return complex_find _button_visible_selectors index: index
       end
 
-      xpath _button_contains_string value
+      complex_find _button_contains_string value
     end
 
     # Find all buttons containing value.
@@ -54,34 +70,41 @@ module Appium
     # @param value [String] the value to search for
     # @return [Array<Button>]
     def buttons value=false
-      return xpaths _button_visible_string unless value
-      xpaths _button_contains_string value
+      return complex_find mode: 'all', selectors: _button_visible_selectors unless value
+      complex_find mode: 'all', selectors: _button_contains_string(value)
     end
 
     # Find the first button.
     # @return [Button]
     def first_button
-      xpath _button_visible_string
+      complex_find _button_visible_selectors button_index: 0, image_button_index: 0
     end
 
     # Find the last button.
     # @return [Button]
     def last_button
-      xpath _button_visible_string index: 'last()'
+      # uiautomator index doesn't support last
+      # and it's 0 indexed
+      button_index       = tags(Button).length
+      button_index       -= 1 if button_index >= 0
+      image_button_index = tags(ImageButton).length
+      image_button_index -= 1 if image_button_index >= 0
+
+      complex_find _button_visible_selectors 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
-      xpath _button_exact_string value
+      complex_find _button_exact_string value
     end
 
     # Find all buttons that exactly match value.
     # @param value [String] the value to match exactly
     # @return [Array<Button>]
     def buttons_exact value
-      xpaths _button_exact_string value
+      complex_find mode: 'all', selectors: _button_exact_string(value)
     end
   end # module Android
 end # module Appium

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

@@ -5,28 +5,28 @@ module Appium
     # @param value [String] the value to search for
     # @return [Element]
     def find value
-      xpath_visible_contains '*', value
+      complex_find_contains '*', value
     end
 
     # Find all elements containing value
     # @param value [String] the value to search for
     # @return [Array<Element>]
     def finds value
-      xpaths_visible_contains '*', value
+      complex_finds_contains '*', value
     end
 
     # Find the first element exactly matching value
     # @param value [String] the value to search for
     # @return [Element]
     def find_exact value
-      xpath_visible_exact '*', value
+      complex_find_exact '*', value
     end
 
     # Find all elements exactly matching value
     # @param value [String] the value to search for
     # @return [Array<Element>]
     def finds_exact value
-      xpaths_visible_exact '*', value
+      complex_finds_exact '*', value
     end
 
     # Scroll to the first element containing target text or description.

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

@@ -9,7 +9,7 @@ module Appium
     # @return [TextView]
     def text value
       return ele_index TextView, value if value.is_a? Numeric
-      xpath_visible_contains TextView, value
+      complex_find_contains TextView, value
     end
 
     # Find all TextViews containing value.
@@ -18,7 +18,7 @@ module Appium
     # @return [Array<TextView>]
     def texts value=false
       return tags TextView unless value
-      xpaths_visible_contains TextView, value
+      complex_finds_contains TextView, value
     end
 
     # Find the first TextView.
@@ -37,14 +37,14 @@ module Appium
     # @param value [String] the value to match exactly
     # @return [TextView]
     def text_exact value
-      xpath_visible_exact TextView, value
+      complex_find_exact TextView, value
     end
 
     # Find all TextViews that exactly match value.
     # @param value [String] the value to match exactly
     # @return [Array<TextView>]
     def texts_exact value
-      xpaths_visible_exact TextView, value
+      complex_finds_exact TextView, value
     end
   end # module Android
 end # module Appium

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

@@ -8,7 +8,7 @@ module Appium
     # @return [EditText]
     def textfield value
       return ele_index EditText, value if value.is_a? Numeric
-      xpath_visible_contains EditText, value
+      complex_find_contains EditText, value
     end
 
     # Find all EditTexts containing value.
@@ -17,7 +17,7 @@ module Appium
     # @return [Array<EditText>]
     def textfields value=false
       return tags EditText unless value
-      xpaths_visible_contains EditText, value
+      complex_finds_contains EditText, value
     end
 
     # Find the first EditText.
@@ -36,14 +36,14 @@ module Appium
     # @param value [String] the value to match exactly
     # @return [EditText]
     def textfield_exact value
-      xpath_visible_exact EditText, value
+      complex_find_exact EditText, value
     end
 
     # Find all EditTexts that exactly match value.
     # @param value [String] the value to match exactly
     # @return [Array<EditText>]
     def textfields_exact value
-      xpaths_visible_exact EditText, value
+      complex_finds_exact EditText, value
     end
   end # module Android
 end # module Appium

data/lib/appium_lib/android/helper.rb

@@ -130,29 +130,20 @@ module Appium
                      am_start: pkg + '/' + act)
     end
 
-    # @private
-    def string_id_xpath id
-      value    = resolve_id id
-      # If the id doesn't resolve in strings.xml then use it as is
-      # It's probably a resource id which won't be in strings.xml
-      value    = id unless value
-      exact    = string_visible_exact '*', value
-      contains = string_visible_contains '*', value
-      "#{exact} | #{contains}"
-    end
-
     # Find the first matching element by id
     # @param id [String] the id to search for
     # @return [Element]
     def id id
-      xpath string_id_xpath id
+      # Android auto resolves strings.xml ids
+      find_element :id, id
     end
 
     # Find all matching elements by id
     # @param id [String] the id to search for
     # @return [Element]
     def ids id
-      xpaths string_id_xpath id
+      # Android auto resolves strings.xml ids
+      find_elements :id, value
     end
 
     # Find the element of type class_name at matching index.
@@ -160,65 +151,21 @@ module Appium
     # @param index [Integer] the index
     # @return [Element] the found element of type class_name
     def ele_index class_name, index
-      unless index == 'last()'
-        # XPath index starts at 1.
-        raise "#{index} is not a valid xpath index. Must be >= 1" if index <= 0
+      if index == 'last()'
+        index = tags(class_name).length
+        index -= 1 if index >= 0
+      else
+        raise 'Index must be >= 1' unless index >= 1
+        index -= 1 if index >= 1
       end
-      find_element :xpath, %Q(//#{class_name}[#{index}])
-    end
-
-    # @private
-    def string_attr_exact class_name, attr, value
-      %Q(//#{class_name}[@#{attr}='#{value}'])
-    end
-
-    # Find the first element exactly matching class and attribute value.
-    # @param class_name [String] the class name to search for
-    # @param attr [String] the attribute to inspect
-    # @param value [String] the expected value of the attribute
-    # @return [Element]
-    def find_ele_by_attr class_name, attr, value
-      @driver.find_element :xpath, string_attr_exact(class_name, attr, value)
-    end
-
-    # Find all elements exactly matching class and attribute value.
-    # @param class_name [String] the class name to match
-    # @param attr [String] the attribute to compare
-    # @param value [String] the value of the attribute that the element must have
-    # @return [Array<Element>]
-    def find_eles_by_attr class_name, attr, value
-      @driver.find_elements :xpath, string_attr_exact(class_name, attr, value)
-    end
-
-    # @private
-    def string_attr_include class_name, attr, value
-      %Q(//#{class_name}[contains(translate(@#{attr},'#{value.upcase}', '#{value}'), '#{value}')])
-    end
-
-    # Find the first element by attribute that exactly matches value.
-    # @param class_name [String] the class name to match
-    # @param attr [String] the attribute to compare
-    # @param value [String] the value of the attribute that the element must include
-    # @return [Element] the element of type tag who's attribute includes value
-    def find_ele_by_attr_include class_name, attr, value
-      @driver.find_element :xpath, string_attr_include(class_name, attr, value)
-    end
-
-    # Find elements by attribute that include value.
-    # @param class_name [String] the tag name to match
-    # @param attr [String] the attribute to compare
-    # @param value [String] the value of the attribute that the element must include
-    # @return [Array<Element>] the elements of type tag who's attribute includes value
-    def find_eles_by_attr_include class_name, attr, value
-      @driver.find_elements :xpath, string_attr_include(class_name, attr, value)
+      complex_find [[[4, class_name], [9, index]]]
     end
 
     # Find the first element that matches class_name
     # @param class_name [String] the tag to match
     # @return [Element]
     def first_ele class_name
-      # XPath index starts at 1
-      ele_index class_name, 1
+      tag(class_name)
     end
 
     # Find the last element that matches class_name
@@ -233,7 +180,7 @@ module Appium
     # @param class_name [String] the class_name to search for
     # @return [Element]
     def tag class_name
-      xpath %Q(//#{class_name})
+      find_element :class, class_name
     end
 
     # Find all elements of type class_name
@@ -241,84 +188,108 @@ module Appium
     # @param class_name [String] the class_name to search for
     # @return [Element]
     def tags class_name
-      xpaths %Q(//#{class_name})
+      find_elements :class, class_name
     end
 
     # @private
-    # Returns a string xpath that matches the first element that contains value
+    # Returns a string that matches the first element that contains value
     #
-    # example: xpath_visible_contains 'UIATextField', 'sign in'
+    # example: complex_find_contains 'UIATextField', 'sign in'
     #
-    # @param element [String] the class name for the element
+    # @param class_name [String] the class name for the element
     # @param value [String] the value to search for
     # @return [String]
-    def string_visible_contains element, value
-      result     = []
-      attributes = %w[content-desc text]
-
-      value_up   = value.upcase
-      value_down = value.downcase
-
-      attributes.each do |attribute|
-        result << %Q(contains(translate(@#{attribute},"#{value_up}","#{value_down}"), "#{value_down}"))
+    def string_visible_contains class_name, value
+      #  4  = className(String className)
+      # 29  = resourceId(String id
+      #  7  = descriptionContains(String desc)
+      #  3  = textContains(String text)
+      # todo: textContains isn't case insensitive
+      # descriptionContains is case insensitive
+
+      if class_name == '*'
+        return [
+          # resourceId()
+          [[29, value]],
+          # descriptionContains()
+          [[7, value]],
+          # textContains()
+          [[3, value]]
+        ]
       end
 
-      # never partial match on a resource id
-      result << %Q(@resource-id="#{value}")
-
-      result = result.join(' or ')
-
-      "//#{element}[#{result}]"
+      [
+        # className().resourceId()
+        [[4, class_name], [29, value]],
+        # className().descriptionContains()
+        [[4, class_name], [7, value]],
+        # className().textContains()
+        [[4, class_name], [3, value]]
+      ]
     end
 
     # Find the first element that contains value
     # @param element [String] the class name for the element
     # @param value [String] the value to search for
     # @return [Element]
-    def xpath_visible_contains element, value
-      xpath string_visible_contains element, value
+    def complex_find_contains element, value
+      complex_find string_visible_contains element, value
     end
 
     # Find all elements containing value
     # @param element [String] the class name for the element
     # @param value [String] the value to search for
     # @return [Array<Element>]
-    def xpaths_visible_contains element, value
-      xpaths string_visible_contains element, value
+    def complex_finds_contains element, value
+      complex_find mode: 'all', selectors: string_visible_contains(element, value)
     end
 
     # @private
-    # Create an xpath string to exactly match the first element with target value
-    # @param element [String] the class name for the element
+    # Create an string to exactly match the first element with target value
+    # @param class_name [String] the class name for the element
     # @param value [String] the value to search for
     # @return [String]
-    def string_visible_exact element, value
-      result     = []
-      attributes = %w[content-desc resource-id text]
-
-      attributes.each do |attribute|
-        result << %Q(@#{attribute}="#{value}")
+    def string_visible_exact class_name, value
+      #  4  = className(String className)
+      # 29  = resourceId(String id
+      #  5  = description(String desc)
+      #  1  = text(String text)
+
+      if class_name == '*'
+        return [
+          # resourceId()
+          [[29, value]],
+          # description()
+          [[5, value]],
+          # text()
+          [[1, value]]
+        ]
       end
 
-      result = result.join(' or ')
-
-      "//#{element}[#{result}]"
+      [
+        # className().resourceId()
+        [[4, class_name], [29, value]],
+        # className().description()
+        [[4, class_name], [5, value]],
+        # className().text()
+        [[4, class_name], [1, value]]
+      ]
     end
 
     # Find the first element exactly matching value
-    # @param element [String] the class name for the element
+    # @param class_name [String] the class name for the element
     # @param value [String] the value to search for
     # @return [Element]
-    def xpath_visible_exact element, value
-      xpath string_visible_exact element, value
+    def complex_find_exact class_name, value
+      complex_find string_visible_exact class_name, value
     end
 
     # Find all elements exactly matching value
-    # @param element [String] the class name for the element
+    # @param class_name [String] the class name for the element
     # @param value [String] the value to search for
     # @return [Element]
-    def xpaths_visible_exact element, value
-      xpaths string_visible_exact element, value
+    def complex_finds_exact class_name, value
+      complex_find mode: 'all', selectors: string_visible_exact(class_name, value)
     end
   end # module Android
 end # module Appium