irb 1.14.3 → 1.15.0

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,35 +593,60 @@ 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 && 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 || []
-        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)
           "#{IRB::Color.colorize(name, [:BOLD])}\e[m#{sep}#{arg}"
@@ -673,8 +658,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 +701,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/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/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

@@ -93,7 +93,7 @@ module IRB # :nodoc:
     @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 +194,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)

data/lib/irb/inspector.rb

@@ -92,9 +92,14 @@ module IRB # :nodoc:
       @init.call if @init
     end
 
+    def support_stream_output?
+      second_parameter_type = @inspect.parameters[1]&.first
+      second_parameter_type == :req || second_parameter_type == :opt
+    end
+
     # Proc to call when the input is evaluated and output in irb.
-    def inspect_value(v)
-      @inspect.call(v)
+    def inspect_value(v, output, colorize: true)
+      support_stream_output? ? @inspect.call(v, output, colorize: colorize) : output << @inspect.call(v, colorize: colorize)
     rescue => e
       puts "An error occurred when inspecting the object: #{e.inspect}"
 
@@ -110,11 +115,11 @@ module IRB # :nodoc:
   end
 
   Inspector.def_inspector([false, :to_s, :raw]){|v| v.to_s}
-  Inspector.def_inspector([:p, :inspect]){|v|
-    Color.colorize_code(v.inspect, colorable: Color.colorable? && Color.inspect_colorable?(v))
+  Inspector.def_inspector([:p, :inspect]){|v, colorize: true|
+    Color.colorize_code(v.inspect, colorable: colorize && Color.colorable? && Color.inspect_colorable?(v))
   }
-  Inspector.def_inspector([true, :pp, :pretty_inspect], proc{require_relative "color_printer"}){|v|
-    IRB::ColorPrinter.pp(v, +'').chomp
+  Inspector.def_inspector([true, :pp, :pretty_inspect], proc{require_relative "color_printer"}){|v, output, colorize: true|
+    IRB::ColorPrinter.pp(v, output, colorize: colorize)
   }
   Inspector.def_inspector([:yaml, :YAML], proc{require "yaml"}){|v|
     begin

data/lib/irb/pager.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'reline'
+
 module IRB
   # The implementation of this class is borrowed from RDoc's lib/rdoc/ri/driver.rb.
   # Please do NOT use this class directly outside of IRB.
@@ -47,12 +49,42 @@ module IRB
       rescue Errno::EPIPE
       end
 
-      private
-
       def should_page?
         IRB.conf[:USE_PAGER] && STDIN.tty? && (ENV.key?("TERM") && ENV["TERM"] != "dumb")
       end
 
+      def page_with_preview(width, height, formatter_proc)
+        overflow_callback = ->(lines) do
+          modified_output = formatter_proc.call(lines.join, true)
+          content, = take_first_page(width, [height - 2, 0].max) {|o| o.write modified_output }
+          content = content.chomp
+          content = "#{content}\e[0m" if Color.colorable?
+          $stdout.puts content
+          $stdout.puts 'Preparing full inspection value...'
+        end
+        out = PageOverflowIO.new(width, height, overflow_callback, delay: 0.1)
+        yield out
+        content = formatter_proc.call(out.string, out.multipage?)
+        if out.multipage?
+          page(retain_content: true) do |io|
+            io.puts content
+          end
+        else
+          $stdout.puts content
+        end
+      end
+
+      def take_first_page(width, height)
+        overflow_callback = proc do |lines|
+          return lines.join, true
+        end
+        out = Pager::PageOverflowIO.new(width, height, overflow_callback)
+        yield out
+        [out.string, false]
+      end
+
+      private
+
       def content_exceeds_screen_height?(content)
         screen_height, screen_width = begin
           Reline.get_screen_size
@@ -62,10 +94,10 @@ module IRB
 
         pageable_height = screen_height - 3 # leave some space for previous and the current prompt
 
-        # If the content has more lines than the pageable height
-        content.lines.count > pageable_height ||
-          # Or if the content is a few long lines
-          pageable_height * screen_width < Reline::Unicode.calculate_width(content, true)
+        return true if content.lines.size > pageable_height
+
+        _, overflow = take_first_page(screen_width, pageable_height) {|out| out.write content }
+        overflow
       end
 
       def setup_pager(retain_content:)
@@ -96,5 +128,83 @@ module IRB
         nil
       end
     end
+
+    # Writable IO that has page overflow callback
+    class PageOverflowIO
+      attr_reader :string, :first_page_lines
+
+      # Maximum size of a single cell in terminal
+      # Assumed worst case: "\e[1;3;4;9;38;2;255;128;128;48;2;128;128;255mA\e[0m"
+      # bold, italic, underline, crossed_out, RGB forgound, RGB background
+      MAX_CHAR_PER_CELL = 50
+
+      def initialize(width, height, overflow_callback, delay: nil)
+        @lines = []
+        @first_page_lines = nil
+        @width = width
+        @height = height
+        @buffer = +''
+        @overflow_callback = overflow_callback
+        @col = 0
+        @string = +''
+        @multipage = false
+        @delay_until = (Time.now + delay if delay)
+      end
+
+      def puts(text = '')
+        write(text)
+        write("\n") unless text.end_with?("\n")
+      end
+
+      def write(text)
+        @string << text
+        if @multipage
+          if @delay_until && Time.now > @delay_until
+            @overflow_callback.call(@first_page_lines)
+            @delay_until = nil
+          end
+          return
+        end
+
+        overflow_size = (@width * (@height - @lines.size) + @width - @col) * MAX_CHAR_PER_CELL
+        if text.size >= overflow_size
+          text = text[0, overflow_size]
+          overflow = true
+        end
+
+        @buffer << text
+        @col += Reline::Unicode.calculate_width(text)
+        if text.include?("\n") || @col >= @width
+          @buffer.lines.each do |line|
+            wrapped_lines = Reline::Unicode.split_by_width(line.chomp, @width).first.compact
+            wrapped_lines.pop if wrapped_lines.last == ''
+            @lines.concat(wrapped_lines)
+            if @lines.empty?
+              @lines << "\n"
+            elsif line.end_with?("\n")
+              @lines[-1] += "\n"
+            end
+          end
+          @buffer.clear
+          @buffer << @lines.pop unless @lines.last.end_with?("\n")
+          @col = Reline::Unicode.calculate_width(@buffer)
+        end
+        if overflow || @lines.size > @height || (@lines.size == @height && @col > 0)
+          @first_page_lines = @lines.take(@height)
+          if !@delay_until || Time.now > @delay_until
+            @overflow_callback.call(@first_page_lines)
+            @delay_until = nil
+          end
+          @multipage = true
+        end
+      end
+
+      def multipage?
+        @multipage
+      end
+
+      alias print write
+      alias << write
+    end
   end
 end

data/lib/irb/statement.rb

@@ -54,6 +54,27 @@ module IRB
       end
     end
 
+    class IncorrectAlias < Statement
+      attr_reader :message
+
+      def initialize(message)
+        @code = ""
+        @message = message
+      end
+
+      def should_be_handled_by_debugger?
+        false
+      end
+
+      def is_assignment?
+        false
+      end
+
+      def suppresses_echo?
+        true
+      end
+    end
+
     class Command < Statement
       attr_reader :command_class, :arg
 

data/lib/irb/version.rb

@@ -5,7 +5,7 @@
 #
 
 module IRB # :nodoc:
-  VERSION = "1.14.3"
+  VERSION = "1.15.0"
   @RELEASE_VERSION = VERSION
-  @LAST_UPDATE_DATE = "2024-12-18"
+  @LAST_UPDATE_DATE = "2025-01-21"
 end