irb 1.6.4 → 1.8.0

data/lib/irb/cmd/ls.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
 require "reline"
+require "stringio"
 require_relative "nop"
+require_relative "../pager"
 require_relative "../color"
 
 module IRB
@@ -33,14 +35,18 @@ module IRB
         o.dump("instance variables", obj.instance_variables)
         o.dump("class variables", klass.class_variables)
         o.dump("locals", locals)
-        nil
+        o.print_result
       end
 
       def dump_methods(o, klass, obj)
         singleton_class = begin obj.singleton_class; rescue TypeError; nil end
         dumped_mods = Array.new
+        ancestors = klass.ancestors
+        ancestors = ancestors.reject { |c| c >= Object } if klass < Object
+        singleton_ancestors = (singleton_class&.ancestors || []).reject { |c| c >= Class }
+
         # singleton_class' ancestors should be at the front
-        maps = class_method_map(singleton_class&.ancestors || [], dumped_mods) + class_method_map(klass.ancestors, dumped_mods)
+        maps = class_method_map(singleton_ancestors, dumped_mods) + class_method_map(ancestors, dumped_mods)
         maps.each do |mod, methods|
           name = mod == singleton_class ? "#{klass}.methods" : "#{mod}#methods"
           o.dump(name, methods)
@@ -49,7 +55,6 @@ module IRB
 
       def class_method_map(classes, dumped_mods)
         dumped_methods = Array.new
-        classes = classes.reject { |mod| mod >= Object }
         classes.map do |mod|
           next if dumped_mods.include? mod
 
@@ -74,6 +79,11 @@ module IRB
         def initialize(grep: nil)
           @grep = grep
           @line_width = screen_width - MARGIN.length # right padding
+          @io = StringIO.new
+        end
+
+        def print_result
+          Pager.page_content(@io.string)
         end
 
         def dump(name, strs)
@@ -82,12 +92,12 @@ module IRB
           return if strs.empty?
 
           # Attempt a single line
-          print "#{Color.colorize(name, [:BOLD, :BLUE])}: "
+          @io.print "#{Color.colorize(name, [:BOLD, :BLUE])}: "
           if fits_on_line?(strs, cols: strs.size, offset: "#{name}: ".length)
-            puts strs.join(MARGIN)
+            @io.puts strs.join(MARGIN)
             return
           end
-          puts
+          @io.puts
 
           # Dump with the largest # of columns that fits on a line
           cols = strs.size
@@ -96,7 +106,7 @@ module IRB
           end
           widths = col_widths(strs, cols: cols)
           strs.each_slice(cols) do |ss|
-            puts ss.map.with_index { |s, i| "#{MARGIN}%-#{widths[i]}s" % s }.join
+            @io.puts ss.map.with_index { |s, i| "#{MARGIN}%-#{widths[i]}s" % s }.join
           end
         end
 

data/lib/irb/cmd/nop.rb

@@ -30,23 +30,19 @@ module IRB
         end
       end
 
-      def self.execute(conf, *opts, **kwargs, &block)
-        command = new(conf)
+      def self.execute(irb_context, *opts, **kwargs, &block)
+        command = new(irb_context)
         command.execute(*opts, **kwargs, &block)
       rescue CommandArgumentError => e
         puts e.message
       end
 
-      def initialize(conf)
-        @irb_context = conf
+      def initialize(irb_context)
+        @irb_context = irb_context
       end
 
       attr_reader :irb_context
 
-      def irb
-        @irb_context.irb
-      end
-
       def execute(*opts)
         #nop
       end

data/lib/irb/cmd/pushws.rb

@@ -12,7 +12,7 @@ module IRB
 
   module ExtendCommand
     class Workspaces < Nop
-      category "IRB"
+      category "Workspace"
       description "Show workspaces."
 
       def execute(*obj)
@@ -21,7 +21,7 @@ module IRB
     end
 
     class PushWorkspace < Workspaces
-      category "IRB"
+      category "Workspace"
       description "Push an object to the workspace stack."
 
       def execute(*obj)
@@ -31,7 +31,7 @@ module IRB
     end
 
     class PopWorkspace < Workspaces
-      category "IRB"
+      category "Workspace"
       description "Pop a workspace from the workspace stack."
 
       def execute(*obj)

data/lib/irb/cmd/show_cmds.rb

@@ -2,6 +2,7 @@
 
 require "stringio"
 require_relative "nop"
+require_relative "../pager"
 
 module IRB
   # :stopdoc:
@@ -14,7 +15,17 @@ module IRB
       def execute(*args)
         commands_info = IRB::ExtendCommandBundle.all_commands_info
         commands_grouped_by_categories = commands_info.group_by { |cmd| cmd[:category] }
-        longest_cmd_name_length = commands_info.map { |c| c[:display_name] }.max { |a, b| a.length <=> b.length }.length
+
+        if irb_context.with_debugger
+          # Remove the original "Debugging" category
+          commands_grouped_by_categories.delete("Debugging")
+          # Remove the `help` command as it's delegated to the debugger
+          commands_grouped_by_categories["Context"].delete_if { |cmd| cmd[:display_name] == :help }
+          # Add an empty "Debugging (from debug.gem)" category at the end
+          commands_grouped_by_categories["Debugging (from debug.gem)"] = []
+        end
+
+        longest_cmd_name_length = commands_info.map { |c| c[:display_name].length }.max
 
         output = StringIO.new
 
@@ -28,9 +39,12 @@ module IRB
           output.puts
         end
 
-        puts output.string
+        # Append the debugger help at the end
+        if irb_context.with_debugger
+          output.puts DEBUGGER__.help
+        end
 
-        nil
+        Pager.page_content(output.string)
       end
     end
   end

data/lib/irb/cmd/show_doc.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require_relative "nop"
+
+module IRB
+  module ExtendCommand
+    class ShowDoc < Nop
+      class << self
+        def transform_args(args)
+          # Return a string literal as is for backward compatibility
+          if args.empty? || string_literal?(args)
+            args
+          else # Otherwise, consider the input as a String for convenience
+            args.strip.dump
+          end
+        end
+      end
+
+      category "Context"
+      description "Enter the mode to look up RI documents."
+
+      def execute(*names)
+        require 'rdoc/ri/driver'
+
+        unless ShowDoc.const_defined?(:Ri)
+          opts = RDoc::RI::Driver.process_args([])
+          ShowDoc.const_set(:Ri, RDoc::RI::Driver.new(opts))
+        end
+
+        if names.empty?
+          Ri.interactive
+        else
+          names.each do |name|
+            begin
+              Ri.display_name(name.to_s)
+            rescue RDoc::RI::Error
+              puts $!.message
+            end
+          end
+        end
+
+        nil
+      rescue LoadError, SystemExit
+        warn "Can't display document because `rdoc` is not installed."
+      end
+    end
+  end
+end

data/lib/irb/cmd/show_source.rb

@@ -1,12 +1,10 @@
 # frozen_string_literal: true
 
 require_relative "nop"
+require_relative "../source_finder"
 require_relative "../color"
-require_relative "../ruby-lex"
 
 module IRB
-  # :stopdoc:
-
   module ExtendCommand
     class ShowSource < Nop
       category "Context"
@@ -21,50 +19,6 @@ module IRB
             args.strip.dump
           end
         end
-
-        def find_source(str, irb_context)
-          case str
-          when /\A[A-Z]\w*(::[A-Z]\w*)*\z/ # Const::Name
-            eval(str, irb_context.workspace.binding) # trigger autoload
-            base = irb_context.workspace.binding.receiver.yield_self { |r| r.is_a?(Module) ? r : Object }
-            file, line = base.const_source_location(str)
-          when /\A(?<owner>[A-Z]\w*(::[A-Z]\w*)*)#(?<method>[^ :.]+)\z/ # Class#method
-            owner = eval(Regexp.last_match[:owner], irb_context.workspace.binding)
-            method = Regexp.last_match[:method]
-            if owner.respond_to?(:instance_method) && owner.instance_methods.include?(method.to_sym)
-              file, line = owner.instance_method(method).source_location
-            end
-          when /\A((?<receiver>.+)(\.|::))?(?<method>[^ :.]+)\z/ # method, receiver.method, receiver::method
-            receiver = eval(Regexp.last_match[:receiver] || 'self', irb_context.workspace.binding)
-            method = Regexp.last_match[:method]
-            file, line = receiver.method(method).source_location if receiver.respond_to?(method)
-          end
-          if file && line
-            Source.new(file: file, first_line: line, last_line: find_end(file, line, irb_context))
-          end
-        end
-
-        private
-
-        def find_end(file, first_line, irb_context)
-          return first_line unless File.exist?(file)
-          lex = RubyLex.new(irb_context)
-          lines = File.read(file).lines[(first_line - 1)..-1]
-          tokens = RubyLex.ripper_lex_without_warning(lines.join)
-          prev_tokens = []
-
-          # chunk with line number
-          tokens.chunk { |tok| tok.pos[0] }.each do |lnum, chunk|
-            code = lines[0..lnum].join
-            prev_tokens.concat chunk
-            continue = lex.process_continue(prev_tokens)
-            code_block_open = lex.check_code_block(code, prev_tokens)
-            if !continue && !code_block_open
-              return first_line + lnum
-            end
-          end
-          first_line
-        end
       end
 
       def execute(str = nil)
@@ -73,8 +27,9 @@ module IRB
           return
         end
 
-        source = self.class.find_source(str, @irb_context)
-        if source && File.exist?(source.file)
+        source = SourceFinder.new(@irb_context).find_source(str)
+
+        if source
           show_source(source)
         else
           puts "Error: Couldn't locate a definition for #{str}"
@@ -84,7 +39,6 @@ module IRB
 
       private
 
-      # @param [IRB::ExtendCommand::ShowSource::Source] source
       def show_source(source)
         puts
         puts "#{bold("From")}: #{source.file}:#{source.first_line}"
@@ -97,16 +51,6 @@ module IRB
       def bold(str)
         Color.colorize(str, [:BOLD])
       end
-
-      Source = Struct.new(
-        :file,       # @param [String] - file name
-        :first_line, # @param [String] - first line
-        :last_line,  # @param [String] - last line
-        keyword_init: true,
-      )
-      private_constant :Source
     end
   end
-
-  # :startdoc:
 end

data/lib/irb/cmd/subirb.rb

@@ -11,52 +11,95 @@ module IRB
 
   module ExtendCommand
     class MultiIRBCommand < Nop
-      def initialize(conf)
-        super
+      def execute(*args)
         extend_irb_context
       end
 
       private
 
+      def print_deprecated_warning
+        warn <<~MSG
+          Multi-irb commands are deprecated and will be removed in IRB 2.0.0. Please use workspace commands instead.
+          If you have any use case for multi-irb, please leave a comment at https://github.com/ruby/irb/issues/653
+        MSG
+      end
+
       def extend_irb_context
         # this extension patches IRB context like IRB.CurrentContext
         require_relative "../ext/multi-irb"
       end
+
+      def print_debugger_warning
+        warn "Multi-IRB commands are not available when the debugger is enabled."
+      end
     end
 
     class IrbCommand < MultiIRBCommand
-      category "IRB"
+      category "Multi-irb (DEPRECATED)"
       description "Start a child IRB."
 
       def execute(*obj)
+        print_deprecated_warning
+
+        if irb_context.with_debugger
+          print_debugger_warning
+          return
+        end
+
+        super
         IRB.irb(nil, *obj)
       end
     end
 
     class Jobs < MultiIRBCommand
-      category "IRB"
+      category "Multi-irb (DEPRECATED)"
       description "List of current sessions."
 
       def execute
+        print_deprecated_warning
+
+        if irb_context.with_debugger
+          print_debugger_warning
+          return
+        end
+
+        super
         IRB.JobManager
       end
     end
 
     class Foreground < MultiIRBCommand
-      category "IRB"
+      category "Multi-irb (DEPRECATED)"
       description "Switches to the session of the given number."
 
       def execute(key = nil)
+        print_deprecated_warning
+
+        if irb_context.with_debugger
+          print_debugger_warning
+          return
+        end
+
+        super
+
         raise CommandArgumentError.new("Please specify the id of target IRB job (listed in the `jobs` command).") unless key
         IRB.JobManager.switch(key)
       end
     end
 
     class Kill < MultiIRBCommand
-      category "IRB"
+      category "Multi-irb (DEPRECATED)"
       description "Kills the session with the given number."
 
       def execute(*keys)
+        print_deprecated_warning
+
+        if irb_context.with_debugger
+          print_debugger_warning
+          return
+        end
+
+        super
         IRB.JobManager.kill(*keys)
       end
     end

data/lib/irb/color.rb

@@ -9,12 +9,14 @@ module IRB # :nodoc:
     BOLD      = 1
     UNDERLINE = 4
     REVERSE   = 7
+    BLACK     = 30
     RED       = 31
     GREEN     = 32
     YELLOW    = 33
     BLUE      = 34
     MAGENTA   = 35
     CYAN      = 36
+    WHITE     = 37
 
     TOKEN_KEYWORDS = {
       on_kw: ['nil', 'self', 'true', 'false', '__FILE__', '__LINE__', '__ENCODING__'],

data/lib/irb/completion.rb

@@ -218,7 +218,7 @@ module IRB
         else
           sym = $1
           candidates = Symbol.all_symbols.collect do |s|
-            ":" + s.id2name.encode(Encoding.default_external)
+            s.inspect
           rescue EncodingError
             # ignore
           end
@@ -233,7 +233,7 @@ module IRB
         if doc_namespace
           candidates.find { |i| i == receiver }
         else
-          candidates.grep(/^#{receiver}/).collect{|e| "::" + e}
+          candidates.grep(/^#{Regexp.quote(receiver)}/).collect{|e| "::" + e}
         end
 
       when /^([A-Z].*)::([^:.]*)$/

data/lib/irb/context.rb

@@ -129,8 +129,6 @@ module IRB
       else
         @io = input_method
       end
-      self.save_history = IRB.conf[:SAVE_HISTORY] if IRB.conf[:SAVE_HISTORY]
-
       @extra_doc_dirs = IRB.conf[:EXTRA_DOC_DIRS]
 
       @echo = IRB.conf[:ECHO]
@@ -151,6 +149,24 @@ module IRB
       @command_aliases = IRB.conf[:COMMAND_ALIASES]
     end
 
+    def save_history=(val)
+      IRB.conf[:SAVE_HISTORY] = val
+    end
+
+    def save_history
+      IRB.conf[:SAVE_HISTORY]
+    end
+
+    # A copy of the default <code>IRB.conf[:HISTORY_FILE]</code>
+    def history_file
+      IRB.conf[:HISTORY_FILE]
+    end
+
+    # Set <code>IRB.conf[:HISTORY_FILE]</code> to the given +hist+.
+    def history_file=(hist)
+      IRB.conf[:HISTORY_FILE] = hist
+    end
+
     # The top-level workspace, see WorkSpace#main
     def main
       @workspace.main
@@ -213,8 +229,19 @@ module IRB
     #
     # See IRB@Customizing+the+IRB+Prompt for more information.
     attr_accessor :prompt_c
-    # See IRB@Customizing+the+IRB+Prompt for more information.
-    attr_accessor :prompt_n
+
+    # TODO: Remove this when developing v2.0
+    def prompt_n
+      warn "IRB::Context#prompt_n is deprecated and will be removed in the next major release."
+      ""
+    end
+
+    # TODO: Remove this when developing v2.0
+    def prompt_n=(_)
+      warn "IRB::Context#prompt_n= is deprecated and will be removed in the next major release."
+      ""
+    end
+
     # Can be either the default <code>IRB.conf[:AUTO_INDENT]</code>, or the
     # mode set by #prompt_mode=
     #
@@ -329,6 +356,8 @@ module IRB
     # User-defined IRB command aliases
     attr_accessor :command_aliases
 
+    attr_accessor :with_debugger
+
     # Alias for #use_multiline
     alias use_multiline? use_multiline
     # Alias for #use_singleline
@@ -396,7 +425,6 @@ module IRB
       @prompt_i = pconf[:PROMPT_I]
       @prompt_s = pconf[:PROMPT_S]
       @prompt_c = pconf[:PROMPT_C]
-      @prompt_n = pconf[:PROMPT_N]
       @return_format = pconf[:RETURN]
       @return_format = "%s\n" if @return_format == nil
       if ai = pconf.include?(:AUTO_INDENT)
@@ -473,28 +501,31 @@ module IRB
       @inspect_mode
     end
 
-    def evaluate(line, line_no, exception: nil) # :nodoc:
+    def evaluate(line, line_no) # :nodoc:
       @line_no = line_no
-      if exception
-        line_no -= 1
-        line = "begin ::Kernel.raise _; rescue _.class\n#{line}\n""end"
-        @workspace.local_variable_set(:_, exception)
-      end
+      result = nil
 
-      # Transform a non-identifier alias (@, $) or keywords (next, break)
-      command, args = line.split(/\s/, 2)
-      if original = command_aliases[command.to_sym]
-        line = line.gsub(/\A#{Regexp.escape(command)}/, original.to_s)
-        command = original
+      if IRB.conf[:MEASURE] && IRB.conf[:MEASURE_CALLBACKS].empty?
+        IRB.set_measure_callback
       end
 
-      # Hook command-specific transformation
-      command_class = ExtendCommandBundle.load_command(command)
-      if command_class&.respond_to?(:transform_args)
-        line = "#{command} #{command_class.transform_args(args)}"
+      if IRB.conf[:MEASURE] && !IRB.conf[:MEASURE_CALLBACKS].empty?
+        last_proc = proc do
+          result = @workspace.evaluate(line, irb_path, line_no)
+        end
+        IRB.conf[:MEASURE_CALLBACKS].inject(last_proc) do |chain, item|
+          _name, callback, arg = item
+          proc do
+            callback.(self, line, line_no, arg) do
+              chain.call
+            end
+          end
+        end.call
+      else
+        result = @workspace.evaluate(line, irb_path, line_no)
       end
 
-      set_last_value(@workspace.evaluate(line, irb_path, line_no))
+      set_last_value(result)
     end
 
     def inspect_last_value # :nodoc:

data/lib/irb/debug/ui.rb

@@ -0,0 +1,104 @@
+require 'io/console/size'
+require 'debug/console'
+
+module IRB
+  module Debug
+    class UI < DEBUGGER__::UI_Base
+      def initialize(thread, irb)
+        @thread = thread
+        @irb = irb
+      end
+
+      def remote?
+        false
+      end
+
+      def activate session, on_fork: false
+      end
+
+      def deactivate
+      end
+
+      def width
+        if (w = IO.console_size[1]) == 0 # for tests PTY
+          80
+        else
+          w
+        end
+      end
+
+      def quit n
+        yield
+        exit n
+      end
+
+      def ask prompt
+        setup_interrupt do
+          print prompt
+          ($stdin.gets || '').strip
+        end
+      end
+
+      def puts str = nil
+        case str
+        when Array
+          str.each{|line|
+            $stdout.puts line.chomp
+          }
+        when String
+          str.each_line{|line|
+            $stdout.puts line.chomp
+          }
+        when nil
+          $stdout.puts
+        end
+      end
+
+      def readline _
+        setup_interrupt do
+          tc = DEBUGGER__::SESSION.get_thread_client(@thread)
+          cmd = @irb.debug_readline(tc.current_frame.binding || TOPLEVEL_BINDING)
+
+          case cmd
+          when nil # when user types C-d
+            "continue"
+          else
+            cmd
+          end
+        end
+      end
+
+      def setup_interrupt
+        DEBUGGER__::SESSION.intercept_trap_sigint false do
+          current_thread = Thread.current # should be session_server thread
+
+          prev_handler = trap(:INT){
+            current_thread.raise Interrupt
+          }
+
+          yield
+        ensure
+          trap(:INT, prev_handler)
+        end
+      end
+
+      def after_fork_parent
+        parent_pid = Process.pid
+
+        at_exit{
+          DEBUGGER__::SESSION.intercept_trap_sigint_end
+          trap(:SIGINT, :IGNORE)
+
+          if Process.pid == parent_pid
+            # only check child process from its parent
+            begin
+              # wait for all child processes to keep terminal
+              Process.waitpid
+            rescue Errno::ESRCH, Errno::ECHILD
+            end
+          end
+        }
+      end
+    end
+  end
+end