error_highlight 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5eb06bb7a0af000c582a2ae98fb4401652556c10cd756a1cba8d68951c4b60b9
-  data.tar.gz: 4fd7da0b60979f72f250c5044af20a8d7badd37776d2b6e7ba75b960f72e0a90
+  metadata.gz: 39dd627c1efbe9ac9572d6173babe5dd142d46c7f5e012dc86941216d2f82c29
+  data.tar.gz: f1f74a8453bf72581f2153762094a439620d1abcbdca93e648bf14827f26728c
 SHA512:
-  metadata.gz: 475126fb1511ea9e9c25d966c778931c4d2b51ae91658703c0f7d625f536788afad4645b1ae4ddecafb5e9a7a4cb99ed84f88a04c58035e9e968db1c2e2ba715
-  data.tar.gz: df639b399fbb96cb0afcb71f78263268558e689eb058f9a1da2f5a7ccb87e682697e1580eadc702c78c801380cf1e7823e0a668b19fd526a9314bc0975e14d9a
+  metadata.gz: 11a923c3ffb586b7662af28d595e11d4b0a890d9f45a168e4442bdc77257ca230c0fca37cc905ed011b23b2ba934dcf7b4d14e02523999fa60f7056c5b7f1637
+  data.tar.gz: 2268b2f56399e14923cee50f2a9625edfcc6db914d044a639ddc98066141266ab17774f1d5c95af55f8a1c05d4ea2e02804758cd219fc98b2a8df768c345b694

data/README.md

@@ -29,7 +29,7 @@ def extract_value(data)
 end
 ```
 
-When `data` is `{ :results => [] }`, the following error messsage is shown:
+When `data` is `{ :results => [] }`, the following error message is shown:
 
 ```
 $ ruby test.rb
@@ -55,13 +55,13 @@ test.rb:2:in `extract_value': undefined method `[]' for nil:NilClass (NoMethodEr
 
 *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).
+You can use the `ErrorHighlight.spot` method to get the snippet data.
+Note that the argument must be a RubyVM::AbstractSyntaxTree::Node object that is created with `keep_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)
+    node = RubyVM::AbstractSyntaxTree.of(caller_locations.first, keep_script_lines: true)
     ErrorHighlight.spot(node)
   end
 end

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")
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.1.0.dev")
 
   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

@@ -21,6 +21,9 @@ module ErrorHighlight
   end
 
   class Spotter
+    class NonAscii < Exception; end
+    private_constant :NonAscii
+
     def initialize(node, point_type: :name, name: nil)
       @node = node
       @point_type = point_type
@@ -31,7 +34,15 @@ module ErrorHighlight
       @multiline = false # Allow multiline spot
 
       @fetch = -> (lineno, last_lineno = lineno) do
-        @node.script_lines[lineno - 1 .. last_lineno - 1].join("")
+        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.
+        # 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?
+
+        snippet
       end
     end
 
@@ -115,6 +126,9 @@ module ErrorHighlight
       else
         return nil
       end
+
+    rescue NonAscii
+      nil
     end
 
     private
@@ -134,7 +148,7 @@ module ErrorHighlight
       nd_recv, mid, nd_args = @node.children
       lineno = nd_recv.last_lineno
       lines = @fetch[lineno, @node.last_lineno]
-      if mid == :[] && lines.match(/\G\s*(\[(?:\s*\])?)/, nd_recv.last_column)
+      if mid == :[] && lines.match(/\G[\s)]*(\[(?:\s*\])?)/, nd_recv.last_column)
         @beg_column = $~.begin(1)
         @snippet = lines[/.*\n/]
         @beg_lineno = @end_lineno = lineno
@@ -143,11 +157,11 @@ module ErrorHighlight
             @end_column = $~.end(0)
           end
         else
-          if lines.match(/\G\s*?\[\s*\]/, nd_recv.last_column)
+          if lines.match(/\G[\s)]*?\[\s*\]/, nd_recv.last_column)
             @end_column = $~.end(0)
           end
         end
-      elsif lines.match(/\G\s*?(\&?\.)(\s*?)(#{ Regexp.quote(mid) }).*\n/, nd_recv.last_column)
+      elsif lines.match(/\G[\s)]*?(\&?\.)(\s*?)(#{ Regexp.quote(mid) }).*\n/, nd_recv.last_column)
         lines = $` + $&
         @beg_column = $~.begin($2.include?("\n") ? 3 : 1)
         @end_column = $~.end(3)
@@ -193,16 +207,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 == :[]= && @snippet.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 @snippet.match(/\s*\]\s*=/, args_last_column)
+        if @snippet.match(/[\s)]*\]\s*=/, args_last_column)
           @end_column = $~.end(0)
         end
-      elsif @snippet.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
@@ -218,7 +232,7 @@ module ErrorHighlight
     def spot_attrasgn_for_args
       nd_recv, mid, nd_args = @node.children
       fetch_line(nd_recv.last_lineno)
-      if mid == :[]= && @snippet.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
@@ -240,7 +254,7 @@ module ErrorHighlight
       fetch_line(nd_recv.last_lineno)
       if nd_arg
         # binary operator
-        if @snippet.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
@@ -316,7 +330,7 @@ module ErrorHighlight
     def spot_op_asgn1_for_name
       nd_recv, op, nd_args, _nd_rhs = @node.children
       fetch_line(nd_recv.last_lineno)
-      if @snippet.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
@@ -363,7 +377,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 @snippet.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)

data/lib/error_highlight/core_ext.rb

@@ -16,7 +16,7 @@ module ErrorHighlight
 
       loc = locs.first
       begin
-        node = RubyVM::AbstractSyntaxTree.of(loc, save_script_lines: true)
+        node = RubyVM::AbstractSyntaxTree.of(loc, keep_script_lines: true)
         opts = {}
 
         case self
@@ -29,7 +29,9 @@ module ErrorHighlight
 
         spot = ErrorHighlight.spot(node, **opts)
 
-      rescue Errno::ENOENT
+      rescue SyntaxError
+      rescue SystemCallError # file not found or something
+      rescue ArgumentError   # eval'ed code
       end
 
       if spot

data/lib/error_highlight/formatter.rb

@@ -1,9 +1,10 @@
 module ErrorHighlight
   class DefaultFormatter
-    def message_for(spot)
+    def self.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])
+        indent = spot[:snippet][0...spot[:first_column]].gsub(/[^\t]/, " ")
+        marker = indent + "^" * (spot[:last_column] - spot[:first_column])
 
         "\n\n#{ spot[:snippet] }#{ marker }"
       else
@@ -13,12 +14,10 @@ module ErrorHighlight
   end
 
   def self.formatter
-    @@formatter
+    Ractor.current[:__error_highlight_formatter__] || DefaultFormatter
   end
 
   def self.formatter=(formatter)
-    @@formatter = formatter
+    Ractor.current[:__error_highlight_formatter__] = formatter
   end
-
-  self.formatter = DefaultFormatter.new
 end

data/lib/error_highlight/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: error_highlight
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Yusuke Endoh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-30 00:00:00.000000000 Z
+date: 2021-12-23 00:00:00.000000000 Z
 dependencies: []
 description: The gem enhances Exception#message by adding a short explanation where
   the exception is raised
@@ -42,14 +42,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.0
+      version: 3.1.0.dev
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.3.1
 signing_key: 
 specification_version: 4
 summary: Shows a one-line code snippet with an underline in the error backtrace