irb 1.1.1 → 1.2.0

data/lib/irb/completion.rb

@@ -8,6 +8,7 @@
 #
 
 require "readline"
+autoload :RDoc, "rdoc"
 
 module IRB
   module InputCompletor # :nodoc:
@@ -35,9 +36,13 @@ module IRB
       yield
     ]
 
+    BASIC_WORD_BREAK_CHARACTERS = " \t\n`><=;|&{("
+
     CompletionProc = proc { |input|
-      bind = IRB.conf[:MAIN_CONTEXT].workspace.binding
+      retrieve_completion_data(input).compact.map{ |i| i.encode(Encoding.default_external) }
+    }
 
+    def self.retrieve_completion_data(input, bind: IRB.conf[:MAIN_CONTEXT].workspace.binding, doc_namespace: false)
       case input
       when /^((["'`]).*\2)\.([^.]*)$/
         # String
@@ -45,7 +50,11 @@ module IRB
         message = Regexp.quote($3)
 
         candidates = String.instance_methods.collect{|m| m.to_s}
-        select_message(receiver, message, candidates)
+        if doc_namespace
+          "String.#{message}"
+        else
+          select_message(receiver, message, candidates)
+        end
 
       when /^(\/[^\/]*\/)\.([^.]*)$/
         # Regexp
@@ -53,7 +62,11 @@ module IRB
         message = Regexp.quote($2)
 
         candidates = Regexp.instance_methods.collect{|m| m.to_s}
-        select_message(receiver, message, candidates)
+        if doc_namespace
+          "Regexp.#{message}"
+        else
+          select_message(receiver, message, candidates)
+        end
 
       when /^([^\]]*\])\.([^.]*)$/
         # Array
@@ -61,19 +74,28 @@ module IRB
         message = Regexp.quote($2)
 
         candidates = Array.instance_methods.collect{|m| m.to_s}
-        select_message(receiver, message, candidates)
+        if doc_namespace
+          "Array.#{message}"
+        else
+          select_message(receiver, message, candidates)
+        end
 
       when /^([^\}]*\})\.([^.]*)$/
         # Proc or Hash
         receiver = $1
         message = Regexp.quote($2)
 
-        candidates = Proc.instance_methods.collect{|m| m.to_s}
-        candidates |= Hash.instance_methods.collect{|m| m.to_s}
-        select_message(receiver, message, candidates)
+        proc_candidates = Proc.instance_methods.collect{|m| m.to_s}
+        hash_candidates = Hash.instance_methods.collect{|m| m.to_s}
+        if doc_namespace
+          ["Proc.#{message}", "Hash.#{message}"]
+        else
+          select_message(receiver, message, proc_candidates | hash_candidates)
+        end
 
       when /^(:[^:.]*)$/
         # Symbol
+        return nil if doc_namespace
         if Symbol.respond_to?(:all_symbols)
           sym = $1
           candidates = Symbol.all_symbols.collect{|s| ":" + s.id2name}
@@ -86,7 +108,11 @@ module IRB
         # Absolute Constant or class methods
         receiver = $1
         candidates = Object.constants.collect{|m| m.to_s}
-        candidates.grep(/^#{receiver}/).collect{|e| "::" + e}
+        if doc_namespace
+          candidates.find { |i| i == receiver }
+        else
+          candidates.grep(/^#{receiver}/).collect{|e| "::" + e}
+        end
 
       when /^([A-Z].*)::([^:.]*)$/
         # Constant or class methods
@@ -98,7 +124,11 @@ module IRB
         rescue Exception
           candidates = []
         end
-        select_message(receiver, message, candidates, "::")
+        if doc_namespace
+          "#{receiver}::#{message}"
+        else
+          select_message(receiver, message, candidates, "::")
+        end
 
       when /^(:[^:.]+)(\.|::)([^.]*)$/
         # Symbol
@@ -107,20 +137,33 @@ module IRB
         message = Regexp.quote($3)
 
         candidates = Symbol.instance_methods.collect{|m| m.to_s}
-        select_message(receiver, message, candidates, sep)
+        if doc_namespace
+          "Symbol.#{message}"
+        else
+          select_message(receiver, message, candidates, sep)
+        end
 
-      when /^(-?(0[dbo])?[0-9_]+(\.[0-9_]+)?([eE]-?[0-9]+)?)(\.|::)([^.]*)$/
+      when /^(?<num>-?(0[dbo])?[0-9_]+(\.[0-9_]+)?(([eE][+-]?[0-9]+)?i?|r)?)(?<sep>\.|::)(?<mes>[^.]*)$/
         # Numeric
-        receiver = $1
-        sep = $5
-        message = Regexp.quote($6)
+        receiver = $~[:num]
+        sep = $~[:sep]
+        message = Regexp.quote($~[:mes])
 
         begin
-          candidates = eval(receiver, bind).methods.collect{|m| m.to_s}
+          instance = eval(receiver, bind)
+          if doc_namespace
+            "#{instance.class.name}.#{message}"
+          else
+            candidates = instance.methods.collect{|m| m.to_s}
+            select_message(receiver, message, candidates, sep)
+          end
         rescue Exception
-          candidates = []
+          if doc_namespace
+            nil
+          else
+            candidates = []
+          end
         end
-        select_message(receiver, message, candidates, sep)
 
       when /^(-?0x[0-9a-fA-F_]+)(\.|::)([^.]*)$/
         # Numeric(0xFFFF)
@@ -129,16 +172,30 @@ module IRB
         message = Regexp.quote($3)
 
         begin
-          candidates = eval(receiver, bind).methods.collect{|m| m.to_s}
+          instance = eval(receiver, bind)
+          if doc_namespace
+            "#{instance.class.name}.#{message}"
+          else
+            candidates = instance.methods.collect{|m| m.to_s}
+            select_message(receiver, message, candidates, sep)
+          end
         rescue Exception
-          candidates = []
+          if doc_namespace
+            nil
+          else
+            candidates = []
+          end
         end
-        select_message(receiver, message, candidates, sep)
 
       when /^(\$[^.]*)$/
         # global var
-        regmessage = Regexp.new(Regexp.quote($1))
-        candidates = global_variables.collect{|m| m.to_s}.grep(regmessage)
+        gvar = $1
+        all_gvars = global_variables.collect{|m| m.to_s}
+        if doc_namespace
+          all_gvars.find{ |i| i == gvar }
+        else
+          all_gvars.grep(Regexp.new(Regexp.quote(gvar)))
+        end
 
       when /^([^."].*)(\.|::)([^.]*)$/
         # variable.func or func.func
@@ -146,7 +203,7 @@ module IRB
         sep = $2
         message = Regexp.quote($3)
 
-        gv = eval("global_variables", bind).collect{|m| m.to_s}
+        gv = eval("global_variables", bind).collect{|m| m.to_s}.append("true", "false", "nil")
         lv = eval("local_variables", bind).collect{|m| m.to_s}
         iv = eval("instance_variables", bind).collect{|m| m.to_s}
         cv = eval("self.class.constants", bind).collect{|m| m.to_s}
@@ -177,7 +234,11 @@ module IRB
           candidates.sort!
           candidates.uniq!
         end
-        select_message(receiver, message, candidates, sep)
+        if doc_namespace
+          "#{rec.class.name}#{sep}#{candidates.find{ |i| i == message }}"
+        else
+          select_message(receiver, message, candidates, sep)
+        end
 
       when /^\.([^.]*)$/
         # unknown(maybe String)
@@ -186,12 +247,50 @@ module IRB
         message = Regexp.quote($1)
 
         candidates = String.instance_methods(true).collect{|m| m.to_s}
-        select_message(receiver, message, candidates)
+        if doc_namespace
+          "String.#{candidates.find{ |i| i == message }}"
+        else
+          select_message(receiver, message, candidates)
+        end
 
       else
         candidates = eval("methods | private_methods | local_variables | instance_variables | self.class.constants", bind).collect{|m| m.to_s}
+        conditions |= ReservedWords
 
-        (candidates|ReservedWords).grep(/^#{Regexp.quote(input)}/)
+        if doc_namespace
+          candidates.find{ |i| i == input }
+        else
+          candidates.grep(/^#{Regexp.quote(input)}/)
+        end
+      end
+    end
+
+    PerfectMatchedProc = ->(matched) {
+      RDocRIDriver ||= RDoc::RI::Driver.new
+      if matched =~ /\A(?:::)?RubyVM/ and not ENV['RUBY_YES_I_AM_NOT_A_NORMAL_USER']
+        File.open(File.join(__dir__, 'ruby_logo.aa')) do |f|
+          RDocRIDriver.page do |io|
+            IO.copy_stream(f, io)
+          end
+        end
+        return
+      end
+      namespace = retrieve_completion_data(matched, doc_namespace: true)
+      return unless matched
+      if namespace.is_a?(Array)
+        out = RDoc::Markup::Document.new
+        namespace.each do |m|
+          begin
+            RDocRIDriver.add_method(out, m)
+          rescue RDoc::RI::Driver::NotFoundError
+          end
+        end
+        RDocRIDriver.display(out)
+      else
+        begin
+          RDocRIDriver.display_names([namespace])
+        rescue RDoc::RI::Driver::NotFoundError
+        end
       end
     }
 
@@ -225,7 +324,7 @@ module IRB
         end
       end
 
-      %i(IRB SLex RubyLex RubyToken).each do |sym|
+      %i(IRB RubyLex).each do |sym|
         next unless Object.const_defined?(sym)
         scanner.call(Object.const_get(sym))
       end
@@ -236,9 +335,3 @@ module IRB
     end
   end
 end
-
-if Readline.respond_to?("basic_word_break_characters=")
-  Readline.basic_word_break_characters= " \t\n`><=;|&{("
-end
-Readline.completion_append_character = nil
-Readline.completion_proc = IRB::InputCompletor::CompletionProc

data/lib/irb/context.rb

@@ -22,10 +22,10 @@ module IRB
     #
     # The optional +input_method+ argument:
     #
-    # +nil+::     uses stdin or Readline
+    # +nil+::     uses stdin or Reidline or Readline
     # +String+::  uses a File
     # +other+::   uses this as InputMethod
-    def initialize(irb, workspace = nil, input_method = nil, output_method = nil)
+    def initialize(irb, workspace = nil, input_method = nil)
       @irb = irb
       if workspace
         @workspace = workspace
@@ -39,7 +39,21 @@ module IRB
       @rc = IRB.conf[:RC]
       @load_modules = IRB.conf[:LOAD_MODULES]
 
-      @use_readline = IRB.conf[:USE_READLINE]
+      if IRB.conf.has_key?(:USE_SINGLELINE)
+        @use_singleline = IRB.conf[:USE_SINGLELINE]
+      elsif IRB.conf.has_key?(:USE_READLINE) # backward compatibility
+        @use_singleline = IRB.conf[:USE_READLINE]
+      else
+        @use_singleline = nil
+      end
+      if IRB.conf.has_key?(:USE_MULTILINE)
+        @use_multiline = IRB.conf[:USE_MULTILINE]
+      elsif IRB.conf.has_key?(:USE_REIDLINE) # backward compatibility
+        @use_multiline = IRB.conf[:USE_REIDLINE]
+      else
+        @use_multiline = nil
+      end
+      @use_colorize = IRB.conf[:USE_COLORIZE]
       @verbose = IRB.conf[:VERBOSE]
       @io = nil
 
@@ -64,23 +78,48 @@ module IRB
 
       case input_method
       when nil
-        case use_readline?
+        @io = nil
+        case use_multiline?
         when nil
-          if (defined?(ReadlineInputMethod) && STDIN.tty? &&
-              IRB.conf[:PROMPT_MODE] != :INF_RUBY)
-            @io = ReadlineInputMethod.new
+          if STDIN.tty? && IRB.conf[:PROMPT_MODE] != :INF_RUBY && !use_singleline?
+            # Both of multiline mode and singleline mode aren't specified.
+            puts <<~EOM
+              This version of IRB is drastically different from the previous version.
+              If you hit any issues, you can use "irb --legacy" to run the old version.
+              If you want to just erase this message, please use "irb --multiline" or
+              add `IRB.conf[:USE_MULTILINE] = true` to your ~/.irbrc file.
+            EOM
+            @io = ReidlineInputMethod.new
           else
-            @io = StdioInputMethod.new
+            @io = nil
           end
         when false
-          @io = StdioInputMethod.new
+          @io = nil
         when true
-          if defined?(ReadlineInputMethod)
-            @io = ReadlineInputMethod.new
+          @io = ReidlineInputMethod.new
+        end
+        unless @io
+          case use_singleline?
+          when nil
+            if (defined?(ReadlineInputMethod) && STDIN.tty? &&
+                IRB.conf[:PROMPT_MODE] != :INF_RUBY)
+              @io = ReadlineInputMethod.new
+            else
+              @io = nil
+            end
+          when false
+            @io = nil
+          when true
+            if defined?(ReadlineInputMethod)
+              @io = ReadlineInputMethod.new
+            else
+              @io = nil
+            end
           else
-            @io = StdioInputMethod.new
+            @io = nil
           end
         end
+        @io = StdioInputMethod.new unless @io
 
       when String
         @io = FileInputMethod.new(input_method)
@@ -91,17 +130,15 @@ module IRB
       end
       self.save_history = IRB.conf[:SAVE_HISTORY] if IRB.conf[:SAVE_HISTORY]
 
-      if output_method
-        @output_method = output_method
-      else
-        @output_method = StdioOutputMethod.new
-      end
-
       @echo = IRB.conf[:ECHO]
       if @echo.nil?
         @echo = true
       end
-      self.debug_level = IRB.conf[:DEBUG_LEVEL]
+
+      @echo_on_assignment = IRB.conf[:ECHO_ON_ASSIGNMENT]
+      if @echo_on_assignment.nil?
+        @echo_on_assignment = false
+      end
     end
 
     # The top-level workspace, see WorkSpace#main
@@ -117,9 +154,9 @@ module IRB
     attr_reader :thread
     # The current input method
     #
-    # Can be either StdioInputMethod, ReadlineInputMethod, FileInputMethod or
-    # other specified when the context is created. See ::new for more
-    # information on +input_method+.
+    # Can be either StdioInputMethod, ReadlineInputMethod,
+    # ReidlineInputMethod, FileInputMethod or other specified when the
+    # context is created. See ::new for more # information on +input_method+.
     attr_accessor :io
 
     # Current irb session
@@ -137,12 +174,18 @@ module IRB
     # +input_method+ passed to Context.new
     attr_accessor :irb_path
 
-    # Whether +Readline+ is enabled or not.
+    # Whether multiline editor mode is enabled or not.
+    #
+    # A copy of the default <code>IRB.conf[:USE_MULTILINE]</code>
+    attr_reader :use_multiline
+    # Whether singleline editor mode is enabled or not.
     #
-    # A copy of the default <code>IRB.conf[:USE_READLINE]</code>
+    # A copy of the default <code>IRB.conf[:USE_SINGLELINE]</code>
+    attr_reader :use_singleline
+    # Whether colorization is enabled or not.
     #
-    # See #use_readline= for more information.
-    attr_reader :use_readline
+    # A copy of the default <code>IRB.conf[:USE_COLORIZE]</code>
+    attr_reader :use_colorize
     # A copy of the default <code>IRB.conf[:INSPECT_MODE]</code>
     attr_reader :inspect_mode
 
@@ -165,17 +208,17 @@ module IRB
     # Can be either the default <code>IRB.conf[:AUTO_INDENT]</code>, or the
     # mode set by #prompt_mode=
     #
-    # To enable auto-indentation in irb:
+    # To disable auto-indentation in irb:
     #
-    #     IRB.conf[:AUTO_INDENT] = true
+    #     IRB.conf[:AUTO_INDENT] = false
     #
     # or
     #
-    #     irb_context.auto_indent_mode = true
+    #     irb_context.auto_indent_mode = false
     #
     # or
     #
-    #     IRB.CurrentContext.auto_indent_mode = true
+    #     IRB.CurrentContext.auto_indent_mode = false
     #
     # See IRB@Configuration for more information.
     attr_accessor :auto_indent_mode
@@ -207,14 +250,19 @@ module IRB
     #     puts "omg"
     #     # omg
     attr_accessor :echo
+    # Whether to echo for assignment expressions
+    #
+    # Uses IRB.conf[:ECHO_ON_ASSIGNMENT] if available, or defaults to +false+.
+    #
+    #     a = "omg"
+    #     IRB.CurrentContext.echo_on_assignment = true
+    #     a = "omg"
+    #     #=> omg
+    attr_accessor :echo_on_assignment
     # Whether verbose messages are displayed or not.
     #
     # A copy of the default <code>IRB.conf[:VERBOSE]</code>
     attr_accessor :verbose
-    # The debug level of irb
-    #
-    # See #debug_level= for more information.
-    attr_reader :debug_level
 
     # The limit of backtrace lines displayed as top +n+ and tail +n+.
     #
@@ -225,18 +273,33 @@ module IRB
     # See IRB@Command+line+options for more command line options.
     attr_accessor :back_trace_limit
 
-    # Alias for #use_readline
-    alias use_readline? use_readline
+    # Alias for #use_multiline
+    alias use_multiline? use_multiline
+    # Alias for #use_singleline
+    alias use_singleline? use_singleline
+    # backward compatibility
+    alias use_reidline use_multiline
+    # backward compatibility
+    alias use_reidline? use_multiline
+    # backward compatibility
+    alias use_readline use_singleline
+    # backward compatibility
+    alias use_readline? use_singleline
+    # Alias for #use_colorize
+    alias use_colorize? use_colorize
     # Alias for #rc
     alias rc? rc
     alias ignore_sigint? ignore_sigint
     alias ignore_eof? ignore_eof
     alias echo? echo
+    alias echo_on_assignment? echo_on_assignment
 
     # Returns whether messages are displayed or not.
     def verbose?
       if @verbose.nil?
-        if defined?(ReadlineInputMethod) && @io.kind_of?(ReadlineInputMethod)
+        if @io.kind_of?(ReidlineInputMethod)
+          false
+        elsif defined?(ReadlineInputMethod) && @io.kind_of?(ReadlineInputMethod)
           false
         elsif !STDIN.tty? or @io.kind_of?(FileInputMethod)
           true
@@ -249,9 +312,11 @@ module IRB
     end
 
     # Whether #verbose? is +true+, and +input_method+ is either
-    # StdioInputMethod or ReadlineInputMethod, see #io for more information.
+    # StdioInputMethod or ReidlineInputMethod or ReadlineInputMethod, see #io
+    # for more information.
     def prompting?
       verbose? || (STDIN.tty? && @io.kind_of?(StdioInputMethod) ||
+                   @io.kind_of?(ReidlineInputMethod) ||
                    (defined?(ReadlineInputMethod) && @io.kind_of?(ReadlineInputMethod)))
     end
 
@@ -350,36 +415,11 @@ module IRB
       @inspect_mode
     end
 
-    # Obsolete method.
-    #
-    # Can be set using the +--noreadline+ and +--readline+ command line
-    # options.
-    #
-    # See IRB@Command+line+options for more command line options.
-    def use_readline=(opt)
-      print "This method is obsolete."
-      print "Do nothing."
-    end
-
-    # Sets the debug level of irb
-    #
-    # Can also be set using the +--irb_debug+ command line option.
-    #
-    # See IRB@Command+line+options for more command line options.
-    def debug_level=(value)
-      @debug_level = value
-      RubyLex.debug_level = value
-    end
-
-    # Whether or not debug mode is enabled, see #debug_level=.
-    def debug?
-      @debug_level > 0
-    end
-
     def evaluate(line, line_no, exception: nil) # :nodoc:
       @line_no = line_no
       if exception
-        line = "begin ::Kernel.raise _; rescue _.class; #{line}; end"
+        line_no -= 1
+        line = "begin ::Kernel.raise _; rescue _.class\n#{line}\n""end"
         @workspace.local_variable_set(:_, exception)
       end
       set_last_value(@workspace.evaluate(self, line, irb_path, line_no))