irb 1.8.3 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 332023cd842d367c49ca245616a926f8f8df1f724c16b22d18447f1456710290
-  data.tar.gz: c6b7ab4d628a6fb766bed6f93b124490b1c364ba79b7ce8c1e4e21d67df64545
+  metadata.gz: 810aa12a1fbfdbd0ff9f9c4d5c4ac71e62e8241f87cb1a306be1ff81aaef08cb
+  data.tar.gz: 781d169232ac355b9723e8dc03d6c0de4c16327b4a4a3339cd1e90bad7e1c0b1
 SHA512:
-  metadata.gz: 8962b3e7359c4292bb09c75f3a5f1548b5dd53c3053a4a736a0a295c83126b065eca7578a185a0bf218468053399a3f029e47a06860ac69713756fb346945d08
-  data.tar.gz: '0109b52f17e50b944d5fb3e9e40b432a3a3bafbf45ed9b0dd5725de43527e5ca3926db65b44bf39c646f76c38c4dee07cd2eb8fcb33690dc071dcd4a66b99b87'
+  metadata.gz: 51d97e80d977c6ce100f66cc0ad4becae17600d36653be88cc7c2f1e6cd0b7127cec01344bc69b04de1b043f8d45a1d07f6b4b8ad3fad4584585aca269cfa65f
+  data.tar.gz: a197cf8c07a1ea728a3c9d0d70fdd28a2a5b9a4e9ebf72a8fd8d6495627cf4c369e6831879a766c5dd8819438bb1f126b0d4d669becc4c63a7ad6c4ea51a3a79

data/Gemfile

@@ -17,3 +17,10 @@ gem "rake"
 gem "test-unit"
 gem "test-unit-ruby-core"
 gem "debug", github: "ruby/debug"
+
+gem "racc"
+
+if RUBY_VERSION >= "3.0.0"
+  gem "rbs"
+  gem "prism", ">= 0.17.1"
+end

data/README.md

@@ -52,6 +52,10 @@ $ gem install irb
 
 ## Usage
 
+> **Note**
+>
+> We're working hard to match Pry's variety of powerful features in IRB, and you can track our progress or find contribution ideas in [this document](https://github.com/ruby/irb/blob/master/COMPARED_WITH_PRY.md).
+
 ### The `irb` Executable
 
 You can start a fresh IRB session by typing `irb` in your terminal.
@@ -231,6 +235,79 @@ However, there are also some limitations to be aware of:
 2. As IRB [doesn't currently support remote-connection](https://github.com/ruby/irb/issues/672), it can't be used with `debug.gem`'s remote debugging feature.
 3. Access to the previous return value via the underscore `_` is not supported.
 
+## Type Based Completion
+
+IRB's default completion `IRB::RegexpCompletor` uses Regexp. IRB has another experimental completion `IRB::TypeCompletion` that uses type analysis.
+
+### How to Enable IRB::TypeCompletion
+
+To enable IRB::TypeCompletion, run IRB with `--type-completor` option
+```
+$ irb --type-completor
+```
+Or write the code below to IRB's rc-file.
+```ruby
+IRB.conf[:COMPLETOR] = :type # default is :regexp
+```
+You also need `gem prism` and `gem rbs` to use this feature.
+
+To check if it's enabled, type `irb_info` into IRB and see the `Completion` section.
+```
+irb(main):001> irb_info
+...
+# Enabled
+Completion: Autocomplete, TypeCompletion::Completor(Prism: 0.17.1, RBS: 3.3.0)
+# Not enabled
+Completion: Autocomplete, RegexpCompletor
+...
+```
+If you have `sig/` directory or `rbs_collection.lock.yaml` in current directory, IRB will load it.
+
+### Advantage over Default IRB::RegexpCompletor
+
+IRB::TypeCompletion can autocomplete chained methods, block parameters and more if type information is available.
+These are some examples IRB::RegexpCompletor cannot complete.
+
+```ruby
+irb(main):001> 'Ruby'.upcase.chars.s # Array methods (sample, select, shift, size)
+```
+
+```ruby
+irb(main):001> 10.times.map(&:to_s).each do |s|
+irb(main):002>   s.up # String methods (upcase, upcase!, upto)
+```
+
+```ruby
+irb(main):001> class User < ApplicationRecord
+irb(main):002>   def foo
+irb(main):003>     sa # save, save!
+```
+
+As a trade-off, completion calculation takes more time than IRB::RegexpCompletor.
+
+### Difference between Steep's Completion
+
+Compared with Steep, IRB::TypeCompletion has some difference and limitations.
+```ruby
+[0, 'a'].sample.
+# Steep completes intersection of Integer methods and String methods
+# IRB::TypeCompletion completes both Integer and String methods
+```
+
+Some features like type narrowing is not implemented.
+```ruby
+def f(arg = [0, 'a'].sample)
+  if arg.is_a?(String)
+    arg. # Completes both Integer and String methods
+```
+
+Unlike other static type checker, IRB::TypeCompletion uses runtime information to provide better completion.
+```ruby
+irb(main):001> a = [1]
+=> [1]
+irb(main):002> a.first. # Completes Integer methods
+```
+
 ## Configuration
 
 ### Environment Variables
@@ -269,6 +346,30 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/ruby/irb.
 
+### Set up the environment
+
+1. Fork the project to your GithHub account
+2. Clone the fork with `git clone git@github.com:[your_username]/irb.git`
+3. Run `bundle install`
+4. Run `bundle exec rake` to make sure tests pass locally
+
+### Run integration tests
+
+If your changes affect component rendering, such as the autocompletion's dialog/dropdown, you may need to run IRB's integration tests, known as `yamatanarroroti`.
+
+Before running these tests, ensure that you have `libvterm` installed. If you're using Homebrew, you can install it by running:
+
+```bash
+brew install libvterm
+```
+
+After installing `libvterm`, you can run the integration tests using the following commands:
+
+```bash
+WITH_VTERM=1 bundle install
+WITH_VTERM=1 bundle exec rake test test_yamatanooroti
+```
+
 ## Releasing
 
 ```

data/Rakefile

@@ -5,7 +5,7 @@ Rake::TestTask.new(:test) do |t|
   t.libs << "test" << "test/lib"
   t.libs << "lib"
   t.ruby_opts << "-rhelper"
-  t.test_files = FileList["test/irb/test_*.rb"]
+  t.test_files = FileList["test/irb/test_*.rb", "test/irb/type_completion/test_*.rb"]
 end
 
 # To make sure they have been correctly setup for Ruby CI.
@@ -13,7 +13,7 @@ desc "Run each irb test file in isolation."
 task :test_in_isolation do
   failed = false
 
-  FileList["test/irb/test_*.rb"].each do |test_file|
+  FileList["test/irb/test_*.rb", "test/irb/type_completion/test_*.rb"].each do |test_file|
     ENV["TEST"] = test_file
     begin
       Rake::Task["test"].execute

data/lib/irb/cmd/irb_info.rb

@@ -14,6 +14,7 @@ module IRB
         str  = "Ruby version: #{RUBY_VERSION}\n"
         str += "IRB version: #{IRB.version}\n"
         str += "InputMethod: #{IRB.CurrentContext.io.inspect}\n"
+        str += "Completion: #{IRB.CurrentContext.io.respond_to?(:completion_info) ? IRB.CurrentContext.io.completion_info : 'off'}\n"
         str += ".irbrc path: #{IRB.rc_file}\n" if File.exist?(IRB.rc_file)
         str += "RUBY_PLATFORM: #{RUBY_PLATFORM}\n"
         str += "LANG env: #{ENV["LANG"]}\n" if ENV["LANG"] && !ENV["LANG"].empty?

data/lib/irb/completion.rb

@@ -9,6 +9,30 @@ require_relative 'ruby-lex'
 
 module IRB
   class BaseCompletor # :nodoc:
+
+    # Set of reserved words used by Ruby, you should not use these for
+    # constants or variables
+    ReservedWords = %w[
+      __ENCODING__ __LINE__ __FILE__
+      BEGIN END
+      alias and
+      begin break
+      case class
+      def defined? do
+      else elsif end ensure
+      false for
+      if in
+      module
+      next nil not
+      or
+      redo rescue retry return
+      self super
+      then true
+      undef unless until
+      when while
+      yield
+    ]
+
     def completion_candidates(preposing, target, postposing, bind:)
       raise NotImplementedError
     end
@@ -94,28 +118,9 @@ module IRB
       end
     }
 
-    # Set of reserved words used by Ruby, you should not use these for
-    # constants or variables
-    ReservedWords = %w[
-      __ENCODING__ __LINE__ __FILE__
-      BEGIN END
-      alias and
-      begin break
-      case class
-      def defined? do
-      else elsif end ensure
-      false for
-      if in
-      module
-      next nil not
-      or
-      redo rescue retry return
-      self super
-      then true
-      undef unless until
-      when while
-      yield
-    ]
+    def inspect
+      'RegexpCompletor'
+    end
 
     def complete_require_path(target, preposing, postposing)
       if target =~ /\A(['"])([^'"]+)\Z/

data/lib/irb/context.rb

@@ -86,14 +86,14 @@ module IRB
         when nil
           if STDIN.tty? && IRB.conf[:PROMPT_MODE] != :INF_RUBY && !use_singleline?
             # Both of multiline mode and singleline mode aren't specified.
-            @io = RelineInputMethod.new
+            @io = RelineInputMethod.new(build_completor)
           else
             @io = nil
           end
         when false
           @io = nil
         when true
-          @io = RelineInputMethod.new
+          @io = RelineInputMethod.new(build_completor)
         end
         unless @io
           case use_singleline?
@@ -149,6 +149,43 @@ module IRB
       @command_aliases = IRB.conf[:COMMAND_ALIASES]
     end
 
+    private def build_completor
+      completor_type = IRB.conf[:COMPLETOR]
+      case completor_type
+      when :regexp
+        return RegexpCompletor.new
+      when :type
+        completor = build_type_completor
+        return completor if completor
+      else
+        warn "Invalid value for IRB.conf[:COMPLETOR]: #{completor_type}"
+      end
+      # Fallback to RegexpCompletor
+      RegexpCompletor.new
+    end
+
+    TYPE_COMPLETION_REQUIRED_PRISM_VERSION = '0.17.1'
+
+    private def build_type_completor
+      unless Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('3.0.0') && RUBY_ENGINE != 'truffleruby'
+        warn 'TypeCompletion requires RUBY_VERSION >= 3.0.0'
+        return
+      end
+      begin
+        require 'prism'
+      rescue LoadError => e
+        warn "TypeCompletion requires Prism: #{e.message}"
+        return
+      end
+      unless Gem::Version.new(Prism::VERSION) >= Gem::Version.new(TYPE_COMPLETION_REQUIRED_PRISM_VERSION)
+        warn "TypeCompletion requires Prism::VERSION >= #{TYPE_COMPLETION_REQUIRED_PRISM_VERSION}"
+        return
+      end
+      require 'irb/type_completion/completor'
+      TypeCompletion::Types.preload_in_thread
+      TypeCompletion::Completor.new
+    end
+
     def save_history=(val)
       IRB.conf[:SAVE_HISTORY] = val
     end

data/lib/irb/easter-egg.rb

@@ -98,18 +98,26 @@ module IRB
       end
     end
 
+    private def easter_egg_logo(type)
+      @easter_egg_logos ||= File.read(File.join(__dir__, 'ruby_logo.aa'), encoding: 'UTF-8:UTF-8')
+        .split(/TYPE: ([A-Z]+)\n/)[1..]
+        .each_slice(2)
+        .to_h
+      @easter_egg_logos[type.to_s.upcase]
+    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
+        require "rdoc"
+        RDoc::RI::Driver.new.page do |io|
+          io.write easter_egg_logo(:large)
         end
       when :dancing
-        begin
+        STDOUT.cooked do
+          interrupted = false
+          prev_trap = trap("SIGINT") { interrupted = true }
           canvas = Canvas.new(Reline.get_screen_size)
           Reline::IOGate.set_winch_handler do
             canvas = Canvas.new(Reline.get_screen_size)
@@ -125,10 +133,12 @@ module IRB
             buff[0, 20] = "\e[0mPress Ctrl+C to stop\e[31m\e[1m"
             print "\e[H" + buff
             sleep 0.05
+            break if interrupted
           end
         rescue Interrupt
         ensure
           print "\e[0m\e[?1049l"
+          trap("SIGINT", prev_trap)
         end
       end
     end

data/lib/irb/init.rb

@@ -5,6 +5,41 @@
 #
 
 module IRB # :nodoc:
+  @CONF = {}
+  # Displays current configuration.
+  #
+  # Modifying the configuration is achieved by sending a message to IRB.conf.
+  #
+  # See IRB@Configuration for more information.
+  def IRB.conf
+    @CONF
+  end
+
+  def @CONF.inspect
+    array = []
+    for k, v in sort{|a1, a2| a1[0].id2name <=> a2[0].id2name}
+      case k
+      when :MAIN_CONTEXT, :__TMP__EHV__
+        array.push format("CONF[:%s]=...myself...", k.id2name)
+      when :PROMPT
+        s = v.collect{
+          |kk, vv|
+          ss = vv.collect{|kkk, vvv| ":#{kkk.id2name}=>#{vvv.inspect}"}
+          format(":%s=>{%s}", kk.id2name, ss.join(", "))
+        }
+        array.push format("CONF[:%s]={%s}", k.id2name, s.join(", "))
+      else
+        array.push format("CONF[:%s]=%s", k.id2name, v.inspect)
+      end
+    end
+    array.join("\n")
+  end
+
+  # Returns the current version of IRB, including release version and last
+  # updated date.
+  def IRB.version
+    format("irb %s (%s)", @RELEASE_VERSION, @LAST_UPDATE_DATE)
+  end
 
   # initialize config
   def IRB.setup(ap_path, argv: ::ARGV)
@@ -28,6 +63,7 @@ module IRB # :nodoc:
     unless ap_path and @CONF[:AP_NAME]
       ap_path = File.join(File.dirname(File.dirname(__FILE__)), "irb.rb")
     end
+    @CONF[:VERSION] = version
     @CONF[:AP_NAME] = File::basename(ap_path, ".rb")
 
     @CONF[:IRB_NAME] = "irb"
@@ -40,6 +76,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] = :regexp
     @CONF[:INSPECT_MODE] = true
     @CONF[:USE_TRACER] = false
     @CONF[:USE_LOADER] = false
@@ -293,6 +330,10 @@ module IRB # :nodoc:
         @CONF[:USE_AUTOCOMPLETE] = true
       when "--noautocomplete"
         @CONF[:USE_AUTOCOMPLETE] = false
+      when "--regexp-completor"
+        @CONF[:COMPLETOR] = :regexp
+      when "--type-completor"
+        @CONF[:COMPLETOR] = :type
       when /^--prompt-mode(?:=(.+))?/, /^--prompt(?:=(.+))?/
         opt = $1 || argv.shift
         prompt_mode = opt.upcase.tr("-", "_").intern

data/lib/irb/input-method.rb

@@ -193,6 +193,10 @@ module IRB
       }
     end
 
+    def completion_info
+      'RegexpCompletor'
+    end
+
     # Reads the next line from this input method.
     #
     # See IO#gets for more information.
@@ -230,13 +234,13 @@ module IRB
     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
+      super()
 
       @eof = false
-      @completor = RegexpCompletor.new
+      @completor = completor
 
       Reline.basic_word_break_characters = BASIC_WORD_BREAK_CHARACTERS
       Reline.completion_append_character = nil
@@ -270,6 +274,11 @@ module IRB
       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
@@ -303,15 +312,20 @@ module IRB
         return nil if result.nil? or pointer.nil? or pointer < 0
 
         name = doc_namespace.call(result[pointer])
+        show_easter_egg = name&.match?(/\ARubyVM/) && !ENV['RUBY_YES_I_AM_NOT_A_NORMAL_USER']
 
         options = {}
         options[:extra_doc_dirs] = IRB.conf[:EXTRA_DOC_DIRS] unless IRB.conf[:EXTRA_DOC_DIRS].empty?
         driver = RDoc::RI::Driver.new(options)
 
         if key.match?(dialog.name)
-          begin
-            driver.display_names([name])
-          rescue RDoc::RI::Driver::NotFoundError
+          if show_easter_egg
+            IRB.__send__(:easter_egg)
+          else
+            begin
+              driver.display_names([name])
+            rescue RDoc::RI::Driver::NotFoundError
+            end
           end
         end
 
@@ -374,8 +388,15 @@ module IRB
         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")
+        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

data/lib/irb/lc/help-message

@@ -30,6 +30,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'.

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

@@ -21,6 +21,9 @@ Usage:  irb.rb [options] [programfile] [arguments]
   --nocolorize	    色付けを利用しない.
   --autocomplete    オートコンプリートを利用する.
   --noautocomplete  オートコンプリートを利用しない.
+  --regexp-completor
+                    補完に正規表現を利用する.
+  --type-completor  補完に型情報を利用する.
   --prompt prompt-mode/--prompt-mode prompt-mode
 		    プロンプトモードを切替えます. 現在定義されているプ
 		    ロンプトモードは, default, simple, xmp, inf-rubyが

data/lib/irb/ruby_logo.aa

@@ -1,3 +1,4 @@
+TYPE: LARGE
 
                                              -+smJYYN?mm-
                                    HB"BBYT            TQg  NggT
@@ -35,3 +36,45 @@
     m7       NW H            N                        HSVO1z=?11-
       NgTH    bB        kH   WBHWWHBHWmQgg&gggggNNN
            NNggggggNN
+TYPE: ASCII
+                  ,,,;;;;''''';;;'';,
+              ,,;''     ';;,;;;      ',
+           ,,''          ;;'';'''';;;;;;
+         ,;'             ;;   ',,      ;
+       ,;'              ,;'     ';,    ;
+      ;'               ,;;         ',,,;
+    ,'                ,;;,,,,,,,,,,,;;;;
+   ;'                ;;';;;;         ,;;
+  ;'               ,;'  ;; '',,     ,;;;
+ ;;              ,;'     ;    '';, ,; ;'
+;;            ,;;'       ;;       ;; ;;
+;;,        ,,;;'          ;      ;'; ;;
+;';;,,,,;;;;;;;,,,        ;;   ,'  ; ;;
+; ;;'''    ,;';  ''';,,,   ; ,;'   ;;;;
+;;;;,      ;  ';       ''';;;'     ';;;
+;'; ;,    ;'   ';        ,;' ',     ;;;
+;;;  ;   ,;     ';    ,,'      ',,  ;;
+;;;  ';  ;'      ';,,''          ';,;;
+ ';   ';,;     ,,;''''''''';;;;;;,,;;;
+   ';,,;;,,;;;;;;;;;;''''''''''''''
+TYPE: UNICODE
+                  ⣀⣤⣴⣾⣿⣿⣿⡛⠛⠛⠛⠛⣻⣿⠿⠛⠛⠶⣤⡀
+              ⣀⣴⠾⠛⠉⠁    ⠙⣿⣶⣤⣶⣟⣉     ⠈⠻⣦
+           ⣀⣴⠟⠋          ⢸⣿⠟⠻⣯⡙⠛⠛⠛⠶⠶⠶⢶⣽⣇
+         ⣠⡾⠋⠁            ⣾⡿  ⠈⠛⢦⣄      ⣿
+       ⣠⡾⠋              ⣰⣿⠃     ⠙⠷⣤⡀   ⣿
+     ⢀⡾⠋               ⣰⣿⡏        ⠈⠻⣦⣄⢠⣿
+    ⣰⠟⠁               ⣴⣿⣿⣁⣀⣠⣤⣤⣤⣤⣤⣤⣤⣴⠶⠿⣿⡏
+   ⣼⠏               ⢀⣾⣿⠟⣿⠿⣯⣍⠁        ⣰⣿⡇
+ ⢀⣼⠋              ⢀⣴⣿⠟⠁ ⢸⡇ ⠙⠻⢦⣄⡀    ⢠⡿⣿⡇
+⢀⣾⡏             ⢀⣴⣿⠟⠁    ⣿    ⠉⠻⢶⣄⡀⣰⡟ ⣿⠃
+⣾⣿⠁           ⣠⣶⡿⠋⠁      ⢹⡇      ⠈⣿⡏ ⢸⣿
+⣿⣿⡆       ⢀⣠⣴⣿⡿⠋         ⠈⣿     ⢀⡾⠋⣿ ⢸⣿
+⣿⠸⣿⣶⣤⣤⣤⣤⣶⣾⠿⠿⣿⣿⠶⣤⣤⣀⡀       ⢹⡇   ⣴⠟⠁ ⣿⡀⢸⣿
+⣿⢀⣿⣟⠛⠋⠉⠁   ⢰⡟⠹⣧ ⠈⠉⠛⠻⠶⢦⣤⣀⡀ ⠈⣿ ⣠⡾⠃   ⢸⡇⢸⡇
+⣿⣾⣿⢿⡄      ⣿⠁ ⠘⣧       ⠉⠙⠛⠷⣿⣿⡋     ⠸⣇⣸⡇
+⣿⠃⣿⠈⢿⡄    ⣸⠇   ⠘⣧       ⢀⣤⠾⠋⠈⠻⣦⡀    ⣿⣿⡇
+⣿⢸⡏ ⠈⣷⡀  ⢠⡿     ⠘⣧⡀   ⣠⡴⠟⠁    ⠈⠻⣦⣀  ⢿⣿⠁
+⢻⣾⡇  ⠘⣷  ⣼⠃      ⠘⣷⣠⣴⠟⠋          ⠙⢷⣄⢸⣿
+ ⠻⣧⡀  ⠘⣧⣰⡏    ⢀⣠⣤⠶⠛⠉⠛⠛⠛⠛⠛⠛⠻⢶⣶⣶⣶⣶⣶⣤⣤⣽⣿⣿
+  ⠈⠛⠷⢦⣤⣽⣿⣥⣤⣶⣶⡿⠿⠿⠶⠶⠶⠶⠾⠛⠛⠛⠛⠛⠛⠛⠋⠉⠉⠉⠉⠉⠉⠁