irb 1.14.3 → 1.18.0

data/lib/irb/command/internal_helpers.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'prism'
+
 module IRB
   module Command
     # Internal use only, for default command's backward compatibility.
@@ -7,9 +9,10 @@ module IRB
       def unwrap_string_literal(str)
         return if str.empty?
 
-        sexp = Ripper.sexp(str)
-        if sexp && sexp.size == 2 && sexp.last&.first&.first == :string_literal
-          @irb_context.workspace.binding.eval(str).to_s
+        result = Prism.parse(str)
+        body = result.value.statements.body
+        if result.success? && body.size == 1 && body.first.is_a?(Prism::StringNode)
+          body.first.unescaped
         else
           str
         end

data/lib/irb/command/ls.rb

@@ -55,11 +55,13 @@ module IRB
 
         o = Output.new(grep: grep)
 
-        klass  = (obj.class == Class || obj.class == Module ? obj : obj.class)
+        klass = Kernel.instance_method(:class).bind(obj).call
+        obj_is_class_or_module = Module === obj
+        klass = obj_is_class_or_module ? obj : klass
 
-        o.dump("constants", obj.constants) if obj.respond_to?(:constants)
+        o.dump("constants", obj.constants) if obj_is_class_or_module
         dump_methods(o, klass, obj)
-        o.dump("instance variables", obj.instance_variables)
+        o.dump("instance variables", Kernel.instance_method(:instance_variables).bind(obj).call)
         o.dump("class variables", klass.class_variables)
         o.dump("locals", locals) if locals
         o.print_result
@@ -67,7 +69,7 @@ module IRB
       end
 
       def dump_methods(o, klass, obj)
-        singleton_class = begin obj.singleton_class; rescue TypeError; nil end
+        singleton_class = begin Kernel.instance_method(:singleton_class).bind(obj).call; rescue TypeError; nil end
         dumped_mods = Array.new
         ancestors = klass.ancestors
         ancestors = ancestors.reject { |c| c >= Object } if klass < Object

data/lib/irb/completion.rb

@@ -8,30 +8,33 @@
 require_relative 'ruby-lex'
 
 module IRB
+  class DocumentTarget # :nodoc:
+    attr_reader :name
+
+    def initialize(name)
+      @name = name
+    end
+  end
+
+  class CommandDocument < DocumentTarget # :nodoc:
+  end
+
+  # Represents a method/class documentation target. May hold multiple names
+  # when the receiver is ambiguous (e.g. `{}.any?` could be Hash#any? or Proc#any?).
+  # The dialog popup uses only the first name; the full-screen display renders all.
+  class MethodDocument < DocumentTarget # :nodoc:
+    attr_reader :names
+
+    def initialize(*names)
+      super(names.first)
+      @names = names
+    end
+  end
+
   class BaseCompletor # :nodoc:
 
     # Set of reserved words used by Ruby, you should not use these for
     # constants or variables
-    ReservedWords = %w[
-      __ENCODING__ __LINE__ __FILE__
-      BEGIN END
-      alias and
-      begin break
-      case class
-      def defined? do
-      else elsif end ensure
-      false for
-      if in
-      module
-      next nil not
-      or
-      redo rescue retry return
-      self super
-      then true
-      undef unless until
-      when while
-      yield
-    ]
 
     HELP_COMMAND_PREPOSING = /\Ahelp\s+/
 
@@ -60,13 +63,13 @@ module IRB
 
     def retrieve_gem_and_system_load_path
       candidates = (GEM_PATHS | $LOAD_PATH)
-      candidates.map do |p|
+      candidates.filter_map do |p|
         if p.respond_to?(:to_path)
           p.to_path
         else
           String(p) rescue nil
         end
-      end.compact.sort
+      end.sort
     end
 
     def retrieve_files_to_require_from_load_path
@@ -96,6 +99,12 @@ module IRB
       end
     end
 
+    def command_document_target(preposing, matched)
+      if preposing.empty? && IRB::Command.command_names.include?(matched)
+        CommandDocument.new(matched)
+      end
+    end
+
     def retrieve_files_to_require_relative_from_current_dir
       @files_from_current_dir ||= Dir.glob("**/*.{rb,#{RbConfig::CONFIG['DLEXT']}}", base: '.').map { |path|
         path.sub(/\.(rb|#{RbConfig::CONFIG['DLEXT']})\z/, '')
@@ -127,12 +136,21 @@ module IRB
 
       return commands unless result
 
-      commands | result.completion_candidates.map { target + _1 }
+      encoded_candidates = result.completion_candidates.filter_map do |i|
+        encoded = i.encode(Encoding.default_external)
+        target + encoded
+      rescue Encoding::UndefinedConversionError
+        # If the string cannot be converted, we just ignore it
+        nil
+      end
+      commands | encoded_candidates
     end
 
     def doc_namespace(preposing, matched, _postposing, bind:)
-      result = ReplTypeCompletor.analyze(preposing + matched, binding: bind, filename: @context.irb_path)
-      result&.doc_namespace('')
+      command_document_target(preposing, matched) || begin
+        result = ReplTypeCompletor.analyze(preposing + matched, binding: bind, filename: @context.irb_path)
+        result&.doc_namespace('')
+      end
     end
   end
 
@@ -179,28 +197,15 @@ module IRB
       else
         return nil # It's not String literal
       end
-      tokens = RubyLex.ripper_lex_without_warning(preposing.gsub(/\s*\z/, ''))
-      tok = nil
-      tokens.reverse_each do |t|
-        unless [:on_lparen, :on_sp, :on_ignored_sp, :on_nl, :on_ignored_nl, :on_comment].include?(t.event)
-          tok = t
-          break
-        end
-      end
-      return unless tok&.event == :on_ident && tok.state == Ripper::EXPR_CMDARG
-
-      case tok.tok
-      when 'require'
-        retrieve_files_to_require_from_load_path.select { |path|
-          path.start_with?(actual_target)
-        }.map { |path|
-          quote + path
+
+      case preposing
+      when /(^|[^\w])require\(? *\z/
+        retrieve_files_to_require_from_load_path.filter_map { |path|
+          quote + path if path.start_with?(actual_target)
         }
-      when 'require_relative'
-        retrieve_files_to_require_relative_from_current_dir.select { |path|
-          path.start_with?(actual_target)
-        }.map { |path|
-          quote + path
+      when /(^|[^\w])require_relative\(? *\z/
+        retrieve_files_to_require_relative_from_current_dir.filter_map { |path|
+          quote + path if path.start_with?(actual_target)
         }
       end
     end
@@ -218,12 +223,17 @@ module IRB
       # It doesn't make sense to propose commands with other preposing
       commands = [] unless preposing.empty?
 
-      completion_data = retrieve_completion_data(target, bind: bind, doc_namespace: false).compact.map{ |i| i.encode(Encoding.default_external) }
+      completion_data = retrieve_completion_data(target, bind: bind, doc_namespace: false).compact.filter_map do |i|
+        i.encode(Encoding.default_external)
+      rescue Encoding::UndefinedConversionError
+        # If the string cannot be converted, we just ignore it
+        nil
+      end
       commands | completion_data
     end
 
-    def doc_namespace(_preposing, matched, _postposing, bind:)
-      retrieve_completion_data(matched, bind: bind, doc_namespace: true)
+    def doc_namespace(preposing, matched, _postposing, bind:)
+      command_document_target(preposing, matched) || retrieve_completion_data(matched, bind: bind, doc_namespace: true)
     end
 
     def retrieve_completion_data(input, bind:, doc_namespace:)
@@ -287,7 +297,7 @@ module IRB
           nil
         else
           sym = $1
-          candidates = Symbol.all_symbols.collect do |s|
+          candidates = Symbol.all_symbols.filter_map do |s|
             s.inspect
           rescue EncodingError
             # ignore
@@ -459,12 +469,19 @@ module IRB
             eval("#{perfect_match_var}.class.name", bind) rescue nil
           else
             candidates = (bind.eval_methods | bind.eval_private_methods | bind.local_variables | bind.eval_instance_variables | bind.eval_class_constants).collect{|m| m.to_s}
-            candidates |= ReservedWords
+            candidates |= RubyLex::RESERVED_WORDS.map(&:to_s)
             candidates.find{ |i| i == input }
           end
         else
           candidates = (bind.eval_methods | bind.eval_private_methods | bind.local_variables | bind.eval_instance_variables | bind.eval_class_constants).collect{|m| m.to_s}
-          candidates |= ReservedWords
+          candidates |= RubyLex::RESERVED_WORDS.map(&:to_s)
+
+          target_encoding = Encoding.default_external
+          candidates = candidates.compact.filter_map do |candidate|
+            candidate.encoding == target_encoding ? candidate : candidate.encode(target_encoding)
+          rescue EncodingError
+            nil
+          end
           candidates.grep(/^#{Regexp.quote(input)}/).sort
         end
       end

data/lib/irb/context.rb

@@ -155,11 +155,6 @@ module IRB
       @command_aliases = IRB.conf[:COMMAND_ALIASES].dup
     end
 
-    private def term_interactive?
-      return true if ENV['TEST_IRB_FORCE_INTERACTIVE']
-      STDIN.tty? && ENV['TERM'] != 'dumb'
-    end
-
     def use_tracer=(val)
       require_relative "ext/tracer" if val
       IRB.conf[:USE_TRACER] = val
@@ -177,45 +172,6 @@ module IRB
       __send__(__method__, val)
     end
 
-    private def build_completor
-      completor_type = IRB.conf[:COMPLETOR]
-
-      # Gem repl_type_completor is added to bundled gems in Ruby 3.4.
-      # Use :type as default completor only in Ruby 3.4 or later.
-      verbose = !!completor_type
-      completor_type ||= RUBY_VERSION >= '3.4' ? :type : :regexp
-
-      case completor_type
-      when :regexp
-        return RegexpCompletor.new
-      when :type
-        completor = build_type_completor(verbose: verbose)
-        return completor if completor
-      else
-        warn "Invalid value for IRB.conf[:COMPLETOR]: #{completor_type}"
-      end
-      # Fallback to RegexpCompletor
-      RegexpCompletor.new
-    end
-
-    private def build_type_completor(verbose:)
-      if RUBY_ENGINE == 'truffleruby'
-        # Avoid SyntaxError. truffleruby does not support endless method definition yet.
-        warn 'TypeCompletor is not supported on TruffleRuby yet' if verbose
-        return
-      end
-
-      begin
-        require 'repl_type_completor'
-      rescue LoadError => e
-        warn "TypeCompletor requires `gem repl_type_completor`: #{e.message}" if verbose
-        return
-      end
-
-      ReplTypeCompletor.preload_rbs
-      TypeCompletor.new(self)
-    end
-
     def save_history=(val)
       IRB.conf[:SAVE_HISTORY] = val
     end
@@ -308,6 +264,8 @@ module IRB
     attr_reader :use_autocomplete
     # A copy of the default <code>IRB.conf[:INSPECT_MODE]</code>
     attr_reader :inspect_mode
+    # Inspector for the current context
+    attr_reader :inspect_method
 
     # A copy of the default <code>IRB.conf[:PROMPT_MODE]</code>
     attr_reader :prompt_mode
@@ -600,6 +558,8 @@ module IRB
         set_last_value(result)
       when Statement::Command
         statement.command_class.execute(self, statement.arg)
+      when Statement::IncorrectAlias
+        warn statement.message
       end
 
       nil
@@ -633,37 +593,63 @@ module IRB
       result
     end
 
-    def parse_command(code)
+    def parse_input(code, is_assignment_expression)
       command_name, arg = code.strip.split(/\s+/, 2)
-      return unless code.lines.size == 1 && command_name
-
       arg ||= ''
-      command = command_name.to_sym
-      # Command aliases are always command. example: $, @
-      if (alias_name = command_aliases[command])
-        return [alias_name, arg]
+
+      # command can only be 1 line
+      if code.lines.size != 1 ||
+        # command name is required
+        command_name.nil? ||
+        # local variable have precedence over command
+        local_variables.include?(command_name.to_sym) ||
+        # assignment expression is not a command
+        (is_assignment_expression ||
+        (arg.start_with?(ASSIGN_OPERATORS_REGEXP) && !arg.start_with?(/==|=~/)))
+        return Statement::Expression.new(code, is_assignment_expression)
       end
 
-      # Assignment-like expression is not a command
-      return if arg.start_with?(ASSIGN_OPERATORS_REGEXP) && !arg.start_with?(/==|=~/)
+      command = command_name.to_sym
 
-      # Local variable have precedence over command
-      return if local_variables.include?(command)
+      # Check command aliases
+      if aliased_name = command_aliases[command]
+        if command_class = Command.load_command(aliased_name)
+          command = aliased_name
+        elsif HelperMethod.helper_methods[aliased_name]
+          message = <<~MESSAGE
+            Using command alias `#{command}` for helper method `#{aliased_name}` is not supported.
+            Please check the value of `IRB.conf[:COMMAND_ALIASES]`.
+          MESSAGE
+          return Statement::IncorrectAlias.new(message)
+        else
+          message = <<~MESSAGE
+            You're trying to use command alias `#{command}` for command `#{aliased_name}`, but `#{aliased_name}` does not exist.
+            Please check the value of `IRB.conf[:COMMAND_ALIASES]`.
+          MESSAGE
+          return Statement::IncorrectAlias.new(message)
+        end
+      else
+        command_class = Command.load_command(command)
+      end
 
-      # Check visibility
-      public_method = !!KERNEL_PUBLIC_METHOD.bind_call(main, command) rescue false
-      private_method = !public_method && !!KERNEL_METHOD.bind_call(main, command) rescue false
-      if Command.execute_as_command?(command, public_method: public_method, private_method: private_method)
-        [command, arg]
+      if command_class
+        # Check whether the command conflicts with existing methods
+        public_method = !!KERNEL_PUBLIC_METHOD.bind_call(main, command) rescue false
+        private_method = !public_method && !!KERNEL_METHOD.bind_call(main, command) rescue false
+        if Command.execute_as_command?(command, public_method: public_method, private_method: private_method)
+          return Statement::Command.new(code, command_class, arg)
+        end
       end
+      Statement::Expression.new(code, is_assignment_expression)
     end
 
     def colorize_input(input, complete:)
       if IRB.conf[:USE_COLORIZE] && IRB::Color.colorable?
         lvars = local_variables || []
-        if parse_command(input)
+        parsed_input = parse_input(input, false)
+        if parsed_input.is_a?(Statement::Command)
           name, sep, arg = input.split(/(\s+)/, 2)
-          arg = IRB::Color.colorize_code(arg, complete: complete, local_variables: lvars)
+          arg = IRB::Color.colorize_code(arg, complete: complete, local_variables: lvars) if arg
           "#{IRB::Color.colorize(name, [:BOLD])}\e[m#{sep}#{arg}"
         else
           IRB::Color.colorize_code(input, complete: complete, local_variables: lvars)
@@ -673,8 +659,12 @@ module IRB
       end
     end
 
-    def inspect_last_value # :nodoc:
-      @inspect_method.inspect_value(@last_value)
+    def inspect_last_value(output = +'') # :nodoc:
+      @inspect_method.inspect_value(@last_value, output)
+    end
+
+    def inspector_support_stream_output?
+      @inspect_method.support_stream_output?
     end
 
     NOPRINTING_IVARS = ["@last_value"] # :nodoc:
@@ -712,5 +702,51 @@ module IRB
       main_object = main
       Object === main_object ? main_object.__send__(method_name) : Object.instance_method(method_name).bind_call(main_object)
     end
+
+    private
+
+    def term_interactive?
+      return true if ENV['TEST_IRB_FORCE_INTERACTIVE']
+      STDIN.tty? && ENV['TERM'] != 'dumb'
+    end
+
+    def build_completor
+      completor_type = IRB.conf[:COMPLETOR]
+
+      # Gem repl_type_completor is added to bundled gems in Ruby 3.4.
+      # Use :type as default completor only in Ruby 3.4 or later.
+      verbose = !!completor_type
+      completor_type ||= RUBY_VERSION >= '3.4' ? :type : :regexp
+
+      case completor_type
+      when :regexp
+        return RegexpCompletor.new
+      when :type
+        completor = build_type_completor(verbose: verbose)
+        return completor if completor
+      else
+        warn "Invalid value for IRB.conf[:COMPLETOR]: #{completor_type}"
+      end
+      # Fallback to RegexpCompletor
+      RegexpCompletor.new
+    end
+
+    def build_type_completor(verbose:)
+      if RUBY_ENGINE == 'truffleruby'
+        # Avoid SyntaxError. truffleruby does not support endless method definition yet.
+        warn 'TypeCompletor is not supported on TruffleRuby yet' if verbose
+        return
+      end
+
+      begin
+        require 'repl_type_completor'
+      rescue LoadError => e
+        warn "TypeCompletor requires `gem repl_type_completor`: #{e.message}" if verbose
+        return
+      end
+
+      ReplTypeCompletor.preload_rbs
+      TypeCompletor.new(self)
+    end
   end
 end

data/lib/irb/debug.rb

@@ -49,7 +49,7 @@ module IRB
           def DEBUGGER__.capture_frames(*args)
             frames = capture_frames_without_irb(*args)
             frames.reject! do |frame|
-              frame.realpath&.start_with?(IRB_DIR) || frame.path == "<internal:prelude>"
+              frame.realpath&.start_with?(IRB_DIR) || frame.path&.start_with?("<internal:")
             end
             frames
           end
@@ -60,7 +60,7 @@ module IRB
         if !DEBUGGER__::CONFIG[:no_hint] && irb.context.io.is_a?(RelineInputMethod)
           Reline.output_modifier_proc = proc do |input, complete:|
             unless input.strip.empty?
-              cmd = input.split(/\s/, 2).first
+              cmd = input[/\S+/]
 
               if !complete && DEBUGGER__.commands.key?(cmd)
                 input = input.sub(/\n$/, " # debug command\n")
@@ -87,7 +87,7 @@ module IRB
       module SkipPathHelperForIRB
         def skip_internal_path?(path)
           # The latter can be removed once https://github.com/ruby/debug/issues/866 is resolved
-          super || path.match?(IRB_DIR) || path.match?('<internal:prelude>')
+          super || path&.match?(IRB_DIR) || path&.match?('<internal:prelude>')
         end
       end
 

data/lib/irb/default_commands.rb

@@ -9,6 +9,7 @@ require_relative "command/cd"
 require_relative "command/chws"
 require_relative "command/context"
 require_relative "command/continue"
+require_relative "command/copy"
 require_relative "command/debug"
 require_relative "command/delete"
 require_relative "command/disable_irb"
@@ -218,7 +219,8 @@ module IRB
     )
 
     _register_with_aliases(:irb_show_doc, Command::ShowDoc,
-      [:show_doc, NO_OVERRIDE]
+      [:show_doc, NO_OVERRIDE],
+      [:ri, NO_OVERRIDE]
     )
 
     _register_with_aliases(:irb_info, Command::IrbInfo)
@@ -249,6 +251,7 @@ module IRB
     )
 
     register(:cd, Command::CD)
+    register(:copy, Command::Copy)
   end
 
   ExtendCommand = Command

data/lib/irb/easter-egg.rb

@@ -121,12 +121,13 @@ module IRB
           interrupted = false
           prev_trap = trap("SIGINT") { interrupted = true }
           canvas = Canvas.new(Reline.get_screen_size)
+          otio = Reline::IOGate.prep
           Reline::IOGate.set_winch_handler do
             canvas = Canvas.new(Reline.get_screen_size)
           end
           ruby_model = RubyModel.new
           print "\e[?25l" # hide cursor
-          0.step do |i| # TODO (0..).each needs Ruby 2.6 or later
+          (0..).each do |i|
             buff = canvas.draw do
               ruby_model.render_frame(i) do |p1, p2|
                 canvas.line(p1, p2)
@@ -139,6 +140,7 @@ module IRB
           end
         rescue Interrupt
         ensure
+          Reline::IOGate.deprep(otio)
           print "\e[?25h" # show cursor
           trap("SIGINT", prev_trap)
         end

data/lib/irb/ext/multi-irb.rb

@@ -65,6 +65,7 @@ module IRB
       @current_job = irb
       th.run
       Thread.stop
+      Thread.pass
       @current_job = irb(Thread.current)
     end
 
@@ -220,6 +221,7 @@ module IRB
       end
     end
     Thread.stop
+    Thread.pass
     @JobManager.current_job = @JobManager.irb(Thread.current)
   end
 

data/lib/irb/history.rb

@@ -2,9 +2,13 @@ require "pathname"
 
 module IRB
   module History
+    DEFAULT_ENTRY_LIMIT = 1000
+
     class << self
       # Integer representation of <code>IRB.conf[:HISTORY_FILE]</code>.
       def save_history
+        return 0 if IRB.conf[:SAVE_HISTORY] == false
+        return DEFAULT_ENTRY_LIMIT if IRB.conf[:SAVE_HISTORY] == true
         IRB.conf[:SAVE_HISTORY].to_i
       end
 

data/lib/irb/init.rb

@@ -87,13 +87,14 @@ module IRB # :nodoc:
     @CONF[:IGNORE_SIGINT] = true
     @CONF[:IGNORE_EOF] = false
     @CONF[:USE_PAGER] = true
+    @CONF[:SHOW_BANNER] = true
     @CONF[:EXTRA_DOC_DIRS] = []
     @CONF[:ECHO] = nil
     @CONF[:ECHO_ON_ASSIGNMENT] = nil
     @CONF[:VERBOSE] = nil
 
     @CONF[:EVAL_HISTORY] = nil
-    @CONF[:SAVE_HISTORY] = 1000
+    @CONF[:SAVE_HISTORY] = History::DEFAULT_ENTRY_LIMIT
 
     @CONF[:BACK_TRACE_LIMIT] = 16
 
@@ -194,6 +195,8 @@ module IRB # :nodoc:
       :'$' => :show_source,
       :'@' => :whereami,
     }
+
+    @CONF[:COPY_COMMAND] = ENV.fetch("IRB_COPY_COMMAND", nil)
   end
 
   def IRB.set_measure_callback(type = nil, arg = nil, &block)
@@ -343,6 +346,8 @@ module IRB # :nodoc:
         opt = $1 || argv.shift
         prompt_mode = opt.upcase.tr("-", "_").intern
         @CONF[:PROMPT_MODE] = prompt_mode
+      when "--nobanner"
+        @CONF[:SHOW_BANNER] = false
       when "--noprompt"
         @CONF[:PROMPT_MODE] = :NULL
       when "--script"