error_highlight 0.7.0 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c61fd8e89a64b337d10859ca487015ad69c87555057ce7f15b274ce799a5beb3
-  data.tar.gz: 946058938dc70f583672f9adf1450a1514e4922638e051b2755545017f266963
+  metadata.gz: ef4c5d2f4747887533384fb54a39c1bb318199738f342d42cfe34ee43b82aac8
+  data.tar.gz: 416e7a3d066e4010a8f62ba638fda7e6513f0ab743d3f7ac1b6502c3cf260187
 SHA512:
-  metadata.gz: b5a627e7b0a5710be27e62444a5127353e592cb5dd075ec0a25aa957fdf92e7c3e730b30a0fe5b4d1d35eabd9cde9dd6abafbc22a3f071ad7af8f39f991ee634
-  data.tar.gz: 6e72a445acf82b23d8a6deb6537504dfe64b50d74a808ff33104da5dccad6970256f115ef1dc786a25136457ce18b801d0d466b7b8c8dac4ba0d70ab3b5732cc
+  metadata.gz: 6c6ab47b4e691ef2df5fc72308b26f8458cebf8f3b1b1ccd2273563f4dfea5dabf1a141040f28ce003a276dce8c6e24848b42d561e9cd3b5a7838c872a26a90d
+  data.tar.gz: 3b5b1e262f4d2e38a27d3034886344f48bdfa1e7fc76cecf56c277887ede0d6ead14d0ff2138dddcab6849068e503eef64133bbe1bdbba817ff474099fcf9cd9

data/.github/workflows/ruby.yml

@@ -13,7 +13,7 @@ jobs:
     uses: ruby/actions/.github/workflows/ruby_versions.yml@master
     with:
       engine: cruby
-      min_version: 3.1
+      min_version: 3.2
 
   build:
     needs: ruby-versions
@@ -22,7 +22,7 @@ jobs:
       matrix:
         ruby: ${{ fromJson(needs.ruby-versions.outputs.versions) }}
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v7
     - uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby }}
@@ -36,7 +36,7 @@ jobs:
   prism:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v7
     - uses: ruby/setup-ruby@v1
       with:
         ruby-version: head

data/.github/workflows/sync-ruby.yml

@@ -0,0 +1,33 @@
+name: Sync ruby
+on:
+  push:
+    branches: [master]
+jobs:
+  sync:
+    name: Sync ruby
+    runs-on: ubuntu-latest
+    if: ${{ github.repository_owner == 'ruby' }}
+    steps:
+      - uses: actions/checkout@v7
+
+      - name: Create GitHub App token
+        id: app-token
+        uses: actions/create-github-app-token@v3
+        with:
+          app-id: 2060836
+          private-key: ${{ secrets.RUBY_SYNC_DEFAULT_GEMS_PRIVATE_KEY }}
+          owner: ruby
+          repositories: ruby
+
+      - name: Sync to ruby/ruby
+        uses: convictional/trigger-workflow-and-wait@v1.6.5
+        with:
+          owner: ruby
+          repo: ruby
+          workflow_file_name: sync_default_gems.yml
+          github_token: ${{ steps.app-token.outputs.token }}
+          ref: master
+          client_payload: |
+            {"gem":"${{ github.event.repository.name }}","before":"${{ github.event.before }}","after":"${{ github.event.after }}"}
+          propagate_failure: true
+          wait_interval: 10

data/error_highlight.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/ruby/error_highlight"
 
   spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 3.1.0.dev")
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.2.0")
 
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }

data/lib/error_highlight/base.rb

@@ -1,13 +1,13 @@
 require_relative "version"
 
 module ErrorHighlight
-  # Identify the code fragment at that a given exception occurred.
+  # Identify the code fragment where a given exception occurred.
   #
   # Options:
   #
   # point_type: :name | :args
-  #   :name (default) points the method/variable name that the exception occurred.
-  #   :args points the arguments of the method call that the exception occurred.
+  #   :name (default) points to the method/variable name where the exception occurred.
+  #   :args points to the arguments of the method call where the exception occurred.
   #
   # backtrace_location: Thread::Backtrace::Location
   #   It locates the code fragment of the given backtrace_location.
@@ -28,7 +28,7 @@ module ErrorHighlight
   # Currently, ErrorHighlight.spot only supports a single-line code fragment.
   # Therefore, if the return value is not nil, first_lineno and last_lineno will have
   # the same value. If the relevant code fragment spans multiple lines
-  # (e.g., Array#[] of +ary[(newline)expr(newline)]+), the method will return nil.
+  # (e.g., Array#[] of <tt>ary[(newline)expr(newline)]</tt>), the method will return nil.
   # This restriction may be removed in the future.
   def self.spot(obj, **opts)
     case obj
@@ -113,7 +113,7 @@ module ErrorHighlight
         snippet = @node.script_lines[lineno - 1 .. last_lineno - 1].join("")
         snippet += "\n" unless snippet.end_with?("\n")
 
-        # It require some work to support Unicode (or multibyte) characters.
+        # It requires some work to support Unicode (or multibyte) characters.
         # Tentatively, we stop highlighting if the code snippet has non-ascii characters.
         # See https://github.com/ruby/error_highlight/issues/4
         raise NonAscii unless snippet.ascii_only?
@@ -122,56 +122,51 @@ module ErrorHighlight
       end
     end
 
-    OPT_GETCONSTANT_PATH = (RUBY_VERSION.split(".").map {|s| s.to_i } <=> [3, 2]) >= 0
-    private_constant :OPT_GETCONSTANT_PATH
-
     def spot
       return nil unless @node
 
-      if OPT_GETCONSTANT_PATH
-        # In Ruby 3.2 or later, a nested constant access (like `Foo::Bar::Baz`)
-        # is compiled to one instruction (opt_getconstant_path).
-        # @node points to the node of the whole `Foo::Bar::Baz` even if `Foo`
-        # or `Foo::Bar` causes NameError.
-        # So we try to spot the sub-node that causes the NameError by using
-        # `NameError#name`.
-        case @node.type
-        when :COLON2
-          subnodes = []
-          node = @node
-          while node.type == :COLON2
-            node2, const = node.children
-            subnodes << node if const == @name
-            node = node2
-          end
-          if node.type == :CONST || node.type == :COLON3
-            if node.children.first == @name
-              subnodes << node
-            end
-
-            # If we found only one sub-node whose name is equal to @name, use it
-            return nil if subnodes.size != 1
-            @node = subnodes.first
-          else
-            # Do nothing; opt_getconstant_path is used only when the const base is
-            # NODE_CONST (`Foo`) or NODE_COLON3 (`::Foo`)
-          end
-        when :constant_path_node
-          subnodes = []
-          node = @node
-
-          begin
-            subnodes << node if node.name == @name
-          end while (node = node.parent).is_a?(Prism::ConstantPathNode)
-
-          if node.is_a?(Prism::ConstantReadNode) && node.name == @name
+      # In Ruby 3.2 or later, a nested constant access (like `Foo::Bar::Baz`)
+      # is compiled to one instruction (opt_getconstant_path).
+      # @node points to the node of the whole `Foo::Bar::Baz` even if `Foo`
+      # or `Foo::Bar` causes NameError.
+      # So we try to spot the sub-node that causes the NameError by using
+      # `NameError#name`.
+      case @node.type
+      when :COLON2
+        subnodes = []
+        node = @node
+        while node.type == :COLON2
+          node2, const = node.children
+          subnodes << node if const == @name
+          node = node2
+        end
+        if node.type == :CONST || node.type == :COLON3
+          if node.children.first == @name
             subnodes << node
           end
 
           # If we found only one sub-node whose name is equal to @name, use it
           return nil if subnodes.size != 1
           @node = subnodes.first
+        else
+          # Do nothing; opt_getconstant_path is used only when the const base is
+          # NODE_CONST (`Foo`) or NODE_COLON3 (`::Foo`)
         end
+      when :constant_path_node
+        subnodes = []
+        node = @node
+
+        begin
+          subnodes << node if node.name == @name
+        end while (node = node.parent).is_a?(Prism::ConstantPathNode)
+
+        if node.is_a?(Prism::ConstantReadNode) && node.name == @name
+          subnodes << node
+        end
+
+        # If we found only one sub-node whose name is equal to @name, use it
+        return nil if subnodes.size != 1
+        @node = subnodes.first
       end
 
       case @node.type
@@ -239,6 +234,24 @@ module ErrorHighlight
       when :OP_CDECL
         spot_op_cdecl
 
+      when :DEFN
+        # There is nothing to highlight for the arguments of a method
+        # definition, so just return nil instead of raising.
+        return nil if @point_type != :name
+        spot_defn
+
+      when :DEFS
+        return nil if @point_type != :name
+        spot_defs
+
+      when :LAMBDA
+        return nil if @point_type != :name
+        spot_lambda
+
+      when :ITER
+        return nil if @point_type != :name
+        spot_iter
+
       when :call_node
         case @point_type
         when :name
@@ -280,6 +293,37 @@ module ErrorHighlight
       when :constant_path_operator_write_node
         prism_spot_constant_path_operator_write
 
+      when :def_node
+        case @point_type
+        when :name
+          prism_spot_def_for_name
+        when :args
+          # There is nothing to highlight for the arguments of a method
+          # definition (e.g. an ArgumentError for a missing required keyword
+          # is spotted with point_type: :args). Return nil instead of raising
+          # NotImplementedError, which would otherwise escape
+          # Exception#detailed_message / #full_message.
+          return nil
+        end
+
+      when :lambda_node
+        case @point_type
+        when :name
+          prism_spot_lambda_for_name
+        when :args
+          # See the comment for :def_node above.
+          return nil
+        end
+
+      when :block_node
+        case @point_type
+        when :name
+          prism_spot_block_for_name
+        when :args
+          # See the comment for :def_node above.
+          return nil
+        end
+
       end
 
       if @snippet && @beg_column && @end_column && @beg_column < @end_column
@@ -344,6 +388,7 @@ module ErrorHighlight
         end
       elsif mid.to_s =~ /\A\W+\z/ && lines.match(/\G\s*(#{ Regexp.quote(mid) })=.*\n/, nd_recv.last_column)
         @snippet = $` + $&
+        @beg_lineno = @end_lineno = lineno
         @beg_column = $~.begin(1)
         @end_column = $~.end(1)
       end
@@ -470,7 +515,6 @@ module ErrorHighlight
     def spot_fcall_for_args
       _mid, nd_args = @node.children
       if nd_args && nd_args.first_lineno == nd_args.last_lineno
-        # binary operator
         fetch_line(nd_args.first_lineno)
         @beg_column = nd_args.first_column
         @end_column = nd_args.last_column
@@ -582,8 +626,9 @@ module ErrorHighlight
         @beg_column = nd_parent.last_column
         @end_column = @node.last_column
       else
-        @snippet = @fetch[@node.last_lineno]
+        fetch_line(@node.last_lineno)
         if @snippet[...@node.last_column].match(/#{ Regexp.quote(const) }\z/)
+          @beg_lineno = @end_lineno = @node.last_lineno
           @beg_column = $~.begin(0)
           @end_column = $~.end(0)
         end
@@ -597,7 +642,7 @@ module ErrorHighlight
       nd_lhs, op, _nd_rhs = @node.children
       *nd_parent_lhs, _const = nd_lhs.children
       if @name == op
-        @snippet = @fetch[nd_lhs.last_lineno]
+        fetch_line(nd_lhs.last_lineno)
         if @snippet.match(/\G\s*(#{ Regexp.quote(op) })=/, nd_lhs.last_column)
           @beg_column = $~.begin(1)
           @end_column = $~.end(1)
@@ -607,18 +652,67 @@ module ErrorHighlight
         @end_column = nd_lhs.last_column
         if nd_parent_lhs.empty? # example: ::C += 1
           if nd_lhs.first_lineno == nd_lhs.last_lineno
-            @snippet = @fetch[nd_lhs.last_lineno]
+            fetch_line(nd_lhs.last_lineno)
             @beg_column = nd_lhs.first_column
           end
         else # example: Foo::Bar::C += 1
           if nd_parent_lhs.last.last_lineno == nd_lhs.last_lineno
-            @snippet = @fetch[nd_lhs.last_lineno]
+            fetch_line(nd_lhs.last_lineno)
             @beg_column = nd_parent_lhs.last.last_column
           end
         end
       end
     end
 
+    # Example:
+    #   def bar; end
+    #       ^^^
+    def spot_defn
+      mid, = @node.children
+      fetch_line(@node.first_lineno)
+      if @snippet.match(/\Gdef\s+(#{ Regexp.quote(mid) }\b)/, @node.first_column)
+        @beg_column = $~.begin(1)
+        @end_column = $~.end(1)
+      end
+    end
+
+    # Example:
+    #   def Foo.bar; end
+    #          ^^^^
+    def spot_defs
+      nd_recv, mid, = @node.children
+      fetch_line(nd_recv.last_lineno)
+      if @snippet.match(/\G\s*(\.\s*#{ Regexp.quote(mid) }\b)/, nd_recv.last_column)
+        @beg_column = $~.begin(1)
+        @end_column = $~.end(1)
+      end
+    end
+
+    # Example:
+    #   -> { ... }
+    #   ^^
+    def spot_lambda
+      fetch_line(@node.first_lineno)
+      if @snippet.match(/\G->/, @node.first_column)
+        @beg_column = $~.begin(0)
+        @end_column = $~.end(0)
+      end
+    end
+
+    # Example:
+    #   lambda { ... }
+    #          ^
+    #   define_method :foo do
+    #                      ^^
+    def spot_iter
+      _nd_fcall, nd_scope = @node.children
+      fetch_line(nd_scope.first_lineno)
+      if @snippet.match(/\G(?:do\b|\{)/, nd_scope.first_column)
+        @beg_column = $~.begin(0)
+        @end_column = $~.end(0)
+      end
+    end
+
     def fetch_line(lineno)
       @beg_lineno = @end_lineno = lineno
       @snippet = @fetch[lineno]
@@ -824,6 +918,31 @@ module ErrorHighlight
         prism_location(@node.binary_operator_loc.chop)
       end
     end
+
+    # Example:
+    #   def foo()
+    #       ^^^
+    def prism_spot_def_for_name
+      location = @node.name_loc
+      location = @node.operator_loc.join(location) if @node.operator_loc
+      prism_location(location)
+    end
+
+    # Example:
+    #   -> x, y { }
+    #   ^^
+    def prism_spot_lambda_for_name
+      prism_location(@node.operator_loc)
+    end
+
+    # Example:
+    #   lambda { }
+    #          ^
+    #   define_method :foo do |x, y|
+    #                      ^
+    def prism_spot_block_for_name
+      prism_location(@node.opening_loc)
+    end
   end
 
   private_constant :Spotter

data/lib/error_highlight/core_ext.rb

@@ -3,9 +3,38 @@ require_relative "formatter"
 module ErrorHighlight
   module CoreExt
     private def generate_snippet
-      spot = ErrorHighlight.spot(self)
-      return "" unless spot
-      return ErrorHighlight.formatter.message_for(spot)
+      if ArgumentError === self && message =~ /\A(?:wrong number of arguments|missing keyword[s]?|unknown keyword[s]?|no keywords accepted)\b/
+        locs = self.backtrace_locations
+        return "" if locs.size < 2
+        callee_loc, caller_loc = locs
+        callee_spot = ErrorHighlight.spot(self, backtrace_location: callee_loc, point_type: :name)
+        caller_spot = ErrorHighlight.spot(self, backtrace_location: caller_loc, point_type: :name)
+        if caller_spot && callee_spot &&
+            caller_loc.path == callee_loc.path &&
+            caller_loc.lineno == callee_loc.lineno &&
+            caller_spot == callee_spot
+          callee_loc = callee_spot = nil
+        end
+        ret = +"\n"
+        [["caller", caller_loc, caller_spot], ["callee", callee_loc, callee_spot]].each do |header, loc, spot|
+          out = nil
+          if loc
+            out = "    #{ header }: #{ loc.path }:#{ loc.lineno }"
+            if spot
+              _, _, snippet, highlight = ErrorHighlight.formatter.message_for(spot).lines
+              out += "\n    | #{ snippet }      #{ highlight }"
+            else
+              # do nothing
+            end
+          end
+          ret << "\n" + out if out
+        end
+        ret
+      else
+        spot = ErrorHighlight.spot(self)
+        return "" unless spot
+        return ErrorHighlight.formatter.message_for(spot)
+      end
     end
 
     if Exception.method_defined?(:detailed_message)

data/lib/error_highlight/formatter.rb

@@ -56,11 +56,11 @@ module ErrorHighlight
     end
 
     def self.terminal_width
-      # lazy load io/console, so it's not loaded when 'max_snippet_width' is set
+      # lazy load io/console to avoid loading it when 'max_snippet_width' is manually set
       require "io/console"
-      STDERR.winsize[1] if STDERR.tty?
+      $stderr.winsize[1] if $stderr.tty?
     rescue LoadError, NoMethodError, SystemCallError
-      # do not truncate when window size is not available
+      # skip truncation when terminal window size is unavailable
     end
   end
 

data/lib/error_highlight/version.rb

@@ -1,3 +1,3 @@
 module ErrorHighlight
-  VERSION = "0.7.0"
+  VERSION = "0.7.2"
 end

metadata

@@ -1,55 +1,56 @@
 --- !ruby/object:Gem::Specification
 name: error_highlight
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.2
 platform: ruby
-original_platform: ''
 authors:
-- Yusuke Endoh
+  - Yusuke Endoh
 bindir: bin
 cert_chain: []
-date: 2024-12-03 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
-description: The gem enhances Exception#message by adding a short explanation where
-  the exception is raised
+description: "The gem enhances Exception#message by adding a short explanation where the exception is raised"
 email:
-- mame@ruby-lang.org
+  - mame@ruby-lang.org
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/dependabot.yml"
-- ".github/workflows/ruby.yml"
-- ".gitignore"
-- Gemfile
-- LICENSE.txt
-- README.md
-- Rakefile
-- error_highlight.gemspec
-- lib/error_highlight.rb
-- lib/error_highlight/base.rb
-- lib/error_highlight/core_ext.rb
-- lib/error_highlight/formatter.rb
-- lib/error_highlight/version.rb
-homepage: https://github.com/ruby/error_highlight
+  - .github/dependabot.yml
+  - .github/workflows/ruby.yml
+  - .github/workflows/sync-ruby.yml
+  - .gitignore
+  - Gemfile
+  - LICENSE.txt
+  - README.md
+  - Rakefile
+  - error_highlight.gemspec
+  - lib/error_highlight.rb
+  - lib/error_highlight/base.rb
+  - lib/error_highlight/core_ext.rb
+  - lib/error_highlight/formatter.rb
+  - lib/error_highlight/version.rb
+homepage: "https://github.com/ruby/error_highlight"
 licenses:
-- MIT
+  - MIT
 metadata: {}
 rdoc_options: []
 require_paths:
-- lib
+  - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
-    - !ruby/object:Gem::Version
-      version: 3.1.0.dev
+    -
+      - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
-    - !ruby/object:Gem::Version
-      version: '0'
+    -
+      - ">="
+      - !ruby/object:Gem::Version
+        version: "0"
 requirements: []
-rubygems_version: 3.6.0.dev
+rubygems_version: 4.1.0.dev
 specification_version: 4
 summary: Shows a one-line code snippet with an underline in the error backtrace
 test_files: []