render_me_pretty 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5e982d58b2b59ca91a4713eeb1720ba73fcc0fe6c23ad0052ec54fa8c80adde
-  data.tar.gz: 2b791ee128231df293c58fa55c064d1cae60df140baf6460c38f68446325f04a
+  metadata.gz: 9175cf8f3c94175794b0bc0f5ed0ef8e9620193889d9fb17da206bd1eda235b9
+  data.tar.gz: aa14dc5c61c60629ab3e6871a65c9a80e2ec51523e0bfd252aba1f3401949668
 SHA512:
-  metadata.gz: '085a42766665d911e15928aa5026d3bc95aa595030a92d20340222b0661750dd5b24ae95884310828b67952cd3b0b697c545d2ef470d5b6ee9a6d811621fb1ba'
-  data.tar.gz: '0943c0fb992da2d40e00b2d4242c70694bca5195672eea6e4164a19fd32cf505f6918cf9b7e84ed9e0b594c6a47defc8ce9b6e06753c767181ba7c6869b6267d'
+  metadata.gz: 40315ff34828109eca1823fa9e4238021fc333d2311d8b22cc0d752b2b962d7cf53114b146737ba2954fcb8d52bbffdaadaae2de9fcf266f56845450dec2ce60
+  data.tar.gz: a9067cc69cb6316cd37af1dd0d9175c18402d07c71e33afac2f04a0c31173134fa5247d0f47b87768eae5dbf0d4593ceaaa1a713bf65d289fbb0b1b8e14aef08

data/CHANGELOG.md

@@ -3,6 +3,10 @@
 All notable changes to this project will be documented in this file.
 This project *tries* to adhere to [Semantic Versioning](http://semver.org/), even before v1.0.
 
+## [0.6.0]
+- Handle SyntaxError errors correctly
+- refactor into MainErrorHandler and SyntaxError classes
+
 ## [0.5.0]
 - fix find_template_error_line
 - remove some of the filtering for backtrace lines

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    render_me_pretty (0.3.0)
+    render_me_pretty (0.6.0)
       activesupport
       colorize
       tilt

data/lib/render_me_pretty/erb.rb

@@ -43,6 +43,10 @@ require 'tilt/erb'
 
 module RenderMePretty
   class Erb
+    autoload :BaseHandler, 'render_me_pretty/erb/base_handler'
+    autoload :SyntaxErrorHandler, "render_me_pretty/erb/syntax_error_handler"
+    autoload :MainErrorHandler, "render_me_pretty/erb/main_error_handler"
+
     def initialize(path, variables={})
       @path = path
       @init_vars = variables
@@ -76,47 +80,28 @@ module RenderMePretty
       end
     end
 
-    # handles Tilt error
-    def handle_exception(e)
-      error_line = find_template_error_line(e.backtrace)
-      error_line_number = error_line.split(':')[1].to_i
-      pretty_error(e, error_line_number)
-    end
-
-    # For Tilt, first line of the baacktrace that contains the path of the file
-    # we're rendeirng has the line number. Example:
+    # Handles Tilt error in prettier manner.
+    #
+    # When there's a syntax error Tilt does not include the line nubmer of the
+    # error in the backtrace it is instead included in the e.message itself.
+    #
+    # When for other errors the line_number is included in the backtrace.
     #
-    #   spec/fixtures/invalid.erb:2:in `block in singleton class'
-    #   error_info = e.backtrace[0]
-    def find_template_error_line(lines)
-      lines.select do |line|
-        line.include?(@path)
-      end.first
+    # Refer to specs and uncomment puts out to see the different types of errors.
+    def handle_exception(e)
+      # puts "*" * 30
+      # puts e.class.to_s.colorize(:cyan)
+      # puts e.message.colorize(:cyan)
+      # puts e.backtrace
+      # puts "*" * 30
+      handler = e.is_a?(SyntaxError) ?
+                  SyntaxErrorHandler.new(@path, e) :
+                  MainErrorHandler.new(@path, e)
+      io = handler.handle
+      print_result(io)
     end
 
-
-    def pretty_error(e, line)
-      pretty_path = @path.sub(/^\.\//, '')
-      io = StringIO.new
-      io.puts "#{e.class}: #{e.message}"
-      io.puts "Error evaluating ERB template on line #{line.to_s.colorize(:red)} of: #{pretty_path}:"
-
-      template = IO.read(@path)
-      template_lines = template.split("\n")
-      context = 5 # lines of context
-      top, bottom = [line-context-1, 0].max, line+context-1
-      spacing = template_lines.size.to_s.size
-      template_lines[top..bottom].each_with_index do |line_content, index|
-        line_number = top+index+1
-        if line_number == line
-          io.printf("%#{spacing}d %s\n".colorize(:red), line_number, line_content)
-        else
-          io.printf("%#{spacing}d %s\n", line_number, line_content)
-        end
-      end
-
-      io.puts backtrace_lines(e)
-
+    def print_result(io)
       if ENV['TEST']
         io.string
       else

data/lib/render_me_pretty/erb/base_handler.rb

@@ -0,0 +1,75 @@
+class RenderMePretty::Erb
+  class BaseHandler
+    def initialize(path, exception)
+      @path = path
+      @exception = exception
+    end
+
+    def pretty_trace(error_line_number, full_message=true)
+      io = StringIO.new
+
+      message = full_message ? ": #{@exception.message}" : ""
+      io.puts "#{@exception.class}#{message}".colorize(:red)
+
+      pretty_path = @path.sub(/^\.\//, '')
+      io.puts "Error evaluating ERB template on line #{error_line_number.to_s.colorize(:red)} of: #{pretty_path}:"
+
+      context = 5 # lines of context
+      top, bottom = [error_line_number-context-1, 0].max, error_line_number+context-1
+
+      lines = IO.read(@path).split("\n")
+      spacing = lines.size.to_s.size
+      lines[top..bottom].each_with_index do |line_content, index|
+        current_line_number = top+index+1
+        if current_line_number == error_line_number
+          io.printf("%#{spacing}d %s\n".colorize(:red), current_line_number, line_content)
+        else
+          io.printf("%#{spacing}d %s\n", current_line_number, line_content)
+        end
+      end
+
+      io.puts backtrace_lines
+      io
+    end
+
+    # Method produces a filtered original stack trace that can be appended to
+    # the pretty backtrace output.
+    #
+    # It parses the original backtrace that looks something like this:
+    #
+    #   (erb):380:in `get_binding'
+    #   /Users/tung/.rbenv/versions/2.5.0/lib/ruby/2.5.0/erb.rb:885:in `eval'
+    #   /Users/tung/.rbenv/versions/2.5.0/lib/ruby/2.5.0/erb.rb:885:in `result'
+    #   /Users/tung/src/tongueroo/lono/vendor/render_me_pretty/lib/render_me_pretty/erb.rb:67:in `render'
+    #   /Users/tung/src/tongueroo/lono/vendor/render_me_pretty/lib/render_me_pretty.rb:11:in `result'
+    #   /Users/tung/src/tongueroo/lono/lib/lono/template/template.rb:32:in `build'
+    #   /Users/tung/src/tongueroo/lono/lib/lono/template/dsl.rb:82:in `block in build_templates'
+    #   /Users/tung/src/tongueroo/lono/lib/lono/template/dsl.rb:81:in `each'
+    def backtrace_lines
+      full = ENV['FULL_BACKTRACE']
+      if full
+        lines = @exception.backtrace
+      else
+        lines = @exception.backtrace
+        # This filtering business makes is hiding useful info.
+        # Think it was needed for ERB but Tilt provides a better stack trace.
+        # Commenting out for now.
+
+        # filter out internal lines
+        # removal_index = lines.find_index { |l| l =~ %r[lib/render_me_pretty] }
+        # lines = lines[removal_index..-1] # remove leading lines above the lib/
+          # render_me_pretty lines by keeping lines past the removal index
+        # lines.reject! { |l| l =~ %r[lib/render_me_pretty] } # now filter out
+          # render_me_pretty lines
+        lines = lines[0..7] # keep 8 lines
+      end
+      lines[0] = lines[0].colorize(:red)
+
+      # header
+      lines.unshift "\nOriginal backtrace#{full ? '' : ' (last 8 lines)'}:"
+      # footer
+      lines << "\nRe-run with FULL_BACKTRACE=1 to see all lines"
+      lines.join("\n")
+    end
+  end
+end

data/lib/render_me_pretty/erb/main_error_handler.rb

@@ -0,0 +1,21 @@
+class RenderMePretty::Erb
+  class MainErrorHandler < BaseHandler
+    def handle
+      line_number = find_line_number
+      pretty_trace(line_number, full_message=true) # returns StringIO
+    end
+
+    # For general Tilt errors first line of the backtrace that contains the path
+    # of the file we're rendeirng and has the line number. Example:
+    #
+    #   spec/fixtures/invalid.erb:2:in `block in singleton class'
+    #   error_info = e.backtrace[0]
+    def find_line_number
+      lines = @exception.backtrace
+      error_line = lines.select do |line|
+        line.include?(@path)
+      end.first
+      error_line.split(':')[1].to_i
+    end
+  end
+end

data/lib/render_me_pretty/erb/syntax_error_handler.rb

@@ -0,0 +1,26 @@
+class RenderMePretty::Erb
+  class SyntaxErrorHandler < BaseHandler
+    def handle
+      line_number = find_line_number
+      pretty_trace(line_number, full_message=false) # returns StringIO
+    end
+
+    # spec/fixtures/invalid/syntax.erb:2: syntax error, unexpected ';', expecting ']'
+    # );  if ENV['TEST' ; _erbout.<<(-" missing ending...
+    #                   ^
+    # spec/fixtures/invalid/syntax.erb:12: syntax error, unexpected keyword_end, expecting end-of-input
+    # end;end;end;end
+    #             ^~~
+    #
+    # We will only find the first line number for the error.
+    def find_line_number
+      pattern = Regexp.new("#{@path}:(\\\d+): syntax error")
+      lines = @exception.message.split("\n")
+      found_line = lines.find do |line|
+        line.match(pattern)
+      end
+      md = found_line.match(pattern)
+      md[1].to_i # line_number
+    end
+  end
+end

data/lib/render_me_pretty/version.rb

@@ -1,3 +1,3 @@
 module RenderMePretty
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: render_me_pretty
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-16 00:00:00.000000000 Z
+date: 2018-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -112,6 +112,9 @@ files:
 - bin/setup
 - lib/render_me_pretty.rb
 - lib/render_me_pretty/erb.rb
+- lib/render_me_pretty/erb/base_handler.rb
+- lib/render_me_pretty/erb/main_error_handler.rb
+- lib/render_me_pretty/erb/syntax_error_handler.rb
 - lib/render_me_pretty/version.rb
 - render_me_pretty.gemspec
 - tilt_examples.rb