Refactor iOS textfield xpath

Author: bootstraponline

ios_tests/lib/ios/specs/ios/element/textfield.rb

@@ -20,21 +20,10 @@ def after_last
     before_first
   end
 
-  t 'e_textfields' do
-    e_textfields.length.must_equal 4
-  end
-
-  t 'first_textfield' do
-    first_textfield.text.must_equal enter_text
-  end
-
-  t 'last_textfield' do
-    last_textfield.text.must_equal enter_password
-  end
-
   t 'textfield' do
     textfield(1).text.must_equal(enter_text)
     textfield(enter_text).text.must_equal(enter_text)
+    textfield('word').text.must_equal enter_password
   end
 
   t 'textfields' do
@@ -43,16 +32,28 @@ def after_last
     values.include?('<enter password>').must_equal true
   end
 
-  t 'textfield_include' do
-    textfield_include('word').text.must_equal enter_password
+  t 'first_textfield' do
+    first_textfield.text.must_equal enter_text
+  end
+
+  t 'last_textfield' do
+    last_textfield.text.must_equal enter_password
   end
 
   t 'textfield_exact' do
     textfield_exact(enter_password).text.must_equal enter_password
   end
 
+  t 'textfields_exact' do
+    textfields_exact(enter_password).first.text.must_equal enter_password
+  end
+
+  t 'e_textfields' do
+    e_textfields.length.must_equal 4
+  end
+
   def keyboard_exists?
-    !! ignore { wait_true(3) { execute_script 'au.mainApp().keyboard().type() !== "UIAElementNil"' } }
+    !!ignore { wait_true(3) { execute_script 'au.mainApp().keyboard().type() !== "UIAElementNil"' } }
   end
 
   def keyboard_must_not_exist
@@ -81,15 +82,19 @@ def must_raise_no_element &block
   end
 
   # test textfield methods with no textfields
-  t 'no textfields' do
+
+  t 'leave textfields' do
     set_wait 1
-    # must leave textfield screen for the rest of the tests
     leave_textfields
-    e_textfields.must_equal []
   end
 
-  t 'no e_textfields' do
-    e_textfields.length.must_equal 0
+  t 'no textfield' do
+    must_raise_no_element { textfield(1) }
+    must_raise_no_element { textfield('does not exist') }
+  end
+
+  t 'no textfields' do
+    textfields('does not exist').length.must_equal 0
   end
 
   t 'no first_textfield' do
@@ -100,17 +105,16 @@ def must_raise_no_element &block
     must_raise_no_element { last_textfield }
   end
 
-  t 'no textfield' do
-    must_raise_no_element { textfield(1) }
-    must_raise_no_element { textfield('does not exist') }
+  t 'no textfield_exact' do
+    must_raise_no_element { textfield_exact('does not exist') }
   end
 
-  t 'no textfield_include' do
-    must_raise_no_element { textfield_include('does not exist') }
+  t 'no textfields_exact' do
+    textfields_exact('does not exist').length.must_equal 0
   end
 
-  t 'no textfield_exact' do
-    must_raise_no_element { textfield_exact('does not exist') }
+  t 'no e_textfields' do
+    e_textfields.length.must_equal 0
   end
 
   t 'after_last' do

lib/appium_lib/ios/element/textfield.rb

@@ -1,27 +1,34 @@
 module Appium
   module Ios
-    UIATextField = 'UIATextField'
+    UIATextField       = 'UIATextField'
     UIASecureTextField = 'UIASecureTextField'
-    # Get an array of textfield elements.
-    # @return [Array<Textfield>]
-    def e_textfields
-      xpaths %Q(//#{UIATextField}[@visible="true"] | //#{UIASecureTextField}[@visible="true"])
+
+    # @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
 
-    # Get the first textfield element.
-    # @return [Textfield]
-    def first_textfield
-      xpath %Q(//#{UIATextField}[@visible="true"] | //#{UIASecureTextField}[@visible="true"])
+    # @private
+    def _textfield_exact_string value
+      textfield = string_visible_exact UIATextField, value
+      secure    = string_visible_exact UIASecureTextField, value
+      "#{textfield} | #{secure}"
     end
 
-    # Get the last textfield element.
-    # @return [Textfield]
-    def last_textfield
-      xpath %Q(//#{UIATextField}[@visible="true"][last()] | //#{UIASecureTextField}[@visible="true"][last()])
+    # @private
+    def _textfield_contains_string value
+      textfield = string_visible_contains UIATextField, value
+      secure    = string_visible_contains UIASecureTextField, value
+      "#{textfield} | #{secure}"
     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.
+    # @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.
@@ -30,34 +37,43 @@ def textfield value
         index = value
         raise "#{index} is not a valid xpath index. Must be >= 1" if index <= 0
 
-        return xpath(%Q(//#{UIATextField}[@visible="true"][#{index}] | //#{UIASecureTextField}[@visible="true"][#{index}]))
+        return xpath _textfield_visible_string index: index
       end
 
-      textfield_include value
+      xpath _textfield_contains_string value
     end
 
     def textfields value
-      textfield = string_visible_include UIATextField, value
-      secure = string_visible_include UIASecureTextField, value
-      xpaths "#{textfield} | #{secure}"
+      xpaths _textfield_contains_string value
     end
 
-    # Get the first textfield that includes text.
-    # @param value [String] the value the textfield must include
+    # Get the first textfield element.
     # @return [Textfield]
-    def textfield_include value
-      textfield = string_visible_include UIATextField, value
-      secure = string_visible_include UIASecureTextField, value
-      xpath "#{textfield} | #{secure}"
+    def first_textfield
+      xpath _textfield_visible_string
+    end
+
+    # Get the last textfield element.
+    # @return [Textfield]
+    def last_textfield
+      xpath _textfield_visible_string index: 'last()'
     end
 
     # Get the first textfield that exactly matches text.
     # @param value [String] the value the textfield must exactly match
     # @return [Textfield]
     def textfield_exact value
-      textfield = string_visible_exact UIATextField, value
-      secure = string_visible_exact UIASecureTextField, value
-      xpath "#{textfield} | #{secure}"
+      xpath _textfield_exact_string value
+    end
+
+    def textfields_exact value
+      xpaths _textfield_exact_string value
+    end
+
+    # Get an array of textfield elements.
+    # @return [Array<Textfield>]
+    def e_textfields
+      xpaths _textfield_visible_string
     end
   end # module Ios
 end # module Appium

lib/appium_lib/ios/helper.rb

@@ -138,7 +138,7 @@ def id id
       value = resolve_id id
       raise "Invalid id `#{id}`" unless value
       exact    = string_visible_exact '*', value
-      contains = string_visible_include '*', value
+      contains = string_visible_contains '*', value
       xpath "#{exact} | #{contains}"
     end
 
@@ -226,7 +226,7 @@ def tags class_name
 
     # xpath fragment helper
     # example: xpath_visible_contains 'UIATextField', text
-    def string_visible_include element, value
+    def string_visible_contains element, value
       result     = []
       attributes = %w[name hint label value]
 
@@ -243,11 +243,11 @@ def string_visible_include element, value
     end
 
     def xpath_visible_contains element, value
-      xpath string_visible_include element, value
+      xpath string_visible_contains element, value
     end
 
     def xpaths_visible_contains element, value
-      xpaths string_visible_include element, value
+      xpaths string_visible_contains element, value
     end
 
     def string_visible_exact element, value
@@ -260,6 +260,7 @@ def string_visible_exact element, value
 
       result = result.join(' or ')
       result = %Q(@visible="true" and (#{result}))
+
       "//#{element}[#{result}]"
     end