irb 1.13.2 → 1.15.2

data/lib/irb/command/history.rb

@@ -14,7 +14,7 @@ module IRB
 
       def execute(arg)
 
-        if (match = arg&.match(/(-g|-G)\s+(?<grep>.+)\s*\n\z/))
+        if (match = arg&.match(/(-g|-G)\s+(?<grep>.+)\s*\z/))
           grep = Regexp.new(match[:grep])
         end
 

data/lib/irb/command/internal_helpers.rb

@@ -19,7 +19,7 @@ module IRB
         # Use throw and catch to handle arg that includes `;`
         # For example: "1, kw: (2; 3); 4" will be parsed to [[1], { kw: 3 }]
         catch(:EXTRACT_RUBY_ARGS) do
-          @irb_context.workspace.binding.eval "IRB::Command.extract_ruby_args #{arg}"
+          @irb_context.workspace.binding.eval "::IRB::Command.extract_ruby_args #{arg}"
         end || [[], {}]
       end
     end

data/lib/irb/command/ls.rb

@@ -11,7 +11,7 @@ module IRB
 
   module Command
     class Ls < Base
-      include RubyArgsExtractor
+      class EvaluationError < StandardError; end
 
       category "Context"
       description "Show methods, constants, and variables."
@@ -22,24 +22,35 @@ module IRB
           -g [query]  Filter the output with a query.
       HELP_MESSAGE
 
+      def evaluate(code)
+        @irb_context.workspace.binding.eval(code)
+      rescue Exception => e
+        puts "#{e.class}: #{e.message}"
+        raise EvaluationError
+      end
+
       def execute(arg)
         if match = arg.match(/\A(?<target>.+\s|)(-g|-G)\s+(?<grep>.+)$/)
-          if match[:target].empty?
-            use_main = true
-          else
-            obj = @irb_context.workspace.binding.eval(match[:target])
-          end
+          target = match[:target]
           grep = Regexp.new(match[:grep])
+        elsif match = arg.match(/\A((?<target>.+),|)\s*grep:(?<grep>.+)/)
+          # Legacy style `ls obj, grep: /regexp/`
+          # Evaluation order should be eval(target) then eval(grep)
+          target = match[:target] || ''
+          grep_regexp_code = match[:grep]
         else
-          args, kwargs = ruby_args(arg)
-          use_main = args.empty?
-          obj = args.first
-          grep = kwargs[:grep]
+          target = arg.strip
         end
 
-        if use_main
+        if target.empty?
           obj = irb_context.workspace.main
           locals = irb_context.workspace.binding.local_variables
+        else
+          obj = evaluate(target)
+        end
+
+        if grep_regexp_code
+          grep = evaluate(grep_regexp_code)
         end
 
         o = Output.new(grep: grep)
@@ -52,6 +63,7 @@ module IRB
         o.dump("class variables", klass.class_variables)
         o.dump("locals", locals) if locals
         o.print_result
+      rescue EvaluationError
       end
 
       def dump_methods(o, klass, obj)

data/lib/irb/completion.rb

@@ -33,6 +33,8 @@ module IRB
       yield
     ]
 
+    HELP_COMMAND_PREPOSING = /\Ahelp\s+/
+
     def completion_candidates(preposing, target, postposing, bind:)
       raise NotImplementedError
     end
@@ -86,8 +88,8 @@ module IRB
         )
     end
 
-    def command_completions(preposing, target)
-      if preposing.empty? && !target.empty?
+    def command_candidates(target)
+      if !target.empty?
         IRB::Command.command_names.select { _1.start_with?(target) }
       else
         []
@@ -111,8 +113,18 @@ module IRB
     end
 
     def completion_candidates(preposing, target, _postposing, bind:)
-      commands = command_completions(preposing, target)
+      # When completing the argument of `help` command, only commands should be candidates
+      return command_candidates(target) if preposing.match?(HELP_COMMAND_PREPOSING)
+
+      commands = if preposing.empty?
+        command_candidates(target)
+      # It doesn't make sense to propose commands with other preposing
+      else
+        []
+      end
+
       result = ReplTypeCompletor.analyze(preposing + target, binding: bind, filename: @context.irb_path)
+
       return commands unless result
 
       commands | result.completion_candidates.map { target + _1 }
@@ -125,26 +137,33 @@ module IRB
   end
 
   class RegexpCompletor < BaseCompletor # :nodoc:
+    KERNEL_METHODS = ::Kernel.instance_method(:methods)
+    KERNEL_PRIVATE_METHODS = ::Kernel.instance_method(:private_methods)
+    KERNEL_INSTANCE_VARIABLES = ::Kernel.instance_method(:instance_variables)
+    OBJECT_CLASS_INSTANCE_METHOD = ::Object.instance_method(:class)
+    MODULE_CONSTANTS_INSTANCE_METHOD = ::Module.instance_method(:constants)
+
     using Module.new {
       refine ::Binding do
         def eval_methods
-          ::Kernel.instance_method(:methods).bind(eval("self")).call
+          KERNEL_METHODS.bind_call(receiver)
         end
 
         def eval_private_methods
-          ::Kernel.instance_method(:private_methods).bind(eval("self")).call
+          KERNEL_PRIVATE_METHODS.bind_call(receiver)
         end
 
         def eval_instance_variables
-          ::Kernel.instance_method(:instance_variables).bind(eval("self")).call
+          KERNEL_INSTANCE_VARIABLES.bind_call(receiver)
         end
 
         def eval_global_variables
-          ::Kernel.instance_method(:global_variables).bind(eval("self")).call
+          ::Kernel.global_variables
         end
 
         def eval_class_constants
-          ::Module.instance_method(:constants).bind(eval("self.class")).call
+          klass = OBJECT_CLASS_INSTANCE_METHOD.bind_call(receiver)
+          MODULE_CONSTANTS_INSTANCE_METHOD.bind_call(klass)
         end
       end
     }
@@ -187,12 +206,20 @@ module IRB
     end
 
     def completion_candidates(preposing, target, postposing, bind:)
-      if preposing && postposing
-        result = complete_require_path(target, preposing, postposing)
-        return result if result
+      if result = complete_require_path(target, preposing, postposing)
+        return result
       end
-      commands = command_completions(preposing || '', target)
-      commands | retrieve_completion_data(target, bind: bind, doc_namespace: false).compact.map{ |i| i.encode(Encoding.default_external) }
+
+      commands = command_candidates(target)
+
+      # When completing the argument of `help` command, only commands should be candidates
+      return commands if preposing.match?(HELP_COMMAND_PREPOSING)
+
+      # 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) }
+      commands | completion_data
     end
 
     def doc_namespace(_preposing, matched, _postposing, bind:)
@@ -470,7 +497,7 @@ module IRB
       end
     end
     CompletionProc = ->(target, preposing = nil, postposing = nil) {
-      regexp_completor.completion_candidates(preposing, target, postposing, bind: IRB.conf[:MAIN_CONTEXT].workspace.binding)
+      regexp_completor.completion_candidates(preposing || '', target, postposing || '', bind: IRB.conf[:MAIN_CONTEXT].workspace.binding)
     }
   end
   deprecate_constant :InputCompletor

data/lib/irb/context.rb

@@ -13,6 +13,10 @@ module IRB
   # A class that wraps the current state of the irb session, including the
   # configuration of IRB.conf.
   class Context
+    KERNEL_PUBLIC_METHOD = ::Kernel.instance_method(:public_method)
+    KERNEL_METHOD = ::Kernel.instance_method(:method)
+
+    ASSIGN_OPERATORS_REGEXP = Regexp.union(%w[= += -= *= /= %= **= &= |= &&= ||= ^= <<= >>=])
     # Creates a new IRB context.
     #
     # The optional +input_method+ argument:
@@ -148,26 +152,9 @@ module IRB
         @newline_before_multiline_output = true
       end
 
-      @user_aliases = IRB.conf[:COMMAND_ALIASES].dup
-      @command_aliases = @user_aliases.merge(KEYWORD_ALIASES)
-    end
-
-    private def term_interactive?
-      return true if ENV['TEST_IRB_FORCE_INTERACTIVE']
-      STDIN.tty? && ENV['TERM'] != 'dumb'
+      @command_aliases = IRB.conf[:COMMAND_ALIASES].dup
     end
 
-    # because all input will eventually be evaluated as Ruby code,
-    # command names that conflict with Ruby keywords need special workaround
-    # we can remove them once we implemented a better command system for IRB
-    KEYWORD_ALIASES = {
-      :break => :irb_break,
-      :catch => :irb_catch,
-      :next => :irb_next,
-    }.freeze
-
-    private_constant :KEYWORD_ALIASES
-
     def use_tracer=(val)
       require_relative "ext/tracer" if val
       IRB.conf[:USE_TRACER] = val
@@ -185,39 +172,6 @@ module IRB
       __send__(__method__, val)
     end
 
-    private def build_completor
-      completor_type = IRB.conf[:COMPLETOR]
-      case completor_type
-      when :regexp
-        return RegexpCompletor.new
-      when :type
-        completor = build_type_completor
-        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
-      if RUBY_ENGINE == 'truffleruby'
-        # Avoid SyntaxError. truffleruby does not support endless method definition yet.
-        warn 'TypeCompletor is not supported on TruffleRuby yet'
-        return
-      end
-
-      begin
-        require 'repl_type_completor'
-      rescue LoadError => e
-        warn "TypeCompletor requires `gem repl_type_completor`: #{e.message}"
-        return
-      end
-
-      ReplTypeCompletor.preload_rbs
-      TypeCompletor.new(self)
-    end
-
     def save_history=(val)
       IRB.conf[:SAVE_HISTORY] = val
     end
@@ -310,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
@@ -602,7 +558,8 @@ module IRB
         set_last_value(result)
       when Statement::Command
         statement.command_class.execute(self, statement.arg)
-        set_last_value(nil)
+      when Statement::IncorrectAlias
+        warn statement.message
       end
 
       nil
@@ -636,8 +593,77 @@ module IRB
       result
     end
 
-    def inspect_last_value # :nodoc:
-      @inspect_method.inspect_value(@last_value)
+    def parse_input(code, is_assignment_expression)
+      command_name, arg = code.strip.split(/\s+/, 2)
+      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
+
+      command = command_name.to_sym
+
+      # 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_class && Command.execute_as_command?(command, public_method: public_method, private_method: private_method)
+        Statement::Command.new(code, command_class, arg)
+      else
+        Statement::Expression.new(code, is_assignment_expression)
+      end
+    end
+
+    def colorize_input(input, complete:)
+      if IRB.conf[:USE_COLORIZE] && IRB::Color.colorable?
+        lvars = local_variables || []
+        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)
+          "#{IRB::Color.colorize(name, [:BOLD])}\e[m#{sep}#{arg}"
+        else
+          IRB::Color.colorize_code(input, complete: complete, local_variables: lvars)
+        end
+      else
+        Reline::Unicode.escape_for_print(input)
+      end
+    end
+
+    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:
@@ -670,5 +696,56 @@ module IRB
     def local_variables # :nodoc:
       workspace.binding.local_variables
     end
+
+    def safe_method_call_on_main(method_name)
+      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/ui.rb

@@ -45,9 +45,7 @@ module IRB
             $stdout.puts line.chomp
           }
         when String
-          str.each_line{|line|
-            $stdout.puts line.chomp
-          }
+          Pager.page_content(str, retain_content: true)
         when nil
           $stdout.puts
         end
@@ -56,7 +54,7 @@ module IRB
       def readline _
         setup_interrupt do
           tc = DEBUGGER__::SESSION.instance_variable_get(:@tc)
-          cmd = @irb.debug_readline(tc.current_frame.binding || TOPLEVEL_BINDING)
+          cmd = @irb.debug_readline(tc.current_frame.eval_binding || TOPLEVEL_BINDING)
 
           case cmd
           when nil # when user types C-d

data/lib/irb/debug.rb

@@ -57,22 +57,18 @@ module IRB
           DEBUGGER__::ThreadClient.prepend(SkipPathHelperForIRB)
         end
 
-        if !@output_modifier_defined && !DEBUGGER__::CONFIG[:no_hint]
-          irb_output_modifier_proc = Reline.output_modifier_proc
-
-          Reline.output_modifier_proc = proc do |output, complete:|
-            unless output.strip.empty?
-              cmd = output.split(/\s/, 2).first
+        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
 
               if !complete && DEBUGGER__.commands.key?(cmd)
-                output = output.sub(/\n$/, " # debug command\n")
+                input = input.sub(/\n$/, " # debug command\n")
               end
             end
 
-            irb_output_modifier_proc.call(output, complete: complete)
+            irb.context.colorize_input(input, complete: complete)
           end
-
-          @output_modifier_defined = true
         end
 
         true
@@ -85,6 +81,7 @@ module IRB
         IRB.instance_variable_set(:@debugger_irb, irb)
         irb.context.with_debugger = true
         irb.context.irb_name += ":rdbg"
+        irb.context.io.load_history if irb.context.io.class < HistorySavingAbility
       end
 
       module SkipPathHelperForIRB

data/lib/irb/default_commands.rb

@@ -5,9 +5,11 @@ require_relative "command/internal_helpers"
 require_relative "command/backtrace"
 require_relative "command/break"
 require_relative "command/catch"
+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"
@@ -180,9 +182,15 @@ module IRB
       [:edit, NO_OVERRIDE]
     )
 
-    _register_with_aliases(:irb_break, Command::Break)
-    _register_with_aliases(:irb_catch, Command::Catch)
-    _register_with_aliases(:irb_next, Command::Next)
+    _register_with_aliases(:irb_break, Command::Break,
+      [:break, OVERRIDE_ALL]
+    )
+    _register_with_aliases(:irb_catch, Command::Catch,
+      [:catch, OVERRIDE_PRIVATE_ONLY]
+    )
+    _register_with_aliases(:irb_next, Command::Next,
+      [:next, OVERRIDE_ALL]
+    )
     _register_with_aliases(:irb_delete, Command::Delete,
       [:delete, NO_OVERRIDE]
     )
@@ -211,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)
@@ -240,6 +249,9 @@ module IRB
     _register_with_aliases(:irb_disable_irb, Command::DisableIrb,
       [:disable_irb, NO_OVERRIDE]
     )
+
+    register(:cd, Command::CD)
+    register(:copy, Command::Copy)
   end
 
   ExtendCommand = Command
@@ -256,10 +268,12 @@ module IRB
     # Deprecated. Doesn't have any effect.
     @EXTEND_COMMANDS = []
 
-    # Drepcated. Use Command.regiser instead.
-    def self.def_extend_command(cmd_name, cmd_class, _, *aliases)
-      Command._register_with_aliases(cmd_name, cmd_class, *aliases)
-      Command.class_variable_set(:@@command_override_policies, nil)
+    class << self
+      # Drepcated. Use Command.regiser instead.
+      def def_extend_command(cmd_name, cmd_class, _, *aliases)
+        Command._register_with_aliases(cmd_name, cmd_class, *aliases)
+        Command.class_variable_set(:@@command_override_policies, nil)
+      end
     end
   end
 end

data/lib/irb/easter-egg.rb

@@ -100,19 +100,21 @@ module IRB
 
     private def easter_egg_logo(type)
       @easter_egg_logos ||= File.read(File.join(__dir__, 'ruby_logo.aa'), encoding: 'UTF-8:UTF-8')
-        .split(/TYPE: ([A-Z]+)\n/)[1..]
+        .split(/TYPE: ([A-Z_]+)\n/)[1..]
         .each_slice(2)
         .to_h
       @easter_egg_logos[type.to_s.upcase]
     end
 
     private def easter_egg(type = nil)
+      print "\e[?1049h"
       type ||= [:logo, :dancing].sample
       case type
       when :logo
-        require "rdoc"
-        RDoc::RI::Driver.new.page do |io|
-          io.write easter_egg_logo(:large)
+        Pager.page do |io|
+          logo_type = STDOUT.external_encoding == Encoding::UTF_8 ? :unicode_large : :ascii_large
+          io.write easter_egg_logo(logo_type)
+          STDIN.raw { STDIN.getc } if io == STDOUT
         end
       when :dancing
         STDOUT.cooked do
@@ -123,7 +125,7 @@ module IRB
             canvas = Canvas.new(Reline.get_screen_size)
           end
           ruby_model = RubyModel.new
-          print "\e[?1049h"
+          print "\e[?25l" # hide cursor
           0.step do |i| # TODO (0..).each needs Ruby 2.6 or later
             buff = canvas.draw do
               ruby_model.render_frame(i) do |p1, p2|
@@ -137,10 +139,12 @@ module IRB
           end
         rescue Interrupt
         ensure
-          print "\e[0m\e[?1049l"
+          print "\e[?25h" # show cursor
           trap("SIGINT", prev_trap)
         end
       end
+    ensure
+      print "\e[0m\e[?1049l"
     end
   end
 end