render_me_pretty 0.9.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28f4378bce74504d490fde1c53d18fa5132a9aa5ea072fdde13a322181222325
-  data.tar.gz: 35d9971f8c07a02bf099d2b0a78c6d204fa5a542027399d99d334776366b0615
+  metadata.gz: 80b046fa6c8baf78bd662403f3db8c7d069bcf42f244cc6045763f32b592f075
+  data.tar.gz: d30655c34e425304fab8c46fb8d6ba1fec8b6c886d7fb8d95b8579516888a3bf
 SHA512:
-  metadata.gz: b370e5090fcc8c5c6344caf169562a491ea319d1cc866d4968f5ea659e10009ed17383413181b8657048040e77cc99d8e18e01d9bf04d50fa8f21a885895fcff
-  data.tar.gz: 4f5b87455ae81cb9e3b49f7e1771e1155f5c8a3a6e797e8833616c6dcef6f836f2de99546cf880aeaad3c081345406202f01574652490d7c50095d43b614e54a
+  metadata.gz: 4908d4dfe9b6147284d7ec66f4fce89b2cbeecf186f5a4c93fae1164909921200a2923c6c62f3abef4d075183fd0159cc7e9385d59baef2fdf01df7b796737a3
+  data.tar.gz: b3b036d451a78ede232701541606a0cb1eae094a6f78d64aaaa2924cd4a79e47f4014f5cc9ea715dc6bd7a069f2a52fe484550f5912dcb23e8c4984829d4ddc0

data/CHANGELOG.md

@@ -3,6 +3,11 @@
 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.0.0] - 2024-08-29
+- [#5](https://github.com/tongueroo/render_me_pretty/pull/5) Standardrb
+- [#6](https://github.com/tongueroo/render_me_pretty/pull/6) add mit license
+- [#7](https://github.com/tongueroo/render_me_pretty/pull/7) on_error config option error exit or raise
+
 ## [0.9.0] - 2023-06-06
 - [#2](https://github.com/tongueroo/render_me_pretty/pull/2) require tilt so EMPTY_HASH is defined
 - [#3](https://github.com/tongueroo/render_me_pretty/pull/3) CI: Github Actions Rspec

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) Tung Nguyen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/Rakefile

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

data/lib/render_me_pretty/erb/base_handler.rb

@@ -1,6 +1,6 @@
 class RenderMePretty::Erb
   class BaseHandler
-    def initialize(exception, path, layout_path=nil)
+    def initialize(exception, path, layout_path = nil)
       @exception = exception
       @path = path
       @layout_path = layout_path
@@ -8,25 +8,25 @@ class RenderMePretty::Erb
 
     def handle
       line_number = find_line_number
-      pretty_trace(line_number, full_message=true) # returns StringIO
+      pretty_trace(line_number, true) # returns StringIO
     end
 
-    def pretty_trace(error_line_number, full_message=true)
+    def pretty_trace(error_line_number, full_message = true)
       io = StringIO.new
 
       message = full_message ? ": #{@exception.message}" : ""
       io.puts "#{@exception.class}#{message}".color(:red)
 
-      pretty_path = template_path_with_error.sub(/^\.\//, '')
+      pretty_path = template_path_with_error.sub(/^\.\//, "")
       io.puts "Error evaluating ERB template around line #{error_line_number.to_s.color(:red)} of: #{pretty_path}:"
 
       context = 5 # lines of context
-      top, bottom = [error_line_number-context-1, 0].max, error_line_number+context-1
+      top, bottom = [error_line_number - context - 1, 0].max, error_line_number + context - 1
 
       lines = IO.read(template_path_with_error).split("\n")
       spacing = lines.size.to_s.size
       lines[top..bottom].each_with_index do |line_content, index|
-        current_line_number = top+index+1
+        current_line_number = top + index + 1
         if current_line_number == error_line_number
           io.printf("%#{spacing}d %s\n".color(:red), current_line_number, line_content)
         else
@@ -56,11 +56,10 @@ class RenderMePretty::Erb
     #   /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']
+      full = ENV["FULL_BACKTRACE"]
+      lines = @exception.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.
@@ -68,15 +67,15 @@ class RenderMePretty::Erb
         # 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
+        # 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
+        # render_me_pretty lines
         lines = lines[0..7] # keep 8 lines
       end
       lines[0] = lines[0].color(:red)
 
       # header
-      lines.unshift "\nOriginal backtrace#{full ? '' : ' (last 8 lines)'}:"
+      lines.unshift "\nOriginal backtrace#{full ? "" : " (last 8 lines)"}:"
       # footer
       lines << "\nRe-run with FULL_BACKTRACE=1 to see all lines"
       lines.join("\n")

data/lib/render_me_pretty/erb/main_error_handler.rb

@@ -7,15 +7,15 @@ class RenderMePretty::Erb
     #   error_info = e.backtrace[0]
     def find_line_number
       lines = @exception.backtrace
-      error_line = lines.select do |line|
+      error_line = lines.find do |line|
         line.include?(template_path_with_error)
-      end.first
+      end
 
       if error_line.nil?
         puts "WARN: Unable to find line number. Fallback and print out full backtrace."
         puts @exception.backtrace
       else
-        error_line.split(':')[1].to_i
+        error_line.split(":")[1].to_i
       end
     end
 

data/lib/render_me_pretty/erb.rb

@@ -1,54 +1,52 @@
-=begin
-## Usage examples:
-
-Given an example template /path/to/template.erb that contains:
-
-  a: <%= @a %>
-
+# ## 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
-
+#
+#   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
-
+#
+#   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.
-
+#
+#   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'
-require 'tilt/erb'
+#
+# 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.
+#
+require "tilt"
+require "tilt/erb"
 
 module RenderMePretty
   class Erb
-    autoload :BaseHandler, 'render_me_pretty/erb/base_handler'
+    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={})
+    def initialize(path, variables = {})
       @path = path
       @init_vars = variables
       @context = variables.delete(:context)
@@ -71,11 +69,11 @@ module RenderMePretty
       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)
+        context.instance_variable_set("@" + key.to_s, value)
       end
 
       # https://github.com/gotar/dry-view/commit/39e3f96625bf90da2e51fb1fd437f18cedb9ae8c
-      tilt_options = {trim: '-', default_encoding: "utf-8"}
+      tilt_options = {trim: "-", default_encoding: "utf-8"}
       if @layout_path
         layout = Tilt::ERBTemplate.new(@layout_path, tilt_options)
       else
@@ -91,12 +89,8 @@ module RenderMePretty
         else
           template.render(context)
         end
-      rescue Exception => e
-        if e.class == SystemExit # allow exit to happen normally
-          raise
-        else
-          handle_exception(e)
-        end
+      rescue StandardError, ScriptError => e
+        handle_exception(e)
       end
     end
 
@@ -122,11 +116,15 @@ module RenderMePretty
     end
 
     def print_result(io)
-      if ENV['TEST']
+      if ENV["TEST"]
         io.string
       else
         puts io.string
-        exit 1
+        if RenderMePretty.on_error.to_sym == :exit
+          exit 1
+        else
+          raise
+        end
       end
     end
 
@@ -144,11 +142,10 @@ module RenderMePretty
     #   /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']
+      full = ENV["FULL_BACKTRACE"]
+      lines = e.backtrace
       if full
-        lines = e.backtrace
       else
-        lines = e.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.
@@ -156,15 +153,15 @@ module RenderMePretty
         # 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
+        # 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
+        # render_me_pretty lines
         lines = lines[0..7] # keep 8 lines
       end
       lines[0] = lines[0].color(:red)
 
       # header
-      lines.unshift "\nOriginal backtrace#{full ? '' : ' (last 8 lines)'}:"
+      lines.unshift "\nOriginal backtrace#{full ? "" : " (last 8 lines)"}:"
       # footer
       lines << "\nRe-run with FULL_BACKTRACE=1 to see all lines"
       lines.join("\n")

data/lib/render_me_pretty/version.rb

@@ -1,3 +1,3 @@
 module RenderMePretty
-  VERSION = "0.9.0"
+  VERSION = "1.0.0"
 end

data/lib/render_me_pretty.rb

@@ -4,12 +4,15 @@ require "active_support/core_ext/string"
 require "rainbow/ext/string"
 
 module RenderMePretty
-  autoload :Erb, 'render_me_pretty/erb'
+  autoload :Erb, "render_me_pretty/erb"
 
-  def result(path, variables={})
+  def result(path, variables = {})
     erb = Erb.new(path, variables)
     erb.render
   end
 
+  mattr_accessor :on_error
+  self.on_error = :exit # :exit or :raise
+
   extend self
 end

data/render_me_pretty.gemspec

@@ -3,19 +3,20 @@ $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.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.summary = "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.license = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+  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.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
   spec.add_dependency "activesupport"

data/tilt_examples.rb

@@ -1,18 +1,18 @@
-require 'tilt/erb'
-template = Tilt::ERBTemplate.new('templates/foo.erb')
-joe = Person.find('joe')
-output = template.render(joe, :x => 35, :y => 42)
+require "tilt/erb"
+template = Tilt::ERBTemplate.new("templates/foo.erb")
+joe = Person.find("joe")
+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)
+jane = Person.find("jane")
+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' }
+template = Tilt::ERBTemplate.new("foo.erb")
+template.render { "Joe" }
 # => "Hey Joe!"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: render_me_pretty
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-06-06 00:00:00.000000000 Z
+date: 2024-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -106,6 +106,7 @@ files:
 - ".rspec"
 - CHANGELOG.md
 - Gemfile
+- LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
@@ -119,7 +120,8 @@ files:
 - render_me_pretty.gemspec
 - tilt_examples.rb
 homepage: https://github.com/tongueroo/render_me_pretty
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -136,7 +138,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.10
 signing_key: 
 specification_version: 4
 summary: Render ERB template and provide more useful message pointing out the line