appium_lib_core 9.4.0 → 9.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a96d88aa179653568fc018b371ec9ab0204d10fad6228d42dcfe5c47941fcdac
-  data.tar.gz: 4f9385c8c9ed097d678ec8b49cd2d0a0adb80fb82a64222f88ae0ba2519de0ab
+  metadata.gz: 65d659dce3980c45c306b4e6e2da0f9e089428b2de1bd881bf8a276f37e66900
+  data.tar.gz: 6d8e9e621366cef67cbd8e40ddbe8e1a79eb0e191cb5295bdd19e583dfc770fa
 SHA512:
-  metadata.gz: c2424c1b0bf51c61e1f80d858202f0dfc173d75f1c4f5e3e0b00fcfdccba776745134e184a75c652880e838c01e79eba96920bcb6b566dc993764e28f56551a2
-  data.tar.gz: 99c2de8b1c88b0f2779eb5dd96957bd0d101cec4af7f08a6ed22aa1e001eb0daf4edf3eaf1ab6fd40a05f070b580e0b256b5b33c2da1d35fd88304936a0b2ffc
+  metadata.gz: fbd3f5b0aa25fbb1ca35ef4002a1a49470a329bcab6d0ea12c01679cb3ee8834f41f33b702fa31caaa44e80236b8e6cd2d07c74c3dec54711a1b68a128243475
+  data.tar.gz: bbab7740cde1fd3995a1c55dcf46ff8452f1db4286b595995c0840a3a81947acc7245b97a1bd2667ca514b5b52466f1fbdb1b4e1ba9d58c00f9eef8d35903615

data/CHANGELOG.md

@@ -10,6 +10,17 @@ Read `release_notes.md` for commit level details.
 
 ### Deprecations
 
+## [9.5.1] - 2025-01-29
+
+### Enhancements
+- Added a module to search context to improve documentation
+
+
+## [9.5.0] - 2025-01-22
+
+### Deprecations
+- Drop Ruby 3.0 by following selenium binding
+
 ## [9.4.0] - 2025-01-08
 
 ### Enhancements

data/Gemfile

@@ -2,3 +2,14 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in appium_lib_core.gemspec
 gemspec
+
+gem 'appium_thor', '~> 2.0'
+gem 'minitest', '~> 5.0'
+gem 'minitest-reporters', '~> 1.1'
+gem 'parallel_tests'
+gem 'rake', '~> 13.0'
+gem 'rubocop', '1.71.0'
+gem 'simplecov'
+gem 'steep', '~> 1.9.3'
+gem 'webmock', '~> 3.24.0'
+gem 'yard', '~> 0.9.11'

data/appium_lib_core.gemspec

@@ -3,7 +3,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'appium_lib_core/version'
 
 Gem::Specification.new do |spec|
-  spec.required_ruby_version = Gem::Requirement.new('>= 3.0')
+  spec.required_ruby_version = Gem::Requirement.new('>= 3.1')
 
   spec.name          = 'appium_lib_core'
   spec.version       = Appium::Core::VERSION
@@ -21,18 +21,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'faye-websocket', '~> 0.11.0'
-  spec.add_runtime_dependency 'selenium-webdriver', '~> 4.21'
+  spec.add_dependency 'faye-websocket', '~> 0.11.0'
+  spec.add_dependency 'selenium-webdriver', '~> 4.21'
 
-  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 'parallel_tests'
-  spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'rubocop', '1.69.2'
-  spec.add_development_dependency 'simplecov'
-  spec.add_development_dependency 'steep', '~> 1.7.0'
-  spec.add_development_dependency 'webmock', '~> 3.24.0'
-  spec.add_development_dependency 'yard', '~> 0.9.11'
   spec.metadata['rubygems_mfa_required'] = 'true'
 end

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

@@ -39,7 +39,7 @@ module Appium
 
         include ::Appium::Core::Waitable
 
-        ::Selenium::WebDriver::SearchContext.extra_finders = APPIUM_EXTRA_FINDERS
+        ::Selenium::WebDriver::SearchContext.extra_finders = ::Appium::Core::Base::SearchContext::APPIUM_EXTRA_FINDERS
 
         # Private API.
         # Do not use this for general use. Used by flutter driver to get bridge for creating a new element

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

@@ -31,7 +31,7 @@ module Appium
         class Default < ::Selenium::WebDriver::Remote::Http::Default
           attr_reader :additional_headers
 
-          ::Selenium::WebDriver::Remote::Http::Common.user_agent = \
+          ::Selenium::WebDriver::Remote::Http::Common.user_agent =
             "appium/ruby_lib_core/#{VERSION} (#{::Selenium::WebDriver::Remote::Http::Common.user_agent})"
 
           # override

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

@@ -12,102 +12,110 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# 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
+module Appium
+  module Core
+    class Base
+      module SearchContext
+        # 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
 
-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
+        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
+      end
+    end
+  end
+end

data/lib/appium_lib_core/element.rb

@@ -19,7 +19,7 @@ module Appium
     class Element < ::Selenium::WebDriver::Element
       include ::Appium::Core::Base::TakesScreenshot
 
-      ::Selenium::WebDriver::SearchContext.extra_finders = APPIUM_EXTRA_FINDERS
+      ::Selenium::WebDriver::SearchContext.extra_finders = ::Appium::Core::Base::SearchContext::APPIUM_EXTRA_FINDERS
 
       # Retuns the element id.
       #

data/lib/appium_lib_core/support/event_firing_bridge.rb

@@ -21,7 +21,7 @@ module Appium
 
       def initialize(delegate, listener, **opts)
         @appium_options = opts
-        super delegate, listener
+        super(delegate, listener)
       end
 
       def find_element_by(how, what, parent = nil)

data/lib/appium_lib_core/version.rb

@@ -14,7 +14,7 @@
 
 module Appium
   module Core
-    VERSION = '9.4.0' unless defined? ::Appium::Core::VERSION
-    DATE    = '2025-01-08' unless defined? ::Appium::Core::DATE
+    VERSION = '9.5.1' unless defined? ::Appium::Core::VERSION
+    DATE    = '2025-01-29' unless defined? ::Appium::Core::DATE
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appium_lib_core
 version: !ruby/object:Gem::Version
-  version: 9.4.0
+  version: 9.5.1
 platform: ruby
 authors:
 - Kazuaki MATSUO
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-01-08 00:00:00.000000000 Z
+date: 2025-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faye-websocket
@@ -38,146 +38,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.21'
-- !ruby/object:Gem::Dependency
-  name: appium_thor
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-- !ruby/object:Gem::Dependency
-  name: minitest-reporters
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-- !ruby/object:Gem::Dependency
-  name: parallel_tests
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.69.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.69.2
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: steep
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.7.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.7.0
-- !ruby/object:Gem::Dependency
-  name: webmock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.24.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.24.0
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.9.11
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.9.11
 description: Minimal Ruby library for Appium.
 email:
 - fly.49.89.over@gmail.com
@@ -310,7 +170,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="