irb 1.14.0 → 1.14.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b96add3ef12d981b483ae225bfd8bca8a1a477f0b03c8040a0dfbf047bd0d1fb
-  data.tar.gz: efe91e97fab6b11a239c4774da9d5ecfe39bbc364d61a6b2c7fd6ec8b9c01a72
+  metadata.gz: 606da5c01c0630f572812c844da8f331fd487fa50060db8c95a61aef14660d68
+  data.tar.gz: 5d1749fea9672c734b9bdce740f6f43d90b2479e2a06de09d9604265317fab1e
 SHA512:
-  metadata.gz: 0eaa119e765d958cdab2ba80fa12e47a9727d389a37f255e174ec260279af8e2c2edb510689364541fe40f3c202a3b3d4f2d7dc7fbe30030b04e89bc2c851a3a
-  data.tar.gz: 71904280b978ac48763d7bc965f053fd5580ec7876c40cba76a1a9c26ac7aec2f4ad98deb1d9c8d3635f5222a0b757d458d7fded9264411b05f19bfe77ad2526
+  metadata.gz: 478ceef6ddf60e4bf8ddf2f1586129eab9bcff9e40bb9af8662a1c7f46d7c406f7d896395d3459cbde5ac2a427b73e474327033647e6c742691c185a553a1d71
+  data.tar.gz: da1f92f1403c9fee631f7fc85f1bf60120db710bd171a98be1b428a22c4545fed4d4e4dd7692d90220520609047bd4fc6d00882da0bce7bf1a67e05dc41dd8e1

data/README.md

@@ -114,6 +114,7 @@ Help
   help           List all available commands. Use `help <command>` to get information about a specific command.
 
 IRB
+  context        Displays current configuration.
   exit           Exit the current irb session.
   exit!          Exit the current process.
   irb_load       Load a Ruby file.
@@ -121,6 +122,7 @@ IRB
   source         Loads a given file in the current session.
   irb_info       Show information about IRB.
   history        Shows the input history. `-g [query]` or `-G [query]` allows you to filter the output.
+  disable_irb    Disable binding.irb.
 
 Workspace
   cwws           Show the current workspace.
@@ -128,6 +130,7 @@ Workspace
   workspaces     Show workspaces.
   pushws         Push an object to the workspace stack.
   popws          Pop a workspace from the workspace stack.
+  cd             Move into the given object or leave the current context.
 
 Multi-irb (DEPRECATED)
   irb            Start a child IRB.
@@ -152,11 +155,14 @@ Misc
   measure        `measure` enables the mode to measure processing time. `measure :off` disables it.
 
 Context
-  show_doc       Enter the mode to look up RI documents.
+  show_doc       Look up documentation with RI.
   ls             Show methods, constants, and variables.
-  show_source    Show the source code of a given method or constant.
+  show_source    Show the source code of a given method, class/module, or constant.
   whereami       Show the source code around binding.irb again.
 
+Helper methods
+  conf           Returns the current IRB context.
+
 Aliases
   $              Alias for `show_source`
   @              Alias for `whereami`
@@ -164,6 +170,13 @@ Aliases
 
 ## Debugging with IRB
 
+### Getting Started
+
+- In `binding.irb`, use the `debug` command to start a `irb:rdbg` session with access to all `debug.gem` commands.
+- Use `RUBY_DEBUG_IRB_CONSOLE=1` environment variable to make `debug.gem` use IRB as the debugging console.
+
+### Details
+
 Starting from version 1.8.0, IRB boasts a powerful integration with `debug.gem`, providing a debugging experience akin to `pry-byebug`.
 
 After hitting a `binding.irb` breakpoint, you can activate the debugger with the `debug` command. Alternatively, if the `debug` method happens to already be defined in the current scope, you can call `irb_debug`.
@@ -348,6 +361,10 @@ irb(main):002> a.first. # Completes Integer methods
 - `VISUAL`: Its value would be used to open files by the `edit` command.
 - `EDITOR`: Its value would be used to open files by the `edit` command if `VISUAL` is unset.
 - `IRBRC`: The file specified would be evaluated as IRB's rc-file.
+- `XDG_CONFIG_HOME`: If it is set and `IRBRC` is unset, the file `$XDG_CONFIG_HOME/irb/irbrc` would be evaluated as IRB's rc-file.
+- `RI_PAGER`: The command specified would be used as a pager.
+- `PAGER`: The command specified would be used as a pager if `RI_PAGER` is unset.
+- `IRB_LANG`, `LC_MESSAGES`, `LC_ALL`, `LANG`: The first of these that is set would be used as the locale value.
 
 ## Documentation
 

data/lib/irb/command/base.rb

@@ -10,8 +10,10 @@ module IRB
   module Command
     class CommandArgumentError < StandardError; end
 
-    def self.extract_ruby_args(*args, **kwargs)
-      throw :EXTRACT_RUBY_ARGS, [args, kwargs]
+    class << self
+      def extract_ruby_args(*args, **kwargs)
+        throw :EXTRACT_RUBY_ARGS, [args, kwargs]
+      end
     end
 
     class Base
@@ -31,6 +33,12 @@ module IRB
           @help_message
         end
 
+        def execute(irb_context, arg)
+          new(irb_context).execute(arg)
+        rescue CommandArgumentError => e
+          puts e.message
+        end
+
         private
 
         def highlight(text)
@@ -38,12 +46,6 @@ module IRB
         end
       end
 
-      def self.execute(irb_context, arg)
-        new(irb_context).execute(arg)
-      rescue CommandArgumentError => e
-        puts e.message
-      end
-
       def initialize(irb_context)
         @irb_context = irb_context
       end

data/lib/irb/command/debug.rb

@@ -58,13 +58,15 @@ module IRB
     end
 
     class DebugCommand < Debug
-      def self.category
-        "Debugging"
-      end
+      class << self
+        def category
+          "Debugging"
+        end
 
-      def self.description
-        command_name = self.name.split("::").last.downcase
-        "Start the debugger of debug.gem and run its `#{command_name}` command."
+        def description
+          command_name = self.name.split("::").last.downcase
+          "Start the debugger of debug.gem and run its `#{command_name}` command."
+        end
       end
     end
   end

data/lib/irb/command/help.rb

@@ -39,7 +39,7 @@ module IRB
 
         help_cmds = commands_grouped_by_categories.delete("Help")
         no_category_cmds = commands_grouped_by_categories.delete("No category")
-        aliases = irb_context.instance_variable_get(:@user_aliases).map do |alias_name, target|
+        aliases = irb_context.instance_variable_get(:@command_aliases).map do |alias_name, target|
           { display_name: alias_name, description: "Alias for `#{target}`" }
         end
 

data/lib/irb/command/internal_helpers.rb

@@ -19,7 +19,7 @@ module IRB
         # Use throw and catch to handle arg that includes `;`
         # For example: "1, kw: (2; 3); 4" will be parsed to [[1], { kw: 3 }]
         catch(:EXTRACT_RUBY_ARGS) do
-          @irb_context.workspace.binding.eval "IRB::Command.extract_ruby_args #{arg}"
+          @irb_context.workspace.binding.eval "::IRB::Command.extract_ruby_args #{arg}"
         end || [[], {}]
       end
     end

data/lib/irb/command/ls.rb

@@ -11,7 +11,7 @@ module IRB
 
   module Command
     class Ls < Base
-      include RubyArgsExtractor
+      class EvaluationError < StandardError; end
 
       category "Context"
       description "Show methods, constants, and variables."
@@ -22,24 +22,35 @@ module IRB
           -g [query]  Filter the output with a query.
       HELP_MESSAGE
 
+      def evaluate(code)
+        @irb_context.workspace.binding.eval(code)
+      rescue Exception => e
+        puts "#{e.class}: #{e.message}"
+        raise EvaluationError
+      end
+
       def execute(arg)
         if match = arg.match(/\A(?<target>.+\s|)(-g|-G)\s+(?<grep>.+)$/)
-          if match[:target].empty?
-            use_main = true
-          else
-            obj = @irb_context.workspace.binding.eval(match[:target])
-          end
+          target = match[:target]
           grep = Regexp.new(match[:grep])
+        elsif match = arg.match(/\A((?<target>.+),|)\s*grep:(?<grep>.+)/)
+          # Legacy style `ls obj, grep: /regexp/`
+          # Evaluation order should be eval(target) then eval(grep)
+          target = match[:target] || ''
+          grep_regexp_code = match[:grep]
         else
-          args, kwargs = ruby_args(arg)
-          use_main = args.empty?
-          obj = args.first
-          grep = kwargs[:grep]
+          target = arg.strip
         end
 
-        if use_main
+        if target.empty?
           obj = irb_context.workspace.main
           locals = irb_context.workspace.binding.local_variables
+        else
+          obj = evaluate(target)
+        end
+
+        if grep_regexp_code
+          grep = evaluate(grep_regexp_code)
         end
 
         o = Output.new(grep: grep)
@@ -52,6 +63,7 @@ module IRB
         o.dump("class variables", klass.class_variables)
         o.dump("locals", locals) if locals
         o.print_result
+      rescue EvaluationError
       end
 
       def dump_methods(o, klass, obj)

data/lib/irb/completion.rb

@@ -137,26 +137,33 @@ module IRB
   end
 
   class RegexpCompletor < BaseCompletor # :nodoc:
+    KERNEL_METHODS = ::Kernel.instance_method(:methods)
+    KERNEL_PRIVATE_METHODS = ::Kernel.instance_method(:private_methods)
+    KERNEL_INSTANCE_VARIABLES = ::Kernel.instance_method(:instance_variables)
+    OBJECT_CLASS_INSTANCE_METHOD = ::Object.instance_method(:class)
+    MODULE_CONSTANTS_INSTANCE_METHOD = ::Module.instance_method(:constants)
+
     using Module.new {
       refine ::Binding do
         def eval_methods
-          ::Kernel.instance_method(:methods).bind(eval("self")).call
+          KERNEL_METHODS.bind_call(receiver)
         end
 
         def eval_private_methods
-          ::Kernel.instance_method(:private_methods).bind(eval("self")).call
+          KERNEL_PRIVATE_METHODS.bind_call(receiver)
         end
 
         def eval_instance_variables
-          ::Kernel.instance_method(:instance_variables).bind(eval("self")).call
+          KERNEL_INSTANCE_VARIABLES.bind_call(receiver)
         end
 
         def eval_global_variables
-          ::Kernel.instance_method(:global_variables).bind(eval("self")).call
+          ::Kernel.global_variables
         end
 
         def eval_class_constants
-          ::Module.instance_method(:constants).bind(eval("self.class")).call
+          klass = OBJECT_CLASS_INSTANCE_METHOD.bind_call(receiver)
+          MODULE_CONSTANTS_INSTANCE_METHOD.bind_call(klass)
         end
       end
     }

data/lib/irb/context.rb

@@ -13,6 +13,10 @@ module IRB
   # A class that wraps the current state of the irb session, including the
   # configuration of IRB.conf.
   class Context
+    KERNEL_PUBLIC_METHOD = ::Kernel.instance_method(:public_method)
+    KERNEL_METHOD = ::Kernel.instance_method(:method)
+
+    ASSIGN_OPERATORS_REGEXP = Regexp.union(%w[= += -= *= /= %= **= &= |= &&= ||= ^= <<= >>=])
     # Creates a new IRB context.
     #
     # The optional +input_method+ argument:
@@ -148,8 +152,7 @@ module IRB
         @newline_before_multiline_output = true
       end
 
-      @user_aliases = IRB.conf[:COMMAND_ALIASES].dup
-      @command_aliases = @user_aliases.merge(KEYWORD_ALIASES)
+      @command_aliases = IRB.conf[:COMMAND_ALIASES].dup
     end
 
     private def term_interactive?
@@ -157,17 +160,6 @@ module IRB
       STDIN.tty? && ENV['TERM'] != 'dumb'
     end
 
-    # because all input will eventually be evaluated as Ruby code,
-    # command names that conflict with Ruby keywords need special workaround
-    # we can remove them once we implemented a better command system for IRB
-    KEYWORD_ALIASES = {
-      :break => :irb_break,
-      :catch => :irb_catch,
-      :next => :irb_next,
-    }.freeze
-
-    private_constant :KEYWORD_ALIASES
-
     def use_tracer=(val)
       require_relative "ext/tracer" if val
       IRB.conf[:USE_TRACER] = val
@@ -187,11 +179,17 @@ module IRB
 
     private def build_completor
       completor_type = IRB.conf[:COMPLETOR]
+
+      # Gem repl_type_completor is added to bundled gems in Ruby 3.4.
+      # Use :type as default completor only in Ruby 3.4 or later.
+      verbose = !!completor_type
+      completor_type ||= RUBY_VERSION >= '3.4' ? :type : :regexp
+
       case completor_type
       when :regexp
         return RegexpCompletor.new
       when :type
-        completor = build_type_completor
+        completor = build_type_completor(verbose: verbose)
         return completor if completor
       else
         warn "Invalid value for IRB.conf[:COMPLETOR]: #{completor_type}"
@@ -200,17 +198,17 @@ module IRB
       RegexpCompletor.new
     end
 
-    private def build_type_completor
+    private def build_type_completor(verbose:)
       if RUBY_ENGINE == 'truffleruby'
         # Avoid SyntaxError. truffleruby does not support endless method definition yet.
-        warn 'TypeCompletor is not supported on TruffleRuby yet'
+        warn 'TypeCompletor is not supported on TruffleRuby yet' if verbose
         return
       end
 
       begin
         require 'repl_type_completor'
       rescue LoadError => e
-        warn "TypeCompletor requires `gem repl_type_completor`: #{e.message}"
+        warn "TypeCompletor requires `gem repl_type_completor`: #{e.message}" if verbose
         return
       end
 
@@ -635,6 +633,46 @@ module IRB
       result
     end
 
+    def parse_command(code)
+      command_name, arg = code.strip.split(/\s+/, 2)
+      return unless code.lines.size == 1 && command_name
+
+      arg ||= ''
+      command = command_name.to_sym
+      # Command aliases are always command. example: $, @
+      if (alias_name = command_aliases[command])
+        return [alias_name, arg]
+      end
+
+      # Assignment-like expression is not a command
+      return if arg.start_with?(ASSIGN_OPERATORS_REGEXP) && !arg.start_with?(/==|=~/)
+
+      # Local variable have precedence over command
+      return if local_variables.include?(command)
+
+      # Check visibility
+      public_method = !!KERNEL_PUBLIC_METHOD.bind_call(main, command) rescue false
+      private_method = !public_method && !!KERNEL_METHOD.bind_call(main, command) rescue false
+      if Command.execute_as_command?(command, public_method: public_method, private_method: private_method)
+        [command, arg]
+      end
+    end
+
+    def colorize_input(input, complete:)
+      if IRB.conf[:USE_COLORIZE] && IRB::Color.colorable?
+        lvars = local_variables || []
+        if parse_command(input)
+          name, sep, arg = input.split(/(\s+)/, 2)
+          arg = IRB::Color.colorize_code(arg, complete: complete, local_variables: lvars)
+          "#{IRB::Color.colorize(name, [:BOLD])}\e[m#{sep}#{arg}"
+        else
+          IRB::Color.colorize_code(input, complete: complete, local_variables: lvars)
+        end
+      else
+        Reline::Unicode.escape_for_print(input)
+      end
+    end
+
     def inspect_last_value # :nodoc:
       @inspect_method.inspect_value(@last_value)
     end
@@ -669,5 +707,10 @@ module IRB
     def local_variables # :nodoc:
       workspace.binding.local_variables
     end
+
+    def safe_method_call_on_main(method_name)
+      main_object = main
+      Object === main_object ? main_object.__send__(method_name) : Object.instance_method(method_name).bind_call(main_object)
+    end
   end
 end

data/lib/irb/debug/ui.rb

@@ -45,9 +45,7 @@ module IRB
             $stdout.puts line.chomp
           }
         when String
-          str.each_line{|line|
-            $stdout.puts line.chomp
-          }
+          Pager.page_content(str, retain_content: true)
         when nil
           $stdout.puts
         end
@@ -56,7 +54,7 @@ module IRB
       def readline _
         setup_interrupt do
           tc = DEBUGGER__::SESSION.instance_variable_get(:@tc)
-          cmd = @irb.debug_readline(tc.current_frame.binding || TOPLEVEL_BINDING)
+          cmd = @irb.debug_readline(tc.current_frame.eval_binding || TOPLEVEL_BINDING)
 
           case cmd
           when nil # when user types C-d

data/lib/irb/debug.rb

@@ -57,22 +57,18 @@ module IRB
           DEBUGGER__::ThreadClient.prepend(SkipPathHelperForIRB)
         end
 
-        if !@output_modifier_defined && !DEBUGGER__::CONFIG[:no_hint]
-          irb_output_modifier_proc = Reline.output_modifier_proc
-
-          Reline.output_modifier_proc = proc do |output, complete:|
-            unless output.strip.empty?
-              cmd = output.split(/\s/, 2).first
+        if !DEBUGGER__::CONFIG[:no_hint] && irb.context.io.is_a?(RelineInputMethod)
+          Reline.output_modifier_proc = proc do |input, complete:|
+            unless input.strip.empty?
+              cmd = input.split(/\s/, 2).first
 
               if !complete && DEBUGGER__.commands.key?(cmd)
-                output = output.sub(/\n$/, " # debug command\n")
+                input = input.sub(/\n$/, " # debug command\n")
               end
             end
 
-            irb_output_modifier_proc.call(output, complete: complete)
+            irb.context.colorize_input(input, complete: complete)
           end
-
-          @output_modifier_defined = true
         end
 
         true

data/lib/irb/default_commands.rb

@@ -181,9 +181,15 @@ module IRB
       [:edit, NO_OVERRIDE]
     )
 
-    _register_with_aliases(:irb_break, Command::Break)
-    _register_with_aliases(:irb_catch, Command::Catch)
-    _register_with_aliases(:irb_next, Command::Next)
+    _register_with_aliases(:irb_break, Command::Break,
+      [:break, OVERRIDE_ALL]
+    )
+    _register_with_aliases(:irb_catch, Command::Catch,
+      [:catch, OVERRIDE_PRIVATE_ONLY]
+    )
+    _register_with_aliases(:irb_next, Command::Next,
+      [:next, OVERRIDE_ALL]
+    )
     _register_with_aliases(:irb_delete, Command::Delete,
       [:delete, NO_OVERRIDE]
     )
@@ -259,10 +265,12 @@ module IRB
     # Deprecated. Doesn't have any effect.
     @EXTEND_COMMANDS = []
 
-    # Drepcated. Use Command.regiser instead.
-    def self.def_extend_command(cmd_name, cmd_class, _, *aliases)
-      Command._register_with_aliases(cmd_name, cmd_class, *aliases)
-      Command.class_variable_set(:@@command_override_policies, nil)
+    class << self
+      # Drepcated. Use Command.regiser instead.
+      def def_extend_command(cmd_name, cmd_class, _, *aliases)
+        Command._register_with_aliases(cmd_name, cmd_class, *aliases)
+        Command.class_variable_set(:@@command_override_policies, nil)
+      end
     end
   end
 end

data/lib/irb/easter-egg.rb

@@ -100,19 +100,21 @@ module IRB
 
     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..]
+        .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)
+      print "\e[?1049h"
       type ||= [:logo, :dancing].sample
       case type
       when :logo
-        require "rdoc"
-        RDoc::RI::Driver.new.page do |io|
-          io.write easter_egg_logo(:large)
+        Pager.page do |io|
+          logo_type = STDOUT.external_encoding == Encoding::UTF_8 ? :unicode_large : :ascii_large
+          io.write easter_egg_logo(logo_type)
+          STDIN.raw { STDIN.getc } if io == STDOUT
         end
       when :dancing
         STDOUT.cooked do
@@ -123,7 +125,7 @@ module IRB
             canvas = Canvas.new(Reline.get_screen_size)
           end
           ruby_model = RubyModel.new
-          print "\e[?1049h"
+          print "\e[?25l" # hide cursor
           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|
@@ -137,10 +139,12 @@ module IRB
           end
         rescue Interrupt
         ensure
-          print "\e[0m\e[?1049l"
+          print "\e[?25h" # show cursor
           trap("SIGINT", prev_trap)
         end
       end
+    ensure
+      print "\e[0m\e[?1049l"
     end
   end
 end