irb 1.8.3 → 1.13.1

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/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
@@ -49,7 +49,7 @@ module IRB # :nodoc:
         else
           @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

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

data/lib/irb/helper_method/base.rb

@@ -0,0 +1,16 @@
+require "singleton"
+
+module IRB
+  module HelperMethod
+    class Base
+      include Singleton
+
+      class << self
+        def description(description = nil)
+          @description = description if description
+          @description
+        end
+      end
+    end
+  end
+end

data/lib/irb/helper_method/conf.rb

@@ -0,0 +1,11 @@
+module IRB
+  module HelperMethod
+    class Conf < Base
+      description "Returns the current IRB context."
+
+      def execute
+        IRB.CurrentContext
+      end
+    end
+  end
+end

data/lib/irb/helper_method.rb

@@ -0,0 +1,29 @@
+require_relative "helper_method/base"
+
+module IRB
+  module HelperMethod
+    @helper_methods = {}
+
+    class << self
+      attr_reader :helper_methods
+
+      def register(name, helper_class)
+        @helper_methods[name] = helper_class
+
+        if defined?(HelpersContainer)
+          HelpersContainer.install_helper_methods
+        end
+      end
+
+      def all_helper_methods_info
+        @helper_methods.map do |name, helper_class|
+          { display_name: name, description: helper_class.description }
+        end
+      end
+    end
+
+    # Default helper_methods
+    require_relative "helper_method/conf"
+    register(:conf, HelperMethod::Conf)
+  end
+end

data/lib/irb/history.rb

@@ -1,3 +1,5 @@
+require "pathname"
+
 module IRB
   module HistorySavingAbility # :nodoc:
     def support_history_saving?
@@ -5,7 +7,7 @@ module IRB
     end
 
     def reset_history_counter
-      @loaded_history_lines = self.class::HISTORY.size if defined? @loaded_history_lines
+      @loaded_history_lines = self.class::HISTORY.size
     end
 
     def load_history
@@ -15,7 +17,7 @@ module IRB
         history_file = File.expand_path(history_file)
       end
       history_file = IRB.rc_file("_history") unless history_file
-      if File.exist?(history_file)
+      if history_file && File.exist?(history_file)
         File.open(history_file, "r:#{IRB.conf[:LC_MESSAGES].encoding}") do |f|
           f.each { |l|
             l = l.chomp
@@ -41,6 +43,9 @@ module IRB
         end
         history_file = IRB.rc_file("_history") unless history_file
 
+        # When HOME and XDG_CONFIG_HOME are not available, history_file might be nil
+        return unless history_file
+
         # Change the permission of a file that already exists[BUG #7694]
         begin
           if File.stat(history_file).mode & 066 != 0
@@ -59,13 +64,19 @@ module IRB
           append_history = true
         end
 
+        pathname = Pathname.new(history_file)
+        unless Dir.exist?(pathname.dirname)
+          warn "Warning: The directory to save IRB's history file does not exist. Please double check `IRB.conf[:HISTORY_FILE]`'s value."
+          return
+        end
+
         File.open(history_file, (append_history ? 'a' : 'w'), 0o600, encoding: IRB.conf[:LC_MESSAGES]&.encoding) do |f|
-          hist = history.map{ |l| l.split("\n").join("\\\n") }
+          hist = history.map{ |l| l.scrub.split("\n").join("\\\n") }
           unless append_history
             begin
               hist = hist.last(num) if hist.size > num and num > 0
             rescue RangeError # bignum too big to convert into `long'
-              # Do nothing because the bignum should be treated as inifinity
+              # Do nothing because the bignum should be treated as infinity
             end
           end
           f.puts(hist)