irb 1.6.4 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db51125adbe98b16228e314bff627b1cec953b92f32c774c4b9a820dc3bfc40b
-  data.tar.gz: ead3ebf30f5a4369d8cc2767691397d766bab8532031f8f505c2d0b3f251e071
+  metadata.gz: fa3c9603f48d730988d34f454a10b58021caa677ab8832d9764e39e61bb49abb
+  data.tar.gz: c46d1e32c81a8f22593e174af095070159af6a61508c97b3ef4b0b9d28301d58
 SHA512:
-  metadata.gz: d2f749ce66ed43433fbbc7ec8682a0c3f0180ac8fb676739e5c3cbf0eb2f8bbb89a7896af11120bdeedd730e57edddaeabf932ae22ac55ad33c99f8408ffc832
-  data.tar.gz: 55621e3a5f9926c3f1b44426c23b9b08543920075fa0d32eeda8b7db35ded09aba6c311011e7f8397a6a5089bbb63d2b2e2603c1d7e254b77a16b93ca35b76f3
+  metadata.gz: 3e99185c909180d01a3310f7db11437181268b930d267f2fe365c06cd7a442ad3a8cdf7d5863fb19e17885a23aad46b993a2e5c21fb8632ff2f91285e469be4b
+  data.tar.gz: 44978be86d00d0fc435e81e4cadc5abad08d47519a189db02e34d7eb3435e9ac0cc0adf470e845edba1e7d866574298e1b7b8bba5190d8be538c396cd0179d07

data/lib/irb/cmd/help.rb

@@ -1,57 +1,23 @@
-# frozen_string_literal: false
-#
-#   help.rb - helper using ri
-#
+# frozen_string_literal: true
 
-require_relative "nop"
+require_relative "show_doc"
 
 module IRB
-  # :stopdoc:
-
   module ExtendCommand
-    class Help < Nop
-      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
-
+    class Help < ShowDoc
       category "Context"
-      description "Enter the mode to look up RI documents."
+      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)
-        require 'rdoc/ri/driver'
-        opts = RDoc::RI::Driver.process_args([])
-        IRB::ExtendCommand::Help.const_set(:Ri, RDoc::RI::Driver.new(opts))
-      rescue LoadError, SystemExit
-        IRB::ExtendCommand::Help.remove_method(:execute)
-        # raise NoMethodError in ensure
-      else
-        def execute(*names)
-          if names.empty?
-            Ri.interactive
-            return
-          end
-          names.each do |name|
-            begin
-              Ri.display_name(name.to_s)
-            rescue RDoc::RI::Error
-              puts $!.message
-            end
-          end
-          nil
-        end
-        nil
-      ensure
-        execute(*names)
+        warn DEPRECATION_MESSAGE
+        super
       end
     end
   end
-
-  # :startdoc:
 end

data/lib/irb/cmd/ls.rb

@@ -39,8 +39,12 @@ module IRB
       def dump_methods(o, klass, obj)
         singleton_class = begin obj.singleton_class; rescue TypeError; nil end
         dumped_mods = Array.new
+        ancestors = klass.ancestors
+        ancestors = ancestors.reject { |c| c >= Object } if klass < Object
+        singleton_ancestors = (singleton_class&.ancestors || []).reject { |c| c >= Class }
+
         # singleton_class' ancestors should be at the front
-        maps = class_method_map(singleton_class&.ancestors || [], dumped_mods) + class_method_map(klass.ancestors, dumped_mods)
+        maps = class_method_map(singleton_ancestors, dumped_mods) + class_method_map(ancestors, dumped_mods)
         maps.each do |mod, methods|
           name = mod == singleton_class ? "#{klass}.methods" : "#{mod}#methods"
           o.dump(name, methods)
@@ -49,7 +53,6 @@ module IRB
 
       def class_method_map(classes, dumped_mods)
         dumped_methods = Array.new
-        classes = classes.reject { |mod| mod >= Object }
         classes.map do |mod|
           next if dumped_mods.include? mod
 

data/lib/irb/cmd/show_doc.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require_relative "nop"
+
+module IRB
+  module ExtendCommand
+    class ShowDoc < Nop
+      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
+
+      category "Context"
+      description "Enter the mode to look up RI documents."
+
+      def execute(*names)
+        require 'rdoc/ri/driver'
+
+        unless ShowDoc.const_defined?(:Ri)
+          opts = RDoc::RI::Driver.process_args([])
+          ShowDoc.const_set(:Ri, RDoc::RI::Driver.new(opts))
+        end
+
+        if names.empty?
+          Ri.interactive
+        else
+          names.each do |name|
+            begin
+              Ri.display_name(name.to_s)
+            rescue RDoc::RI::Error
+              puts $!.message
+            end
+          end
+        end
+
+        nil
+      rescue LoadError, SystemExit
+        warn "Can't display document because `rdoc` is not installed."
+      end
+    end
+  end
+end

data/lib/irb/cmd/show_source.rb

@@ -31,13 +31,14 @@ module IRB
           when /\A(?<owner>[A-Z]\w*(::[A-Z]\w*)*)#(?<method>[^ :.]+)\z/ # Class#method
             owner = eval(Regexp.last_match[:owner], irb_context.workspace.binding)
             method = Regexp.last_match[:method]
-            if owner.respond_to?(:instance_method) && owner.instance_methods.include?(method.to_sym)
-              file, line = owner.instance_method(method).source_location
+            if owner.respond_to?(:instance_method)
+              methods = owner.instance_methods + owner.private_instance_methods
+              file, line = owner.instance_method(method).source_location if methods.include?(method.to_sym)
             end
           when /\A((?<receiver>.+)(\.|::))?(?<method>[^ :.]+)\z/ # method, receiver.method, receiver::method
             receiver = eval(Regexp.last_match[:receiver] || 'self', irb_context.workspace.binding)
             method = Regexp.last_match[:method]
-            file, line = receiver.method(method).source_location if receiver.respond_to?(method)
+            file, line = receiver.method(method).source_location if receiver.respond_to?(method, true)
           end
           if file && line
             Source.new(file: file, first_line: line, last_line: find_end(file, line, irb_context))

data/lib/irb/ext/tracer.rb

@@ -7,7 +7,7 @@
 begin
   require "tracer"
 rescue LoadError
-  $stderr.puts "Tracer extension of IRB is enabled but tracer gem doesn't found."
+  $stderr.puts "Tracer extension of IRB is enabled but tracer gem wasn't found."
   module IRB
     class Context
       def use_tracer=(opt)

data/lib/irb/extend-command.rb

@@ -157,10 +157,14 @@ module IRB # :nodoc:
 
       [
         :irb_help, :Help, "cmd/help",
-        [:show_doc, NO_OVERRIDE],
         [:help, NO_OVERRIDE],
       ],
 
+      [
+        :irb_show_doc, :ShowDoc, "cmd/show_doc",
+        [:show_doc, NO_OVERRIDE],
+      ],
+
       [
         :irb_info, :IrbInfo, "cmd/irb_info"
       ],

data/lib/irb/help.rb

@@ -4,15 +4,13 @@
 #   	by Keiju ISHITSUKA(keiju@ishitsuka.com)
 #
 
-require_relative 'magic-file'
-
 module IRB
   # 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")
     space_line = false
-    IRB::MagicFile.open(path){|f|
+    File.open(path){|f|
       f.each_line do |l|
         if /^\s*$/ =~ l
           lc.puts l unless space_line

data/lib/irb/input-method.rb

@@ -5,7 +5,6 @@
 #
 
 require_relative 'src_encoding'
-require_relative 'magic-file'
 require_relative 'completion'
 require 'io/console'
 require 'reline'
@@ -132,7 +131,7 @@ module IRB
     # Creates a new input method object
     def initialize(file)
       super
-      @io = file.is_a?(IO) ? file : IRB::MagicFile.open(file)
+      @io = file.is_a?(IO) ? file : File.open(file)
       @external_encoding = @io.external_encoding
     end
     # The file name of this input method, usually given during initialization.
@@ -399,8 +398,10 @@ module IRB
       formatter = RDoc::Markup::ToAnsi.new
       formatter.width = width
       dialog.trap_key = alt_d
-      message = 'Press Alt+d to read the full document'
+      mod_key = RUBY_PLATFORM.match?(/darwin/) ? "Option" : "Alt"
+      message = "Press #{mod_key}+d to read the full document"
       contents = [message] + doc.accept(formatter).split("\n")
+      contents = contents.take(preferred_dialog_height) if respond_to?(:preferred_dialog_height)
 
       y = cursor_pos_to_render.y
       DialogRenderInfo.new(pos: Reline::CursorPos.new(x, y), contents: contents, width: width, bg_color: '49')

data/lib/irb/locale.rb

@@ -15,7 +15,11 @@ module IRB # :nodoc:
     ]x
     LOCALE_DIR = "/lc/"
 
-    @@legacy_encoding_alias_map = {}.freeze
+    LEGACY_ENCODING_ALIAS_MAP = {
+      'ujis' => Encoding::EUC_JP,
+      'euc' => Encoding::EUC_JP
+    }
+
     @@loaded = []
 
     def initialize(locale = nil)
@@ -26,11 +30,11 @@ module IRB # :nodoc:
         @lang, @territory, @encoding_name, @modifier = m[:language], m[:territory], m[:codeset], m[:modifier]
 
         if @encoding_name
-          begin load 'irb/encoding_aliases.rb'; rescue LoadError; end
-          if @encoding = @@legacy_encoding_alias_map[@encoding_name]
+          if @encoding = LEGACY_ENCODING_ALIAS_MAP[@encoding_name]
             warn(("%s is obsolete. use %s" % ["#{@lang}_#{@territory}.#{@encoding_name}", "#{@lang}_#{@territory}.#{@encoding.name}"]), uplevel: 1)
+          else
+            @encoding = Encoding.find(@encoding_name) rescue nil
           end
-          @encoding = Encoding.find(@encoding_name) rescue nil
         end
       end
       @encoding ||= (Encoding.find('locale') rescue Encoding::ASCII_8BIT)
@@ -78,39 +82,12 @@ module IRB # :nodoc:
       super(*ary)
     end
 
-    def require(file, priv = nil)
-      rex = Regexp.new("lc/#{Regexp.quote(file)}\.(so|o|sl|rb)?")
-      return false if $".find{|f| f =~ rex}
-
-      case file
-      when /\.rb$/
-        begin
-          load(file, priv)
-          $".push file
-          return true
-        rescue LoadError
-        end
-      when /\.(so|o|sl)$/
-        return super
-      end
-
-      begin
-        load(f = file + ".rb")
-        $".push f  #"
-        return true
-      rescue LoadError
-        return ruby_require(file)
-      end
-    end
-
-    alias toplevel_load load
-
-    def load(file, priv=nil)
+    def load(file)
       found = find(file)
       if found
         unless @@loaded.include?(found)
           @@loaded << found # cache
-          return real_load(found, priv)
+          Kernel.load(found)
         end
       else
         raise LoadError, "No such file to load -- #{file}"
@@ -129,16 +106,6 @@ module IRB # :nodoc:
       end
     end
 
-    private
-    def real_load(path, priv)
-      src = MagicFile.open(path){|f| f.read}
-      if priv
-        eval("self", TOPLEVEL_BINDING).extend(Module.new {eval(src, nil, path)})
-      else
-        eval(src, TOPLEVEL_BINDING, path)
-      end
-    end
-
     # @param paths load paths in which IRB find a localized file.
     # @param dir directory
     # @param file basename to be localized

data/lib/irb/ruby-lex.rb

@@ -18,10 +18,7 @@ class RubyLex
 
   def initialize(context)
     @context = context
-    @exp_line_no = @line_no = 1
-    @indent = 0
-    @continue = false
-    @line = ""
+    @line_no = 1
     @prompt = nil
   end
 
@@ -42,8 +39,17 @@ class RubyLex
     result
   end
 
+  def single_line_command?(code)
+    command = code.split(/\s/, 2).first
+    @context.symbol_alias?(command) || @context.transform_args?(command)
+  end
+
   # io functions
-  def set_input(io, &block)
+  def set_input(&block)
+    @input = block
+  end
+
+  def configure_io(io)
     @io = io
     if @io.respond_to?(:check_termination)
       @io.check_termination do |code|
@@ -61,14 +67,9 @@ class RubyLex
           end
         else
           # Accept any single-line input for symbol aliases or commands that transform args
-          command = code.split(/\s/, 2).first
-          if @context.symbol_alias?(command) || @context.transform_args?(command)
-            next true
-          end
+          next true if single_line_command?(code)
 
-          code.gsub!(/\s*\z/, '').concat("\n")
-          tokens = self.class.ripper_lex_without_warning(code, context: @context)
-          ltype, indent, continue, code_block_open = check_state(code, tokens)
+          ltype, indent, continue, code_block_open = check_code_state(code)
           if ltype or indent > 0 or continue or code_block_open
             false
           else
@@ -112,10 +113,22 @@ class RubyLex
       end
     end
 
-    if block_given?
-      @input = block
-    else
-      @input = Proc.new{@io.gets}
+    if @io.respond_to?(:auto_indent) and @context.auto_indent_mode
+      @io.auto_indent do |lines, line_index, byte_pointer, is_newline|
+        if is_newline
+          @tokens = self.class.ripper_lex_without_warning(lines[0..line_index].join("\n"), context: @context)
+          prev_spaces = find_prev_spaces(line_index)
+          depth_difference = check_newline_depth_difference
+          depth_difference = 0 if depth_difference < 0
+          prev_spaces + depth_difference * 2
+        else
+          code = line_index.zero? ? '' : lines[0..(line_index - 1)].map{ |l| l + "\n" }.join
+          last_line = lines[line_index]&.byteslice(0, byte_pointer)
+          code += last_line if last_line
+          @tokens = self.class.ripper_lex_without_warning(code, context: @context)
+          check_corresponding_token_depth(lines, line_index)
+        end
+      end
     end
   end
 
@@ -184,26 +197,6 @@ class RubyLex
     prev_spaces
   end
 
-  def set_auto_indent
-    if @io.respond_to?(:auto_indent) and @context.auto_indent_mode
-      @io.auto_indent do |lines, line_index, byte_pointer, is_newline|
-        if is_newline
-          @tokens = self.class.ripper_lex_without_warning(lines[0..line_index].join("\n"), context: @context)
-          prev_spaces = find_prev_spaces(line_index)
-          depth_difference = check_newline_depth_difference
-          depth_difference = 0 if depth_difference < 0
-          prev_spaces + depth_difference * 2
-        else
-          code = line_index.zero? ? '' : lines[0..(line_index - 1)].map{ |l| l + "\n" }.join
-          last_line = lines[line_index]&.byteslice(0, byte_pointer)
-          code += last_line if last_line
-          @tokens = self.class.ripper_lex_without_warning(code, context: @context)
-          check_corresponding_token_depth(lines, line_index)
-        end
-      end
-    end
-  end
-
   def check_state(code, tokens)
     ltype = process_literal_type(tokens)
     indent = process_nesting_level(tokens)
@@ -214,67 +207,56 @@ class RubyLex
     [ltype, indent, continue, code_block_open]
   end
 
-  def prompt
-    if @prompt
-      @prompt.call(@ltype, @indent, @continue, @line_no)
-    end
+  def check_code_state(code)
+    check_target_code = code.gsub(/\s*\z/, '').concat("\n")
+    tokens = self.class.ripper_lex_without_warning(check_target_code, context: @context)
+    check_state(check_target_code, tokens)
   end
 
-  def initialize_input
-    @ltype = nil
-    @indent = 0
-    @continue = false
-    @line = ""
-    @exp_line_no = @line_no
-    @code_block_open = false
+  def save_prompt_to_context_io(ltype, indent, continue, line_num_offset)
+    # Implicitly saves prompt string to `@context.io.prompt`. This will be used in the next `@input.call`.
+    @prompt.call(ltype, indent, continue, @line_no + line_num_offset)
   end
 
-  def each_top_level_statement
-    initialize_input
-    catch(:TERM_INPUT) do
-      loop do
-        begin
-          prompt
-          unless l = lex
-            throw :TERM_INPUT if @line == ''
-          else
-            @line_no += l.count("\n")
-            if l == "\n"
-              @exp_line_no += 1
-              next
-            end
-            @line.concat l
-            if @code_block_open or @ltype or @continue or @indent > 0
-              next
-            end
-          end
-          if @line != "\n"
-            @line.force_encoding(@io.encoding)
-            yield @line, @exp_line_no
-          end
-          raise TerminateLineInput if @io.eof?
-          @line = ''
-          @exp_line_no = @line_no
-
-          @indent = 0
-        rescue TerminateLineInput
-          initialize_input
-          prompt
-        end
+  def readmultiline
+    save_prompt_to_context_io(nil, 0, false, 0)
+
+    # multiline
+    return @input.call if @io.respond_to?(:check_termination)
+
+    # nomultiline
+    code = ''
+    line_offset = 0
+    loop do
+      line = @input.call
+      unless line
+        return code.empty? ? nil : code
       end
+
+      code << line
+      # Accept any single-line input for symbol aliases or commands that transform args
+      return code if single_line_command?(code)
+
+      ltype, indent, continue, code_block_open = check_code_state(code)
+      return code unless ltype or indent > 0 or continue or code_block_open
+
+      line_offset += 1
+      save_prompt_to_context_io(ltype, indent, continue, line_offset)
     end
   end
 
-  def lex
-    line = @input.call
-    if @io.respond_to?(:check_termination)
-      return line # multiline
+  def each_top_level_statement
+    loop do
+      code = readmultiline
+      break unless code
+
+      if code != "\n"
+        code.force_encoding(@io.encoding)
+        yield code, @line_no
+      end
+      @line_no += code.count("\n")
+    rescue TerminateLineInput
     end
-    code = @line + (line.nil? ? '' : line)
-    code.gsub!(/\s*\z/, '').concat("\n")
-    @tokens = self.class.ripper_lex_without_warning(code, context: @context)
-    @ltype, @indent, @continue, @code_block_open = check_state(code, @tokens)
-    line
   end
 
   def process_continue(tokens)

data/lib/irb/version.rb

@@ -5,7 +5,7 @@
 #
 
 module IRB # :nodoc:
-  VERSION = "1.6.4"
+  VERSION = "1.7.0"
   @RELEASE_VERSION = VERSION
-  @LAST_UPDATE_DATE = "2023-04-07"
+  @LAST_UPDATE_DATE = "2023-06-03"
 end

data/lib/irb.rb

@@ -537,7 +537,7 @@ module IRB
         @context.io.prompt
       end
 
-      @scanner.set_input(@context.io) do
+      @scanner.set_input do
         signal_status(:IN_INPUT) do
           if l = @context.io.gets
             print l if @context.verbose?
@@ -555,7 +555,7 @@ module IRB
         end
       end
 
-      @scanner.set_auto_indent
+      @scanner.configure_io(@context.io)
 
       @scanner.each_top_level_statement do |line, line_no|
         signal_status(:IN_EVAL) do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: irb
 version: !ruby/object:Gem::Version
-  version: 1.6.4
+  version: 1.7.0
 platform: ruby
 authors:
 - aycabta
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-09 00:00:00.000000000 Z
+date: 2023-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: reline
@@ -66,6 +66,7 @@ files:
 - 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
@@ -91,11 +92,9 @@ files:
 - lib/irb/inspector.rb
 - lib/irb/lc/error.rb
 - lib/irb/lc/help-message
-- lib/irb/lc/ja/encoding_aliases.rb
 - lib/irb/lc/ja/error.rb
 - lib/irb/lc/ja/help-message
 - lib/irb/locale.rb
-- lib/irb/magic-file.rb
 - lib/irb/notifier.rb
 - lib/irb/output-method.rb
 - lib/irb/ruby-lex.rb
@@ -130,7 +129,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.8
+rubygems_version: 3.5.0.dev
 signing_key:
 specification_version: 4
 summary: Interactive Ruby command-line tool for REPL (Read Eval Print Loop).

data/lib/irb/lc/ja/encoding_aliases.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: false
-module IRB
-  # :stopdoc:
-
-  class Locale
-    @@legacy_encoding_alias_map = {
-      'ujis' => Encoding::EUC_JP,
-      'euc' => Encoding::EUC_JP
-    }.freeze
-  end
-
-  # :startdoc:
-end

data/lib/irb/magic-file.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: false
-module IRB
-  class << (MagicFile = Object.new)
-    # see parser_magic_comment in parse.y
-    ENCODING_SPEC_RE = %r"coding\s*[=:]\s*([[:alnum:]\-_]+)"
-
-    def open(path)
-      io = File.open(path, 'rb')
-      line = io.gets
-      line = io.gets if line[0,2] == "#!"
-      encoding = detect_encoding(line)
-      internal_encoding = encoding
-      encoding ||= IRB.default_src_encoding
-      io.rewind
-      io.set_encoding(encoding, internal_encoding)
-
-      if block_given?
-        begin
-          return (yield io)
-        ensure
-          io.close
-        end
-      else
-        return io
-      end
-    end
-
-    private
-    def detect_encoding(line)
-      return unless line[0] == ?#
-      line = line[1..-1]
-      line = $1 if line[/-\*-\s*(.*?)\s*-*-$/]
-      return nil unless ENCODING_SPEC_RE =~ line
-      encoding = $1
-      return encoding.sub(/-(?:mac|dos|unix)/i, '')
-    end
-  end
-end