appium_console 4.3.0 → 4.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: d35c8ccbcf449176ebd22cb03bf4debd2c1b3538db04d09ed5a8af308bdb53d8
4
- data.tar.gz: 6315d3dca7927d2137760d71f75bd04b9c47d63ceaf2576000620736bad18ffc
3
+ metadata.gz: 33c7927fb9cb8e529632cfb4f019751838a24de1ececea900b8deba363a9f62b
4
+ data.tar.gz: b30cbe1f9a635cddfa017e3e23a811ad696e11db4106a30f04d284606c2547a9
5
5
  SHA512:
6
- metadata.gz: 1de4c84924901e5303ed218540d22926f98ed9ccd9ad337030f2a89bd462508c89bdeec7d80aa12edf0cf1461de2cfc035cc34cd00058ae900f72e146659be06
7
- data.tar.gz: 1df9030b98171cf15667ccf98044c7290c914061a046f6023ef849b74f822947fb535bef611f6d381c737f0b6bc305a768ff8c59854c23ab1a027bf7b31fa6bc
6
+ metadata.gz: 90dc13be5c5085320ce09bcb0f9c0b67c26c671524c5d9e50678c27c46048ca385a400ff88dc837095c46f3e38f5492fc302e032335fe79ffe6c13508aaec07f
7
+ data.tar.gz: 5fdfb600da8a5173cb8410a37491130780750df55f205e5e93be23c09e3d8d1c6d7715ded63369ec66bbc9261a439a6970e95a1be41c6f756fa5afa7bd4e7969
data/CHANGELOG.md CHANGED
@@ -3,6 +3,20 @@
3
3
  Historical commit-level notes through 4.2.0 are in [release_notes.md](release_notes.md).
4
4
  New entries are maintained by Release Please.
5
5
 
6
+ ## [4.4.0](https://github.com/appium/ruby_console/compare/v4.3.1...v4.4.0) (2026-11-22)
7
+
8
+
9
+ ### Features
10
+
11
+ * support multiple sessions while preserving console shortcuts ([#275](https://github.com/appium/ruby_console/issues/275)) ([f0e9be6](https://github.com/appium/ruby_console/commit/f0e9be65d498d5e0bdfeeb00ee8ef1c81ea4ad40))
12
+
13
+ ## [4.3.1](https://github.com/appium/ruby_console/compare/v4.3.0...v4.3.1) (2026-10-28)
14
+
15
+
16
+ ### Bug Fixes
17
+
18
+ * guard after_session hook and avoid duplicate newCommandTimeout capability ([#270](https://github.com/appium/ruby_console/issues/270)) ([6b45836](https://github.com/appium/ruby_console/commit/6b45836fd4fd9b2ddc7498744009c6a53f5904be))
19
+
6
20
  ## [4.3.0](https://github.com/appium/ruby_console/compare/v4.2.0...v4.3.0) (2026-09-20)
7
21
 
8
22
 
data/Gemfile CHANGED
@@ -3,4 +3,4 @@ gemspec
3
3
 
4
4
  gem 'minitest', '~> 5.0'
5
5
  gem 'rake', '~> 13.0'
6
- gem 'rubocop', '1.91.0'
6
+ gem 'rubocop', '1.92.2'
@@ -22,7 +22,7 @@ Gem::Specification.new do |s|
22
22
  s.require_paths = ['lib']
23
23
 
24
24
  # appium_lib version must match ruby console version.
25
- s.add_dependency 'appium_lib', '>= 14.0.0'
25
+ s.add_dependency 'appium_lib', '>= 17.0.0'
26
26
  s.add_dependency 'pry', '>= 0.14', '< 0.17'
27
27
  s.add_dependency 'thor', '>= 0.19', '< 2.0'
28
28
 
@@ -4,7 +4,7 @@
4
4
  module Appium; end unless defined? Appium
5
5
  module Appium
6
6
  module Console
7
- VERSION = '4.3.0' unless defined? ::Appium::Console::VERSION
8
- DATE = '2026-09-20' unless defined? ::Appium::Console::DATE # x-release-please-date
7
+ VERSION = '4.4.0' unless defined? ::Appium::Console::VERSION
8
+ DATE = '2026-11-22' unless defined? ::Appium::Console::DATE # x-release-please-date
9
9
  end
10
10
  end
@@ -13,17 +13,17 @@ module Appium
13
13
  module Console
14
14
  class << self
15
15
  def setup(appium_txt_path)
16
- Pry.send(:define_singleton_method, :pry_load_appium_txt) do |opts = {}|
16
+ define_pry_method(:pry_load_appium_txt) do |opts = {}|
17
17
  verbose = opts.fetch :verbose, false
18
18
  path = appium_txt_path
19
19
  Appium.load_appium_txt file: path, verbose: verbose
20
20
  end
21
21
 
22
- Pry.send(:define_singleton_method, :reload) do
22
+ define_pry_method(:reload) do
23
23
  parsed = Pry.pry_load_appium_txt
24
- return unless parsed && parsed[:appium_lib] && parsed[:appium_lib][:require]
24
+ requires = parsed&.dig(:appium_lib, :require)
25
+ return unless requires
25
26
 
26
- requires = parsed[:appium_lib][:require]
27
27
  requires.each do |file|
28
28
  # If a page obj is deleted then load will error.
29
29
  load file
@@ -38,10 +38,8 @@ module Appium
38
38
  cmd = ['-r', start]
39
39
 
40
40
  parsed = Pry.pry_load_appium_txt verbose: true
41
- has_requires = parsed && parsed[:appium_lib] && parsed[:appium_lib][:require]
42
- if has_requires
43
- requires = parsed[:appium_lib][:require]
44
-
41
+ requires = parsed&.dig(:appium_lib, :require)
42
+ if requires
45
43
  unless requires.empty?
46
44
  load_files = requires.map { |f| "require #{f.dump};" }.join "\n"
47
45
  cmd += ['-e', load_files]
@@ -50,13 +48,26 @@ module Appium
50
48
  $stdout.puts "pry #{cmd.join(' ')}"
51
49
  end
52
50
 
51
+ opts = Pry::CLI.parse_options cmd
52
+ Pry::CLI.start(opts)
53
+ end
54
+
55
+ def register_release_session_hook(driver)
56
+ if Pry.hooks.hook_exists?(:after_session, 'Release session hook')
57
+ Pry.hooks.delete_hook(:after_session, 'Release session hook')
58
+ end
53
59
  Pry.hooks.add_hook(:after_session, 'Release session hook') do |output, _binding, _pry|
54
60
  output.puts 'Closing appium session...'
55
- x
61
+ driver.driver_quit
62
+ $driver = nil if $driver.equal?(driver)
56
63
  end
64
+ end
57
65
 
58
- opts = Pry::CLI.parse_options cmd
59
- Pry::CLI.start(opts)
66
+ private
67
+
68
+ def define_pry_method(name, &)
69
+ Pry.singleton_class.send(:remove_method, name) if Pry.respond_to?(name)
70
+ Pry.send(:define_singleton_method, name, &)
60
71
  end
61
72
  end
62
73
  end
data/lib/cli.rb CHANGED
@@ -97,6 +97,12 @@ appium_console: v#{::Appium::Console::VERSION}
97
97
  end
98
98
  default_command :init
99
99
 
100
+ desc 'multi', 'Starts a console for managing independent Appium sessions'
101
+ def multi
102
+ Pry.config.command_prefix = '%'
103
+ Pry::CLI.start(Pry::CLI.parse_options([]))
104
+ end
105
+
100
106
  desc 'setup', 'Generates toml file'
101
107
  subcommand 'setup', Setup
102
108
  end
data/lib/start.rb CHANGED
@@ -11,11 +11,15 @@ Pry.respond_to?(:config) ? Pry.config.command_prefix = '%' : ''
11
11
 
12
12
  opts = Pry.pry_load_appium_txt
13
13
  # override command timeout so the server doesn't shut down after 60 seconds
14
- new_command_timeout = { caps: { newCommandTimeout: 999_999 }.merge(opts[:caps] || {}) }
14
+ caps = opts[:caps] || {}
15
+ has_command_timeout = caps.key?(:newCommandTimeout) || caps.key?(:'appium:newCommandTimeout')
16
+ new_command_timeout = { caps: (has_command_timeout ? {} : { newCommandTimeout: 999_999 }).merge(caps) }
15
17
  opts = opts.merge(new_command_timeout)
16
18
  core = Appium::Driver.new opts, false
17
19
  core.start_driver
20
+ $driver = core
18
21
  Appium.promote_appium_methods Object, core
22
+ Appium::Console.register_release_session_hook(core)
19
23
 
20
24
  # Load minitest
21
25
  begin
data/readme.md CHANGED
@@ -21,6 +21,32 @@
21
21
  - `arc setup ios` creates `appium.txt` for ios in the current working dir.
22
22
  - Setup preserves an existing `appium.txt`. Add `--force` to overwrite it.
23
23
  - `arc toml FILE` starts arc with toml FILE path
24
+ - `arc multi` opens a console where you start and stop each session yourself.
25
+
26
+ ### Using the configured session
27
+
28
+ `arc`, `arc init`, and `arc toml FILE` start the configured session.
29
+ The console exposes that session as `$driver` and makes commands such as
30
+ `get_source` available at the prompt and in page objects. Exit the console
31
+ to close the session.
32
+
33
+ ### Managing multiple sessions
34
+
35
+ Run `arc multi` and load a configuration for each device. Keep each driver
36
+ in its own variable and call commands on the driver you want to use.
37
+
38
+ ```ruby
39
+ ios = Appium::Driver.new(Appium.load_appium_txt(file: 'ios.txt'), false)
40
+ android = Appium::Driver.new(Appium.load_appium_txt(file: 'android.txt'), false)
41
+ ios.start_driver
42
+ android.start_driver
43
+
44
+ ios.get_source
45
+ android.get_source
46
+
47
+ ios.driver_quit
48
+ android.driver_quit
49
+ ```
24
50
 
25
51
  ## Documentation
26
52
 
data/test/cli_test.rb CHANGED
@@ -8,8 +8,44 @@ require 'tomlrb'
8
8
  class CliTest < Minitest::Test
9
9
  ROOT = File.expand_path('..', __dir__)
10
10
 
11
- def run_arc(*args)
12
- Open3.capture3(Gem.ruby, '-I', File.join(ROOT, 'lib'), File.join(ROOT, 'bin/arc'), *args)
11
+ def run_arc(*args, offline: false, **options)
12
+ preload = offline ? ['-r', File.join(__dir__, 'support/offline_session')] : []
13
+ Open3.capture3(Gem.ruby, *preload, '-I', File.join(ROOT, 'lib'), File.join(ROOT, 'bin/arc'), *args, **options)
14
+ end
15
+
16
+ def test_configured_console_exposes_global_and_bare_methods
17
+ Dir.mktmpdir do |dir|
18
+ File.write(File.join(dir, 'appium.txt'), <<~TOML)
19
+ [caps]
20
+ platformName = "iOS"
21
+ automationName = "XCUITest"
22
+ TOML
23
+ input = 'puts [get_source, $driver.get_source, Object.new.get_source].join("/")'
24
+ stdout, stderr, status = run_arc(stdin_data: input, chdir: dir, offline: true)
25
+ assert status.success?, stderr
26
+ assert_includes stdout, "ios/ios/ios\n"
27
+ assert_includes stdout, "closed ios\n"
28
+ end
29
+ end
30
+
31
+ def test_multi_sessions_can_be_used_and_closed_independently
32
+ Dir.mktmpdir do |dir|
33
+ input = <<~RUBY
34
+ ios = Appium::Driver.new({ caps: { platformName: 'iOS', automationName: 'XCUITest' } }, false)
35
+ android = Appium::Driver.new({ caps: { platformName: 'Android', automationName: 'UiAutomator2' } }, false)
36
+ ios.start_driver
37
+ android.start_driver
38
+ puts [ios.get_source, android.get_source, $driver.nil?, respond_to?(:get_source, true)].join("/")
39
+ ios.driver_quit
40
+ puts "remaining " + android.get_source
41
+ android.driver_quit
42
+ RUBY
43
+ stdout, stderr, status = run_arc('multi', stdin_data: input, chdir: dir, offline: true)
44
+ assert status.success?, stderr
45
+ assert_includes stdout, "ios/android/true/false\n"
46
+ assert_includes stdout, "remaining android\n"
47
+ assert_includes stdout, "closed android\n"
48
+ end
13
49
  end
14
50
 
15
51
  def test_setup_generates_driver_and_server_settings
data/test/console_test.rb CHANGED
@@ -43,4 +43,17 @@ class ConsoleTest < Minitest::Test
43
43
  end
44
44
  end
45
45
  end
46
+
47
+ def test_after_session_hook_releases_only_the_registered_driver
48
+ driver = Minitest::Mock.new
49
+ driver.expect(:driver_quit, nil)
50
+ Appium::Console.register_release_session_hook(Object.new)
51
+ Appium::Console.register_release_session_hook(driver)
52
+ output = StringIO.new
53
+ Pry.hooks.get_hook(:after_session, 'Release session hook').call(output, binding, Pry.new)
54
+ driver.verify
55
+ assert_includes output.string, 'Closing appium session...'
56
+ ensure
57
+ Pry.hooks.delete_hook(:after_session, 'Release session hook')
58
+ end
46
59
  end
data/test/simple.rb CHANGED
@@ -8,13 +8,14 @@
8
8
  require 'rubygems'
9
9
  require 'appium_lib'
10
10
 
11
- def sign_in
12
- button('Sign In').click
11
+ def sign_in(driver)
12
+ driver.button('Sign In').click
13
13
  end
14
14
 
15
- start_driver
16
-
17
- sign_in
18
-
19
- # Quit
20
- x
15
+ driver = Appium::Driver.new(Appium.load_appium_txt(file: 'appium.txt'), false)
16
+ begin
17
+ driver.start_driver
18
+ sign_in(driver)
19
+ ensure
20
+ driver.driver_quit
21
+ end
@@ -0,0 +1,22 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'appium_lib'
4
+
5
+ # Exercise the real appium_lib wrappers and console startup without a server.
6
+ module OfflineSession
7
+ Session = Struct.new(:page_source) do
8
+ def quit
9
+ puts "closed #{page_source}"
10
+ end
11
+ end
12
+
13
+ def start_driver(**)
14
+ Session.new(device.to_s)
15
+ end
16
+
17
+ def appium_server_version
18
+ {}
19
+ end
20
+ end
21
+
22
+ Appium::Core::Driver.prepend(OfflineSession)
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: appium_console
3
3
  version: !ruby/object:Gem::Version
4
- version: 4.3.0
4
+ version: 4.4.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - code@bootstraponline.com
@@ -16,14 +16,14 @@ dependencies:
16
16
  requirements:
17
17
  - - ">="
18
18
  - !ruby/object:Gem::Version
19
- version: 14.0.0
19
+ version: 17.0.0
20
20
  type: :runtime
21
21
  prerelease: false
22
22
  version_requirements: !ruby/object:Gem::Requirement
23
23
  requirements:
24
24
  - - ">="
25
25
  - !ruby/object:Gem::Version
26
- version: 14.0.0
26
+ version: 17.0.0
27
27
  - !ruby/object:Gem::Dependency
28
28
  name: pry
29
29
  requirement: !ruby/object:Gem::Requirement
@@ -92,6 +92,7 @@ files:
92
92
  - test/cli_test.rb
93
93
  - test/console_test.rb
94
94
  - test/simple.rb
95
+ - test/support/offline_session.rb
95
96
  homepage: https://github.com/appium/ruby_console
96
97
  licenses:
97
98
  - http://www.apache.org/licenses/LICENSE-2.0.txt