Skip to content

Commit

Permalink
Support --noscript option to not use first non-option argument as script
Browse files Browse the repository at this point in the history
Also add --script option to turn the option back on.

Previously there wasn't a way to get an interactive IRB session
and access arguments provided on the command line.

Additionally, handle `-` as script as stdin. In Unix-like tools, `-`
means to take standard input instead of a file.  This doesn't
result in exactly the same output for:

```
echo 'p ARGV' > args.rb; irb args.rb a b c
```

and

```
echo 'p ARGV' | irb - a b c
```

Due to how irb handles whether stdin is a tty.

However, this change allows use of `-` as a argument, instead of
giving an unrecognized switch error. This required some small
changes to context.rb (to handle `-` as standard input) and
input-method.rb (to have FileInputMethod accept IO arguments in
addition to strings).

Implements [Feature #15371]
  • Loading branch information
jeremyevans authored Sep 16, 2022
1 parent fd04751 commit 4192683
Show file tree
Hide file tree
Showing 5 changed files with 64 additions and 5 deletions.
4 changes: 4 additions & 0 deletions lib/irb/context.rb
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,10 @@ def initialize(irb, workspace = nil, input_method = nil)
end
@io = StdioInputMethod.new unless @io

when '-'
@io = FileInputMethod.new($stdin)
@irb_name = '-'
@irb_path = '-'
when String
@io = FileInputMethod.new(input_method)
@irb_name = File.basename(input_method)
Expand Down
16 changes: 12 additions & 4 deletions lib/irb/init.rb
Original file line number Diff line number Diff line change
Expand Up @@ -289,6 +289,10 @@ def IRB.parse_opts(argv: ::ARGV)
@CONF[:PROMPT_MODE] = prompt_mode
when "--noprompt"
@CONF[:PROMPT_MODE] = :NULL
when "--script"
noscript = false
when "--noscript"
noscript = true
when "--inf-ruby-mode"
@CONF[:PROMPT_MODE] = :INF_RUBY
when "--sample-book-mode", "--simple-prompt"
Expand All @@ -309,16 +313,20 @@ def IRB.parse_opts(argv: ::ARGV)
IRB.print_usage
exit 0
when "--"
if opt = argv.shift
if !noscript && (opt = argv.shift)
@CONF[:SCRIPT] = opt
$0 = opt
end
break
when /^-/
when /^-./
fail UnrecognizedSwitch, opt
else
@CONF[:SCRIPT] = opt
$0 = opt
if noscript
argv.unshift(opt)
else
@CONF[:SCRIPT] = opt
$0 = opt
end
break
end
end
Expand Down
2 changes: 1 addition & 1 deletion lib/irb/input-method.rb
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ def open(file, &block)
# Creates a new input method object
def initialize(file)
super
@io = IRB::MagicFile.open(file)
@io = file.is_a?(IO) ? file : IRB::MagicFile.open(file)
@external_encoding = @io.external_encoding
end
# The file name of this input method, usually given during initialization.
Expand Down
2 changes: 2 additions & 0 deletions lib/irb/lc/help-message
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@ Usage: irb.rb [options] [programfile] [arguments]
--sample-book-mode, --simple-prompt
Set prompt mode to 'simple'.
--noprompt Don't output prompt.
--script Script mode (default, treat first argument as script)
--noscript No script mode (leave arguments in argv)
--single-irb Share self with sub-irb.
--tracer Show stack trace for each command.
--back-trace-limit n[=16]
Expand Down
45 changes: 45 additions & 0 deletions test/irb/test_init.rb
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ def setup
def teardown
ENV.update(@backup_env)
FileUtils.rm_rf(@tmpdir)
IRB.conf.delete(:SCRIPT)
end

def test_setup_with_argv_preserves_global_argv
Expand Down Expand Up @@ -87,6 +88,50 @@ def test_no_color_environment_variable
IRB.conf[:USE_COLORIZE] = orig_use_colorize
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)
Expand Down

0 comments on commit 4192683

Please sign in to comment.