mirror of
https://github.com/ruby/ruby.git
synced 2025-08-23 04:55:21 +02:00
7164715666
(https://github.com/ruby/irb/pull/771)
I propose introducing the capability to set the IRB completion kinds via an environment variable, specifically `IRB_COMPLETOR=type`.
This feature aims to enhance the Rails console experience by allowing Rails users to specify their preferred completion more conveniently.
Currently, when using the Rails console, there's no straightforward way to globally set the type completion across a Rails application repository.
It's possible to configure this setting by placing a `.irbrc` file at the project root. However, using a .irbrc file is not ideal as it allows for broad configurations and can potentially affect the production environment.
My suggestion focuses on allowing users to set the completion to 'type' in a minimal.
This enhancement would be particularly beneficial for teams writing RBS in their Rails applications.
This type completer, integrated with RBS, would enhance completion accuracy, improving the Rails console experience.
032f6da25f
221 lines
6.6 KiB
Ruby
221 lines
6.6 KiB
Ruby
# frozen_string_literal: false
|
|
require "irb"
|
|
require "fileutils"
|
|
|
|
require_relative "helper"
|
|
|
|
module TestIRB
|
|
class InitTest < TestCase
|
|
def setup
|
|
# IRBRC is for RVM...
|
|
@backup_env = %w[HOME XDG_CONFIG_HOME IRBRC].each_with_object({}) do |env, hash|
|
|
hash[env] = ENV.delete(env)
|
|
end
|
|
ENV["HOME"] = @tmpdir = Dir.mktmpdir("test_irb_init_#{$$}")
|
|
end
|
|
|
|
def teardown
|
|
ENV.update(@backup_env)
|
|
FileUtils.rm_rf(@tmpdir)
|
|
IRB.conf.delete(:SCRIPT)
|
|
end
|
|
|
|
def test_setup_with_argv_preserves_global_argv
|
|
argv = ["foo", "bar"]
|
|
with_argv(argv) do
|
|
IRB.setup(eval("__FILE__"), argv: %w[-f])
|
|
assert_equal argv, ARGV
|
|
end
|
|
end
|
|
|
|
def test_setup_with_minimum_argv_does_not_change_dollar0
|
|
orig = $0.dup
|
|
IRB.setup(eval("__FILE__"), argv: %w[-f])
|
|
assert_equal orig, $0
|
|
end
|
|
|
|
def test_rc_file
|
|
tmpdir = @tmpdir
|
|
Dir.chdir(tmpdir) do
|
|
ENV["XDG_CONFIG_HOME"] = "#{tmpdir}/xdg"
|
|
IRB.conf[:RC_NAME_GENERATOR] = nil
|
|
assert_equal(tmpdir+"/.irb#{IRB::IRBRC_EXT}", IRB.rc_file)
|
|
assert_equal(tmpdir+"/.irb_history", IRB.rc_file("_history"))
|
|
assert_file.not_exist?(tmpdir+"/xdg")
|
|
IRB.conf[:RC_NAME_GENERATOR] = nil
|
|
FileUtils.touch(tmpdir+"/.irb#{IRB::IRBRC_EXT}")
|
|
assert_equal(tmpdir+"/.irb#{IRB::IRBRC_EXT}", IRB.rc_file)
|
|
assert_equal(tmpdir+"/.irb_history", IRB.rc_file("_history"))
|
|
assert_file.not_exist?(tmpdir+"/xdg")
|
|
end
|
|
end
|
|
|
|
def test_rc_file_in_subdir
|
|
tmpdir = @tmpdir
|
|
Dir.chdir(tmpdir) do
|
|
FileUtils.mkdir_p("#{tmpdir}/mydir")
|
|
Dir.chdir("#{tmpdir}/mydir") do
|
|
IRB.conf[:RC_NAME_GENERATOR] = nil
|
|
assert_equal(tmpdir+"/.irb#{IRB::IRBRC_EXT}", IRB.rc_file)
|
|
assert_equal(tmpdir+"/.irb_history", IRB.rc_file("_history"))
|
|
IRB.conf[:RC_NAME_GENERATOR] = nil
|
|
FileUtils.touch(tmpdir+"/.irb#{IRB::IRBRC_EXT}")
|
|
assert_equal(tmpdir+"/.irb#{IRB::IRBRC_EXT}", IRB.rc_file)
|
|
assert_equal(tmpdir+"/.irb_history", IRB.rc_file("_history"))
|
|
end
|
|
end
|
|
end
|
|
|
|
def test_recovery_sigint
|
|
pend "This test gets stuck on Solaris for unknown reason; contribution is welcome" if RUBY_PLATFORM =~ /solaris/
|
|
bundle_exec = ENV.key?('BUNDLE_GEMFILE') ? ['-rbundler/setup'] : []
|
|
status = assert_in_out_err(bundle_exec + %w[-W0 -rirb -e binding.irb;loop{Process.kill("SIGINT",$$)} -- -f --], "exit\n", //, //)
|
|
Process.kill("SIGKILL", status.pid) if !status.exited? && !status.stopped? && !status.signaled?
|
|
end
|
|
|
|
def test_no_color_environment_variable
|
|
orig_no_color = ENV['NO_COLOR']
|
|
orig_use_colorize = IRB.conf[:USE_COLORIZE]
|
|
IRB.conf[:USE_COLORIZE] = true
|
|
|
|
assert IRB.conf[:USE_COLORIZE]
|
|
|
|
ENV['NO_COLOR'] = 'true'
|
|
IRB.setup(__FILE__)
|
|
refute IRB.conf[:USE_COLORIZE]
|
|
|
|
ENV['NO_COLOR'] = ''
|
|
IRB.setup(__FILE__)
|
|
assert IRB.conf[:USE_COLORIZE]
|
|
|
|
ENV['NO_COLOR'] = nil
|
|
IRB.setup(__FILE__)
|
|
assert IRB.conf[:USE_COLORIZE]
|
|
ensure
|
|
ENV['NO_COLOR'] = orig_no_color
|
|
IRB.conf[:USE_COLORIZE] = orig_use_colorize
|
|
end
|
|
|
|
def test_use_autocomplete_environment_variable
|
|
orig_use_autocomplete_env = ENV['IRB_USE_AUTOCOMPLETE']
|
|
orig_use_autocomplete_conf = IRB.conf[:USE_AUTOCOMPLETE]
|
|
|
|
ENV['IRB_USE_AUTOCOMPLETE'] = nil
|
|
IRB.setup(__FILE__)
|
|
assert IRB.conf[:USE_AUTOCOMPLETE]
|
|
|
|
ENV['IRB_USE_AUTOCOMPLETE'] = ''
|
|
IRB.setup(__FILE__)
|
|
assert IRB.conf[:USE_AUTOCOMPLETE]
|
|
|
|
ENV['IRB_USE_AUTOCOMPLETE'] = 'false'
|
|
IRB.setup(__FILE__)
|
|
refute IRB.conf[:USE_AUTOCOMPLETE]
|
|
|
|
ENV['IRB_USE_AUTOCOMPLETE'] = 'true'
|
|
IRB.setup(__FILE__)
|
|
assert IRB.conf[:USE_AUTOCOMPLETE]
|
|
ensure
|
|
ENV["IRB_USE_AUTOCOMPLETE"] = orig_use_autocomplete_env
|
|
IRB.conf[:USE_AUTOCOMPLETE] = orig_use_autocomplete_conf
|
|
end
|
|
|
|
def test_completor_environment_variable
|
|
orig_use_autocomplete_env = ENV['IRB_COMPLETOR']
|
|
orig_use_autocomplete_conf = IRB.conf[:COMPLETOR]
|
|
|
|
ENV['IRB_COMPLETOR'] = nil
|
|
IRB.setup(__FILE__)
|
|
assert_equal(:regexp, IRB.conf[:COMPLETOR])
|
|
|
|
ENV['IRB_COMPLETOR'] = 'regexp'
|
|
IRB.setup(__FILE__)
|
|
assert_equal(:regexp, IRB.conf[:COMPLETOR])
|
|
|
|
ENV['IRB_COMPLETOR'] = 'type'
|
|
IRB.setup(__FILE__)
|
|
assert_equal(:type, IRB.conf[:COMPLETOR])
|
|
|
|
ENV['IRB_COMPLETOR'] = 'regexp'
|
|
IRB.setup(__FILE__, argv: ['--type-completor'])
|
|
assert_equal :type, IRB.conf[:COMPLETOR]
|
|
|
|
ENV['IRB_COMPLETOR'] = 'type'
|
|
IRB.setup(__FILE__, argv: ['--regexp-completor'])
|
|
assert_equal :regexp, IRB.conf[:COMPLETOR]
|
|
ensure
|
|
ENV['IRB_COMPLETOR'] = orig_use_autocomplete_env
|
|
IRB.conf[:COMPLETOR] = orig_use_autocomplete_conf
|
|
end
|
|
|
|
def test_completor_setup_with_argv
|
|
orig_completor_conf = IRB.conf[:COMPLETOR]
|
|
|
|
# Default is :regexp
|
|
IRB.setup(__FILE__, argv: [])
|
|
assert_equal :regexp, IRB.conf[:COMPLETOR]
|
|
|
|
IRB.setup(__FILE__, argv: ['--type-completor'])
|
|
assert_equal :type, IRB.conf[:COMPLETOR]
|
|
|
|
IRB.setup(__FILE__, argv: ['--regexp-completor'])
|
|
assert_equal :regexp, IRB.conf[:COMPLETOR]
|
|
ensure
|
|
IRB.conf[:COMPLETOR] = orig_completor_conf
|
|
end
|
|
|
|
def test_noscript
|
|
argv = %w[--noscript -- -f]
|
|
IRB.setup(eval("__FILE__"), argv: argv)
|
|
assert_nil IRB.conf[:SCRIPT]
|
|
assert_equal(['-f'], argv)
|
|
|
|
argv = %w[--noscript -- a]
|
|
IRB.setup(eval("__FILE__"), argv: argv)
|
|
assert_nil IRB.conf[:SCRIPT]
|
|
assert_equal(['a'], argv)
|
|
|
|
argv = %w[--noscript a]
|
|
IRB.setup(eval("__FILE__"), argv: argv)
|
|
assert_nil IRB.conf[:SCRIPT]
|
|
assert_equal(['a'], argv)
|
|
|
|
argv = %w[--script --noscript a]
|
|
IRB.setup(eval("__FILE__"), argv: argv)
|
|
assert_nil IRB.conf[:SCRIPT]
|
|
assert_equal(['a'], argv)
|
|
|
|
argv = %w[--noscript --script a]
|
|
IRB.setup(eval("__FILE__"), argv: argv)
|
|
assert_equal('a', IRB.conf[:SCRIPT])
|
|
assert_equal([], argv)
|
|
end
|
|
|
|
def test_dash
|
|
argv = %w[-]
|
|
IRB.setup(eval("__FILE__"), argv: argv)
|
|
assert_equal('-', IRB.conf[:SCRIPT])
|
|
assert_equal([], argv)
|
|
|
|
argv = %w[-- -]
|
|
IRB.setup(eval("__FILE__"), argv: argv)
|
|
assert_equal('-', IRB.conf[:SCRIPT])
|
|
assert_equal([], argv)
|
|
|
|
argv = %w[-- - -f]
|
|
IRB.setup(eval("__FILE__"), argv: argv)
|
|
assert_equal('-', IRB.conf[:SCRIPT])
|
|
assert_equal(['-f'], argv)
|
|
end
|
|
|
|
private
|
|
|
|
def with_argv(argv)
|
|
orig = ARGV.dup
|
|
ARGV.replace(argv)
|
|
yield
|
|
ensure
|
|
ARGV.replace(orig)
|
|
end
|
|
end
|
|
end
|