appium_lib_core 13.1.4 → 13.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fce67854333b7c62714d35b70fe102dad1bbab1309cf872ac82d03f1f1acd6c2
-  data.tar.gz: 551d97c4086fa641e12b735575caef458ab8aa5d06d4aa00ecbf4f6231a01eab
+  metadata.gz: a7cf3e87d71c8019b4e82f93fb85e53eac1c608ec974ab58caebe5ce6f686b7a
+  data.tar.gz: e9a86bced562076144dd592f92b5ea213c788a0ef9f42d14c4668b472a17d704
 SHA512:
-  metadata.gz: 59c9920b5d951cc2205fc5968605a266f7db2bc14059bd77b4fea890d49785e0c30892b2703ddfed554fe24cf3463b10efd1caaf0d5e2b60acfd37ce9a01996c
-  data.tar.gz: d0521ff1a53d38efaaea992138a6ca41f2bc586073e28f024854f7ce7fbea85105c9a927a007d44228b5f08b792224cbb067556fd1f705513ebd0b1229443937
+  metadata.gz: 9000c5f967b6ea90ef5f616e1edf8cd3d8075cd832f84d9493e11c1c8382c666be7b634e840d3c3eec58a1b0cd5823272ea0663e21133345a90ea21292c2fae3
+  data.tar.gz: 1acbfe6da6a953865497c429d2b37c5b50d9f802557b3a1cc0d2df1c2b08ce63a1a0abfb57d42943396a5e12dcdb2251d1591135dcbb607e28ccd3cfe91eba8f

data/CHANGELOG.md

@@ -2,6 +2,20 @@
 All notable changes to this project will be documented in this file.
 New entries are generated by Release Please. Historical commit-level details through 13.1.0 remain in `release_notes.md`.
 
+## [13.2.1](https://github.com/appium/ruby_lib_core/compare/v13.2.0...v13.2.1) (2026-10-27)
+
+
+### Bug Fixes
+
+* support symbol webSocketUrl capability for BiDiBridge and guard nil bidi on close ([#729](https://github.com/appium/ruby_lib_core/issues/729)) ([d104352](https://github.com/appium/ruby_lib_core/commit/d104352112de6b4a181f6ae652ace738856ae083))
+
+## [13.2.0](https://github.com/appium/ruby_lib_core/compare/v13.1.4...v13.2.0) (2026-10-26)
+
+
+### Features
+
+* Implement Cached Element for shouldUseCompactResponses and elementResponseAttributes ([#727](https://github.com/appium/ruby_lib_core/issues/727)) ([a0b22c5](https://github.com/appium/ruby_lib_core/commit/a0b22c5d8d757b787b44ba0468e6a216a7c46725))
+
 ## [13.1.4](https://github.com/appium/ruby_lib_core/compare/v13.1.3...v13.1.4) (2026-10-03)
 
 

data/README.md

@@ -151,6 +151,31 @@ assert attached_driver.session_id == @driver.session_id
 attached_driver.page_source
 ```
 
+### Element response attributes
+
+When the server is configured with `shouldUseCompactResponses: false` and
+`elementResponseAttributes`, returned attributes are available through `element.cached`:
+
+```ruby
+element = @driver.find_element(:accessibility_id, 'some accessibility')
+element.cached.text                    # text returned with this element
+element.cached['content-desc']          # also accepts attribute/content-desc
+element.cached.attributes              # returned attributes, excluding element IDs
+element.text                           # fetches current text; does not update cached
+```
+
+`cached` only reads the response snapshot. It cannot find elements or send commands.
+Standard boolean fields (`enabled`, `displayed`, `selected`) normalize `"true"` and
+`"false"` to booleans. `cached.rect`, `cached.location`, and `cached.size` return
+Selenium Rectangle, Point, and Dimension objects; `cached.tag_name` reads `name`.
+These conversions also apply to `cached[name]`. Explicit `cached['attribute/...']`
+lookups and custom attributes retain their server types. `cached.attributes`
+exposes the original server values.
+Use `cached[name]` for optional attributes; it returns `nil` when absent. Dynamic
+methods such as `cached.text` are available only for attributes in the response.
+Standard accessors such as `cached.enabled?` and `cached.rect` return `nil` when
+their data is absent.
+
 ### Capabilities
 
 Read [Appium/Core/Driver](https://rubydoc.info/github/appium/ruby_lib_core/Appium/Core/Driver) to catch up with available capabilities.

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

@@ -80,11 +80,11 @@ module Appium
         def quit
           super
         ensure
-          bidi.close
+          bidi&.close
         end
 
         def close
-          execute(:close_window).tap { |handles| bidi.close if handles.empty? }
+          execute(:close_window).tap { |handles| bidi&.close if handles.empty? }
         end
 
         # steep:ignore:end

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

@@ -148,6 +148,13 @@ module Appium
 
         private
 
+        # Preserve the response until Element initialization, including for script results.
+        # Selenium calls this immediately before constructing an element. Keep nil for
+        # non-element hashes so ordinary script results and shadow roots stay intact.
+        def element_id_from(response)
+          response if super
+        end
+
         def selenium_bridge_accepts_url?
           ::Selenium::WebDriver::Remote::Bridge.instance_method(:initialize).parameters.any? do |_, name|
             name == :url

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

@@ -86,7 +86,7 @@ module Appium
 
           raise ::Appium::Core::Error::ArgumentError, "Unable to create a driver with parameters: #{opts}" unless opts.empty?
 
-          @has_bidi = capabilities && capabilities['webSocketUrl'] ? true : false
+          @has_bidi = capabilities && (capabilities['webSocketUrl'] || capabilities[:webSocketUrl]) ? true : false
           bridge_clzz = @has_bidi ? ::Appium::Core::Base::BiDiBridge : ::Appium::Core::Base::Bridge
           # steep:ignore:start
           bridge = bridge_clzz.new(**bridge_opts)

data/lib/appium_lib_core/element.rb

@@ -17,6 +17,86 @@ module Appium
     # Implement useful features for element.
     # Patch for Selenium Webdriver.
     class Element < ::Selenium::WebDriver::Element
+      # Attributes returned with an element response. This object has no bridge:
+      # reading it never sends a command or refreshes the returned values.
+      class Cache
+        attr_reader :attributes
+
+        def initialize(attributes = {})
+          @attributes = attributes.dup.freeze
+        end
+
+        # Normalize standard response fields; arbitrary attribute/... values stay raw.
+        # Missing attributes return nil. The original values remain in attributes.
+        def attribute(name)
+          key = attribute_key(name)
+          value = @attributes[key]
+          case name.to_s
+          when 'enabled', 'displayed', 'selected'
+            return true if value == 'true'
+            return false if value == 'false'
+          when 'rect'
+            return ::Selenium::WebDriver::Rectangle.new(value['x'], value['y'], value['width'], value['height']) if value.is_a?(Hash)
+          end
+          value
+        end
+
+        alias [] attribute
+
+        def enabled?
+          attribute('enabled')
+        end
+
+        alias enabled enabled?
+
+        def displayed?
+          attribute('displayed')
+        end
+
+        alias displayed displayed?
+
+        def selected?
+          attribute('selected')
+        end
+
+        alias selected selected?
+
+        def rect
+          attribute('rect')
+        end
+
+        def location
+          rectangle = rect
+          ::Selenium::WebDriver::Point.new(rectangle.x, rectangle.y) if rectangle
+        end
+
+        def size
+          rectangle = rect
+          ::Selenium::WebDriver::Dimension.new(rectangle.width, rectangle.height) if rectangle
+        end
+
+        def tag_name
+          attribute('name')
+        end
+
+        def method_missing(name, *args, &block)
+          return super unless args.empty? && block.nil? && respond_to_missing?(name)
+
+          attribute(name.to_s.delete_suffix('?').tr('_', '-'))
+        end
+
+        def respond_to_missing?(name, include_private = false)
+          @attributes.key?(attribute_key(name.to_s.delete_suffix('?').tr('_', '-'))) || super
+        end
+
+        private
+
+        def attribute_key(name)
+          key = name.to_s
+          @attributes.key?("attribute/#{key}") ? "attribute/#{key}" : key
+        end
+      end
+
       include ::Appium::Core::Base::TakesScreenshot
 
       # steep:ignore:start
@@ -32,6 +112,24 @@ module Appium
       #
       attr_reader :id
 
+      def initialize(bridge, id, cached = nil)
+        if id.is_a?(Hash)
+          # Preserve any extra attributes included in the element response.
+          cached = Cache.new(id.except('ELEMENT', ELEMENT_KEY))
+          id = id['ELEMENT'] || id[ELEMENT_KEY]
+        end
+        super(bridge, id)
+        @cached = cached
+      end
+
+      # Snapshot from elementResponseAttributes with shouldUseCompactResponses=false.
+      # Normal element calls still query the server and do not update this snapshot.
+      # Standard fields use Element API types; cached.attributes holds server values.
+      # @return [Appium::Core::Element::Cache]
+      def cached
+        @cached ||= Cache.new
+      end
+
       # Returns the value of attributes like below. Read each platform to know more details.
       #
       # uiautomator2: https://github.com/appium/appium-uiautomator2-server/blob/203cc7e57ce477f3cff5d95b135d1b3450a6033a/app/src/main/java/io/appium/uiautomator2/utils/Attribute.java#L19

data/lib/appium_lib_core/support/event_firing_bridge.rb

@@ -29,7 +29,7 @@ module Appium
           @delegate.find_element_by how, what, parent
         end
 
-        ::Appium::Core::Element.new self, e.ref.last
+        ::Appium::Core::Element.new self, e.ref.last, e.cached
       end
 
       def find_elements_by(how, what, parent = nil)
@@ -37,7 +37,7 @@ module Appium
           @delegate.find_elements_by(how, what, parent)
         end
 
-        es.map { |e| ::Appium::Core::Element.new self, e.ref.last }
+        es.map { |e| ::Appium::Core::Element.new self, e.ref.last, e.cached }
       end
 
       private

data/lib/appium_lib_core/version.rb

@@ -14,7 +14,7 @@
 
 module Appium
   module Core
-    VERSION = '13.1.4' unless defined? ::Appium::Core::VERSION
-    DATE    = '2026-10-03' unless defined? ::Appium::Core::DATE # x-release-please-date
+    VERSION = '13.2.1' unless defined? ::Appium::Core::VERSION
+    DATE    = '2026-10-27' unless defined? ::Appium::Core::DATE # x-release-please-date
   end
 end

data/sig/gems/selenium/common/element.rbs

@@ -3,6 +3,8 @@ module Selenium
     class Element
       ELEMENT_KEY: ::String
 
+      def initialize: (untyped bridge, untyped id) -> void
+
       def inspect: () -> untyped
 
       def ==: (untyped other) -> bool

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

@@ -105,6 +105,8 @@ module Appium
 
         private
 
+        def element_id_from: (untyped response) -> untyped
+
         def selenium_bridge_accepts_url?: () -> bool
 
         def camel_case: (untyped str_or_sym) -> untyped

data/sig/lib/appium_lib_core/element.rbs

@@ -2,9 +2,37 @@ module Appium
   module Core
     # Element class inheriting from Selenium::WebDriver::Element
     class Element < ::Selenium::WebDriver::Element
+      class Cache
+        attr_reader attributes: Hash[String, untyped]
+
+        def initialize: (?Hash[String, untyped] attributes) -> void
+        def attribute: (String | Symbol name) -> untyped
+        alias [] attribute
+        def enabled?: () -> bool?
+        alias enabled enabled?
+        def displayed?: () -> bool?
+        alias displayed displayed?
+        def selected?: () -> bool?
+        alias selected selected?
+        def rect: () -> untyped
+        def location: () -> untyped
+        def size: () -> untyped
+        def tag_name: () -> String?
+        def method_missing: (Symbol name, *untyped args) ?{ (?) -> untyped } -> untyped
+        def respond_to_missing?: (Symbol name, ?bool include_private) -> bool
+
+        private
+
+        def attribute_key: (String | Symbol name) -> String
+      end
+
       include ::Appium::Core::Base::TakesScreenshot
 
-      def initialize: (untyped bridge, untyped id) -> void
+      @cached: Cache?
+
+      def initialize: (untyped bridge, untyped id, ?Cache? cached) -> void
+
+      def cached: () -> Cache
 
       attr_reader id: Array[untyped]
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appium_lib_core
 version: !ruby/object:Gem::Version
-  version: 13.1.4
+  version: 13.2.1
 platform: ruby
 authors:
 - Kazuaki MATSUO