irb 1.11.2 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 53ffdc8550a2c9debc40dc6565f23010c02959bf924fc917a6736465960dc660
-  data.tar.gz: ca6f06898a6b431303c5b63b9f8ff88295106ad66d8cb30e85a6f5f879449c8e
+  metadata.gz: 4ef257bd1b4917c3af8f4e1c372cb7c489cd16844df518e352c0bff74c77b4fc
+  data.tar.gz: e9cd328330de9c415b93f680228ff79c3a798c481fe657bc48f7d7305470462c
 SHA512:
-  metadata.gz: '059eb872f0be29fec2c8fe7c64b809f9346b3e25b084a1033ab4ea6e02e7c3e311317d2a169a18d5a9291acc578e56c1587c12f901d2e09fa52d58fe3717377c'
-  data.tar.gz: 8b6cce5c6bc85f25db7a78977e433746efa47d2eb0b0828d9adebb813ce0648396aae6e0c903aca30b79f2c1e947f319e75b21e916eb6f8a8a8f8d5553431d5c
+  metadata.gz: 78b5b33588812cda49274b45e7b905cec8cb9e6b0ed71be66a644680db5ac96a19e276952425ec54a05d2ce3e8cf99b69eb7964e310770e155ced4f51501b088
+  data.tar.gz: 68ae7b61704a3356a14d526bdf058306c9ef158d8442030779b9256a59bee2929e1bab1fdf394f39bda09479b47430ca1de94c57c7b23017affec1400975e03a

data/README.md

@@ -30,7 +30,7 @@ The `irb` command from your shell will start the interpreter.
 
 ## Installation
 
-> **Note**
+> [!Note]
 >
 > IRB is a default gem of Ruby so you shouldn't need to install it separately.
 >
@@ -56,7 +56,7 @@ $ gem install irb
 
 ## Usage
 
-> **Note**
+> [!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).
 
@@ -107,16 +107,19 @@ Hello World
 
 ## Commands
 
-The following commands are available on IRB. You can get the same output from the `show_cmds` command.
+The following commands are available on IRB. You can get the same output from the `help` command.
 
 ```txt
+Help
+  help           List all available commands. Use `help <command>` to get information about a specific command.
+
 IRB
   exit           Exit the current irb session.
+  exit!          Exit the current process.
   irb_load       Load a Ruby file.
   irb_require    Require a Ruby file.
   source         Loads a given file in the current session.
   irb_info       Show information about 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
@@ -145,13 +148,12 @@ Debugging
   info           Start the debugger of debug.gem and run its `info` command.
 
 Misc
-  edit           Open a file with the editor command defined with `ENV["VISUAL"]` or `ENV["EDITOR"]`.
+  edit           Open a file or source location.
   measure        `measure` enables the mode to measure processing time. `measure :off` disables it.
 
 Context
-  help           [DEPRECATED] Enter the mode to look up RI documents.
   show_doc       Enter the mode to look up RI documents.
-  ls             Show methods, constants, and variables. `-g [query]` or `-G [query]` allows you to filter out the output.
+  ls             Show methods, constants, and variables.
   show_source    Show the source code of a given method or constant.
   whereami       Show the source code around binding.irb again.
 
@@ -227,7 +229,7 @@ end
 
 To learn about these features, please refer to `debug.gem`'s [commands list](https://github.com/ruby/debug#debug-command-on-the-debug-console).
 
-In the `irb:rdbg` session, the `show_cmds` command will also display all commands from `debug.gem`.
+In the `irb:rdbg` session, the `help` command will also display all commands from `debug.gem`.
 
 ### Advantages Over `debug.gem`'s Console
 

data/lib/irb/cmd/nop.rb

@@ -1,53 +1,4 @@
-# frozen_string_literal: false
-#
-#   nop.rb -
-#   	by Keiju ISHITSUKA(keiju@ruby-lang.org)
-#
+# frozen_string_literal: true
 
-module IRB
-  # :stopdoc:
-
-  module ExtendCommand
-    class CommandArgumentError < StandardError; end
-
-    class Nop
-      class << self
-        def category(category = nil)
-          @category = category if category
-          @category
-        end
-
-        def description(description = nil)
-          @description = description if description
-          @description
-        end
-
-        private
-
-        def string_literal?(args)
-          sexp = Ripper.sexp(args)
-          sexp && sexp.size == 2 && sexp.last&.first&.first == :string_literal
-        end
-      end
-
-      def self.execute(irb_context, *opts, **kwargs, &block)
-        command = new(irb_context)
-        command.execute(*opts, **kwargs, &block)
-      rescue CommandArgumentError => e
-        puts e.message
-      end
-
-      def initialize(irb_context)
-        @irb_context = irb_context
-      end
-
-      attr_reader :irb_context
-
-      def execute(*opts)
-        #nop
-      end
-    end
-  end
-
-  # :startdoc:
-end
+# This file is just a placeholder for backward-compatibility.
+# Please require 'irb' and inheirt your command from `IRB::Command::Base` instead.

data/lib/irb/{cmd → command}/backtrace.rb

@@ -5,7 +5,7 @@ require_relative "debug"
 module IRB
   # :stopdoc:
 
-  module ExtendCommand
+  module Command
     class Backtrace < DebugCommand
       def self.transform_args(args)
         args&.dump

data/lib/irb/command/base.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+#
+#   nop.rb -
+#   	by Keiju ISHITSUKA(keiju@ruby-lang.org)
+#
+
+module IRB
+  # :stopdoc:
+
+  module Command
+    class CommandArgumentError < StandardError; end
+
+    class Base
+      class << self
+        def category(category = nil)
+          @category = category if category
+          @category
+        end
+
+        def description(description = nil)
+          @description = description if description
+          @description
+        end
+
+        def help_message(help_message = nil)
+          @help_message = help_message if help_message
+          @help_message
+        end
+
+        private
+
+        def string_literal?(args)
+          sexp = Ripper.sexp(args)
+          sexp && sexp.size == 2 && sexp.last&.first&.first == :string_literal
+        end
+
+        def highlight(text)
+          Color.colorize(text, [:BOLD, :BLUE])
+        end
+      end
+
+      def self.execute(irb_context, *opts, **kwargs, &block)
+        command = new(irb_context)
+        command.execute(*opts, **kwargs, &block)
+      rescue CommandArgumentError => e
+        puts e.message
+      end
+
+      def initialize(irb_context)
+        @irb_context = irb_context
+      end
+
+      attr_reader :irb_context
+
+      def execute(*opts)
+        #nop
+      end
+    end
+
+    Nop = Base
+  end
+
+  # :startdoc:
+end

data/lib/irb/{cmd → command}/break.rb

@@ -5,7 +5,7 @@ require_relative "debug"
 module IRB
   # :stopdoc:
 
-  module ExtendCommand
+  module Command
     class Break < DebugCommand
       def self.transform_args(args)
         args&.dump

data/lib/irb/{cmd → command}/catch.rb

@@ -5,7 +5,7 @@ require_relative "debug"
 module IRB
   # :stopdoc:
 
-  module ExtendCommand
+  module Command
     class Catch < DebugCommand
       def self.transform_args(args)
         args&.dump

data/lib/irb/{cmd → command}/chws.rb

@@ -1,18 +1,16 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 #
 #   change-ws.rb -
 #   	by Keiju ISHITSUKA(keiju@ruby-lang.org)
 #
-
-require_relative "nop"
 require_relative "../ext/change-ws"
 
 module IRB
   # :stopdoc:
 
-  module ExtendCommand
+  module Command
 
-    class CurrentWorkingWorkspace < Nop
+    class CurrentWorkingWorkspace < Base
       category "Workspace"
       description "Show the current workspace."
 
@@ -21,7 +19,7 @@ module IRB
       end
     end
 
-    class ChangeWorkspace < Nop
+    class ChangeWorkspace < Base
       category "Workspace"
       description "Change the current workspace to an object."
 

data/lib/irb/{cmd → command}/continue.rb

@@ -5,7 +5,7 @@ require_relative "debug"
 module IRB
   # :stopdoc:
 
-  module ExtendCommand
+  module Command
     class Continue < DebugCommand
       def execute(*args)
         super(do_cmds: ["continue", *args].join(" "))

data/lib/irb/{cmd → command}/debug.rb

@@ -1,18 +1,17 @@
-require_relative "nop"
 require_relative "../debug"
 
 module IRB
   # :stopdoc:
 
-  module ExtendCommand
-    class Debug < Nop
+  module Command
+    class Debug < Base
       category "Debugging"
       description "Start the debugger of debug.gem."
 
       BINDING_IRB_FRAME_REGEXPS = [
         '<internal:prelude>',
         binding.method(:irb).source_location.first,
-      ].map { |file| /\A#{Regexp.escape(file)}:\d+:in `irb'\z/ }
+      ].map { |file| /\A#{Regexp.escape(file)}:\d+:in (`|'Binding#)irb'\z/ }
 
       def execute(pre_cmds: nil, do_cmds: nil)
         if irb_context.with_debugger

data/lib/irb/{cmd → command}/delete.rb

@@ -5,7 +5,7 @@ require_relative "debug"
 module IRB
   # :stopdoc:
 
-  module ExtendCommand
+  module Command
     class Delete < DebugCommand
       def execute(*args)
         super(pre_cmds: ["delete", *args].join(" "))

data/lib/irb/command/edit.rb

@@ -0,0 +1,70 @@
+require 'shellwords'
+
+require_relative "../source_finder"
+
+module IRB
+  # :stopdoc:
+
+  module Command
+    class Edit < Base
+      category "Misc"
+      description 'Open a file or source location.'
+      help_message <<~HELP_MESSAGE
+        Usage: edit [FILE or constant or method signature]
+
+        Open a file in the editor specified in #{highlight('ENV["VISUAL"]')} or #{highlight('ENV["EDITOR"]')}
+
+        - If no arguments are provided, IRB will attempt to open the file the current context was defined in.
+        - If FILE is provided, IRB will open the file.
+        - If a constant or method signature is provided, IRB will attempt to locate the source file and open it.
+
+        Examples:
+
+          edit
+          edit foo.rb
+          edit Foo
+          edit Foo#bar
+      HELP_MESSAGE
+
+      class << self
+        def transform_args(args)
+          # Return a string literal as is for backward compatibility
+          if args.nil? || args.empty? || string_literal?(args)
+            args
+          else # Otherwise, consider the input as a String for convenience
+            args.strip.dump
+          end
+        end
+      end
+
+      def execute(*args)
+        path = args.first
+
+        if path.nil?
+          path = @irb_context.irb_path
+        elsif !File.exist?(path)
+          source = SourceFinder.new(@irb_context).find_source(path)
+
+          if source&.file_exist? && !source.binary_file?
+            path = source.file
+          end
+        end
+
+        unless File.exist?(path)
+          puts "Can not find file: #{path}"
+          return
+        end
+
+        if editor = (ENV['VISUAL'] || ENV['EDITOR'])
+          puts "command: '#{editor}'"
+          puts "   path: #{path}"
+          system(*Shellwords.split(editor), path)
+        else
+          puts "Can not find editor setting: ENV['VISUAL'] or ENV['EDITOR']"
+        end
+      end
+    end
+  end
+
+  # :startdoc:
+end

data/lib/irb/{cmd → command}/exit.rb

@@ -1,12 +1,10 @@
 # frozen_string_literal: true
 
-require_relative "nop"
-
 module IRB
   # :stopdoc:
 
-  module ExtendCommand
-    class Exit < Nop
+  module Command
+    class Exit < Base
       category "IRB"
       description "Exit the current irb session."
 

data/lib/irb/{cmd → command}/finish.rb

@@ -5,7 +5,7 @@ require_relative "debug"
 module IRB
   # :stopdoc:
 
-  module ExtendCommand
+  module Command
     class Finish < DebugCommand
       def execute(*args)
         super(do_cmds: ["finish", *args].join(" "))

data/lib/irb/command/force_exit.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module IRB
+  # :stopdoc:
+
+  module Command
+    class ForceExit < Base
+      category "IRB"
+      description "Exit the current process."
+
+      def execute(*)
+        throw :IRB_EXIT, true
+      rescue UncaughtThrowError
+        Kernel.exit!
+      end
+    end
+  end
+
+  # :startdoc:
+end

data/lib/irb/command/help.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module IRB
+  module Command
+    class Help < Base
+      category "Help"
+      description "List all available commands. Use `help <command>` to get information about a specific command."
+
+      class << self
+        def transform_args(args)
+          # Return a string literal as is for backward compatibility
+          if args.empty? || string_literal?(args)
+            args
+          else # Otherwise, consider the input as a String for convenience
+            args.strip.dump
+          end
+        end
+      end
+
+      def execute(command_name = nil)
+        content =
+          if command_name
+            if command_class = ExtendCommandBundle.load_command(command_name)
+              command_class.help_message || command_class.description
+            else
+              "Can't find command `#{command_name}`. Please check the command name and try again.\n\n"
+            end
+          else
+            help_message
+          end
+        Pager.page_content(content)
+      end
+
+      private
+
+      def help_message
+        commands_info = IRB::ExtendCommandBundle.all_commands_info
+        commands_grouped_by_categories = commands_info.group_by { |cmd| cmd[:category] }
+
+        user_aliases = irb_context.instance_variable_get(:@user_aliases)
+
+        commands_grouped_by_categories["Aliases"] = user_aliases.map do |alias_name, target|
+          { display_name: alias_name, description: "Alias for `#{target}`" }
+        end
+
+        if irb_context.with_debugger
+          # Remove the original "Debugging" category
+          commands_grouped_by_categories.delete("Debugging")
+          # Add an empty "Debugging (from debug.gem)" category at the end
+          commands_grouped_by_categories["Debugging (from debug.gem)"] = []
+        end
+
+        longest_cmd_name_length = commands_info.map { |c| c[:display_name].length }.max
+
+        output = StringIO.new
+
+        help_cmds = commands_grouped_by_categories.delete("Help")
+
+        add_category_to_output("Help", help_cmds, output, longest_cmd_name_length)
+
+        commands_grouped_by_categories.each do |category, cmds|
+          add_category_to_output(category, cmds, output, longest_cmd_name_length)
+        end
+
+        # Append the debugger help at the end
+        if irb_context.with_debugger
+          output.puts DEBUGGER__.help
+        end
+
+        output.string
+      end
+
+      def add_category_to_output(category, cmds, output, longest_cmd_name_length)
+        output.puts Color.colorize(category, [:BOLD])
+
+        cmds.each do |cmd|
+          output.puts "  #{cmd[:display_name].to_s.ljust(longest_cmd_name_length)}    #{cmd[:description]}"
+        end
+
+        output.puts
+      end
+    end
+  end
+end

data/lib/irb/{cmd → command}/history.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
 require "stringio"
-require_relative "nop"
+
 require_relative "../pager"
 
 module IRB
   # :stopdoc:
 
-  module ExtendCommand
-    class History < Nop
+  module Command
+    class History < Base
       category "IRB"
       description "Shows the input history. `-g [query]` or `-G [query]` allows you to filter the output."
 

data/lib/irb/{cmd → command}/info.rb

@@ -5,7 +5,7 @@ require_relative "debug"
 module IRB
   # :stopdoc:
 
-  module ExtendCommand
+  module Command
     class Info < DebugCommand
       def self.transform_args(args)
         args&.dump

data/lib/irb/{cmd → command}/irb_info.rb

@@ -1,12 +1,10 @@
-# frozen_string_literal: false
-
-require_relative "nop"
+# frozen_string_literal: true
 
 module IRB
   # :stopdoc:
 
-  module ExtendCommand
-    class IrbInfo < Nop
+  module Command
+    class IrbInfo < Base
       category "IRB"
       description "Show information about IRB."
 
@@ -15,7 +13,8 @@ module IRB
         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)
+        rc_files = IRB.rc_files.select { |rc| File.exist?(rc) }
+        str += ".irbrc paths: #{rc_files.join(", ")}\n" if rc_files.any?
         str += "RUBY_PLATFORM: #{RUBY_PLATFORM}\n"
         str += "LANG env: #{ENV["LANG"]}\n" if ENV["LANG"] && !ENV["LANG"].empty?
         str += "LC_ALL env: #{ENV["LC_ALL"]}\n" if ENV["LC_ALL"] && !ENV["LC_ALL"].empty?

data/lib/irb/{cmd → command}/load.rb

@@ -1,17 +1,15 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 #
 #   load.rb -
 #   	by Keiju ISHITSUKA(keiju@ruby-lang.org)
 #
-
-require_relative "nop"
 require_relative "../ext/loader"
 
 module IRB
   # :stopdoc:
 
-  module ExtendCommand
-    class LoaderCommand < Nop
+  module Command
+    class LoaderCommand < Base
       include IrbLoader
 
       def raise_cmd_argument_error

data/lib/irb/{cmd → command}/ls.rb

@@ -2,17 +2,23 @@
 
 require "reline"
 require "stringio"
-require_relative "nop"
+
 require_relative "../pager"
 require_relative "../color"
 
 module IRB
   # :stopdoc:
 
-  module ExtendCommand
-    class Ls < Nop
+  module Command
+    class Ls < Base
       category "Context"
-      description "Show methods, constants, and variables. `-g [query]` or `-G [query]` allows you to filter out the output."
+      description "Show methods, constants, and variables."
+
+      help_message <<~HELP_MESSAGE
+        Usage: ls [obj] [-g [query]]
+
+          -g [query]  Filter the output with a query.
+      HELP_MESSAGE
 
       def self.transform_args(args)
         if match = args&.match(/\A(?<args>.+\s|)(-g|-G)\s+(?<grep>[^\s]+)\s*\n\z/)

data/lib/irb/{cmd → command}/measure.rb

@@ -1,10 +1,8 @@
-require_relative "nop"
-
 module IRB
   # :stopdoc:
 
-  module ExtendCommand
-    class Measure < Nop
+  module Command
+    class Measure < Base
       category "Misc"
       description "`measure` enables the mode to measure processing time. `measure :off` disables it."
 

data/lib/irb/{cmd → command}/next.rb

@@ -5,7 +5,7 @@ require_relative "debug"
 module IRB
   # :stopdoc:
 
-  module ExtendCommand
+  module Command
     class Next < DebugCommand
       def execute(*args)
         super(do_cmds: ["next", *args].join(" "))

data/lib/irb/{cmd → command}/pushws.rb

@@ -1,22 +1,37 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 #
 #   change-ws.rb -
 #   	by Keiju ISHITSUKA(keiju@ruby-lang.org)
 #
 
-require_relative "nop"
 require_relative "../ext/workspaces"
 
 module IRB
   # :stopdoc:
 
-  module ExtendCommand
-    class Workspaces < Nop
+  module Command
+    class Workspaces < Base
       category "Workspace"
       description "Show workspaces."
 
       def execute(*obj)
-        irb_context.workspaces.collect{|ws| ws.main}
+        inspection_resuls = irb_context.instance_variable_get(:@workspace_stack).map do |ws|
+          truncated_inspect(ws.main)
+        end
+
+        puts "[" + inspection_resuls.join(", ") + "]"
+      end
+
+      private
+
+      def truncated_inspect(obj)
+        obj_inspection = obj.inspect
+
+        if obj_inspection.size > 20
+          obj_inspection = obj_inspection[0, 19] + "...>"
+        end
+
+        obj_inspection
       end
     end