lono 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a9236c10e7fcf57b75bbbb57b7ad87ada43f7c1d
-  data.tar.gz: c453a06115c4263f8955c97e566c5a6261365195
+  metadata.gz: 4bf114ffb03f191da26a05fc80c4709f2eca37e0
+  data.tar.gz: 942454c20cf254b21236a8508aa71ccecd371da4
 SHA512:
-  metadata.gz: dae90a7b3e39be326fedd087551570cfb0b33ce5081befccfa53f14b6e04868735b6b2d1de5c2d463cf66e53ccbffa58e672fb5b730a73307a0f1d797622deb7
-  data.tar.gz: 0bd752bb836cc1567be6be4fb20ebdc8509f7ca068ab59905299ca828764b931f956523bedc8e8309ecec7aafcfed08e57d2bd647edd49b6fbe25d53a546db4d
+  metadata.gz: 4506033e8b011e45aac50e3f1d65ed28990e531d2ff2a39ee036a8587e67f29fe0c69d9128bc79e0d0bd32e733c01a4a95435dd72da7978349fec80cff1d60b0
+  data.tar.gz: 56d90a0893be4bf743154aca21647ada77b9dfef3668a457e33a7b9a6ecc369e13d4a57ac625bf4193d80d4bc06d26cac77ec1f59890f62c8a17d490d02462a2

data/CHANGELOG.md

@@ -3,6 +3,9 @@
 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.
 
+## [1.1.0]
+- useful ERB render error messages
+
 ## [1.0.2]
 - remove blank lines from yaml output
 

data/lib/lono/template.rb

@@ -1,6 +1,6 @@
 require 'erb'
 require 'json'
-require "base64"
+require 'base64'
 
 module Lono
   class Template
@@ -16,7 +16,7 @@ module Lono
     def build
       instance_eval(&@block)
       template = IO.read(@source)
-      erb_result(template)
+      erb_result(@source, template)
     end
 
     def source(path)
@@ -33,7 +33,7 @@ module Lono
       path = "#{@options[:project_root]}/templates/partial/#{path}"
       template = IO.read(path)
       variables(vars)
-      result = erb_result(template)
+      result = erb_result(path, template)
       result = indent(result, options[:indent]) if options[:indent]
       result
     end
@@ -45,15 +45,42 @@ module Lono
       end.join("\n")
     end
 
-    def erb_result(template)
-      ERB.new(template, nil, "-").result(binding)
+    def erb_result(path, template)
+      begin
+        ERB.new(template, nil, "-").result(binding)
+      rescue Exception => e
+        puts e
+
+        # 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.backtrac
+        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
+        puts "Error evaluating ERB template on line #{line.to_s.colorize(:red)} of: #{path.sub(/^\.\//, '')}"
+
+        template_lines = template.split("\n")
+        context = 5 # lines of context
+        top, bottom = [line-context, 0].max, line+context
+        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
+            printf("%#{spacing}d %s\n".colorize(:red), line_number, line_content)
+          else
+            printf("%#{spacing}d %s\n", line_number, line_content)
+          end
+        end
+        exit 1 unless ENV['TEST']
+      end
     end
 
     def user_data(path, vars={})
       path = "#{@options[:project_root]}/templates/user_data/#{path}"
       template = IO.read(path)
       variables(vars)
-      result = erb_result(template)
+      result = erb_result(path, template)
       output = []
       result.split("\n").each do |line|
         output += transform(line)

data/lib/lono/version.rb

@@ -1,3 +1,3 @@
 module Lono
-  VERSION = "1.0.2"
+  VERSION = "1.1.0"
 end

data/spec/lib/lono/template_spec.rb

@@ -0,0 +1,46 @@
+require File.expand_path("../../../spec_helper", __FILE__)
+
+describe Lono::Template do
+  let(:template) do
+    block = Proc.new {}
+    template = Lono::Template.new("output_name.yml", block)
+
+    # override the puts and printf methods within the test
+    def template.messages
+      @messages
+    end
+
+    def template.puts(msg)
+      @messages ||= []
+      @messages << msg
+      nil
+    end
+
+    def template.printf(*args)
+      @messages ||= []
+      @messages << args
+    end
+
+    template
+  end
+
+  context "valid erb template" do
+    it "should be able to lono generate" do
+      template.erb_result("path", "template")
+    end
+  end
+
+  context "invalid erb template" do
+    it "should print out useful error message about undefined variable" do
+      template.erb_result("path", "variable does not exist\n<% variable %>\nanother line")
+      errors = template.messages.grep(/Error evaluating ERB template on line/)
+      expect(errors).not_to be_empty
+    end
+
+    it "should print out useful error message about syntax error" do
+      template.erb_result("path", "<%s dsfds ?%>\nanother line")
+      errors = template.messages.grep(/Error evaluating ERB template on line/)
+      expect(errors).not_to be_empty
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -2,6 +2,8 @@ require "pp"
 require "byebug"
 require "bundler"
 
+ENV['TEST'] = '1'
+
 Bundler.require(:development)
 
 $root = File.expand_path('../../', __FILE__)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lono
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-10 00:00:00.000000000 Z
+date: 2017-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -232,6 +232,7 @@ files:
 - spec/fixtures/cfn.json
 - spec/lib/lono/dsl_spec.rb
 - spec/lib/lono/new_spec.rb
+- spec/lib/lono/template_spec.rb
 - spec/lib/lono_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/tongueroo/lono
@@ -263,5 +264,6 @@ test_files:
 - spec/fixtures/cfn.json
 - spec/lib/lono/dsl_spec.rb
 - spec/lib/lono/new_spec.rb
+- spec/lib/lono/template_spec.rb
 - spec/lib/lono_spec.rb
 - spec/spec_helper.rb