render_me_pretty 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bdea15bc599691050a16495af35770790dd186481e8156f500cef67569bd11a3
-  data.tar.gz: e2019115f4e08b8de0779017621ebe3f7175866091a04a35575d3a51e88f1c32
+  metadata.gz: c0ca366dbc0b626c3bd1fa15b7d83f8d29ab4b22a0eabd35dc6d1c68604b0925
+  data.tar.gz: 18a6fbec659aa7d6fde4053277aa10d5836d7703d38e2b9b29e78399a921b264
 SHA512:
-  metadata.gz: 655f3e4be15080b24946f7e373e653ac56adc2abd2423f087e3dbb7a876f7dbc8103c29d4143b1c1617ffc7166ee92ee13dc07443482ce6ab65014f1fc1b44c5
-  data.tar.gz: 486e06149bb49c56ac8381bc55543eb42297d13c521bf1e7e1f32650f135093705f208be715e14f592b81da5395f8c1435a213fe3070016a843b2f0da037541f
+  metadata.gz: 71a16eef148da71913f34478c8981915f8844e4586344771fd490d21f61c7f5cbd3a22d83f5b61deedad188f04b696372cca8b8185687ab9e44e058751554a36
+  data.tar.gz: 6e68c1e4fa8c5d1fd0e133b1e4d0ec44d708deaccd888b5ba23fadd49cec30d74b1918b6d48de921be49face3ed28013309d0bfac6695515f10dcb40904743a6

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Change Log
+
+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.2.0]
+- add RenderMePretty.result convenience class method
+
+## [0.1.0]
+- initial release
+

data/README.md

@@ -39,7 +39,13 @@ 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)
+There's also a convenience class method:
+
+```ruby
+RenderMePretty.result("/path/to/tempate.erb", a: 5)
+```
+
+A few more examples are in the [erb_spec.rb](spec/lib/render_me_pretty/erb_spec.rb)
 
 ## Installation
 

data/lib/render_me_pretty/context.rb

@@ -0,0 +1,115 @@
+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

data/lib/render_me_pretty/erb.rb

@@ -0,0 +1,30 @@
+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
+    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/lib/render_me_pretty/version.rb

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

data/lib/render_me_pretty.rb

@@ -1,145 +1,13 @@
 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
+  autoload :Erb, 'render_me_pretty/erb'
+  autoload :Context, 'render_me_pretty/context'
 
-      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
+  def self.result(path, variables={})
+    erb = Erb.new(path, variables={})
+    erb.render
   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
+  extend self
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: render_me_pretty
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Tung Nguyen
@@ -89,6 +89,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - README.md
@@ -96,6 +97,8 @@ 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
 - tilt_examples.rb