irb 1.0.0 → 1.4.1

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,22 @@ 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]
+      @use_autocomplete = IRB.conf[:USE_AUTOCOMPLETE]
       @verbose = IRB.conf[:VERBOSE]
       @io = nil
 
@@ -64,23 +79,42 @@ 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.
+            @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 +125,22 @@ 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
+      @extra_doc_dirs = IRB.conf[:EXTRA_DOC_DIRS]
 
       @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 = :truncate
+      end
+
+      @newline_before_multiline_output = IRB.conf[:NEWLINE_BEFORE_MULTILINE_OUTPUT]
+      if @newline_before_multiline_output.nil?
+        @newline_before_multiline_output = true
+      end
     end
 
     # The top-level workspace, see WorkSpace#main
@@ -111,18 +150,18 @@ module IRB
 
     # The toplevel workspace, see #home_workspace
     attr_reader :workspace_home
-    # WorkSpace in the current context
+    # WorkSpace in the current context.
     attr_accessor :workspace
-    # The current thread in this context
+    # The current thread in this context.
     attr_reader :thread
-    # The current input method
+    # 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
+    # Current irb session.
     attr_accessor :irb
     # A copy of the default <code>IRB.conf[:AP_NAME]</code>
     attr_accessor :ap_name
@@ -137,26 +176,34 @@ 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_READLINE]</code>
+    # A copy of the default <code>IRB.conf[:USE_MULTILINE]</code>
+    attr_reader :use_multiline
+    # Whether singleline editor mode is enabled or not.
     #
-    # See #use_readline= for more information.
-    attr_reader :use_readline
+    # A copy of the default <code>IRB.conf[:USE_SINGLELINE]</code>
+    attr_reader :use_singleline
+    # Whether colorization is enabled or not.
+    #
+    # A copy of the default <code>IRB.conf[:USE_COLORIZE]</code>
+    attr_reader :use_colorize
+    # A copy of the default <code>IRB.conf[:USE_AUTOCOMPLETE]</code>
+    attr_reader :use_autocomplete
     # A copy of the default <code>IRB.conf[:INSPECT_MODE]</code>
     attr_reader :inspect_mode
 
     # A copy of the default <code>IRB.conf[:PROMPT_MODE]</code>
     attr_reader :prompt_mode
-    # Standard IRB prompt
+    # Standard IRB prompt.
     #
     # See IRB@Customizing+the+IRB+Prompt for more information.
     attr_accessor :prompt_i
-    # IRB prompt for continuated strings
+    # IRB prompt for continuated strings.
     #
     # See IRB@Customizing+the+IRB+Prompt for more information.
     attr_accessor :prompt_s
-    # IRB prompt for continuated statement (e.g. immediately after an +if+)
+    # IRB prompt for continuated statement. (e.g. immediately after an +if+)
     #
     # See IRB@Customizing+the+IRB+Prompt for more information.
     attr_accessor :prompt_c
@@ -165,17 +212,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
@@ -196,9 +243,12 @@ module IRB
     #
     # If set to +false+, <code>^D</code> will quit irb.
     attr_accessor :ignore_eof
+    # Specify the installation locations of the ri file to be displayed in the
+    # document dialog.
+    attr_accessor :extra_doc_dirs
     # Whether to echo the return value to output or not.
     #
-    # Uses IRB.conf[:ECHO] if available, or defaults to +true+.
+    # Uses <code>IRB.conf[:ECHO]</code> if available, or defaults to +true+.
     #
     #     puts "hello"
     #     # hello
@@ -207,14 +257,59 @@ module IRB
     #     puts "omg"
     #     # omg
     attr_accessor :echo
+    # Whether to echo for assignment expressions.
+    #
+    # If set to +false+, the value of assignment will not be shown.
+    #
+    # If set to +true+, the value of assignment will be shown.
+    #
+    # If set to +:truncate+, the value of assignment will be shown and truncated.
+    #
+    # It defaults to +:truncate+.
+    #
+    #     a = "omg"
+    #     #=> omg
+    #
+    #     a = "omg" * 10
+    #     #=> omgomgomgomgomgomgomg...
+    #
+    #     IRB.CurrentContext.echo_on_assignment = false
+    #     a = "omg"
+    #
+    #     IRB.CurrentContext.echo_on_assignment = true
+    #     a = "omg" * 10
+    #     #=> omgomgomgomgomgomgomgomgomgomg
+    #
+    # To set the behaviour of showing on assignment in irb:
+    #
+    #     IRB.conf[:ECHO_ON_ASSIGNMENT] = :truncate or true or false
+    #
+    # or
+    #
+    #     irb_context.echo_on_assignment = :truncate or true or false
+    #
+    # or
+    #
+    #     IRB.CurrentContext.echo_on_assignment = :truncate or true or false
+    attr_accessor :echo_on_assignment
+    # Whether a newline is put before multiline output.
+    #
+    # Uses <code>IRB.conf[:NEWLINE_BEFORE_MULTILINE_OUTPUT]</code> if available,
+    # or defaults to +true+.
+    #
+    #     "abc\ndef"
+    #     #=>
+    #     abc
+    #     def
+    #     IRB.CurrentContext.newline_before_multiline_output = false
+    #     "abc\ndef"
+    #     #=> abc
+    #     def
+    attr_accessor :newline_before_multiline_output
     # 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 +320,36 @@ 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 #use_autocomplete
+    alias use_autocomplete? use_autocomplete
     # 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
+    alias newline_before_multiline_output? newline_before_multiline_output
 
     # 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 +362,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
 
@@ -276,6 +391,7 @@ module IRB
       @prompt_c = pconf[:PROMPT_C]
       @prompt_n = pconf[:PROMPT_N]
       @return_format = pconf[:RETURN]
+      @return_format = "%s\n" if @return_format == nil
       if ai = pconf.include?(:AUTO_INDENT)
         @auto_indent_mode = ai
       else
@@ -350,36 +466,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))
@@ -393,6 +484,8 @@ module IRB
     # Exits the current session, see IRB.irb_exit
     def exit(ret = 0)
       IRB.irb_exit(@irb, ret)
+    rescue UncaughtThrowError
+      super
     end
 
     NOPRINTING_IVARS = ["@last_value"] # :nodoc:

data/lib/irb/easter-egg.rb

@@ -0,0 +1,138 @@
+require "reline"
+
+module IRB
+  class << self
+    class Vec
+      def initialize(x, y, z)
+        @x, @y, @z = x, y, z
+      end
+
+      attr_reader :x, :y, :z
+
+      def sub(other)
+        Vec.new(@x - other.x, @y - other.y, @z - other.z)
+      end
+
+      def dot(other)
+        @x*other.x + @y*other.y + @z*other.z
+      end
+
+      def cross(other)
+        ox, oy, oz = other.x, other.y, other.z
+        Vec.new(@y*oz-@z*oy, @z*ox-@x*oz, @x*oy-@y*ox)
+      end
+
+      def normalize
+        r = Math.sqrt(self.dot(self))
+        Vec.new(@x / r, @y / r, @z / r)
+      end
+    end
+
+    class Canvas
+      def initialize((h, w))
+        @data = (0..h-2).map { [0] * w }
+        @scale = [w / 2.0, h-2].min
+        @center = Complex(w / 2, h-2)
+      end
+
+      def line((x1, y1), (x2, y2))
+        p1 = Complex(x1, y1) / 2 * @scale + @center
+        p2 = Complex(x2, y2) / 2 * @scale + @center
+        line0(p1, p2)
+      end
+
+      private def line0(p1, p2)
+        mid = (p1 + p2) / 2
+        if (p1 - p2).abs < 1
+          x, y = mid.rect
+          @data[y / 2][x] |= (y % 2 > 1 ? 2 : 1)
+        else
+          line0(p1, mid)
+          line0(p2, mid)
+        end
+      end
+
+      def draw
+        @data.each {|row| row.fill(0) }
+        yield
+        @data.map {|row| row.map {|n| " ',;"[n] }.join }.join("\n")
+      end
+    end
+
+    class RubyModel
+      def initialize
+        @faces = init_ruby_model
+      end
+
+      def init_ruby_model
+        cap_vertices    = (0..5).map {|i| Vec.new(*Complex.polar(1,  i        * Math::PI / 3).rect, 1) }
+        middle_vertices = (0..5).map {|i| Vec.new(*Complex.polar(2, (i + 0.5) * Math::PI / 3).rect, 0) }
+        bottom_vertex   = Vec.new(0, 0, -2)
+
+        faces = [cap_vertices]
+        6.times do |j|
+          i = j-1
+          faces << [cap_vertices[i], middle_vertices[i], cap_vertices[j]]
+          faces << [cap_vertices[j], middle_vertices[i], middle_vertices[j]]
+          faces << [middle_vertices[i], bottom_vertex, middle_vertices[j]]
+        end
+
+        faces
+      end
+
+      def render_frame(i)
+        angle = i / 10.0
+        dir = Vec.new(*Complex.polar(1, angle).rect, Math.sin(angle)).normalize
+        dir2 = Vec.new(*Complex.polar(1, angle - Math::PI/2).rect, 0)
+        up = dir.cross(dir2)
+        nm = dir.cross(up)
+        @faces.each do |vertices|
+          v0, v1, v2, = vertices
+          if v1.sub(v0).cross(v2.sub(v0)).dot(dir) > 0
+            points = vertices.map {|p| [nm.dot(p), up.dot(p)] }
+            (points + [points[0]]).each_cons(2) do |p1, p2|
+              yield p1, p2
+            end
+          end
+        end
+      end
+    end
+
+    private def easter_egg(type = nil)
+      type ||= [:logo, :dancing].sample
+      case type
+      when :logo
+        File.open(File.join(__dir__, 'ruby_logo.aa')) do |f|
+          require "rdoc"
+          RDoc::RI::Driver.new.page do |io|
+            IO.copy_stream(f, io)
+          end
+        end
+      when :dancing
+        begin
+          canvas = Canvas.new(Reline.get_screen_size)
+          Reline::IOGate.set_winch_handler do
+            canvas = Canvas.new(Reline.get_screen_size)
+          end
+          ruby_model = RubyModel.new
+          print "\e[?1049h"
+          0.step do |i| # TODO (0..).each needs Ruby 2.6 or later
+            buff = canvas.draw do
+              ruby_model.render_frame(i) do |p1, p2|
+                canvas.line(p1, p2)
+              end
+            end
+            buff[0, 20] = "\e[0mPress Ctrl+C to stop\e[31m\e[1m"
+            print "\e[H" + buff
+            sleep 0.05
+          end
+        rescue Interrupt
+        ensure
+          print "\e[0m\e[?1049l"
+        end
+      end
+    end
+  end
+end
+
+IRB.__send__(:easter_egg, ARGV[0]&.to_sym) if $0 == __FILE__

data/lib/irb/ext/change-ws.rb

@@ -43,4 +43,3 @@ module IRB # :nodoc:
     end
   end
 end
-

data/lib/irb/ext/history.rb

@@ -22,7 +22,7 @@ module IRB # :nodoc:
     def set_last_value(value)
       _set_last_value(value)
 
-      if @eval_history
+      if defined?(@eval_history) && @eval_history
         @eval_history_values.push @line_no, @last_value
         @workspace.evaluate self, "__ = IRB.CurrentContext.instance_eval{@eval_history_values}"
       end
@@ -30,9 +30,13 @@ module IRB # :nodoc:
       @last_value
     end
 
-    # The command result history limit.
+    remove_method :eval_history= if method_defined?(:eval_history=)
+    # The command result history limit. This method is not available until
+    # #eval_history= was called with non-nil value (directly or via
+    # setting <code>IRB.conf[:EVAL_HISTORY]</code> in <code>.irbrc</code>).
     attr_reader :eval_history
-    # Sets command result history limit.
+    # Sets command result history limit. Default value is set from
+    # <code>IRB.conf[:EVAL_HISTORY]</code>.
     #
     # +no+ is an Integer or +nil+.
     #
@@ -41,6 +45,9 @@ module IRB # :nodoc:
     # If +no+ is 0, the number of history items is unlimited.
     #
     # If +no+ is +nil+, execution result history isn't used (default).
+    #
+    # History values are available via <code>__</code> variable, see
+    # IRB::History.
     def eval_history=(no)
       if no
         if defined?(@eval_history) && @eval_history
@@ -58,20 +65,51 @@ module IRB # :nodoc:
     end
   end
 
-  class History # :nodoc:
-
-    def initialize(size = 16)
+  # Represents history of results of previously evaluated commands.
+  #
+  # Available via <code>__</code> variable, only if <code>IRB.conf[:EVAL_HISTORY]</code>
+  # or <code>IRB::CurrentContext().eval_history</code> is non-nil integer value
+  # (by default it is +nil+).
+  #
+  # Example (in `irb`):
+  #
+  #    # Initialize history
+  #    IRB::CurrentContext().eval_history = 10
+  #    # => 10
+  #
+  #    # Perform some commands...
+  #    1 + 2
+  #    # => 3
+  #    puts 'x'
+  #    # x
+  #    # => nil
+  #    raise RuntimeError
+  #    # ...error raised
+  #
+  #    # Inspect history (format is "<item number> <evaluated value>":
+  #    __
+  #    # => 1 10
+  #    # 2 3
+  #    # 3 nil
+  #
+  #    __[1]
+  #    # => 10
+  #
+  class History
+
+    def initialize(size = 16)  # :nodoc:
       @size = size
       @contents = []
     end
 
-    def size(size)
+    def size(size) # :nodoc:
       if size != 0 && size < @size
         @contents = @contents[@size - size .. @size]
       end
       @size = size
     end
 
+    # Get one item of the content (both positive and negative indexes work).
     def [](idx)
       begin
         if idx >= 0
@@ -84,14 +122,14 @@ module IRB # :nodoc:
       end
     end
 
-    def push(no, val)
+    def push(no, val)  # :nodoc:
       @contents.push [no, val]
       @contents.shift if @size != 0 && @contents.size > @size
     end
 
     alias real_inspect inspect
 
-    def inspect
+    def inspect  # :nodoc:
       if @contents.empty?
         return real_inspect
       end
@@ -115,5 +153,3 @@ module IRB # :nodoc:
     end
   end
 end
-
-