appium_lib 6.0.0 → 7.0.0

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

@@ -1,44 +1,43 @@
 module Appium
   module Android
-
     # Find the first element containing value
     # @param value [String] the value to search for
     # @return [Element]
-    def find value
+    def find(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
+    def finds(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
+    def find_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
+    def finds_exact(value)
       complex_finds_exact '*', value
     end
 
     # @private
-     def scroll_uiselector content
-       "new UiScrollable(new UiSelector().scrollable(true).instance(0)).scrollIntoView(#{content}.instance(0));"
-     end
+    def scroll_uiselector(content)
+      "new UiScrollable(new UiSelector().scrollable(true).instance(0)).scrollIntoView(#{content}.instance(0));"
+    end
 
     # Scroll to the first element containing target text or description.
     # @param text [String] the text to search for in the text value and content description
     # @return [Element] the element scrolled to
-    def scroll_to text
-      text = %Q("#{text}")
+    def scroll_to(text)
+      text = %("#{text}")
 
       args = scroll_uiselector("new UiSelector().textContains(#{text})") +
              scroll_uiselector("new UiSelector().descriptionContains(#{text})")
@@ -49,8 +48,8 @@ module Appium
     # Scroll to the first element with the exact target text or description.
     # @param text [String] the text to search for in the text value and content description
     # @return [Element] the element scrolled to
-    def scroll_to_exact text
-      text = %Q("#{text}")
+    def scroll_to_exact(text)
+      text = %("#{text}")
 
       args = scroll_uiselector("new UiSelector().text(#{text})") +
              scroll_uiselector("new UiSelector().description(#{text})")
@@ -58,4 +57,4 @@ module Appium
       find_element :uiautomator, args
     end
   end # module Android
-end # module Appium
+end # module Appium

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

@@ -7,7 +7,7 @@ module Appium
     # @param value [String, Integer] the value to find.
     # If int then the TextView at that index is returned.
     # @return [TextView]
-    def text value
+    def text(value)
       return ele_index TextView, value if value.is_a? Numeric
       complex_find_contains TextView, value
     end
@@ -16,7 +16,7 @@ module Appium
     # If value is omitted, all texts are returned.
     # @param value [String] the value to search for
     # @return [Array<TextView>]
-    def texts value=false
+    def texts(value = false)
       return tags TextView unless value
       complex_finds_contains TextView, value
     end
@@ -36,15 +36,15 @@ module Appium
     # Find the first TextView that exactly matches value.
     # @param value [String] the value to match exactly
     # @return [TextView]
-    def text_exact value
+    def text_exact(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
+    def texts_exact(value)
       complex_finds_exact TextView, value
     end
   end # module Android
-end # module Appium
+end # module Appium

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

@@ -6,7 +6,7 @@ module Appium
     # @param value [String, Integer] the text to match exactly.
     # If int then the EditText at that index is returned.
     # @return [EditText]
-    def textfield value
+    def textfield(value)
       return ele_index EditText, value if value.is_a? Numeric
       complex_find_contains EditText, value
     end
@@ -15,7 +15,7 @@ module Appium
     # If value is omitted, all EditTexts are returned.
     # @param value [String] the value to search for
     # @return [Array<EditText>]
-    def textfields value=false
+    def textfields(value = false)
       return tags EditText unless value
       complex_finds_contains EditText, value
     end
@@ -35,15 +35,15 @@ module Appium
     # Find the first EditText that exactly matches value.
     # @param value [String] the value to match exactly
     # @return [EditText]
-    def textfield_exact value
+    def textfield_exact(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
+    def textfields_exact(value)
       complex_finds_exact EditText, value
     end
   end # module Android
-end # module Appium
+end # module Appium

data/lib/appium_lib/android/helper.rb

@@ -3,14 +3,10 @@ module Appium
     # @private
     # http://nokogiri.org/Nokogiri/XML/SAX.html
     class AndroidElements < Nokogiri::XML::SAX::Document
-      attr_reader :result, :keys, :instance
-
-      def filter
-        @filter
-      end
+      attr_reader :result, :keys, :instance, :filter
 
       # convert to string to support symbols
-      def filter= value
+      def filter=(value)
         # nil and false disable the filter
         return @filter = false unless value
         @filter = value.to_s.downcase
@@ -19,17 +15,17 @@ module Appium
       def initialize
         reset
         @filter   = false
-        @instance = Hash.new -1
+        @instance = Hash.new(-1)
       end
 
       def reset
         @result   = ''
-        @keys     = %w[text resource-id content-desc]
-        @instance = Hash.new -1
+        @keys     = %w(text resource-id content-desc)
+        @instance = Hash.new(-1)
       end
 
       # http://nokogiri.org/Nokogiri/XML/SAX/Document.html
-      def start_element name, attrs = []
+      def start_element(name, attrs = [])
         return if filter && !name.downcase.include?(filter)
 
         # instance numbers start at 0.
@@ -38,15 +34,18 @@ module Appium
         attributes = {}
 
         attrs.each do |key, value|
-          if keys.include?(key) && !value.empty?
-            attributes[key] = value
-          end
+          attributes[key] = value if keys.include?(key) && !value.empty?
         end
 
         # scoped to: text resource-id content-desc
         attributes_values = attributes.values
-        id_matches        = $driver.lazy_load_strings.select do |key, value|
-          attributes_values.include? value
+        strings           = $driver.lazy_load_strings
+        id_matches        = []
+
+        unless strings.empty?
+          id_matches = strings.select do |_key, value|
+            attributes_values.include? value
+          end
         end
 
         string_ids = nil
@@ -56,7 +55,7 @@ module Appium
           string_ids   = ''
 
           # add first
-          string_ids   += "#{id_matches.shift[0]}\n"
+          string_ids += "#{id_matches.shift[0]}\n"
 
           # use padding for remaining values
           # [0] = key, [1] = value
@@ -76,8 +75,8 @@ module Appium
           string += "  text: #{text}\n" unless text.nil?
           string += "  desc: #{desc}\n" unless desc.nil?
         end
-        string  += "  id: #{id}\n" unless id.nil?
-        string  += "  strings.xml: #{string_ids}" unless string_ids.nil?
+        string += "  id: #{id}\n" unless id.nil?
+        string += "  strings.xml: #{string_ids}" unless string_ids.nil?
 
         @result += "\n#{name} (#{number})\n#{string}" unless attributes.empty?
       end
@@ -86,7 +85,7 @@ module Appium
     # Fix uiautomator's xml dump.
     # https://github.com/appium/appium/issues/2822
     # https://code.google.com/p/android/issues/detail?id=74143
-    def _fix_android_native_source source
+    def _fix_android_native_source(source)
       # <android.app.ActionBar$Tab
       # <android.app.ActionBar  $  Tab
 
@@ -105,8 +104,8 @@ module Appium
 
         #  <android.app.ActionBar$Tab   => <android.app.ActionBar.Tab
         # </android.app.ActionBar$Tab> => </android.app.ActionBar.Tab>
-        source = source.gsub(/<#{before}\s*\$\s*#{after}/, "<#{fixed}").
-          gsub(/<\/#{before}\s*\$\s*#{after}>/, "</#{fixed}>")
+        source = source.gsub(/<#{before}\s*\$\s*#{after}/,
+                             "<#{fixed}").gsub(/<\/#{before}\s*\$\s*#{after}>/, "</#{fixed}>")
       end
 
       source
@@ -124,7 +123,7 @@ module Appium
     # @param class_name [String] the class name to filter on.
     # if false (default) then all classes will be inspected
     # @return [String]
-    def get_android_inspect class_name=false
+    def get_android_inspect(class_name = false)
       source = get_source
 
       doctype_string = '<!doctyp'
@@ -150,7 +149,7 @@ module Appium
     # @option class [Symbol] the class name to filter on. case insensitive include match.
     # if nil (default) then all classes will be inspected
     # @return [void]
-    def page opts={}
+    def page(opts = {})
       class_name = opts.is_a?(Hash) ? opts.fetch(:class, nil) : opts
       puts get_android_inspect class_name
       nil
@@ -160,7 +159,8 @@ module Appium
     # Works on local host only (not remote).
 
     # example line:
-    # "mFocusedApp=AppWindowToken{b1420058 token=Token{b128add0 ActivityRecord{b1264d10 u0 com.example.android.apis/.ApiDemos t23}}}"
+    # "mFocusedApp=AppWindowToken{b1420058 token=Token{b128add0
+    #  ActivityRecord{b1264d10 u0 com.example.android.apis/.ApiDemos t23}}}"
     def current_app
       line = `adb shell dumpsys window windows`.each_line.grep(/mFocusedApp/).first.strip
 
@@ -169,7 +169,7 @@ module Appium
 
     # @private
     # noinspection RubyArgCount
-    def _parse_current_app_line line
+    def _parse_current_app_line(line)
       match = line.match(/ ([^\/ ]+\/[^ }]+)[ }]/)
       return nil unless match && match[1]
 
@@ -185,7 +185,7 @@ module Appium
     # Find the first matching element by id
     # @param id [String] the id to search for
     # @return [Element]
-    def id id
+    def id(id)
       # Android auto resolves strings.xml ids
       find_element :id, id
     end
@@ -193,7 +193,7 @@ module Appium
     # Find all matching elements by id
     # @param id [String] the id to search for
     # @return [Element]
-    def ids id
+    def ids(id)
       # Android auto resolves strings.xml ids
       find_elements :id, id
     end
@@ -202,13 +202,13 @@ module Appium
     # @param class_name [String] the class name to find
     # @param index [Integer] the index
     # @return [Element] the found element of type class_name
-    def ele_index class_name, index
+    def ele_index(class_name, index)
       results = tags(class_name)
       if index == 'last()'
         index = results.length
         index -= 1 if index >= 0
       else
-        raise 'Index must be >= 1' unless index >= 1
+        fail 'Index must be >= 1' unless index >= 1
         index -= 1 if index >= 1
       end
 
@@ -220,14 +220,14 @@ module Appium
     # Find the first element that matches class_name
     # @param class_name [String] the tag to match
     # @return [Element]
-    def first_ele class_name
+    def first_ele(class_name)
       tag(class_name)
     end
 
     # Find the last element that matches class_name
     # @param class_name [String] the tag to match
     # @return [Element]
-    def last_ele class_name
+    def last_ele(class_name)
       ele_index class_name, 'last()'
     end
 
@@ -235,7 +235,7 @@ module Appium
     #
     # @param class_name [String] the class_name to search for
     # @return [Element]
-    def tag class_name
+    def tag(class_name)
       find_element :class, class_name
     end
 
@@ -243,11 +243,41 @@ module Appium
     #
     # @param class_name [String] the class_name to search for
     # @return [Element]
-    def tags class_name
+    def tags(class_name)
       find_elements :class, class_name
     end
 
     # @private
+    # Detects if the string represents a resourceId
+    # resourceId is only supported on API >= 18 devices
+    #
+    # @param string [String] the string check for a resourceId
+    #                        value will be auto unquoted
+    # @param on_match [String] the string to return on resourceId match
+    #
+    # @return [String] empty string on failure, on_match on successful match
+    def _resource_id(string, on_match)
+      return '' unless string
+
+      # unquote the string
+      # "com.example.Test:id/enter" -> com.example.Test:id/enter
+      unquote = string.match(/"(.+)"/)
+      string = unquote[1] if unquote
+
+      # java_package : type / name
+      #
+      # com.example.Test:id/enter
+      #
+      # ^[a-zA-Z_]      - Java package must start with letter or underscore
+      # [a-zA-Z0-9\._]* - Java package may contain letters, numbers, periods and underscores
+      # :               - : ends the package and starts the type
+      # [^\/]+          - type is made up of at least one non-/ characters
+      # \\/             - / ends the type and starts the name
+      # [\S]+$          - the name contains at least one non-space character and then the line is ended
+      resource_id = /^[a-zA-Z_][a-zA-Z0-9\._]*:[^\/]+\/[\S]+$/
+      string.match(resource_id) ? on_match : ''
+    end
+
     # Returns a string that matches the first element that contains value
     #
     # example: complex_find_contains 'UIATextField', 'sign in'
@@ -255,19 +285,19 @@ module Appium
     # @param class_name [String] the class name for the element
     # @param value [String] the value to search for
     # @return [String]
-    def string_visible_contains class_name, value
-      value = %Q("#{value}")
+    def string_visible_contains(class_name, value)
+      value = %("#{value}")
 
       if class_name == '*'
-        return "new UiSelector().resourceId(#{value});" +
-          "new UiSelector().descriptionContains(#{value});" +
+        return _resource_id(value, "new UiSelector().resourceId(#{value});") +
+          "new UiSelector().descriptionContains(#{value});" \
           "new UiSelector().textContains(#{value});"
       end
 
-      class_name = %Q("#{class_name}")
+      class_name = %("#{class_name}")
 
-      "new UiSelector().className(#{class_name}).resourceId(#{value});" +
-        "new UiSelector().className(#{class_name}).descriptionContains(#{value});" +
+      _resource_id(value, "new UiSelector().className(#{class_name}).resourceId(#{value});") +
+        "new UiSelector().className(#{class_name}).descriptionContains(#{value});" \
         "new UiSelector().className(#{class_name}).textContains(#{value});"
     end
 
@@ -275,7 +305,7 @@ module Appium
     # @param element [String] the class name for the element
     # @param value [String] the value to search for
     # @return [Element]
-    def complex_find_contains element, value
+    def complex_find_contains(element, value)
       find_element :uiautomator, string_visible_contains(element, value)
     end
 
@@ -283,7 +313,7 @@ module Appium
     # @param element [String] the class name for the element
     # @param value [String] the value to search for
     # @return [Array<Element>]
-    def complex_finds_contains element, value
+    def complex_finds_contains(element, value)
       find_elements :uiautomator, string_visible_contains(element, value)
     end
 
@@ -292,19 +322,19 @@ module Appium
     # @param class_name [String] the class name for the element
     # @param value [String] the value to search for
     # @return [String]
-    def string_visible_exact class_name, value
-      value = %Q("#{value}")
+    def string_visible_exact(class_name, value)
+      value = %("#{value}")
 
       if class_name == '*'
-        return "new UiSelector().resourceId(#{value});" +
-          "new UiSelector().description(#{value});" +
+        return _resource_id(value, "new UiSelector().resourceId(#{value});") +
+          "new UiSelector().description(#{value});" \
           "new UiSelector().text(#{value});"
       end
 
-      class_name = %Q("#{class_name}")
+      class_name = %("#{class_name}")
 
-      "new UiSelector().className(#{class_name}).resourceId(#{value});" +
-        "new UiSelector().className(#{class_name}).description(#{value});" +
+      _resource_id(value, "new UiSelector().className(#{class_name}).resourceId(#{value});") +
+        "new UiSelector().className(#{class_name}).description(#{value});" \
         "new UiSelector().className(#{class_name}).text(#{value});"
     end
 
@@ -312,7 +342,7 @@ module Appium
     # @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
+    def complex_find_exact(class_name, value)
       find_element :uiautomator, string_visible_exact(class_name, value)
     end
 
@@ -320,7 +350,7 @@ module Appium
     # @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
+    def complex_finds_exact(class_name, value)
       find_elements :uiautomator, string_visible_exact(class_name, value)
     end
 
@@ -334,4 +364,4 @@ module Appium
       src
     end
   end # module Android
-end # module Appium
+end # module Appium