irb 1.7.1 → 1.13.2

data/lib/irb/default_commands.rb

@@ -0,0 +1,265 @@
+# frozen_string_literal: true
+
+require_relative "command"
+require_relative "command/internal_helpers"
+require_relative "command/backtrace"
+require_relative "command/break"
+require_relative "command/catch"
+require_relative "command/chws"
+require_relative "command/context"
+require_relative "command/continue"
+require_relative "command/debug"
+require_relative "command/delete"
+require_relative "command/disable_irb"
+require_relative "command/edit"
+require_relative "command/exit"
+require_relative "command/finish"
+require_relative "command/force_exit"
+require_relative "command/help"
+require_relative "command/history"
+require_relative "command/info"
+require_relative "command/irb_info"
+require_relative "command/load"
+require_relative "command/ls"
+require_relative "command/measure"
+require_relative "command/next"
+require_relative "command/pushws"
+require_relative "command/show_doc"
+require_relative "command/show_source"
+require_relative "command/step"
+require_relative "command/subirb"
+require_relative "command/whereami"
+
+module IRB
+  module Command
+    NO_OVERRIDE = 0
+    OVERRIDE_PRIVATE_ONLY = 0x01
+    OVERRIDE_ALL = 0x02
+
+    class << self
+      # This API is for IRB's internal use only and may change at any time.
+      # Please do NOT use it.
+      def _register_with_aliases(name, command_class, *aliases)
+        @commands[name.to_sym] = [command_class, aliases]
+      end
+
+      def all_commands_info
+        user_aliases = IRB.CurrentContext.command_aliases.each_with_object({}) do |(alias_name, target), result|
+          result[target] ||= []
+          result[target] << alias_name
+        end
+
+        commands.map do |command_name, (command_class, aliases)|
+          aliases = aliases.map { |a| a.first }
+
+          if additional_aliases = user_aliases[command_name]
+            aliases += additional_aliases
+          end
+
+          display_name = aliases.shift || command_name
+          {
+            display_name: display_name,
+            description: command_class.description,
+            category: command_class.category
+          }
+        end
+      end
+
+      def command_override_policies
+        @@command_override_policies ||= commands.flat_map do |cmd_name, (cmd_class, aliases)|
+          [[cmd_name, OVERRIDE_ALL]] + aliases
+        end.to_h
+      end
+
+      def execute_as_command?(name, public_method:, private_method:)
+        case command_override_policies[name]
+        when OVERRIDE_ALL
+          true
+        when OVERRIDE_PRIVATE_ONLY
+          !public_method
+        when NO_OVERRIDE
+          !public_method && !private_method
+        end
+      end
+
+      def command_names
+        command_override_policies.keys.map(&:to_s)
+      end
+
+      # Convert a command name to its implementation class if such command exists
+      def load_command(command)
+        command = command.to_sym
+        commands.each do |command_name, (command_class, aliases)|
+          if command_name == command || aliases.any? { |alias_name, _| alias_name == command }
+            return command_class
+          end
+        end
+        nil
+      end
+    end
+
+    _register_with_aliases(:irb_context, Command::Context,
+      [:context, NO_OVERRIDE]
+    )
+
+    _register_with_aliases(:irb_exit, Command::Exit,
+      [:exit, OVERRIDE_PRIVATE_ONLY],
+      [:quit, OVERRIDE_PRIVATE_ONLY],
+      [:irb_quit, OVERRIDE_PRIVATE_ONLY]
+    )
+
+    _register_with_aliases(:irb_exit!, Command::ForceExit,
+      [:exit!, OVERRIDE_PRIVATE_ONLY]
+    )
+
+    _register_with_aliases(:irb_current_working_workspace, Command::CurrentWorkingWorkspace,
+      [:cwws, NO_OVERRIDE],
+      [:pwws, NO_OVERRIDE],
+      [:irb_print_working_workspace, OVERRIDE_ALL],
+      [:irb_cwws, OVERRIDE_ALL],
+      [:irb_pwws, OVERRIDE_ALL],
+      [:irb_current_working_binding, OVERRIDE_ALL],
+      [:irb_print_working_binding, OVERRIDE_ALL],
+      [:irb_cwb, OVERRIDE_ALL],
+      [:irb_pwb, OVERRIDE_ALL],
+    )
+
+    _register_with_aliases(:irb_change_workspace, Command::ChangeWorkspace,
+      [:chws, NO_OVERRIDE],
+      [:cws, NO_OVERRIDE],
+      [:irb_chws, OVERRIDE_ALL],
+      [:irb_cws, OVERRIDE_ALL],
+      [:irb_change_binding, OVERRIDE_ALL],
+      [:irb_cb, OVERRIDE_ALL],
+      [:cb, NO_OVERRIDE],
+    )
+
+    _register_with_aliases(:irb_workspaces, Command::Workspaces,
+      [:workspaces, NO_OVERRIDE],
+      [:irb_bindings, OVERRIDE_ALL],
+      [:bindings, NO_OVERRIDE],
+    )
+
+    _register_with_aliases(:irb_push_workspace, Command::PushWorkspace,
+      [:pushws, NO_OVERRIDE],
+      [:irb_pushws, OVERRIDE_ALL],
+      [:irb_push_binding, OVERRIDE_ALL],
+      [:irb_pushb, OVERRIDE_ALL],
+      [:pushb, NO_OVERRIDE],
+    )
+
+    _register_with_aliases(:irb_pop_workspace, Command::PopWorkspace,
+      [:popws, NO_OVERRIDE],
+      [:irb_popws, OVERRIDE_ALL],
+      [:irb_pop_binding, OVERRIDE_ALL],
+      [:irb_popb, OVERRIDE_ALL],
+      [:popb, NO_OVERRIDE],
+    )
+
+    _register_with_aliases(:irb_load, Command::Load)
+    _register_with_aliases(:irb_require, Command::Require)
+    _register_with_aliases(:irb_source, Command::Source,
+      [:source, NO_OVERRIDE]
+    )
+
+    _register_with_aliases(:irb, Command::IrbCommand)
+    _register_with_aliases(:irb_jobs, Command::Jobs,
+      [:jobs, NO_OVERRIDE]
+    )
+    _register_with_aliases(:irb_fg, Command::Foreground,
+      [:fg, NO_OVERRIDE]
+    )
+    _register_with_aliases(:irb_kill, Command::Kill,
+      [:kill, OVERRIDE_PRIVATE_ONLY]
+    )
+
+    _register_with_aliases(:irb_debug, Command::Debug,
+      [:debug, NO_OVERRIDE]
+    )
+    _register_with_aliases(:irb_edit, Command::Edit,
+      [:edit, NO_OVERRIDE]
+    )
+
+    _register_with_aliases(:irb_break, Command::Break)
+    _register_with_aliases(:irb_catch, Command::Catch)
+    _register_with_aliases(:irb_next, Command::Next)
+    _register_with_aliases(:irb_delete, Command::Delete,
+      [:delete, NO_OVERRIDE]
+    )
+
+    _register_with_aliases(:irb_step, Command::Step,
+      [:step, NO_OVERRIDE]
+    )
+    _register_with_aliases(:irb_continue, Command::Continue,
+      [:continue, NO_OVERRIDE]
+    )
+    _register_with_aliases(:irb_finish, Command::Finish,
+      [:finish, NO_OVERRIDE]
+    )
+    _register_with_aliases(:irb_backtrace, Command::Backtrace,
+      [:backtrace, NO_OVERRIDE],
+      [:bt, NO_OVERRIDE]
+    )
+
+    _register_with_aliases(:irb_debug_info, Command::Info,
+      [:info, NO_OVERRIDE]
+    )
+
+    _register_with_aliases(:irb_help, Command::Help,
+      [:help, NO_OVERRIDE],
+      [:show_cmds, NO_OVERRIDE]
+    )
+
+    _register_with_aliases(:irb_show_doc, Command::ShowDoc,
+      [:show_doc, NO_OVERRIDE]
+    )
+
+    _register_with_aliases(:irb_info, Command::IrbInfo)
+
+    _register_with_aliases(:irb_ls, Command::Ls,
+      [:ls, NO_OVERRIDE]
+    )
+
+    _register_with_aliases(:irb_measure, Command::Measure,
+      [:measure, NO_OVERRIDE]
+    )
+
+    _register_with_aliases(:irb_show_source, Command::ShowSource,
+      [:show_source, NO_OVERRIDE]
+    )
+
+    _register_with_aliases(:irb_whereami, Command::Whereami,
+      [:whereami, NO_OVERRIDE]
+    )
+
+    _register_with_aliases(:irb_history, Command::History,
+      [:history, NO_OVERRIDE],
+      [:hist, NO_OVERRIDE]
+    )
+
+    _register_with_aliases(:irb_disable_irb, Command::DisableIrb,
+      [:disable_irb, NO_OVERRIDE]
+    )
+  end
+
+  ExtendCommand = Command
+
+  # For backward compatibility, we need to keep this module:
+  # - As a container of helper methods
+  # - As a place to register commands with the deprecated def_extend_command method
+  module ExtendCommandBundle
+    # For backward compatibility
+    NO_OVERRIDE = Command::NO_OVERRIDE
+    OVERRIDE_PRIVATE_ONLY = Command::OVERRIDE_PRIVATE_ONLY
+    OVERRIDE_ALL = Command::OVERRIDE_ALL
+
+    # Deprecated. Doesn't have any effect.
+    @EXTEND_COMMANDS = []
+
+    # Drepcated. Use Command.regiser instead.
+    def self.def_extend_command(cmd_name, cmd_class, _, *aliases)
+      Command._register_with_aliases(cmd_name, cmd_class, *aliases)
+      Command.class_variable_set(:@@command_override_policies, nil)
+    end
+  end
+end

data/lib/irb/easter-egg.rb

@@ -98,18 +98,26 @@ module IRB
       end
     end
 
+    private def easter_egg_logo(type)
+      @easter_egg_logos ||= File.read(File.join(__dir__, 'ruby_logo.aa'), encoding: 'UTF-8:UTF-8')
+        .split(/TYPE: ([A-Z]+)\n/)[1..]
+        .each_slice(2)
+        .to_h
+      @easter_egg_logos[type.to_s.upcase]
+    end
+
     private def easter_egg(type = nil)
       type ||= [:logo, :dancing].sample
       case type
       when :logo
-        File.open(File.join(__dir__, 'ruby_logo.aa')) do |f|
-          require "rdoc"
-          RDoc::RI::Driver.new.page do |io|
-            IO.copy_stream(f, io)
-          end
+        require "rdoc"
+        RDoc::RI::Driver.new.page do |io|
+          io.write easter_egg_logo(:large)
         end
       when :dancing
-        begin
+        STDOUT.cooked do
+          interrupted = false
+          prev_trap = trap("SIGINT") { interrupted = true }
           canvas = Canvas.new(Reline.get_screen_size)
           Reline::IOGate.set_winch_handler do
             canvas = Canvas.new(Reline.get_screen_size)
@@ -125,10 +133,12 @@ module IRB
             buff[0, 20] = "\e[0mPress Ctrl+C to stop\e[31m\e[1m"
             print "\e[H" + buff
             sleep 0.05
+            break if interrupted
           end
         rescue Interrupt
         ensure
           print "\e[0m\e[?1049l"
+          trap("SIGINT", prev_trap)
         end
       end
     end

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,15 +25,13 @@ 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])
-
-      if !(class<<main;ancestors;end).include?(ExtendCommandBundle)
-        main.extend ExtendCommandBundle
-      end
+      workspace = WorkSpace.new(_main[0])
+      replace_workspace(workspace)
+      workspace.load_helper_methods_to_main
     end
   end
 end

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

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 #
 #   history.rb -
 #   	by Keiju ISHITSUKA(keiju@ruby-lang.org)
@@ -18,7 +18,7 @@ module IRB # :nodoc:
 
       if defined?(@eval_history) && @eval_history
         @eval_history_values.push @line_no, @last_value
-        @workspace.evaluate "__ = IRB.CurrentContext.instance_eval{@eval_history_values}"
+        workspace.evaluate "__ = IRB.CurrentContext.instance_eval{@eval_history_values}"
       end
 
       @last_value
@@ -40,16 +40,16 @@ 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__]")
+          workspace.evaluate("__ = IRB.conf[:__TMP__EHV__]")
           IRB.conf.delete(:__TMP_EHV__)
         end
       else
@@ -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

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 #
 #   loader.rb -
 #   	by Keiju ISHITSUKA(keiju@ruby-lang.org)
@@ -98,13 +98,13 @@ module IRB # :nodoc:
 
     def old # :nodoc:
       back_io = @io
-      back_path = @irb_path
+      back_path = irb_path
       back_name = @irb_name
       back_scanner = @irb.scanner
       begin
         @io = FileInputMethod.new(path)
         @irb_name = File.basename(path)
-        @irb_path = path
+        self.irb_path = path
         @irb.signal_status(:IN_LOAD) do
           if back_io.kind_of?(FileInputMethod)
             @irb.eval_input
@@ -119,7 +119,7 @@ module IRB # :nodoc:
       ensure
         @io = back_io
         @irb_name = back_name
-        @irb_path = back_path
+        self.irb_path = back_path
         @irb.scanner = back_scanner
       end
     end

data/lib/irb/ext/multi-irb.rb

@@ -1,11 +1,11 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 #
 #   irb/multi-irb.rb - multiple irb module
 #   	by Keiju ISHITSUKA(keiju@ruby-lang.org)
 #
 
 module IRB
-  class JobManager
+  class JobManager # :nodoc:
 
     # Creates a new JobManager object
     def initialize
@@ -166,12 +166,12 @@ module IRB
   @JobManager = JobManager.new
 
   # The current JobManager in the session
-  def IRB.JobManager
+  def IRB.JobManager # :nodoc:
     @JobManager
   end
 
   # The current Context in this session
-  def IRB.CurrentContext
+  def IRB.CurrentContext # :nodoc:
     IRB.JobManager.irb(Thread.current).context
   end
 
@@ -179,7 +179,7 @@ module IRB
   #
   # The optional +file+ argument is given to Context.new, along with the
   # workspace created with the remaining arguments, see WorkSpace.new
-  def IRB.irb(file = nil, *main)
+  def IRB.irb(file = nil, *main) # :nodoc:
     workspace = WorkSpace.new(*main)
     parent_thread = Thread.current
     Thread.start do

data/lib/irb/ext/tracer.rb

@@ -1,78 +1,39 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 #
 #   irb/lib/tracer.rb -
 #   	by Keiju ISHITSUKA(keiju@ruby-lang.org)
 #
-
+# Loading the gem "tracer" will cause it to extend IRB commands with:
+# https://github.com/ruby/tracer/blob/v0.2.2/lib/tracer/irb.rb
 begin
   require "tracer"
 rescue LoadError
   $stderr.puts "Tracer extension of IRB is enabled but tracer gem wasn't found."
-  module IRB
-    class Context
-      def use_tracer=(opt)
-        # do nothing
-      end
-    end
-  end
   return # This is about to disable loading below
 end
 
 module IRB
+  class CallTracer < ::CallTracer
+    IRB_DIR = File.expand_path('../..', __dir__)
 
-  # initialize tracing function
-  def IRB.initialize_tracer
-    Tracer.verbose = false
-    Tracer.add_filter {
-      |event, file, line, id, binding, *rests|
-      /^#{Regexp.quote(@CONF[:IRB_LIB_PATH])}/ !~ file and
-        File::basename(file) != "irb.rb"
-    }
-  end
-
-  class Context
-    # Whether Tracer is used when evaluating statements in this context.
-    #
-    # See +lib/tracer.rb+ for more information.
-    attr_reader :use_tracer
-    alias use_tracer? use_tracer
-
-    # Sets whether or not to use the Tracer library when evaluating statements
-    # in this context.
-    #
-    # See +lib/tracer.rb+ for more information.
-    def use_tracer=(opt)
-      if opt
-        Tracer.set_get_line_procs(@irb_path) {
-          |line_no, *rests|
-          @io.line(line_no)
-        }
-      elsif !opt && @use_tracer
-        Tracer.off
-      end
-      @use_tracer=opt
+    def skip?(tp)
+      super || tp.path.match?(IRB_DIR) || tp.path.match?('<internal:prelude>')
     end
   end
-
   class WorkSpace
     alias __evaluate__ evaluate
     # Evaluate the context of this workspace and use the Tracer library to
     # output the exact lines of code are being executed in chronological order.
     #
-    # See +lib/tracer.rb+ for more information.
-    def evaluate(context, statements, file = nil, line = nil)
-      if context.use_tracer? && file != nil && line != nil
-        Tracer.on
-        begin
+    # See https://github.com/ruby/tracer for more information.
+    def evaluate(statements, file = __FILE__, line = __LINE__)
+      if IRB.conf[:USE_TRACER] == true
+        CallTracer.new(colorize: Color.colorable?).start do
           __evaluate__(statements, file, line)
-        ensure
-          Tracer.off
         end
       else
-        __evaluate__(statements, file || __FILE__, line || __LINE__)
+        __evaluate__(statements, file, line)
       end
     end
   end
-
-  IRB.initialize_tracer
 end

data/lib/irb/ext/use-loader.rb

@@ -1,10 +1,10 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 #
 #   use-loader.rb -
 #   	by Keiju ISHITSUKA(keiju@ruby-lang.org)
 #
 
-require_relative "../cmd/load"
+require_relative "../command/load"
 require_relative "loader"
 
 class Object
@@ -17,12 +17,12 @@ module IRB
     remove_method :irb_load if method_defined?(:irb_load)
     # Loads the given file similarly to Kernel#load, see IrbLoader#irb_load
     def irb_load(*opts, &b)
-      ExtendCommand::Load.execute(irb_context, *opts, &b)
+      Command::Load.execute(irb_context, *opts, &b)
     end
     remove_method :irb_require if method_defined?(:irb_require)
     # Loads the given file similarly to Kernel#require
     def irb_require(*opts, &b)
-      ExtendCommand::Require.execute(irb_context, *opts, &b)
+      Command::Require.execute(irb_context, *opts, &b)
     end
   end
 
@@ -49,14 +49,12 @@ module IRB
       if IRB.conf[:USE_LOADER] != opt
         IRB.conf[:USE_LOADER] = opt
         if opt
-          if !$".include?("irb/cmd/load")
-          end
-          (class<<@workspace.main;self;end).instance_eval {
+          (class<<workspace.main;self;end).instance_eval {
             alias_method :load, :irb_load
             alias_method :require, :irb_require
           }
         else
-          (class<<@workspace.main;self;end).instance_eval {
+          (class<<workspace.main;self;end).instance_eval {
             alias_method :load, :__original__load__IRB_use_loader__
             alias_method :require, :__original__require__IRB_use_loader__
           }

data/lib/irb/ext/workspaces.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 #
 #   push-ws.rb -
 #   	by Keiju ISHITSUKA(keiju@ruby-lang.org)
@@ -6,21 +6,6 @@
 
 module IRB # :nodoc:
   class Context
-
-    # Size of the current WorkSpace stack
-    def irb_level
-      workspace_stack.size
-    end
-
-    # WorkSpaces in the current stack
-    def workspaces
-      if defined? @workspaces
-        @workspaces
-      else
-        @workspaces = []
-      end
-    end
-
     # Creates a new workspace with the given object or binding, and appends it
     # onto the current #workspaces stack.
     #
@@ -28,20 +13,15 @@ module IRB # :nodoc:
     # information.
     def push_workspace(*_main)
       if _main.empty?
-        if workspaces.empty?
-          print "No other workspace\n"
-          return nil
+        if @workspace_stack.size > 1
+          # swap the top two workspaces
+          previous_workspace, current_workspace = @workspace_stack.pop(2)
+          @workspace_stack.push current_workspace, previous_workspace
         end
-        ws = workspaces.pop
-        workspaces.push @workspace
-        @workspace = ws
-        return workspaces
-      end
-
-      workspaces.push @workspace
-      @workspace = WorkSpace.new(@workspace.binding, _main[0])
-      if !(class<<main;ancestors;end).include?(ExtendCommandBundle)
-        main.extend ExtendCommandBundle
+      else
+        new_workspace = WorkSpace.new(workspace.binding, _main[0])
+        @workspace_stack.push new_workspace
+        new_workspace.load_helper_methods_to_main
       end
     end
 
@@ -50,11 +30,7 @@ module IRB # :nodoc:
     #
     # Also, see #push_workspace.
     def pop_workspace
-      if workspaces.empty?
-        print "workspace stack empty\n"
-        return
-      end
-      @workspace = workspaces.pop
+      @workspace_stack.pop if @workspace_stack.size > 1
     end
   end
 end

data/lib/irb/frame.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 #
 #   frame.rb -
 #   	by Keiju ISHITSUKA(Nihon Rational Software Co.,Ltd)

data/lib/irb/help.rb

@@ -1,12 +1,12 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 #
 #   irb/help.rb - print usage module
 #   	by Keiju ISHITSUKA(keiju@ishitsuka.com)
 #
 
 module IRB
-  # Outputs the irb help message, see IRB@Command+line+options.
-  def IRB.print_usage
+  # Outputs the irb help message, see IRB@Command-Line+Options.
+  def IRB.print_usage # :nodoc:
     lc = IRB.conf[:LC_MESSAGES]
     path = lc.find("irb/help-message")
     space_line = false