error_highlight 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f6edc97e3eca88e8281056e7a3d9bceb448c0ac614b742e4ed38908a40e51e01
+  data.tar.gz: 255b537c7d07f8dfd01b747719472e57d24e91703b8df678d655a3fc3f71897d
+SHA512:
+  metadata.gz: a63da67176a0dabd493fdafa1de60155a26696d22ba633d17765b29a359b0e4ffcc30d4806236bf416c828427d32171aca4210bdb1e018e0347e4cefef3e953a
+  data.tar.gz: '08febd90564658489923f2ef0d2aab82a3796e52c7aa2a11ddcd6cc0d1f65abacd9b757b61bbb36bb59d7cf0e0c1eea820bce6d3b0bad3f771ead27714bc70ee'

data/.github/workflows/ruby.yml

@@ -0,0 +1,27 @@
+name: Ruby
+
+on:
+  pull_request:
+    branches:
+      - 'master'
+  push:
+    branches:
+      - 'master'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [ 'ruby-head' ]
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - name: Bundle install
+      run: |
+        bundle install
+    - name: Run the test suite
+      run: |
+        bundle exec rake TESTOPT=-v

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem "rake", "~> 13.0"
+gem "test-unit", "~> 3.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Yusuke Endoh
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,71 @@
+# ErrorHighlight
+
+## Installation
+
+Ruby 3.1 will ship with this gem and it will automatically be `require`d when a Ruby process starts up. No special setup is required.
+
+Note: This gem works only on MRI and requires Ruby 3.1 or later because it depends on MRI's internal APIs that are available since 3.1.
+
+## Examples
+
+```ruby
+1.time {}
+```
+
+```
+$ ruby test.rb
+test.rb:1:in `<main>': undefined method `time' for 1:Integer (NoMethodError)
+
+1.time {}
+ ^^^^^
+Did you mean?  times
+```
+
+## More example
+
+```ruby
+def extract_value(data)
+  data[:results].first[:value]
+end
+```
+
+When `data` is `{ :results => [] }`, the following error messsage is shown:
+
+```
+$ ruby test.rb
+test.rb:2:in `extract_value': undefined method `[]' for nil:NilClass (NoMethodError)
+
+  data[:results].first[:value]
+                      ^^^^^^^^
+        from test.rb:5:in `<main>'
+```
+
+When `data` is `nil`, it prints:
+
+```
+$ ruby test.rb
+test.rb:2:in `extract_value': undefined method `[]' for nil:NilClass (NoMethodError)
+
+  data[:results].first[:value]
+      ^^^^^^^^^^
+        from test.rb:5:in `<main>'
+```
+
+## 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 {}'
+-e:1:in `<main>': undefined method `time' for 1:Integer (NoMethodError)
+Did you mean?  times
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ruby/error_highlight.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+task default: :test

data/error_highlight.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+begin
+  require_relative "lib/error_highlight/version"
+rescue LoadError # Fallback to load version file in ruby core repository
+  require_relative "version"
+end
+
+Gem::Specification.new do |spec|
+  spec.name          = "error_highlight"
+  spec.version       = ErrorHighlight::VERSION
+  spec.authors       = ["Yusuke Endoh"]
+  spec.email         = ["mame@ruby-lang.org"]
+
+  spec.summary       = 'Shows a one-line code snippet with an underline in the error backtrace'
+  spec.description   = 'The gem enhances Exception#message by adding a short explanation where the exception is raised'
+  spec.homepage      = "https://github.com/ruby/error_highlight"
+
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.1.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)/}) }
+  end
+  spec.require_paths = ["lib"]
+end

data/lib/error_highlight.rb

@@ -0,0 +1,2 @@
+require_relative "error_highlight/base"
+require_relative "error_highlight/core_ext"

data/lib/error_highlight/base.rb

@@ -0,0 +1,446 @@
+require_relative "version"
+
+module ErrorHighlight
+  # Identify the code fragment that seems associated with a given error
+  #
+  # Arguments:
+  #  node: RubyVM::AbstractSyntaxTree::Node
+  #  point: :name | :args
+  #  name: The name associated with the NameError/NoMethodError
+  #  fetch: A block to fetch a specified code line (or lines)
+  #
+  # Returns:
+  #  {
+  #    first_lineno: Integer,
+  #    first_column: Integer,
+  #    last_lineno: Integer,
+  #    last_column: Integer,
+  #    line: String,
+  #  } | nil
+  def self.spot(...)
+    Spotter.new(...).spot
+  end
+
+  class Spotter
+    def initialize(node, point, name: nil, &fetch)
+      @node = node
+      @point = point
+      @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
+    end
+
+    def spot
+      return nil unless @node
+
+      case @node.type
+
+      when :CALL, :QCALL
+        case @point
+        when :name
+          spot_call_for_name
+        when :args
+          spot_call_for_args
+        end
+
+      when :ATTRASGN
+        case @point
+        when :name
+          spot_attrasgn_for_name
+        when :args
+          spot_attrasgn_for_args
+        end
+
+      when :OPCALL
+        case @point
+        when :name
+          spot_opcall_for_name
+        when :args
+          spot_opcall_for_args
+        end
+
+      when :FCALL
+        case @point
+        when :name
+          spot_fcall_for_name
+        when :args
+          spot_fcall_for_args
+        end
+
+      when :VCALL
+        spot_vcall
+
+      when :OP_ASGN1
+        case @point
+        when :name
+          spot_op_asgn1_for_name
+        when :args
+          spot_op_asgn1_for_args
+        end
+
+      when :OP_ASGN2
+        case @point
+        when :name
+          spot_op_asgn2_for_name
+        when :args
+          spot_op_asgn2_for_args
+        end
+
+      when :CONST
+        spot_vcall
+
+      when :COLON2
+        spot_colon2
+
+      when :COLON3
+        spot_vcall
+
+      when :OP_CDECL
+        spot_op_cdecl
+      end
+
+      if @line && @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,
+        }
+      else
+        return nil
+      end
+    end
+
+    private
+
+    # Example:
+    #   x.foo
+    #    ^^^^
+    #   x.foo(42)
+    #    ^^^^
+    #   x&.foo
+    #    ^^^^^
+    #   x[42]
+    #    ^^^^
+    #   x += 1
+    #     ^
+    def spot_call_for_name
+      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)
+        @beg_column = $~.begin(1)
+        @line = 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)
+            @end_column = $~.end(0)
+          end
+        else
+          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)
+        lines = $` + $&
+        @beg_column = $~.begin($2.include?("\n") ? 3 : 1)
+        @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..]
+          @beg_column -= i + 1
+          @end_column -= i + 1
+        else
+          @line = 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 = $` + $&
+        @beg_column = $~.begin(1)
+        @end_column = $~.end(1)
+      end
+    end
+
+    # Example:
+    #   x.foo(42)
+    #         ^^
+    #   x[42]
+    #     ^^
+    #   x += 1
+    #        ^
+    def spot_call_for_args
+      _nd_recv, _mid, nd_args = @node.children
+      if nd_args && nd_args.first_lineno == nd_args.last_lineno
+        fetch_line(nd_args.first_lineno)
+        @beg_column = nd_args.first_column
+        @end_column = nd_args.last_column
+      end
+      # TODO: support @arg
+    end
+
+    # Example:
+    #   x.foo = 1
+    #    ^^^^^^
+    #   x[42] = 1
+    #    ^^^^^^
+    def spot_attrasgn_for_name
+      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)
+        @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)
+          @end_column = $~.end(0)
+        end
+      elsif @line.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
+    end
+
+    # Example:
+    #   x.foo = 1
+    #           ^
+    #   x[42] = 1
+    #     ^^^^^^^
+    #   x[] = 1
+    #     ^^^^^
+    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)
+        @beg_column = $~.end(0)
+        if nd_recv.last_lineno == nd_args.last_lineno
+          @end_column = nd_args.last_column
+        end
+      elsif nd_args && nd_args.first_lineno == nd_args.last_lineno
+        @beg_column = nd_args.first_column
+        @end_column = nd_args.last_column
+      end
+      # TODO: support @arg
+    end
+
+    # Example:
+    #   x + 1
+    #     ^
+    #   +x
+    #   ^
+    def spot_opcall_for_name
+      nd_recv, op, nd_arg = @node.children
+      fetch_line(nd_recv.last_lineno)
+      if nd_arg
+        # binary operator
+        if @line.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/)
+          @beg_column = $~.begin(1)
+          @end_column = $~.end(1)
+        end
+      end
+    end
+
+    # Example:
+    #   x + 1
+    #       ^
+    def spot_opcall_for_args
+      _nd_recv, _op, nd_arg = @node.children
+      if nd_arg && nd_arg.first_lineno == nd_arg.last_lineno
+        # binary operator
+        fetch_line(nd_arg.first_lineno)
+        @beg_column = nd_arg.first_column
+        @end_column = nd_arg.last_column
+      end
+    end
+
+    # Example:
+    #   foo(42)
+    #   ^^^
+    #   foo 42
+    #   ^^^
+    def spot_fcall_for_name
+      mid, _nd_args = @node.children
+      fetch_line(@node.first_lineno)
+      if @line.match(/(#{ Regexp.quote(mid) })/, @node.first_column)
+        @beg_column = $~.begin(1)
+        @end_column = $~.end(1)
+      end
+    end
+
+    # Example:
+    #   foo(42)
+    #       ^^
+    #   foo 42
+    #       ^^
+    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
+      end
+    end
+
+    # Example:
+    #   foo
+    #   ^^^
+    def spot_vcall
+      if @node.first_lineno == @node.last_lineno
+        fetch_line(@node.last_lineno)
+        @beg_column = @node.first_column
+        @end_column = @node.last_column
+      end
+    end
+
+    # Example:
+    #   x[1] += 42
+    #    ^^^    (for [])
+    #   x[1] += 42
+    #        ^  (for +)
+    #   x[1] += 42
+    #    ^^^^^^ (for []=)
+    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)
+        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)
+          case @name
+          when :[], :[]=
+            @beg_column = bracket_beg_column
+            @end_column = $~.begin(@name == :[] ? 1 : 3)
+          when op
+            @beg_column = $~.begin(2)
+            @end_column = $~.end(2)
+          end
+        end
+      end
+    end
+
+    # Example:
+    #   x[1] += 42
+    #     ^^^^^^^^
+    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)
+        @beg_column = $~.end(0)
+        if nd_recv.last_lineno == nd_rhs.last_lineno
+          @end_column = nd_rhs.last_column
+        end
+      elsif nd_args && nd_args.first_lineno == nd_rhs.last_lineno
+        @beg_column = nd_args.first_column
+        @end_column = nd_rhs.last_column
+      end
+      # TODO: support @arg
+    end
+
+    # Example:
+    #   x.foo += 42
+    #    ^^^     (for foo)
+    #   x.foo += 42
+    #         ^  (for +)
+    #   x.foo += 42
+    #    ^^^^^^^ (for foo=)
+    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)
+        case @name
+        when attr
+          @beg_column = $~.begin(1)
+          @end_column = $~.begin(2)
+        when op
+          @beg_column = $~.begin(3)
+          @end_column = $~.end(3)
+        when :"#{ attr }="
+          @beg_column = $~.begin(1)
+          @end_column = $~.end(4)
+        end
+      end
+    end
+
+    # Example:
+    #   x.foo += 42
+    #            ^^
+    def spot_op_asgn2_for_args
+      _nd_recv, _qcall, _attr, _op, nd_rhs = @node.children
+      if nd_rhs.first_lineno == nd_rhs.last_lineno
+        fetch_line(nd_rhs.first_lineno)
+        @beg_column = nd_rhs.first_column
+        @end_column = nd_rhs.last_column
+      end
+    end
+
+    # Example:
+    #   Foo::Bar
+    #      ^^^^^
+    def spot_colon2
+      nd_parent, const = @node.children
+      if nd_parent.last_lineno == @node.last_lineno
+        fetch_line(nd_parent.last_lineno)
+        @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/)
+          @beg_column = $~.begin(0)
+          @end_column = $~.end(0)
+        end
+      end
+    end
+
+    # Example:
+    #   Foo::Bar += 1
+    #      ^^^^^^^^
+    def spot_op_cdecl
+      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)
+          @beg_column = $~.begin(1)
+          @end_column = $~.end(1)
+        end
+      else
+        # constant access error
+        @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]
+            @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]
+            @beg_column = nd_parent_lhs.last.last_column
+          end
+        end
+      end
+    end
+
+    def fetch_line(lineno)
+      @beg_lineno = @end_lineno = lineno
+      @line = @fetch[lineno]
+    end
+  end
+
+  private_constant :Spotter
+end

data/lib/error_highlight/core_ext.rb

@@ -0,0 +1,48 @@
+module ErrorHighlight
+  module CoreExt
+    SKIP_TO_S_FOR_SUPER_LOOKUP = true
+    private_constant :SKIP_TO_S_FOR_SUPER_LOOKUP
+
+    def to_s
+      msg = super.dup
+
+      locs = backtrace_locations
+      return msg unless locs
+
+      loc = locs.first
+      begin
+        node = RubyVM::AbstractSyntaxTree.of(loc, save_script_lines: true)
+        opts = {}
+
+        case self
+        when NoMethodError, NameError
+          point = :name
+          opts[:name] = name
+        when TypeError, ArgumentError
+          point = :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
+
+      rescue Errno::ENOENT
+      end
+
+      if spot
+        marker = " " * spot[:first_column] + "^" * (spot[:last_column] - spot[:first_column])
+        points = "\n\n#{ spot[:line] }#{ marker }"
+        msg << points if !msg.include?(points)
+      end
+
+      msg
+    end
+  end
+
+  NameError.prepend(CoreExt)
+
+  # temporarily disabled
+  #TypeError.prepend(CoreExt)
+  #ArgumentError.prepend(CoreExt)
+end

data/lib/error_highlight/version.rb

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

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: error_highlight
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yusuke Endoh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-06-29 00:00:00.000000000 Z
+dependencies: []
+description: The gem enhances Exception#message by adding a short explanation where
+  the exception is raised
+email:
+- mame@ruby-lang.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".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/version.rb
+homepage: https://github.com/ruby/error_highlight
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.0.dev
+signing_key: 
+specification_version: 4
+summary: Shows a one-line code snippet with an underline in the error backtrace
+test_files: []