irb 1.1.0.pre.3 → 1.1.0.pre.4

data/irb.gemspec

@@ -16,7 +16,62 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/ruby/irb"
   spec.license       = "BSD-2-Clause"
 
-  spec.files         = ["LICENSE.txt", "README.md", "exe/irb", "irb.gemspec", "lib/irb.rb", "lib/irb/cmd/chws.rb", "lib/irb/cmd/fork.rb", "lib/irb/cmd/help.rb", "lib/irb/cmd/load.rb", "lib/irb/cmd/nop.rb", "lib/irb/cmd/pushws.rb", "lib/irb/cmd/subirb.rb", "lib/irb/completion.rb", "lib/irb/context.rb", "lib/irb/color.rb", "lib/irb/ext/change-ws.rb", "lib/irb/ext/history.rb", "lib/irb/ext/loader.rb", "lib/irb/ext/multi-irb.rb", "lib/irb/ext/save-history.rb", "lib/irb/ext/tracer.rb", "lib/irb/ext/use-loader.rb", "lib/irb/ext/workspaces.rb", "lib/irb/extend-command.rb", "lib/irb/frame.rb", "lib/irb/help.rb", "lib/irb/init.rb", "lib/irb/input-method.rb", "lib/irb/inspector.rb", "lib/irb/lc/.document", "lib/irb/lc/error.rb", "lib/irb/lc/help-message", "lib/irb/lc/ja/encoding_aliases.rb", "lib/irb/lc/ja/error.rb", "lib/irb/lc/ja/help-message", "lib/irb/locale.rb", "lib/irb/magic-file.rb", "lib/irb/notifier.rb", "lib/irb/output-method.rb", "lib/irb/ruby-lex.rb", "lib/irb/ruby-token.rb", "lib/irb/slex.rb", "lib/irb/src_encoding.rb", "lib/irb/version.rb", "lib/irb/workspace.rb", "lib/irb/ws-for-case-2.rb", "lib/irb/xmp.rb"]
+  spec.files         = [
+    "Gemfile",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "bin/console",
+    "bin/setup",
+    "doc/irb/irb-tools.rd.ja",
+    "doc/irb/irb.rd.ja",
+    "exe/irb",
+    "irb.gemspec",
+    "lib/irb.rb",
+    "lib/irb/cmd/chws.rb",
+    "lib/irb/cmd/fork.rb",
+    "lib/irb/cmd/help.rb",
+    "lib/irb/cmd/load.rb",
+    "lib/irb/cmd/nop.rb",
+    "lib/irb/cmd/pushws.rb",
+    "lib/irb/cmd/subirb.rb",
+    "lib/irb/color.rb",
+    "lib/irb/completion.rb",
+    "lib/irb/context.rb",
+    "lib/irb/ext/change-ws.rb",
+    "lib/irb/ext/history.rb",
+    "lib/irb/ext/loader.rb",
+    "lib/irb/ext/multi-irb.rb",
+    "lib/irb/ext/save-history.rb",
+    "lib/irb/ext/tracer.rb",
+    "lib/irb/ext/use-loader.rb",
+    "lib/irb/ext/workspaces.rb",
+    "lib/irb/extend-command.rb",
+    "lib/irb/frame.rb",
+    "lib/irb/help.rb",
+    "lib/irb/init.rb",
+    "lib/irb/input-method.rb",
+    "lib/irb/inspector.rb",
+    "lib/irb/lc/.document",
+    "lib/irb/lc/error.rb",
+    "lib/irb/lc/help-message",
+    "lib/irb/lc/ja/encoding_aliases.rb",
+    "lib/irb/lc/ja/error.rb",
+    "lib/irb/lc/ja/help-message",
+    "lib/irb/locale.rb",
+    "lib/irb/magic-file.rb",
+    "lib/irb/notifier.rb",
+    "lib/irb/output-method.rb",
+    "lib/irb/ruby-lex.rb",
+    "lib/irb/ruby_logo.aa",
+    "lib/irb/slex.rb",
+    "lib/irb/src_encoding.rb",
+    "lib/irb/version.rb",
+    "lib/irb/workspace.rb",
+    "lib/irb/ws-for-case-2.rb",
+    "lib/irb/xmp.rb",
+    "man/irb.1",
+  ]
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]

data/lib/irb.rb

@@ -45,8 +45,8 @@ require "irb/version"
 #     irb(main):006:1> end
 #     #=> nil
 #
-# The Readline extension module can be used with irb. Use of Readline is
-# default if it's installed.
+# The singleline editor module or multiline editor module can be used with irb.
+# Use of multiline editor is default if it's installed.
 #
 # == Command line options
 #
@@ -61,10 +61,10 @@ require "irb/version"
 #     -W[level=2]       Same as `ruby -W`
 #     --inspect         Use `inspect' for output (default except for bc mode)
 #     --noinspect       Don't use inspect for output
-#     --reidline        Use Reidline extension module
-#     --noreidline      Don't use Reidline extension module
-#     --readline        Use Readline extension module
-#     --noreadline      Don't use Readline extension module
+#     --multiline       Use multiline editor module
+#     --nomultiline     Don't use multiline editor module
+#     --singleline      Use singleline editor module
+#     --nosingleline    Don't use singleline editor module
 #     --colorize        Use colorization
 #     --nocolorize      Don't use colorization
 #     --prompt prompt-mode
@@ -72,7 +72,7 @@ require "irb/version"
 #                       Switch prompt mode. Pre-defined prompt modes are
 #                       `default', `simple', `xmp' and `inf-ruby'
 #     --inf-ruby-mode   Use prompt appropriate for inf-ruby-mode on emacs.
-#                       Suppresses --reidline and --readline.
+#                       Suppresses --multiline and --singleline.
 #     --simple-prompt   Simple prompt mode
 #     --noprompt        No prompt mode
 #     --tracer          Display trace for each execution of commands.
@@ -100,8 +100,8 @@ require "irb/version"
 #     IRB.conf[:IRB_RC] = nil
 #     IRB.conf[:BACK_TRACE_LIMIT]=16
 #     IRB.conf[:USE_LOADER] = false
-#     IRB.conf[:USE_REIDLINE] = nil
-#     IRB.conf[:USE_READLINE] = nil
+#     IRB.conf[:USE_MULTILINE] = nil
+#     IRB.conf[:USE_SINGLELINE] = nil
 #     IRB.conf[:USE_COLORIZE] = true
 #     IRB.conf[:USE_TRACER] = false
 #     IRB.conf[:IGNORE_SIGINT] = true
@@ -124,7 +124,7 @@ require "irb/version"
 # === History
 #
 # By default, irb will store the last 1000 commands you used in
-# <code>~/.irb_history</code>.
+# <code>IRB.conf[:HISTORY_FILE]</code> (<code>~/.irb_history</code> by default).
 #
 # If you want to disable history, add the following to your +.irbrc+:
 #
@@ -132,6 +132,14 @@ require "irb/version"
 #
 # See IRB::Context#save_history= for more information.
 #
+# The history of _resuls_ of commands evaluated is not stored by default,
+# but can be turned on to be stored with this +.irbrc+ setting:
+#
+#     IRB.conf[:EVAL_HISTORY] = <number>
+#
+# See IRB::Context#eval_history= and History class. The history of command
+# results is not permanently saved in any file.
+#
 # == Customizing the IRB Prompt
 #
 # In order to customize the prompt, you can change the following Hash:
@@ -274,7 +282,9 @@ require "irb/version"
 # <code>_</code>::
 #   The value command executed, as a local variable
 # <code>__</code>::
-#   The history of evaluated commands
+#   The history of evaluated commands. Available only if
+#   <code>IRB.conf[:EVAL_HISTORY]</code> is not +nil+ (which is the default).
+#   See also IRB::Context#eval_history= and IRB::History.
 # <code>__[line_no]</code>::
 #   Returns the evaluation value at the given line number, +line_no+.
 #   If +line_no+ is a negative, the return value +line_no+ many lines before
@@ -441,8 +451,8 @@ module IRB
     # parsed as a :method_add_arg and the output won't be suppressed
 
     # Creates a new irb session
-    def initialize(workspace = nil, input_method = nil, output_method = nil)
-      @context = Context.new(self, workspace, input_method, output_method)
+    def initialize(workspace = nil, input_method = nil)
+      @context = Context.new(self, workspace, input_method)
       @context.main.extend ExtendCommandBundle
       @signal_status = :IN_IRB
       @scanner = RubyLex.new
@@ -526,7 +536,7 @@ module IRB
       @scanner.each_top_level_statement do |line, line_no|
         signal_status(:IN_EVAL) do
           begin
-            line.untaint
+            line.untaint if RUBY_VERSION < '2.7'
             @context.evaluate(line, line_no, exception: exc)
             output_value if @context.echo? && (@context.echo_on_assignment? || !assignment_expression?(line))
           rescue Interrupt => exc
@@ -756,7 +766,10 @@ module IRB
       # s-expression where the second selement of the top level array is an
       # array of parsed expressions. The first element of each expression is the
       # expression's type.
-      ASSIGNMENT_NODE_TYPES.include?(Ripper.sexp(line)&.dig(1,-1,0))
+      verbose, $VERBOSE = $VERBOSE, nil
+      result = ASSIGNMENT_NODE_TYPES.include?(Ripper.sexp(line)&.dig(1,-1,0))
+      $VERBOSE = verbose
+      result
     end
 
     ATTR_TTY = "\e[%sm"
@@ -850,6 +863,8 @@ class Binding
     IRB.setup(source_location[0], argv: [])
     workspace = IRB::WorkSpace.new(self)
     STDOUT.print(workspace.code_around_binding)
-    IRB::Irb.new(workspace).run(IRB.conf)
+    binding_irb = IRB::Irb.new(workspace)
+    binding_irb.context.irb_path = File.expand_path(source_location[0])
+    binding_irb.run(IRB.conf)
   end
 end

data/lib/irb/color.rb

@@ -30,7 +30,7 @@ module IRB # :nodoc:
       # backtick and regexp as red (string's color, because they're sharing tokens).
       TOKEN_SEQ_EXPRS = {
         on_CHAR:            [[BLUE, BOLD],            ALL],
-        on_backtick:        [[RED],                   ALL],
+        on_backtick:        [[RED, BOLD],             ALL],
         on_comment:         [[BLUE, BOLD],            ALL],
         on_const:           [[BLUE, BOLD, UNDERLINE], ALL],
         on_embexpr_beg:     [[RED],                   ALL],
@@ -45,17 +45,18 @@ module IRB # :nodoc:
         on_int:             [[BLUE, BOLD],            ALL],
         on_kw:              [[GREEN],                 ALL],
         on_label:           [[MAGENTA],               ALL],
-        on_label_end:       [[RED],                   ALL],
-        on_qsymbols_beg:    [[RED],                   ALL],
-        on_qwords_beg:      [[RED],                   ALL],
+        on_label_end:       [[RED, BOLD],             ALL],
+        on_qsymbols_beg:    [[RED, BOLD],             ALL],
+        on_qwords_beg:      [[RED, BOLD],             ALL],
         on_rational:        [[BLUE, BOLD],            ALL],
         on_regexp_beg:      [[RED, BOLD],             ALL],
         on_regexp_end:      [[RED, BOLD],             ALL],
         on_symbeg:          [[YELLOW],                ALL],
-        on_tstring_beg:     [[RED],                   ALL],
+        on_symbols_beg:     [[RED, BOLD],             ALL],
+        on_tstring_beg:     [[RED, BOLD],             ALL],
         on_tstring_content: [[RED],                   ALL],
-        on_tstring_end:     [[RED],                   ALL],
-        on_words_beg:       [[RED],                   ALL],
+        on_tstring_end:     [[RED, BOLD],             ALL],
+        on_words_beg:       [[RED, BOLD],             ALL],
         on_parse_error:     [[RED, REVERSE],          ALL],
         compile_error:      [[RED, REVERSE],          ALL],
       }
@@ -70,16 +71,20 @@ module IRB # :nodoc:
         $stdout.tty? && supported? && (/mswin|mingw/ =~ RUBY_PLATFORM || (ENV.key?('TERM') && ENV['TERM'] != 'dumb'))
       end
 
-      def inspect_colorable?(obj)
+      def inspect_colorable?(obj, seen: {})
         case obj
         when String, Symbol, Regexp, Integer, Float, FalseClass, TrueClass, NilClass
           true
         when Hash
-          obj.all? { |k, v| inspect_colorable?(k) && inspect_colorable?(v) }
+          without_circular_ref(obj, seen: seen) do
+            obj.all? { |k, v| inspect_colorable?(k, seen: seen) && inspect_colorable?(v, seen: seen) }
+          end
         when Array
-          obj.all? { |o| inspect_colorable?(o) }
+          without_circular_ref(obj, seen: seen) do
+            obj.all? { |o| inspect_colorable?(o, seen: seen) }
+          end
         when Range
-          inspect_colorable?(obj.begin) && inspect_colorable?(obj.end)
+          inspect_colorable?(obj.begin, seen: seen) && inspect_colorable?(obj.end, seen: seen)
         when Module
           !obj.name.nil?
         else
@@ -132,6 +137,14 @@ module IRB # :nodoc:
 
       private
 
+      def without_circular_ref(obj, seen:, &block)
+        return false if seen.key?(obj.object_id)
+        seen[obj.object_id] = true
+        block.call
+      ensure
+        seen.delete(obj.object_id)
+      end
+
       # Ripper::Lexer::Elem#state is supported on Ruby 2.5+
       def supported?
         return @supported if defined?(@supported)
@@ -141,6 +154,7 @@ module IRB # :nodoc:
       def scan(code, allow_last_error:)
         pos = [1, 0]
 
+        verbose, $VERBOSE = $VERBOSE, nil
         lexer = Ripper::Lexer.new(code)
         if lexer.respond_to?(:scan) # Ruby 2.7+
           lexer.scan.each do |elem|
@@ -164,6 +178,7 @@ module IRB # :nodoc:
             yield(elem.event, elem.tok, elem.state)
           end
         end
+        $VERBOSE = verbose
       end
 
       def dispatch_seq(token, expr, str, in_symbol:)
@@ -192,7 +207,7 @@ module IRB # :nodoc:
       def scan_token(token)
         prev_state = @stack.last
         case token
-        when :on_symbeg
+        when :on_symbeg, :on_symbols_beg, :on_qsymbols_beg
           @stack << true
         when :on_ident, :on_op, :on_const, :on_ivar, :on_cvar, :on_gvar, :on_kw
           if @stack.last # Pop only when it's Symbol

data/lib/irb/context.rb

@@ -25,7 +25,7 @@ module IRB
     # +nil+::     uses stdin or Reidline or Readline
     # +String+::  uses a File
     # +other+::   uses this as InputMethod
-    def initialize(irb, workspace = nil, input_method = nil, output_method = nil)
+    def initialize(irb, workspace = nil, input_method = nil)
       @irb = irb
       if workspace
         @workspace = workspace
@@ -39,8 +39,20 @@ module IRB
       @rc = IRB.conf[:RC]
       @load_modules = IRB.conf[:LOAD_MODULES]
 
-      @use_readline = IRB.conf[:USE_READLINE]
-      @use_reidline = IRB.conf[:USE_REIDLINE]
+      if IRB.conf.has_key?(:USE_SINGLELINE)
+        @use_singleline = IRB.conf[:USE_SINGLELINE]
+      elsif IRB.conf.has_key?(:USE_READLINE) # backward compatibility
+        @use_singleline = IRB.conf[:USE_READLINE]
+      else
+        @use_singleline = nil
+      end
+      if IRB.conf.has_key?(:USE_MULTILINE)
+        @use_multiline = IRB.conf[:USE_MULTILINE]
+      elsif IRB.conf.has_key?(:USE_REIDLINE) # backward compatibility
+        @use_multiline = IRB.conf[:USE_REIDLINE]
+      else
+        @use_multiline = nil
+      end
       @use_colorize = IRB.conf[:USE_COLORIZE]
       @verbose = IRB.conf[:VERBOSE]
       @io = nil
@@ -67,9 +79,9 @@ module IRB
       case input_method
       when nil
         @io = nil
-        case use_reidline?
+        case use_multiline?
         when nil
-          if STDIN.tty? && IRB.conf[:PROMPT_MODE] != :INF_RUBY && !use_readline?
+          if STDIN.tty? && IRB.conf[:PROMPT_MODE] != :INF_RUBY && !use_singleline?
             @io = ReidlineInputMethod.new
           else
             @io = nil
@@ -80,7 +92,7 @@ module IRB
           @io = ReidlineInputMethod.new
         end
         unless @io
-          case use_readline?
+          case use_singleline?
           when nil
             if (defined?(ReadlineInputMethod) && STDIN.tty? &&
                 IRB.conf[:PROMPT_MODE] != :INF_RUBY)
@@ -111,12 +123,6 @@ module IRB
       end
       self.save_history = IRB.conf[:SAVE_HISTORY] if IRB.conf[:SAVE_HISTORY]
 
-      if output_method
-        @output_method = output_method
-      else
-        @output_method = StdioOutputMethod.new
-      end
-
       @echo = IRB.conf[:ECHO]
       if @echo.nil?
         @echo = true
@@ -161,18 +167,14 @@ module IRB
     # +input_method+ passed to Context.new
     attr_accessor :irb_path
 
-    # Whether +Reidline+ is enabled or not.
-    #
-    # A copy of the default <code>IRB.conf[:USE_REIDLINE]</code>
+    # Whether multiline editor mode is enabled or not.
     #
-    # See #use_reidline= for more information.
-    attr_reader :use_reidline
-    # Whether +Readline+ is enabled or not.
+    # A copy of the default <code>IRB.conf[:USE_MULTILINE]</code>
+    attr_reader :use_multiline
+    # Whether singleline editor mode is enabled or not.
     #
-    # A copy of the default <code>IRB.conf[:USE_READLINE]</code>
-    #
-    # See #use_readline= for more information.
-    attr_reader :use_readline
+    # A copy of the default <code>IRB.conf[:USE_SINGLELINE]</code>
+    attr_reader :use_singleline
     # Whether colorization is enabled or not.
     #
     # A copy of the default <code>IRB.conf[:USE_COLORIZE]</code>
@@ -264,10 +266,18 @@ module IRB
     # See IRB@Command+line+options for more command line options.
     attr_accessor :back_trace_limit
 
-    # Alias for #use_reidline
-    alias use_reidline? use_reidline
-    # Alias for #use_readline
-    alias use_readline? use_readline
+    # Alias for #use_multiline
+    alias use_multiline? use_multiline
+    # Alias for #use_singleline
+    alias use_singleline? use_singleline
+    # backward compatibility
+    alias use_reidline use_multiline
+    # backward compatibility
+    alias use_reidline? use_multiline
+    # backward compatibility
+    alias use_readline use_singleline
+    # backward compatibility
+    alias use_readline? use_singleline
     # Alias for #use_colorize
     alias use_colorize? use_colorize
     # Alias for #rc
@@ -398,17 +408,6 @@ module IRB
       @inspect_mode
     end
 
-    # Obsolete method.
-    #
-    # Can be set using the +--noreadline+ and +--readline+ command line
-    # options.
-    #
-    # See IRB@Command+line+options for more command line options.
-    def use_readline=(opt)
-      print "This method is obsolete."
-      print "Do nothing."
-    end
-
     def evaluate(line, line_no, exception: nil) # :nodoc:
       @line_no = line_no
       if exception

data/lib/irb/ext/history.rb

@@ -31,9 +31,12 @@ module IRB # :nodoc:
     end
 
     remove_method :eval_history= if method_defined?(:eval_history=)
-    # The command result history limit.
+    # The command result history limit. This method is not available until
+    # #eval_history= was called with non-nil value (directly or via
+    # setting <code>IRB.conf[:EVAL_HISTORY]</code> in <code>.irbrc</code>).
     attr_reader :eval_history
-    # Sets command result history limit.
+    # Sets command result history limit. Default value is set from
+    # <code>IRB.conf[:EVAL_HISTORY]</code>.
     #
     # +no+ is an Integer or +nil+.
     #
@@ -42,6 +45,9 @@ module IRB # :nodoc:
     # If +no+ is 0, the number of history items is unlimited.
     #
     # If +no+ is +nil+, execution result history isn't used (default).
+    #
+    # History values are available via <code>__</code> variable, see
+    # IRB::History.
     def eval_history=(no)
       if no
         if defined?(@eval_history) && @eval_history
@@ -59,20 +65,51 @@ module IRB # :nodoc:
     end
   end
 
-  class History # :nodoc:
-
-    def initialize(size = 16)
+  # Represents history of results of previously evaluated commands.
+  #
+  # Available via <code>__</code> variable, only if <code>IRB.conf[:EVAL_HISTORY]</code>
+  # or <code>IRB::CurrentContext().eval_history</code> is non-nil integer value
+  # (by default it is +nil+).
+  #
+  # Example (in `irb`):
+  #
+  #    # Initialize history
+  #    IRB::CurrentContext().eval_history = 10
+  #    # => 10
+  #
+  #    # Perform some commands...
+  #    1 + 2
+  #    # => 3
+  #    puts 'x'
+  #    # x
+  #    # => nil
+  #    raise RuntimeError
+  #    # ...error raised
+  #
+  #    # Inspect history (format is "<item number> <evaluated value>":
+  #    __
+  #    # => 1 10
+  #    # 2 3
+  #    # 3 nil
+  #
+  #    __[1]
+  #    # => 10
+  #
+  class History
+
+    def initialize(size = 16)  # :nodoc:
       @size = size
       @contents = []
     end
 
-    def size(size)
+    def size(size) # :nodoc:
       if size != 0 && size < @size
         @contents = @contents[@size - size .. @size]
       end
       @size = size
     end
 
+    # Get one item of the content (both positive and negative indexes work).
     def [](idx)
       begin
         if idx >= 0
@@ -85,14 +122,14 @@ module IRB # :nodoc:
       end
     end
 
-    def push(no, val)
+    def push(no, val)  # :nodoc:
       @contents.push [no, val]
       @contents.shift if @size != 0 && @contents.size > @size
     end
 
     alias real_inspect inspect
 
-    def inspect
+    def inspect  # :nodoc:
       if @contents.empty?
         return real_inspect
       end