appium_lib 0.0.30 → 0.3.0

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

@@ -0,0 +1,56 @@
+# encoding: utf-8
+module Appium::Ios
+  # iOS only
+  # Tap the alert button identified by value.
+  #
+  # Click the ok button:
+  #   alert_click 'OK'
+  #
+  # Click the first button:
+  #   alert_click 0
+  #
+  # @param value [Integer, String] either an integer index of the button or the button's name
+  # @return [void]
+  def alert_click value
+    value = "'#{value}'" if value.is_a?(String)
+    @driver.execute_script "UIATarget.localTarget().frontMostApp().alert().buttons()[#{value}].tap();"
+  end
+
+  # Get the alert message text.
+  # @return [String]
+  def alert_text
+    @driver.switch_to.alert.text
+  end
+
+  # Accept the alert.
+  # @return [void]
+  def alert_accept
+    @driver.switch_to.alert.accept
+  end
+
+  # Get the text of the alert's accept button.
+  # The last button is considered "accept."
+  # @return [String]
+  def alert_accept_text
+    a = @driver.find_element(:tag_name, :alert)
+    return if a.nil?
+    b = a.find_elements(:tag_name, :button)
+    b.last.text if b && b.size >= 1
+  end
+
+  # Dismiss the alert.
+  # @return [void]
+  def alert_dismiss
+    @driver.switch_to.alert.dismiss
+  end
+
+  # Get the text of the alert's dismiss button.
+  # The first button is considered "dismiss."
+  # @return [String]
+  def alert_dismiss_text
+    a = @driver.find_element(:tag_name, :alert)
+    return if a.nil?
+    b = a.find_elements(:tag_name, :button)
+    b.first.text if b && b.size >= 1
+  end
+end # module Appium::Ios

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

@@ -0,0 +1,170 @@
+# encoding: utf-8
+module Appium::Ios
+=begin
+  name, names, text, text should match substring and case insensitive.
+
+  iOS .name() is the accessibility attribute. If not defined, then .label() is used instead.
+  This differs from Android where name (the content description) is empty when not set.
+
+  name defaults to label when undefined. value is never a default so that must be
+  included in a new search.
+
+  Find - search everything.
+
+  The search order is:
+  1. name
+  2. label (implied by name)
+  3. value
+
+  Android name = iOS name & label
+  Android text = iOS value
+=end
+
+  # returnElems requires a wrapped $(element).
+  # set to empty array when length is zero to prevent hang.
+  #
+  # UIAElementNil when not matched
+  #
+  # 1. secureTextFields
+  # 2. textFields
+  # 3. buttons
+  # 4. elements
+  #
+  # search takes the window to search.
+  # start searching webview first.
+  # window 0 is the main window.
+  # window 1 is the 1st webview (if it exists)
+  # must break instead of return because it's not a function.
+  #
+  # single element length is undefined when found and 0 when not found.
+  def first_ele_js predicate
+    %Q(
+    function isNil( a ) {
+      return a.type() === 'UIAElementNil';
+    }
+
+    function search( w ) {
+      var search = "#{predicate}";
+      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);
+          }
+        }
+      }
+
+      return a;
+    }
+
+    function search_web( windowIndex ) {
+      var a = undefined;
+
+      try {
+        a = UIATarget.localTarget().frontMostApp().windows()[windowIndex].scrollViews()[0].webViews()[0].elements().firstWithPredicate("#{predicate}");
+      } catch(e) {}
+
+      return a;
+    }
+
+    function run() {
+      var windows = au.mainApp.windows();
+      for (var i = 0, len = windows.length; i < len; i++) {
+        var result = search_web( i );
+        if ( isNil( result ) ) {
+          result = search( windows[ i ] );
+        }
+        if ( ! isNil( result ) ) {
+          return au._returnElems( $( [ result ] ) );
+        }
+      }
+      return au._returnElems( $( [] ) );
+    }
+
+    run();
+    )
+  end
+
+  def all_ele_js predicate
+    %Q(
+      var w = au.mainWindow;
+      var search = "#{predicate}";
+      var a = w.elements().withPredicate(search).toArray();
+
+      if ( a.length === 0 ) {
+        a = [];
+      }
+
+      au._returnElems($(a));
+    )
+  end
+
+  # Return the first element matching text.
+  # @param text [String] the text to search for
+  # @return [Element] the first matching element
+  def find text
+    js = first_ele_js "name contains[c] '#{text}' || label contains[c] '#{text}' || value contains[c] '#{text}'"
+
+    ele = execute_script(js).first
+    raise Selenium::WebDriver::Error::NoSuchElementError, '' if ele.nil?
+    ele
+  end
+
+  # Return all elements matching text.
+  # @param text [String] the text to search for
+  # @return [Array<Element>] all matching elements
+  def finds text
+    # returnElems requires a wrapped $(element).
+    # must call toArray when using withPredicate instead of firstWithPredicate.
+    js = all_ele_js "name contains[c] '#{text}' || label contains[c] '#{text}' || value contains[c] '#{text}'"
+
+    execute_script js
+  end
+
+  # Return the first element matching text.
+  # @param text [String] the text to search for
+  # @return [Element] the first matching element
+  def text text
+    js = first_ele_js "value contains[c] '#{text}'"
+
+    execute_script(js).first
+  end
+
+  # Return all elements matching text.
+  # @param text [String] the text to search for
+  # @return [Array<Element>] all matching elements
+  def texts text
+    # XPath //* is not implemented on iOS
+    # https://github.com/appium/appium/issues/430
+      js = all_ele_js "value contains[c] '#{text}'"
+
+    execute_script js
+  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
+    js = first_ele_js "name contains[c] '#{name}' || label contains[c] '#{name}'"
+
+    execute_script(js).first
+  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
+    # find_elements :name is not the same as on Android.
+    # it's case sensitive and exact on iOS and not on Android.
+    # https://github.com/appium/appium/issues/379
+    js = all_ele_js "name contains[c] '#{name}' || label contains[c] '#{name}''"
+
+    execute_script js
+  end
+end # module Appium::Ios

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

@@ -0,0 +1,90 @@
+# encoding: utf-8
+module Appium::Ios
+  # UIATextField & UIASecureTextField methods
+  #
+  # Find textfield and then secure elements in one server call
+  # to match Android.
+
+  # Get an array of textfield texts.
+  # @return [Array<String>]
+  def textfields
+    find_2_eles_attr :textfield, :secure, :text
+  end
+
+  # Get an array of textfield elements.
+  # @return [Array<Textfield>]
+  def e_textfields
+    execute_script textfield_js
+  end
+
+  # Get the first textfield element.
+  # @return [Textfield]
+  def first_textfield
+    js = textfield_js 'r = r.length > 0 ? $(r[0]) : r;'
+    execute_script(js).first
+  end
+
+  # Get the last textfield element.
+  # @return [Textfield]
+  def last_textfield
+    js = textfield_js 'r = r.length > 0 ? $(r[r.length - 1]) : r;'
+    execute_script(js).first
+  end
+
+  # Get the first textfield that matches text.
+  # @param text [String, Integer] the text to match exactly. If int then the textfield at that index is returned.
+  # @return [Textfield]
+  def textfield text
+    # Don't use ele_index because that only works on one element type.
+    # iOS needs to combine textfield and secure to match Android.
+    if text.is_a? Numeric
+      js = textfield_js "r = r.length > 0 ? $(r[#{text}]) : r;"
+      return execute_script(js).first
+    end
+
+    textfield_include text
+  end
+
+  # Get the first textfield that includes text.
+  # @param text [String] the text the textfield must include
+  # @return [Textfield]
+  def textfield_include text
+    js = %Q(
+      var t = au.getElementsByXpath('textfield[contains(@text, "#{text}")]').value;
+      var s = au.getElementsByXpath('secure[contains(@text, "#{text}")]').value;
+      t.concat(s)[0];
+    )
+
+    puts js if defined? Pry
+
+    execute_script js
+  end
+
+  # Get the first textfield that exactly matches text.
+  # @param text [String] the text the textfield must exactly match
+  # @return [Textfield]
+  def textfield_exact text
+    # find_ele_by_text :textfield, text
+    js = %Q(
+      var t = au.getElementsByXpath('textfield[@text="#{text}"]').value;
+      var s = au.getElementsByXpath('secure[@text="#{text}"]').value;
+      t.concat(s)[0];
+    )
+
+    puts js if defined? Pry
+
+    execute_script js
+  end
+
+  # Return combined lookup of textfield and secure
+  # with an optional filter. $() wrap is required for .each
+  def textfield_js filter=''
+  %Q(
+    var t = au.lookup('textfield');
+    var s = au.lookup('secure');
+    var r = $(t.concat(s));
+    #{filter}
+    au._returnElems(r);
+  )
+  end
+end # module Appium::Ios

data/lib/appium_lib/ios/helper.rb

@@ -0,0 +1,103 @@
+# encoding: utf-8
+module Appium::Ios
+  # iOS only. Android uses uiautomator instead of uiautomation.
+  # Get an array of attribute values from elements exactly matching tag name.
+  # @param tag_name [String] the tag name to find
+  # @param attribute [String] the attribute to collect
+  # @result [Array<String>] an array of strings containing the attribute from found elements of type tag_name.
+  def find_eles_attr tag_name, attribute
+    # Use au.lookup(tag_name) instead of $(tag_name)
+    # See https://github.com/appium/appium/issues/214
+    js = %Q(
+        var eles = au.lookup('#{tag_name}');
+        var result = [];
+        for (var a = 0, length = eles.length; a < length; a++) {
+          result.push(eles[a].#{attribute}());
+        }
+        result
+      )
+
+    @driver.execute_script js
+  end
+
+  # iOS only. Android doesn't use find_2_eles_attr.
+  # Get an array of attribute values from elements exactly matching tag name.
+  # @param tag_name_1 [String] the 1st tag name to find
+  # @param tag_name_2 [String] the 2nd tag name to find
+  # @param attribute [String] the attribute to collect
+  # @result [Array<String>] an array of strings containing the attribute from found elements of type tag_name.
+  def find_2_eles_attr tag_name_1, tag_name_2, attribute
+    # Use au.lookup(tag_name) instead of $(tag_name)
+    # See https://github.com/appium/appium/issues/214
+    js = %Q(
+        var eles = au.lookup('#{tag_name_1}');
+        eles = $(eles.concat(au.lookup('#{tag_name_2}')));
+        var result = [];
+        for (var a = 0, length = eles.length; a < length; a++) {
+          result.push(eles[a].#{attribute}());
+        }
+        result
+      )
+
+    @driver.execute_script js
+  end
+
+  # iOS only. On Android uiautomator always returns an empty string for EditText password.
+  #
+  # Password character returned from value of UIASecureTextField
+  # @param length [Integer] the length of the password to generate
+  # @return [String] the returned string is of size length
+  def password length=1
+    '•' * length
+  end
+
+  def get_page element
+
+    def empty ele
+      (ele['name'] || ele['label'] || ele['value']) == nil
+    end
+
+    def fix_space s
+      # ints don't respond to force encoding
+      return s unless s.respond_to? :force_encoding
+      # char code 160 (name, label) vs 32 (value) will break comparison.
+      # convert string to binary and remove 160.
+      # \xC2\xA0
+      s.force_encoding('binary').gsub("\xC2\xA0".force_encoding('binary'), ' ') if s
+    end
+
+    unless empty(element)
+      puts "#{element['type']}"
+      name = fix_space element['name']
+      label = fix_space element['label']
+      value = fix_space element['value']
+
+      if name == label && name == value
+        puts "   name, label, value: #{name}" if name
+      elsif name == label
+        puts "   name, label: #{name}" if name
+        puts "   value: #{value}" if value
+      elsif name == value
+        puts "   name, value: #{name}" if name
+        puts "  label: #{label}" if label
+      else
+        puts "   name: #{name}" if name
+        puts "  label: #{label}" if label
+        puts "  value: #{value}" if value
+      end
+    end
+
+    children = element['children']
+    children.each { |c| get_page c } if children
+    nil
+  end
+
+  def page
+    get_page get_source
+    nil
+  end
+
+  def fast_duration
+    0.5
+  end
+end # module Appium::Ios

data/lib/appium_lib/ios/patch.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+module Appium::Ios
+  # Implement useful features for element.
+  class Selenium::WebDriver::Element
+    # Cross platform way of entering text into a textfield
+    def type text
+      # enter text then tap window to hide the keyboard.
+      js = %Q(
+      au.getElement('#{self.ref}').setValue('#{text}');
+      au.lookup('window')[0].tap()
+    )
+      @driver.execute_script js
+    end
+  end
+end

data/readme.md

@@ -24,11 +24,18 @@ gem uninstall -aIx appium_lib ;\
 gem install --no-rdoc --no-ri appium_lib
 ```
 
-#### Run from Source
+#### Simple Usage
 
-`pry -r ./lib/appium_lib.rb`
+```ruby
+require 'appium_lib'
+
+# Start a driver based on APP_PATH
+Appium::Driver.new.start_driver
 
-Then `start_driver`
+# Start an Android driver
+apk = { 'APP_PATH' => ENV['APP_APK'] }
+Appium::Driver.new(apk).start_driver
+```
 
 #### Documentation