render_me_pretty 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0ca366dbc0b626c3bd1fa15b7d83f8d29ab4b22a0eabd35dc6d1c68604b0925
-  data.tar.gz: 18a6fbec659aa7d6fde4053277aa10d5836d7703d38e2b9b29e78399a921b264
+  metadata.gz: 5fca5bd4ed5c7502ec8b72669e5fced039e90b8e4f1cdb6f47fdaab6f289e247
+  data.tar.gz: 26ecbd9090b108e5baf921cec068a06a2ac4057232d984792304e49d0d038304
 SHA512:
-  metadata.gz: 71a16eef148da71913f34478c8981915f8844e4586344771fd490d21f61c7f5cbd3a22d83f5b61deedad188f04b696372cca8b8185687ab9e44e058751554a36
-  data.tar.gz: 6e68c1e4fa8c5d1fd0e133b1e4d0ec44d708deaccd888b5ba23fadd49cec30d74b1918b6d48de921be49face3ed28013309d0bfac6695515f10dcb40904743a6
+  metadata.gz: bb38911b2da29bc35e67d648d7de31b17b74cdfd0b7a3b97bfbb6419a641d884c77d063d84ba9f4abd195f2fc6ebf7915e598b3b9b2b6ff18297e2cd6a6f601b
+  data.tar.gz: 74a63b170fcab819827e3f808f0b14c25925b162c123b9b7f519c39b2b77e07a858fe38c351fa3e08cfbc4ce6a52c5c70dc3a687f069993bc6348e8179ca253c

data/CHANGELOG.md

@@ -3,6 +3,14 @@
 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.4.0]
+- fix erb and context definitions, fix bug with empty variables={}
+- improve original backtrace info, colorize exact line
+
+## [0.3.0]
+- fix bug with empty variables={}
+- fix erb and context definitions
+
 ## [0.2.0]
 - add RenderMePretty.result convenience class method
 

data/Gemfile.lock

@@ -1,14 +1,15 @@
 PATH
   remote: .
   specs:
-    render_me_pretty (0.1.0)
+    render_me_pretty (0.3.0)
       activesupport
       colorize
+      tilt
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.1.4)
+    activesupport (5.1.5)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (~> 0.7)
       minitest (~> 5.1)
@@ -16,7 +17,7 @@ GEM
     colorize (0.8.1)
     concurrent-ruby (1.0.5)
     diff-lcs (1.3)
-    i18n (0.9.4)
+    i18n (0.9.5)
       concurrent-ruby (~> 1.0)
     minitest (5.11.3)
     rake (12.3.0)
@@ -34,6 +35,7 @@ GEM
       rspec-support (~> 3.7.0)
     rspec-support (3.7.1)
     thread_safe (0.3.6)
+    tilt (2.0.8)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
 

data/README.md

@@ -45,6 +45,26 @@ There's also a convenience class method:
 RenderMePretty.result("/path/to/tempate.erb", a: 5)
 ```
 
+### Custom Context
+
+```ruby
+person = Person.new("tung")
+erb = RenderMePretty::Erb.new("/path/to/tempate.erb", a: 3, context: person) } # passing context here
+erb.render(a: 4)
+
+person = Person.new("tung")
+erb = RenderMePretty::Erb.new("/path/to/tempate.erb", a: 3) }
+erb.render(person, a: 4) # passing context here
+```
+
+The context's methods and instance variables are available in the ERB template. Variables passed at initialization time to `RenderMePretty::Erb.new` or at call time for `render` be set as instance variables to a clone of the original context object.
+
+So in the case above, if there was an `@a` instance variable in the Person object, it will not get respected. Instead the value would be `@a = 4`.
+
+### Context
+
+You can pass in a context object also.  Examples:
+
 A few more examples are in the [erb_spec.rb](spec/lib/render_me_pretty/erb_spec.rb)
 
 ## Installation

data/lib/render_me_pretty.rb

@@ -1,11 +1,12 @@
 require "render_me_pretty/version"
+require "active_support/core_ext/string"
+require "colorize"
 
 module RenderMePretty
   autoload :Erb, 'render_me_pretty/erb'
-  autoload :Context, 'render_me_pretty/context'
 
-  def self.result(path, variables={})
-    erb = Erb.new(path, variables={})
+  def result(path, variables={})
+    erb = Erb.new(path, variables)
     erb.render
   end
 

data/lib/render_me_pretty/erb.rb

@@ -1,30 +1,154 @@
+=begin
+## Usage examples:
+
+Given an example template /path/to/template.erb that contains:
+
+  a: <%= @a %>
+
+### Variables at initialization
+
+  erb = RenderMePretty::Erb.new("/path/to/template.erb", a: 1)
+  erb.render
+
+Result: a: 1
+
+### Variables at render time
+
+  erb = RenderMePretty::Erb.new("/path/to/template.erb")
+  erb.render(a: 2)
+
+Result: a: 2
+
+### Variables at both initialization and render time:
+
+  erb = RenderMePretty::Erb.new("/path/to/template.erb", a: 3)
+  erb.render(a: "override", a: 4)
+
+Result: a: 4
+
+Variables at render time will override variables at initialization time.
+
+## Context Scope
+
+If you want to use your own context object, pass it as a variable.  The context variable is specially treated as a context object.  Example:
+
+  person = Person.new # must implement get_binding
+  erb = RenderMePretty::Erb.new("/path/to/template.erb")
+  erb.render(context: person, a: 2)
+
+The context will be `person`.  So person methods and instance variables will be available in the ERB templates.
+
+=end
+require 'tilt/erb'
+
 module RenderMePretty
-  class Context
-    def initialize(hash={})
-      # http://stackoverflow.com/questions/1338960/ruby-templates-how-to-pass-variables-into-inlined-erb
-      hash.each do |key, value|
-        instance_variable_set('@' + key.to_s, value)
-      end
+  class Erb
+    def initialize(path, variables={})
+      @path = path
+      @init_vars = variables
+      @context = variables.delete(:context)
     end
 
-    def override_variables!(vars)
-      vars.each do |key, value|
-        instance_variable_set('@' + key.to_s, value)
+    # Usage:
+    #
+    #   render(context, a: 1, b: 2)
+    #   render(a: 1, b: 2)
+    #   render
+    def render(*args)
+      if args.last.is_a?(Hash)
+        render_vars = args.pop
+        @init_vars = @init_vars.merge(render_vars)
+      end
+      context = args[0]
+      context ||= @context || Object.new
+
+      context = context.clone # so we dont stomp the original object
+      # override context's instance variables with init and render vars.
+      @init_vars.each do |key, value|
+        context.instance_variable_set('@' + key.to_s, value)
+      end
+
+      template = Tilt::ERBTemplate.new(@path)
+      begin
+        template.render(context)
+      rescue Exception => e
+        handle_exception(e)
       end
     end
 
-    def get_binding
-      binding
+    # handles Tilt error
+    def handle_exception(e)
+      # first line of the baacktrace for Tilt has the line number
+      # spec/fixtures/invalid.erb:2:in `block in singleton class'
+      error_info = e.backtrace[0]
+      error_line_number = error_info.split(':')[1].to_i
+      pretty_error(e, error_line_number)
     end
 
-    def self.load_helpers(base_folder)
-      Dir.glob("#{base_folder}/**/*_helper.rb").each do |path|
-        relative_path = path.sub("#{base_folder}/", "")
-        class_name = File.basename(relative_path, '.rb').classify
+    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}:"
 
-        require path
-        include const_get(class_name)
+      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)
+
+      if ENV['TEST']
+        io.string
+      else
+        puts io.string
+        exit 1
+      end
+    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(e)
+      full = ENV['FULL_BACKTRACE']
+      if full
+        lines = e.backtrace
+      else
+        lines = e.backtrace
+        # 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
+        lines[0] = lines[0].colorize(:red)
+      end
+
+      # header
+      lines.unshift "\nOriginal filtered backtrace#{full ? '' : ' (last 8 lines)'}:"
+      # footer
+      lines << "\nRe-run with FULL_STACK_TRACE=1 to see all lines"
+      lines.join("\n")
     end
   end
 end

data/lib/render_me_pretty/version.rb

@@ -1,3 +1,3 @@
 module RenderMePretty
-  VERSION = "0.2.0"
+  VERSION = "0.4.0"
 end

data/render_me_pretty.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "activesupport"
   spec.add_dependency "colorize"
+  spec.add_dependency "tilt"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: render_me_pretty
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-13 00:00:00.000000000 Z
+date: 2018-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: tilt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -97,7 +111,6 @@ files:
 - bin/console
 - bin/setup
 - lib/render_me_pretty.rb
-- lib/render_me_pretty/context.rb
 - lib/render_me_pretty/erb.rb
 - lib/render_me_pretty/version.rb
 - render_me_pretty.gemspec

data/lib/render_me_pretty/context.rb

@@ -1,115 +0,0 @@
-require "active_support/core_ext/string"
-require "colorize"
-
-=begin
-## Usage examples:
-
-Given an example template /path/to/template.erb that contains:
-
-  a: <%= @a %>
-
-### Variables at initialization
-
-  erb = RenderMePretty::Erb.new("/path/to/template.erb", a: 1)
-  erb.render
-
-Result: a: 1
-
-### Variables at render time
-
-  erb = RenderMePretty::Erb.new("/path/to/template.erb")
-  erb.render(a: 2)
-
-Result: a: 2
-
-### Variables at both initialization and render time:
-
-  erb = RenderMePretty::Erb.new("/path/to/template.erb", a: 3)
-  erb.render(a: "override", a: 4)
-
-Result: a: 4
-
-Variables at render time will override variables at initialization time.
-
-## Context Helpers
-
-When no context is provided, a built-in context object is created. You can add helpers to the built-in context object with:
-
-  RenderMePretty::Context.load_helpers("lib/helpers")
-
-This loads modules defined in `lib/helpers` folder and adds their methods of the built-in context object. The helper classes must be defined with the following convetion: FooHelper and foo_helper.rb.
-
-Note, helpers will only work with the built-in context scope.  If you are passing in your own context object to be used, then you should handle adding helper methods to that context object yourself.
-
-## Custom Context Scope
-
-A built-in context object is provided for convenience. If you want to use your own context object, pass it as a variable.  The context variable is specially treated as a context object.  Example:
-
-  person = Person.new # must implement get_binding
-  erb = RenderMePretty::Erb.new("/path/to/template.erb")
-  erb.render(context: person, a: 2)
-
-The context will be `person`.  So person methods and instance variables will be available in the ERB templates.
-
-=end
-module RenderMePretty
-  class Erb
-    def initialize(path, variables={})
-      @path = path
-      @variables = variables
-      if variables[:context]
-        @context = variables.delete(:context)
-      else
-        @context = Context.new(variables)
-      end
-    end
-
-    def render(override_vars={})
-      @context.override_variables!(override_vars)
-      template = IO.read(@path)
-      ERB.new(template, nil, "-").result(@context.get_binding)
-    rescue Exception => e
-      handle_exception(e)
-    end
-
-    # How to know where ERB stopped? - https://www.ruby-forum.com/topic/182051
-    # syntax errors have the (erb):xxx info in e.message
-    # undefined variables have (erb):xxx info in e.backtrace
-    def handle_exception(e)
-      error_info = e.message.split("\n").grep(/\(erb\)/)[0]
-      error_info ||= e.backtrace.grep(/\(erb\)/)[0]
-      raise unless error_info # unable to find the (erb):xxx: error line
-
-      line = error_info.split(':')[1].to_i
-      io = StringIO.new
-      io.puts "#{e.class} evaluating ERB template on line #{line.to_s.colorize(:red)} of: #{@path.sub(/^\.\//, '')}"
-
-      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
-
-      # Append the original stack trace also
-      io.puts("\nOriginal backtrace (last 5 lines):")
-      lines = ENV['FULL_STACK_TRACE'] ? e.backtrace : e.backtrace[0..4]
-      io.write(lines.join("\n"))
-      io.puts("\nRe-run with FULL_STACK_TRACE=1 to see all lines")
-
-      if ENV['TEST']
-        io.string
-      else
-        puts io.string
-        exit 1
-      end
-    end
-  end
-end