appium_lib 16.3.0 → 16.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9e81fd3ef115747e9838bc68954bf0e0fb895df7922612111953f2a0d9888d6
-  data.tar.gz: 2beea3083c901bf4ffbceeec161a2c1479aac5727a5982394bf67d00be8fec47
+  metadata.gz: b1aa9e62b11df7b31d2b0cb2da08780e251b052b82a59b741811a611f00aaf8d
+  data.tar.gz: ecab8df07b2745d0d6d996b8e3a3a32c840834ca84eed2e8dd4daa318915d278
 SHA512:
-  metadata.gz: ea82b249a833372f9524d7e481694dbeae3f70a60b4e70e13e70dc78fc9bb775eef24e1c030fe03e265f31e387da3e9347b5c269b6897ff51dfa0780c6ae9405
-  data.tar.gz: 82cac953765834b5cd86e0edb3b9f1142536875da73b565f6ec2ea18ef467bbb2c47a9e8d8df52133f861b3086e5afca14cb51be00f435337b76f77dd5d55a95
+  metadata.gz: cd9cbd2131d41a2ea9399d8f7b3b232783f15d975c75acd117158d99913044f7926ddbbccf06936eafa57e8cc6512e6eff50cb2b54436512acd6698a75969b11
+  data.tar.gz: e42e614ede8d46d494dfef431ecc2f983e969bf22d70b2b39f6402ce2789f5ec6165b244a8ec06cdf1f1dabfa0eeb1a01ce9d497c9da93ab92521d2bd4f3d292

data/CHANGELOG.md

@@ -1,8 +1,16 @@
 # Changelogs
-Commit based release not is [release_notes.md](./release_notes.md)
+Historical commit-level release notes are in [release_notes.md](./release_notes.md).
+New entries are maintained by Release Please.
 
 Release tags are https://github.com/appium/ruby_lib/releases .
 
+## [16.3.1](https://github.com/appium/ruby_lib/compare/v16.3.0...v16.3.1) (2026-09-13)
+
+
+### Bug Fixes
+
+* issues in code ([#1124](https://github.com/appium/ruby_lib/issues/1124)) ([1fc98b8](https://github.com/appium/ruby_lib/commit/1fc98b89cf41284c7da83df214aed6d8764429c2))
+
 ## [16.3.0] - 2026-05-11
 - Bump appium_lib_core to 13+
     - No user facing changes are expected.

data/Gemfile

@@ -15,11 +15,10 @@
 source 'https://rubygems.org'
 gemspec
 
-gem 'appium_thor', '~> 2.0'
 gem 'hashdiff', '~> 1.2.0'
 gem 'minitest', '~> 5.0'
 gem 'minitest-reporters', '~> 1.1'
 gem 'pry'
 gem 'rake', '~> 13.0'
-gem 'rubocop', '1.86.1'
+gem 'rubocop', '1.90.0'
 gem 'yard', '~> 0.9.11'

data/appium_lib.gemspec

@@ -19,4 +19,10 @@ Gem::Specification.new do |s|
 
   s.files = `git ls-files`.split("\n").reject { |v| v.match(/\A^(ios_tests|android_tests|grid|test_apps)\/.+/) }
   s.metadata['rubygems_mfa_required'] = 'true'
+  # Keep release automation out of the published package.
+  s.files.reject! do |file|
+    file.start_with?('.github/', 'script/', 'test/release/') ||
+      %w[RELEASING.md release-please-config.json .release-please-manifest.json].include?(file)
+  end
+
 end

data/lib/appium_lib/android/common/helper.rb

@@ -29,12 +29,12 @@ module Appium
 
       def initialize # rubocop:disable Lint/MissingSuper
         reset
-        @filter   = false
+        @filter = false
       end
 
       def reset
-        @result   = ''
-        @keys     = %w(text resource-id content-desc)
+        @result = ''
+        @keys = %w(text resource-id content-desc)
       end
 
       # http://nokogiri.org/Nokogiri/XML/SAX/Document.html

data/lib/appium_lib/appium.rb

@@ -110,7 +110,7 @@ module Appium
     # @return [Array] list of require files as an array, nil if require doesn't exist
     def expand_required_files(base_dir, file_paths)
       # ensure files are absolute
-      Array(file_paths).map! do |f|
+      file_paths = Array(file_paths).map do |f|
         file = File.exist?(f) ? f : File.join(base_dir, f)
         file = File.expand_path file
 
@@ -171,10 +171,10 @@ module Appium
           # override unless there's an existing method with matching arity
           next if const.respond_to?(m) && const.method(m).arity == driver.method(m).arity
 
-          const.send(:define_singleton_method, m) do |*args, &block|
-            super(*args, &block) # promote.rb
+          const.send(:define_singleton_method, m) do |*args, **kwargs, &block|
+            super(*args, **kwargs, &block) # promote.rb
           rescue NoMethodError, ArgumentError
-            driver.send m, *args, &block if driver.respond_to?(m)
+            driver.send m, *args, **kwargs, &block if driver.respond_to?(m)
           end
         end
       end
@@ -219,7 +219,7 @@ module Appium
             # https://github.com/appium/ruby_lib/issues/917
 
             # Remove the method before adding it.
-            remove_method method if method_defined? method
+            remove_method method if instance_methods(false).include? method
 
             define_method method do |*args, &block|
               # Prefer existing method.

data/lib/appium_lib/common/helper.rb

@@ -276,7 +276,7 @@ module Appium
       doc = if source.start_with? '<html'
               Nokogiri::HTML(source) { |cfg| cfg.options = opts }
             else
-              Nokogiri::XML(source)  { |cfg| cfg.options = opts }
+              Nokogiri::XML(source) { |cfg| cfg.options = opts }
             end
       puts doc.to_xml indent: 2
     end

data/lib/appium_lib/driver.rb

@@ -564,7 +564,8 @@ module Appium
     # @option http_client_ops [Hash] :read_timeout Custom read timeout for http client.
     # @return [Selenium::WebDriver] the new global driver
     def start_driver(http_client_ops = { http_client: nil, open_timeout: 999_999, read_timeout: 999_999 })
-      if http_client_ops[:http_client].nil?
+      http_client = http_client_ops[:http_client]
+      if http_client.nil?
         http_client = ::Appium::Http::Default.new(open_timeout: http_client_ops[:open_timeout],
                                                   read_timeout: http_client_ops[:read_timeout])
       end

data/lib/appium_lib/version.rb

@@ -14,6 +14,6 @@
 
 module Appium
   # Version and Date are defined on the 'Appium' module, not 'Appium::Common'
-  VERSION = '16.3.0' unless defined? ::Appium::VERSION
-  DATE    = '2026-05-11' unless defined? ::Appium::DATE
+  VERSION = '16.3.1' unless defined? ::Appium::VERSION
+  DATE    = '2026-09-13' unless defined? ::Appium::DATE # x-release-please-date
 end

data/readme.md

@@ -99,3 +99,8 @@ This repository has examples for running tests in parallel. Read [ios_tests](htt
 
 ## How to add new helpful methods
 - Add the new methods in this library
+
+## Releasing
+
+Review and merge the Release Please PR to publish. See [RELEASING.md](RELEASING.md)
+for one-time Trusted Publishing setup and recovery instructions.

data/test/regression_test.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+require 'minitest/autorun'
+require 'appium_lib'
+require 'tmpdir'
+
+class RegressionTest < Minitest::Test
+  def test_expand_single_required_file
+    Dir.mktmpdir do |dir|
+      path = File.join(dir, 'helper.rb')
+      File.write(path, '')
+
+      assert_equal [path], Appium.expand_required_files(dir, 'helper.rb')
+    end
+  end
+
+  def test_expand_required_directory_and_skip_missing_files
+    Dir.mktmpdir do |dir|
+      nested = File.join(dir, 'helpers')
+      Dir.mkdir(nested)
+      path = File.join(nested, 'helper.rb')
+      File.write(path, '')
+      File.write(File.join(nested, 'notes.txt'), '')
+
+      assert_equal [path], Appium.expand_required_files(dir, %w(helpers missing.rb))
+      assert_empty Appium.expand_required_files(dir, 'missing.rb')
+    end
+  end
+
+  def test_promote_preserves_inherited_method
+    parent = Class.new do
+      def back
+        :inherited
+      end
+    end
+    child = Class.new(parent)
+    driver = Object.new
+    def driver.back
+      :driver
+    end
+
+    Appium.promote_appium_methods(child, driver)
+
+    assert_equal :inherited, child.new.back
+  end
+
+  def test_promote_again_uses_new_driver
+    target = Class.new
+    first = Object.new
+    def first.back
+      :first
+    end
+    second = Object.new
+    def second.back
+      :second
+    end
+
+    Appium.promote_appium_methods(target, first)
+    assert_equal :first, target.new.back
+    Appium.promote_appium_methods(target, second)
+    assert_equal :second, target.new.back
+  end
+
+  def test_singleton_promotion_forwards_keywords_and_block
+    driver = Object.new
+    def driver.log_event(vendor:, event:)
+      yield [vendor, event]
+    end
+    target = Module.new
+    Appium.promote_singleton_appium_methods([target], driver)
+
+    result = target.log_event(vendor: 'test', event: 'event') { |values| values.join(':') }
+
+    assert_equal 'test:event', result
+  end
+
+  def test_singleton_promotion_preserves_positional_hash
+    driver = Object.new
+    def driver.command(options)
+      options
+    end
+    target = Module.new
+    Appium.promote_singleton_appium_methods([target], driver)
+
+    assert_equal({ value: 1 }, target.command({ value: 1 }))
+  end
+
+  class RecordingCore
+    attr_reader :http_client
+
+    def automation_name
+      :uiautomator2
+    end
+
+    def start_driver(http_client_ops:, **)
+      @http_client = http_client_ops[:http_client]
+      nil
+    end
+
+    def appium_server_version
+      {}
+    end
+  end
+
+  def test_start_driver_passes_custom_http_client
+    client = Object.new
+    driver = build_driver
+
+    driver.start_driver(http_client: client)
+
+    assert_same client, driver.http_client
+  end
+
+  def test_start_driver_builds_default_http_client
+    driver = build_driver
+
+    driver.start_driver
+
+    assert_instance_of Appium::Http::Default, driver.http_client
+  end
+
+  private
+
+  def build_driver
+    driver = Appium::Driver.allocate
+    driver.instance_variable_set(:@core, RecordingCore.new)
+    def driver.server_url
+      'http://127.0.0.1:4723'
+    end
+    driver
+  end
+end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appium_lib
 version: !ruby/object:Gem::Version
-  version: 16.3.0
+  version: 16.3.1
 platform: ruby
 authors:
 - code@bootstraponline.com
 - Kazuaki Matsuo
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-05-11 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appium_lib_core
@@ -79,20 +78,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/CODEOWNERS"
-- ".github/ISSUE_TEMPLATE.md"
-- ".github/PULL_REQUEST_TEMPLATE.md"
-- ".github/dependabot.yml"
-- ".github/workflows/functional-test.yml"
-- ".github/workflows/pr-title.yml"
-- ".github/workflows/rubocop.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE-2.0.txt
 - Rakefile
-- Thorfile
 - appium_lib.gemspec
 - contributing.md
 - docs/android_uiautomator.md
@@ -157,12 +148,12 @@ files:
 - readme.md
 - release_notes.md
 - test/first_test.rb
+- test/regression_test.rb
 homepage: https://github.com/appium/ruby_lib
 licenses:
 - Apache-2.0
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -177,8 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
-signing_key:
+rubygems_version: 4.0.16
 specification_version: 4
 summary: Ruby library for Appium
 test_files: []

data/.github/CODEOWNERS

@@ -1 +0,0 @@
-* @KazuCocoa

data/.github/ISSUE_TEMPLATE.md

@@ -1,21 +0,0 @@
-## This is a
-* [ ] Bug report
-* [ ] Question
-* [ ] Freature Request
-
-## Summary
-
-## Environment
-* Appium version (or git revision):
-* `ruby_lib` version:
-* Mobile platform/version/device under test:
-
-## Actual behaviour and steps to reproduce
-
-## Expected behaviour
-
-## Link to Appium/Ruby logs
-
-Create a [GIST](https://gist.github.com) which is a paste of your _full_ Appium logs, and link them here. 
-
-## Any additional comments

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -1,17 +0,0 @@
-# Summary
-
-Please include a summary of the change and which issue is fixed.
-Please also include relevant motivation and context.
-
-Closes # (issue)
-
-# How Has This Been Tested?
-
-Please describe the tests that you ran to verify your changes. If the change has test code, it can be alternative.
-
-- [ ] Test A
-- [ ] Test B
-
-# Checklist
-
-- [ ] `bundle exec rake rubocop`

data/.github/dependabot.yml

@@ -1,14 +0,0 @@
-version: 2
-updates:
-- package-ecosystem: bundler
-  directory: "/"
-  schedule:
-    interval: weekly
-    time: "11:00"
-  open-pull-requests-limit: 10
-- package-ecosystem: github-actions
-  directory: "/"
-  schedule:
-    interval: weekly
-    time: "11:00"
-  open-pull-requests-limit: 10

data/.github/workflows/functional-test.yml

@@ -1,170 +0,0 @@
-name: Functional Tests
-
-on:
-  # Run by manual at this time
-  workflow_dispatch:
-  push:
-    branches: [ master ]
-  pull_request:
-    branches: [ master ]
-
-concurrency:
-  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
-  cancel-in-progress: true
-
-jobs:
-  ios_test:
-    runs-on: macos-15
-    timeout-minutes: 90
-    env:
-          XCODE_VERSION: 16.4
-          IOS_VERSION: 18.5
-          IOS_DEVICE_NAME: iPhone 16 Plus
-
-    steps:
-    - uses: actions/checkout@v6
-
-    - name: Install Node.js
-      uses: actions/setup-node@v6
-      with:
-        node-version: 'lts/*'
-
-    - name: Select Xcode
-      uses: maxim-lobanov/setup-xcode@v1
-      with:
-        xcode-version: ${{ env.XCODE_VERSION }}
-    - run: defaults write com.apple.iphonesimulator PasteboardAutomaticSync -bool false
-
-    - uses: futureware-tech/simulator-action@v5
-      with:
-      # https://github.com/actions/runner-images/blob/main/images/macos/macos-14-arm64-Readme.md
-        model: ${{ env.IOS_DEVICE_NAME }}
-        os_version: ${{ env.IOS_VERSION }}
-
-    - name: Preparing other environment
-      run: |
-        brew install ffmpeg
-        brew tap wix/brew
-        brew install applesimutils
-
-    # Start Appium
-    - name: Install appium and mjpeg-consumer
-      run: |
-        npm install -g appium
-        npm install -g mjpeg-consumer
-    - run: |
-        appium driver install xcuitest
-        appium plugin install images
-        appium plugin install execute-driver
-        nohup appium --use-plugins=images,execute-driver --relaxed-security --log-timestamp --log-no-colors > appium.log &
-
-    - run: |
-        npx appium driver run xcuitest download-wda-sim --platform=ios --outdir=${{ github.workspace }}/wda
-      name: Downloading prebuilt WDA
-
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: 4.0
-    - run: |
-        bundle install
-        bundle exec rake ios
-      name: Run tests
-      timeout-minutes: 60
-      working-directory: ios_tests
-      env:
-        LOCAL_PREBUILT_WDA: ${{ github.workspace }}/wda/WebDriverAgentRunner-Runner.app
-
-    - name: Save server output
-      if: ${{ always() }}
-      uses: actions/upload-artifact@master
-      with:
-        name: appium-ios_test_with_other_deps.log
-        path: |
-          appium.log
-          test/report/
-
-  android_test:
-    runs-on: ubuntu-latest
-    timeout-minutes: 90
-    env:
-      API_LEVEL: 35
-      ARCH: x86_64
-
-    steps:
-    - uses: actions/checkout@v6
-
-    - name: Set up Java
-      uses: actions/setup-java@v5
-      with:
-        distribution: temurin
-        java-version: '17'
-
-    - name: Install Node.js
-      uses: actions/setup-node@v6
-      with:
-        node-version: 'lts/*'
-
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: 4.0
-
-    - name: Install appium
-      run: |
-        npm install -g appium
-        npm install -g mjpeg-consumer
-
-    - name: Start appium
-      run: |
-        appium driver install uiautomator2
-        appium plugin install images
-        appium plugin install execute-driver
-        nohup appium --use-plugins=images,execute-driver --relaxed-security --log-timestamp --log-no-colors > appium.log &
-
-    - name: Enable KVM group perms
-      run: |
-        echo 'KERNEL=="kvm", GROUP="kvm", MODE="0666", OPTIONS+="static_node=kvm"' | sudo tee /etc/udev/rules.d/99-kvm4all.rules
-        sudo udevadm control --reload-rules
-        sudo udevadm trigger --name-match=kvm
-
-    - name: AVD cache
-      uses: actions/cache@v5
-      id: avd-cache
-      with:
-        path: |
-          ~/.android/avd/*
-          ~/.android/adb*
-        key: avd-${{ env.API_LEVEL }}
-
-    - name: Create AVD snapshot for cache
-      if: steps.avd-cache.outputs.cache-hit != 'true'
-      uses: reactivecircus/android-emulator-runner@v2
-      with:
-        api-level: ${{ env.API_LEVEL }}
-        arch: ${{ env.ARCH }}
-        target: google_apis
-        force-avd-creation: false
-        emulator-options: -no-window -gpu swiftshader_indirect -noaudio -no-boot-anim -camera-back none
-        disable-animations: false
-        script: echo "Generated AVD snapshot for caching."
-
-    - name: run tests
-      uses: reactivecircus/android-emulator-runner@v2
-      with:
-        api-level: ${{ env.API_LEVEL }}
-        arch: ${{ env.ARCH }}
-        script: cd android_tests;bundle install;bundle exec rake --tasks;bundle exec rake android
-        target: google_apis
-        profile: Nexus 5X
-        disable-spellchecker: true
-        disable-animations: true
-
-    - name: Save server output
-      if: ${{ always() }}
-      uses: actions/upload-artifact@master
-      with:
-        name: appium-android_test_with_other_deps.log
-        path: |
-          appium.log
-          test/report/

data/.github/workflows/pr-title.yml

@@ -1,10 +0,0 @@
-name: Conventional Commits
-on:
-  pull_request:
-    types: [opened, edited, synchronize, reopened]
-
-jobs:
-  lint:
-    uses: appium/appium-workflows/.github/workflows/pr-title.yml@main
-    with:
-      config-preset: angular

data/.github/workflows/rubocop.yml

@@ -1,29 +0,0 @@
-name: rubocop
-
-on:
-  push:
-    branches: [ master ]
-  pull_request:
-    branches: [ master ]
-
-jobs:
-  test:
-    strategy:
-      fail-fast: false
-      matrix:
-        ruby: [3.1, 3.2, 3.3]
-
-    runs-on: ubuntu-latest
-
-    steps:
-    - uses: actions/checkout@v6
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: ${{ matrix.ruby }}
-    - name: Install dependencies
-      run: bundle install
-    - name: Run rubocop
-      run: bundle exec rake rubocop
-    - name: Run tests
-      run: bundle exec rake test

data/Thorfile

@@ -1,7 +0,0 @@
-require 'appium_thor'
-
-Appium::Thor::Config.set do
-  gem_name     'appium_lib'
-  github_name  'ruby_lib'
-  version_file 'lib/appium_lib/version.rb'
-end