irb 1.11.1 → 1.12.0

data/lib/irb/source_finder.rb

@@ -4,12 +4,63 @@ require_relative "ruby-lex"
 
 module IRB
   class SourceFinder
-    Source = Struct.new(
-      :file,       # @param [String] - file name
-      :first_line, # @param [String] - first line
-      :last_line,  # @param [String] - last line
-      keyword_init: true,
-    )
+    class EvaluationError < StandardError; end
+
+    class Source
+      attr_reader :file, :line
+      def initialize(file, line, ast_source = nil)
+        @file = file
+        @line = line
+        @ast_source = ast_source
+      end
+
+      def file_exist?
+        File.exist?(@file)
+      end
+
+      def binary_file?
+        # If the line is zero, it means that the target's source is probably in a binary file.
+        @line.zero?
+      end
+
+      def file_content
+        @file_content ||= File.read(@file)
+      end
+
+      def colorized_content
+        if !binary_file? && file_exist?
+          end_line = find_end
+          # To correctly colorize, we need to colorize full content and extract the relevant lines.
+          colored = IRB::Color.colorize_code(file_content)
+          colored.lines[@line - 1...end_line].join
+        elsif @ast_source
+          IRB::Color.colorize_code(@ast_source)
+        end
+      end
+
+      private
+
+      def find_end
+        lex = RubyLex.new
+        code = file_content
+        lines = code.lines[(@line - 1)..-1]
+        tokens = RubyLex.ripper_lex_without_warning(lines.join)
+        prev_tokens = []
+
+        # chunk with line number
+        tokens.chunk { |tok| tok.pos[0] }.each do |lnum, chunk|
+          code = lines[0..lnum].join
+          prev_tokens.concat chunk
+          continue = lex.should_continue?(prev_tokens)
+          syntax = lex.check_code_syntax(code, local_variables: [])
+          if !continue && syntax == :valid
+            return @line + lnum
+          end
+        end
+        @line
+      end
+    end
+
     private_constant :Source
 
     def initialize(irb_context)
@@ -17,50 +68,47 @@ module IRB
     end
 
     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
-        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)
+      when /\A(::)?[A-Z]\w*(::[A-Z]\w*)*\z/ # ConstName, ::ConstName, ConstPath::ConstName
+        eval_receiver_or_owner(signature) # trigger autoload
+        *parts, name = signature.split('::', -1)
+        base =
+          if parts.empty? # ConstName
+            find_const_owner(name)
+          elsif parts == [''] # ::ConstName
+            Object
+          else # ConstPath::ConstName
+            eval_receiver_or_owner(parts.join('::'))
+          end
+        file, line = base.const_source_location(name)
       when /\A(?<owner>[A-Z]\w*(::[A-Z]\w*)*)#(?<method>[^ :.]+)\z/ # Class#method
-        owner = eval(Regexp.last_match[:owner], context_binding)
+        owner = eval_receiver_or_owner(Regexp.last_match[:owner])
         method = Regexp.last_match[:method]
         return unless owner.respond_to?(:instance_method)
-        file, line = method_target(owner, super_level, method, "owner")
+        method = method_target(owner, super_level, method, "owner")
+        file, line = method&.source_location
       when /\A((?<receiver>.+)(\.|::))?(?<method>[^ :.]+)\z/ # method, receiver.method, receiver::method
-        receiver = eval(Regexp.last_match[:receiver] || 'self', context_binding)
+        receiver = eval_receiver_or_owner(Regexp.last_match[:receiver] || 'self')
         method = Regexp.last_match[:method]
         return unless receiver.respond_to?(method, true)
-        file, line = method_target(receiver, super_level, method, "receiver")
+        method = method_target(receiver, super_level, method, "receiver")
+        file, line = method&.source_location
       end
-      # 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))
+      return unless file && line
+
+      if File.exist?(file)
+        Source.new(file, line)
+      elsif method
+        # Method defined with eval, probably in IRB session
+        source = RubyVM::AbstractSyntaxTree.of(method)&.source rescue nil
+        Source.new(file, line, source)
       end
+    rescue EvaluationError
+      nil
     end
 
     private
 
-    def find_end(file, first_line)
-      lex = RubyLex.new
-      lines = File.read(file).lines[(first_line - 1)..-1]
-      tokens = RubyLex.ripper_lex_without_warning(lines.join)
-      prev_tokens = []
-
-      # chunk with line number
-      tokens.chunk { |tok| tok.pos[0] }.each do |lnum, chunk|
-        code = lines[0..lnum].join
-        prev_tokens.concat chunk
-        continue = lex.should_continue?(prev_tokens)
-        syntax = lex.check_code_syntax(code, local_variables: [])
-        if !continue && syntax == :valid
-          return first_line + lnum
-        end
-      end
-      first_line
-    end
-
     def method_target(owner_receiver, super_level, method, type)
       case type
       when "owner"
@@ -71,9 +119,21 @@ module IRB
       super_level.times do |s|
         target_method = target_method.super_method if target_method
       end
-      target_method.nil? ? nil : target_method.source_location
+      target_method
     rescue NameError
       nil
     end
+
+    def eval_receiver_or_owner(code)
+      context_binding = @irb_context.workspace.binding
+      eval(code, context_binding)
+    rescue NameError
+      raise EvaluationError
+    end
+
+    def find_const_owner(name)
+      module_nesting = @irb_context.workspace.binding.eval('::Module.nesting')
+      module_nesting.find { |mod| mod.const_defined?(name, false) } || module_nesting.find { |mod| mod.const_defined?(name) } || Object
+    end
   end
 end

data/lib/irb/statement.rb

@@ -20,6 +20,29 @@ module IRB
       raise NotImplementedError
     end
 
+    class EmptyInput < Statement
+      def is_assignment?
+        false
+      end
+
+      def suppresses_echo?
+        true
+      end
+
+      # Debugger takes empty input to repeat the last command
+      def should_be_handled_by_debugger?
+        true
+      end
+
+      def code
+        ""
+      end
+
+      def evaluable_code
+        code
+      end
+    end
+
     class Expression < Statement
       def initialize(code, is_assignment)
         @code = code
@@ -60,9 +83,8 @@ module IRB
       end
 
       def should_be_handled_by_debugger?
-        require_relative 'cmd/help'
-        require_relative 'cmd/debug'
-        IRB::ExtendCommand::DebugCommand > @command_class || IRB::ExtendCommand::Help == @command_class
+        require_relative 'command/debug'
+        IRB::Command::DebugCommand > @command_class
       end
 
       def evaluable_code

data/lib/irb/version.rb

@@ -1,11 +1,11 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 #
 #   irb/version.rb - irb version definition file
 #   	by Keiju ISHITSUKA(keiju@ishitsuka.com)
 #
 
 module IRB # :nodoc:
-  VERSION = "1.11.1"
+  VERSION = "1.12.0"
   @RELEASE_VERSION = VERSION
-  @LAST_UPDATE_DATE = "2024-01-08"
+  @LAST_UPDATE_DATE = "2024-03-06"
 end

data/lib/irb/workspace.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 #
 #   irb/workspace-binding.rb -
 #   	by Keiju ISHITSUKA(keiju@ruby-lang.org)
@@ -90,11 +90,11 @@ EOF
         IRB.conf[:__MAIN__] = @main
         @main.singleton_class.class_eval do
           private
-          define_method(:exit) do |*a, &b|
-            # Do nothing, will be overridden
-          end
           define_method(:binding, Kernel.instance_method(:binding))
           define_method(:local_variables, Kernel.instance_method(:local_variables))
+          # Define empty method to avoid delegator warning, will be overridden.
+          define_method(:exit) {|*a, &b| }
+          define_method(:exit!) {|*a, &b| }
         end
         @binding = eval("IRB.conf[:__MAIN__].instance_eval('binding', __FILE__, __LINE__)", @binding, *@binding.source_location)
       end

data/lib/irb/ws-for-case-2.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 #
 #   irb/ws-for-case-2.rb -
 #   	by Keiju ISHITSUKA(keiju@ruby-lang.org)

data/lib/irb/xmp.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 #
 #   xmp.rb - irb version of gotoken xmp
 #   	by Keiju ISHITSUKA(Nippon Rational Inc.)

data/lib/irb.rb

@@ -1,4 +1,4 @@
-# frozen_string_literal: false
+# frozen_string_literal: true
 #
 #   irb.rb - irb main module
 #       by Keiju ISHITSUKA(keiju@ruby-lang.org)
@@ -9,7 +9,7 @@ require "reline"
 
 require_relative "irb/init"
 require_relative "irb/context"
-require_relative "irb/extend-command"
+require_relative "irb/command"
 
 require_relative "irb/ruby-lex"
 require_relative "irb/statement"
@@ -203,11 +203,10 @@ require_relative "irb/pager"
 #
 # === Input Command History
 #
-# By default, \IRB stores a history of up to 1000 input commands
-# in file <tt>~/.irb_history</tt>
-# (or, if a {configuration file}[rdoc-ref:IRB@Configuration+File]
-# is found, in file +.irb_history+
-# inin the same directory as that file).
+# By default, \IRB stores a history of up to 1000 input commands in a
+# file named <tt>.irb_history</tt>. The history file will be in the same directory
+# as the {configuration file}[rdoc-ref:IRB@Configuration+File] if one is found, or
+# in <tt>~/</tt> otherwise.
 #
 # A new \IRB session creates the history file if it does not exist,
 # and appends to the file if it does exist.
@@ -365,7 +364,7 @@ require_relative "irb/pager"
 # You can change the initial behavior and suppress all echoing by:
 #
 # - Adding to the configuration file: <tt>IRB.conf[:ECHO] = false</tt>.
-#   (The default value for this entry is +niL+, which means the same as +true+.)
+#   (The default value for this entry is +nil+, which means the same as +true+.)
 # - Giving command-line option <tt>--noecho</tt>.
 #   (The default is <tt>--echo</tt>.)
 #
@@ -392,7 +391,7 @@ require_relative "irb/pager"
 #   (The default value for this entry is +niL+, which means the same as +:truncate+.)
 # - Giving command-line option <tt>--noecho-on-assignment</tt>
 #   or <tt>--echo-on-assignment</tt>.
-#   (The default is <tt>--truncate-echo-on-assigment</tt>.)
+#   (The default is <tt>--truncate-echo-on-assignment</tt>.)
 #
 # During the session, you can change the current setting
 # with configuration method <tt>conf.echo_on_assignment=</tt>
@@ -413,7 +412,7 @@ require_relative "irb/pager"
 #
 # By default, \IRB prefixes a newline to a multiline response.
 #
-# You can change the initial default value by adding to the configuation file:
+# You can change the initial default value by adding to the configuration file:
 #
 #   IRB.conf[:NEWLINE_BEFORE_MULTILINE_OUTPUT] = false
 #
@@ -812,7 +811,7 @@ require_relative "irb/pager"
 #
 # === Commands
 #
-# Please use the `show_cmds` command to see the list of available commands.
+# Please use the `help` command to see the list of available commands.
 #
 # === IRB Sessions
 #
@@ -887,7 +886,7 @@ module IRB
 
   # Quits irb
   def IRB.irb_exit(*)
-    throw :IRB_EXIT
+    throw :IRB_EXIT, false
   end
 
   # Aborts then interrupts irb.
@@ -904,8 +903,8 @@ module IRB
     # parsed as a :method_add_arg and the output won't be suppressed
 
     PROMPT_MAIN_TRUNCATE_LENGTH = 32
-    PROMPT_MAIN_TRUNCATE_OMISSION = '...'.freeze
-    CONTROL_CHARACTERS_PATTERN = "\x00-\x1F".freeze
+    PROMPT_MAIN_TRUNCATE_OMISSION = '...'
+    CONTROL_CHARACTERS_PATTERN = "\x00-\x1F"
 
     # Returns the current context of this irb session
     attr_reader :context
@@ -934,7 +933,7 @@ module IRB
 
     def debug_readline(binding)
       workspace = IRB::WorkSpace.new(binding)
-      context.workspace = workspace
+      context.replace_workspace(workspace)
       context.workspace.load_commands_to_main
       @line_no += 1
 
@@ -945,7 +944,7 @@ module IRB
       # Irb#eval_input will simply return the input, and we need to pass it to the debugger.
       input = if IRB.conf[:SAVE_HISTORY] && context.io.support_history_saving?
         # Previous IRB session's history has been saved when `Irb#run` is exited
-        # We need to make sure the saved history is not saved again by reseting the counter
+        # We need to make sure the saved history is not saved again by resetting the counter
         context.io.reset_history_counter
 
         begin
@@ -980,13 +979,21 @@ module IRB
       end
 
       begin
-        catch(:IRB_EXIT) do
+        if defined?(RubyVM.keep_script_lines)
+          keep_script_lines_backup = RubyVM.keep_script_lines
+          RubyVM.keep_script_lines = true
+        end
+
+        forced_exit = catch(:IRB_EXIT) do
           eval_input
         end
       ensure
+        RubyVM.keep_script_lines = keep_script_lines_backup if defined?(RubyVM.keep_script_lines)
         trap("SIGINT", prev_trap)
         conf[:AT_EXIT].each{|hook| hook.call}
+
         context.io.save_history if save_history
+        Kernel.exit if forced_exit
       end
     end
 
@@ -1049,7 +1056,7 @@ module IRB
       return read_input(prompt) if @context.io.respond_to?(:check_termination)
 
       # nomultiline
-      code = ''
+      code = +''
       line_offset = 0
       loop do
         line = read_input(prompt)
@@ -1075,16 +1082,17 @@ module IRB
       loop do
         code = readmultiline
         break unless code
-
-        if code != "\n"
-          yield build_statement(code), @line_no
-        end
+        yield build_statement(code), @line_no
         @line_no += code.count("\n")
       rescue RubyLex::TerminateLineInput
       end
     end
 
     def build_statement(code)
+      if code.match?(/\A\n*\z/)
+        return Statement::EmptyInput.new
+      end
+
       code.force_encoding(@context.io.encoding)
       command_or_alias, arg = code.split(/\s/, 2)
       # Transform a non-identifier alias (@, $) or keywords (next, break)
@@ -1130,7 +1138,6 @@ module IRB
       end
       if @context.io.respond_to?(:dynamic_prompt)
         @context.io.dynamic_prompt do |lines|
-          lines << '' if lines.empty?
           tokens = RubyLex.ripper_lex_without_warning(lines.map{ |l| l + "\n" }.join, local_variables: @context.local_variables)
           line_results = IRB::NestingParser.parse_by_line(tokens)
           tokens_until_line = []
@@ -1228,7 +1235,7 @@ module IRB
         lines.map{ |l| l + "\n" }.join
       }
       # The "<top (required)>" in "(irb)" may be the top level of IRB so imitate the main object.
-      message = message.gsub(/\(irb\):(?<num>\d+):in `<(?<frame>top \(required\))>'/) { "(irb):#{$~[:num]}:in `<main>'" }
+      message = message.gsub(/\(irb\):(?<num>\d+):in (?<open_quote>[`'])<(?<frame>top \(required\))>'/) { "(irb):#{$~[:num]}:in #{$~[:open_quote]}<main>'" }
       puts message
       puts 'Maybe IRB bug!' if irb_bug
     rescue Exception => handler_exc
@@ -1262,12 +1269,11 @@ module IRB
     # Used by the irb command +irb_load+, see IRB@IRB+Sessions for more
     # information.
     def suspend_workspace(workspace)
-      @context.workspace, back_workspace = workspace, @context.workspace
-      begin
-        yield back_workspace
-      ensure
-        @context.workspace = back_workspace
-      end
+      current_workspace = @context.workspace
+      @context.replace_workspace(workspace)
+      yield
+    ensure
+      @context.replace_workspace current_workspace
     end
 
     # Evaluates the given block using the given +input_method+ as the
@@ -1515,7 +1521,7 @@ class Binding
   # See IRB for more information.
   def irb(show_code: true)
     # Setup IRB with the current file's path and no command line arguments
-    IRB.setup(source_location[0], argv: [])
+    IRB.setup(source_location[0], argv: []) unless IRB.initialized?
     # Create a new workspace using the current binding
     workspace = IRB::WorkSpace.new(self)
     # Print the code around the binding if show_code is true
@@ -1527,7 +1533,7 @@ class Binding
 
     if debugger_irb
       # If we're already in a debugger session, set the workspace and irb_path for the original IRB instance
-      debugger_irb.context.workspace = workspace
+      debugger_irb.context.replace_workspace(workspace)
       debugger_irb.context.irb_path = irb_path
       # If we've started a debugger session and hit another binding.irb, we don't want to start an IRB session
       # instead, we want to resume the irb:rdbg session.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: irb
 version: !ruby/object:Gem::Version
-  version: 1.11.1
+  version: 1.12.0
 platform: ruby
 authors:
 - aycabta
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-09 00:00:00.000000000 Z
+date: 2024-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: reline
@@ -60,34 +60,36 @@ files:
 - exe/irb
 - irb.gemspec
 - lib/irb.rb
-- lib/irb/cmd/backtrace.rb
-- lib/irb/cmd/break.rb
-- lib/irb/cmd/catch.rb
-- lib/irb/cmd/chws.rb
-- lib/irb/cmd/continue.rb
-- lib/irb/cmd/debug.rb
-- lib/irb/cmd/delete.rb
-- lib/irb/cmd/edit.rb
-- lib/irb/cmd/exit.rb
-- lib/irb/cmd/finish.rb
-- lib/irb/cmd/help.rb
-- lib/irb/cmd/history.rb
-- lib/irb/cmd/info.rb
-- lib/irb/cmd/irb_info.rb
-- lib/irb/cmd/load.rb
-- lib/irb/cmd/ls.rb
-- lib/irb/cmd/measure.rb
-- lib/irb/cmd/next.rb
 - lib/irb/cmd/nop.rb
-- lib/irb/cmd/pushws.rb
-- lib/irb/cmd/show_cmds.rb
-- lib/irb/cmd/show_doc.rb
-- lib/irb/cmd/show_source.rb
-- lib/irb/cmd/step.rb
-- lib/irb/cmd/subirb.rb
-- lib/irb/cmd/whereami.rb
 - lib/irb/color.rb
 - lib/irb/color_printer.rb
+- lib/irb/command.rb
+- lib/irb/command/backtrace.rb
+- lib/irb/command/base.rb
+- lib/irb/command/break.rb
+- lib/irb/command/catch.rb
+- lib/irb/command/chws.rb
+- lib/irb/command/continue.rb
+- lib/irb/command/debug.rb
+- lib/irb/command/delete.rb
+- lib/irb/command/edit.rb
+- lib/irb/command/exit.rb
+- lib/irb/command/finish.rb
+- lib/irb/command/force_exit.rb
+- lib/irb/command/help.rb
+- lib/irb/command/history.rb
+- lib/irb/command/info.rb
+- lib/irb/command/irb_info.rb
+- lib/irb/command/load.rb
+- lib/irb/command/ls.rb
+- lib/irb/command/measure.rb
+- lib/irb/command/next.rb
+- lib/irb/command/pushws.rb
+- lib/irb/command/show_doc.rb
+- lib/irb/command/show_source.rb
+- lib/irb/command/step.rb
+- lib/irb/command/subirb.rb
+- lib/irb/command/whereami.rb
 - lib/irb/completion.rb
 - lib/irb/context.rb
 - lib/irb/debug.rb
@@ -100,7 +102,6 @@ files:
 - lib/irb/ext/tracer.rb
 - lib/irb/ext/use-loader.rb
 - lib/irb/ext/workspaces.rb
-- lib/irb/extend-command.rb
 - lib/irb/frame.rb
 - lib/irb/help.rb
 - lib/irb/history.rb
@@ -149,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.4
+rubygems_version: 3.5.1
 signing_key:
 specification_version: 4
 summary: Interactive Ruby command-line tool for REPL (Read Eval Print Loop).

data/lib/irb/cmd/edit.rb

@@ -1,60 +0,0 @@
-require 'shellwords'
-require_relative "nop"
-require_relative "../source_finder"
-
-module IRB
-  # :stopdoc:
-
-  module ExtendCommand
-    class Edit < Nop
-      category "Misc"
-      description 'Open a file with the editor command defined with `ENV["VISUAL"]` or `ENV["EDITOR"]`.'
-
-      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? && (irb_path = @irb_context.irb_path)
-          path = irb_path
-        end
-
-        if !File.exist?(path)
-          source =
-            begin
-              SourceFinder.new(@irb_context).find_source(path)
-            rescue NameError
-              # if user enters a path that doesn't exist, it'll cause NameError when passed here because find_source would try to evaluate it as well
-              # in this case, we should just ignore the error
-            end
-
-          if source
-            path = source.file
-          else
-            puts "Can not find file: #{path}"
-            return
-          end
-        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/help.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "show_doc"
-
-module IRB
-  module ExtendCommand
-    class Help < ShowDoc
-      category "Context"
-      description "[DEPRECATED] Enter the mode to look up RI documents."
-
-      DEPRECATION_MESSAGE = <<~MSG
-        [Deprecation] The `help` command will be repurposed to display command help in the future.
-        For RI document lookup, please use the `show_doc` command instead.
-        For command help, please use `show_cmds` for now.
-      MSG
-
-      def execute(*names)
-        warn DEPRECATION_MESSAGE
-        super
-      end
-    end
-  end
-end