irb 1.6.4 → 1.8.0

data/lib/irb/debug.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+module IRB
+  module Debug
+    IRB_DIR = File.expand_path('..', __dir__)
+
+    class << self
+      def insert_debug_break(pre_cmds: nil, do_cmds: nil)
+        options = { oneshot: true, hook_call: false }
+
+        if pre_cmds || do_cmds
+          options[:command] = ['irb', pre_cmds, do_cmds]
+        end
+        if DEBUGGER__::LineBreakpoint.instance_method(:initialize).parameters.include?([:key, :skip_src])
+          options[:skip_src] = true
+        end
+
+        # To make debugger commands like `next` or `continue` work without asking
+        # the user to quit IRB after that, we need to exit IRB first and then hit
+        # a TracePoint on #debug_break.
+        file, lineno = IRB::Irb.instance_method(:debug_break).source_location
+        DEBUGGER__::SESSION.add_line_breakpoint(file, lineno + 1, **options)
+      end
+
+      def setup(irb)
+        # When debug session is not started at all
+        unless defined?(DEBUGGER__::SESSION)
+          begin
+            require "debug/session"
+          rescue LoadError # debug.gem is not written in Gemfile
+            return false unless load_bundled_debug_gem
+          end
+          DEBUGGER__::CONFIG.set_config
+          configure_irb_for_debugger(irb)
+          thread = Thread.current
+
+          DEBUGGER__.initialize_session{ IRB::Debug::UI.new(thread, irb) }
+        end
+
+        # When debug session was previously started but not by IRB
+        if defined?(DEBUGGER__::SESSION) && !irb.context.with_debugger
+          configure_irb_for_debugger(irb)
+          thread = Thread.current
+
+          DEBUGGER__::SESSION.reset_ui(IRB::Debug::UI.new(thread, irb))
+        end
+
+        # Apply patches to debug gem so it skips IRB frames
+        unless DEBUGGER__.respond_to?(:capture_frames_without_irb)
+          DEBUGGER__.singleton_class.send(:alias_method, :capture_frames_without_irb, :capture_frames)
+
+          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>"
+            end
+            frames
+          end
+
+          DEBUGGER__::ThreadClient.prepend(SkipPathHelperForIRB)
+        end
+
+        true
+      end
+
+      private
+
+      def configure_irb_for_debugger(irb)
+        require 'irb/debug/ui'
+        IRB.instance_variable_set(:@debugger_irb, irb)
+        irb.context.with_debugger = true
+        irb.context.irb_name += ":rdbg"
+      end
+
+      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>')
+        end
+      end
+
+      # This is used when debug.gem is not written in Gemfile. Even if it's not
+      # installed by `bundle install`, debug.gem is installed by default because
+      # it's a bundled gem. This method tries to activate and load that.
+      def load_bundled_debug_gem
+        # Discover latest debug.gem under GEM_PATH
+        debug_gem = Gem.paths.path.flat_map { |path| Dir.glob("#{path}/gems/debug-*") }.select do |path|
+          File.basename(path).match?(/\Adebug-\d+\.\d+\.\d+(\w+)?\z/)
+        end.sort_by do |path|
+          Gem::Version.new(File.basename(path).delete_prefix('debug-'))
+        end.last
+        return false unless debug_gem
+
+        # Discover debug/debug.so under extensions for Ruby 3.2+
+        ext_name = "/debug/debug.#{RbConfig::CONFIG['DLEXT']}"
+        ext_path = Gem.paths.path.flat_map do |path|
+          Dir.glob("#{path}/extensions/**/#{File.basename(debug_gem)}#{ext_name}")
+        end.first
+
+        # Attempt to forcibly load the bundled gem
+        if ext_path
+          $LOAD_PATH << ext_path.delete_suffix(ext_name)
+        end
+        $LOAD_PATH << "#{debug_gem}/lib"
+        begin
+          require "debug/session"
+          puts "Loaded #{File.basename(debug_gem)}"
+          true
+        rescue LoadError
+          false
+        end
+      end
+    end
+  end
+end

data/lib/irb/ext/{history.rb → eval_history.rb}

@@ -40,14 +40,14 @@ module IRB # :nodoc:
     #
     # If +no+ is +nil+, execution result history isn't used (default).
     #
-    # History values are available via <code>__</code> variable, see
-    # IRB::History.
+    # EvalHistory values are available via <code>__</code> variable, see
+    # IRB::EvalHistory.
     def eval_history=(no)
       if no
         if defined?(@eval_history) && @eval_history
           @eval_history_values.size(no)
         else
-          @eval_history_values = History.new(no)
+          @eval_history_values = EvalHistory.new(no)
           IRB.conf[:__TMP__EHV__] = @eval_history_values
           @workspace.evaluate("__ = IRB.conf[:__TMP__EHV__]")
           IRB.conf.delete(:__TMP_EHV__)
@@ -89,7 +89,7 @@ module IRB # :nodoc:
   #    __[1]
   #    # => 10
   #
-  class History
+  class EvalHistory
 
     def initialize(size = 16)  # :nodoc:
       @size = size

data/lib/irb/ext/loader.rb

@@ -42,6 +42,7 @@ module IRB # :nodoc:
     #
     # See Irb#suspend_input_method for more information.
     def source_file(path)
+      irb = irb_context.irb
       irb.suspend_name(path, File.basename(path)) do
         FileInputMethod.open(path) do |io|
           irb.suspend_input_method(io) do
@@ -66,6 +67,7 @@ module IRB # :nodoc:
     #
     # See Irb#suspend_input_method for more information.
     def load_file(path, priv = nil)
+      irb = irb_context.irb
       irb.suspend_name(path, File.basename(path)) do
 
         if priv

data/lib/irb/ext/tracer.rb

@@ -7,7 +7,7 @@
 begin
   require "tracer"
 rescue LoadError
-  $stderr.puts "Tracer extension of IRB is enabled but tracer gem doesn't found."
+  $stderr.puts "Tracer extension of IRB is enabled but tracer gem wasn't found."
   module IRB
     class Context
       def use_tracer=(opt)

data/lib/irb/extend-command.rb

@@ -157,10 +157,14 @@ module IRB # :nodoc:
 
       [
         :irb_help, :Help, "cmd/help",
-        [:show_doc, NO_OVERRIDE],
         [:help, NO_OVERRIDE],
       ],
 
+      [
+        :irb_show_doc, :ShowDoc, "cmd/show_doc",
+        [:show_doc, NO_OVERRIDE],
+      ],
+
       [
         :irb_info, :IrbInfo, "cmd/irb_info"
       ],
@@ -285,7 +289,7 @@ module IRB # :nodoc:
           alias_method to, from
         }
       else
-        Kernel.print "irb: warn: can't alias #{to} from #{from}.\n"
+        Kernel.warn "irb: warn: can't alias #{to} from #{from}.\n"
       end
     end
 
@@ -312,10 +316,9 @@ module IRB # :nodoc:
     CE = ContextExtender # :nodoc:
 
     @EXTEND_COMMANDS = [
-      [:eval_history=, "ext/history.rb"],
+      [:eval_history=, "ext/eval_history.rb"],
       [:use_tracer=, "ext/tracer.rb"],
       [:use_loader=, "ext/use-loader.rb"],
-      [:save_history=, "ext/save-history.rb"],
     ]
 
     # Installs the default context extensions as irb commands:
@@ -323,7 +326,6 @@ module IRB # :nodoc:
     # Context#eval_history=::   +irb/ext/history.rb+
     # Context#use_tracer=::     +irb/ext/tracer.rb+
     # Context#use_loader=::     +irb/ext/use-loader.rb+
-    # Context#save_history=::   +irb/ext/save-history.rb+
     def self.install_extend_commands
       for args in @EXTEND_COMMANDS
         def_extend_command(*args)

data/lib/irb/help.rb

@@ -4,15 +4,13 @@
 #   	by Keiju ISHITSUKA(keiju@ishitsuka.com)
 #
 
-require_relative 'magic-file'
-
 module IRB
   # Outputs the irb help message, see IRB@Command+line+options.
   def IRB.print_usage
     lc = IRB.conf[:LC_MESSAGES]
     path = lc.find("irb/help-message")
     space_line = false
-    IRB::MagicFile.open(path){|f|
+    File.open(path){|f|
       f.each_line do |l|
         if /^\s*$/ =~ l
           lc.puts l unless space_line

data/lib/irb/{ext/save-history.rb → history.rb}

@@ -1,64 +1,14 @@
-# frozen_string_literal: false
-#
-#   save-history.rb -
-#   	by Keiju ISHITSUKA(keiju@ruby-lang.org)
-#
-
 module IRB
   module HistorySavingAbility # :nodoc:
-  end
-
-  class Context
-    def init_save_history# :nodoc:
-      unless (class<<@io;self;end).include?(HistorySavingAbility)
-        @io.extend(HistorySavingAbility)
-      end
-    end
-
-    # A copy of the default <code>IRB.conf[:SAVE_HISTORY]</code>
-    def save_history
-      IRB.conf[:SAVE_HISTORY]
-    end
-
-    remove_method(:save_history=) if method_defined?(:save_history=)
-    # Sets <code>IRB.conf[:SAVE_HISTORY]</code> to the given +val+ and calls
-    # #init_save_history with this context.
-    #
-    # Will store the number of +val+ entries of history in the #history_file
-    #
-    # Add the following to your +.irbrc+ to change the number of history
-    # entries stored to 1000:
-    #
-    #     IRB.conf[:SAVE_HISTORY] = 1000
-    def save_history=(val)
-      IRB.conf[:SAVE_HISTORY] = val
-      if val
-        main_context = IRB.conf[:MAIN_CONTEXT]
-        main_context = self unless main_context
-        main_context.init_save_history
-      end
-    end
-
-    # A copy of the default <code>IRB.conf[:HISTORY_FILE]</code>
-    def history_file
-      IRB.conf[:HISTORY_FILE]
+    def support_history_saving?
+      true
     end
 
-    # Set <code>IRB.conf[:HISTORY_FILE]</code> to the given +hist+.
-    def history_file=(hist)
-      IRB.conf[:HISTORY_FILE] = hist
-    end
-  end
-
-  module HistorySavingAbility # :nodoc:
-    def HistorySavingAbility.extended(obj)
-      IRB.conf[:AT_EXIT].push proc{obj.save_history}
-      obj.load_history
-      obj
+    def reset_history_counter
+      @loaded_history_lines = self.class::HISTORY.size if defined? @loaded_history_lines
     end
 
     def load_history
-      return unless self.class.const_defined?(:HISTORY)
       history = self.class::HISTORY
       if history_file = IRB.conf[:HISTORY_FILE]
         history_file = File.expand_path(history_file)
@@ -82,7 +32,6 @@ module IRB
     end
 
     def save_history
-      return unless self.class.const_defined?(:HISTORY)
       history = self.class::HISTORY
       if num = IRB.conf[:SAVE_HISTORY] and (num = num.to_i) != 0
         if history_file = IRB.conf[:HISTORY_FILE]

data/lib/irb/init.rb

@@ -58,35 +58,30 @@ module IRB # :nodoc:
     @CONF[:PROMPT] = {
       :NULL => {
         :PROMPT_I => nil,
-        :PROMPT_N => nil,
         :PROMPT_S => nil,
         :PROMPT_C => nil,
         :RETURN => "%s\n"
       },
       :DEFAULT => {
-        :PROMPT_I => "%N(%m):%03n:%i> ",
-        :PROMPT_N => "%N(%m):%03n:%i> ",
-        :PROMPT_S => "%N(%m):%03n:%i%l ",
-        :PROMPT_C => "%N(%m):%03n:%i* ",
+        :PROMPT_I => "%N(%m):%03n> ",
+        :PROMPT_S => "%N(%m):%03n%l ",
+        :PROMPT_C => "%N(%m):%03n* ",
         :RETURN => "=> %s\n"
       },
       :CLASSIC => {
         :PROMPT_I => "%N(%m):%03n:%i> ",
-        :PROMPT_N => "%N(%m):%03n:%i> ",
         :PROMPT_S => "%N(%m):%03n:%i%l ",
         :PROMPT_C => "%N(%m):%03n:%i* ",
         :RETURN => "%s\n"
       },
       :SIMPLE => {
         :PROMPT_I => ">> ",
-        :PROMPT_N => ">> ",
         :PROMPT_S => "%l> ",
         :PROMPT_C => "?> ",
         :RETURN => "=> %s\n"
       },
       :INF_RUBY => {
-        :PROMPT_I => "%N(%m):%03n:%i> ",
-        :PROMPT_N => nil,
+        :PROMPT_I => "%N(%m):%03n> ",
         :PROMPT_S => nil,
         :PROMPT_C => nil,
         :RETURN => "%s\n",
@@ -94,7 +89,6 @@ module IRB # :nodoc:
       },
       :XMP => {
         :PROMPT_I => nil,
-        :PROMPT_N => nil,
         :PROMPT_S => nil,
         :PROMPT_C => nil,
         :RETURN => "    ==>%s\n"

data/lib/irb/input-method.rb

@@ -4,23 +4,13 @@
 #   	by Keiju ISHITSUKA(keiju@ruby-lang.org)
 #
 
-require_relative 'src_encoding'
-require_relative 'magic-file'
 require_relative 'completion'
+require_relative "history"
 require 'io/console'
 require 'reline'
 
 module IRB
-  STDIN_FILE_NAME = "(line)" # :nodoc:
   class InputMethod
-
-    # Creates a new input method object
-    def initialize(file = STDIN_FILE_NAME)
-      @file_name = file
-    end
-    # The file name of this input method, usually given during initialization.
-    attr_reader :file_name
-
     # The irb prompt associated with this input method
     attr_accessor :prompt
 
@@ -48,6 +38,10 @@ module IRB
       false
     end
 
+    def support_history_saving?
+      false
+    end
+
     # For debug message
     def inspect
       'Abstract InputMethod'
@@ -57,7 +51,6 @@ module IRB
   class StdioInputMethod < InputMethod
     # Creates a new input method object
     def initialize
-      super
       @line_no = 0
       @line = []
       @stdin = IO.open(STDIN.to_i, :external_encoding => IRB.conf[:LC_MESSAGES].encoding, :internal_encoding => "-")
@@ -131,12 +124,9 @@ module IRB
 
     # Creates a new input method object
     def initialize(file)
-      super
-      @io = file.is_a?(IO) ? file : IRB::MagicFile.open(file)
+      @io = file.is_a?(IO) ? file : File.open(file)
       @external_encoding = @io.external_encoding
     end
-    # The file name of this input method, usually given during initialization.
-    attr_reader :file_name
 
     # Whether the end of this input method has been reached, returns +true+ if
     # there is no more data to read.
@@ -169,111 +159,79 @@ module IRB
     end
   end
 
-  begin
-    class ReadlineInputMethod < InputMethod
-      def self.initialize_readline
-        require "readline"
-      rescue LoadError
-      else
-        include ::Readline
-      end
-
-      # Creates a new input method object using Readline
-      def initialize
-        self.class.initialize_readline
-        if Readline.respond_to?(:encoding_system_needs)
-          IRB.__send__(:set_encoding, Readline.encoding_system_needs.name, override: false)
-        end
-        super
-
-        @line_no = 0
-        @line = []
-        @eof = false
+  class ReadlineInputMethod < StdioInputMethod
+    def self.initialize_readline
+      require "readline"
+    rescue LoadError
+    else
+      include ::Readline
+    end
 
-        @stdin = IO.open(STDIN.to_i, :external_encoding => IRB.conf[:LC_MESSAGES].encoding, :internal_encoding => "-")
-        @stdout = IO.open(STDOUT.to_i, 'w', :external_encoding => IRB.conf[:LC_MESSAGES].encoding, :internal_encoding => "-")
+    include HistorySavingAbility
 
-        if Readline.respond_to?("basic_word_break_characters=")
-          Readline.basic_word_break_characters = IRB::InputCompletor::BASIC_WORD_BREAK_CHARACTERS
-        end
-        Readline.completion_append_character = nil
-        Readline.completion_proc = IRB::InputCompletor::CompletionProc
+    # Creates a new input method object using Readline
+    def initialize
+      self.class.initialize_readline
+      if Readline.respond_to?(:encoding_system_needs)
+        IRB.__send__(:set_encoding, Readline.encoding_system_needs.name, override: false)
       end
 
-      # Reads the next line from this input method.
-      #
-      # See IO#gets for more information.
-      def gets
-        Readline.input = @stdin
-        Readline.output = @stdout
-        if l = readline(@prompt, false)
-          HISTORY.push(l) if !l.empty?
-          @line[@line_no += 1] = l + "\n"
-        else
-          @eof = true
-          l
-        end
-      end
+      super
 
-      # Whether the end of this input method has been reached, returns +true+
-      # if there is no more data to read.
-      #
-      # See IO#eof? for more information.
-      def eof?
-        @eof
-      end
+      @eof = false
 
-      # Whether this input method is still readable when there is no more data to
-      # read.
-      #
-      # See IO#eof for more information.
-      def readable_after_eof?
-        true
+      if Readline.respond_to?("basic_word_break_characters=")
+        Readline.basic_word_break_characters = IRB::InputCompletor::BASIC_WORD_BREAK_CHARACTERS
       end
+      Readline.completion_append_character = nil
+      Readline.completion_proc = IRB::InputCompletor::CompletionProc
+    end
 
-      # Returns the current line number for #io.
-      #
-      # #line counts the number of times #gets is called.
-      #
-      # See IO#lineno for more information.
-      def line(line_no)
-        @line[line_no]
+    # Reads the next line from this input method.
+    #
+    # See IO#gets for more information.
+    def gets
+      Readline.input = @stdin
+      Readline.output = @stdout
+      if l = readline(@prompt, false)
+        HISTORY.push(l) if !l.empty?
+        @line[@line_no += 1] = l + "\n"
+      else
+        @eof = true
+        l
       end
+    end
 
-      # The external encoding for standard input.
-      def encoding
-        @stdin.external_encoding
-      end
+    # Whether the end of this input method has been reached, returns +true+
+    # if there is no more data to read.
+    #
+    # See IO#eof? for more information.
+    def eof?
+      @eof
+    end
 
-      # For debug message
-      def inspect
-        readline_impl = (defined?(Reline) && Readline == Reline) ? 'Reline' : 'ext/readline'
-        str = "ReadlineInputMethod with #{readline_impl} #{Readline::VERSION}"
-        inputrc_path = File.expand_path(ENV['INPUTRC'] || '~/.inputrc')
-        str += " and #{inputrc_path}" if File.exist?(inputrc_path)
-        str
-      end
+    # For debug message
+    def inspect
+      readline_impl = (defined?(Reline) && Readline == Reline) ? 'Reline' : 'ext/readline'
+      str = "ReadlineInputMethod with #{readline_impl} #{Readline::VERSION}"
+      inputrc_path = File.expand_path(ENV['INPUTRC'] || '~/.inputrc')
+      str += " and #{inputrc_path}" if File.exist?(inputrc_path)
+      str
     end
   end
 
-  class RelineInputMethod < InputMethod
-    include Reline
-
+  class RelineInputMethod < StdioInputMethod
+    HISTORY = Reline::HISTORY
+    include HistorySavingAbility
     # Creates a new input method object using Reline
     def initialize
       IRB.__send__(:set_encoding, Reline.encoding_system_needs.name, override: false)
+
       super
 
-      @line_no = 0
-      @line = []
       @eof = false
 
-      @stdin = ::IO.open(STDIN.to_i, :external_encoding => IRB.conf[:LC_MESSAGES].encoding, :internal_encoding => "-")
-      @stdout = ::IO.open(STDOUT.to_i, 'w', :external_encoding => IRB.conf[:LC_MESSAGES].encoding, :internal_encoding => "-")
-
-      if Reline.respond_to?("basic_word_break_characters=")
-        Reline.basic_word_break_characters = IRB::InputCompletor::BASIC_WORD_BREAK_CHARACTERS
-      end
+      Reline.basic_word_break_characters = IRB::InputCompletor::BASIC_WORD_BREAK_CHARACTERS
       Reline.completion_append_character = nil
       Reline.completer_quote_characters = ''
       Reline.completion_proc = IRB::InputCompletor::CompletionProc
@@ -399,11 +357,13 @@ module IRB
       formatter = RDoc::Markup::ToAnsi.new
       formatter.width = width
       dialog.trap_key = alt_d
-      message = 'Press Alt+d to read the full document'
+      mod_key = RUBY_PLATFORM.match?(/darwin/) ? "Option" : "Alt"
+      message = "Press #{mod_key}+d to read the full document"
       contents = [message] + doc.accept(formatter).split("\n")
+      contents = contents.take(preferred_dialog_height)
 
       y = cursor_pos_to_render.y
-      DialogRenderInfo.new(pos: Reline::CursorPos.new(x, y), contents: contents, width: width, bg_color: '49')
+      Reline::DialogRenderInfo.new(pos: Reline::CursorPos.new(x, y), contents: contents, width: width, bg_color: '49')
     }
 
     # Reads the next line from this input method.
@@ -414,8 +374,8 @@ module IRB
       Reline.output = @stdout
       Reline.prompt_proc = @prompt_proc
       Reline.auto_indent_proc = @auto_indent_proc if @auto_indent_proc
-      if l = readmultiline(@prompt, false, &@check_termination_proc)
-        HISTORY.push(l) if !l.empty?
+      if l = Reline.readmultiline(@prompt, false, &@check_termination_proc)
+        Reline::HISTORY.push(l) if !l.empty?
         @line[@line_no += 1] = l + "\n"
       else
         @eof = true
@@ -431,37 +391,11 @@ module IRB
       @eof
     end
 
-    # Whether this input method is still readable when there is no more data to
-    # read.
-    #
-    # See IO#eof for more information.
-    def readable_after_eof?
-      true
-    end
-
-    # Returns the current line number for #io.
-    #
-    # #line counts the number of times #gets is called.
-    #
-    # See IO#lineno for more information.
-    def line(line_no)
-      @line[line_no]
-    end
-
-    # The external encoding for standard input.
-    def encoding
-      @stdin.external_encoding
-    end
-
     # For debug message
     def inspect
       config = Reline::Config.new
       str = "RelineInputMethod with Reline #{Reline::VERSION}"
-      if config.respond_to?(:inputrc_path)
-        inputrc_path = File.expand_path(config.inputrc_path)
-      else
-        inputrc_path = File.expand_path(ENV['INPUTRC'] || '~/.inputrc')
-      end
+      inputrc_path = File.expand_path(config.inputrc_path)
       str += " and #{inputrc_path}" if File.exist?(inputrc_path)
       str
     end