irb 1.10.1 → 1.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce85a9eb69af7fbbb8cb41a6d34029502d2b6712d916b7a3823176e2769cdcf8
-  data.tar.gz: 711b52081eb0a97eee4901844b33e8cf9657316c8dde29c9eeb41d3a6998f78e
+  metadata.gz: 17969636013c03ffd08d5b53570ec0eda8620855092bd863c5b851e668343007
+  data.tar.gz: 7900a886588ebca5839e2b6fac6d538e58febd2706cdbbe979e098f2950d2d79
 SHA512:
-  metadata.gz: 300f29f4e769be7ede8371fc7f667fb543eb7d8dd9249b062993074c2bdbb5808a3322cb4bb6a0ff58bd79c2d6e82a3bbac0f78b6a117e0095c63fbfe9431fb8
-  data.tar.gz: 997b64b19a2902c6a9bc47ee4aff909b133f13e829456cc4fe4cf33b6ca425c8619f58ffda7be71bdd3dde1b91e2d23ba24bad9e9045b612fc190e6ac3fa42e7
+  metadata.gz: e9d8fe7568718ce10db38ed1a85ad92473c21ca81738cadaa8a8258adcf18cdbfc5755c61621c336ac4bc53c57a08ad26311a4fc671fb98ad0cd5130c2e7527e
+  data.tar.gz: 729f6a0f6ba9fe6cfac3e2ed9e752531006f60c386b3e51fd84c877eeb1b3cdcb0fee1a7bf44c3c0bfa7f0f56def8ad8c7d99413b9b96b304d17e0c15d90aa87

data/.document

@@ -1,4 +1,4 @@
 LICENSE.txt
 README.md
-doc
+doc/irb/indexes.md
 lib/**/*.rb

data/README.md

@@ -15,6 +15,10 @@ The `irb` command from your shell will start the interpreter.
 - [Debugging with IRB](#debugging-with-irb)
   - [More about `debug.gem`](#more-about-debuggem)
   - [Advantages Over `debug.gem`'s Console](#advantages-over-debuggems-console)
+- [Type Based Completion](#type-based-completion)
+  - [How to Enable IRB::TypeCompletor](#how-to-enable-irbtypecompletor)
+  - [Advantage over Default IRB::RegexpCompletor](#advantage-over-default-irbregexpcompletor)
+  - [Difference between Steep's Completion](#difference-between-steeps-completion)
 - [Configuration](#configuration)
   - [Environment Variables](#environment-variables)
 - [Documentation](#documentation)
@@ -105,15 +109,9 @@ Hello World
 
 The following commands are available on IRB. You can get the same output from the `show_cmds` command.
 
-```
-Workspace
-  cwws           Show the current workspace.
-  chws           Change the current workspace to an object.
-  workspaces     Show workspaces.
-  pushws         Push an object to the workspace stack.
-  popws          Pop a workspace from the workspace stack.
-
+```txt
 IRB
+  exit           Exit the current irb session.
   irb_load       Load a Ruby file.
   irb_require    Require a Ruby file.
   source         Loads a given file in the current session.
@@ -121,6 +119,13 @@ IRB
   show_cmds      List all available commands and their description.
   history        Shows the input history. `-g [query]` or `-G [query]` allows you to filter the output.
 
+Workspace
+  cwws           Show the current workspace.
+  chws           Change the current workspace to an object.
+  workspaces     Show workspaces.
+  pushws         Push an object to the workspace stack.
+  popws          Pop a workspace from the workspace stack.
+
 Multi-irb (DEPRECATED)
   irb            Start a child IRB.
   jobs           List of current sessions.
@@ -149,6 +154,10 @@ Context
   ls             Show methods, constants, and variables. `-g [query]` or `-G [query]` allows you to filter out the output.
   show_source    Show the source code of a given method or constant.
   whereami       Show the source code around binding.irb again.
+
+Aliases
+  $              Alias for `show_source`
+  @              Alias for `whereami`
 ```
 
 ## Debugging with IRB
@@ -242,15 +251,33 @@ IRB's default completion `IRB::RegexpCompletor` uses Regexp. IRB has another exp
 
 ### How to Enable IRB::TypeCompletor
 
-To enable IRB::TypeCompletor, run IRB with `--type-completor` option
+Install [ruby/repl_type_completor](https://github.com/ruby/repl_type_completor/) with:
+```
+$ gem install repl_type_completor
+```
+Or add these lines to your project's Gemfile.
+```ruby
+gem 'irb'
+gem 'repl_type_completor', group: [:development, :test]
+```
+
+Now you can use type based completion by:
+
+Running IRB with the `--type-completor` option
 ```
 $ irb --type-completor
 ```
-Or write the code below to IRB's rc-file.
+
+Or writing this line to IRB's rc-file (e.g. `~/.irbrc`)
 ```ruby
 IRB.conf[:COMPLETOR] = :type # default is :regexp
 ```
-You also need `gem repl_type_completor` to use this feature.
+
+Or setting the environment variable `IRB_COMPLETOR`
+```ruby
+ENV['IRB_COMPLETOR'] = 'type'
+IRB.start
+```
 
 To check if it's enabled, type `irb_info` into IRB and see the `Completion` section.
 ```

data/irb.gemspec

@@ -41,6 +41,6 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = Gem::Requirement.new(">= 2.7")
 
-  spec.add_dependency "reline", ">= 0.3.8"
+  spec.add_dependency "reline", ">= 0.4.2"
   spec.add_dependency "rdoc"
 end

data/lib/irb/cmd/debug.rb

@@ -31,7 +31,7 @@ module IRB
           # 4. Exit the current Irb#run call via `throw :IRB_EXIT`.
           # 5. `Irb#debug_break` will be called and trigger the breakpoint, which will run the intended command.
           unless binding_irb?
-            puts "`debug` command is only available when IRB is started with binding.irb"
+            puts "Debugging commands are only available when IRB is started with binding.irb"
             return
           end
 

data/lib/irb/cmd/exit.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative "nop"
+
+module IRB
+  # :stopdoc:
+
+  module ExtendCommand
+    class Exit < Nop
+      category "IRB"
+      description "Exit the current irb session."
+
+      def execute(*)
+        IRB.irb_exit
+      rescue UncaughtThrowError
+        Kernel.exit
+      end
+    end
+  end
+
+  # :startdoc:
+end

data/lib/irb/cmd/measure.rb

@@ -12,32 +12,29 @@ module IRB
         super(*args)
       end
 
-      def execute(type = nil, arg = nil, &block)
+      def execute(type = nil, arg = nil)
         # Please check IRB.init_config in lib/irb/init.rb that sets
         # IRB.conf[:MEASURE_PROC] to register default "measure" methods,
         # "measure :time" (abbreviated as "measure") and "measure :stackprof".
+
+        if block_given?
+          warn 'Configure IRB.conf[:MEASURE_PROC] to add custom measure methods.'
+          return
+        end
+
         case type
         when :off
-          IRB.conf[:MEASURE] = nil
           IRB.unset_measure_callback(arg)
         when :list
           IRB.conf[:MEASURE_CALLBACKS].each do |type_name, _, arg_val|
             puts "- #{type_name}" + (arg_val ? "(#{arg_val.inspect})" : '')
           end
         when :on
-          IRB.conf[:MEASURE] = true
-          added = IRB.set_measure_callback(type, arg)
+          added = IRB.set_measure_callback(arg)
           puts "#{added[0]} is added." if added
         else
-          if block_given?
-            IRB.conf[:MEASURE] = true
-            added = IRB.set_measure_callback(&block)
-            puts "#{added[0]} is added." if added
-          else
-            IRB.conf[:MEASURE] = true
-            added = IRB.set_measure_callback(type, arg)
-            puts "#{added[0]} is added." if added
-          end
+          added = IRB.set_measure_callback(type, arg)
+          puts "#{added[0]} is added." if added
         end
         nil
       end

data/lib/irb/cmd/show_source.rb

@@ -27,17 +27,14 @@ module IRB
           puts "Error: Expected a string but got #{str.inspect}"
           return
         end
-        if str.include? " -s"
-          str, esses = str.split(" -")
-          s_count = esses.count("^s").zero? ? esses.size : 1
-          source = SourceFinder.new(@irb_context).find_source(str, s_count)
-        else
-          source = SourceFinder.new(@irb_context).find_source(str)
-        end
+
+        str, esses = str.split(" -")
+        super_level = esses ? esses.count("s") : 0
+        source = SourceFinder.new(@irb_context).find_source(str, super_level)
 
         if source
           show_source(source)
-        elsif s_count
+        elsif super_level > 0
           puts "Error: Couldn't locate a super definition for #{str}"
         else
           puts "Error: Couldn't locate a definition for #{str}"

data/lib/irb/completion.rb

@@ -406,7 +406,13 @@ module IRB
         else
           select_message(receiver, message, candidates.sort)
         end
-
+      when /^\s*$/
+        # empty input
+        if doc_namespace
+          nil
+        else
+          []
+        end
       else
         if doc_namespace
           vars = (bind.local_variables | bind.eval_instance_variables).collect{|m| m.to_s}

data/lib/irb/context.rb

@@ -264,15 +264,15 @@ module IRB
     attr_reader :prompt_mode
     # Standard IRB prompt.
     #
-    # See IRB@Customizing+the+IRB+Prompt for more information.
+    # See {Custom Prompts}[rdoc-ref:IRB@Custom+Prompts] for more information.
     attr_accessor :prompt_i
     # IRB prompt for continuated strings.
     #
-    # See IRB@Customizing+the+IRB+Prompt for more information.
+    # See {Custom Prompts}[rdoc-ref:IRB@Custom+Prompts] for more information.
     attr_accessor :prompt_s
     # IRB prompt for continuated statement. (e.g. immediately after an +if+)
     #
-    # See IRB@Customizing+the+IRB+Prompt for more information.
+    # See {Custom Prompts}[rdoc-ref:IRB@Custom+Prompts] for more information.
     attr_accessor :prompt_c
 
     # TODO: Remove this when developing v2.0
@@ -394,8 +394,6 @@ module IRB
     # The default value is 16.
     #
     # Can also be set using the +--back-trace-limit+ command line option.
-    #
-    # See IRB@Command+line+options for more command line options.
     attr_accessor :back_trace_limit
 
     # User-defined IRB command aliases
@@ -463,7 +461,7 @@ module IRB
 
     # Sets the +mode+ of the prompt in this context.
     #
-    # See IRB@Customizing+the+IRB+Prompt for more information.
+    # See {Custom Prompts}[rdoc-ref:IRB@Custom+Prompts] for more information.
     def prompt_mode=(mode)
       @prompt_mode = mode
       pconf = IRB.conf[:PROMPT][mode]
@@ -501,8 +499,6 @@ module IRB
     #
     # Can also be set using the +--inspect+ and +--noinspect+ command line
     # options.
-    #
-    # See IRB@Command+line+options for more command line options.
     def inspect_mode=(opt)
 
       if i = Inspector::INSPECTORS[opt]
@@ -577,14 +573,6 @@ module IRB
       @inspect_method.inspect_value(@last_value)
     end
 
-    alias __exit__ exit
-    # 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:
     NO_INSPECTING_IVARS = ["@irb", "@io"] # :nodoc:
     IDNAME_IVARS = ["@prompt_mode"] # :nodoc:

data/lib/irb/extend-command.rb

@@ -16,15 +16,6 @@ module IRB # :nodoc:
     # See #install_alias_method.
     OVERRIDE_ALL = 0x02
 
-    # Quits the current irb context
-    #
-    # +ret+ is the optional signal or message to send to Context#exit
-    #
-    # Same as <code>IRB.CurrentContext.exit</code>.
-    def irb_exit(ret = 0)
-      irb_context.exit(ret)
-    end
-
     # Displays current configuration.
     #
     # Modifying the configuration is achieved by sending a message to IRB.conf.
@@ -35,13 +26,16 @@ module IRB # :nodoc:
     @ALIASES = [
       [:context, :irb_context, NO_OVERRIDE],
       [:conf, :irb_context, NO_OVERRIDE],
-      [:irb_quit, :irb_exit, OVERRIDE_PRIVATE_ONLY],
-      [:exit, :irb_exit, OVERRIDE_PRIVATE_ONLY],
-      [:quit, :irb_exit, OVERRIDE_PRIVATE_ONLY],
     ]
 
 
     @EXTEND_COMMANDS = [
+      [
+        :irb_exit, :Exit, "cmd/exit",
+        [:exit, OVERRIDE_PRIVATE_ONLY],
+        [:quit, OVERRIDE_PRIVATE_ONLY],
+        [:irb_quit, OVERRIDE_PRIVATE_ONLY],
+      ],
       [
         :irb_current_working_workspace, :CurrentWorkingWorkspace, "cmd/chws",
         [:cwws, NO_OVERRIDE],

data/lib/irb/help.rb

@@ -5,7 +5,7 @@
 #
 
 module IRB
-  # Outputs the irb help message, see IRB@Command+line+options.
+  # Outputs the irb help message, see IRB@Command-Line+Options.
   def IRB.print_usage
     lc = IRB.conf[:LC_MESSAGES]
     path = lc.find("irb/help-message")

data/lib/irb/init.rb

@@ -215,6 +215,7 @@ module IRB # :nodoc:
       added = [:TIME, IRB.conf[:MEASURE_PROC][:TIME], arg]
     end
     if added
+      IRB.conf[:MEASURE] = true
       found = IRB.conf[:MEASURE_CALLBACKS].find{ |m| m[0] == added[0] && m[2] == added[2] }
       if found
         # already added
@@ -235,6 +236,7 @@ module IRB # :nodoc:
       type_sym = type.upcase.to_sym
       IRB.conf[:MEASURE_CALLBACKS].reject!{ |t, | t == type_sym }
     end
+    IRB.conf[:MEASURE] = nil if IRB.conf[:MEASURE_CALLBACKS].empty?
   end
 
   def IRB.init_error
@@ -387,18 +389,16 @@ module IRB # :nodoc:
     $LOAD_PATH.unshift(*load_path)
   end
 
-  # running config
+  # Run the config file
   def IRB.run_config
     if @CONF[:RC]
       begin
-        load rc_file
-      rescue LoadError, Errno::ENOENT
-      rescue # StandardError, ScriptError
-        print "load error: #{rc_file}\n"
-        print $!.class, ": ", $!, "\n"
-        for err in $@[0, $@.size - 2]
-          print "\t", err, "\n"
-        end
+        file = rc_file
+        # Because rc_file always returns `HOME/.irbrc` even if no rc file is present, we can't warn users about missing rc files.
+        # Otherwise, it'd be very noisy.
+        load file if File.exist?(file)
+      rescue StandardError, ScriptError => e
+        warn "Error loading RC file '#{file}':\n#{e.full_message(highlight: false)}"
       end
     end
   end
@@ -416,7 +416,7 @@ module IRB # :nodoc:
     end
     case rc_file = @CONF[:RC_NAME_GENERATOR].call(ext)
     when String
-      return rc_file
+      rc_file
     else
       fail IllegalRCNameGenerator
     end

data/lib/irb/input-method.rb

@@ -291,11 +291,13 @@ module IRB
       @auto_indent_proc = block
     end
 
+    def retrieve_doc_namespace(matched)
+      preposing, _target, postposing, bind = @completion_params
+      @completor.doc_namespace(preposing, matched, postposing, bind: bind)
+    end
+
     def show_doc_dialog_proc
-      doc_namespace = ->(matched) {
-        preposing, _target, postposing, bind = @completion_params
-        @completor.doc_namespace(preposing, matched, postposing, bind: bind)
-      }
+      input_method = self # self is changed in the lambda below.
       ->() {
         dialog.trap_key = nil
         alt_d = [
@@ -311,7 +313,7 @@ module IRB
         cursor_pos_to_render, result, pointer, autocomplete_dialog = context.pop(4)
         return nil if result.nil? or pointer.nil? or pointer < 0
 
-        name = doc_namespace.call(result[pointer])
+        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)
 
@@ -419,8 +421,7 @@ module IRB
         return
       end
 
-      _target, preposing, postposing, bind = @completion_params
-      namespace = @completor.doc_namespace(preposing, matched, postposing, bind: bind)
+      namespace = retrieve_doc_namespace(matched)
       return unless namespace
 
       driver ||= RDoc::RI::Driver.new

data/lib/irb/source_finder.rb

@@ -16,10 +16,10 @@ module IRB
       @irb_context = irb_context
     end
 
-    def find_source(signature, s_count = nil)
+    def find_source(signature, super_level = 0)
       context_binding = @irb_context.workspace.binding
       case signature
-      when /\A[A-Z]\w*(::[A-Z]\w*)*\z/ # Const::Name
+      when /\A(::)?[A-Z]\w*(::[A-Z]\w*)*\z/ # Const::Name
         eval(signature, context_binding) # trigger autoload
         base = context_binding.receiver.yield_self { |r| r.is_a?(Module) ? r : Object }
         file, line = base.const_source_location(signature)
@@ -27,14 +27,15 @@ module IRB
         owner = eval(Regexp.last_match[:owner], context_binding)
         method = Regexp.last_match[:method]
         return unless owner.respond_to?(:instance_method)
-        file, line = method_target(owner, s_count, method, "owner")
+        file, line = method_target(owner, super_level, method, "owner")
       when /\A((?<receiver>.+)(\.|::))?(?<method>[^ :.]+)\z/ # method, receiver.method, receiver::method
         receiver = eval(Regexp.last_match[:receiver] || 'self', context_binding)
         method = Regexp.last_match[:method]
         return unless receiver.respond_to?(method, true)
-        file, line = method_target(receiver, s_count, method, "receiver")
+        file, line = method_target(receiver, super_level, method, "receiver")
       end
-      if file && line && File.exist?(file)
+      # If the line is zero, it means that the target's source is probably in a binary file, which we should ignore.
+      if file && line && !line.zero? && File.exist?(file)
         Source.new(file: file, first_line: line, last_line: find_end(file, line))
       end
     end
@@ -60,20 +61,14 @@ module IRB
       first_line
     end
 
-    def method_target(owner_receiver, s_count, method, type)
+    def method_target(owner_receiver, super_level, method, type)
       case type
       when "owner"
         target_method = owner_receiver.instance_method(method)
-        return target_method.source_location unless s_count
       when "receiver"
-        if s_count
-          target_method = owner_receiver.class.instance_method(method)
-        else
-          target_method = method
-          return owner_receiver.method(method).source_location
-        end
+        target_method = owner_receiver.method(method)
       end
-      s_count.times do |s|
+      super_level.times do |s|
         target_method = target_method.super_method if target_method
       end
       target_method.nil? ? nil : target_method.source_location

data/lib/irb/version.rb

@@ -5,7 +5,7 @@
 #
 
 module IRB # :nodoc:
-  VERSION = "1.10.1"
+  VERSION = "1.11.1"
   @RELEASE_VERSION = VERSION
-  @LAST_UPDATE_DATE = "2023-12-05"
+  @LAST_UPDATE_DATE = "2024-01-08"
 end

data/lib/irb/xmp.rb

@@ -44,8 +44,8 @@ class XMP
   # The top-level binding or, optional +bind+ parameter will be used when
   # creating the workspace. See WorkSpace.new for more information.
   #
-  # This uses the +:XMP+ prompt mode, see IRB@Customizing+the+IRB+Prompt for
-  # full detail.
+  # This uses the +:XMP+ prompt mode.
+  # See {Custom Prompts}[rdoc-ref:IRB@Custom+Prompts] for more information.
   def initialize(bind = nil)
     IRB.init_config(nil)