dead_end 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 125719d74f88dcc5d196a1570508bd36d83d7ece6058b029a579da90a70cc099
-  data.tar.gz: 2eea6be22997101b46ff2820dfabaef4e473424a552e7f9c2835e43471c4431b
+  metadata.gz: 8b372fd8bb6cb9f7b3a601fcb32a539ae361fa19e3f64471d6c446564532750c
+  data.tar.gz: fc78d6a4ff9f86663af64dc6acf1bf2a0bced8fded065a2e0b52210e19766496
 SHA512:
-  metadata.gz: 674e35c603ec9ed2a8662e6ee3472381c6108a8734f455d39ef30472e38d13fd08a23cb107333f9ff8353ace614cb6c1f5bcb21e6aeb5384911ad1a61eb1ff58
-  data.tar.gz: 4ed5351764e96b5c95b2c4f68403bd81a3739163ad83d9e473829a1f6571f7e3614b855f56f21f5e8f15434817f7b7e8a947146044d4ac4c4f9314a15cd6b9bf
+  metadata.gz: 5ee131a4f8574bec7a8e9054b4085524cf49692afeb40387144f9461f34323b533944b1c9683b0772c43858ed348fb6eb889ae89ecfb765b0c26b805e93dee4c
+  data.tar.gz: bffe41e67a11e342ad5db8a36b7faa81c1ea24eab2a37bb67c77762cd0be470f12cc55b8baf9e9696e2ed321943eed348328b637220102d2e9e1678c17ef3d18

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## HEAD (unreleased)
 
+## 1.1.0
+
+- Annotate NoMethodError in non-production environments (https://github.com/zombocom/dead_end/pull/46)
+- Do not count trailing if/unless as a keyword (https://github.com/zombocom/dead_end/pull/44)
+
 ## 1.0.2
 
 - Fix bug where empty lines were interpreted to have a zero indentation (https://github.com/zombocom/dead_end/pull/39)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dead_end (1.0.2)
+    dead_end (1.1.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,6 +1,6 @@
 # DeadEnd
 
-An AI powered library to find syntax errors in your source code:
+An error in your code forces you to stop. DeadEnd helps you find those errors to get you back on your way faster.
 
     DeadEnd: Unmatched `end` detected
 
@@ -18,7 +18,7 @@ An AI powered library to find syntax errors in your source code:
 
 ## Installation in your codebase
 
-To automatically search syntax errors when they happen, add this to your Gemfile:
+To automatically annotate errors when they happen, add this to your Gemfile:
 
 ```ruby
 gem 'dead_end'
@@ -44,7 +44,7 @@ If you're using rspec add this to your `.rspec` file:
 
 ## Install the CLI
 
-To get the CLI and manually search for syntax errors, install the gem:
+To get the CLI and manually search for syntax errors (but not automatically annotate them), you can manually install the gem:
 
     $ gem install dead_end
 
@@ -54,7 +54,7 @@ This gives you the CLI command `$ dead_end` for more info run `$ dead_end --help
 
 - Missing `end`:
 
-```
+```ruby
 class Dog
   def bark
     puts "bark"
@@ -68,7 +68,7 @@ end
 
 - Unexpected `end`
 
-```
+```ruby
 class Dog
   def speak
     @sounds.each |sound| # Note the missing `do` here
@@ -81,6 +81,21 @@ end
 
 As well as unmatched `|` and unmatched `}`. These errors can be time consuming to debug because Ruby often only tells you the last line in the file. The command `ruby -wc path/to/file.rb` can narrow it down a little bit, but this library does a better job.
 
+## What other errors does it handle?
+
+In addition to syntax errors, the NoMethodError is annotated to show the line where the error occured, and the surrounding context:
+
+```
+scratch.rb:7:in `call': undefined method `upcase' for nil:NilClass (NoMethodError)
+
+
+  1  class Pet
+  6    def call
+❯ 7      puts "Come here #{@neam.upcase}"
+  8    end
+  9  end
+```
+
 ## Sounds cool, but why isn't this baked into Ruby directly?
 
 I would love to get something like this directly in Ruby, but I first need to prove it's useful. The `did_you_mean` functionality started as a gem that was eventually adopted by a bunch of people and then Ruby core liked it enough that they included it in the source. The goal of this gem is to:
@@ -90,7 +105,7 @@ I would love to get something like this directly in Ruby, but I first need to pr
 
 ## Artificial Inteligence?
 
-This library uses a goal-seeking algorithm similar to that of a path-finding search. For more information [read the blog post about how it works under the hood](https://schneems.com/2020/12/01/squash-unexpectedend-errors-with-syntaxsearch/).
+This library uses a goal-seeking algorithm for syntax error detection similar to that of a path-finding search. For more information [read the blog post about how it works under the hood](https://schneems.com/2020/12/01/squash-unexpectedend-errors-with-syntaxsearch/).
 
 ## How does it detect syntax error locations?
 

data/lib/dead_end/auto.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+#
 require_relative "../dead_end/internals"
 
 # Monkey patch kernel to ensure that all `require` calls call the same
@@ -49,3 +51,49 @@ class Object
   end
 end
 
+module DeadEnd
+  IsProduction = -> {
+    ENV["RAILS_ENV"] == "production" || ENV["RACK_ENV"] == "production"
+  }
+end
+
+# Unlike a syntax error, a NoMethodError can occur hundreds or thousands of times and
+# chew up CPU and other resources. Since this is primarilly a "development" optimization
+# we can attempt to disable this behavior in a production context.
+if !DeadEnd::IsProduction.call
+  class NoMethodError
+    def to_s
+      return super if DeadEnd::IsProduction.call
+
+      file, line, _ = backtrace[0].split(":")
+      return super if !File.exist?(file)
+
+      index = line.to_i - 1
+      source = File.read(file)
+      code_lines = DeadEnd::CodeLine.parse(source)
+
+      block = DeadEnd::CodeBlock.new(lines: code_lines[index])
+      lines = DeadEnd::CaptureCodeContext.new(
+        blocks: block,
+        code_lines: code_lines
+      ).call
+
+      message = super.dup
+      message << $/
+      message << $/
+
+      message << DeadEnd::DisplayCodeWithLineNumbers.new(
+        lines: lines,
+        highlight_lines: block.lines,
+        terminal: self.class.to_tty?
+      ).call
+
+      message << $/
+      message
+    rescue => e
+      puts "DeadEnd Internal error: #{e.message}"
+      puts "DeadEnd Internal backtrace: #{e.backtrace}"
+      super
+    end
+  end
+end

data/lib/dead_end/code_line.rb

@@ -31,6 +31,12 @@ module DeadEnd
   class CodeLine
     TRAILING_SLASH = ("\\" + $/).freeze
 
+    def self.parse(source)
+      source.lines.map.with_index do |line, index|
+        CodeLine.new(line: line, index: index)
+      end
+    end
+
     attr_reader :line, :index, :indent, :original_line
 
     def initialize(line: , index:)
@@ -51,25 +57,29 @@ module DeadEnd
     end
 
     private def lex_detect!
-      lex = LexAll.new(source: line)
+      lex_array = LexAll.new(source: line)
       kw_count = 0
       end_count = 0
-      lex.each do |lex|
+      lex_array.each_with_index do |lex, index|
         next unless lex.type == :on_kw
 
         case lex.token
-        when 'def', 'case', 'for', 'begin', 'class', 'module', 'if', 'unless', 'while', 'until' , 'do'
+        when 'if', 'unless', 'while', 'until'
+          # Only count if/unless when it's not a "trailing" if/unless
+          # https://github.com/ruby/ruby/blob/06b44f819eb7b5ede1ff69cecb25682b56a1d60c/lib/irb/ruby-lex.rb#L374-L375
+          kw_count += 1 if !lex.expr_label?
+        when 'def', 'case', 'for', 'begin', 'class', 'module', 'do'
           kw_count += 1
         when 'end'
           end_count += 1
         end
       end
 
-      @is_comment = lex.detect {|lex| lex.type != :on_sp}&.type == :on_comment
+      @is_comment = lex_array.detect {|lex| lex.type != :on_sp}&.type == :on_comment
       return if @is_comment
       @is_kw = (kw_count - end_count) > 0
       @is_end = (end_count - kw_count) > 0
-      @is_trailing_slash = lex.last.token == TRAILING_SLASH
+      @is_trailing_slash = lex_array.last.token == TRAILING_SLASH
     end
 
     alias :original :original_line

data/lib/dead_end/lex_all.rb

@@ -21,7 +21,7 @@ module DeadEnd
         lineno = @lex.last&.first&.first + 1
       end
 
-      @lex.map! {|(line, _), type, token| LexValue.new(line, _, type, token) }
+      @lex.map! {|(line, _), type, token, state| LexValue.new(line, _, type, token, state) }
     end
 
     def each
@@ -47,11 +47,17 @@ module DeadEnd
     #  lex.type # => :on_indent
     #  lex.token # => "describe"
     class LexValue
-      attr_reader :line, :type, :token
-      def initialize(line, _, type, token)
+      attr_reader :line, :type, :token, :state
+
+      def initialize(line, _, type, token, state)
         @line = line
         @type = type
         @token = token
+        @state = state
+      end
+
+      def expr_label?
+        state.allbits?(Ripper::EXPR_LABEL)
       end
     end
   end

data/lib/dead_end/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DeadEnd
-  VERSION = "1.0.2"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dead_end
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - schneems
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-28 00:00:00.000000000 Z
+date: 2020-12-29 00:00:00.000000000 Z
 dependencies: []
 description: When you get an "unexpected end" in your syntax this gem helps you find
   it