appium_lib_core 9.0.0 → 9.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ccf2b5c0df2ae8489c0c9b3382d260f2464c20828b02484888c7f1c738a42084
-  data.tar.gz: 6aa81ba96bd097f6075a947656533fd20476de3199855827d4278e71449b842e
+  metadata.gz: 66d04f7356959668f0eb58b68869126add5dc0e4abfdc79c2aedcb24e8e8dd6f
+  data.tar.gz: f49ba5759a02d29a88a2c470f65e5c30277660838fe4aadcc024db77092b6f0d
 SHA512:
-  metadata.gz: 7b7c967d705ffd0034af99c930ed6840e272a064cda6dd461710ac8990413b1ee7de7bbb577e9a3231113ec77c5007b737beb82811600c5d2061d21add41b129
-  data.tar.gz: 24405ae6731acb21cc504d0867410523a63943244d718700b0c24504bdf9cecae0ae54b7e5a647660cd8aec7e5bd9bd6391e160e1796246250e6dfecd78ca2ec
+  metadata.gz: dbee76c3700eda2c8a4214644f9de866a8957e4d25d0aa20e10fffe245e1c3d7208863004c4c16d7e32b0bbf79d22a65cfca6999e5783361178e104000b7847a
+  data.tar.gz: 3c0fce31f001303602d99a1feec396e51061a2b57f1ce8155dad771d4167dadaf2ef263a579833eba4f7466fbe2ce8055776b0dbd4de3c7c8fb293465570dc43

data/CHANGELOG.md

@@ -10,6 +10,18 @@ Read `release_notes.md` for commit level details.
 
 ### Deprecations
 
+## [9.1.1] - 2024-05-19
+
+### Enhancements
+- Simplify internal code with Selenium 4.21.0 further.
+
+
+## [9.1.0] - 2024-05-18
+
+### Enhancements
+- Require Selenium 4.21.0+
+- Simplify internal code with Selenium 4.21.0. Now it requires selenium webdriver v4.21.0.
+
 ## [9.0.0] - 2024-05-14
 
 ### Deprecations

data/appium_lib_core.gemspec

@@ -1,5 +1,4 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'appium_lib_core/version'
 
@@ -11,8 +10,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Kazuaki MATSUO']
   spec.email         = ['fly.49.89.over@gmail.com']
 
-  spec.summary       = %q{Minimal Ruby library for Appium.}
-  spec.description   = %q{Minimal Ruby library for Appium.}
+  spec.summary       = 'Minimal Ruby library for Appium.'
+  spec.description   = 'Minimal Ruby library for Appium.'
   spec.homepage      = 'https://github.com/appium/ruby_lib_core/'
   spec.license       = 'Apache-2.0'
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
@@ -22,16 +21,17 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'selenium-webdriver', '~> 4.2'
   spec.add_runtime_dependency 'faye-websocket', '~> 0.11.0'
+  spec.add_runtime_dependency 'selenium-webdriver', '~> 4.21'
 
-  spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'yard', '~> 0.9.11'
+  spec.add_development_dependency 'appium_thor', '~> 2.0'
   spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'minitest-reporters', '~> 1.1'
-  spec.add_development_dependency 'webmock', '~> 3.23.0'
-  spec.add_development_dependency 'rubocop', '1.63.5'
-  spec.add_development_dependency 'appium_thor', '~> 2.0'
   spec.add_development_dependency 'parallel_tests'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rubocop', '1.63.5'
   spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'webmock', '~> 3.23.0'
+  spec.add_development_dependency 'yard', '~> 0.9.11'
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end

data/lib/appium_lib_core/common/base/bridge.rb

@@ -15,6 +15,12 @@
 module Appium
   module Core
     class Base
+      class LocatorConverter
+        def convert(how, what)
+          [how, what]
+        end
+      end # LocatorConverter
+
       class Bridge < ::Selenium::WebDriver::Remote::Bridge
         include Device::DeviceLock
         include Device::Keyboard
@@ -31,6 +37,8 @@ module Appium
         include Device::ExecuteDriver
         include Device::Orientation
 
+        Bridge.locator_converter = LocatorConverter.new
+
         # Prefix for extra capability defined by W3C
         APPIUM_PREFIX = 'appium:'
 
@@ -153,6 +161,18 @@ module Appium
         public
 
         # command for Appium 2.0.
+
+        # Example:
+        #   driver.add_command(name: :available_contexts, method: :get, url: 'session/:session_id/contexts') do
+        #     execute(:available_contexts, {}) || []
+        #   end
+        # Then,
+        #   driver.available_contexts #=> ["NATIVE_APP"]
+
+        # def add_command(method:, url:, name:, &block)
+        #   Bridge.add_command name, method, url, &block
+        # end
+
         def add_command(method:, url:, name:, &block)
           ::Appium::Logger.info "Overriding the method '#{name}' for '#{url}'" if @available_commands.key? name
 
@@ -162,7 +182,7 @@ module Appium
         end
 
         def commands(command)
-          @available_commands[command]
+          @available_commands[command] || Bridge.extra_commands[command]
         end
 
         def status
@@ -216,52 +236,8 @@ module Appium
         end
 
         # For Appium
-        # override
-        def active_element
-          ::Appium::Core::Element.new self, element_id_from(execute(:get_active_element))
-        end
         alias switch_to_active_element active_element
 
-        # For Appium
-        # override
-        def find_element_by(how, what, parent_ref = [])
-          how, what = convert_locator(how, what)
-
-          return execute_atom(:findElements, Support::RelativeLocator.new(what).as_json).first if how == 'relative'
-
-          parent_type, parent_id = parent_ref
-          id = case parent_type
-               when :element
-                 execute :find_child_element, { id: parent_id }, { using: how, value: what.to_s }
-               when :shadow_root
-                 execute :find_shadow_child_element, { id: parent_id }, { using: how, value: what.to_s }
-               else
-                 execute :find_element, {}, { using: how, value: what.to_s }
-               end
-
-          ::Appium::Core::Element.new self, element_id_from(id)
-        end
-
-        # For Appium
-        # override
-        def find_elements_by(how, what, parent_ref = [])
-          how, what = convert_locator(how, what)
-
-          return execute_atom :findElements, Support::RelativeLocator.new(what).as_json if how == 'relative'
-
-          parent_type, parent_id = parent_ref
-          ids = case parent_type
-                when :element
-                  execute :find_child_elements, { id: parent_id }, { using: how, value: what.to_s }
-                when :shadow_root
-                  execute :find_shadow_child_elements, { id: parent_id }, { using: how, value: what.to_s }
-                else
-                  execute :find_elements, {}, { using: how, value: what.to_s }
-                end
-
-          ids.map { |id| ::Appium::Core::Element.new self, element_id_from(id) }
-        end
-
         # For Appium
         # @param [Hash] id The id which can get as a response from server
         # @return [::Appium::Core::Element]
@@ -351,55 +327,6 @@ module Appium
         def send_command(command_params)
           execute :chrome_send_command, {}, command_params
         end
-
-        private
-
-        def unwrap_script_result(arg)
-          case arg
-          when Array
-            arg.map { |e| unwrap_script_result(e) }
-          when Hash
-            element_id = element_id_from(arg)
-            return ::Appium::Core::Element.new(self, element_id) if element_id
-
-            shadow_root_id = shadow_root_id_from(arg)
-            return ::Selenium::WebDriver::Remote::ShadowRoot.new self, shadow_root_id if shadow_root_id
-
-            arg.each { |k, v| arg[k] = unwrap_script_result(v) }
-          else
-            arg
-          end
-        end
-
-        def element_id_from(id)
-          id['ELEMENT'] || id['element-6066-11e4-a52e-4f735466cecf']
-        end
-
-        # Don't convert locators for Appium in native context
-        def convert_locator(how, what)
-          # case how
-          # when 'class name'
-          #   how = 'css selector'
-          #   what = ".#{escape_css(what)}"
-          # when 'id'
-          #   how = 'css selector'
-          #   what = "##{escape_css(what)}"
-          # when 'name'
-          #   how = 'css selector'
-          #   what = "*[name='#{escape_css(what)}']"
-          # when 'tag name'
-          #   how = 'css selector'
-          # end
-          #
-          # if what.is_a?(Hash)
-          #   what = what.each_with_object({}) do |(h, w), hash|
-          #     h, w = convert_locator(h.to_s, w)
-          #     hash[h] = w
-          #   end
-          # end
-
-          [how, what]
-        end
       end # class Bridge
     end # class Base
   end # module Core

data/lib/appium_lib_core/common/base/driver.rb

@@ -32,7 +32,6 @@ module Appium
         include ::Selenium::WebDriver::DriverExtensions::HasWebStorage
 
         include ::Appium::Core::Base::Rotatable
-        include ::Appium::Core::Base::SearchContext
         include ::Appium::Core::Base::TakesScreenshot
         include ::Appium::Core::Base::HasRemoteStatus
         include ::Appium::Core::Base::HasLocation
@@ -40,6 +39,8 @@ module Appium
 
         include ::Appium::Core::Waitable
 
+        ::Selenium::WebDriver::SearchContext.extra_finders = APPIUM_EXTRA_FINDERS
+
         # Private API.
         # Do not use this for general use. Used by flutter driver to get bridge for creating a new element
         attr_reader :bridge
@@ -57,6 +58,7 @@ module Appium
           @bidi = nil
 
           # in the selenium webdriver as well
+          ::Selenium::WebDriver::Remote::Bridge.element_class = ::Appium::Core::Element
           bridge ||= create_bridge(**opts)
           add_extensions(bridge.browser)
           @bridge = listener ? ::Appium::Support::EventFiringBridge.new(bridge, listener, **original_opts) : bridge
@@ -1023,8 +1025,8 @@ module Appium
         #     ele = @driver.convert_to_element(response) #=> ::Appium::Core::Element
         #     ele.rect #=> Can get the rect of the element
         #
-        def convert_to_element(id)
-          @bridge.convert_to_element id
+        def convert_to_element(response_id)
+          @bridge.convert_to_element response_id
         end
       end # class Driver
     end # class Base

data/lib/appium_lib_core/common/base/http_default.rb

@@ -31,6 +31,9 @@ module Appium
         class Default < ::Selenium::WebDriver::Remote::Http::Default
           attr_reader :additional_headers
 
+          ::Selenium::WebDriver::Remote::Http::Common.user_agent = \
+            "appium/ruby_lib_core/#{VERSION} (#{::Selenium::WebDriver::Remote::Http::Common.user_agent})"
+
           # override
           def initialize(open_timeout: nil, read_timeout: nil)
             @open_timeout = open_timeout
@@ -39,6 +42,17 @@ module Appium
             super
           end
 
+          def set_additional_header(key, value)
+            @additional_headers[key] = value
+            ::Selenium::WebDriver::Remote::Http::Common.extra_headers = @additional_headers
+          end
+
+          def delete_additional_header(key)
+            @additional_headers.delete key
+            ::Selenium::WebDriver::Remote::Http::Common.extra_headers = @additional_headers
+            @common_headers.delete key if defined? @common_headers
+          end
+
           # Update <code>server_url</code> provided when ruby_lib _core created a default http client.
           # Set <code>@http</code> as nil to re-create http client for the <code>server_url</code>
           #
@@ -59,13 +73,6 @@ module Appium
             @server_url = URI.parse "#{scheme}://#{host}:#{port}#{path}"
           end
 
-          def request(verb, url, headers, payload, redirects = 0)
-            headers['User-Agent'] = "appium/ruby_lib_core/#{VERSION} (#{headers['User-Agent']})"
-            headers = headers.merge @additional_headers unless @additional_headers.empty?
-
-            super(verb, url, headers, payload, redirects)
-          end
-
           private
 
           def validate_url_param(scheme, host, port, path)

data/lib/appium_lib_core/common/base/search_context.rb

@@ -12,172 +12,102 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-module Appium
-  module Core
-    class Base
-      module SearchContext
-        # referenced: ::Selenium::WebDriver::SearchContext
-
-        FINDERS = ::Selenium::WebDriver::SearchContext::FINDERS.merge(
-          accessibility_id:     'accessibility id',
-          image:                '-image',
-          custom:               '-custom',
-          # Android
-          uiautomator:          '-android uiautomator', # Unavailable in Espresso
-          viewtag:              '-android viewtag',     # Available in Espresso
-          data_matcher:         '-android datamatcher', # Available in Espresso
-          view_matcher:         '-android viewmatcher', # Available in Espresso
-          # iOS
-          predicate:            '-ios predicate string',
-          class_chain:          '-ios class chain'
-        )
-
-        # rubocop:disable Layout/LineLength
-        #
-        # Find the first element matching the given arguments
-        #
-        # - Android can find with uiautomator like a {http://developer.android.com/tools/help/uiautomator/UiSelector.html UISelector}.
-        # - iOS can find with a {https://developer.apple.com/library/ios/documentation/ToolsLanguages/Reference/UIAWindowClassReference/UIAWindow/UIAWindow.html#//apple_ref/doc/uid/TP40009930 UIAutomation command}.
-        # - iOS, only for XCUITest(WebDriverAgent), can find with a {https://github.com/facebook/WebDriverAgent/wiki/Queries class chain}
-        #
-        # == Find with image
-        # Return an element if current view has a partial image. The logic depends on template matching by OpenCV.
-        # {https://github.com/appium/appium/blob/1.x/docs/en/writing-running-appium/image-comparison.md image-comparison}
-        #
-        # You can handle settings for the comparision following {https://github.com/appium/appium-base-driver/blob/master/lib/basedriver/device-settings.js#L6 here}
-        #
-        # == Espresso viewmatcher and datamatcher
-        # Espresso has {https://developer.android.com/training/testing/espresso/basics _onView_ matcher}
-        # and {https://medium.com/androiddevelopers/adapterviews-and-espresso-f4172aa853cf _onData_ matcher} for more reference
-        # that allows you to target adapters instead of Views. This method find methods based on reflections
-        #
-        # This is a selector strategy that allows users to pass a selector of the form:
-        #
-        # <code>{ name: '<name>', args: ['arg1', 'arg2', '...'], class: '<optional class>' }</code>
-        #
-        # - _name_: The name of a method to invoke. The method must return
-        # a Hamcrest {http://hamcrest.org/JavaHamcrest/javadoc/1.3/org/hamcrest/Matcher.html Matcher}
-        # - _args_: The args provided to the method
-        # - _class_: The class name that the method is part of (defaults to <code>org.hamcrest.Matchers</code>).
-        # Can be fully qualified, or simple, and simple defaults to <code>androidx.test.espresso.matcher</code> package
-        # (e.g.: <code>class=CursorMatchers</code> fully qualified is <code>class=androidx.test.espresso.matcher.CursorMatchers</code>
-        #
-        # See example how to send viewmatcher and datamatcher in Ruby client
-        #
-        #
-        # @overload find_element(how, what)
-        #   @param [Symbol, String] how The method to find the element by
-        #   @param [String] what The locator to use
-        #
-        # @overload find_element(opts)
-        #   @param [Hash] opts Find options
-        #   @option opts [Symbol] :how Key named after the method to find the element by, containing the locator
-        # @return [Element]
-        # @raise [Error::NoSuchElementError] if the element doesn't exist
-        #
-        # @example Find element with each keys
-        #
-        #     # with accessibility id. All platforms.
-        #     @driver.find_elements :accessibility_id, 'Animation'
-        #     @driver.find_elements :accessibility_id, 'Animation'
-        #
-        #     # with base64 encoded template image. All platforms.
-        #     @driver.find_elements :image, Base64.strict_encode64(File.read(file_path))
-        #
-        #     # For Android
-        #     ## With uiautomator
-        #     @driver.find_elements :uiautomator, 'new UiSelector().clickable(true)'
-        #     ## With viewtag, but only for Espresso
-        #     ## 'setTag'/'getTag' in https://developer.android.com/reference/android/view/View
-        #     @driver.find_elements :viewtag, 'new UiSelector().clickable(true)'
-        #     # With data_matcher. The argument should be JSON format.
-        #     @driver.find_elements :data_matcher, { name: 'hasEntry', args: %w(title Animation) }.to_json
-        #
-        #     # For iOS
-        #     ## With :predicate
-        #     @driver.find_elements :predicate, "isWDVisible == 1"
-        #     @driver.find_elements :predicate, 'wdName == "Buttons"'
-        #     @driver.find_elements :predicate, 'wdValue == "SearchBar" AND isWDDivisible == 1'
-        #
-        #     ## With Class Chain
-        #     ### select the third child button of the first child window element
-        #     @driver.find_elements :class_chain, 'XCUIElementTypeWindow/XCUIElementTypeButton[3]'
-        #     ### select all the children windows
-        #     @driver.find_elements :class_chain, 'XCUIElementTypeWindow'
-        #     ### select the second last child of the second child window
-        #     @driver.find_elements :class_chain, 'XCUIElementTypeWindow[2]/XCUIElementTypeAny[-2]'
-        #     ### matching predicate. <code>'</code> is the mark.
-        #     @driver.find_elements :class_chain, 'XCUIElementTypeWindow['visible = 1]['name = "bla"']'
-        #     ### containing predicate. '$' is the mark.
-        #     ### Require appium-xcuitest-driver 2.54.0+. PR: https://github.com/facebook/WebDriverAgent/pull/707/files
-        #     @driver.find_elements :class_chain, 'XCUIElementTypeWindow[$name = \"bla$$$bla\"$]'
-        #     e = find_element :class_chain, "**/XCUIElementTypeWindow[$name == 'Buttons'$]"
-        #     e.tag_name #=> "XCUIElementTypeWindow"
-        #     e = find_element :class_chain, "**/XCUIElementTypeStaticText[$name == 'Buttons'$]"
-        #     e.tag_name #=> "XCUIElementTypeStaticText"
-        #
-        # rubocop:enable Layout/LineLength
-        def find_element(*args)
-          how, what = extract_args(args)
-          by = _set_by_from_finders(how)
-          begin
-            bridge.find_element_by by, what.to_s, ref
-          rescue Selenium::WebDriver::Error::TimeoutError
-            raise Selenium::WebDriver::Error::NoSuchElementError
-          end
-        end
-
-        #
-        # Find all elements matching the given arguments
-        #
-        # @return [Array<Selenium::WebDriver::Element>]
-        #
-        # @see SearchContext#find_elements
-        #
-        def find_elements(*args)
-          how, what = extract_args(args)
-          by = _set_by_from_finders(how)
-          begin
-            bridge.find_elements_by by, what.to_s, ref
-          rescue Selenium::WebDriver::Error::TimeoutError
-            []
-          end
-        end
-
-        private
-
-        def _set_by_from_finders(how)
-          by = FINDERS[how.to_sym]
-          unless by
-            raise ::Appium::Core::Error::ArgumentError,
-                  "cannot find element by #{how.inspect}. Available finders are #{FINDERS.keys}."
-          end
-
-          by
-        end
-
-        def extract_args(args)
-          case args.size
-          when 2
-            args
-          when 1
-            arg = args.first
-
-            unless arg.respond_to?(:shift)
-              raise ::Appium::Core::Error::ArgumentError, "expected #{arg.inspect}:#{arg.class} to respond to #shift"
-            end
-
-            # this will be a single-entry hash, so use #shift over #first or #[]
-            arr = arg.dup.shift
-
-            raise ::Appium::Core::Error::ArgumentError, "expected #{arr.inspect} to have 2 elements" unless arr.size == 2
+# rubocop:disable Layout/LineLength
+#
+# Find the first element matching the given arguments
+#
+# - Android can find with uiautomator like a {http://developer.android.com/tools/help/uiautomator/UiSelector.html UISelector}.
+# - iOS can find with a {https://developer.apple.com/library/ios/documentation/ToolsLanguages/Reference/UIAWindowClassReference/UIAWindow/UIAWindow.html#//apple_ref/doc/uid/TP40009930 UIAutomation command}.
+# - iOS, only for XCUITest(WebDriverAgent), can find with a {https://github.com/facebook/WebDriverAgent/wiki/Queries class chain}
+#
+# == Find with image
+# Return an element if current view has a partial image. The logic depends on template matching by OpenCV.
+# {https://github.com/appium/appium/blob/1.x/docs/en/writing-running-appium/image-comparison.md image-comparison}
+#
+# You can handle settings for the comparision following {https://github.com/appium/appium-base-driver/blob/master/lib/basedriver/device-settings.js#L6 here}
+#
+# == Espresso viewmatcher and datamatcher
+# Espresso has {https://developer.android.com/training/testing/espresso/basics _onView_ matcher}
+# and {https://medium.com/androiddevelopers/adapterviews-and-espresso-f4172aa853cf _onData_ matcher} for more reference
+# that allows you to target adapters instead of Views. This method find methods based on reflections
+#
+# This is a selector strategy that allows users to pass a selector of the form:
+#
+# <code>{ name: '<name>', args: ['arg1', 'arg2', '...'], class: '<optional class>' }</code>
+#
+# - _name_: The name of a method to invoke. The method must return
+# a Hamcrest {http://hamcrest.org/JavaHamcrest/javadoc/1.3/org/hamcrest/Matcher.html Matcher}
+# - _args_: The args provided to the method
+# - _class_: The class name that the method is part of (defaults to <code>org.hamcrest.Matchers</code>).
+# Can be fully qualified, or simple, and simple defaults to <code>androidx.test.espresso.matcher</code> package
+# (e.g.: <code>class=CursorMatchers</code> fully qualified is <code>class=androidx.test.espresso.matcher.CursorMatchers</code>
+#
+# See example how to send viewmatcher and datamatcher in Ruby client
+#
+#
+# @overload find_element(how, what)
+#   @param [Symbol, String] how The method to find the element by
+#   @param [String] what The locator to use
+#
+# @overload find_element(opts)
+#   @param [Hash] opts Find options
+#   @option opts [Symbol] :how Key named after the method to find the element by, containing the locator
+# @return [Element]
+# @raise [Error::NoSuchElementError] if the element doesn't exist
+#
+# @example Find element with each keys
+#
+#     # with accessibility id. All platforms.
+#     @driver.find_elements :accessibility_id, 'Animation'
+#     @driver.find_elements :accessibility_id, 'Animation'
+#
+#     # with base64 encoded template image. All platforms.
+#     @driver.find_elements :image, Base64.strict_encode64(File.read(file_path))
+#
+#     # For Android
+#     ## With uiautomator
+#     @driver.find_elements :uiautomator, 'new UiSelector().clickable(true)'
+#     ## With viewtag, but only for Espresso
+#     ## 'setTag'/'getTag' in https://developer.android.com/reference/android/view/View
+#     @driver.find_elements :viewtag, 'new UiSelector().clickable(true)'
+#     # With data_matcher. The argument should be JSON format.
+#     @driver.find_elements :data_matcher, { name: 'hasEntry', args: %w(title Animation) }.to_json
+#
+#     # For iOS
+#     ## With :predicate
+#     @driver.find_elements :predicate, "isWDVisible == 1"
+#     @driver.find_elements :predicate, 'wdName == "Buttons"'
+#     @driver.find_elements :predicate, 'wdValue == "SearchBar" AND isWDDivisible == 1'
+#
+#     ## With Class Chain
+#     ### select the third child button of the first child window element
+#     @driver.find_elements :class_chain, 'XCUIElementTypeWindow/XCUIElementTypeButton[3]'
+#     ### select all the children windows
+#     @driver.find_elements :class_chain, 'XCUIElementTypeWindow'
+#     ### select the second last child of the second child window
+#     @driver.find_elements :class_chain, 'XCUIElementTypeWindow[2]/XCUIElementTypeAny[-2]'
+#     ### matching predicate. <code>'</code> is the mark.
+#     @driver.find_elements :class_chain, 'XCUIElementTypeWindow['visible = 1]['name = "bla"']'
+#     ### containing predicate. '$' is the mark.
+#     ### Require appium-xcuitest-driver 2.54.0+. PR: https://github.com/facebook/WebDriverAgent/pull/707/files
+#     @driver.find_elements :class_chain, 'XCUIElementTypeWindow[$name = \"bla$$$bla\"$]'
+#     e = find_element :class_chain, "**/XCUIElementTypeWindow[$name == 'Buttons'$]"
+#     e.tag_name #=> "XCUIElementTypeWindow"
+#     e = find_element :class_chain, "**/XCUIElementTypeStaticText[$name == 'Buttons'$]"
+#     e.tag_name #=> "XCUIElementTypeStaticText"
+#
+# rubocop:enable Layout/LineLength
 
-            arr
-          else
-            raise ::Appium::Core::Error::ArgumentError, "wrong number of arguments (#{args.size} for 2)"
-          end
-        end
-      end # module SearchContext
-    end # class Base
-  end # module Core
-end # module Appium
+APPIUM_EXTRA_FINDERS = {
+  accessibility_id:     'accessibility id',
+  image:                '-image',
+  custom:               '-custom',
+  # Android
+  uiautomator:          '-android uiautomator', # Unavailable in Espresso
+  viewtag:              '-android viewtag',     # Available in Espresso
+  data_matcher:         '-android datamatcher', # Available in Espresso
+  view_matcher:         '-android viewmatcher', # Available in Espresso
+  # iOS
+  predicate:            '-ios predicate string',
+  class_chain:          '-ios class chain'
+}.freeze

data/lib/appium_lib_core/driver.rb

@@ -402,7 +402,7 @@ module Appium
 
         if @enable_idempotency_header
           if @http_client.instance_variable_defined? :@additional_headers
-            @http_client.additional_headers[Appium::Core::Base::Http::RequestHeaders::KEYS[:idempotency]] = SecureRandom.uuid
+            @http_client.set_additional_header Appium::Core::Base::Http::RequestHeaders::KEYS[:idempotency], SecureRandom.uuid
           else
             ::Appium::Logger.warn 'No additional_headers attribute in this http client instance'
           end
@@ -426,7 +426,7 @@ module Appium
 
         if @http_client.instance_variable_defined? :@additional_headers
           # We only need the key for a new session request. Should remove it for other following commands.
-          @http_client.additional_headers.delete Appium::Core::Base::Http::RequestHeaders::KEYS[:idempotency]
+          @http_client.delete_additional_header Appium::Core::Base::Http::RequestHeaders::KEYS[:idempotency]
         end
 
         # TODO: this method can be removed after releasing Appium 2.0, and after a while

data/lib/appium_lib_core/element.rb

@@ -17,9 +17,10 @@ module Appium
     # Implement useful features for element.
     # Patch for Selenium Webdriver.
     class Element < ::Selenium::WebDriver::Element
-      include ::Appium::Core::Base::SearchContext
       include ::Appium::Core::Base::TakesScreenshot
 
+      ::Selenium::WebDriver::SearchContext.extra_finders = APPIUM_EXTRA_FINDERS
+
       # Retuns the element id.
       #
       # @return [String]

data/lib/appium_lib_core/version.rb

@@ -14,7 +14,7 @@
 
 module Appium
   module Core
-    VERSION = '9.0.0' unless defined? ::Appium::Core::VERSION
-    DATE    = '2024-05-14' unless defined? ::Appium::Core::DATE
+    VERSION = '9.1.1' unless defined? ::Appium::Core::VERSION
+    DATE    = '2024-05-19' unless defined? ::Appium::Core::DATE
   end
 end

metadata

@@ -1,113 +1,113 @@
 --- !ruby/object:Gem::Specification
 name: appium_lib_core
 version: !ruby/object:Gem::Version
-  version: 9.0.0
+  version: 9.1.1
 platform: ruby
 authors:
 - Kazuaki MATSUO
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-14 00:00:00.000000000 Z
+date: 2024-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: selenium-webdriver
+  name: faye-websocket
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: 0.11.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: 0.11.0
 - !ruby/object:Gem::Dependency
-  name: faye-websocket
+  name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.0
+        version: '4.21'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.0
+        version: '4.21'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: appium_thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.11
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.11
+        version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: minitest-reporters
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: minitest-reporters
+  name: parallel_tests
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.23.0
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.23.0
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -123,47 +123,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.63.5
 - !ruby/object:Gem::Dependency
-  name: appium_thor
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: parallel_tests
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.23.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.23.0
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.11
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.11
 description: Minimal Ruby library for Appium.
 email:
 - fly.49.89.over@gmail.com
@@ -258,7 +258,8 @@ files:
 homepage: https://github.com/appium/ruby_lib_core/
 licenses:
 - Apache-2.0
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -274,7 +275,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: Minimal Ruby library for Appium.