irb 1.14.0 → 1.18.0

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? && l != Readline::HISTORY.to_a.last
         @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)
@@ -245,6 +255,16 @@ module IRB
 
   class RelineInputMethod < StdioInputMethod
     HISTORY = Reline::HISTORY
+    ALT_KEY_NAME = RUBY_PLATFORM.match?(/darwin/) ? "Option" : "Alt"
+    PRESS_ALT_D_TO_READ_FULL_DOC = "Press #{ALT_KEY_NAME}+d to read the full document".freeze
+    PRESS_ALT_D_TO_SEE_MORE = "Press #{ALT_KEY_NAME}+d to see more".freeze
+    ALT_D_SEQUENCES = [
+      [27, 100], # Normal Alt+d when convert-meta isn't used.
+      # When option/alt is not configured as a meta key in terminal emulator,
+      # option/alt + d will send a unicode character depend on OS keyboard setting.
+      [195, 164], # "ä" in somewhere (FIXME: environment information is unknown).
+      [226, 136, 130] # "∂" Alt+d on Mac keyboard.
+    ].freeze
     include HistorySavingAbility
     # Creates a new input method object using Reline
     def initialize(completor)
@@ -263,18 +283,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]
 
@@ -304,9 +315,17 @@ module IRB
       @auto_indent_proc = block
     end
 
-    def retrieve_doc_namespace(matched)
+    def retrieve_document_target(matched)
       preposing, _target, postposing, bind = @completion_params
-      @completor.doc_namespace(preposing, matched, postposing, bind: bind)
+      result = @completor.doc_namespace(preposing, matched, postposing, bind: bind)
+      case result
+      when DocumentTarget, nil
+        result
+      when Array
+        MethodDocument.new(*result)
+      when String
+        MethodDocument.new(result)
+      end
     end
 
     def rdoc_ri_driver
@@ -327,140 +346,158 @@ module IRB
       input_method = self # self is changed in the lambda below.
       ->() {
         dialog.trap_key = nil
-        alt_d = [
-          [27, 100], # Normal Alt+d when convert-meta isn't used.
-          # When option/alt is not configured as a meta key in terminal emulator,
-          # option/alt + d will send a unicode character depend on OS keyboard setting.
-          [195, 164], # "ä" in somewhere (FIXME: environment information is unknown).
-          [226, 136, 130] # "∂" Alt+d on Mac keyboard.
-        ]
-
-        if just_cursor_moving and completion_journey_data.nil?
+
+        if just_cursor_moving && completion_journey_data.nil?
           return nil
         end
         cursor_pos_to_render, result, pointer, autocomplete_dialog = context.pop(4)
-        return nil if result.nil? or pointer.nil? or pointer < 0
+        return nil if result.nil? || pointer.nil? || pointer < 0
 
-        name = input_method.retrieve_doc_namespace(result[pointer])
-        # Use first one because document dialog does not support multiple namespaces.
-        name = name.first if name.is_a?(Array)
+        matched_text = result[pointer]
+        show_easter_egg = matched_text&.match?(/\ARubyVM/) && !ENV['RUBY_YES_I_AM_NOT_A_NORMAL_USER']
+        target = show_easter_egg ? nil : input_method.retrieve_document_target(matched_text)
 
-        show_easter_egg = name&.match?(/\ARubyVM/) && !ENV['RUBY_YES_I_AM_NOT_A_NORMAL_USER']
+        x, width = input_method.dialog_doc_position(cursor_pos_to_render, autocomplete_dialog, screen_width)
+        return nil unless x
 
-        driver = input_method.rdoc_ri_driver
+        dialog.trap_key = ALT_D_SEQUENCES
 
         if key.match?(dialog.name)
-          if show_easter_egg
-            IRB.__send__(:easter_egg)
-          else
-            begin
-              driver.display_names([name])
-            rescue RDoc::RI::Driver::NotFoundError
-            end
+          begin
+            print "\e[?1049h"
+            input_method.display_document(matched_text)
+          ensure
+            print "\e[?1049l"
           end
         end
 
-        begin
-          name = driver.expand_name(name)
-        rescue RDoc::RI::Driver::NotFoundError
-          return nil
-        rescue
-          return nil # unknown error
-        end
-        doc = nil
-        used_for_class = false
-        if not name =~ /#|\./
-          found, klasses, includes, extends = driver.classes_and_includes_and_extends_for(name)
-          if not found.empty?
-            doc = driver.class_document(name, found, klasses, includes, extends)
-            used_for_class = true
+        contents = case target
+        when CommandDocument
+          input_method.command_doc_dialog_contents(target.name, width)
+        when MethodDocument
+          input_method.rdoc_dialog_contents(target.name, width)
+        else
+          if show_easter_egg
+            input_method.easter_egg_dialog_contents
           end
         end
-        unless used_for_class
-          doc = RDoc::Markup::Document.new
-          begin
-            driver.add_method(doc, name)
-          rescue RDoc::RI::Driver::NotFoundError
-            doc = nil
-          rescue
-            return nil # unknown error
-          end
+        return nil unless contents
+
+        contents = contents.take(preferred_dialog_height)
+        y = cursor_pos_to_render.y
+        Reline::DialogRenderInfo.new(pos: Reline::CursorPos.new(x, y), contents: contents, width: width, bg_color: '49')
+      }
+    end
+
+    def command_doc_dialog_contents(command_name, width)
+      command_class = IRB::Command.load_command(command_name)
+      return unless command_class
+
+      [PRESS_ALT_D_TO_READ_FULL_DOC, ""] + command_class.doc_dialog_content(command_name, width)
+    end
+
+    def easter_egg_dialog_contents
+      type = STDOUT.external_encoding == Encoding::UTF_8 ? :unicode : :ascii
+      lines = IRB.send(:easter_egg_logo, type).split("\n")
+      lines[0][0, PRESS_ALT_D_TO_SEE_MORE.size] = PRESS_ALT_D_TO_SEE_MORE
+      lines
+    end
+
+    def rdoc_dialog_contents(name, width)
+      driver = rdoc_ri_driver
+      return unless driver
+
+      name = driver.expand_name(name)
+
+      doc = if name =~ /#|\./
+        d = RDoc::Markup::Document.new
+        driver.add_method(d, name)
+        d
+      else
+        found, klasses, includes, extends = driver.classes_and_includes_and_extends_for(name)
+        if found.empty?
+          d = RDoc::Markup::Document.new
+          driver.add_method(d, name)
+          d
+        else
+          driver.class_document(name, found, klasses, includes, extends)
         end
-        return nil if doc.nil?
-        width = 40
-
-        right_x = cursor_pos_to_render.x + autocomplete_dialog.width
-        if right_x + width > screen_width
-          right_width = screen_width - (right_x + 1)
-          left_x = autocomplete_dialog.column - width
-          left_x = 0 if left_x < 0
-          left_width = width > autocomplete_dialog.column ? autocomplete_dialog.column : width
-          if right_width.positive? and left_width.positive?
-            if right_width >= left_width
-              width = right_width
-              x = right_x
-            else
-              width = left_width
-              x = left_x
-            end
-          elsif right_width.positive? and left_width <= 0
+      end
+
+      formatter = RDoc::Markup::ToAnsi.new
+      formatter.width = width
+      [PRESS_ALT_D_TO_READ_FULL_DOC] + doc.accept(formatter).split("\n")
+    rescue RDoc::RI::Driver::NotFoundError
+    end
+
+    def dialog_doc_position(cursor_pos_to_render, autocomplete_dialog, screen_width)
+      width = 40
+      right_x = cursor_pos_to_render.x + autocomplete_dialog.width
+      if right_x + width > screen_width
+        right_width = screen_width - (right_x + 1)
+        left_x = autocomplete_dialog.column - width
+        left_x = 0 if left_x < 0
+        left_width = width > autocomplete_dialog.column ? autocomplete_dialog.column : width
+        if right_width.positive? && left_width.positive?
+          if right_width >= left_width
             width = right_width
             x = right_x
-          elsif right_width <= 0 and left_width.positive?
+          else
             width = left_width
             x = left_x
-          else # Both are negative width.
-            return nil
           end
-        else
+        elsif right_width.positive? && left_width <= 0
+          width = right_width
           x = right_x
-        end
-        formatter = RDoc::Markup::ToAnsi.new
-        formatter.width = width
-        dialog.trap_key = alt_d
-        mod_key = RUBY_PLATFORM.match?(/darwin/) ? "Option" : "Alt"
-        if show_easter_egg
-          type = STDOUT.external_encoding == Encoding::UTF_8 ? :unicode : :ascii
-          contents = IRB.send(:easter_egg_logo, type).split("\n")
-          message = "Press #{mod_key}+d to see more"
-          contents[0][0, message.size] = message
+        elsif right_width <= 0 && left_width.positive?
+          width = left_width
+          x = left_x
         else
-          message = "Press #{mod_key}+d to read the full document"
-          contents = [message] + doc.accept(formatter).split("\n")
+          return nil
         end
-        contents = contents.take(preferred_dialog_height)
-
-        y = cursor_pos_to_render.y
-        Reline::DialogRenderInfo.new(pos: Reline::CursorPos.new(x, y), contents: contents, width: width, bg_color: '49')
-      }
+      else
+        x = right_x
+      end
+      [x, width]
     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)
-        return
-      end
+      target = retrieve_document_target(matched)
+      return unless target
+
+      case target
+      when CommandDocument
+        command_class = IRB::Command.load_command(target.name)
+        if command_class
+          content = command_class.help_message || command_class.description
+          Pager.page(retain_content: true) do |io|
+            io.puts content
+          end
+        end
+      when MethodDocument
+        driver = rdoc_ri_driver
+        return unless driver
 
-      namespace = retrieve_doc_namespace(matched)
-      return unless namespace
+        if matched =~ /\A(?:::)?RubyVM/ && !ENV['RUBY_YES_I_AM_NOT_A_NORMAL_USER']
+          IRB.__send__(:easter_egg)
+          return
+        end
 
-      if namespace.is_a?(Array)
-        out = RDoc::Markup::Document.new
-        namespace.each do |m|
+        if target.names.length > 1
+          out = RDoc::Markup::Document.new
+          target.names.each do |m|
+            begin
+              driver.add_method(out, m)
+            rescue RDoc::RI::Driver::NotFoundError
+            end
+          end
+          driver.display(out)
+        else
           begin
-            driver.add_method(out, m)
+            driver.display_names([target.name])
           rescue RDoc::RI::Driver::NotFoundError
           end
         end
-        driver.display(out)
-      else
-        begin
-          driver.display_names([namespace])
-        rescue RDoc::RI::Driver::NotFoundError
-        end
       end
     end
 
@@ -473,7 +510,7 @@ module IRB
       Reline.prompt_proc = @prompt_proc
       Reline.auto_indent_proc = @auto_indent_proc if @auto_indent_proc
       if l = Reline.readmultiline(@prompt, false, &@check_termination_proc)
-        Reline::HISTORY.push(l) if !l.empty?
+        Reline::HISTORY.push(l) if !l.empty? && l != Reline::HISTORY.to_a.last
         @line[@line_no += 1] = l + "\n"
       else
         @eof = true

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.filter_map {|k, v| k if v == inspector}
       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/help-message

@@ -6,10 +6,10 @@ Usage:  irb.rb [options] [programfile] [arguments]
   -U                Set external and internal encodings to UTF-8.
   -E ex[:in]        Set default external (ex) and internal (in) encodings
                     (same as 'ruby -E').
-  -w                Suppress warnings (same as 'ruby -w').
+  -w                Enable warnings (same as 'ruby -w' or 'ruby -W1').
   -W[level=2]       Set warning level: 0=silence, 1=medium, 2=verbose
                     (same as 'ruby -W').
-  --context-mode n  Set n[0-4] to method to create Binding Object,
+  --context-mode n  Set n[0-5] to method to create Binding Object,
                     when new workspace was created.
   --extra-doc-dir   Add an extra doc dir for the doc dialog.
   --echo            Show result (default).

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 から 5 のいずれかに設定する.
   --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用のプロンプト表示を行なう. 特
                     に指定がない限り, シングルラインエディタとマルチラ
                     インエディタは使わなくなる.