render_me_pretty 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bdea15bc599691050a16495af35770790dd186481e8156f500cef67569bd11a3
+  data.tar.gz: e2019115f4e08b8de0779017621ebe3f7175866091a04a35575d3a51e88f1c32
+SHA512:
+  metadata.gz: 655f3e4be15080b24946f7e373e653ac56adc2abd2423f087e3dbb7a876f7dbc8103c29d4143b1c1617ffc7166ee92ee13dc07443482ce6ab65014f1fc1b44c5
+  data.tar.gz: 486e06149bb49c56ac8381bc55543eb42297d13c521bf1e7e1f32650f135093705f208be715e14f592b81da5395f8c1435a213fe3070016a843b2f0da037541f

data/.gitignore

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

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in render_me_pretty.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,50 @@
+PATH
+  remote: .
+  specs:
+    render_me_pretty (0.1.0)
+      activesupport
+      colorize
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.1.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    colorize (0.8.1)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    i18n (0.9.4)
+      concurrent-ruby (~> 1.0)
+    minitest (5.11.3)
+    rake (12.3.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  rake
+  render_me_pretty!
+  rspec
+
+BUNDLED WITH
+   1.16.1

data/README.md

@@ -0,0 +1,64 @@
+# Render Me Pretty
+
+Let's say you have an error in your ERB template:
+
+```
+line 1
+<%= sdsd %>
+line 3
+```
+
+Normally, when render it with ERB you get an error message that looks something like this:
+
+```sh
+ NameError:
+   undefined local variable or method `sdsd' for #<RenderMePretty::Context:0x00007fcda414d358>
+ (erb):2:in `get_binding'
+ ./lib/render_me_pretty.rb:71:in `render'
+ ./spec/lib/render_me_pretty/erb_spec.rb:41:in `block (3 levels) in <top (required)>'
+```
+
+Instead, this library produces an output with an error pointing out the original line in the ERB template like so:
+
+```
+NameError evaluating ERB template on line 2 of: spec/fixtures/invalid.erb
+1 line 1
+2 <%= sdsd %>
+3 line 3
+```
+
+The output also colorizes the error line in red so it stands out.
+
+
+## Usage
+
+Here's a simple example:
+
+```ruby
+erb = RenderMePretty::Erb.new("/path/to/tempate.erb", a: 3) }
+erb.render(a: 4)
+```
+
+A few more examples are in the [erb_spec.rb](spec/lib/erb_spec.rb)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'render_me_pretty'
+```
+
+And then execute:
+
+    $ bundle
+
+## Contributing
+
+Please fork the project and open a pull request! I'd love your pull requests. Contributions are encouraged and welcomed!
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "render_me_pretty"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/render_me_pretty/version.rb

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

data/lib/render_me_pretty.rb

@@ -0,0 +1,145 @@
+require "render_me_pretty/version"
+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
+
+  # http://stackoverflow.com/questions/1338960/ruby-templates-how-to-pass-variables-into-inlined-erb
+  class Context
+    def initialize(hash={})
+      hash.each do |key, value|
+        instance_variable_set('@' + key.to_s, value)
+      end
+    end
+
+    def override_variables!(vars)
+      vars.each do |key, value|
+        instance_variable_set('@' + key.to_s, value)
+      end
+    end
+
+    def get_binding
+      binding
+    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
+
+        require path
+        include const_get(class_name)
+      end
+    end
+  end
+end

data/render_me_pretty.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "render_me_pretty/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "render_me_pretty"
+  spec.version       = RenderMePretty::VERSION
+  spec.authors       = ["Tung Nguyen"]
+  spec.email         = ["tongueroo@gmail.com"]
+
+  spec.summary       = %q{Render ERB template and provide more useful message pointing out the line with the error in the view}
+  spec.homepage      = "https://github.com/tongueroo/render_me_pretty"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport"
+  spec.add_dependency "colorize"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/tilt_examples.rb

@@ -0,0 +1,18 @@
+require 'tilt/erb'
+template = Tilt::ERBTemplate.new('templates/foo.erb')
+joe = Person.find('joe')
+output = template.render(joe, :x => 35, :y => 42)
+# If no scope is provided, the template is evaluated within the context of an object created with Object.new.
+
+# A single Template instance's render method may be called multiple times with different scope and locals arguments. Continuing the previous example, we render the same compiled template but this time in jane's scope:
+
+jane = Person.find('jane')
+output = template.render(jane, :x => 22, :y => nil)
+# Blocks can be passed to render for templates that support running arbitrary ruby code (usually with some form of yield). For instance, assuming the following in foo.erb:
+
+# Hey <%= yield %>!
+# The block passed to render is called on yield:
+
+template = Tilt::ERBTemplate.new('foo.erb')
+template.render { 'Joe' }
+# => "Hey Joe!"

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: render_me_pretty
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tung Nguyen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-02-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: colorize
+  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
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- tongueroo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/render_me_pretty.rb
+- lib/render_me_pretty/version.rb
+- render_me_pretty.gemspec
+- tilt_examples.rb
+homepage: https://github.com/tongueroo/render_me_pretty
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Render ERB template and provide more useful message pointing out the line
+  with the error in the view
+test_files: []