appium_console 4.2.0 → 4.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd05f297d96d2542f2101103c3bcf7e2a8626f0f46dfba004d7dcaab88663d04
-  data.tar.gz: 487d016059200b2c94a43bbd98245778c5eaec965350f9194b1c2b4b527196bf
+  metadata.gz: d35c8ccbcf449176ebd22cb03bf4debd2c1b3538db04d09ed5a8af308bdb53d8
+  data.tar.gz: 6315d3dca7927d2137760d71f75bd04b9c47d63ceaf2576000620736bad18ffc
 SHA512:
-  metadata.gz: 7a7742fded7155b9ab7c03d6dc530202e3bd2c0cfe27d3ab40a067f56a0fd4b076f3ef41017ec325dda26926f98e6363996fe17f068edc651006f58a76207a60
-  data.tar.gz: d4be64288f72600ae0cd9c37b37b1181948b9172c381063b5fff0df781050bb2106494a4d22d378d833cf0687189540278c9c698327615c4501f0daa320527b1
+  metadata.gz: 1de4c84924901e5303ed218540d22926f98ed9ccd9ad337030f2a89bd462508c89bdeec7d80aa12edf0cf1461de2cfc035cc34cd00058ae900f72e146659be06
+  data.tar.gz: 1df9030b98171cf15667ccf98044c7290c914061a046f6023ef849b74f822947fb535bef611f6d381c737f0b6bc305a768ff8c59854c23ab1a027bf7b31fa6bc

data/.rubocop.yml

@@ -1,6 +1,6 @@
 AllCops:
   TargetRubyVersion: 3.1
-Metrics/LineLength:
+Layout/LineLength:
   Max: 128
 Metrics/MethodLength:
   Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+# Changelog
+
+Historical commit-level notes through 4.2.0 are in [release_notes.md](release_notes.md).
+New entries are maintained by Release Please.
+
+## [4.3.0](https://github.com/appium/ruby_console/compare/v4.2.0...v4.3.0) (2026-09-20)
+
+
+### Features
+
+* correct console setup defaults and safely load files ([#265](https://github.com/appium/ruby_console/issues/265)) ([d127d91](https://github.com/appium/ruby_console/commit/d127d9150d72fec8529d9c68c121a5dc6b50fb4c))
+
+## [4.2.0] - 2025-01-25
+
+- See the historical release notes for this release.

data/Gemfile

@@ -1,6 +1,6 @@
 source 'https://rubygems.org'
 gemspec
 
-gem 'appium_thor', '~> 2.0'
+gem 'minitest', '~> 5.0'
 gem 'rake', '~> 13.0'
-gem 'rubocop', '1.71.0'
+gem 'rubocop', '1.91.0'

data/Rakefile

@@ -2,6 +2,11 @@ require 'bundler/gem_tasks'
 require 'rake/testtask'
 require 'rubocop/rake_task'
 
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+end
+
 desc('Execute RuboCop static code analysis')
 RuboCop::RakeTask.new(:rubocop) do |t|
   t.patterns = %w(lib test)

data/appium_console.gemspec

@@ -23,10 +23,16 @@ Gem::Specification.new do |s|
 
   # appium_lib version must match ruby console version.
   s.add_dependency 'appium_lib', '>= 14.0.0'
-  s.add_dependency 'pry', '~> 0.14.0'
+  s.add_dependency 'pry', '>= 0.14', '< 0.17'
   s.add_dependency 'thor', '>= 0.19', '< 2.0'
 
   s.executables = ['arc']
   s.files = `git ls-files`.split "\n"
   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_console/version.rb

@@ -4,7 +4,7 @@
 module Appium; end unless defined? Appium
 module Appium
   module Console
-    VERSION = '4.2.0' unless defined? ::Appium::Console::VERSION
-    DATE = '2025-01-25' unless defined? ::Appium::Console::DATE
+    VERSION = '4.3.0' unless defined? ::Appium::Console::VERSION
+    DATE = '2026-09-20' unless defined? ::Appium::Console::DATE # x-release-please-date
   end
 end

data/lib/appium_console.rb

@@ -43,7 +43,7 @@ module Appium
           requires = parsed[:appium_lib][:require]
 
           unless requires.empty?
-            load_files = requires.map { |f| %(require "#{f}";) }.join "\n"
+            load_files = requires.map { |f| "require #{f.dump};" }.join "\n"
             cmd += ['-e', load_files]
           end
 

data/lib/cli.rb

@@ -18,6 +18,7 @@ module Appium::CLI # rubocop:disable Style/ClassAndModuleChildren
         <<-TEMPLATE.gsub(/skip\s/, '')
 [caps]
 platformName = "#{caps[:platform_name]}"
+automationName = "#{caps[:automation_name]}"
 #{caps[:platform_version] ? "platformVersion = \"#{caps[:platform_version]}\"" : 'skip'}
 #{caps[:device_name] ? "deviceName = \"#{caps[:device_name]}\"" : 'skip'}
 app = "#{caps[:path_to_app]}"
@@ -25,7 +26,7 @@ app = "#{caps[:path_to_app]}"
 #{caps[:app_activity] ? "appActivity = \"#{caps[:app_activity]}\"" : 'skip'}
 
 [appium_lib]
-server_url = "http://127.0.0.1:4723/wd/hub"
+server_url = "http://127.0.0.1:4723/"
         TEMPLATE
       end
     end
@@ -33,6 +34,7 @@ server_url = "http://127.0.0.1:4723/wd/hub"
 
   class Setup < Thor
     desc 'ios', 'Generates toml for ios'
+    method_option :force, type: :boolean, default: false, desc: 'Overwrite an existing appium.txt'
     def ios
       toml = File.join(Dir.pwd, Config.default_appium_txt_path)
       template = Config.template(
@@ -42,10 +44,11 @@ server_url = "http://127.0.0.1:4723/wd/hub"
         platform_version: '15.0',
         path_to_app: '/path/to/app_bundle'
       )
-      File.write(toml, template)
+      write_config(toml, template)
     end
 
     desc 'android', 'Generates toml for android'
+    method_option :force, type: :boolean, default: false, desc: 'Overwrite an existing appium.txt'
     def android
       toml = File.join(Dir.pwd, Config.default_appium_txt_path)
       template = Config.template(
@@ -56,11 +59,23 @@ server_url = "http://127.0.0.1:4723/wd/hub"
         app_package: 'com.package.example',
         app_activity: 'com.package.example.ExampleActivity'
       )
-      File.write(toml, template)
+      write_config(toml, template)
+    end
+
+    private
+
+    def write_config(path, template)
+      File.write(path, template, mode: options[:force] ? 'w' : 'wx')
+    rescue Errno::EEXIST
+      raise Thor::Error, "#{path} already exists. Use --force to overwrite it."
     end
   end
 
   class Main < Thor
+    def self.exit_on_failure?
+      true
+    end
+
     desc 'version', 'Prints version of appium_lib and appium_console'
     def version
       puts <<-VERSION

data/readme.md

@@ -19,15 +19,26 @@
         - `arc version` prints the current version of appium console and appium lib.
         - `arc setup android` creates `appium.txt` for android in the current working dir.
         - `arc setup ios` creates `appium.txt` for ios in the current working dir.
+        - Setup preserves an existing `appium.txt`. Add `--force` to overwrite it.
         - `arc toml FILE` starts arc with toml FILE path
 
 ## Documentation
 
 - [ruby_lib](https://github.com/appium/ruby_lib)
 
+## Development
+
+Run `bundle install`, then `bundle exec rake test` and `bundle exec rake rubocop`.
+Tests run without an Appium server or device.
+
 ## Changelog
 - 4.0.0
     - Drop Ruby 2.7 support
 - 3.0.0
     - Update ruby_lib version to v12
 
+
+## 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/cli_test.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'minitest/autorun'
+require 'open3'
+require 'tmpdir'
+require 'tomlrb'
+
+class CliTest < Minitest::Test
+  ROOT = File.expand_path('..', __dir__)
+
+  def run_arc(*args)
+    Open3.capture3(Gem.ruby, '-I', File.join(ROOT, 'lib'), File.join(ROOT, 'bin/arc'), *args)
+  end
+
+  def test_setup_generates_driver_and_server_settings
+    { 'ios' => 'XCUITest', 'android' => 'uiautomator2' }.each do |platform, driver|
+      Dir.mktmpdir do |dir|
+        Dir.chdir(dir) do
+          _, stderr, status = run_arc('setup', platform)
+          assert status.success?, stderr
+          config = Tomlrb.load_file('appium.txt')
+          assert_equal driver, config.fetch('caps').fetch('automationName')
+          assert_equal platform == 'ios' ? 'iOS' : 'Android', config.fetch('caps').fetch('platformName')
+          assert_equal 'http://127.0.0.1:4723/', config.fetch('appium_lib').fetch('server_url')
+        end
+      end
+    end
+  end
+
+  def test_setup_preserves_existing_config_unless_forced
+    %w[ios android].each do |platform|
+      Dir.mktmpdir do |dir|
+        Dir.chdir(dir) do
+          File.write('appium.txt', 'custom configuration')
+          _, stderr, status = run_arc('setup', platform)
+          refute status.success?
+          assert_includes stderr, '--force'
+          assert_equal 'custom configuration', File.read('appium.txt')
+
+          _, stderr, status = run_arc('setup', platform, '--force')
+          assert status.success?, stderr
+          assert Tomlrb.load_file('appium.txt').fetch('caps').key?('automationName')
+        end
+      end
+    end
+  end
+
+  def test_version_command
+    stdout, stderr, status = run_arc('version')
+    assert status.success?, stderr
+    assert_includes stdout, 'appium_console:'
+    assert_includes stdout, 'appium_lib:'
+  end
+end

data/test/console_test.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'minitest/autorun'
+require 'minitest/mock'
+require 'open3'
+require 'tmpdir'
+require 'appium_console'
+
+class ConsoleTest < Minitest::Test
+  def test_start_requires_files_with_special_characters_literally
+    Dir.mktmpdir do |dir|
+      file = File.join(dir, 'page"\\#{raise "interpolated"}.rb')
+      File.write(file, 'puts "page loaded"')
+      parsed = { appium_lib: { require: [file] } }
+      Appium::Console.setup('appium.txt')
+      launch = lambda do |args|
+        assert_equal '-r', args.first
+        assert_equal File.expand_path('../lib/start.rb', __dir__), args[1]
+        assert_equal '-e', args[2]
+        stdout, stderr, status = Open3.capture3(Gem.ruby, '-e', args[3])
+        assert status.success?, stderr
+        assert_equal "page loaded\n", stdout
+      end
+      Appium.stub(:load_appium_txt, parsed) do
+        Pry::CLI.stub(:parse_options, ->(args) { args }) do
+          Pry::CLI.stub(:start, launch) { capture_io { Appium::Console.start } }
+        end
+      end
+    ensure
+      Pry.hooks.delete_hook(:after_session, 'Release session hook')
+    end
+  end
+
+  def test_reload_loads_changed_file_contents
+    Dir.mktmpdir do |dir|
+      file = File.join(dir, 'page.rb')
+      Appium::Console.setup('appium.txt')
+      Appium.stub(:load_appium_txt, { appium_lib: { require: [file] } }) do
+        File.write(file, 'puts "first version"')
+        assert_output("first version\n") { Pry.reload }
+        File.write(file, 'puts "second version"')
+        assert_output("second version\n") { Pry.reload }
+      end
+    end
+  end
+end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appium_console
 version: !ruby/object:Gem::Version
-  version: 4.2.0
+  version: 4.3.0
 platform: ruby
 authors:
 - code@bootstraponline.com
 - Kazuaki Matsuo
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-26 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appium_lib
@@ -29,16 +28,22 @@ dependencies:
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.14'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: '0.17'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.14'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: '0.17'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -68,13 +73,12 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/dependabot.yml"
 - ".gitignore"
 - ".rubocop.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE-2.0.txt
 - Rakefile
-- Thorfile
 - appium_console.gemspec
 - bin/arc
 - img/avd_settings.png
@@ -85,13 +89,14 @@ files:
 - lib/start.rb
 - readme.md
 - release_notes.md
+- test/cli_test.rb
+- test/console_test.rb
 - test/simple.rb
 homepage: https://github.com/appium/ruby_console
 licenses:
 - http://www.apache.org/licenses/LICENSE-2.0.txt
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -106,8 +111,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.20
 specification_version: 4
 summary: Appium Ruby Console
 test_files: []

data/.github/dependabot.yml

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

data/Thorfile

@@ -1,20 +0,0 @@
-require 'appium_thor'
-
-Appium::Thor::Config.set do
-  gem_name     'appium_console'
-  github_owner 'appium'
-  github_name  'ruby_console'
-  version_file 'lib/appium_console/version.rb'
-end
-
-# Must use '::' otherwise Default will point to Thor::Sandbox::Default
-# Debug by calling Thor::Base.subclass_files via Pry
-#
-# https://github.com/erikhuda/thor/issues/484
-#
-class ::Default < Thor
-  desc 'spec', 'Run RSpec tests'
-  def spec
-    exec 'rspec spec'
-  end
-end