irb 1.7.1 → 1.13.2

data/lib/irb/{cmd → command}/measure.rb

@@ -1,10 +1,10 @@
-require_relative "nop"
-
 module IRB
   # :stopdoc:
 
-  module ExtendCommand
-    class Measure < Nop
+  module Command
+    class Measure < Base
+      include RubyArgsExtractor
+
       category "Misc"
       description "`measure` enables the mode to measure processing time. `measure :off` disables it."
 
@@ -12,32 +12,33 @@ module IRB
         super(*args)
       end
 
-      def execute(type = nil, arg = nil, &block)
+      def execute(arg)
+        if arg&.match?(/^do$|^do[^\w]|^\{/)
+          warn 'Configure IRB.conf[:MEASURE_PROC] to add custom measure methods.'
+          return
+        end
+        args, kwargs = ruby_args(arg)
+        execute_internal(*args, **kwargs)
+      end
+
+      def execute_internal(type = nil, arg = nil)
         # Please check IRB.init_config in lib/irb/init.rb that sets
         # IRB.conf[:MEASURE_PROC] to register default "measure" methods,
         # "measure :time" (abbreviated as "measure") and "measure :stackprof".
+
         case type
         when :off
-          IRB.conf[:MEASURE] = nil
           IRB.unset_measure_callback(arg)
         when :list
           IRB.conf[:MEASURE_CALLBACKS].each do |type_name, _, arg_val|
             puts "- #{type_name}" + (arg_val ? "(#{arg_val.inspect})" : '')
           end
         when :on
-          IRB.conf[:MEASURE] = true
-          added = IRB.set_measure_callback(type, arg)
+          added = IRB.set_measure_callback(arg)
           puts "#{added[0]} is added." if added
         else
-          if block_given?
-            IRB.conf[:MEASURE] = true
-            added = IRB.set_measure_callback(&block)
-            puts "#{added[0]} is added." if added
-          else
-            IRB.conf[:MEASURE] = true
-            added = IRB.set_measure_callback(type, arg)
-            puts "#{added[0]} is added." if added
-          end
+          added = IRB.set_measure_callback(type, arg)
+          puts "#{added[0]} is added." if added
         end
         nil
       end

data/lib/irb/{cmd → command}/next.rb

@@ -5,10 +5,10 @@ require_relative "debug"
 module IRB
   # :stopdoc:
 
-  module ExtendCommand
+  module Command
     class Next < DebugCommand
-      def execute(*args)
-        super(do_cmds: ["next", *args].join(" "))
+      def execute(arg)
+        execute_debug_command(do_cmds: "next #{arg}")
       end
     end
   end

data/lib/irb/command/pushws.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+#
+#   change-ws.rb -
+#   	by Keiju ISHITSUKA(keiju@ruby-lang.org)
+#
+
+require_relative "../ext/workspaces"
+
+module IRB
+  # :stopdoc:
+
+  module Command
+    class Workspaces < Base
+      category "Workspace"
+      description "Show workspaces."
+
+      def execute(_arg)
+        inspection_resuls = irb_context.instance_variable_get(:@workspace_stack).map do |ws|
+          truncated_inspect(ws.main)
+        end
+
+        puts "[" + inspection_resuls.join(", ") + "]"
+      end
+
+      private
+
+      def truncated_inspect(obj)
+        obj_inspection = obj.inspect
+
+        if obj_inspection.size > 20
+          obj_inspection = obj_inspection[0, 19] + "...>"
+        end
+
+        obj_inspection
+      end
+    end
+
+    class PushWorkspace < Workspaces
+      category "Workspace"
+      description "Push an object to the workspace stack."
+
+      def execute(arg)
+        if arg.empty?
+          irb_context.push_workspace
+        else
+          obj = eval(arg, irb_context.workspace.binding)
+          irb_context.push_workspace(obj)
+        end
+        super
+      end
+    end
+
+    class PopWorkspace < Workspaces
+      category "Workspace"
+      description "Pop a workspace from the workspace stack."
+
+      def execute(_arg)
+        irb_context.pop_workspace
+        super
+      end
+    end
+  end
+
+  # :startdoc:
+end

data/lib/irb/command/show_doc.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module IRB
+  module Command
+    class ShowDoc < Base
+      include RubyArgsExtractor
+
+      category "Context"
+      description "Look up documentation with RI."
+
+      help_message <<~HELP_MESSAGE
+        Usage: show_doc [name]
+
+        When name is provided, IRB will look up the documentation for the given name.
+        When no name is provided, a RI session will be started.
+
+        Examples:
+
+          show_doc
+          show_doc Array
+          show_doc Array#each
+
+      HELP_MESSAGE
+
+      def execute(arg)
+        # Accept string literal for backward compatibility
+        name = unwrap_string_literal(arg)
+        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 name.nil?
+          Ri.interactive
+        else
+          begin
+            Ri.display_name(name)
+          rescue RDoc::RI::Error
+            puts $!.message
+          end
+        end
+
+        nil
+      rescue LoadError, SystemExit
+        warn "Can't display document because `rdoc` is not installed."
+      end
+    end
+  end
+end

data/lib/irb/command/show_source.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require_relative "../source_finder"
+require_relative "../pager"
+require_relative "../color"
+
+module IRB
+  module Command
+    class ShowSource < Base
+      include RubyArgsExtractor
+
+      category "Context"
+      description "Show the source code of a given method, class/module, or constant."
+
+      help_message <<~HELP_MESSAGE
+        Usage: show_source [target] [-s]
+
+          -s  Show the super method. You can stack it like `-ss` to show the super of the super, etc.
+
+        Examples:
+
+          show_source Foo
+          show_source Foo#bar
+          show_source Foo#bar -s
+          show_source Foo.baz
+          show_source Foo::BAR
+      HELP_MESSAGE
+
+      def execute(arg)
+        # Accept string literal for backward compatibility
+        str = unwrap_string_literal(arg)
+        unless str.is_a?(String)
+          puts "Error: Expected a string but got #{str.inspect}"
+          return
+        end
+
+        str, esses = str.split(" -")
+        super_level = esses ? esses.count("s") : 0
+        source = SourceFinder.new(@irb_context).find_source(str, super_level)
+
+        if source
+          show_source(source)
+        elsif super_level > 0
+          puts "Error: Couldn't locate a super definition for #{str}"
+        else
+          puts "Error: Couldn't locate a definition for #{str}"
+        end
+        nil
+      end
+
+      private
+
+      def show_source(source)
+        if source.binary_file?
+          content = "\n#{bold('Defined in binary file')}: #{source.file}\n\n"
+        else
+          code = source.colorized_content || 'Source not available'
+          content = <<~CONTENT
+
+            #{bold("From")}: #{source.file}:#{source.line}
+
+            #{code.chomp}
+
+          CONTENT
+        end
+        Pager.page_content(content)
+      end
+
+      def bold(str)
+        Color.colorize(str, [:BOLD])
+      end
+    end
+  end
+end

data/lib/irb/{cmd → command}/step.rb

@@ -5,10 +5,10 @@ require_relative "debug"
 module IRB
   # :stopdoc:
 
-  module ExtendCommand
+  module Command
     class Step < DebugCommand
-      def execute(*args)
-        super(do_cmds: ["step", *args].join(" "))
+      def execute(arg)
+        execute_debug_command(do_cmds: "step #{arg}")
       end
     end
   end

data/lib/irb/command/subirb.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+#
+#   multi.rb -
+#   	by Keiju ISHITSUKA(keiju@ruby-lang.org)
+#
+
+module IRB
+  # :stopdoc:
+
+  module Command
+    class MultiIRBCommand < Base
+      include RubyArgsExtractor
+
+      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 "Multi-irb (DEPRECATED)"
+      description "Start a child IRB."
+
+      def execute(arg)
+        args, kwargs = ruby_args(arg)
+        execute_internal(*args, **kwargs)
+      end
+
+      def execute_internal(*obj)
+        print_deprecated_warning
+
+        if irb_context.with_debugger
+          print_debugger_warning
+          return
+        end
+
+        extend_irb_context
+        IRB.irb(nil, *obj)
+        puts IRB.JobManager.inspect
+      end
+    end
+
+    class Jobs < MultiIRBCommand
+      category "Multi-irb (DEPRECATED)"
+      description "List of current sessions."
+
+      def execute(_arg)
+        print_deprecated_warning
+
+        if irb_context.with_debugger
+          print_debugger_warning
+          return
+        end
+
+        extend_irb_context
+        puts IRB.JobManager.inspect
+      end
+    end
+
+    class Foreground < MultiIRBCommand
+      category "Multi-irb (DEPRECATED)"
+      description "Switches to the session of the given number."
+
+      def execute(arg)
+        args, kwargs = ruby_args(arg)
+        execute_internal(*args, **kwargs)
+      end
+
+      def execute_internal(key = nil)
+        print_deprecated_warning
+
+        if irb_context.with_debugger
+          print_debugger_warning
+          return
+        end
+
+        extend_irb_context
+
+        raise CommandArgumentError.new("Please specify the id of target IRB job (listed in the `jobs` command).") unless key
+        IRB.JobManager.switch(key)
+        puts IRB.JobManager.inspect
+      end
+    end
+
+    class Kill < MultiIRBCommand
+      category "Multi-irb (DEPRECATED)"
+      description "Kills the session with the given number."
+
+      def execute(arg)
+        args, kwargs = ruby_args(arg)
+        execute_internal(*args, **kwargs)
+      end
+
+      def execute_internal(*keys)
+        print_deprecated_warning
+
+        if irb_context.with_debugger
+          print_debugger_warning
+          return
+        end
+
+        extend_irb_context
+        IRB.JobManager.kill(*keys)
+        puts IRB.JobManager.inspect
+      end
+    end
+  end
+
+  # :startdoc:
+end

data/lib/irb/{cmd → command}/whereami.rb

@@ -1,16 +1,14 @@
 # frozen_string_literal: true
 
-require_relative "nop"
-
 module IRB
   # :stopdoc:
 
-  module ExtendCommand
-    class Whereami < Nop
+  module Command
+    class Whereami < Base
       category "Context"
       description "Show the source code around binding.irb again."
 
-      def execute(*)
+      def execute(_arg)
         code = irb_context.workspace.code_around_binding
         if code
           puts code

data/lib/irb/command.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+#
+#   irb/command.rb - irb command
+#   	by Keiju ISHITSUKA(keiju@ruby-lang.org)
+#
+
+require_relative "command/base"
+
+module IRB # :nodoc:
+  module Command
+    @commands = {}
+
+    class << self
+      attr_reader :commands
+
+      # Registers a command with the given name.
+      # Aliasing is intentionally not supported at the moment.
+      def register(name, command_class)
+        @commands[name.to_sym] = [command_class, []]
+      end
+    end
+  end
+end