appium_lib 0.24.1 → 1.0.0

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

@@ -1,95 +1,19 @@
-# 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
-    # this will call get text twice so call bridge directly
-    # ".switch_to.alert" calls it once, then ".text" another time.
-    # @driver.switch_to.alert.text
-    driver.send(:bridge).getAlertText
-  end
-
-  # Accept the alert.
-  # @return [void]
-  def alert_accept
-    # @driver.switch_to.alert.accept
-    # ".switch_to.alert" calls getAlertText so use bridge directly
-    driver.send(:bridge).acceptAlert
-  end
-
-  # Get the text of the alert's accept button.
-  # The last button is considered "accept." on iOS 6
-  # The first button is considered "accept." on iOS 7
-  # @return [String]
-  def alert_accept_text
-    old_wait = default_wait
-    set_wait 0
-    target_text = ''
-
-    a = ignore { @driver.find_element(:tag_name, :alert) }
-
-    begin
-      if a.nil? # either no alert or on iOS 7
-        b = xpaths 'actionsheet/button'
-        target_text = b.first.text if b && b.size >= 1
-      else # iOS 6 alert found
-        b = a.find_elements(:tag_name, :button)
-        target_text = b.last.text if b && b.size >= 1
-      end
-    rescue
-    ensure
-      set_wait old_wait
-      return target_text
+module Appium
+  module Ios
+    # Accept the alert.
+    # @return [void]
+    def alert_accept
+      # @driver.switch_to.alert.accept
+      # ".switch_to.alert" calls getAlertText so use bridge directly
+      driver.send(:bridge).acceptAlert
     end
-  end
-
-  # Dismiss the alert.
-  # @return [void]
-  def alert_dismiss
-    # @driver.switch_to.alert.dismiss
-    # ".switch_to.alert" calls getAlertText so use bridge directly
-    driver.send(:bridge).dismissAlert
-  end
-
-  # Get the text of the alert's dismiss button.
-  # The first button is considered "dismiss." on iOS 6
-  # The last button is considered "dismiss." on iOS 7
-  # @return [String]
-  def alert_dismiss_text
-    old_wait = default_wait
-    set_wait 0
-    target_text = ''
-
-    a = ignore { @driver.find_element(:tag_name, :alert) }
 
-    begin
-      if a.nil? # either no alert or on iOS 7
-        b = xpaths 'actionsheet/button'
-        target_text = b.last.text if b && b.size >= 1
-      else # iOS 6 alert found
-        b = a.find_elements(:tag_name, :button)
-        target_text = b.first.text if b && b.size >= 1
-      end
-    rescue
-    ensure
-      set_wait old_wait
-      return target_text
+    # Dismiss the alert.
+    # @return [void]
+    def alert_dismiss
+      # @driver.switch_to.alert.dismiss
+      # ".switch_to.alert" calls getAlertText so use bridge directly
+      driver.send(:bridge).dismissAlert
     end
-  end
-end # module Appium::Ios
+  end # module Ios
+end # module Appium

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

@@ -0,0 +1,55 @@
+# UIAButton methods
+module Appium
+  module Ios
+    UIAButton = 'UIAButton'
+
+    # Find the first UIAButton that contains value or by index.
+    # @param value [String, Integer] the value to exactly match.
+    # If int then the UIAButton at that index is returned.
+    # @return [UIAButton]
+    def button value
+      # return button at index.
+      return ele_index UIAButton, value if value.is_a? Numeric
+      xpath_visible_contains UIAButton, value
+    end
+
+    # Find all UIAButtons containing value
+    # @param value [String] the value to search for
+    # @return [Array<UIAButton>]
+    def buttons value
+      xpaths_visible_contains UIAButton, value
+    end
+
+    # Find the first UIAButton.
+    # @return [UIAButton]
+    def first_button
+      first_ele UIAButton
+    end
+
+    # Find the last UIAButton.
+    # @return [UIAButton]
+    def last_button
+      last_ele UIAButton
+    end
+
+    # Find the first UIAButton that exactly matches value.
+    # @param value [String] the value to match exactly
+    # @return [UIAButton]
+    def button_exact value
+      xpath_visible_exact UIAButton, value
+    end
+
+    # Find all UIAButtons that exactly match value.
+    # @param value [String] the value to match exactly
+    # @return [Array<UIAButton>]
+    def buttons_exact value
+      xpaths_visible_exact UIAButton, value
+    end
+
+    # Find all UIAButtons.
+    # @return [Array<UIAButton>]
+    def e_buttons
+      tags UIAButton
+    end
+  end # module Ios
+end # module Appium

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

@@ -1,165 +1,32 @@
-# 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
-
-  # @private
-  # 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.
-  # @param predicate [String] the predicate
-  # @return [String] the completed JavaScript program
-  def first_ele_js predicate
-    (<<-JS).strip # remove trailing newline
-       au.mainApp().getFirstWithPredicateWeighted("#{predicate}");
-    JS
-  end
-
-  # @private
-  # @param predicate [String] the predicate
-  # @return [String] the completed JavaScript program
-  def all_ele_js predicate
-    (<<-JS).strip # remove trailing newline
-      au.mainApp().getAllWithPredicate("#{predicate}");
-    JS
-  end
-
-  # Return the first element matching text.
-  # @param text [String] the text to search for
-  # @return [Element] the first matching element
-  def find text
-    text = escape_single_quote text
-    ele = nil
-    # prefer value search. this may error with:
-    # Can't use in/contains operator with collection 1
-    js = first_ele_js "value contains[c] '#{text}'"
-    ele = ignore { execute_script js }
-
-    # now search name and label if the value search didn't match.
-    unless ele
-      js = first_ele_js "name contains[c] '#{text}' || label contains[c] '#{text}'"
-      ele = ignore { execute_script js }
+module Appium
+  module Ios
+
+    # Find the first element containing value
+    # @param value [String] the value to search for
+    # @return [Element]
+    def find value
+      xpath_visible_contains '*', value
     end
 
-    # manually raise error if no element was found
-    raise Selenium::WebDriver::Error::NoSuchElementError, 'An element could not be located on the page using the given search parameters.' unless ele
-
-    ele
-  end
-
-  # Return all elements matching text.
-  # @param text [String] the text to search for
-  # @return [Array<Element>] all matching elements
-  def finds text
-    text = escape_single_quote text
-    eles = []
-    # value contains may error
-    js = all_ele_js "value contains[c] '#{text}'"
-    eles = ignore { execute_script js }
-
-    js = all_ele_js "name contains[c] '#{text}' || label contains[c] '#{text}'"
-    eles += ignore { execute_script js }
-    eles
-  end
-
-  # Return the first element matching text.
-  # @param text [String] the text to search for
-  # @return [Element] the first matching element
-  def text text
-    text = escape_single_quote text
-    js = first_ele_js "value contains[c] '#{text}'"
-    execute_script js
-  end
-
-  # Return all elements matching text.
-  # @param text [String] the text to search for
-  # @return [Array<Element>] all matching elements
-  def texts text
-    text = escape_single_quote 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.
-  # 
-  # ```ruby
-  # # find element with name or label containing example and access the name attribute.
-  # name('example').name 
-  #
-  # # find element with name or label containing example and access the label attribute.
-  # name('example').label 
-  # ```
-  #
-  # @param name [String] the name to search for
-  # @return [Element] the first matching element
-  def name name
-    name = escape_single_quote name
-    mobile :findElementNameContains, name: name
-  end
-
-  def name_exact name
-    name = escape_single_quote name
-    js = all_ele_js "name == '#{name}'"
-    result = execute_script js
-
-    return result if result.kind_of? Selenium::WebDriver::Element
-
-    if result.length > 0
-      result.first
-    else
-      Appium::Common.raise_no_element_error
+    # 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
 
-  # 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
-    name = escape_single_quote name
-    # :name is not consistent across iOS and Android so use custom JavaScript
-    # https://github.com/appium/appium/issues/379
-    js = all_ele_js "name contains[c] '#{name}' || label contains[c] '#{name}'"
-    execute_script js
-  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
+    end
 
-  def escape_single_quote text_to_escape
-    text_to_escape.gsub("'", '\\' * 4 + "'")
-  end
-end # module Appium::Ios
+    # 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
+  end # module Ios
+end # module Appium

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

@@ -0,0 +1,54 @@
+# UIAStaticText methods
+module Appium
+  module Ios
+    UIAStaticText = 'UIAStaticText'
+
+    # Find the first UIAStaticText that contains value or by index.
+    # @param value [String, Integer] the value to find.
+    # If int then the UIAStaticText at that index is returned.
+    # @return [UIAStaticText]
+    def s_text value
+      return ele_index UIAStaticText, value if value.is_a? Numeric
+      xpath_visible_contains UIAStaticText, value
+    end
+
+    # Find all UIAStaticText containing value.
+    # @param value [String] the value to search for
+    # @return [Array<UIAStaticText>]
+    def s_texts value
+      xpaths_visible_contains UIAStaticText, value
+    end
+
+    # Find the first UIAStaticText.
+    # @return [UIAStaticText]
+    def first_s_text
+      first_ele UIAStaticText
+    end
+
+    # Find the last UIAStaticText.
+    # @return [UIAStaticText]
+    def last_s_text
+      last_ele UIAStaticText
+    end
+
+    # Find the first UIAStaticText that exactly matches value.
+    # @param value [String] the value to match exactly
+    # @return [UIAStaticText]
+    def s_text_exact value
+      xpath_visible_exact UIAStaticText, value
+    end
+
+    # Find all UIAStaticTexts that exactly match value.
+    # @param value [String] the value to match exactly
+    # @return [Array<UIAStaticText>]
+    def s_texts_exact value
+      xpaths_visible_exact UIAStaticText, value
+    end
+
+    # Find all UIAStaticTexts.
+    # @return [Array<UIAStaticText>]
+    def e_s_texts
+      tags UIAStaticText
+    end
+  end # module Ios
+end # module Appium

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

@@ -1,77 +1,90 @@
-# encoding: utf-8
-module Appium::Ios
-  # UIATextField & UIASecureTextField methods
-  #
-  # Find textfield and then secure elements in one server call
-  # to match Android.
+module Appium
+  module Ios
+    UIATextField       = 'UIATextField'
+    UIASecureTextField = 'UIASecureTextField'
 
-  def locate_single_textfield js
-    ele = execute_script(js)
-    ele = ele.first if ele.kind_of? Array
-    raise_no_element_error unless ele.kind_of? Selenium::WebDriver::Element
-    ele
-  end
+    private
 
-  # Get an array of textfield texts.
-  # Does not respect implicit wait because we're using execute_script.
-  # @return [Array<String>]
-  def textfields
-    find_2_eles_attr :textfield, :secure, :text
-  end
+    # @private
+    def _textfield_visible_string opts={}
+      index = opts.fetch :index, false
+      if index
+        %Q(//#{UIATextField}[@visible="true"][#{index}] | //#{UIASecureTextField}[@visible="true"][#{index}])
+      else
+        %Q(//#{UIATextField}[@visible="true"] | //#{UIASecureTextField}[@visible="true"])
+      end
+    end
+
+    # @private
+    def _textfield_exact_string value
+      textfield = string_visible_exact UIATextField, value
+      secure    = string_visible_exact UIASecureTextField, value
+      "#{textfield} | #{secure}"
+    end
+
+    # @private
+    def _textfield_contains_string value
+      textfield = string_visible_contains UIATextField, value
+      secure    = string_visible_contains UIASecureTextField, value
+      "#{textfield} | #{secure}"
+    end
+
+    public
 
-  # Get an array of textfield elements.
-  # @return [Array<Textfield>]
-  def e_textfields
-    xpaths 'textfield'
-  end
+    # Find the first TextField that contains value or by index.
+    # @param value [String, Integer] the text to match exactly.
+    # If int then the TextField at that index is returned.
+    # @return [TextField]
+    def textfield value
+      # Don't use ele_index because that only works on one element type.
+      # iOS needs to combine textfield and secure to match Android.
+      if value.is_a? Numeric
+        index = value
+        raise "#{index} is not a valid xpath index. Must be >= 1" if index <= 0
 
-  # Get the first textfield element.
-  # @return [Textfield]
-  def first_textfield
-    xpath 'textfield'
-  end
+        return xpath _textfield_visible_string index: index
+      end
 
-  # Get the last textfield element.
-  # @return [Textfield]
-  def last_textfield
-    xpath 'textfield[last()]'
-  end
+      xpath _textfield_contains_string value
+    end
+
+    # Find all TextFields containing value.
+    # @param value [String] the value to search for
+    # @return [Array<TextField>]
+    def textfields value
+      xpaths _textfield_contains_string value
+    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
-      raise "#{text} is not a valid xpath index. Must be >= 1" if text <= 0
-      return xpath("textfield[#{text}]")
+    # Find the first TextField.
+    # @return [TextField]
+    def first_textfield
+      xpath _textfield_visible_string
     end
 
-    textfield_include text
-  end
+    # Find the last TextField.
+    # @return [TextField]
+    def last_textfield
+      xpath _textfield_visible_string index: 'last()'
+    end
 
-  # Get the first textfield that includes text.
-  # @param text [String] the text the textfield must include
-  # @return [Textfield]
-  def textfield_include text
-    xpath "textfield[contains(@text,'#{text}')]"
-  end
+    # Find the first TextField that exactly matches value.
+    # @param value [String] the value to match exactly
+    # @return [TextField]
+    def textfield_exact value
+      xpath _textfield_exact_string value
+    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
-    xpath "textfield[@text='#{text}']"
-  end
+    # Find all TextFields that exactly match value.
+    # @param value [String] the value to match exactly
+    # @return [Array<TextField>]
+    def textfields_exact value
+      xpaths _textfield_exact_string value
+    end
 
-  # Get the first textfield that exactly matches name
-  # @return [Element]
-  def textfield_named target_name
-    wait do
-      target = e_textfields.detect { |e| e.name == target_name }
-      raise "Textfield named #{target_name} not found" unless target
-      target
+    # Find all TextFields.
+    # @return [Array<TextField>]
+    def e_textfields
+      xpaths _textfield_visible_string
     end
-  end
-end # module Appium::Ios
+  end # module Ios
+end # module Appium