irb 1.13.2 → 1.15.2

data/lib/irb/history.rb

@@ -1,6 +1,36 @@
 require "pathname"
 
 module IRB
+  module History
+    DEFAULT_ENTRY_LIMIT = 1000
+
+    class << self
+      # Integer representation of <code>IRB.conf[:HISTORY_FILE]</code>.
+      def save_history
+        return 0 if IRB.conf[:SAVE_HISTORY] == false
+        return DEFAULT_ENTRY_LIMIT if IRB.conf[:SAVE_HISTORY] == true
+        IRB.conf[:SAVE_HISTORY].to_i
+      end
+
+      def save_history?
+        !save_history.zero?
+      end
+
+      def infinite?
+        save_history.negative?
+      end
+
+      # Might be nil when HOME and XDG_CONFIG_HOME are not available.
+      def history_file
+        if (history_file = IRB.conf[:HISTORY_FILE])
+          File.expand_path(history_file)
+        else
+          IRB.rc_file("_history")
+        end
+      end
+    end
+  end
+
   module HistorySavingAbility # :nodoc:
     def support_history_saving?
       true
@@ -11,76 +41,75 @@ module IRB
     end
 
     def load_history
+      history_file = History.history_file
+      return unless File.exist?(history_file.to_s)
+
       history = self.class::HISTORY
 
-      if history_file = IRB.conf[:HISTORY_FILE]
-        history_file = File.expand_path(history_file)
-      end
-      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
-            if self.class == RelineInputMethod and history.last&.end_with?("\\")
-              history.last.delete_suffix!("\\")
-              history.last << "\n" << l
-            else
-              history << l
-            end
-          }
-        end
-        @loaded_history_lines = history.size
-        @loaded_history_mtime = File.mtime(history_file)
+      File.open(history_file, "r:#{IRB.conf[:LC_MESSAGES].encoding}") do |f|
+        f.each { |l|
+          l = l.chomp
+          if self.class == RelineInputMethod and history.last&.end_with?("\\")
+            history.last.delete_suffix!("\\")
+            history.last << "\n" << l
+          else
+            history << l
+          end
+        }
       end
+      @loaded_history_lines = history.size
+      @loaded_history_mtime = File.mtime(history_file)
     end
 
     def save_history
+      return unless History.save_history?
+      return unless (history_file = History.history_file)
+      unless ensure_history_file_writable(history_file)
+        warn <<~WARN
+          Can't write history to #{History.history_file.inspect} due to insufficient permissions.
+          Please verify the value of `IRB.conf[:HISTORY_FILE]`. Ensure the folder exists and that both the folder and file (if it exists) are writable.
+        WARN
+        return
+      end
+
       history = self.class::HISTORY.to_a
 
-      if num = IRB.conf[:SAVE_HISTORY] and (num = num.to_i) != 0
-        if history_file = IRB.conf[:HISTORY_FILE]
-          history_file = File.expand_path(history_file)
-        end
-        history_file = IRB.rc_file("_history") unless history_file
+      if File.exist?(history_file) &&
+          File.mtime(history_file) != @loaded_history_mtime
+        history = history[@loaded_history_lines..-1] if @loaded_history_lines
+        append_history = true
+      end
 
-        # When HOME and XDG_CONFIG_HOME are not available, history_file might be nil
-        return unless history_file
+      File.open(history_file, (append_history ? "a" : "w"), 0o600, encoding: IRB.conf[:LC_MESSAGES]&.encoding) do |f|
+        hist = history.map { |l| l.scrub.split("\n").join("\\\n") }
 
-        # Change the permission of a file that already exists[BUG #7694]
-        begin
-          if File.stat(history_file).mode & 066 != 0
-            File.chmod(0600, history_file)
-          end
-        rescue Errno::ENOENT
-        rescue Errno::EPERM
-          return
-        rescue
-          raise
+        unless append_history || History.infinite?
+          # Check size before slicing because array.last(huge_number) raises RangeError.
+          hist = hist.last(History.save_history) if hist.size > History.save_history
         end
 
-        if File.exist?(history_file) &&
-           File.mtime(history_file) != @loaded_history_mtime
-          history = history[@loaded_history_lines..-1] if @loaded_history_lines
-          append_history = true
-        end
+        f.puts(hist)
+      end
+    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
+    private
 
-        File.open(history_file, (append_history ? 'a' : 'w'), 0o600, encoding: IRB.conf[:LC_MESSAGES]&.encoding) do |f|
-          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 infinity
-            end
-          end
-          f.puts(hist)
+    # Returns boolean whether writing to +history_file+ will be possible.
+    # Permissions of already existing +history_file+ are changed to
+    # owner-only-readable if necessary [BUG #7694].
+    def ensure_history_file_writable(history_file)
+      history_file = Pathname.new(history_file)
+
+      return false unless history_file.dirname.writable?
+      return true unless history_file.exist?
+
+      begin
+        if history_file.stat.mode & 0o66 != 0
+          history_file.chmod 0o600
         end
+        true
+      rescue Errno::EPERM # no permissions
+        false
       end
     end
   end

data/lib/irb/init.rb

@@ -80,7 +80,7 @@ module IRB # :nodoc:
     @CONF[:USE_SINGLELINE] = false unless defined?(ReadlineInputMethod)
     @CONF[:USE_COLORIZE] = (nc = ENV['NO_COLOR']).nil? || nc.empty?
     @CONF[:USE_AUTOCOMPLETE] = ENV.fetch("IRB_USE_AUTOCOMPLETE", "true") != "false"
-    @CONF[:COMPLETOR] = ENV.fetch("IRB_COMPLETOR", "regexp").to_sym
+    @CONF[:COMPLETOR] = ENV["IRB_COMPLETOR"]&.to_sym
     @CONF[:INSPECT_MODE] = true
     @CONF[:USE_TRACER] = false
     @CONF[:USE_LOADER] = false
@@ -93,7 +93,7 @@ module IRB # :nodoc:
     @CONF[:VERBOSE] = nil
 
     @CONF[:EVAL_HISTORY] = nil
-    @CONF[:SAVE_HISTORY] = 1000
+    @CONF[:SAVE_HISTORY] = History::DEFAULT_ENTRY_LIMIT
 
     @CONF[:BACK_TRACE_LIMIT] = 16
 
@@ -194,6 +194,8 @@ module IRB # :nodoc:
       :'$' => :show_source,
       :'@' => :whereami,
     }
+
+    @CONF[:COPY_COMMAND] = ENV.fetch("IRB_COPY_COMMAND", nil)
   end
 
   def IRB.set_measure_callback(type = nil, arg = nil, &block)

data/lib/irb/input-method.rb

@@ -26,10 +26,11 @@ module IRB
 
     def winsize
       if instance_variable_defined?(:@stdout) && @stdout.tty?
-        @stdout.winsize
-      else
-        [24, 80]
+        winsize = @stdout.winsize
+        # If width or height is 0, something is wrong.
+        return winsize unless winsize.include? 0
       end
+      [24, 80]
     end
 
     # Whether this input method is still readable when there is no more data to
@@ -67,7 +68,9 @@ module IRB
     #
     # See IO#gets for more information.
     def gets
-      puts if @stdout.tty? # workaround for debug compatibility test
+      # Workaround for debug compatibility test https://github.com/ruby/debug/pull/1100
+      puts if ENV['RUBY_DEBUG_TEST_UI']
+
       print @prompt
       line = @stdin.gets
       @line[@line_no += 1] = line
@@ -171,11 +174,18 @@ module IRB
   end
 
   class ReadlineInputMethod < StdioInputMethod
-    def self.initialize_readline
-      require "readline"
-    rescue LoadError
-    else
-      include ::Readline
+    class << self
+      def initialize_readline
+        return if defined?(self::Readline)
+
+        begin
+          require 'readline'
+          const_set(:Readline, ::Readline)
+        rescue LoadError
+          const_set(:Readline, ::Reline)
+        end
+        const_set(:HISTORY, self::Readline::HISTORY)
+      end
     end
 
     include HistorySavingAbility
@@ -212,8 +222,8 @@ module IRB
     def gets
       Readline.input = @stdin
       Readline.output = @stdout
-      if l = readline(@prompt, false)
-        HISTORY.push(l) if !l.empty?
+      if l = Readline.readline(@prompt, false)
+        Readline::HISTORY.push(l) if !l.empty?
         @line[@line_no += 1] = l + "\n"
       else
         @eof = true
@@ -235,7 +245,7 @@ module IRB
 
     # For debug message
     def inspect
-      readline_impl = (defined?(Reline) && Readline == Reline) ? 'Reline' : 'ext/readline'
+      readline_impl = Readline == ::Reline ? 'Reline' : 'ext/readline'
       str = "ReadlineInputMethod with #{readline_impl} #{Readline::VERSION}"
       inputrc_path = File.expand_path(ENV['INPUTRC'] || '~/.inputrc')
       str += " and #{inputrc_path}" if File.exist?(inputrc_path)
@@ -263,18 +273,9 @@ module IRB
         @completion_params = [preposing, target, postposing, bind]
         @completor.completion_candidates(preposing, target, postposing, bind: bind)
       }
-      Reline.output_modifier_proc =
-        if IRB.conf[:USE_COLORIZE]
-          proc do |output, complete: |
-            next unless IRB::Color.colorable?
-            lvars = IRB.CurrentContext&.local_variables || []
-            IRB::Color.colorize_code(output, complete: complete, local_variables: lvars)
-          end
-        else
-          proc do |output|
-            Reline::Unicode.escape_for_print(output)
-          end
-        end
+      Reline.output_modifier_proc = proc do |input, complete:|
+        IRB.CurrentContext.colorize_input(input, complete: complete)
+      end
       Reline.dig_perfect_match_proc = ->(matched) { display_document(matched) }
       Reline.autocompletion = IRB.conf[:USE_AUTOCOMPLETE]
 
@@ -353,9 +354,15 @@ module IRB
           if show_easter_egg
             IRB.__send__(:easter_egg)
           else
+            # RDoc::RI::Driver#display_names uses pager command internally.
+            # Some pager command like `more` doesn't use alternate screen
+            # so we need to turn on and off alternate screen manually.
             begin
+              print "\e[?1049h"
               driver.display_names([name])
             rescue RDoc::RI::Driver::NotFoundError
+            ensure
+              print "\e[?1049l"
             end
           end
         end

data/lib/irb/inspector.rb

@@ -6,7 +6,6 @@
 
 module IRB # :nodoc:
 
-
   # Convenience method to create a new Inspector, using the given +inspect+
   # proc, and optional +init+ proc and passes them to Inspector.new
   #
@@ -43,38 +42,40 @@ module IRB # :nodoc:
     # +:marshal+::  Using Marshal.dump
     INSPECTORS = {}
 
-    # Determines the inspector to use where +inspector+ is one of the keys passed
-    # during inspector definition.
-    def self.keys_with_inspector(inspector)
-      INSPECTORS.select{|k, v| v == inspector}.collect{|k, v| k}
-    end
-
-    # Example
-    #
-    #     Inspector.def_inspector(key, init_p=nil){|v| v.inspect}
-    #     Inspector.def_inspector([key1,..], init_p=nil){|v| v.inspect}
-    #     Inspector.def_inspector(key, inspector)
-    #     Inspector.def_inspector([key1,...], inspector)
-    def self.def_inspector(key, arg=nil, &block)
-      if block_given?
-        inspector = IRB::Inspector(block, arg)
-      else
-        inspector = arg
+    class << self
+      # Determines the inspector to use where +inspector+ is one of the keys passed
+      # during inspector definition.
+      def keys_with_inspector(inspector)
+        INSPECTORS.select{|k, v| v == inspector}.collect{|k, v| k}
       end
 
-      case key
-      when Array
-        for k in key
-          def_inspector(k, inspector)
+      # Example
+      #
+      #     Inspector.def_inspector(key, init_p=nil){|v| v.inspect}
+      #     Inspector.def_inspector([key1,..], init_p=nil){|v| v.inspect}
+      #     Inspector.def_inspector(key, inspector)
+      #     Inspector.def_inspector([key1,...], inspector)
+      def def_inspector(key, arg=nil, &block)
+        if block_given?
+          inspector = IRB::Inspector(block, arg)
+        else
+          inspector = arg
+        end
+
+        case key
+        when Array
+          for k in key
+            def_inspector(k, inspector)
+          end
+        when Symbol
+          INSPECTORS[key] = inspector
+          INSPECTORS[key.to_s] = inspector
+        when String
+          INSPECTORS[key] = inspector
+          INSPECTORS[key.intern] = inspector
+        else
+          INSPECTORS[key] = inspector
         end
-      when Symbol
-        INSPECTORS[key] = inspector
-        INSPECTORS[key.to_s] = inspector
-      when String
-        INSPECTORS[key] = inspector
-        INSPECTORS[key.intern] = inspector
-      else
-        INSPECTORS[key] = inspector
       end
     end
 
@@ -91,9 +92,14 @@ module IRB # :nodoc:
       @init.call if @init
     end
 
+    def support_stream_output?
+      second_parameter_type = @inspect.parameters[1]&.first
+      second_parameter_type == :req || second_parameter_type == :opt
+    end
+
     # Proc to call when the input is evaluated and output in irb.
-    def inspect_value(v)
-      @inspect.call(v)
+    def inspect_value(v, output, colorize: true)
+      support_stream_output? ? @inspect.call(v, output, colorize: colorize) : output << @inspect.call(v, colorize: colorize)
     rescue => e
       puts "An error occurred when inspecting the object: #{e.inspect}"
 
@@ -109,11 +115,11 @@ module IRB # :nodoc:
   end
 
   Inspector.def_inspector([false, :to_s, :raw]){|v| v.to_s}
-  Inspector.def_inspector([:p, :inspect]){|v|
-    Color.colorize_code(v.inspect, colorable: Color.colorable? && Color.inspect_colorable?(v))
+  Inspector.def_inspector([:p, :inspect]){|v, colorize: true|
+    Color.colorize_code(v.inspect, colorable: colorize && Color.colorable? && Color.inspect_colorable?(v))
   }
-  Inspector.def_inspector([true, :pp, :pretty_inspect], proc{require_relative "color_printer"}){|v|
-    IRB::ColorPrinter.pp(v, +'').chomp
+  Inspector.def_inspector([true, :pp, :pretty_inspect], proc{require_relative "color_printer"}){|v, output, colorize: true|
+    IRB::ColorPrinter.pp(v, output, colorize: colorize)
   }
   Inspector.def_inspector([:yaml, :YAML], proc{require "yaml"}){|v|
     begin

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

@@ -8,7 +8,7 @@ Usage:  irb.rb [options] [programfile] [arguments]
   -w                ruby -w と同じ.
   -W[level=2]       ruby -W と同じ.
   --context-mode n  新しいワークスペースを作成した時に関連する Binding
-		    オブジェクトの作成方法を 0 から 3 のいずれかに設定する.
+		    オブジェクトの作成方法を 0 から 4 のいずれかに設定する.
   --extra-doc-dir   指定したディレクトリのドキュメントを追加で読み込む.
   --echo	    実行結果を表示する(デフォルト).
   --noecho	    実行結果を表示しない.
@@ -33,9 +33,9 @@ Usage:  irb.rb [options] [programfile] [arguments]
                     補完に正規表現を利用する.
   --type-completor  補完に型情報を利用する.
   --prompt prompt-mode/--prompt-mode prompt-mode
-		    プロンプトモードを切替えます. 現在定義されているプ
-		    ロンプトモードは, default, simple, xmp, inf-rubyが
-		    用意されています.
+                    プロンプトモードを切り替える.
+                    現在定義されているプロンプトモードは,
+                    default, classic, simple, inf-ruby, xmp, null.
   --inf-ruby-mode   emacsのinf-ruby-mode用のプロンプト表示を行なう. 特
                     に指定がない限り, シングルラインエディタとマルチラ
                     インエディタは使わなくなる.