irb 1.13.2 → 1.14.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 243737997cdd6abe7e129eb7e7945dca379f1af38ed4254dfe094f2a611918cc
-  data.tar.gz: 5a1cbbdf5ab88a61278afe32a5497f38efa1342e123734ae3ede6135aae9b91f
+  metadata.gz: 7b71e88a4dbaabac4d4a40667f3bd763bd05dfda12832919e44072f04f85ceb4
+  data.tar.gz: 213f59cc1bc59c61ea2013e81a098d0cb1c95f9972233cb8886bb7b353884fe8
 SHA512:
-  metadata.gz: 0b4e5d658e1eba4a0503ffd3776c3baffabb0782eb43a993aac593b6dc4383e9e209ca3c1f077c78225f612a1ac7607f951bc11a2ff8fd78a93e12029fbf1954
-  data.tar.gz: c9e978f318f22d322934b77b8c431830e67a9cb7cf365923041f77123ee5e7d39ffa814a4e7bdd9af759f4671d0b24bd2ae68a9d20beb54b4a0e4248e32ee85f
+  metadata.gz: 2ed2dd4b075b7e54ca58bf206c9dca68163564f5bbdbd8bacb24479af62a2b0bbef9d612ae0af0075bda787e189c6020b953c1858e5faecfbab7e9e441d83952
+  data.tar.gz: 6a81b55c3f04253913c0c1adcc118d61c03cb0b7a5a64410bbfe5495b2fc6d08e0a451eb21302327454f73ef83ed54d74c23ef065139fedbd3a685b1c5562c63

data/Gemfile

@@ -7,7 +7,7 @@ is_truffleruby = RUBY_DESCRIPTION =~ /truffleruby/
 
 if is_unix && ENV['WITH_VTERM']
   gem "vterm", github: "ruby/vterm-gem"
-  gem "yamatanooroti", github: "ruby/yamatanooroti"
+  gem "yamatanooroti", github: "ruby/yamatanooroti", ref: "f6e47192100d6089f70cf64c1de540dcaadf005a"
 end
 
 gem "stackprof" if is_unix && !is_truffleruby

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`

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/cd.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module IRB
+  module Command
+    class CD < Base
+      category "Workspace"
+      description "Move into the given object or leave the current context."
+
+      help_message(<<~HELP)
+        Usage: cd ([target]|..)
+
+        IRB uses a stack of workspaces to keep track of context(s), with `pushws` and `popws` commands to manipulate the stack.
+        The `cd` command is an attempt to simplify the operation and will be subject to change.
+
+        When given:
+        - an object, cd will use that object as the new context by pushing it onto the workspace stack.
+        - "..", cd will leave the current context by popping the top workspace off the stack.
+        - no arguments, cd will move to the top workspace on the stack by popping off all workspaces.
+
+        Examples:
+
+          cd Foo
+          cd Foo.new
+          cd @ivar
+          cd ..
+          cd
+      HELP
+
+      def execute(arg)
+        case arg
+        when ".."
+          irb_context.pop_workspace
+        when ""
+          # TODO: decide what workspace commands should be kept, and underlying APIs should look like,
+          # and perhaps add a new API to clear the workspace stack.
+          prev_workspace = irb_context.pop_workspace
+          while prev_workspace
+            prev_workspace = irb_context.pop_workspace
+          end
+        else
+          begin
+            obj = eval(arg, irb_context.workspace.binding)
+            irb_context.push_workspace(obj)
+          rescue StandardError => e
+            warn "Error: #{e}"
+          end
+        end
+      end
+    end
+  end
+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/completion.rb

@@ -33,6 +33,8 @@ module IRB
       yield
     ]
 
+    HELP_COMMAND_PREPOSING = /\Ahelp\s+/
+
     def completion_candidates(preposing, target, postposing, bind:)
       raise NotImplementedError
     end
@@ -86,8 +88,8 @@ module IRB
         )
     end
 
-    def command_completions(preposing, target)
-      if preposing.empty? && !target.empty?
+    def command_candidates(target)
+      if !target.empty?
         IRB::Command.command_names.select { _1.start_with?(target) }
       else
         []
@@ -111,8 +113,18 @@ module IRB
     end
 
     def completion_candidates(preposing, target, _postposing, bind:)
-      commands = command_completions(preposing, target)
+      # When completing the argument of `help` command, only commands should be candidates
+      return command_candidates(target) if preposing.match?(HELP_COMMAND_PREPOSING)
+
+      commands = if preposing.empty?
+        command_candidates(target)
+      # It doesn't make sense to propose commands with other preposing
+      else
+        []
+      end
+
       result = ReplTypeCompletor.analyze(preposing + target, binding: bind, filename: @context.irb_path)
+
       return commands unless result
 
       commands | result.completion_candidates.map { target + _1 }
@@ -187,12 +199,20 @@ module IRB
     end
 
     def completion_candidates(preposing, target, postposing, bind:)
-      if preposing && postposing
-        result = complete_require_path(target, preposing, postposing)
-        return result if result
+      if result = complete_require_path(target, preposing, postposing)
+        return result
       end
-      commands = command_completions(preposing || '', target)
-      commands | retrieve_completion_data(target, bind: bind, doc_namespace: false).compact.map{ |i| i.encode(Encoding.default_external) }
+
+      commands = command_candidates(target)
+
+      # When completing the argument of `help` command, only commands should be candidates
+      return commands if preposing.match?(HELP_COMMAND_PREPOSING)
+
+      # It doesn't make sense to propose commands with other preposing
+      commands = [] unless preposing.empty?
+
+      completion_data = retrieve_completion_data(target, bind: bind, doc_namespace: false).compact.map{ |i| i.encode(Encoding.default_external) }
+      commands | completion_data
     end
 
     def doc_namespace(_preposing, matched, _postposing, bind:)
@@ -470,7 +490,7 @@ module IRB
       end
     end
     CompletionProc = ->(target, preposing = nil, postposing = nil) {
-      regexp_completor.completion_candidates(preposing, target, postposing, bind: IRB.conf[:MAIN_CONTEXT].workspace.binding)
+      regexp_completor.completion_candidates(preposing || '', target, postposing || '', bind: IRB.conf[:MAIN_CONTEXT].workspace.binding)
     }
   end
   deprecate_constant :InputCompletor

data/lib/irb/context.rb

@@ -13,6 +13,7 @@ module IRB
   # A class that wraps the current state of the irb session, including the
   # configuration of IRB.conf.
   class Context
+    ASSIGN_OPERATORS_REGEXP = Regexp.union(%w[= += -= *= /= %= **= &= |= &&= ||= ^= <<= >>=])
     # Creates a new IRB context.
     #
     # The optional +input_method+ argument:
@@ -148,8 +149,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 +157,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
@@ -602,7 +591,6 @@ module IRB
         set_last_value(result)
       when Statement::Command
         statement.command_class.execute(self, statement.arg)
-        set_last_value(nil)
       end
 
       nil
@@ -636,6 +624,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.instance_method(:public_method).bind_call(main, command) rescue false
+      private_method = !public_method && !!Kernel.instance_method(: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

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

@@ -5,6 +5,7 @@ require_relative "command/internal_helpers"
 require_relative "command/backtrace"
 require_relative "command/break"
 require_relative "command/catch"
+require_relative "command/cd"
 require_relative "command/chws"
 require_relative "command/context"
 require_relative "command/continue"
@@ -180,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]
     )
@@ -240,6 +247,8 @@ module IRB
     _register_with_aliases(:irb_disable_irb, Command::DisableIrb,
       [:disable_irb, NO_OVERRIDE]
     )
+
+    register(:cd, Command::CD)
   end
 
   ExtendCommand = Command
@@ -256,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
@@ -137,10 +139,11 @@ module IRB
           end
         rescue Interrupt
         ensure
-          print "\e[0m\e[?1049l"
           trap("SIGINT", prev_trap)
         end
       end
+    ensure
+      print "\e[0m\e[?1049l"
     end
   end
 end

data/lib/irb/input-method.rb

@@ -171,11 +171,13 @@ module IRB
   end
 
   class ReadlineInputMethod < StdioInputMethod
-    def self.initialize_readline
-      require "readline"
-    rescue LoadError
-    else
-      include ::Readline
+    class << self
+      def initialize_readline
+        require "readline"
+      rescue LoadError
+      else
+        include ::Readline
+      end
     end
 
     include HistorySavingAbility
@@ -263,18 +265,9 @@ module IRB
         @completion_params = [preposing, target, postposing, bind]
         @completor.completion_candidates(preposing, target, postposing, bind: bind)
       }
-      Reline.output_modifier_proc =
-        if IRB.conf[:USE_COLORIZE]
-          proc do |output, complete: |
-            next unless IRB::Color.colorable?
-            lvars = IRB.CurrentContext&.local_variables || []
-            IRB::Color.colorize_code(output, complete: complete, local_variables: lvars)
-          end
-        else
-          proc do |output|
-            Reline::Unicode.escape_for_print(output)
-          end
-        end
+      Reline.output_modifier_proc = proc do |input, complete:|
+        IRB.CurrentContext.colorize_input(input, complete: complete)
+      end
       Reline.dig_perfect_match_proc = ->(matched) { display_document(matched) }
       Reline.autocompletion = IRB.conf[:USE_AUTOCOMPLETE]
 

data/lib/irb/inspector.rb

@@ -6,7 +6,6 @@
 
 module IRB # :nodoc:
 
-
   # Convenience method to create a new Inspector, using the given +inspect+
   # proc, and optional +init+ proc and passes them to Inspector.new
   #
@@ -43,38 +42,40 @@ module IRB # :nodoc:
     # +:marshal+::  Using Marshal.dump
     INSPECTORS = {}
 
-    # Determines the inspector to use where +inspector+ is one of the keys passed
-    # during inspector definition.
-    def self.keys_with_inspector(inspector)
-      INSPECTORS.select{|k, v| v == inspector}.collect{|k, v| k}
-    end
-
-    # Example
-    #
-    #     Inspector.def_inspector(key, init_p=nil){|v| v.inspect}
-    #     Inspector.def_inspector([key1,..], init_p=nil){|v| v.inspect}
-    #     Inspector.def_inspector(key, inspector)
-    #     Inspector.def_inspector([key1,...], inspector)
-    def self.def_inspector(key, arg=nil, &block)
-      if block_given?
-        inspector = IRB::Inspector(block, arg)
-      else
-        inspector = arg
+    class << self
+      # Determines the inspector to use where +inspector+ is one of the keys passed
+      # during inspector definition.
+      def keys_with_inspector(inspector)
+        INSPECTORS.select{|k, v| v == inspector}.collect{|k, v| k}
       end
 
-      case key
-      when Array
-        for k in key
-          def_inspector(k, inspector)
+      # Example
+      #
+      #     Inspector.def_inspector(key, init_p=nil){|v| v.inspect}
+      #     Inspector.def_inspector([key1,..], init_p=nil){|v| v.inspect}
+      #     Inspector.def_inspector(key, inspector)
+      #     Inspector.def_inspector([key1,...], inspector)
+      def def_inspector(key, arg=nil, &block)
+        if block_given?
+          inspector = IRB::Inspector(block, arg)
+        else
+          inspector = arg
+        end
+
+        case key
+        when Array
+          for k in key
+            def_inspector(k, inspector)
+          end
+        when Symbol
+          INSPECTORS[key] = inspector
+          INSPECTORS[key.to_s] = inspector
+        when String
+          INSPECTORS[key] = inspector
+          INSPECTORS[key.intern] = inspector
+        else
+          INSPECTORS[key] = inspector
         end
-      when Symbol
-        INSPECTORS[key] = inspector
-        INSPECTORS[key.to_s] = inspector
-      when String
-        INSPECTORS[key] = inspector
-        INSPECTORS[key.intern] = inspector
-      else
-        INSPECTORS[key] = inspector
       end
     end