error_highlight 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6edc97e3eca88e8281056e7a3d9bceb448c0ac614b742e4ed38908a40e51e01
-  data.tar.gz: 255b537c7d07f8dfd01b747719472e57d24e91703b8df678d655a3fc3f71897d
+  metadata.gz: 5eb06bb7a0af000c582a2ae98fb4401652556c10cd756a1cba8d68951c4b60b9
+  data.tar.gz: 4fd7da0b60979f72f250c5044af20a8d7badd37776d2b6e7ba75b960f72e0a90
 SHA512:
-  metadata.gz: a63da67176a0dabd493fdafa1de60155a26696d22ba633d17765b29a359b0e4ffcc30d4806236bf416c828427d32171aca4210bdb1e018e0347e4cefef3e953a
-  data.tar.gz: '08febd90564658489923f2ef0d2aab82a3796e52c7aa2a11ddcd6cc0d1f65abacd9b757b61bbb36bb59d7cf0e0c1eea820bce6d3b0bad3f771ead27714bc70ee'
+  metadata.gz: 475126fb1511ea9e9c25d966c778931c4d2b51ae91658703c0f7d625f536788afad4645b1ae4ddecafb5e9a7a4cb99ed84f88a04c58035e9e968db1c2e2ba715
+  data.tar.gz: df639b399fbb96cb0afcb71f78263268558e689eb058f9a1da2f5a7ccb87e682697e1580eadc702c78c801380cf1e7823e0a668b19fd526a9314bc0975e14d9a

data/.github/workflows/ruby.yml

@@ -24,4 +24,4 @@ jobs:
         bundle install
     - name: Run the test suite
       run: |
-        bundle exec rake TESTOPT=-v
+        RUBYOPT=--disable-error_highlight bundle exec rake TESTOPT=-v

data/README.md

@@ -51,13 +51,63 @@ test.rb:2:in `extract_value': undefined method `[]' for nil:NilClass (NoMethodEr
         from test.rb:5:in `<main>'
 ```
 
+## Using the `ErrorHighlight.spot`
+
+*Note: This API is experimental, may change in future.*
+
+You can use the `ErrorHighlight.spot` method to get the spnippet data.
+Note that the argument must be a RubyVM::AbstractSyntaxTree::Node object that is created with `save_script_lines: true` option (which is available since Ruby 3.1).
+
+```ruby
+class Dummy
+  def test(_dummy_arg)
+    node = RubyVM::AbstractSyntaxTree.of(caller_locations.first, save_script_lines: true)
+    ErrorHighlight.spot(node)
+  end
+end
+
+pp Dummy.new.test(42) # <- Line 8
+#           ^^^^^       <- Column 12--17
+
+#=> {:first_lineno=>8,
+#    :first_column=>12,
+#    :last_lineno=>8,
+#    :last_column=>17,
+#    :snippet=>"pp Dummy.new.test(42) # <- Line 8\n"}
+```
+
+## Custom Formatter
+
+If you want to customize the message format for code snippet, use `ErrorHighlight.formatter=` to set your custom object that responds to `message_for` method.
+
+```ruby
+formatter = Object.new
+def formatter.message_for(spot)
+  marker = " " * spot[:first_column] + "^" + "~" * (spot[:last_column] - spot[:first_column] - 1)
+
+  "\n\n#{ spot[:snippet] }#{ marker }"
+end
+
+ErrorHighlight.formatter = formatter
+
+1.time {}
+
+#=>
+#
+# test.rb:10:in `<main>': undefined method `time' for 1:Integer (NoMethodError)
+#
+# 1.time {}
+#  ^~~~~
+# Did you mean?  times
+```
+
 ## Disabling `error_highlight`
 
 Occasionally, you may want to disable the `error_highlight` gem for e.g. debugging issues in the error object itself. You
 can disable it entirely by specifying `--disable-error_highlight` option to the `ruby` command:
 
 ```bash
-$ uby --disable-error_highlight -e '1.time {}'
+$ ruby --disable-error_highlight -e '1.time {}'
 -e:1:in `<main>': undefined method `time' for 1:Integer (NoMethodError)
 Did you mean?  times
 ```

data/lib/error_highlight/base.rb

@@ -4,10 +4,9 @@ module ErrorHighlight
   # Identify the code fragment that seems associated with a given error
   #
   # Arguments:
-  #  node: RubyVM::AbstractSyntaxTree::Node
-  #  point: :name | :args
+  #  node: RubyVM::AbstractSyntaxTree::Node (script_lines should be enabled)
+  #  point_type: :name | :args
   #  name: The name associated with the NameError/NoMethodError
-  #  fetch: A block to fetch a specified code line (or lines)
   #
   # Returns:
   #  {
@@ -15,23 +14,25 @@ module ErrorHighlight
   #    first_column: Integer,
   #    last_lineno: Integer,
   #    last_column: Integer,
-  #    line: String,
+  #    snippet: String,
   #  } | nil
   def self.spot(...)
     Spotter.new(...).spot
   end
 
   class Spotter
-    def initialize(node, point, name: nil, &fetch)
+    def initialize(node, point_type: :name, name: nil)
       @node = node
-      @point = point
+      @point_type = point_type
       @name = name
 
       # Not-implemented-yet options
       @arg = nil # Specify the index or keyword at which argument caused the TypeError/ArgumentError
       @multiline = false # Allow multiline spot
 
-      @fetch = fetch
+      @fetch = -> (lineno, last_lineno = lineno) do
+        @node.script_lines[lineno - 1 .. last_lineno - 1].join("")
+      end
     end
 
     def spot
@@ -40,7 +41,7 @@ module ErrorHighlight
       case @node.type
 
       when :CALL, :QCALL
-        case @point
+        case @point_type
         when :name
           spot_call_for_name
         when :args
@@ -48,7 +49,7 @@ module ErrorHighlight
         end
 
       when :ATTRASGN
-        case @point
+        case @point_type
         when :name
           spot_attrasgn_for_name
         when :args
@@ -56,7 +57,7 @@ module ErrorHighlight
         end
 
       when :OPCALL
-        case @point
+        case @point_type
         when :name
           spot_opcall_for_name
         when :args
@@ -64,7 +65,7 @@ module ErrorHighlight
         end
 
       when :FCALL
-        case @point
+        case @point_type
         when :name
           spot_fcall_for_name
         when :args
@@ -75,7 +76,7 @@ module ErrorHighlight
         spot_vcall
 
       when :OP_ASGN1
-        case @point
+        case @point_type
         when :name
           spot_op_asgn1_for_name
         when :args
@@ -83,7 +84,7 @@ module ErrorHighlight
         end
 
       when :OP_ASGN2
-        case @point
+        case @point_type
         when :name
           spot_op_asgn2_for_name
         when :args
@@ -103,13 +104,13 @@ module ErrorHighlight
         spot_op_cdecl
       end
 
-      if @line && @beg_column && @end_column && @beg_column < @end_column
+      if @snippet && @beg_column && @end_column && @beg_column < @end_column
         return {
           first_lineno: @beg_lineno,
           first_column: @beg_column,
           last_lineno: @end_lineno,
           last_column: @end_column,
-          line: @line,
+          snippet: @snippet,
         }
       else
         return nil
@@ -135,10 +136,10 @@ module ErrorHighlight
       lines = @fetch[lineno, @node.last_lineno]
       if mid == :[] && lines.match(/\G\s*(\[(?:\s*\])?)/, nd_recv.last_column)
         @beg_column = $~.begin(1)
-        @line = lines[/.*\n/]
+        @snippet = lines[/.*\n/]
         @beg_lineno = @end_lineno = lineno
         if nd_args
-          if nd_recv.last_lineno == nd_args.last_lineno && @line.match(/\s*\]/, nd_args.last_column)
+          if nd_recv.last_lineno == nd_args.last_lineno && @snippet.match(/\s*\]/, nd_args.last_column)
             @end_column = $~.end(0)
           end
         else
@@ -152,15 +153,15 @@ module ErrorHighlight
         @end_column = $~.end(3)
         if i = lines[..@beg_column].rindex("\n")
           @beg_lineno = @end_lineno = lineno + lines[..@beg_column].count("\n")
-          @line = lines[i + 1..]
+          @snippet = lines[i + 1..]
           @beg_column -= i + 1
           @end_column -= i + 1
         else
-          @line = lines
+          @snippet = lines
           @beg_lineno = @end_lineno = lineno
         end
       elsif mid.to_s =~ /\A\W+\z/ && lines.match(/\G\s*(#{ Regexp.quote(mid) })=.*\n/, nd_recv.last_column)
-        @line = $` + $&
+        @snippet = $` + $&
         @beg_column = $~.begin(1)
         @end_column = $~.end(1)
       end
@@ -192,16 +193,16 @@ module ErrorHighlight
       nd_recv, mid, nd_args = @node.children
       *nd_args, _nd_last_arg, _nil = nd_args.children
       fetch_line(nd_recv.last_lineno)
-      if mid == :[]= && @line.match(/\G\s*(\[)/, nd_recv.last_column)
+      if mid == :[]= && @snippet.match(/\G\s*(\[)/, nd_recv.last_column)
         @beg_column = $~.begin(1)
         args_last_column = $~.end(0)
         if nd_args.last && nd_recv.last_lineno == nd_args.last.last_lineno
           args_last_column = nd_args.last.last_column
         end
-        if @line.match(/\s*\]\s*=/, args_last_column)
+        if @snippet.match(/\s*\]\s*=/, args_last_column)
           @end_column = $~.end(0)
         end
-      elsif @line.match(/\G\s*(\.\s*#{ Regexp.quote(mid.to_s.sub(/=\z/, "")) }\s*=)/, nd_recv.last_column)
+      elsif @snippet.match(/\G\s*(\.\s*#{ Regexp.quote(mid.to_s.sub(/=\z/, "")) }\s*=)/, nd_recv.last_column)
         @beg_column = $~.begin(1)
         @end_column = $~.end(1)
       end
@@ -217,7 +218,7 @@ module ErrorHighlight
     def spot_attrasgn_for_args
       nd_recv, mid, nd_args = @node.children
       fetch_line(nd_recv.last_lineno)
-      if mid == :[]= && @line.match(/\G\s*\[/, nd_recv.last_column)
+      if mid == :[]= && @snippet.match(/\G\s*\[/, nd_recv.last_column)
         @beg_column = $~.end(0)
         if nd_recv.last_lineno == nd_args.last_lineno
           @end_column = nd_args.last_column
@@ -239,13 +240,13 @@ module ErrorHighlight
       fetch_line(nd_recv.last_lineno)
       if nd_arg
         # binary operator
-        if @line.match(/\G\s*(#{ Regexp.quote(op) })/, nd_recv.last_column)
+        if @snippet.match(/\G\s*(#{ Regexp.quote(op) })/, nd_recv.last_column)
           @beg_column = $~.begin(1)
           @end_column = $~.end(1)
         end
       else
         # unary operator
-        if @line[...nd_recv.first_column].match(/(#{ Regexp.quote(op.to_s.sub(/@\z/, "")) })\s*\(?\s*\z/)
+        if @snippet[...nd_recv.first_column].match(/(#{ Regexp.quote(op.to_s.sub(/@\z/, "")) })\s*\(?\s*\z/)
           @beg_column = $~.begin(1)
           @end_column = $~.end(1)
         end
@@ -273,7 +274,7 @@ module ErrorHighlight
     def spot_fcall_for_name
       mid, _nd_args = @node.children
       fetch_line(@node.first_lineno)
-      if @line.match(/(#{ Regexp.quote(mid) })/, @node.first_column)
+      if @snippet.match(/(#{ Regexp.quote(mid) })/, @node.first_column)
         @beg_column = $~.begin(1)
         @end_column = $~.end(1)
       end
@@ -315,13 +316,13 @@ module ErrorHighlight
     def spot_op_asgn1_for_name
       nd_recv, op, nd_args, _nd_rhs = @node.children
       fetch_line(nd_recv.last_lineno)
-      if @line.match(/\G\s*(\[)/, nd_recv.last_column)
+      if @snippet.match(/\G\s*(\[)/, nd_recv.last_column)
         bracket_beg_column = $~.begin(1)
         args_last_column = $~.end(0)
         if nd_args && nd_recv.last_lineno == nd_args.last_lineno
           args_last_column = nd_args.last_column
         end
-        if @line.match(/\s*\](\s*)(#{ Regexp.quote(op) })=()/, args_last_column)
+        if @snippet.match(/\s*\](\s*)(#{ Regexp.quote(op) })=()/, args_last_column)
           case @name
           when :[], :[]=
             @beg_column = bracket_beg_column
@@ -340,7 +341,7 @@ module ErrorHighlight
     def spot_op_asgn1_for_args
       nd_recv, mid, nd_args, nd_rhs = @node.children
       fetch_line(nd_recv.last_lineno)
-      if mid == :[]= && @line.match(/\G\s*\[/, nd_recv.last_column)
+      if mid == :[]= && @snippet.match(/\G\s*\[/, nd_recv.last_column)
         @beg_column = $~.end(0)
         if nd_recv.last_lineno == nd_rhs.last_lineno
           @end_column = nd_rhs.last_column
@@ -362,7 +363,7 @@ module ErrorHighlight
     def spot_op_asgn2_for_name
       nd_recv, _qcall, attr, op, _nd_rhs = @node.children
       fetch_line(nd_recv.last_lineno)
-      if @line.match(/\G\s*(\.)\s*#{ Regexp.quote(attr) }()\s*(#{ Regexp.quote(op) })(=)/, nd_recv.last_column)
+      if @snippet.match(/\G\s*(\.)\s*#{ Regexp.quote(attr) }()\s*(#{ Regexp.quote(op) })(=)/, nd_recv.last_column)
         case @name
         when attr
           @beg_column = $~.begin(1)
@@ -399,8 +400,8 @@ module ErrorHighlight
         @beg_column = nd_parent.last_column
         @end_column = @node.last_column
       else
-        @line = @fetch[@node.last_lineno]
-        if @line[...@node.last_column].match(/#{ Regexp.quote(const) }\z/)
+        @snippet = @fetch[@node.last_lineno]
+        if @snippet[...@node.last_column].match(/#{ Regexp.quote(const) }\z/)
           @beg_column = $~.begin(0)
           @end_column = $~.end(0)
         end
@@ -414,8 +415,8 @@ module ErrorHighlight
       nd_lhs, op, _nd_rhs = @node.children
       *nd_parent_lhs, _const = nd_lhs.children
       if @name == op
-        @line = @fetch[nd_lhs.last_lineno]
-        if @line.match(/\G\s*(#{ Regexp.quote(op) })=/, nd_lhs.last_column)
+        @snippet = @fetch[nd_lhs.last_lineno]
+        if @snippet.match(/\G\s*(#{ Regexp.quote(op) })=/, nd_lhs.last_column)
           @beg_column = $~.begin(1)
           @end_column = $~.end(1)
         end
@@ -424,12 +425,12 @@ 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
-            @line = @fetch[nd_lhs.last_lineno]
+            @snippet = @fetch[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
-            @line = @fetch[nd_lhs.last_lineno]
+            @snippet = @fetch[nd_lhs.last_lineno]
             @beg_column = nd_parent_lhs.last.last_column
           end
         end
@@ -438,7 +439,7 @@ module ErrorHighlight
 
     def fetch_line(lineno)
       @beg_lineno = @end_lineno = lineno
-      @line = @fetch[lineno]
+      @snippet = @fetch[lineno]
     end
   end
 

data/lib/error_highlight/core_ext.rb

@@ -1,5 +1,10 @@
+require_relative "formatter"
+
 module ErrorHighlight
   module CoreExt
+    # This is a marker to let `DidYouMean::Correctable#original_message` skip
+    # the following method definition of `to_s`.
+    # See https://github.com/ruby/did_you_mean/pull/152
     SKIP_TO_S_FOR_SUPER_LOOKUP = true
     private_constant :SKIP_TO_S_FOR_SUPER_LOOKUP
 
@@ -16,23 +21,19 @@ module ErrorHighlight
 
         case self
         when NoMethodError, NameError
-          point = :name
+          opts[:point_type] = :name
           opts[:name] = name
         when TypeError, ArgumentError
-          point = :args
+          opts[:point_type] = :args
         end
 
-        spot = ErrorHighlight.spot(node, point, **opts) do |lineno, last_lineno|
-          last_lineno ||= lineno
-          node.script_lines[lineno - 1 .. last_lineno - 1].join("")
-        end
+        spot = ErrorHighlight.spot(node, **opts)
 
       rescue Errno::ENOENT
       end
 
       if spot
-        marker = " " * spot[:first_column] + "^" * (spot[:last_column] - spot[:first_column])
-        points = "\n\n#{ spot[:line] }#{ marker }"
+        points = ErrorHighlight.formatter.message_for(spot)
         msg << points if !msg.include?(points)
       end
 
@@ -42,7 +43,8 @@ module ErrorHighlight
 
   NameError.prepend(CoreExt)
 
-  # temporarily disabled
+  # The extension for TypeError/ArgumentError is temporarily disabled due to many test failures
+
   #TypeError.prepend(CoreExt)
   #ArgumentError.prepend(CoreExt)
 end

data/lib/error_highlight/formatter.rb

@@ -0,0 +1,24 @@
+module ErrorHighlight
+  class DefaultFormatter
+    def message_for(spot)
+      # currently only a one-line code snippet is supported
+      if spot[:first_lineno] == spot[:last_lineno]
+        marker = " " * spot[:first_column] + "^" * (spot[:last_column] - spot[:first_column])
+
+        "\n\n#{ spot[:snippet] }#{ marker }"
+      else
+        ""
+      end
+    end
+  end
+
+  def self.formatter
+    @@formatter
+  end
+
+  def self.formatter=(formatter)
+    @@formatter = formatter
+  end
+
+  self.formatter = DefaultFormatter.new
+end

data/lib/error_highlight/version.rb

@@ -1,3 +1,3 @@
 module ErrorHighlight
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: error_highlight
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Yusuke Endoh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-29 00:00:00.000000000 Z
+date: 2021-06-30 00:00:00.000000000 Z
 dependencies: []
 description: The gem enhances Exception#message by adding a short explanation where
   the exception is raised
@@ -28,6 +28,7 @@ files:
 - 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:
@@ -48,7 +49,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.0.dev
+rubygems_version: 3.2.15
 signing_key: 
 specification_version: 4
 summary: Shows a one-line code snippet with an underline in the error backtrace