appium_lib_core 12.0.1 → 12.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92050dbff8ddd9ada25541591ea3bdfd8e9e45529aaa702d7ce2610b7a8f3347
-  data.tar.gz: 9572c6c197b671c189d2532c79dea7b175ef9d704cdaf274acd5335ad4092a3d
+  metadata.gz: cb6226306206eafec9dbd6f2c2f1ac09c86fee48ee841be8616df8acf6ce56a5
+  data.tar.gz: ab63b82ecafb824a8b0edfdcbcba8d9ec0e1530e8a42f86c4c95aa95246a6871
 SHA512:
-  metadata.gz: f45f47ab8f95dea1bcdfb26b1811288ff17cb8bda5837e5cc7bc9f47f1b3890a8637cfc4caceebf03013fe0809377d12f02eecaaa442813409fc49feb3aac8c0
-  data.tar.gz: 1ec5c0ed972d09577eef5b01c1ec3713b52694f97dd6d596eb710c299a84f2ee9666d0dfc85a6c06e80cdb16be6561a40d7d95fabded6887ea0d360900697768
+  metadata.gz: 2573d787ffb963708aae21889b3f3ab6f68b7747b623a7ba906fff4065f7514557608dfaa6b9b05b8ceddaf4a6f0ae96edb20a436af01e3148c5c13ed64bf598
+  data.tar.gz: 21c2e01a1bdfb8bfd81ad309eb8e6fbdfa6d5abba485c77b52c257652be9c8b58a4f62a110a78128f2f26438e0d018cebfe6f1cffd8f60e1aa91293c2d14e269

data/CHANGELOG.md

@@ -2,6 +2,9 @@
 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
 

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.85.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,8 +106,6 @@ 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: [{}] } }) # steep:ignore
 
@@ -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

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/version.rb

@@ -14,7 +14,7 @@
 
 module Appium
   module Core
-    VERSION = '12.0.1' unless defined? ::Appium::Core::VERSION
-    DATE    = '2026-03-07' 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/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

metadata

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