fix returning only visible elements (#465)

* fix tags to return only visible elements

* fix rubocop

* set visible check

* remove some wrong cases

* fix single quote's escape

Author: KazuCocoa

ios_tests/appium.txt

@@ -1,6 +1,6 @@
 [caps]
 platformName = "ios"
-platformVersion = "10.1"
+platformVersion = "10.2"
 deviceName ="iPhone Simulator"
 automationName = 'XCUITest'
 app = "./UICatalog.app"

ios_tests/lib/ios/specs/common/helper.rb

@@ -146,7 +146,7 @@ def uibutton_text
   end
 
   t 'last_ele' do
-    expected = UI::Inventory.xcuitest? ? 'Shows UIViewAnimationTransitions' : 'Transitions'
+    expected = 'Transitions'
 
     el = last_ele(UI::Inventory.static_text)
     el.text.must_equal expected

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

@@ -29,7 +29,6 @@ def gray
 
   t 'buttons' do
     exp = ['Back', 'Back', 'Gray', 'Right pointing arrow']
-    exp.concat ['Add contact'] if UI::Inventory.xcuitest?
 
     target_buttons = buttons('a')
     target_buttons.map(&:name).must_equal exp
@@ -41,7 +40,7 @@ def gray
   end
 
   t 'last_button' do
-    expected = UI::Inventory.xcuitest? ? 'Add contact' : 'Rounded'
+    expected = 'Rounded'
     last_button.name.must_equal expected
   end
 

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

@@ -23,7 +23,7 @@ def before_first
   end
 
   t 'last_text' do
-    expected = UI::Inventory.xcuitest? ? 'Shows UIViewAnimationTransitions' : 'Transitions'
+    expected = 'Transitions'
 
     last_text.text.must_equal expected
     last_text.name.must_equal expected
@@ -37,7 +37,7 @@ def before_first
 
   t 'texts' do
     exp = ['Controls', 'Various uses of UIControl', 'Various uses of UISegmentedControl']
-    texts.length.must_equal(UI::Inventory.xcuitest? ? 25 : 24)
+    texts.length.must_equal 24
     texts('trol').map(&:name).must_equal exp
     texts('uses').length.must_equal 7
   end

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

@@ -71,9 +71,11 @@ def keyboard_must_exist
   t 'textfield type' do
     # Regular send keys triggers the keyboard and doesn't dismiss
     keyboard_must_not_exist unless UI::Inventory.xcuitest? # xcuitest doesn't support JS command
-    textfield(1).send_keys 'ok'
+    textfield(1).send_keys "o'k"
     keyboard_must_exist unless UI::Inventory.xcuitest? # xcuitest doesn't support JS command
 
+    find_exact("o'k").text.must_equal "o'k"
+
     unless UI::Inventory.xcuitest?
       # type should not dismiss the keyboard
       message = 'type test type'

ios_tests/lib/ios/specs/ios/patch.rb

@@ -14,12 +14,7 @@ def after_last
   end
 
   t 'label' do
-    if UI::Inventory.xcuitest?
-      # Order of the elements are: Normal, Rounded, Secure, Check
-      find_element(:name, '<enter text>').label.must_equal 'Normal'
-    else
-      textfield('<enter text>').label.must_equal 'Rounded'
-    end
+    textfield('<enter text>').label.must_equal 'Rounded'
   end
 
   t 'type' do

lib/appium_lib/ios/element/button.rb

@@ -18,7 +18,7 @@ def button(value)
       return ele_index button_class, value if value.is_a? Numeric
 
       if automation_name_is_xcuitest?
-        _raise_error_if_no_element buttons(value).first
+        raise_error_if_no_element buttons(value).first
       else
         ele_by_json_visible_contains button_class, value
       end
@@ -32,8 +32,8 @@ def buttons(value = false)
       return tags button_class unless value
 
       if automation_name_is_xcuitest?
-        elements = tags button_class
-        _elements_include elements, value
+        visible_elements = tags button_class
+        elements_include visible_elements, value
       else
         eles_by_json_visible_contains button_class, value
       end
@@ -58,7 +58,7 @@ def last_button
     # @return [UIAButton|XCUIElementTypeButton]
     def button_exact(value)
       if automation_name_is_xcuitest?
-        _raise_error_if_no_element buttons_exact(value).first
+        raise_error_if_no_element buttons_exact(value).first
       else
         ele_by_json_visible_exact button_class, value
       end
@@ -69,8 +69,8 @@ def button_exact(value)
     # @return [Array<UIAButton|XCUIElementTypeButton>]
     def buttons_exact(value)
       if automation_name_is_xcuitest?
-        elements = tags button_class
-        _elements_exact elements, value
+        visible_elements = tags button_class
+        elements_exact visible_elements, value
       else
         eles_by_json_visible_exact button_class, value
       end

lib/appium_lib/ios/element/generic.rb

@@ -5,7 +5,7 @@ module Ios
     # @return [Element]
     def find(value)
       if automation_name_is_xcuitest?
-        find_ele_by_attr_include '*', '*', value
+        raise_error_if_no_element finds(value).first
       else
         ele_by_json_visible_contains '*', value
       end
@@ -16,7 +16,8 @@ def find(value)
     # @return [Array<Element>]
     def finds(value)
       if automation_name_is_xcuitest?
-        find_eles_by_attr_include '*', '*', value
+        elements = find_eles_by_attr_include '*', '*', value
+        select_visible_elements elements
       else
         eles_by_json_visible_contains '*', value
       end
@@ -27,7 +28,7 @@ def finds(value)
     # @return [Element]
     def find_exact(value)
       if automation_name_is_xcuitest?
-        find_ele_by_attr '*', '*', value
+        raise_error_if_no_element finds_exact(value).first
       else
         ele_by_json_visible_exact '*', value
       end
@@ -38,33 +39,52 @@ def find_exact(value)
     # @return [Array<Element>]
     def finds_exact(value)
       if automation_name_is_xcuitest?
-        find_eles_by_attr '*', '*', value
+        elements = find_eles_by_attr '*', '*', value
+        select_visible_elements elements
       else
         eles_by_json_visible_exact '*', value
       end
     end
 
     private
 
-    def _raise_error_if_no_element(element)
-      raise ::Selenium::WebDriver::Error::NoSuchElementError if element.nil?
+    def raise_error_if_no_element(element)
+      error_message = 'An element could not be located on the page using the given search parameters.'
+      raise(::Selenium::WebDriver::Error::NoSuchElementError, error_message) if element.nil?
       element
     end
 
-    def _elements_include(elements, value)
+    # Return all elements include not displayed elements.
+    def elements_include(elements, value)
       return [] if elements.empty?
       elements.select do |element|
+        # `text` is equal to `value` if value is not `nil`
+        # `text` is equal to `name` if value is `nil`
         name = element.name
-        name.nil? ? false : name.downcase.include?(value.downcase)
+        text = element.value
+        name_result = name.nil? ? false : name.downcase.include?(value.downcase)
+        text_result = text.nil? ? false : text.downcase.include?(value.downcase)
+        name_result || text_result
       end
     end
 
-    def _elements_exact(elements, value)
+    # Return all elements include not displayed elements.
+    def elements_exact(elements, value)
       return [] if elements.empty?
       elements.select do |element|
+        # `text` is equal to `value` if value is not `nil`
+        # `text` is equal to `name` if value is `nil`
         name = element.name
-        name.nil? ? false : name.casecmp(value).zero?
+        text = element.value
+        name_result = name.nil? ? false : name.casecmp(value).zero?
+        text_result = text.nil? ? false : text.casecmp(value).zero?
+        name_result || text_result
       end
     end
+
+    # Return visible elements.
+    def select_visible_elements(elements)
+      elements.select(&:displayed?)
+    end
   end # module Ios
 end # module Appium

lib/appium_lib/ios/element/text.rb

@@ -17,7 +17,7 @@ def text(value)
       return ele_index static_text_class, value if value.is_a? Numeric
 
       if automation_name_is_xcuitest?
-        _raise_error_if_no_element texts(value).first
+        raise_error_if_no_element texts(value).first
       else
         ele_by_json_visible_contains static_text_class, value
       end
@@ -31,8 +31,8 @@ def texts(value = false)
       return tags static_text_class unless value
 
       if automation_name_is_xcuitest?
-        elements = tags static_text_class
-        _elements_include elements, value
+        visible_elements = tags static_text_class
+        elements_include visible_elements, value
       else
         eles_by_json_visible_contains static_text_class, value
       end
@@ -55,7 +55,7 @@ def last_text
     # @return [UIAStaticText|XCUIElementTypeStaticText]
     def text_exact(value)
       if automation_name_is_xcuitest?
-        _raise_error_if_no_element texts_exact(value).first
+        raise_error_if_no_element texts_exact(value).first
       else
         ele_by_json_visible_exact static_text_class, value
       end
@@ -66,8 +66,8 @@ def text_exact(value)
     # @return [Array<UIAStaticText|XCUIElementTypeStaticText>]
     def texts_exact(value)
       if automation_name_is_xcuitest?
-        elements = tags static_text_class
-        _elements_exact elements, value
+        visible_elements = tags static_text_class
+        elements_exact visible_elements, value
       else
         eles_by_json_visible_exact static_text_class, value
       end

lib/appium_lib/ios/element/textfield.rb

@@ -27,13 +27,14 @@ def _textfields
     # @private
     # for XCUITest
     def _textfield_with_xpath
-      xpath "//#{_textfields}"
+      raise_error_if_no_element _textfields_with_xpath.first
     end
 
     # @private
     # for XCUITest
     def _textfields_with_xpath
-      xpaths "//#{_textfields}"
+      elements = xpaths "//#{_textfields}"
+      select_visible_elements elements
     end
 
     # Appium
@@ -78,7 +79,7 @@ def textfield(value)
       end
 
       if automation_name_is_xcuitest?
-        find_ele_by_attr_include _textfields, '*', value
+        raise_error_if_no_element textfields(value).first
       else
         ele_by_json _textfield_contains_string value
       end
@@ -91,7 +92,8 @@ def textfield(value)
     def textfields(value = false)
       if automation_name_is_xcuitest?
         return _textfields_with_xpath unless value
-        find_eles_by_attr_include _textfields, '*', value
+        elements = find_eles_by_attr_include _textfields, '*', value
+        select_visible_elements elements
       else
         return eles_by_json _textfield_visible unless value
         eles_by_json _textfield_contains_string value
@@ -125,7 +127,7 @@ def last_textfield
     # @return [TextField]
     def textfield_exact(value)
       if automation_name_is_xcuitest?
-        find_ele_by_attr _textfields, '*', value
+        raise_error_if_no_element textfields_exact(value).first
       else
         ele_by_json _textfield_exact_string value
       end
@@ -136,7 +138,8 @@ def textfield_exact(value)
     # @return [Array<TextField>]
     def textfields_exact(value)
       if automation_name_is_xcuitest?
-        find_eles_by_attr _textfields, '*', value
+        elements = find_eles_by_attr _textfields, '*', value
+        select_visible_elements elements
       else
         eles_by_json _textfield_exact_string value
       end

lib/appium_lib/ios/helper.rb

@@ -229,17 +229,18 @@ def ele_index(class_name, index)
     def string_attr_exact(class_name, attr, value)
       if automation_name_is_xcuitest?
         if attr == '*'
-          %((//#{class_name})[@*[.='#{value}']])
+          %((//#{class_name})[@*[.="#{value}"]])
         else
-          %((//#{class_name})[@#{attr}='#{value}'])
+          %((//#{class_name})[@#{attr}="#{value}"])
         end
       else
-        %(//#{class_name}[@visible="true" and @#{attr}='#{value}'])
+        %(//#{class_name}[@visible="true" and @#{attr}="#{value}"])
       end
     end
 
     # Find the first element exactly matching class and attribute value.
     # Note: Uses XPath
+    # Note: For XCUITest, this method return ALL elements include displayed or not displayed elements.
     # @param class_name [String] the class name to search for
     # @param attr [String] the attribute to inspect
     # @param value [String] the expected value of the attribute
@@ -250,6 +251,7 @@ def find_ele_by_attr(class_name, attr, value)
 
     # Find all elements exactly matching class and attribute value.
     # Note: Uses XPath
+    # Note: For XCUITest, this method return ALL elements include displayed or not displayed elements.
     # @param class_name [String] the class name to match
     # @param attr [String] the attribute to compare
     # @param value [String] the value of the attribute that the element must have
@@ -262,12 +264,12 @@ def find_eles_by_attr(class_name, attr, value)
     def string_attr_include(class_name, attr, value)
       if automation_name_is_xcuitest?
         if attr == '*'
-          %((//#{class_name})[@*[contains(translate(., '#{value.upcase}', '#{value}'), '#{value}')]])
+          %((//#{class_name})[@*[contains(translate(., "#{value.upcase}", "#{value}"), "#{value}")]])
         else
-          %((//#{class_name})[contains(translate(@#{attr}, '#{value.upcase}', '#{value}'), '#{value}')])
+          %((//#{class_name})[contains(translate(@#{attr}, "#{value.upcase}", "#{value}"), "#{value}")])
         end
       else
-        %(//#{class_name}[@visible="true" and contains(translate(@#{attr},'#{value.upcase}', '#{value}'), '#{value}')])
+        %(//#{class_name}[@visible="true" and contains(translate(@#{attr},"#{value.upcase}", "#{value}"), "#{value}")])
       end
     end
 
@@ -295,33 +297,29 @@ def find_eles_by_attr_include(class_name, attr, value)
     # @param class_name [String] the tag to match
     # @return [Element]
     def first_ele(class_name)
-      if automation_name_is_xcuitest?
-        @driver.find_element :class, class_name
-      else
-        ele_index class_name, 1
-      end
+      ele_index class_name, 1
     end
 
     # Get the last tag that matches class_name
     # @param class_name [String] the tag to match
     # @return [Element]
     def last_ele(class_name)
       if automation_name_is_xcuitest?
-        result = @driver.find_elements :xpath, "(//#{class_name})"
-        raise _no_such_element if result.empty?
-        result.last
+        visible_elements = tags class_name
+        raise _no_such_element if visible_elements.empty?
+        visible_elements.last
       else
         ele_index class_name, 'last()'
       end
     end
 
-    # Returns the first visible element matching class_name
+    # Returns the first **visible** element matching class_name
     #
     # @param class_name [String] the class_name to search for
     # @return [Element]
     def tag(class_name)
       if automation_name_is_xcuitest?
-        first_ele(class_name)
+        raise_error_if_no_element tags(class_name).first
       else
         ele_by_json(typeArray: [class_name], onlyVisible: true)
       end
@@ -333,7 +331,8 @@ def tag(class_name)
     # @return [Element]
     def tags(class_name)
       if automation_name_is_xcuitest?
-        @driver.find_elements :class, class_name
+        elements = @driver.find_elements :class, class_name
+        select_visible_elements elements
       else
         eles_by_json(typeArray: [class_name], onlyVisible: true)
       end