irb 1.12.0 → 1.13.0

data/lib/irb/default_commands.rb

@@ -0,0 +1,260 @@
+# frozen_string_literal: true
+
+require_relative "command"
+require_relative "command/internal_helpers"
+require_relative "command/context"
+require_relative "command/exit"
+require_relative "command/force_exit"
+require_relative "command/chws"
+require_relative "command/pushws"
+require_relative "command/subirb"
+require_relative "command/load"
+require_relative "command/debug"
+require_relative "command/edit"
+require_relative "command/break"
+require_relative "command/catch"
+require_relative "command/next"
+require_relative "command/delete"
+require_relative "command/step"
+require_relative "command/continue"
+require_relative "command/finish"
+require_relative "command/backtrace"
+require_relative "command/info"
+require_relative "command/help"
+require_relative "command/show_doc"
+require_relative "command/irb_info"
+require_relative "command/ls"
+require_relative "command/measure"
+require_relative "command/show_source"
+require_relative "command/whereami"
+require_relative "command/history"
+
+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]
+    )
+  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/ext/change-ws.rb

@@ -29,11 +29,9 @@ module IRB # :nodoc:
         return main
       end
 
-      replace_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/multi-irb.rb

@@ -5,7 +5,7 @@
 #
 
 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/workspaces.rb

@@ -19,10 +19,9 @@ module IRB # :nodoc:
           @workspace_stack.push current_workspace, previous_workspace
         end
       else
-        @workspace_stack.push WorkSpace.new(workspace.binding, _main[0])
-        if !(class<<main;ancestors;end).include?(ExtendCommandBundle)
-          main.extend ExtendCommandBundle
-        end
+        new_workspace = WorkSpace.new(workspace.binding, _main[0])
+        @workspace_stack.push new_workspace
+        new_workspace.load_helper_methods_to_main
       end
     end
 

data/lib/irb/help.rb

@@ -6,7 +6,7 @@
 
 module IRB
   # Outputs the irb help message, see IRB@Command-Line+Options.
-  def IRB.print_usage
+  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 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

@@ -16,8 +16,8 @@ module IRB
       if history_file = IRB.conf[:HISTORY_FILE]
         history_file = File.expand_path(history_file)
       end
-      history_file = IRB.rc_files("_history").first unless history_file
-      if File.exist?(history_file)
+      history_file = IRB.rc_file("_history") unless 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,7 +41,10 @@ module IRB
         if history_file = IRB.conf[:HISTORY_FILE]
           history_file = File.expand_path(history_file)
         end
-        history_file = IRB.rc_files("_history").first unless history_file
+        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

data/lib/irb/init.rb

@@ -395,10 +395,8 @@ module IRB # :nodoc:
   # Run the config file
   def IRB.run_config
     if @CONF[:RC]
-      rc_files.each do |rc|
-        # Because rc_file always returns `HOME/.irbrc` even if no rc file is present, we can't warn users about missing rc files.
-        # Otherwise, it'd be very noisy.
-        load rc if File.exist?(rc)
+      irbrc_files.each do |rc|
+        load rc
       rescue StandardError, ScriptError => e
         warn "Error loading RC file '#{rc}':\n#{e.full_message(highlight: false)}"
       end
@@ -406,53 +404,27 @@ module IRB # :nodoc:
   end
 
   IRBRC_EXT = "rc"
-  def IRB.rc_file(ext = IRBRC_EXT)
-    warn "rc_file is deprecated, please use rc_files instead."
-    rc_files(ext).first
-  end
-
-  def IRB.rc_files(ext = IRBRC_EXT)
-    if !@CONF[:RC_NAME_GENERATOR]
-      @CONF[:RC_NAME_GENERATOR] ||= []
-      existing_rc_file_generators = []
 
-      rc_file_generators do |rcgen|
-        @CONF[:RC_NAME_GENERATOR] << rcgen
-        existing_rc_file_generators << rcgen if File.exist?(rcgen.call(ext))
-      end
+  def IRB.rc_file(ext)
+    prepare_irbrc_name_generators
 
-      if existing_rc_file_generators.any?
-        @CONF[:RC_NAME_GENERATOR] = existing_rc_file_generators
-      end
+    # When irbrc exist in default location
+    if (rcgen = @existing_rc_name_generators.first)
+      return rcgen.call(ext)
     end
 
-    @CONF[:RC_NAME_GENERATOR].map do |rc|
-      rc_file = rc.call(ext)
-      fail IllegalRCNameGenerator unless rc_file.is_a?(String)
-      rc_file
+    # When irbrc does not exist in default location
+    rc_file_generators do |rcgen|
+      return rcgen.call(ext)
     end
+
+    # When HOME and XDG_CONFIG_HOME are not available
+    nil
   end
 
-  # enumerate possible rc-file base name generators
-  def IRB.rc_file_generators
-    if irbrc = ENV["IRBRC"]
-      yield proc{|rc| rc == "rc" ? irbrc : irbrc+rc}
-    end
-    if xdg_config_home = ENV["XDG_CONFIG_HOME"]
-      irb_home = File.join(xdg_config_home, "irb")
-      if File.directory?(irb_home)
-        yield proc{|rc| irb_home + "/irb#{rc}"}
-      end
-    end
-    if home = ENV["HOME"]
-      yield proc{|rc| home+"/.irb#{rc}"}
-      yield proc{|rc| home+"/.config/irb/irb#{rc}"}
-    end
-    current_dir = Dir.pwd
-    yield proc{|rc| current_dir+"/.irb#{rc}"}
-    yield proc{|rc| current_dir+"/irb#{rc.sub(/\A_?/, '.')}"}
-    yield proc{|rc| current_dir+"/_irb#{rc}"}
-    yield proc{|rc| current_dir+"/$irb#{rc}"}
+  def IRB.irbrc_files
+    prepare_irbrc_name_generators
+    @irbrc_files
   end
 
   # loading modules
@@ -468,6 +440,50 @@ module IRB # :nodoc:
 
   class << IRB
     private
+
+    def prepare_irbrc_name_generators
+      return if @existing_rc_name_generators
+
+      @existing_rc_name_generators = []
+      @irbrc_files = []
+      rc_file_generators do |rcgen|
+        irbrc = rcgen.call(IRBRC_EXT)
+        if File.exist?(irbrc)
+          @irbrc_files << irbrc
+          @existing_rc_name_generators << rcgen
+        end
+      end
+      generate_current_dir_irbrc_files.each do |irbrc|
+        @irbrc_files << irbrc if File.exist?(irbrc)
+      end
+      @irbrc_files.uniq!
+    end
+
+    # enumerate possible rc-file base name generators
+    def rc_file_generators
+      if irbrc = ENV["IRBRC"]
+        yield proc{|rc| rc == "rc" ? irbrc : irbrc+rc}
+      end
+      if xdg_config_home = ENV["XDG_CONFIG_HOME"]
+        irb_home = File.join(xdg_config_home, "irb")
+        if File.directory?(irb_home)
+          yield proc{|rc| irb_home + "/irb#{rc}"}
+        end
+      end
+      if home = ENV["HOME"]
+        yield proc{|rc| home+"/.irb#{rc}"}
+        if xdg_config_home.nil? || xdg_config_home.empty?
+          yield proc{|rc| home+"/.config/irb/irb#{rc}"}
+        end
+      end
+    end
+
+    # possible irbrc files in current directory
+    def generate_current_dir_irbrc_files
+      current_dir = Dir.pwd
+      %w[.irbrc irbrc _irbrc $irbrc].map { |file| "#{current_dir}/#{file}" }
+    end
+
     def set_encoding(extern, intern = nil, override: true)
       verbose, $VERBOSE = $VERBOSE, nil
       Encoding.default_external = extern unless extern.nil? || extern.empty?

data/lib/irb/input-method.rb

@@ -308,6 +308,20 @@ module IRB
       @completor.doc_namespace(preposing, matched, postposing, bind: bind)
     end
 
+    def rdoc_ri_driver
+      return @rdoc_ri_driver if defined?(@rdoc_ri_driver)
+
+      begin
+        require 'rdoc'
+      rescue LoadError
+        @rdoc_ri_driver = nil
+      else
+        options = {}
+        options[:extra_doc_dirs] = IRB.conf[:EXTRA_DOC_DIRS] unless IRB.conf[:EXTRA_DOC_DIRS].empty?
+        @rdoc_ri_driver = RDoc::RI::Driver.new(options)
+      end
+    end
+
     def show_doc_dialog_proc
       input_method = self # self is changed in the lambda below.
       ->() {
@@ -331,9 +345,7 @@ module IRB
 
         show_easter_egg = name&.match?(/\ARubyVM/) && !ENV['RUBY_YES_I_AM_NOT_A_NORMAL_USER']
 
-        options = {}
-        options[:extra_doc_dirs] = IRB.conf[:EXTRA_DOC_DIRS] unless IRB.conf[:EXTRA_DOC_DIRS].empty?
-        driver = RDoc::RI::Driver.new(options)
+        driver = input_method.rdoc_ri_driver
 
         if key.match?(dialog.name)
           if show_easter_egg
@@ -421,12 +433,9 @@ module IRB
       }
     end
 
-    def display_document(matched, driver: nil)
-      begin
-        require 'rdoc'
-      rescue LoadError
-        return
-      end
+    def display_document(matched)
+      driver = rdoc_ri_driver
+      return unless driver
 
       if matched =~ /\A(?:::)?RubyVM/ and not ENV['RUBY_YES_I_AM_NOT_A_NORMAL_USER']
         IRB.__send__(:easter_egg)
@@ -436,7 +445,6 @@ module IRB
       namespace = retrieve_doc_namespace(matched)
       return unless namespace
 
-      driver ||= RDoc::RI::Driver.new
       if namespace.is_a?(Array)
         out = RDoc::Markup::Document.new
         namespace.each do |m|

data/lib/irb/lc/error.rb

@@ -47,11 +47,6 @@ module IRB
       super("Undefined prompt mode(#{val}).")
     end
   end
-  class IllegalRCGenerator < StandardError
-    def initialize
-      super("Define illegal RC_NAME_GENERATOR.")
-    end
-  end
 
   # :startdoc:
 end

data/lib/irb/lc/ja/error.rb

@@ -47,11 +47,6 @@ module IRB
       super("プロンプトモード(#{val})は定義されていません.")
     end
   end
-  class IllegalRCGenerator < StandardError
-    def initialize
-      super("RC_NAME_GENERATORが正しく定義されていません.")
-    end
-  end
 
   # :startdoc:
 end

data/lib/irb/lc/ja/help-message

@@ -9,10 +9,18 @@ Usage:  irb.rb [options] [programfile] [arguments]
   -W[level=2]       ruby -W と同じ.
   --context-mode n  新しいワークスペースを作成した時に関連する Binding
 		    オブジェクトの作成方法を 0 から 3 のいずれかに設定する.
+  --extra-doc-dir   指定したディレクトリのドキュメントを追加で読み込む.
   --echo	    実行結果を表示する(デフォルト).
   --noecho	    実行結果を表示しない.
+  --echo-on-assignment
+                    代入結果を表示する.
+  --noecho-on-assignment
+                    代入結果を表示しない.
+  --truncate-echo-on-assignment
+                    truncateされた代入結果を表示する(デフォルト).
   --inspect	    結果出力にinspectを用いる.
   --noinspect	    結果出力にinspectを用いない.
+  --no-pager        ページャを使用しない.
   --multiline       マルチラインエディタを利用する.
   --nomultiline     マルチラインエディタを利用しない.
   --singleline      シングルラインエディタを利用する.
@@ -34,6 +42,8 @@ Usage:  irb.rb [options] [programfile] [arguments]
   --sample-book-mode/--simple-prompt
 		    非常にシンプルなプロンプトを用いるモードです.
   --noprompt	    プロンプト表示を行なわない.
+  --script          スクリプトモード(最初の引数をスクリプトファイルとして扱う、デフォルト)
+  --noscript        引数をargvとして扱う.
   --single-irb	    irb 中で self を実行して得られるオブジェクトをサ
 		    ブ irb と共有する.
   --tracer	    コマンド実行時にトレースを行なう.