appium_lib 9.5.0 → 9.6.0

data/lib/appium_lib/ios/mobile_methods.rb

@@ -21,25 +21,5 @@ module Appium
         ::Appium::Driver::SearchContext::FINDERS[:predicate] = '-ios predicate string'
       end
     end # class << self
-
-    module Xcuitest
-      class << self
-        # @!method ios_class_chain_find
-        #   Only for XCUITest(WebDriverAgent)
-        #   find_element/s can be used with a [class chain]( https://github.com/facebook/WebDriverAgent/wiki/Queries)
-        #
-        #   ```ruby
-        #    # select the third child button of the first child window element
-        #    find_elements :class_chain, 'XCUIElementTypeWindow/XCUIElementTypeButton[3]'
-        #    # select all the children windows
-        #    find_elements :class_chain, 'XCUIElementTypeWindow'
-        #    # select the second last child of the second child window
-        #    find_elements :class_chain, 'XCUIElementTypeWindow[2]/XCUIElementTypeAny[-2]'
-        #   ```
-        def extended(_mod)
-          ::Appium::Driver::SearchContext::FINDERS[:class_chain] = '-ios class chain'
-        end
-      end
-    end
   end # module Ios
 end # module Appium

data/lib/appium_lib/ios/patch.rb

@@ -13,12 +13,8 @@ module Appium
         end
 
         # Cross platform way of entering text into a textfield
-        def type(text)
-          if $driver.automation_name_is_xcuitest?
-            send_keys text
-          else
-            $driver.execute_script %(au.getElement('#{ref}').setValue('#{text}');)
-          end
+        def type(text, driver = $driver)
+          driver.execute_script %(au.getElement('#{ref}').setValue('#{text}');)
         end # def type
       end # Selenium::WebDriver::Element.class_eval
     end # def patch_webdriver_element

data/lib/appium_lib/ios/xcuitest/device.rb

@@ -0,0 +1,59 @@
+require 'base64'
+
+module Appium
+  module Ios
+    module Xcuitest
+      module Device
+        extend Forwardable
+
+        # @!method hide_keyboard
+        #   Hide the onscreen keyboard
+        #   @param [String] close_key The name of the key which closes the keyboard.
+        #   @param [Symbol] strategy The symbol of the strategy which closes the keyboard.
+        #     XCUITest ignore this argument.
+        #     Default for iOS is `:pressKey`. Default for Android is `:tapOutside`.
+        #  ```ruby
+        #  hide_keyboard # Close a keyboard with the 'Done' button
+        #  hide_keyboard('Finished') # Close a keyboard with the 'Finished' button
+        #  ```
+
+        # @!method background_app
+        #  Backgrounds the app for a set number of seconds.
+        #  This is a blocking application
+        # @param [Integer] seconds How many seconds to background the app for.
+        #
+        #   ```ruby
+        #   background_app
+        #   background_app(5)
+        #   background_app(-1) #=> the app never come back. https://github.com/appium/appium/issues/7741
+        #   ```
+
+        class << self
+          def extended(_mod)
+            ::Appium::Device.extend_webdriver_with_forwardable
+
+            ::Appium::Device.add_endpoint_method(:hide_keyboard) do
+              def hide_keyboard(close_key = nil, strategy = nil)
+                option = {}
+
+                option[:key] = close_key if close_key
+                option[:strategy] = strategy if strategy
+
+                execute :hide_keyboard, {}, option
+              end
+            end
+
+            ::Appium::Device.add_endpoint_method(:background_app) do
+              def background_app(duration = 0)
+                # https://github.com/appium/ruby_lib/issues/500, https://github.com/appium/appium/issues/7741
+                # `execute :background_app, {}, seconds: { timeout: duration_milli_sec }` works over Appium 1.6.4
+                duration_milli_sec = duration.nil? ? nil : duration * 1000
+                execute :background_app, {}, seconds: { timeout: duration_milli_sec }
+              end
+            end
+          end
+        end # class << self
+      end # module Device
+    end # module Xcuitest
+  end # module Ios
+end # module Appium

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

@@ -0,0 +1,24 @@
+module Appium
+  module Ios
+    module Xcuitest
+      # @private
+      # class_eval inside a method because class Selenium::WebDriver::Element
+      # will trigger as soon as the file is required. in contrast a method
+      # will trigger only when invoked.
+      def patch_webdriver_element
+        Selenium::WebDriver::Element.class_eval do
+          # Enable access to iOS accessibility label
+          # accessibility identifier is supported as 'name'
+          def label
+            attribute('label')
+          end
+
+          # Cross platform way of entering text into a textfield
+          def type(text)
+            send_keys text
+          end # def type
+        end # Selenium::WebDriver::Element.class_eval
+      end # def patch_webdriver_element
+    end # module Xcuitest
+  end # module Ios
+end # module Appium

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

@@ -0,0 +1,64 @@
+# XCUIElementTypeButton methods
+module Appium
+  module Ios
+    module Xcuitest
+      module Element
+        # XCUIElementTypeButton = 'XCUIElementTypeButton'.freeze
+
+        # @return [String] Class name for button
+        def button_class
+          ::Appium::Ios::XCUIElementTypeButton
+        end
+
+        # Find the first UIAButton|XCUIElementTypeButton that contains value or by index.
+        # @param value [String, Integer] the value to exactly match.
+        # If int then the UIAButton|XCUIElementTypeButton at that index is returned.
+        # @return [UIAButton|XCUIElementTypeButton]
+        def button(value)
+          # return button at index.
+          return ele_index button_class, value if value.is_a? Numeric
+          raise_error_if_no_element buttons(value).first
+        end
+
+        # Find all UIAButtons|XCUIElementTypeButtons containing value.
+        # If value is omitted, all UIAButtons|XCUIElementTypeButtons are returned.
+        # @param value [String] the value to search for
+        # @return [Array<UIAButton|XCUIElementTypeButton>]
+        def buttons(value = false)
+          return tags button_class unless value
+          elements = find_eles_by_predicate_include(class_name: button_class, value: value)
+          select_visible_elements elements
+        end
+
+        # Find the first UIAButton|XCUIElementTypeButton.
+        # @return [UIAButton|XCUIElementTypeButton]
+        def first_button
+          first_ele button_class
+        end
+
+        # TODO: add documentation regarding previous element.
+        #       Previous UIAElement is differ from UIAButton|XCUIElementTypeButton. So, the results are different.
+        # Find the last UIAButton|XCUIElementTypeButton.
+        # @return [UIAButton|XCUIElementTypeButton]
+        def last_button
+          last_ele button_class
+        end
+
+        # Find the first UIAButton|XCUIElementTypeButton that exactly matches value.
+        # @param value [String] the value to match exactly
+        # @return [UIAButton|XCUIElementTypeButton]
+        def button_exact(value)
+          raise_error_if_no_element buttons_exact(value).first
+        end
+
+        # Find all UIAButtons|XCUIElementTypeButtons that exactly match value.
+        # @param value [String] the value to match exactly
+        # @return [Array<UIAButton|XCUIElementTypeButton>]
+        def buttons_exact(value)
+          elements = find_eles_by_predicate(class_name: button_class, value: value)
+          select_visible_elements elements
+        end
+      end # moudule button
+    end # module Xcuitest
+  end # module Ios
+end # module Appium

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

@@ -0,0 +1,50 @@
+module Appium
+  module Ios
+    module Xcuitest
+      module Element
+        # Find the first element containing value
+        # @param value [String] the value to search for
+        # @return [Element]
+        def find(value)
+          raise_error_if_no_element finds(value).first
+        end
+
+        # Find all elements containing value
+        # @param value [String] the value to search for
+        # @return [Array<Element>]
+        def finds(value)
+          elements = find_eles_by_predicate_include value: value
+          select_visible_elements elements
+        end
+
+        # Find the first element exactly matching value
+        # @param value [String] the value to search for
+        # @return [Element]
+        def find_exact(value)
+          raise_error_if_no_element finds_exact(value).first
+        end
+
+        # Find all elements exactly matching value
+        # @param value [String] the value to search for
+        # @return [Array<Element>]
+        def finds_exact(value)
+          elements = find_eles_by_predicate value: value
+          select_visible_elements elements
+        end
+
+        private
+
+        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
+
+        # Return visible elements.
+        def select_visible_elements(elements)
+          elements.select(&:displayed?)
+        end
+      end # module Element
+    end # module Xcuitest
+  end # module Ios
+end # module Appium

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

@@ -0,0 +1,61 @@
+# UIAStaticText|XCUIElementTypeStaticText methods
+module Appium
+  module Ios
+    module Xcuitest
+      module Element
+        # XCUIElementTypeStaticText = 'XCUIElementTypeStaticText'.freeze
+
+        # @return [String] Class name for text
+        def static_text_class
+          ::Appium::Ios::XCUIElementTypeStaticText
+        end
+
+        # Find the first UIAStaticText|XCUIElementTypeStaticText that contains value or by index.
+        # @param value [String, Integer] the value to find.
+        # If int then the UIAStaticText|XCUIElementTypeStaticText at that index is returned.
+        # @return [UIAStaticText|XCUIElementTypeStaticText]
+        def text(value)
+          return ele_index static_text_class, value if value.is_a? Numeric
+          raise_error_if_no_element texts(value).first
+        end
+
+        # Find all UIAStaticTexts|XCUIElementTypeStaticTexts containing value.
+        # If value is omitted, all UIAStaticTexts|XCUIElementTypeStaticTexts are returned
+        # @param value [String] the value to search for
+        # @return [Array<UIAStaticText|XCUIElementTypeStaticText>]
+        def texts(value = false)
+          return tags static_text_class unless value
+          elements = find_eles_by_predicate_include(class_name: static_text_class, value: value)
+          select_visible_elements elements
+        end
+
+        # Find the first UIAStaticText|XCUIElementTypeStaticText.
+        # @return [UIAStaticText|XCUIElementTypeStaticText]
+        def first_text
+          first_ele static_text_class
+        end
+
+        # Find the last UIAStaticText|XCUIElementTypeStaticText.
+        # @return [UIAStaticText|XCUIElementTypeStaticText]
+        def last_text
+          last_ele static_text_class
+        end
+
+        # Find the first UIAStaticText|XCUIElementTypeStaticText that exactly matches value.
+        # @param value [String] the value to match exactly
+        # @return [UIAStaticText|XCUIElementTypeStaticText]
+        def text_exact(value)
+          raise_error_if_no_element texts_exact(value).first
+        end
+
+        # Find all UIAStaticTexts|XCUIElementTypeStaticTexts that exactly match value.
+        # @param value [String] the value to match exactly
+        # @return [Array<UIAStaticText|XCUIElementTypeStaticText>]
+        def texts_exact(value)
+          elements = find_eles_by_predicate(class_name: static_text_class, value: value)
+          select_visible_elements elements
+        end
+      end # module Text
+    end # module XCUITest
+  end # module Ios
+end # module Appium

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

@@ -0,0 +1,94 @@
+module Appium
+  module Ios
+    module Xcuitest
+      module Element
+        # XCUIElementTypeTextField = 'XCUIElementTypeTextField'.freeze
+        # XCUIElementTypeSecureTextField = 'XCUIElementTypeSecureTextField'.freeze
+
+        # @return [String] Class name for text field
+        def text_field_class
+          ::Appium::Ios::XCUIElementTypeTextField
+        end
+
+        # @return [String] Class name for secure text field
+        def secure_text_field_class
+          ::Appium::Ios::XCUIElementTypeSecureTextField
+        end
+
+        # Find the first TextField that contains value or by index.
+        # Note: Uses XPath
+        # @param value [String, Integer] the text to match exactly.
+        # If int then the TextField at that index is returned.
+        # @return [TextField]
+        def textfield(value)
+          if value.is_a? Numeric
+            index = value
+            raise "#{index} is not a valid index. Must be >= 1" if index <= 0
+            index -= 1 # eles_by_json and _textfields_with_predicate is 0 indexed.
+            result = _textfields_with_predicate[index]
+            raise _no_such_element if result.nil?
+            return result
+
+          end
+
+          raise_error_if_no_element textfields(value).first
+        end
+
+        # Find all TextFields containing value.
+        # If value is omitted, all TextFields are returned.
+        # @param value [String] the value to search for
+        # @return [Array<TextField>]
+        def textfields(value = false)
+          return tags_include(class_names: [text_field_class, secure_text_field_class]) unless value
+
+          elements = tags_include class_names: [text_field_class, secure_text_field_class], value: value
+          select_visible_elements elements
+        end
+
+        # Find the first TextField.
+        # @return [TextField]
+        def first_textfield
+          _textfield_with_predicate
+        end
+
+        # Find the last TextField.
+        # @return [TextField]
+        def last_textfield
+          result = _textfields_with_predicate.last
+          raise _no_such_element if result.nil?
+          result
+        end
+
+        # Find the first TextField that exactly matches value.
+        # @param value [String] the value to match exactly
+        # @return [TextField]
+        def textfield_exact(value)
+          raise_error_if_no_element textfields_exact(value).first
+        end
+
+        # Find all TextFields that exactly match value.
+        # @param value [String] the value to match exactly
+        # @return [Array<TextField>]
+        def textfields_exact(value)
+          elements = tags_exact class_names: [text_field_class, secure_text_field_class], value: value
+          select_visible_elements elements
+        end
+
+        private
+
+        # @private
+        # for XCUITest
+        def _textfield_with_predicate
+          raise_error_if_no_element _textfields_with_predicate.first
+        end
+
+        # @private
+        # for XCUITest
+        def _textfields_with_predicate
+          elements = tags_include(class_names: [text_field_class, secure_text_field_class])
+          select_visible_elements elements
+        end
+      end # module TextField
+    end # module XCUITest
+  end # module Ios
+end # module Appium

data/lib/appium_lib/ios/{xcuitest_gestures.rb → xcuitest/gestures.rb}

@@ -9,12 +9,10 @@ module Appium
         #   swipe direction: "down"
         #   ```
         def swipe(direction:, element: nil)
-          return unless %w(up down left right).include?(direction)
-
           args = { direction: direction }
           args[:element] = element.ref if element
 
-          execute_script 'mobile: swipe', args
+          @driver.execute_script 'mobile: swipe', args
         end
 
         # @param [string] direction Either 'up', 'down', 'left' or 'right'.
@@ -37,7 +35,7 @@ module Appium
           args[:toVisible] = to_visible if to_visible
           args[:predicateString] = predicate_string if predicate_string
 
-          execute_script 'mobile: scroll', args
+          @driver.execute_script 'mobile: scroll', args
         end
 
         # @param scale [scale] X tap coordinate of type float. Mandatory parameter
@@ -48,12 +46,10 @@ module Appium
         #   pinch scale: 0.5, velocity: -1
         #   ```
         def pinch(scale:, velocity: 1.0, element: nil)
-          return unless automation_name_is_xcuitest?
-
           args = { scale: scale, velocity: velocity }
           args[:element] = element.ref if element
 
-          execute_script 'mobile: pinch', args
+          @driver.execute_script 'mobile: pinch', args
         end
 
         # @param x [float] X Screen x tap coordinate of type float. Mandatory parameter only if element is not set
@@ -65,11 +61,10 @@ module Appium
         #   double_tap element: find_element(:accessibility_id, "some item")
         #   ```
         def double_tap(x: nil, y: nil, element: nil)
-          return 'require XCUITest(WDA)' unless automation_name_is_xcuitest?
           return 'Set x, y or element' if (x.nil? || y.nil?) && element.nil?
 
           args = element.nil? ? { x: x, y: y } : { element: element.ref }
-          execute_script 'mobile: doubleTap', args
+          @driver.execute_script 'mobile: doubleTap', args
         end
 
         # @param x [float] Screen x long tap coordinate of type float. Mandatory parameter only if element is not set
@@ -83,12 +78,11 @@ module Appium
         #   touch_and_hold element: find_element(:accessibility_id, "some item")
         #   ```
         def touch_and_hold(x: nil, y: nil, element: nil, duration: 1.0)
-          return 'require XCUITest(WDA)' unless automation_name_is_xcuitest?
           return 'Set x, y or element' if (x.nil? || y.nil?) && element.nil?
 
           args = element.nil? ? { x: x, y: y } : { element: element.ref }
           args[:duration] = duration
-          execute_script 'mobile: touchAndHold', args
+          @driver.execute_script 'mobile: touchAndHold', args
         end
 
         # @param [Element] :element Element to long tap on.
@@ -97,10 +91,8 @@ module Appium
         #   two_finger_tap element: find_element(:accessibility_id, "some item")
         #   ```
         def two_finger_tap(element:)
-          return 'require XCUITest(WDA)' unless automation_name_is_xcuitest?
-
           args = { element: element.ref }
-          execute_script 'mobile: twoFingerTap', args
+          @driver.execute_script 'mobile: twoFingerTap', args
         end
 
         # @param x [float] X tap coordinate of type float. Mandatory parameter
@@ -114,11 +106,9 @@ module Appium
         #   tap x: 100, y: 100, element: find_element(:accessibility_id, "some item")
         #   ```
         def tap(x:, y:, element: nil)
-          return 'require XCUITest(WDA)' unless automation_name_is_xcuitest?
-
           args = { x: x, y: y }
           args[:element] = element.ref if element
-          execute_script 'mobile: tap', args
+          @driver.execute_script 'mobile: tap', args
         end
 
         # rubocop:disable Metrics/ParameterLists
@@ -136,11 +126,9 @@ module Appium
         #   drag_from_to_for_duration from_x: 100, from_y: 100, to_x: 150, to_y: 150
         #   ```
         def drag_from_to_for_duration(from_x:, from_y:, to_x:, to_y:, duration: 1.0, element: nil)
-          return 'require XCUITest(WDA)' unless automation_name_is_xcuitest?
-
           args = { fromX: from_x, fromY: from_y, toX: to_x, toY: to_y, duration: duration }
           args[:element] = element.ref if element
-          execute_script 'mobile: dragFromToForDuration', args
+          @driver.execute_script 'mobile: dragFromToForDuration', args
         end
         # rubocop:enable Metrics/ParameterLists
 
@@ -155,12 +143,11 @@ module Appium
         #   select_picker_wheel order: "next", element: find_element(:accessibility_id, "some picker")
         #   ```
         def select_picker_wheel(element:, order:, offset: nil)
-          return 'require XCUITest(WDA)' unless automation_name_is_xcuitest?
           return 'Set "next" or "previous" for :order' unless %w(next previous).include?(order)
 
           args = { element: element.ref, order: order }
           args[:offset] = offset if offset
-          execute_script 'mobile: selectPickerWheelValue', args
+          @driver.execute_script 'mobile: selectPickerWheelValue', args
         end
 
         # @param action [String] The following actions are supported: accept, dismiss and getButtons. Mandatory parameter
@@ -178,7 +165,7 @@ module Appium
 
           args = { action: action }
           args[:button_label] if button_label
-          execute_script 'mobile: alert', args
+          @driver.execute_script 'mobile: alert', args
         end
       end # module Gesture
     end # module Xcuitest