irb 1.7.1 → 1.13.2

data/lib/irb/input-method.rb

@@ -1,24 +1,17 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 #
 #   irb/input-method.rb - input methods used irb
 #   	by Keiju ISHITSUKA(keiju@ruby-lang.org)
 #
 
-require_relative 'src_encoding'
 require_relative 'completion'
+require_relative "history"
 require 'io/console'
 require 'reline'
 
 module IRB
-  STDIN_FILE_NAME = "(line)" # :nodoc:
   class InputMethod
-
-    # Creates a new input method object
-    def initialize(file = STDIN_FILE_NAME)
-      @file_name = file
-    end
-    # The file name of this input method, usually given during initialization.
-    attr_reader :file_name
+    BASIC_WORD_BREAK_CHARACTERS = " \t\n`><=;|&{("
 
     # The irb prompt associated with this input method
     attr_accessor :prompt
@@ -27,7 +20,7 @@ module IRB
     #
     # See IO#gets for more information.
     def gets
-      fail NotImplementedError, "gets"
+      fail NotImplementedError
     end
     public :gets
 
@@ -47,6 +40,14 @@ module IRB
       false
     end
 
+    def support_history_saving?
+      false
+    end
+
+    def prompting?
+      false
+    end
+
     # For debug message
     def inspect
       'Abstract InputMethod'
@@ -56,7 +57,6 @@ module IRB
   class StdioInputMethod < InputMethod
     # Creates a new input method object
     def initialize
-      super
       @line_no = 0
       @line = []
       @stdin = IO.open(STDIN.to_i, :external_encoding => IRB.conf[:LC_MESSAGES].encoding, :internal_encoding => "-")
@@ -67,6 +67,7 @@ module IRB
     #
     # See IO#gets for more information.
     def gets
+      puts if @stdout.tty? # workaround for debug compatibility test
       print @prompt
       line = @stdin.gets
       @line[@line_no += 1] = line
@@ -95,6 +96,10 @@ module IRB
       true
     end
 
+    def prompting?
+      STDIN.tty?
+    end
+
     # Returns the current line number for #io.
     #
     # #line counts the number of times #gets is called.
@@ -130,12 +135,9 @@ module IRB
 
     # Creates a new input method object
     def initialize(file)
-      super
       @io = file.is_a?(IO) ? file : File.open(file)
       @external_encoding = @io.external_encoding
     end
-    # The file name of this input method, usually given during initialization.
-    attr_reader :file_name
 
     # Whether the end of this input method has been reached, returns +true+ if
     # there is no more data to read.
@@ -168,114 +170,99 @@ module IRB
     end
   end
 
-  begin
-    class ReadlineInputMethod < InputMethod
-      def self.initialize_readline
-        require "readline"
-      rescue LoadError
-      else
-        include ::Readline
-      end
+  class ReadlineInputMethod < StdioInputMethod
+    def self.initialize_readline
+      require "readline"
+    rescue LoadError
+    else
+      include ::Readline
+    end
 
-      # Creates a new input method object using Readline
-      def initialize
-        self.class.initialize_readline
-        if Readline.respond_to?(:encoding_system_needs)
-          IRB.__send__(:set_encoding, Readline.encoding_system_needs.name, override: false)
-        end
-        super
+    include HistorySavingAbility
 
-        @line_no = 0
-        @line = []
-        @eof = false
+    # Creates a new input method object using Readline
+    def initialize
+      self.class.initialize_readline
+      if Readline.respond_to?(:encoding_system_needs)
+        IRB.__send__(:set_encoding, Readline.encoding_system_needs.name, override: false)
+      end
 
-        @stdin = IO.open(STDIN.to_i, :external_encoding => IRB.conf[:LC_MESSAGES].encoding, :internal_encoding => "-")
-        @stdout = IO.open(STDOUT.to_i, 'w', :external_encoding => IRB.conf[:LC_MESSAGES].encoding, :internal_encoding => "-")
+      super
 
-        if Readline.respond_to?("basic_word_break_characters=")
-          Readline.basic_word_break_characters = IRB::InputCompletor::BASIC_WORD_BREAK_CHARACTERS
-        end
-        Readline.completion_append_character = nil
-        Readline.completion_proc = IRB::InputCompletor::CompletionProc
-      end
+      @eof = false
+      @completor = RegexpCompletor.new
 
-      # Reads the next line from this input method.
-      #
-      # See IO#gets for more information.
-      def gets
-        Readline.input = @stdin
-        Readline.output = @stdout
-        if l = readline(@prompt, false)
-          HISTORY.push(l) if !l.empty?
-          @line[@line_no += 1] = l + "\n"
-        else
-          @eof = true
-          l
-        end
+      if Readline.respond_to?("basic_word_break_characters=")
+        Readline.basic_word_break_characters = BASIC_WORD_BREAK_CHARACTERS
       end
+      Readline.completion_append_character = nil
+      Readline.completion_proc = ->(target) {
+        bind = IRB.conf[:MAIN_CONTEXT].workspace.binding
+        @completor.completion_candidates('', target, '', bind: bind)
+      }
+    end
 
-      # Whether the end of this input method has been reached, returns +true+
-      # if there is no more data to read.
-      #
-      # See IO#eof? for more information.
-      def eof?
-        @eof
-      end
+    def completion_info
+      'RegexpCompletor'
+    end
 
-      # Whether this input method is still readable when there is no more data to
-      # read.
-      #
-      # See IO#eof for more information.
-      def readable_after_eof?
-        true
+    # Reads the next line from this input method.
+    #
+    # See IO#gets for more information.
+    def gets
+      Readline.input = @stdin
+      Readline.output = @stdout
+      if l = readline(@prompt, false)
+        HISTORY.push(l) if !l.empty?
+        @line[@line_no += 1] = l + "\n"
+      else
+        @eof = true
+        l
       end
+    end
 
-      # Returns the current line number for #io.
-      #
-      # #line counts the number of times #gets is called.
-      #
-      # See IO#lineno for more information.
-      def line(line_no)
-        @line[line_no]
-      end
+    # Whether the end of this input method has been reached, returns +true+
+    # if there is no more data to read.
+    #
+    # See IO#eof? for more information.
+    def eof?
+      @eof
+    end
 
-      # The external encoding for standard input.
-      def encoding
-        @stdin.external_encoding
-      end
+    def prompting?
+      true
+    end
 
-      # For debug message
-      def inspect
-        readline_impl = (defined?(Reline) && 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)
-        str
-      end
+    # For debug message
+    def inspect
+      readline_impl = (defined?(Reline) && 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)
+      str
     end
   end
 
-  class RelineInputMethod < InputMethod
-    include Reline
-
+  class RelineInputMethod < StdioInputMethod
+    HISTORY = Reline::HISTORY
+    include HistorySavingAbility
     # Creates a new input method object using Reline
-    def initialize
+    def initialize(completor)
       IRB.__send__(:set_encoding, Reline.encoding_system_needs.name, override: false)
-      super
 
-      @line_no = 0
-      @line = []
-      @eof = false
+      super()
 
-      @stdin = ::IO.open(STDIN.to_i, :external_encoding => IRB.conf[:LC_MESSAGES].encoding, :internal_encoding => "-")
-      @stdout = ::IO.open(STDOUT.to_i, 'w', :external_encoding => IRB.conf[:LC_MESSAGES].encoding, :internal_encoding => "-")
+      @eof = false
+      @completor = completor
 
-      if Reline.respond_to?("basic_word_break_characters=")
-        Reline.basic_word_break_characters = IRB::InputCompletor::BASIC_WORD_BREAK_CHARACTERS
-      end
+      Reline.basic_word_break_characters = BASIC_WORD_BREAK_CHARACTERS
       Reline.completion_append_character = nil
       Reline.completer_quote_characters = ''
-      Reline.completion_proc = IRB::InputCompletor::CompletionProc
+      Reline.completion_proc = ->(target, preposing, postposing) {
+        bind = IRB.conf[:MAIN_CONTEXT].workspace.binding
+        @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: |
@@ -288,18 +275,23 @@ module IRB
             Reline::Unicode.escape_for_print(output)
           end
         end
-      Reline.dig_perfect_match_proc = IRB::InputCompletor::PerfectMatchedProc
+      Reline.dig_perfect_match_proc = ->(matched) { display_document(matched) }
       Reline.autocompletion = IRB.conf[:USE_AUTOCOMPLETE]
 
       if IRB.conf[:USE_AUTOCOMPLETE]
         begin
           require 'rdoc'
-          Reline.add_dialog_proc(:show_doc, SHOW_DOC_DIALOG, Reline::DEFAULT_DIALOG_CONTEXT)
+          Reline.add_dialog_proc(:show_doc, show_doc_dialog_proc, Reline::DEFAULT_DIALOG_CONTEXT)
         rescue LoadError
         end
       end
     end
 
+    def completion_info
+      autocomplete_message = Reline.autocompletion ? 'Autocomplete' : 'Tab Complete'
+      "#{autocomplete_message}, #{@completor.inspect}"
+    end
+
     def check_termination(&block)
       @check_termination_proc = block
     end
@@ -312,100 +304,165 @@ module IRB
       @auto_indent_proc = block
     end
 
-    SHOW_DOC_DIALOG = ->() {
-      dialog.trap_key = nil
-      alt_d = [
-        [Reline::Key.new(nil, 0xE4, true)], # Normal Alt+d.
-        [27, 100], # Normal Alt+d when convert-meta isn't used.
-        [195, 164], # The "ä" that appears when Alt+d is pressed on xterm.
-        [226, 136, 130] # The "∂" that appears when Alt+d in pressed on iTerm2.
-      ]
+    def retrieve_doc_namespace(matched)
+      preposing, _target, postposing, bind = @completion_params
+      @completor.doc_namespace(preposing, matched, postposing, bind: bind)
+    end
 
-      if just_cursor_moving and 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
-      name = result[pointer]
-      name = IRB::InputCompletor.retrieve_completion_data(name, doc_namespace: true)
+    def rdoc_ri_driver
+      return @rdoc_ri_driver if defined?(@rdoc_ri_driver)
 
-      options = {}
-      options[:extra_doc_dirs] = IRB.conf[:EXTRA_DOC_DIRS] unless IRB.conf[:EXTRA_DOC_DIRS].empty?
-      driver = RDoc::RI::Driver.new(options)
+      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
 
-      if key.match?(dialog.name)
-        begin
-          driver.display_names([name])
-        rescue RDoc::RI::Driver::NotFoundError
+    def show_doc_dialog_proc
+      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?
+          return nil
         end
-      end
+        cursor_pos_to_render, result, pointer, autocomplete_dialog = context.pop(4)
+        return nil if result.nil? or pointer.nil? or pointer < 0
 
-      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
+        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)
+
+        show_easter_egg = name&.match?(/\ARubyVM/) && !ENV['RUBY_YES_I_AM_NOT_A_NORMAL_USER']
+
+        driver = input_method.rdoc_ri_driver
+
+        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
+          end
         end
-      end
-      unless used_for_class
-        doc = RDoc::Markup::Document.new
+
         begin
-          driver.add_method(doc, name)
+          name = driver.expand_name(name)
         rescue RDoc::RI::Driver::NotFoundError
-          doc = nil
+          return nil
         rescue
           return nil # unknown error
         end
-      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
+        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
+          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
+        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
             width = right_width
             x = right_x
-          else
+          elsif right_width <= 0 and left_width.positive?
             width = left_width
             x = left_x
+          else # Both are negative width.
+            return nil
           end
-        elsif right_width.positive? and left_width <= 0
-          width = right_width
+        else
           x = right_x
-        elsif right_width <= 0 and left_width.positive?
-          width = left_width
-          x = left_x
-        else # Both are negative width.
-          return nil
         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
+        else
+          message = "Press #{mod_key}+d to read the full document"
+          contents = [message] + doc.accept(formatter).split("\n")
+        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')
+      }
+    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
+
+      namespace = retrieve_doc_namespace(matched)
+      return unless namespace
+
+      if namespace.is_a?(Array)
+        out = RDoc::Markup::Document.new
+        namespace.each do |m|
+          begin
+            driver.add_method(out, m)
+          rescue RDoc::RI::Driver::NotFoundError
+          end
+        end
+        driver.display(out)
       else
-        x = right_x
+        begin
+          driver.display_names([namespace])
+        rescue RDoc::RI::Driver::NotFoundError
+        end
       end
-      formatter = RDoc::Markup::ToAnsi.new
-      formatter.width = width
-      dialog.trap_key = alt_d
-      mod_key = RUBY_PLATFORM.match?(/darwin/) ? "Option" : "Alt"
-      message = "Press #{mod_key}+d to read the full document"
-      contents = [message] + doc.accept(formatter).split("\n")
-      contents = contents.take(preferred_dialog_height) if respond_to?(:preferred_dialog_height)
-
-      y = cursor_pos_to_render.y
-      DialogRenderInfo.new(pos: Reline::CursorPos.new(x, y), contents: contents, width: width, bg_color: '49')
-    }
+    end
 
     # Reads the next line from this input method.
     #
@@ -415,8 +472,8 @@ module IRB
       Reline.output = @stdout
       Reline.prompt_proc = @prompt_proc
       Reline.auto_indent_proc = @auto_indent_proc if @auto_indent_proc
-      if l = readmultiline(@prompt, false, &@check_termination_proc)
-        HISTORY.push(l) if !l.empty?
+      if l = Reline.readmultiline(@prompt, false, &@check_termination_proc)
+        Reline::HISTORY.push(l) if !l.empty?
         @line[@line_no += 1] = l + "\n"
       else
         @eof = true
@@ -432,37 +489,15 @@ module IRB
       @eof
     end
 
-    # Whether this input method is still readable when there is no more data to
-    # read.
-    #
-    # See IO#eof for more information.
-    def readable_after_eof?
+    def prompting?
       true
     end
 
-    # Returns the current line number for #io.
-    #
-    # #line counts the number of times #gets is called.
-    #
-    # See IO#lineno for more information.
-    def line(line_no)
-      @line[line_no]
-    end
-
-    # The external encoding for standard input.
-    def encoding
-      @stdin.external_encoding
-    end
-
     # For debug message
     def inspect
       config = Reline::Config.new
       str = "RelineInputMethod with Reline #{Reline::VERSION}"
-      if config.respond_to?(:inputrc_path)
-        inputrc_path = File.expand_path(config.inputrc_path)
-      else
-        inputrc_path = File.expand_path(ENV['INPUTRC'] || '~/.inputrc')
-      end
+      inputrc_path = File.expand_path(config.inputrc_path)
       str += " and #{inputrc_path}" if File.exist?(inputrc_path)
       str
     end

data/lib/irb/inspector.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 #
 #   irb/inspector.rb - inspect methods
 #   	by Keiju ISHITSUKA(keiju@ruby-lang.org)
@@ -46,7 +46,7 @@ module IRB # :nodoc:
     # 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}
+      INSPECTORS.select{|k, v| v == inspector}.collect{|k, v| k}
     end
 
     # Example
@@ -113,7 +113,7 @@ module IRB # :nodoc:
     Color.colorize_code(v.inspect, colorable: Color.colorable? && Color.inspect_colorable?(v))
   }
   Inspector.def_inspector([true, :pp, :pretty_inspect], proc{require_relative "color_printer"}){|v|
-    IRB::ColorPrinter.pp(v, '').chomp
+    IRB::ColorPrinter.pp(v, +'').chomp
   }
   Inspector.def_inspector([:yaml, :YAML], proc{require "yaml"}){|v|
     begin

data/lib/irb/lc/error.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 #
 #   irb/lc/error.rb -
 #   	by Keiju ISHITSUKA(keiju@ruby-lang.org)
@@ -12,11 +12,6 @@ module IRB
       super("Unrecognized switch: #{val}")
     end
   end
-  class NotImplementedError < StandardError
-    def initialize(val)
-      super("Need to define `#{val}'")
-    end
-  end
   class CantReturnToNormalMode < StandardError
     def initialize
       super("Can't return to normal mode.")
@@ -52,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/help-message

@@ -22,6 +22,7 @@ Usage:  irb.rb [options] [programfile] [arguments]
                     Show truncated result on assignment (default).
   --inspect         Use 'inspect' for output.
   --noinspect       Don't use 'inspect' for output.
+  --no-pager        Don't use pager.
   --multiline       Use multiline editor module (default).
   --nomultiline     Don't use multiline editor module.
   --singleline      Use single line editor module.
@@ -30,6 +31,9 @@ Usage:  irb.rb [options] [programfile] [arguments]
   --nocolorize      Don't use color-highlighting.
   --autocomplete    Use auto-completion (default).
   --noautocomplete  Don't use auto-completion.
+  --regexp-completor
+                    Use regexp based completion (default).
+  --type-completor  Use type based completion.
   --prompt prompt-mode, --prompt-mode prompt-mode
                     Set prompt mode. Pre-defined prompt modes are:
                     'default', 'classic', 'simple', 'inf-ruby', 'xmp', 'null'.