appium_lib 0.24.1 → 1.0.0

data/ios_tests/upload/upload.rb

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

data/lib/appium_lib.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+require 'Forwardable' unless defined? Forwardable
+require_relative 'appium_lib/rails/duplicable'
 
 $driver = nil
 
@@ -19,16 +20,5 @@ def self.method_missing method, *args, &block
   end
 end
 
-module Appium
-  # @private
-  def self.add_to_path file, path=false
-    path = path ? "../#{path}/" : '..'
-    path = File.expand_path path, file
-
-    $:.unshift path unless $:.include? path
-  end
-
-  add_to_path __FILE__
-
-  require_relative 'appium_lib/driver'
-end
+require_relative 'appium_lib/logger'
+require_relative 'appium_lib/driver'

data/lib/appium_lib/android/dynamic.rb

@@ -1,45 +1,43 @@
-# encoding: utf-8
-
 module Appium
   class Driver
     @@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],
+        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],
+        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],
+        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]
-      }
+        100 => ['getStringAttribute("name")', 'GET_NAME', 100]
+    }
 
-      # @private
-      def dynamic_code_to_string code, value=false
-        result = @@map[code].first
-        return result unless value
-        result.split('(').first + "( \"#{value}\" )"
-      end
+    # @private
+    def dynamic_code_to_string code, value=false
+      result = @@map[code].first
+      return result unless value
+      result.split('(').first + "( \"#{value}\" )"
+    end
   end # class Driver
 end # module Appium

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

@@ -1,37 +1,38 @@
-# encoding: utf-8
-module Appium::Android
-  # Tap the alert button identified by value.
-  # @param value [Integer, String] either an integer index of the button or the button's name
-  # @return [void]
-  def alert_click value
-    button(value).click
-  end
+module Appium
+  module Android
+    # Click the first alert button that contains value or by index.
+    # @param value [Integer, String] either an integer index of the button or the button's name
+    # @return [void]
+    def alert_click value
+      button(value).click
+    end
 
-  # Accept the alert.
-  # The last button is considered "accept."
-  # @return [void]
-  def alert_accept
-    last_button.click
-  end
+    # Accept the alert.
+    # The last button is considered "accept."
+    # @return [void]
+    def alert_accept
+      last_button.click
+    end
 
-  # Get the text of the alert's accept button.
-  # The last button is considered "accept."
-  # @return [String]
-  def alert_accept_text
-    last_button.text
-  end
+    # Get the text of the alert's accept button.
+    # The last button is considered "accept."
+    # @return [String]
+    def alert_accept_text
+      last_button.text
+    end
 
-  # Dismiss the alert.
-  # The first button is considered "dismiss."
-  # @return [void]
-  def alert_dismiss
-    first_button.click
-  end
+    # Dismiss the alert.
+    # The first button is considered "dismiss."
+    # @return [void]
+    def alert_dismiss
+      first_button.click
+    end
 
-  # Get the text of the alert's dismiss button.
-  # The first button is considered "dismiss."
-  # @return [String]
-  def alert_dismiss_text
-    first_button.text
-  end
-end # module Appium::Android
+    # Get the text of the alert's dismiss button.
+    # The first button is considered "dismiss."
+    # @return [String]
+    def alert_dismiss_text
+      first_button.text
+    end
+  end # module Android
+end # module Appium

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

@@ -0,0 +1,91 @@
+# UIAButton methods
+module Appium
+  module Android
+    Button      = 'android.widget.Button'
+    ImageButton = 'android.widget.ImageButton'
+
+    private
+
+    # @private
+    def _button_visible_string opts={}
+      index = opts.fetch :index, false
+      if index
+        %Q(//#{Button}[#{index}] | //#{ImageButton}[#{index}])
+      else
+        %Q(//#{Button} | //#{ImageButton})
+      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
+      "#{button} | #{image_button}"
+    end
+    
+    public
+
+    # 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 xpath index. Must be >= 1" if index <= 0
+
+        return xpath _button_visible_string index: index
+      end
+
+      xpath _button_contains_string value
+    end
+
+    # Find all buttons containing value
+    # @param value [String] the value to search for
+    # @return [Array<Button>]
+    def buttons value
+     xpaths _button_contains_string value
+    end
+
+    # Find the first button.
+    # @return [Button]
+    def first_button
+      xpath _button_visible_string
+    end
+
+    # Find the last button.
+    # @return [Button]
+    def last_button
+       xpath _button_visible_string index: 'last()'
+    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
+    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
+    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

@@ -1,153 +1,58 @@
-# encoding: utf-8
-module Appium::Android
-=begin
-name, names, text, text should match substring and case insensitive.
-
-In Android //* is used to find partial case insensitive text matches.
-//* is not currently implemented in iOS.
-
-find_element :name by default uses a partial case insensitive match.
-On iOS the default is an exact name match.
-
-```javascript
-// iOS version
-// https://github.com/appium/ruby_lib/blob/37bb4e90b29e5adb4438b287b6387a504c94b5c4/lib/appium_lib/element/ios/generic.rb#L23
-var search = "name contains[c] '#{text}' || label contains[c] '#{text}' || value contains[c] '#{text}'";
-var a = w.secureTextFields().firstWithPredicate(search);
-if ( isNil(a) ) {
-  a = w.textFields().firstWithPredicate(search);
-  if ( isNil(a) ) {
-    a = w.buttons().firstWithPredicate(search);
-    if ( isNil(a) ) {
-      a = w.elements().firstWithPredicate(search);
-    }
-  }
-}
-```
-
-Android considers both a textfield and a secure textfield to be "EditText".
-Name (the content desc) is searched first and then we search for value (text).
-There's no label in Android.
-
-Android buttons have different class names (android.widget.Button, android.widget.ImageButton)
-so we consider the element a button if the class name contains the word button.
-
-After looking for textfields and buttons, then we search all elements. Find will return
-the first element that matches.
-=end
-
-  # Find the value contained in content description or text. Search elements
-  # in this order: EditText, Button, ImageButton
-  #
-  # @param val [String] the value to search for
-  # @return [Element]
-  def find val
-    # s.className('android.widget.EditText').descriptionContains(value);
-    args = [ [4, 'android.widget.EditText'], [7, val] ],
-    # s.className('android.widget.EditText').textContains(value);
-           [ [4, 'android.widget.EditText'], [3, val] ],
-
-           # s.className('android.widget.Button').descriptionContains(value);
-           [ [4, 'android.widget.Button'], [7, val] ],
-           # s.className('android.widget.Button').textContains(value);
-           [ [4, 'android.widget.Button'], [3, val] ],
-
-           # s.className('android.widget.ImageButton').descriptionContains(value);
-           [ [4, 'android.widget.ImageButton'], [7, val] ],
-           # s.className('android.widget.ImageButton').textContains(value);
-           [ [4, 'android.widget.ImageButton'], [3, val] ],
-
-           # s.descriptionContains(value);
-           [ [7, val] ],
-           # s.textContains(value);
-           [ [3, val] ]
-    mobile :find, args
-  end
-
-  # Return the first element matching text.
-  # @param text [String] the text to search for
-  # @return [Element] the first matching element
-  def text text
-    # Return the first element matching selector.
-    # s.textContains(value)
-    mobile :find, [ [ [3, text] ] ]
-  end
-
-  # Return all elements matching text.
-  # @param text [String] the text to search for
-  # @return [Array<Element>] all matching elements
-  def texts text
-    @driver.find_elements :xpath, "//*[contains(@text, '#{text}')]"
-  end
-
-  # Return the first element matching name.
-  # on Android name is content description
-  # on iOS name is the accessibility label or the text.
-  # @param name [String] the name to search for
-  # @return [Element] the first matching element
-  def name name
-    # work around https://github.com/appium/appium/issues/543
-    # @driver.find_element :name, name
-    mobile :find, [ [ [7, name] ] ]
-  end
-
-  # Return the first element exactly matching name.
-  # on Android name is content description
-  # on iOS name is the accessibility label or the text.
-  # @param name [String] the name to search for
-  # @return [Element] the first matching element
-  def name_exact name
-    # exact description
-    result = mobile :find, [ [ [5, name] ] ]
-
-    return result if result.kind_of? Selenium::WebDriver::Element
-
-    if result.length > 0
-      result.first
-    else
-      Appium::Common.raise_no_element_error
+module Appium
+  module Android
+
+    # Find the first element containing value
+    # @param value [String] the value to search for
+    # @return [Element]
+    def find value
+      xpath_visible_contains '*', value
     end
-  end
 
-  # Return all elements matching name.
-  # on Android name is content description
-  # on iOS name is the accessibility label or the text.
-  # @param name [String] the name to search for
-  # @return [Array<Element>] all matching elements
-  def names name=''
-    if name.nil? || name.empty?
-      args = 'all', [ [7, ''], [100] ]
-      mobile :find, args
-    else
-      args = 'all',
-          [ [7, name] ]
-      mobile :find, args
+    # Find all elements containing value
+    # @param value [String] the value to search for
+    # @return [Array<Element>]
+    def finds value
+      xpaths_visible_contains '*', value
     end
-  end
 
-  # Scroll to an 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
-    args = 'scroll',
-        # textContains(text)
-        [ [3, text] ],
-        # descriptionContains(text)
-        [ [7, text] ]
+    # 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
+    end
 
-    mobile :find, args
-  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
+    end
 
-  # Scroll to an 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
-    args = 'scroll',
-        # text(text)
-        [ [1, text] ],
-        # description(text)
-        [ [5, text] ]
+    # 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
+      args =
+          # textContains(text)
+          [[3, text]],
+          # descriptionContains(text)
+          [[7, text]]
+
+      complex_find mode: 'scroll', selectors: args
+    end
 
-    mobile :find, args
-  end
-end # module Appium::Android
+    # 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
+      args = 
+          # text(text)
+          [[1, text]],
+          # description(text)
+          [[5, text]]
+
+      complex_find mode: 'scroll', selectors: args
+    end
+  end # module Android
+end # module Appium