appium_lib 1.0.0 → 2.0.0

data/ios_tests/upload/upload.rb

@@ -1,6 +1,6 @@
 require File.expand_path '../sauce_storage', __FILE__
 
-s = SauceStorage.new debug: true
+s   = SauceStorage.new debug: true
 apk = File.expand_path '../' * 2 + ENV['UPLOAD_FILE'], __FILE__
 
 s.upload apk

data/lib/appium_lib/android/dynamic.rb

@@ -1,36 +1,37 @@
 module Appium
   class Driver
+    # http://developer.android.com/tools/help/uiautomator/UiSelector.html
     @@map = {
-        1   => ['text(String text)', 'SELECTOR_TEXT', 1],
-        2   => ['textStartsWith(String text)', 'SELECTOR_START_TEXT', 2],
-        3   => ['textContains(String text)', 'SELECTOR_CONTAINS_TEXT', 3],
-        4   => ['className(String className)', 'SELECTOR_CLASS', 4],
-        5   => ['description(String desc)', 'SELECTOR_DESCRIPTION', 5],
-        6   => ['descriptionStartsWith(String desc)', 'SELECTOR_START_DESCRIPTION', 6],
-        7   => ['descriptionContains(String desc)', 'SELECTOR_CONTAINS_DESCRIPTION', 7],
-        8   => ['index(final int index)', 'SELECTOR_INDEX', 8],
-        9   => ['instance(final int instance)', 'SELECTOR_INSTANCE', 9],
-        10  => ['enabled(boolean val)', 'SELECTOR_ENABLED', 10],
-        11  => ['focused(boolean val)', 'SELECTOR_FOCUSED', 11],
-        12  => ['focusable(boolean val)', 'SELECTOR_FOCUSABLE', 12],
-        13  => ['scrollable(boolean val)', 'SELECTOR_SCROLLABLE', 13],
-        14  => ['clickable(boolean val)', 'SELECTOR_CLICKABLE', 14],
-        15  => ['checked(boolean val)', 'SELECTOR_CHECKED', 15],
-        16  => ['selected(boolean val)', 'SELECTOR_SELECTED', 16],
-        # // SELECTOR_ID = 17; // nothing.
-        18  => ['packageName(String name)', 'SELECTOR_PACKAGE_NAME', 18],
-        # // SELECTOR_CHILD              = 19; // childSelector(UiSelector selector)
-        # // SELECTOR_CONTAINER          = 20; // containerSelector(UiSelector selector)
-        # // SELECTOR_PATTERN            = 21; // ! private ! patternSelector(UiSelector selector)
-        # // SELECTOR_PARENT             = 22; // fromParent(UiSelector selector)
-        # // SELECTOR_COUNT              = 23; // nothing.
-        24  => ['longClickable(boolean val)', 'SELECTOR_LONG_CLICKABLE', 24],
-        25  => ['textMatches(String regex)', 'SELECTOR_TEXT_REGEX', 25],
-        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],
-        # // start internal methods at 100
-        100 => ['getStringAttribute("name")', 'GET_NAME', 100]
+      1   => ['text(String text)', 'SELECTOR_TEXT', 1],
+      2   => ['textStartsWith(String text)', 'SELECTOR_START_TEXT', 2],
+      3   => ['textContains(String text)', 'SELECTOR_CONTAINS_TEXT', 3],
+      4   => ['className(String className)', 'SELECTOR_CLASS', 4],
+      5   => ['description(String desc)', 'SELECTOR_DESCRIPTION', 5],
+      6   => ['descriptionStartsWith(String desc)', 'SELECTOR_START_DESCRIPTION', 6],
+      7   => ['descriptionContains(String desc)', 'SELECTOR_CONTAINS_DESCRIPTION', 7],
+      8   => ['index(final int index)', 'SELECTOR_INDEX', 8],
+      9   => ['instance(final int instance)', 'SELECTOR_INSTANCE', 9],
+      10  => ['enabled(boolean val)', 'SELECTOR_ENABLED', 10],
+      11  => ['focused(boolean val)', 'SELECTOR_FOCUSED', 11],
+      12  => ['focusable(boolean val)', 'SELECTOR_FOCUSABLE', 12],
+      13  => ['scrollable(boolean val)', 'SELECTOR_SCROLLABLE', 13],
+      14  => ['clickable(boolean val)', 'SELECTOR_CLICKABLE', 14],
+      15  => ['checked(boolean val)', 'SELECTOR_CHECKED', 15],
+      16  => ['selected(boolean val)', 'SELECTOR_SELECTED', 16],
+      # // SELECTOR_ID = 17; // nothing.
+      18  => ['packageName(String name)', 'SELECTOR_PACKAGE_NAME', 18],
+      # // SELECTOR_CHILD              = 19; // childSelector(UiSelector selector)
+      # // SELECTOR_CONTAINER          = 20; // containerSelector(UiSelector selector)
+      # // SELECTOR_PATTERN            = 21; // ! private ! patternSelector(UiSelector selector)
+      # // SELECTOR_PARENT             = 22; // fromParent(UiSelector selector)
+      # // SELECTOR_COUNT              = 23; // nothing.
+      24  => ['longClickable(boolean val)', 'SELECTOR_LONG_CLICKABLE', 24],
+      25  => ['textMatches(String regex)', 'SELECTOR_TEXT_REGEX', 25],
+      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],
+      # // start internal methods at 100
+      100 => ['getStringAttribute("name")', 'GET_NAME', 100]
     }
 
     # @private

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

@@ -29,7 +29,7 @@ module Appium
       image_button = string_visible_contains ImageButton, value
       "#{button} | #{image_button}"
     end
-    
+
     public
 
     # Find the first button that contains value or by index.
@@ -49,11 +49,13 @@ module Appium
       xpath _button_contains_string value
     end
 
-    # Find all buttons containing value
+    # 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
-     xpaths _button_contains_string value
+    def buttons value=false
+      return xpaths _button_visible_string unless value
+      xpaths _button_contains_string value
     end
 
     # Find the first button.
@@ -65,7 +67,7 @@ module Appium
     # Find the last button.
     # @return [Button]
     def last_button
-       xpath _button_visible_string index: 'last()'
+      xpath _button_visible_string index: 'last()'
     end
 
     # Find the first button that exactly matches value.
@@ -81,11 +83,5 @@ module Appium
     def buttons_exact value
       xpaths _button_exact_string value
     end
-
-    # Find all buttons.
-    # @return [Array<Button>]
-    def e_buttons
-      xpaths _button_visible_string
-    end
   end # module Android
 end # module Appium

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

@@ -34,8 +34,8 @@ module Appium
     # @return [Element] the element scrolled to
     def scroll_to text
       args =
-          # textContains(text)
-          [[3, text]],
+        # textContains(text)
+        [[3, text]],
           # descriptionContains(text)
           [[7, text]]
 
@@ -46,9 +46,9 @@ module Appium
     # @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
-      args = 
-          # text(text)
-          [[1, text]],
+      args =
+        # text(text)
+        [[1, text]],
           # description(text)
           [[5, text]]
 

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

@@ -7,48 +7,44 @@ module Appium
     # @param value [String, Integer] the value to find.
     # If int then the TextView at that index is returned.
     # @return [TextView]
-    def s_text value
+    def text value
       return ele_index TextView, value if value.is_a? Numeric
       xpath_visible_contains TextView, value
     end
 
     # Find all TextViews containing value.
+    # If value is omitted, all texts are returned.
     # @param value [String] the value to search for
     # @return [Array<TextView>]
-    def s_texts value
+    def texts value=false
+      return tags TextView unless value
       xpaths_visible_contains TextView, value
     end
 
     # Find the first TextView.
     # @return [TextView]
-    def first_s_text
+    def first_text
       first_ele TextView
     end
 
     # Find the last TextView.
     # @return [TextView]
-    def last_s_text
+    def last_text
       last_ele TextView
     end
 
     # Find the first TextView that exactly matches value.
     # @param value [String] the value to match exactly
     # @return [TextView]
-    def s_text_exact value
+    def text_exact value
       xpath_visible_exact TextView, value
     end
 
     # Find all TextViews that exactly match value.
     # @param value [String] the value to match exactly
     # @return [Array<TextView>]
-    def s_texts_exact value
+    def texts_exact value
       xpaths_visible_exact TextView, value
     end
-
-    # Find all TextViews.
-    # @return [Array<TextView>]
-    def e_s_texts
-      tags TextView
-    end
   end # module Android
 end # module Appium

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

@@ -12,9 +12,11 @@ module Appium
     end
 
     # Find all EditTexts containing value.
+    # If value is omitted, all EditTexts are returned.
     # @param value [String] the value to search for
     # @return [Array<EditText>]
-    def textfields value
+    def textfields value=false
+      return tags EditText unless value
       xpaths_visible_contains EditText, value
     end
 
@@ -43,11 +45,5 @@ module Appium
     def textfields_exact value
       xpaths_visible_exact EditText, value
     end
-
-    # Find all EditTexts.
-    # @return [Array<EditText>]
-    def e_textfields
-      tags EditText
-    end
   end # module Android
 end # module Appium

data/lib/appium_lib/android/helper.rb

@@ -39,6 +39,28 @@ module Appium
           end
         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
+        end
+
+        string_ids = nil
+
+        if id_matches && id_matches.length > 0
+          space_suffix = ' ' * '  strings.xml: '.length
+          string_ids   = ''
+
+          # add first
+          string_ids   += "#{id_matches.shift[0]}\n"
+
+          # use padding for remaining values
+          # [0] = key, [1] = value
+          id_matches.each do |match|
+            string_ids += "#{space_suffix}#{match[0]}\n"
+          end
+        end
+
         string = ''
         text   = attributes['text']
         desc   = attributes['content-desc']
@@ -51,6 +73,7 @@ module Appium
           string += "  desc: #{desc}\n" unless desc.nil?
         end
         string  += "  id: #{id}\n" unless id.nil?
+        string  += "  strings.xml: #{string_ids}" unless string_ids.nil?
 
         @result += "\n#{name}\n#{string}" unless attributes.empty?
       end
@@ -74,10 +97,11 @@ module Appium
 
     # Intended for use with console.
     # Inspects and prints the current page.
-    # @param class_name [String] the class name to filter on.
-    # if false (default) then all classes will be inspected
+    # @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 class_name=false
+    def page opts={}
+      class_name = opts.is_a?(Hash) ? opts.fetch(:class, nil) : opts
       puts get_android_inspect class_name
       nil
     end
@@ -96,17 +120,29 @@ module Appium
                      am_start: pkg + '/' + act)
     end
 
-    # Find by id
-    # @param id [String] the id to search for
-    # @return [Element]
-    def id id
-      value = resolve_id id
+    # @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
+      value    = id unless value
       exact    = string_visible_exact '*', value
       contains = string_visible_contains '*', value
-      xpath "#{exact} | #{contains}"
+      "#{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
+    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
     end
 
     # Find the element of type class_name at matching index.

data/lib/appium_lib/common/helper.rb

@@ -134,7 +134,9 @@ module Appium
 
       # http://nokogiri.org/Nokogiri/XML/SAX/Document.html
       def start_element name, attrs = []
-        @result[name] += 1
+        # Count only visible elements. Android is always visible
+        element_visible = $driver.device_is_android? ? true : attrs.to_h['visible'] == 'true'
+        @result[name]   += 1 if element_visible
       end
 
       def formatted_result
@@ -147,7 +149,7 @@ module Appium
       end
     end # class CountElements
 
-    # Returns a string of class counts.
+    # Returns a string of class counts of visible elements.
     def get_page_class
       parser = @count_elements_parser ||= Nokogiri::XML::SAX::Parser.new(CountElements.new)
 

data/lib/appium_lib/common/patch.rb

@@ -84,7 +84,7 @@ def patch_webdriver_bridge
       # path may be nil, session, or not have anything after the session_id.
       path_str   = path
       path_str   = '/' + path_str unless path_str.nil? ||
-          path_str.length <= 0 || path_str[0] == '/'
+        path_str.length <= 0 || path_str[0] == '/'
       path_match = path.match /.*\h{8}-?\h{4}-?\h{4}-?\h{4}-?\h{12}/
       path_str   = path.sub(path_match[0], '') unless path_match.nil?
 

data/lib/appium_lib/common/version.rb

@@ -1,5 +1,5 @@
 module Appium
   # Version and Date are defined on the 'Appium' module, not 'Appium::Common'
-  VERSION = '1.0.0' unless defined? ::Appium::VERSION
-  DATE    = '2014-04-29' unless defined? ::Appium::DATE
+  VERSION = '2.0.0' unless defined? ::Appium::VERSION
+  DATE    = '2014-05-14' unless defined? ::Appium::DATE
 end

data/lib/appium_lib/device/device.rb

@@ -5,19 +5,18 @@ module Appium
     extend Forwardable
 
     NoArgMethods = {
-        post: {
-            shake:    'session/:session_id/appium/device/shake',
-            launch:   'session/:session_id/appium/app/launch',
-            close_app: 'session/:session_id/appium/app/close',
-            reset:    'session/:session_id/appium/app/reset',
-            toggle_airplane_mode: 'session/:session_id/appium/device/toggle_airplane_mode' 
-        },
-        get:  {
-            current_activity:   'session/:session_id/appium/device/current_activity',
-            current_context:    'session/:session_id/context',
-            app_strings:        'session/:session_id/appium/app/strings',
-            available_contexts: 'session/:session_id/contexts',
-        }
+      post: {
+        shake:                'session/:session_id/appium/device/shake',
+        launch:               'session/:session_id/appium/app/launch',
+        close_app:            'session/:session_id/appium/app/close',
+        reset:                'session/:session_id/appium/app/reset',
+        toggle_airplane_mode: 'session/:session_id/appium/device/toggle_airplane_mode',
+      },
+      get:  {
+        current_activity:   'session/:session_id/appium/device/current_activity',
+        current_context:    'session/:session_id/context',
+        available_contexts: 'session/:session_id/contexts',
+      }
     }
 
     # @!method app_strings
@@ -98,6 +97,13 @@ module Appium
           pair.each_pair { |command, path| add_endpoint_method command, path, verb }
         end
 
+        add_endpoint_method(:app_strings, 'session/:session_id/appium/app/strings') do
+          def app_strings language=nil
+            opts = language ? { language: language } : {}
+            execute :app_strings, {}, opts
+          end
+        end
+
         add_endpoint_method(:lock, 'session/:session_id/appium/device/lock') do
           def lock(duration)
             execute :lock, {}, :seconds => duration
@@ -128,9 +134,9 @@ module Appium
           end
         end
 
-        add_endpoint_method(:current_context=, 'session/:session_id/context') do
-          def current_context=(context=null)
-            execute :current_context=, {}, :context => context
+        add_endpoint_method(:set_context, 'session/:session_id/context') do
+          def set_context(context=null)
+            execute :set_context, {}, :name => context
           end
         end
 
@@ -142,7 +148,7 @@ module Appium
 
         add_endpoint_method(:key_event, 'session/:session_id/appium/device/keyevent') do
           def key_event(key, metastate=nil)
-            args = {keycode: key}
+            args             = { keycode: key }
             args[:metastate] = metastate if metastate
             execute :key_event, {}, args
           end
@@ -157,7 +163,7 @@ module Appium
 
         add_endpoint_method(:complex_find, 'session/:session_id/appium/app/complex_find') do
           def complex_find(opts)
-            mode = opts.fetch :mode, false
+            mode      = opts.fetch :mode, false
             selectors = opts.fetch :selectors, false
             raise 'Complex find must have selectors' unless selectors
             selectors.insert(0, mode) if mode
@@ -172,10 +178,10 @@ module Appium
           end
         end
 
-        add_endpoint_method(:push_file,'session/:session_id/appium/device/push_file') do
+        add_endpoint_method(:push_file, 'session/:session_id/appium/device/push_file') do
           def push_file(path, filedata)
             encoded_data = Base64.encode64 filedata
-            execute :push_file, {}, path: path, data: encoded_data 
+            execute :push_file, {}, path: path, data: encoded_data
           end
         end
 
@@ -211,7 +217,7 @@ module Appium
 
         delegate_driver_method method
         delegate_from_appium_driver method
-      end 
+      end
 
       # @private
       def extend_webdriver_with_forwardable
@@ -303,13 +309,13 @@ module Appium
         delegate_from_appium_driver(:zoom, Appium::MultiTouch)
       end
     end # class << self
-        
-    # @!method current_context=
+
+    # @!method set_context
     #   Change the context to the given context.
     #   @param [String] The context to change to
     #
     #   ```ruby
-    #   current_context= "NATIVE_APP"
+    #   set_context "NATIVE_APP"
     #   ```
 
     # @!method current_context
@@ -327,13 +333,14 @@ module Appium
     # ```
     def within_context(context)
       existing_context = current_context
+      set_context context
       yield if block_given?
-      current_context = existing_context
+      set_context existing_context
     end
 
-    # Change to the default context.  This is equivalent to `current_context= nil`.
+    # Change to the default context.  This is equivalent to `set_context nil`.
     def switch_to_default_context
-      current_context = nil
+      set_context nil
     end
   end # module Device
 end # module Appium