appium_lib_core 12.0.0 → 12.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a805f2c5bbd5dc27e1cc04c293599e9bce82483993bbb2bbe3d52c591dad4b56
-  data.tar.gz: '09d935617bff88069b7da75072dc322c54cf57a38de1c89da619fa60b08af9ec'
+  metadata.gz: cb6226306206eafec9dbd6f2c2f1ac09c86fee48ee841be8616df8acf6ce56a5
+  data.tar.gz: ab63b82ecafb824a8b0edfdcbcba8d9ec0e1530e8a42f86c4c95aa95246a6871
 SHA512:
-  metadata.gz: 1d79ce647fb5484b35fd46f2433e1bc615ca72ba224136fe81710a55feae59363f1b478e5e4c5e8c1ebbf0ac11d6e1ab4352bbdfa866a7c1a5feb4a8ee7c4cee
-  data.tar.gz: f76855bd2fd8c8f5eae448abda265b649cde89fea4998e17ec8eebb9fd4b3fcc916f095fc32a12814df41a30c6cbaaf949504840156c98f131ae3b65e8b78d09
+  metadata.gz: 2573d787ffb963708aae21889b3f3ab6f68b7747b623a7ba906fff4065f7514557608dfaa6b9b05b8ceddaf4a6f0ae96edb20a436af01e3148c5c13ed64bf598
+  data.tar.gz: 21c2e01a1bdfb8bfd81ad309eb8e6fbdfa6d5abba485c77b52c257652be9c8b58a4f62a110a78128f2f26438e0d018cebfe6f1cffd8f60e1aa91293c2d14e269

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 All notable changes to this project will be documented in this file.
 Read `release_notes.md` for commit level details.
 
+## [12.1.0] - 2026-03-21
+- Replace internal `add_command` method with Selnium Bridge's `add_command` to simplify the codebase.
+
+## [12.0.1] - 2026-03-07
+- Improve Steep
+
 ## [12.0.0] - 2025-12-28
 - Remove `Appium::Core::WebSocket` which was for `appium/device/logcat` endpoint. Please use BiDi log endpoint such as [this test](https://github.com/appium/ruby_lib_core/blob/master/test/functional/android/webdriver/bidi_test.rb) instead.
 - update RBS files

data/Gemfile

@@ -8,7 +8,7 @@ gem 'minitest', '~> 5.0'
 gem 'minitest-reporters', '~> 1.1'
 gem 'parallel_tests'
 gem 'rake', '~> 13.0'
-gem 'rubocop', '1.82.0'
+gem 'rubocop', '1.85.1'
 gem 'simplecov'
 gem 'steep', '~> 1.10.0'
 gem 'webmock', '~> 3.26.0'

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

@@ -47,8 +47,6 @@ module Appium
         # No 'browserName' means the session is native appium connection
         APPIUM_NATIVE_BROWSER_NAME = 'appium'
 
-        attr_reader :available_commands
-
         def browser
           @browser ||= begin
             name = @capabilities&.browser_name
@@ -74,7 +72,6 @@ module Appium
         #   )
         #
         def attach_to(session_id, platform_name, automation_name)
-          @available_commands = ::Appium::Core::Commands::COMMANDS.dup
           @session_id = session_id
 
           # generate a dummy capabilities instance which only has the given platformName and automationName
@@ -109,10 +106,8 @@ module Appium
         #   driver = core.start_driver
         #
         def create_session(capabilities)
-          @available_commands = ::Appium::Core::Commands::COMMANDS.dup
-
           always_match = add_appium_prefix(capabilities)
-          response = execute(:new_session, {}, { capabilities: { alwaysMatch: always_match, firstMatch: [{}] } })
+          response = execute(:new_session, {}, { capabilities: { alwaysMatch: always_match, firstMatch: [{}] } }) # steep:ignore
 
           @session_id = response['sessionId']
           raise ::Selenium::WebDriver::Error::WebDriverError, 'no sessionId in returned payload' unless @session_id
@@ -162,29 +157,16 @@ 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
-
-          @available_commands[name] = [method, url]
-
-          ::Appium::Core::Device.add_endpoint_method name, &block
+        # Override Selenium's command_list to use Appium's command definitions
+        # instead of the default W3C COMMANDS from Selenium.
+        def command_list
+          ::Appium::Core::Commands::COMMANDS
         end
 
+        # Override Selenium's commands to resolve extra_commands from this subclass
+        # rather than the parent Selenium::WebDriver::Remote::Bridge.
         def commands(command)
-          @available_commands[command] || Bridge.extra_commands[command]
+          command_list[command] || self.class.extra_commands&.[](command)
         end
 
         def status
@@ -273,7 +255,7 @@ module Appium
         # No implementation for W3C webdriver module
         def available_log_types
           types = execute :get_available_log_types
-          Array(types).map(&:to_sym)
+          Array(types).map(&:to_sym) # steep:ignore
         end
 
         # For Appium
@@ -297,7 +279,7 @@ module Appium
 
         # For Appium
         def log_events(type = nil)
-          args = {}
+          args = {} # steep:ignore
           args['type'] = type unless type.nil?
 
           execute :get_log_events, {}, args

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

@@ -135,25 +135,21 @@ module Appium
         # drivers/plugins in Appium 2.0. Appium 2.0 and its custom drivers/plugins allow you
         # to define custom commands that are not part of W3C spec.
         #
+        # Uses Selenium's +Bridge.add_command+ under the hood to register the command
+        # and define the method on the bridge.
+        #
         # @param [Symbol] method HTTP request method as https://www.w3.org/TR/webdriver/#endpoints
         # @param [string] url The url to URL template as https://www.w3.org/TR/webdriver/#endpoints.
         #                     +:session_id+ is the placeholder of 'session id'.
         #                     Other place holders can be specified with +:+ prefix like +:id+.
         #                     Then, the +:id+ will be replaced with a given value as the seconds argument of +execute+
         # @param [Symbol] name The name of method that is called as the driver instance method.
-        # @param [Proc] block The block to involve as the method.
-        #                     Please define a method that has the same +name+ with arguments you want.
-        #                     The method must has +execute+ method. tHe +execute+ is calls the +url+
-        #                     with the given parameters.
-        #                     The first argument should be +name+ as symbol.
-        #                     The second argument should be hash. If keys in the hash matches +:+ prefix
-        #                     string in the given url, the matched string in the given url will be
-        #                     values in the hash.
-        #                     The third argument should be hash. The hash will be the request body.
-        #                     Please read examples below for more details.
+        # @param [Proc] block The block becomes the method body. It is executed in the context of
+        #                     the bridge instance, so +execute+ is available. When no block is given,
+        #                     a default implementation calling +execute(name)+ is used.
         # @raise [ArgumentError] If the given +method+ is invalid value.
         #
-        # @example
+        # @example Simple GET command (no block)
         #
         #   @driver.add_command(
         #     method: :get,
@@ -163,30 +159,37 @@ module Appium
         #   # Send a GET request to 'session/<session id>/path/to/custom/url'
         #   @driver.test_command
         #
+        # @example POST command with arguments (do/end block)
         #
         #   @driver.add_command(
         #     method: :post,
         #     url: 'session/:session_id/path/to/custom/url',
         #     name: :test_command
-        #   ) do
-        #     def test_command(argument)
-        #       execute(:test_command, {}, { dummy: argument })
-        #     end
+        #   ) do |argument|
+        #     execute(:test_command, {}, { dummy: argument })
         #   end
         #   # Send a POST request to 'session/<session id>/path/to/custom/url'
         #   # with body "{ dummy: 1 }" as JSON object. "1" is the argument.
         #   # ':session_id' in the given 'url' is replaced with current 'session id'.
         #   @driver.test_command(1)
         #
+        # @example POST command with arguments (inline block)
+        #
+        #   @driver.add_command(
+        #     method: :post,
+        #     url: 'session/:session_id/path/to/custom/url',
+        #     name: :test_command
+        #   ) { |argument| execute(:test_command, {}, { dummy: argument }) }
+        #   @driver.test_command(1)
+        #
+        # @example POST command with URL placeholders (do/end block)
         #
         #   @driver.add_command(
         #     method: :post,
         #     url: 'session/:session_id/element/:id/custom/action',
         #     name: :test_action_command
-        #   ) do
-        #     def test_action_command(element_id, action)
-        #       execute(:test_action_command, {id: element_id}, { dummy_action: action })
-        #     end
+        #   ) do |element_id, action|
+        #     execute(:test_action_command, {id: element_id}, { dummy_action: action })
         #   end
         #   # Send a POST request to 'session/<session id>/element/<element id>/custom/action'
         #   # with body "{ dummy_action: #{action} }" as JSON object. "action" is the seconds argument.
@@ -195,10 +198,28 @@ module Appium
         #   e = @driver.find_element :accessibility_id, 'an element'
         #   @driver.test_action_command(e.id, 'action')
         #
+        # @example POST command with URL placeholders (inline block)
+        #
+        #   @driver.add_command(
+        #     method: :post,
+        #     url: 'session/:session_id/element/:id/custom/action',
+        #     name: :test_action_command
+        #   ) { |element_id, action| execute(:test_action_command, {id: element_id}, { dummy_action: action }) }
+        #   e = @driver.find_element :accessibility_id, 'an element'
+        #   @driver.test_action_command(e.id, 'action')
+        #
         def add_command(method:, url:, name:, &block)
           raise ::Appium::Core::Error::ArgumentError, "Available method is either #{AVAILABLE_METHODS}" unless AVAILABLE_METHODS.include? method
 
-          @bridge.add_command method: method, url: url, name: name, &block
+          ::Appium::Logger.info "Overriding the command '#{name}' for '#{url}'" if Bridge.extra_commands&.key?(name)
+
+          # Use Selenium's Bridge.add_command to register the command and define the method.
+          # When no block is given, create a default implementation that calls execute.
+          block ||= proc { execute(name) }
+          Bridge.add_command(name, method, url, &block)
+
+          # Ensure the driver delegates the new method to bridge
+          self.class.class_eval { def_delegator :@bridge, name } unless self.class.method_defined?(name)
         end
 
         ### Methods for Appium

data/lib/appium_lib_core/common/command.rb

@@ -208,7 +208,7 @@ module Appium
         chrome_send_command: [:post, 'session/:session_id/goog/cdp/execute']
       }.freeze
 
-      COMMANDS = {}.merge(COMMAND).merge(COMMAND_ANDROID).freeze
+      COMMANDS = {}.merge(COMMAND).merge(COMMAND_ANDROID).freeze # steep:ignore
     end # module Commands
   end # module Core
 end # module Appium

data/lib/appium_lib_core/common/device/app_management.rb

@@ -18,7 +18,7 @@ module Appium
       module Device
         module AppManagement
           def app_strings(language = nil)
-            opts = language ? { language: language } : {}
+            opts = language ? { language: language } : {} # steep:ignore
             execute_script 'mobile:getAppStrings', opts
           end
 
@@ -27,7 +27,7 @@ module Appium
             raise NotImplementedError
           end
 
-          def install_app(path, options = {})
+          def install_app(path, options = {}) # steep:ignore
             args = { appPath: path }
             args[:options] = options unless options&.empty?
 

data/lib/appium_lib_core/common/device/device.rb

@@ -22,7 +22,7 @@ module Appium
           end
 
           def device_time(format = nil)
-            arg = {}
+            arg = {} # steep:ignore
             arg[:format] = format unless format.nil?
 
             execute_script 'mobile:getDeviceTime', arg

data/lib/appium_lib_core/common/device/device_lock.rb

@@ -18,7 +18,7 @@ module Appium
       module Device
         module DeviceLock
           def lock(duration = nil)
-            opts = duration ? { seconds: duration } : {}
+            opts = duration ? { seconds: duration } : {} # steep:ignore
             execute_script 'mobile:lock', opts
           end
 

data/lib/appium_lib_core/common/device/image_comparison.rb

@@ -68,7 +68,7 @@ module Appium
             raise ::Appium::Core::Error::ArgumentError, "match_func should be #{MATCH_FEATURES[:match_func]}" unless MATCH_FEATURES[:match_func].member?(match_func.to_s)
             raise ::Appium::Core::Error::ArgumentError, "visualize should be #{MATCH_FEATURES[:visualize]}" unless MATCH_FEATURES[:visualize].member?(visualize)
 
-            options = {}
+            options = {} # steep:ignore
             options[:detectorName] = detector_name.to_s.upcase
             options[:matchFunc] = match_func.to_s
             options[:goodMatchesFactor] = good_matches_factor.to_i unless good_matches_factor.nil?
@@ -108,7 +108,7 @@ module Appium
                     "visualize should be #{MATCH_TEMPLATE[:visualize]}"
             end
 
-            options = {}
+            options = {} # steep:ignore
             options[:visualize] = visualize
             options[:threshold] = threshold unless threshold.nil?
             options[:multiple] = multiple unless multiple.nil?
@@ -138,7 +138,7 @@ module Appium
                     "visualize should be #{GET_SIMILARITY[:visualize]}"
             end
 
-            options = {}
+            options = {} # steep:ignore
             options[:visualize] = visualize
 
             compare_images(mode: :getSimilarity, first_image: first_image, second_image: second_image, options: options)
@@ -160,7 +160,7 @@ module Appium
           def compare_images(mode: :matchFeatures, first_image:, second_image:, options: nil)
             raise ::Appium::Core::Error::ArgumentError, "content_type should be #{MODE}" unless MODE.member?(mode)
 
-            params = {}
+            params = {} # steep:ignore
             params[:mode] = mode
             params[:firstImage] = Base64.strict_encode64 first_image
             params[:secondImage] = Base64.strict_encode64 second_image

data/lib/appium_lib_core/common/device/keyboard.rb

@@ -18,7 +18,7 @@ module Appium
       module Device
         module Keyboard
           def hide_keyboard(close_key = nil)
-            option = {}
+            option = {} # steep:ignore
 
             option[:key] = close_key || 'Done' # default to Done key.
 

data/lib/appium_lib_core/common/device/screen_record.rb

@@ -35,7 +35,7 @@ module Appium
                                        'method should be POST or PUT'
                                end
 
-                               option = {}
+                               option = {} # steep:ignore
                                option[:remotePath] = remote_path
                                option[:user] = user unless user.nil?
                                option[:pass] = pass unless pass.nil?
@@ -64,7 +64,7 @@ module Appium
                 file_field_name: file_field_name, form_fields: form_fields, headers: headers
               ).upload_option
 
-              params = option.empty? ? {} : { options: option }
+              params = option.empty? ? {} : { options: option } # steep:ignore
 
               execute(:stop_recording_screen, {}, params)
             end

data/lib/appium_lib_core/driver.rb

@@ -603,7 +603,7 @@ module Appium
         o = opts || {}
 
         raw_caps = o[:caps] || o[:capabilities]
-        caps_hash = raw_caps.is_a?(Hash) ? raw_caps : {}
+        caps_hash = raw_caps.is_a?(Hash) ? raw_caps : {} # steep:ignore
 
         Core::Base::Capabilities.new(caps_hash)
       end
@@ -631,7 +631,7 @@ module Appium
         app = get_app # for steep reason
         return unless app && app.empty?
 
-        uri_regex = defined?(URI::RFC2396_PARSER) ? URI::RFC2396_PARSER : URI::DEFAULT_PARSER
+        uri_regex = defined?(URI::RFC2396_PARSER) ? URI::RFC2396_PARSER : URI::DEFAULT_PARSER # steep:ignore
         return if app =~ uri_regex.make_regexp
 
         # steep:ignore

data/lib/appium_lib_core/version.rb

@@ -14,7 +14,7 @@
 
 module Appium
   module Core
-    VERSION = '12.0.0' unless defined? ::Appium::Core::VERSION
-    DATE    = '2025-12-28' unless defined? ::Appium::Core::DATE
+    VERSION = '12.1.0' unless defined? ::Appium::Core::VERSION
+    DATE    = '2026-03-21' unless defined? ::Appium::Core::DATE
   end
 end

data/lib/appium_lib_core.rb

@@ -36,7 +36,7 @@ module Appium
     # the methods which expect the symbol first.
     raise ::Appium::Core::Error::ArgumentError, 'symbolize_keys requires a hash' unless hash.is_a? Hash
 
-    hash.each_with_object({}) do |pair, acc|
+    hash.each_with_object({}) do |pair, acc| # steep:ignore
       key = begin
         if enable_deprecation_msg && !(pair[0].is_a? Symbol)
           ::Appium::Logger.warn("[Deprecation] The key '#{pair[0]}' must be a symbol while currently it " \

data/sig/gems/selenium/error.rbs

@@ -4,6 +4,9 @@ module Selenium
       module UnknownError
         def message: -> String
       end
+
+      class WebDriverError < StandardError
+      end
     end
   end
 end

data/sig/lib/appium_lib_core/common/base/bridge.rbs

@@ -10,8 +10,6 @@ module Appium
 
         @browser: untyped
 
-        @available_commands: untyped
-
         @session_id: untyped
 
         # generate a dummy capabilities instance which only has the given platformName and automationName
@@ -51,8 +49,6 @@ module Appium
         # No 'browserName' means the session is native appium connection
         APPIUM_NATIVE_BROWSER_NAME: "appium"
 
-        attr_reader available_commands: untyped
-
         def browser: () -> untyped
 
         # Appium only.
@@ -115,8 +111,10 @@ module Appium
 
         public
 
-        def add_command: (method: untyped, url: untyped, name: untyped) { (?) -> untyped } -> untyped
+        # Override Selenium's command_list to use Appium's command definitions
+        def command_list: () -> Hash[Symbol, Array[Symbol | String]]
 
+        # Override Selenium's commands to resolve extra_commands from this subclass
         def commands: (untyped command) -> untyped
 
         def status: () -> untyped

data/sig/lib/appium_lib_core/common/base/capabilities.rbs

@@ -2,6 +2,8 @@ module Appium
   module Core
     class Base
       class Capabilities < Selenium::WebDriver::Remote::Capabilities
+        KNOWN: Array[Symbol]
+
         def convert_key: (untyped key) -> untyped
 
         # Inherit json_create from parent, but you can redeclare for clarity:

data/sig/lib/appium_lib_core/common/base/driver.rbs

@@ -157,6 +157,8 @@ module Appium
         def execute_driver: (?script: ::String, ?type: ::String, ?timeout_ms: untyped?) -> untyped
 
         def convert_to_element: (untyped response_id) -> untyped
+
+        def bidi: () -> untyped
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appium_lib_core
 version: !ruby/object:Gem::Version
-  version: 12.0.0
+  version: 12.1.0
 platform: ruby
 authors:
 - Kazuaki MATSUO
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-12-28 00:00:00.000000000 Z
+date: 2026-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver