irb 1.11.1 → 1.12.0

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

@@ -1,22 +1,37 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 #
 #   change-ws.rb -
 #   	by Keiju ISHITSUKA(keiju@ruby-lang.org)
 #
 
-require_relative "nop"
 require_relative "../ext/workspaces"
 
 module IRB
   # :stopdoc:
 
-  module ExtendCommand
-    class Workspaces < Nop
+  module Command
+    class Workspaces < Base
       category "Workspace"
       description "Show workspaces."
 
       def execute(*obj)
-        irb_context.workspaces.collect{|ws| ws.main}
+        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
 

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

@@ -1,10 +1,8 @@
 # frozen_string_literal: true
 
-require_relative "nop"
-
 module IRB
-  module ExtendCommand
-    class ShowDoc < Nop
+  module Command
+    class ShowDoc < Base
       class << self
         def transform_args(args)
           # Return a string literal as is for backward compatibility
@@ -17,7 +15,21 @@ module IRB
       end
 
       category "Context"
-      description "Enter the mode to look up RI documents."
+      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(*names)
         require 'rdoc/ri/driver'

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

@@ -1,15 +1,28 @@
 # frozen_string_literal: true
 
-require_relative "nop"
 require_relative "../source_finder"
 require_relative "../pager"
 require_relative "../color"
 
 module IRB
-  module ExtendCommand
-    class ShowSource < Nop
+  module Command
+    class ShowSource < Base
       category "Context"
-      description "Show the source code of a given method or constant."
+      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
 
       class << self
         def transform_args(args)
@@ -45,15 +58,18 @@ module IRB
       private
 
       def show_source(source)
-        file_content = IRB::Color.colorize_code(File.read(source.file))
-        code = file_content.lines[(source.first_line - 1)...source.last_line].join
-        content = <<~CONTENT
+        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.first_line}
+            #{bold("From")}: #{source.file}:#{source.line}
 
-          #{code}
-        CONTENT
+            #{code.chomp}
 
+          CONTENT
+        end
         Pager.page_content(content)
       end
 

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

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

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

@@ -1,16 +1,14 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 #
 #   multi.rb -
 #   	by Keiju ISHITSUKA(keiju@ruby-lang.org)
 #
 
-require_relative "nop"
-
 module IRB
   # :stopdoc:
 
-  module ExtendCommand
-    class MultiIRBCommand < Nop
+  module Command
+    class MultiIRBCommand < Base
       def execute(*args)
         extend_irb_context
       end

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

@@ -1,12 +1,10 @@
 # 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."
 

data/lib/irb/{extend-command.rb → command.rb}

@@ -1,10 +1,15 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 #
-#   irb/extend-command.rb - irb extend command
+#   irb/command.rb - irb command
 #   	by Keiju ISHITSUKA(keiju@ruby-lang.org)
 #
 
+require_relative "command/base"
+
 module IRB # :nodoc:
+  module Command; end
+  ExtendCommand = Command
+
   # Installs the default irb extensions command bundle.
   module ExtendCommandBundle
     EXCB = ExtendCommandBundle # :nodoc:
@@ -31,13 +36,18 @@ module IRB # :nodoc:
 
     @EXTEND_COMMANDS = [
       [
-        :irb_exit, :Exit, "cmd/exit",
+        :irb_exit, :Exit, "command/exit",
         [:exit, OVERRIDE_PRIVATE_ONLY],
         [:quit, OVERRIDE_PRIVATE_ONLY],
         [:irb_quit, OVERRIDE_PRIVATE_ONLY],
       ],
       [
-        :irb_current_working_workspace, :CurrentWorkingWorkspace, "cmd/chws",
+        :irb_exit!, :ForceExit, "command/force_exit",
+        [:exit!, OVERRIDE_PRIVATE_ONLY],
+      ],
+
+      [
+        :irb_current_working_workspace, :CurrentWorkingWorkspace, "command/chws",
         [:cwws, NO_OVERRIDE],
         [:pwws, NO_OVERRIDE],
         [:irb_print_working_workspace, OVERRIDE_ALL],
@@ -49,7 +59,7 @@ module IRB # :nodoc:
         [:irb_pwb, OVERRIDE_ALL],
       ],
       [
-        :irb_change_workspace, :ChangeWorkspace, "cmd/chws",
+        :irb_change_workspace, :ChangeWorkspace, "command/chws",
         [:chws, NO_OVERRIDE],
         [:cws, NO_OVERRIDE],
         [:irb_chws, OVERRIDE_ALL],
@@ -60,13 +70,13 @@ module IRB # :nodoc:
       ],
 
       [
-        :irb_workspaces, :Workspaces, "cmd/pushws",
+        :irb_workspaces, :Workspaces, "command/pushws",
         [:workspaces, NO_OVERRIDE],
         [:irb_bindings, OVERRIDE_ALL],
         [:bindings, NO_OVERRIDE],
       ],
       [
-        :irb_push_workspace, :PushWorkspace, "cmd/pushws",
+        :irb_push_workspace, :PushWorkspace, "command/pushws",
         [:pushws, NO_OVERRIDE],
         [:irb_pushws, OVERRIDE_ALL],
         [:irb_push_binding, OVERRIDE_ALL],
@@ -74,7 +84,7 @@ module IRB # :nodoc:
         [:pushb, NO_OVERRIDE],
       ],
       [
-        :irb_pop_workspace, :PopWorkspace, "cmd/pushws",
+        :irb_pop_workspace, :PopWorkspace, "command/pushws",
         [:popws, NO_OVERRIDE],
         [:irb_popws, OVERRIDE_ALL],
         [:irb_pop_binding, OVERRIDE_ALL],
@@ -83,112 +93,107 @@ module IRB # :nodoc:
       ],
 
       [
-        :irb_load, :Load, "cmd/load"],
+        :irb_load, :Load, "command/load"],
       [
-        :irb_require, :Require, "cmd/load"],
+        :irb_require, :Require, "command/load"],
       [
-        :irb_source, :Source, "cmd/load",
+        :irb_source, :Source, "command/load",
         [:source, NO_OVERRIDE],
       ],
 
       [
-        :irb, :IrbCommand, "cmd/subirb"],
+        :irb, :IrbCommand, "command/subirb"],
       [
-        :irb_jobs, :Jobs, "cmd/subirb",
+        :irb_jobs, :Jobs, "command/subirb",
         [:jobs, NO_OVERRIDE],
       ],
       [
-        :irb_fg, :Foreground, "cmd/subirb",
+        :irb_fg, :Foreground, "command/subirb",
         [:fg, NO_OVERRIDE],
       ],
       [
-        :irb_kill, :Kill, "cmd/subirb",
+        :irb_kill, :Kill, "command/subirb",
         [:kill, OVERRIDE_PRIVATE_ONLY],
       ],
 
       [
-        :irb_debug, :Debug, "cmd/debug",
+        :irb_debug, :Debug, "command/debug",
         [:debug, NO_OVERRIDE],
       ],
       [
-        :irb_edit, :Edit, "cmd/edit",
+        :irb_edit, :Edit, "command/edit",
         [:edit, NO_OVERRIDE],
       ],
       [
-        :irb_break, :Break, "cmd/break",
+        :irb_break, :Break, "command/break",
       ],
       [
-        :irb_catch, :Catch, "cmd/catch",
+        :irb_catch, :Catch, "command/catch",
       ],
       [
-        :irb_next, :Next, "cmd/next"
+        :irb_next, :Next, "command/next"
       ],
       [
-        :irb_delete, :Delete, "cmd/delete",
+        :irb_delete, :Delete, "command/delete",
         [:delete, NO_OVERRIDE],
       ],
       [
-        :irb_step, :Step, "cmd/step",
+        :irb_step, :Step, "command/step",
         [:step, NO_OVERRIDE],
       ],
       [
-        :irb_continue, :Continue, "cmd/continue",
+        :irb_continue, :Continue, "command/continue",
         [:continue, NO_OVERRIDE],
       ],
       [
-        :irb_finish, :Finish, "cmd/finish",
+        :irb_finish, :Finish, "command/finish",
         [:finish, NO_OVERRIDE],
       ],
       [
-        :irb_backtrace, :Backtrace, "cmd/backtrace",
+        :irb_backtrace, :Backtrace, "command/backtrace",
         [:backtrace, NO_OVERRIDE],
         [:bt, NO_OVERRIDE],
       ],
       [
-        :irb_debug_info, :Info, "cmd/info",
+        :irb_debug_info, :Info, "command/info",
         [:info, NO_OVERRIDE],
       ],
 
       [
-        :irb_help, :Help, "cmd/help",
+        :irb_help, :Help, "command/help",
         [:help, NO_OVERRIDE],
+        [:show_cmds, NO_OVERRIDE],
       ],
 
       [
-        :irb_show_doc, :ShowDoc, "cmd/show_doc",
+        :irb_show_doc, :ShowDoc, "command/show_doc",
         [:show_doc, NO_OVERRIDE],
       ],
 
       [
-        :irb_info, :IrbInfo, "cmd/irb_info"
+        :irb_info, :IrbInfo, "command/irb_info"
       ],
 
       [
-        :irb_ls, :Ls, "cmd/ls",
+        :irb_ls, :Ls, "command/ls",
         [:ls, NO_OVERRIDE],
       ],
 
       [
-        :irb_measure, :Measure, "cmd/measure",
+        :irb_measure, :Measure, "command/measure",
         [:measure, NO_OVERRIDE],
       ],
 
       [
-        :irb_show_source, :ShowSource, "cmd/show_source",
+        :irb_show_source, :ShowSource, "command/show_source",
         [:show_source, NO_OVERRIDE],
       ],
-
       [
-        :irb_whereami, :Whereami, "cmd/whereami",
+        :irb_whereami, :Whereami, "command/whereami",
         [:whereami, NO_OVERRIDE],
       ],
       [
-        :irb_show_cmds, :ShowCmds, "cmd/show_cmds",
-        [:show_cmds, NO_OVERRIDE],
-      ],
-
-      [
-        :irb_history, :History, "cmd/history",
+        :irb_history, :History, "command/history",
         [:history, NO_OVERRIDE],
         [:hist, NO_OVERRIDE],
       ]
@@ -205,11 +210,11 @@ module IRB # :nodoc:
       end
 
       @EXTEND_COMMANDS.each do |cmd_name, cmd_class, load_file, *aliases|
-        if !defined?(ExtendCommand) || !ExtendCommand.const_defined?(cmd_class, false)
+        if !defined?(Command) || !Command.const_defined?(cmd_class, false)
           require_relative load_file
         end
 
-        klass = ExtendCommand.const_get(cmd_class, false)
+        klass = Command.const_get(cmd_class, false)
         aliases = aliases.map { |a| a.first }
 
         if additional_aliases = user_aliases[cmd_name]
@@ -229,10 +234,10 @@ module IRB # :nodoc:
       @EXTEND_COMMANDS.each do |cmd_name, cmd_class, load_file, *aliases|
         next if cmd_name != command && aliases.all? { |alias_name, _| alias_name != command }
 
-        if !defined?(ExtendCommand) || !ExtendCommand.const_defined?(cmd_class, false)
+        if !defined?(Command) || !Command.const_defined?(cmd_class, false)
           require_relative load_file
         end
-        return ExtendCommand.const_get(cmd_class, false)
+        return Command.const_get(cmd_class, false)
       end
       nil
     end
@@ -262,7 +267,7 @@ module IRB # :nodoc:
       line = __LINE__; eval %[
         def #{cmd_name}(*opts, **kwargs, &b)
           Kernel.require_relative "#{load_file}"
-          ::IRB::ExtendCommand::#{cmd_class}.execute(irb_context, *opts, **kwargs, &b)
+          ::IRB::Command::#{cmd_class}.execute(irb_context, *opts, **kwargs, &b)
         end
       ], nil, __FILE__, line
 
@@ -310,45 +315,4 @@ module IRB # :nodoc:
 
     install_extend_commands
   end
-
-  # Extends methods for the Context module
-  module ContextExtender
-    CE = ContextExtender # :nodoc:
-
-    @EXTEND_COMMANDS = [
-      [:eval_history=, "ext/eval_history.rb"],
-      [:use_tracer=, "ext/tracer.rb"],
-      [:use_loader=, "ext/use-loader.rb"],
-    ]
-
-    # Installs the default context extensions as irb commands:
-    #
-    # Context#eval_history=::   +irb/ext/history.rb+
-    # Context#use_tracer=::     +irb/ext/tracer.rb+
-    # Context#use_loader=::     +irb/ext/use-loader.rb+
-    def self.install_extend_commands
-      for args in @EXTEND_COMMANDS
-        def_extend_command(*args)
-      end
-    end
-
-    # Evaluate the given +command+ from the given +load_file+ on the Context
-    # module.
-    #
-    # Will also define any given +aliases+ for the method.
-    def self.def_extend_command(cmd_name, load_file, *aliases)
-      line = __LINE__; Context.module_eval %[
-        def #{cmd_name}(*opts, &b)
-          Context.module_eval {remove_method(:#{cmd_name})}
-          require_relative "#{load_file}"
-          __send__ :#{cmd_name}, *opts, &b
-        end
-        for ali in aliases
-          alias_method ali, cmd_name
-        end
-      ], __FILE__, line
-    end
-
-    CE.install_extend_commands
-  end
 end

data/lib/irb/completion.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 #
 #   irb/completion.rb -
 #   	by Keiju ISHITSUKA(keiju@ishitsuka.com)

data/lib/irb/context.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 #
 #   irb/context.rb - irb context
 #   	by Keiju ISHITSUKA(keiju@ruby-lang.org)
@@ -22,10 +22,11 @@ module IRB
     # +other+::   uses this as InputMethod
     def initialize(irb, workspace = nil, input_method = nil)
       @irb = irb
+      @workspace_stack = []
       if workspace
-        @workspace = workspace
+        @workspace_stack << workspace
       else
-        @workspace = WorkSpace.new
+        @workspace_stack << WorkSpace.new
       end
       @thread = Thread.current
 
@@ -61,7 +62,7 @@ module IRB
       @io = nil
 
       self.inspect_mode = IRB.conf[:INSPECT_MODE]
-      self.use_tracer = IRB.conf[:USE_TRACER] if IRB.conf[:USE_TRACER]
+      self.use_tracer = IRB.conf[:USE_TRACER]
       self.use_loader = IRB.conf[:USE_LOADER] if IRB.conf[:USE_LOADER]
       self.eval_history = IRB.conf[:EVAL_HISTORY] if IRB.conf[:EVAL_HISTORY]
 
@@ -77,7 +78,7 @@ module IRB
       else
         @irb_name = IRB.conf[:IRB_NAME]+"#"+IRB.JobManager.n_jobs.to_s
       end
-      @irb_path = "(" + @irb_name + ")"
+      self.irb_path = "(" + @irb_name + ")"
 
       case input_method
       when nil
@@ -121,11 +122,11 @@ module IRB
       when '-'
         @io = FileInputMethod.new($stdin)
         @irb_name = '-'
-        @irb_path = '-'
+        self.irb_path = '-'
       when String
         @io = FileInputMethod.new(input_method)
         @irb_name = File.basename(input_method)
-        @irb_path = input_method
+        self.irb_path = input_method
       else
         @io = input_method
       end
@@ -161,6 +162,23 @@ module IRB
 
     private_constant :KEYWORD_ALIASES
 
+    def use_tracer=(val)
+      require_relative "ext/tracer" if val
+      IRB.conf[:USE_TRACER] = val
+    end
+
+    def eval_history=(val)
+      self.class.remove_method(__method__)
+      require_relative "ext/eval_history"
+      __send__(__method__, val)
+    end
+
+    def use_loader=(val)
+      self.class.remove_method(__method__)
+      require_relative "ext/use-loader"
+      __send__(__method__, val)
+    end
+
     private def build_completor
       completor_type = IRB.conf[:COMPLETOR]
       case completor_type
@@ -178,7 +196,7 @@ module IRB
 
     private def build_type_completor
       if RUBY_ENGINE == 'truffleruby'
-        # Avoid SynatxError. truffleruby does not support endless method definition yet.
+        # Avoid SyntaxError. truffleruby does not support endless method definition yet.
         warn 'TypeCompletor is not supported on TruffleRuby yet'
         return
       end
@@ -212,15 +230,24 @@ module IRB
       IRB.conf[:HISTORY_FILE] = hist
     end
 
+    # Workspace in the current context.
+    def workspace
+      @workspace_stack.last
+    end
+
+    # Replace the current workspace with the given +workspace+.
+    def replace_workspace(workspace)
+      @workspace_stack.pop
+      @workspace_stack.push(workspace)
+    end
+
     # The top-level workspace, see WorkSpace#main
     def main
-      @workspace.main
+      workspace.main
     end
 
     # The toplevel workspace, see #home_workspace
     attr_reader :workspace_home
-    # WorkSpace in the current context.
-    attr_accessor :workspace
     # The current thread in this context.
     attr_reader :thread
     # The current input method.
@@ -241,9 +268,27 @@ module IRB
     # Can be either name from <code>IRB.conf[:IRB_NAME]</code>, or the number of
     # the current job set by JobManager, such as <code>irb#2</code>
     attr_accessor :irb_name
-    # Can be either the #irb_name surrounded by parenthesis, or the
-    # +input_method+ passed to Context.new
-    attr_accessor :irb_path
+
+    # Can be one of the following:
+    # - the #irb_name surrounded by parenthesis
+    # - the +input_method+ passed to Context.new
+    # - the file path of the current IRB context in a binding.irb session
+    attr_reader :irb_path
+
+    # Sets @irb_path to the given +path+ as well as @eval_path
+    # @eval_path is used for evaluating code in the context of IRB session
+    # It's the same as irb_path, but with the IRB name postfix
+    # This makes sure users can distinguish the methods defined in the IRB session
+    # from the methods defined in the current file's context, especially with binding.irb
+    def irb_path=(path)
+      @irb_path = path
+
+      if File.exist?(path)
+        @eval_path = "#{path}(#{IRB.conf[:IRB_NAME]})"
+      else
+        @eval_path = path
+      end
+    end
 
     # Whether multiline editor mode is enabled or not.
     #
@@ -444,9 +489,7 @@ module IRB
     # StdioInputMethod or RelineInputMethod or ReadlineInputMethod, see #io
     # for more information.
     def prompting?
-      verbose? || (STDIN.tty? && @io.kind_of?(StdioInputMethod) ||
-                   @io.kind_of?(RelineInputMethod) ||
-                   (defined?(ReadlineInputMethod) && @io.kind_of?(ReadlineInputMethod)))
+      verbose? || @io.prompting?
     end
 
     # The return value of the last statement evaluated.
@@ -456,7 +499,7 @@ module IRB
     # to #last_value.
     def set_last_value(value)
       @last_value = value
-      @workspace.local_variable_set :_, value
+      workspace.local_variable_set :_, value
     end
 
     # Sets the +mode+ of the prompt in this context.
@@ -552,7 +595,7 @@ module IRB
 
       if IRB.conf[:MEASURE] && !IRB.conf[:MEASURE_CALLBACKS].empty?
         last_proc = proc do
-          result = @workspace.evaluate(line, irb_path, line_no)
+          result = workspace.evaluate(line, @eval_path, line_no)
         end
         IRB.conf[:MEASURE_CALLBACKS].inject(last_proc) do |chain, item|
           _name, callback, arg = item
@@ -563,7 +606,7 @@ module IRB
           end
         end.call
       else
-        result = @workspace.evaluate(line, irb_path, line_no)
+        result = workspace.evaluate(line, @eval_path, line_no)
       end
 
       set_last_value(result)

data/lib/irb/ext/change-ws.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 #
 #   irb/ext/cb.rb -
 #   	by Keiju ISHITSUKA(keiju@ruby-lang.org)
@@ -12,7 +12,7 @@ module IRB # :nodoc:
       if defined? @home_workspace
         @home_workspace
       else
-        @home_workspace = @workspace
+        @home_workspace = workspace
       end
     end
 
@@ -25,11 +25,11 @@ module IRB # :nodoc:
     # See IRB::WorkSpace.new for more information.
     def change_workspace(*_main)
       if _main.empty?
-        @workspace = home_workspace
+        replace_workspace(home_workspace)
         return main
       end
 
-      @workspace = WorkSpace.new(_main[0])
+      replace_workspace(WorkSpace.new(_main[0]))
 
       if !(class<<main;ancestors;end).include?(ExtendCommandBundle)
         main.extend ExtendCommandBundle