RubyGems - baby_erubis - Versions diffs - 2.0.0 → 2.1.0 - Mend

baby_erubis 2.0.0 → 2.1.0

Files changed (15) hide show

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 86a6cc722ec2c51e207330c70c8202f7f6108b07
-  data.tar.gz: 9f0062ca834b2954323f772dc65e9cb4d8ba5055
+  metadata.gz: e4e3e54829bebc2831ffe6e689adb929da5651f1
+  data.tar.gz: b96bd245ccfad8a9da0bf544adcd0810faf95cbc
 SHA512:
-  metadata.gz: 8f716b9a9866e7d4d9787208f5323cdf58e1c1c22d79ed1a605f4fc4b10f2ae98b3eb6d5a30c5125061497fa91448d2cfd51dd9ac5c9f7e2a960506c24efbc42
-  data.tar.gz: 2f2753b15878d8ae7dad9eaf3673e972ce970ec04aa1f1c4769c983fbe26ea2f4b354708eebbbb8cd29660d1180fa57906630b8d14016f610718246c65f2f29d
+  metadata.gz: c5848f552207930cd84cb1e6babb2de0e102010f623b658e2a845870ab4d7ce0232f2ed0c734bfee32d1492e9c0ec08a29608c14f810d64170785896a707999f
+  data.tar.gz: e353121aaabdc3412b71c4dae60f164e7602bf5fedea44a0918bb631681365641e34857abc237971355786e602d7d00246648cd1e55cc02bae4ab4b2c0a5cc3a

data/MIT-LICENSE CHANGED Viewed

@@ -1,6 +1,6 @@
 The MIT License (MIT)
-Copyright (c) 2014 kuwata-lab.com
+Copyright (c) 2014-2015 kuwata-lab.com
 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

data/README.md CHANGED Viewed

@@ -1,7 +1,7 @@
 BabyErubis.rb
 =============
-$Release: 2.0.0 $
+$Release: 2.1.0 $
 BabyErubis is an yet another eRuby implementation, based on Erubis.
@@ -199,6 +199,67 @@ You can check syntax of Rails template in command-line:
 (TODO: How to use BabyErubis in Ruby on Rails instead of Erubis)
+Define Rendering Methods
+------------------------
+It is very easy to use BabyErubis as template engine in your app or framework,
+because `BabyErubis/Renderer` module defines rendering methods:
+    require 'baby_erubis'
+    require 'baby_erubis/renderer'
+    class MyController
+      include BabyErubis::HtmlEscaper
+      include BabyErubis::Renderer          # !!!!
+      ERUBY_PATH      = ['.']
+      ERUBY_LAYOUT    = :_layout
+      ERUBY_HTML      = BabyErubis::Html
+      ERUBY_HTML_EXT  = '.html.eruby'
+      ERUBY_TEXT      = BabyErubis::Text
+      ERUBY_TEXT_EXT  = '.eruby'
+      ERUBY_CACHE     = {}
+      alias render_html eruby_render_html
+      alias render_text eruby_render_text
+      def index
+        @items = ['A', 'B', 'C']
+        ## renders 'templates/welcome.html.eruby'
+        html = render_html(:welcome)
+        return html
+      end
+    end
+`BabyErubis/Renderer` module defines the following methods:
+* `eruby_render_html(template_name, layout: true, encoding: 'utf-8')` --
+  renders HTML template with layout template.
+  `layout` keyword argument is layout template name or boolean and use
+  default layout name (= ERUBY_TEMPLATE_LAYOUT) when its value is true.
+* `eruby_render_text(template_name, layout: false, encoding: 'utf-8')` --
+  renders plain template.
+Layout template example:
+    <%
+        ## you can specify parent layout template name
+        #@_layout = :sitelayout
+    %>
+    <!doctype html>
+    <html>
+      <head>
+        <meta charset="utf-8" />
+        <title><%= @page_title %></title>
+      <head>
+      <body>
+        <div id="main" class="main">
+    <%== @_content %>         ## or <% _buf << @_content %>
+        </div>
+      </body>
+    </html>
 Customizing
 ===========
@@ -369,6 +430,12 @@ Changes
 =======
+Release 2.1.0 (2015-10-27)
+--------------------------
+* [enhance] Add new helper module `BabyErubis::Renderer`
 Release 2.0.0 (2014-12-09)
 --------------------------
@@ -403,4 +470,4 @@ $License: MIT License $
 Copyright
 =========
-$Copyright: copyright(c) 2014 kuwata-lab.com all rights reserved $
+$Copyright: copyright(c) 2014-2015 kuwata-lab.com all rights reserved $

data/Rakefile CHANGED Viewed

@@ -2,8 +2,8 @@
 ###
-RELEASE   = ENV['rel'] || '2.0.0'
-COPYRIGHT = 'copyright(c) 2014 kuwata-lab.com all rights reserved'
+RELEASE   = ENV['rel'] || '2.1.0'
+COPYRIGHT = 'copyright(c) 2014-2015 kuwata-lab.com all rights reserved'
 LICENSE   = 'MIT License'
 ###

data/baby_erubis.gemspec CHANGED Viewed

@@ -1,9 +1,9 @@
 #!/usr/bin/ruby
 ###
-### $Release: 2.0.0 $
+### $Release: 2.1.0 $
 ### $License: MIT License $
-### $Copyright: copyright(c) 2014 kuwata-lab.com all rights reserved $
+### $Copyright: copyright(c) 2014-2015 kuwata-lab.com all rights reserved $
 ###
 require 'rubygems'
@@ -13,7 +13,7 @@ Gem::Specification.new do |s|
   s.name        = "baby_erubis"
   s.author      = "makoto kuwata"
   s.email       = "kwa(at)kuwata-lab.com"
-  s.version     = "$Release: 2.0.0 $".split()[1]
+  s.version     = "$Release: 2.1.0 $".split()[1]
   s.license     = "MIT License"
   s.platform    = Gem::Platform::RUBY
   s.homepage    = "https://github.com/kwatch/BabyErubis/tree/ruby"

data/bin/baby_erubis CHANGED Viewed

@@ -2,8 +2,8 @@
 # -*- coding: utf-8 -*-
 ###
-### $Release: 2.0.0 $
-### $Copyright: copyright(c) 2014 kuwata-lab.com all rights reserved $
+### $Release: 2.1.0 $
+### $Copyright: copyright(c) 2014-2015 kuwata-lab.com all rights reserved $
 ### $License: MIT License $
 ###

data/lib/baby_erubis/rails.rb CHANGED Viewed

@@ -1,8 +1,8 @@
 # -*- coding: utf-8 -*-
 ###
-### $Release: 2.0.0 $
-### $Copyright: copyright(c) 2014 kuwata-lab.com all rights reserved $
+### $Release: 2.1.0 $
+### $Copyright: copyright(c) 2014-2015 kuwata-lab.com all rights reserved $
 ### $License: MIT License $
 ###

data/lib/baby_erubis.rb CHANGED Viewed

@@ -1,8 +1,8 @@
 # -*- coding: utf-8 -*-
 ###
-### $Release: 2.0.0 $
-### $Copyright: copyright(c) 2014 kuwata-lab.com all rights reserved $
+### $Release: 2.1.0 $
+### $Copyright: copyright(c) 2014-2015 kuwata-lab.com all rights reserved $
 ### $License: MIT License $
 ###
@@ -25,7 +25,11 @@
 module BabyErubis
-  RELEASE = '$Release: 2.0.0 $'.split(' ')[1]
+  RELEASE = '$Release: 2.1.0 $'.split(' ')[1]
+  class TemplateError < StandardError
+  end
   class Template

data/test/context_test.rb CHANGED Viewed

@@ -1,8 +1,8 @@
 # -*- coding: utf-8 -*-
 ###
-### $Release: 2.0.0 $
-### $Copyright: copyright(c) 2014 kuwata-lab.com all rights reserved $
+### $Release: 2.1.0 $
+### $Copyright: copyright(c) 2014-2015 kuwata-lab.com all rights reserved $
 ### $License: MIT License $
 ###

data/test/rails_test.rb CHANGED Viewed

@@ -1,8 +1,8 @@
 # -*- coding: utf-8 -*-
 ###
-### $Release: 2.0.0 $
-### $Copyright: copyright(c) 2014 kuwata-lab.com all rights reserved $
+### $Release: 2.1.0 $
+### $Copyright: copyright(c) 2014-2015 kuwata-lab.com all rights reserved $
 ### $License: MIT License $
 ###

data/test/renderer_test.rb ADDED Viewed

@@ -0,0 +1,312 @@
+# -*- coding: utf-8 -*-
+###
+### $Release: 2.1.0 $
+### $Copyright: copyright(c) 2014-2015 kuwata-lab.com all rights reserved $
+### $License: MIT License $
+###
+libpath = File.class_eval { join(dirname(dirname(__FILE__)), 'lib') }
+$: << libpath unless $:.include?(libpath)
+require 'minitest/autorun'
+require 'baby_erubis'
+require 'baby_erubis/renderer'
+class HelloClass
+  include BabyErubis::HtmlEscaper
+  include BabyErubis::Renderer
+  ERUBY_PATH     = ['_t']
+  ERUBY_HTML_EXT = '.html.erb'
+  ERUBY_TEXT_EXT = '.erb'
+  def initialize(vars={})
+    vars.each do |k, v|
+      instance_variable_set("@#{k}", v)
+    end
+  end
+end
+describe 'BabyErubis::Renderer' do
+  layout_template = <<'END'
+<!doctype>
+<html>
+  <head>
+    <meta charset="utf-8" />
+    <title><%= @page_title %></title>
+  </head>
+  <body>
+    <div id="main" class="main">
+<%== @_content %>
+    </div>
+  </body>
+</html>
+END
+  html_template = <<'END'
+<%
+   @page_title = 'Example'
+%>
+<h1><%= @page_title %></h1>
+<ul>
+<% for x in @items %>
+  <li><%= x %></li>
+<% end %>
+</ul>
+END
+  layout2_template = <<'END'
+<%
+  @_layout = true
+%>
+<section>
+<%== @_content %>
+</section>
+END
+  text_template = <<'END'
+title: <%= @title %>
+date:  <%= @date %>
+END
+  before do
+    Dir.mkdir('_t')
+    File.open('_t/_layout.html.erb', 'w') {|f| f.write(layout_template) }
+    File.open('_t/_layout2.html.erb', 'w') {|f| f.write(layout2_template) }
+    File.open('_t/welcome.html.erb', 'w') {|f| f.write(html_template) }
+    File.open('_t/example.text.erb', 'w') {|f| f.write(text_template) }
+  end
+  after do
+    Dir.glob('_t/*').each {|fpath| File.unlink(fpath) if File.file?(fpath) }
+    Dir.rmdir('_t')
+  end
+  describe '#eruby_render_html()' do
+    it "renders html template." do
+      obj = HelloClass.new(:items=>[10, 20, 30])
+      actual = obj.eruby_render_html(:'welcome', layout: false)
+      expected = <<'END'
+<h1>Example</h1>
+<ul>
+  <li>10</li>
+  <li>20</li>
+  <li>30</li>
+</ul>
+END
+      assert_equal expected, actual
+    end
+    it "renders with layout template." do
+      obj = HelloClass.new(:items=>[10, 20, 30])
+      actual = obj.eruby_render_html(:'welcome', layout: :'_layout')
+      expected = <<'END'
+<!doctype>
+<html>
+  <head>
+    <meta charset="utf-8" />
+    <title>Example</title>
+  </head>
+  <body>
+    <div id="main" class="main">
+<h1>Example</h1>
+<ul>
+  <li>10</li>
+  <li>20</li>
+  <li>30</li>
+</ul>
+    </div>
+  </body>
+</html>
+END
+      assert_equal expected, actual
+    end
+  end
+  describe '#eruby_render_text()' do
+    it "renders text template" do
+      obj = HelloClass.new(:title=>"Homhom", :date=>"2015-01-01")
+      actual = obj.eruby_render_text(:'example.text', layout: false)
+      expected = <<'END'
+title: Homhom
+date:  2015-01-01
+END
+      assert_equal expected, actual
+    end
+  end
+  describe '#_eruby_find_template()' do
+    it "caches template object with timestamp." do
+      cache = HelloClass.const_get :ERUBY_CACHE
+      cache.clear()
+      assert_equal 0, cache.length
+      obj = HelloClass.new(:items=>[10, 20, 30])
+      t1 = Time.now
+      obj.eruby_render_html(:'welcome')
+      t2 = Time.now
+      assert_equal 2, cache.length
+      tuple = cache['_t/welcome.html.erb']
+      assert tuple.is_a?(Array)
+      assert_equal 3, tuple.length
+      assert_equal BabyErubis::HtmlTemplate, tuple[0].class
+      assert_equal File.mtime('_t/welcome.html.erb'), tuple[1]
+      assert t1 < tuple[2]
+      assert t2 > tuple[2]
+    end
+    it "caches template object with timestamp." do
+      cache = HelloClass.const_get :ERUBY_CACHE
+      cache.clear()
+      obj = HelloClass.new(:items=>[10, 20, 30])
+      obj.eruby_render_html(:'welcome')
+      tuple1 = cache['_t/welcome.html.erb']
+      templ1 = tuple1[0]
+      mtime1 = tuple1[1]
+      #
+      tstamp = Time.now - 30
+      File.utime(tstamp, tstamp, '_t/welcome.html.erb')
+      sleep(1.0)
+      obj.eruby_render_html(:'welcome')
+      tuple2 = cache['_t/welcome.html.erb']
+      templ2 = tuple2[0]
+      mtime2 = tuple2[1]
+      assert templ1 != templ2
+      assert mtime1 != mtime2
+      assert templ2.is_a?(BabyErubis::HtmlTemplate)
+      assert_equal tstamp.to_s, mtime2.to_s
+    end
+    it "raises BabyErubis::TempalteError when template file not found." do
+      obj = HelloClass.new(:items=>[10, 20, 30])
+      ex = assert_raises(BabyErubis::TemplateError) do
+        obj.eruby_render_html(:'hello-homhom')
+      end
+      expected = "hello-homhom.html.erb: template not found in [\"_t\"]."
+      assert_equal expected, ex.message
+    end
+  end
+  describe '#_eruby_load_template()' do
+    _prepare = proc {
+      cache = HelloClass.const_get :ERUBY_CACHE
+      cache.clear()
+      obj = HelloClass.new(:items=>[10, 20, 30])
+      obj.eruby_render_html(:'welcome')
+      fpath = '_t/welcome.html.erb'
+      ts = Time.now - 30
+      File.utime(ts, ts, fpath)
+      [cache, obj, fpath]
+    }
+    _render = proc {|cache, obj, fpath, n, expected|
+      count = 0
+      n.times do
+        obj.eruby_render_html(:'welcome')
+        if expected != cache[fpath]
+          count += 1
+          cache[fpath] = expected
+        end
+      end
+      count
+    }
+    it "skips timestamp check in order to reduce syscall (= File.mtime())" do
+      cache, obj, fpath = _prepare.call()
+      #
+      sleep(0.1)
+      count = _render.call(cache, obj, fpath, 1000, cache[fpath])
+      assert count == 0, "#{count} == 0: failed"
+    end
+    it "checks timestamp only for 5% request in order to avoid thundering herd" do
+      cache, obj, fpath = _prepare.call()
+      #
+      sleep(0.6)
+      count = _render.call(cache, obj, fpath, 1000, cache[fpath])
+      assert count > 0,    "#{count} > 0: failed"
+      assert count > 3,    "#{count} > 3: failed"
+      assert count < 100,  "#{count} < 100: failed"
+    end
+    it "update last_checked in cache when file timestamp is not changed" do
+      cache, obj, fpath = _prepare.call()
+      _, _, old_last_checked = cache[fpath]
+      #
+      sleep(1.0)
+      now = Time.now
+      obj.eruby_render_html(:'welcome')
+      _, _, new_last_checked = cache[fpath]
+      assert_operator new_last_checked, :'!=', old_last_checked
+      assert_operator (new_last_checked - old_last_checked), :'>=', 1.0
+      assert_operator (new_last_checked - now), :'<', 0.001
+    end
+    it "remove cache entry when file timestamp is changed" do
+      cache, obj, fpath = _prepare.call()
+      #
+      sleep(1.0)
+      count = _render.call(cache, obj, fpath, 1000, cache[fpath])
+      assert count == 1000, "#{count} == 1000: failed"
+      #
+      assert cache[fpath] != nil
+      ret = obj.__send__(:_eruby_load_template, cache, fpath, Time.now)
+      assert_nil ret
+      assert_nil cache[fpath]
+    end
+  end
+  describe '#_eruby_render_template()' do
+    it "recognizes '@_layout' variable" do
+      expected = <<'END'
+<!doctype>
+<html>
+  <head>
+    <meta charset="utf-8" />
+    <title>Example</title>
+  </head>
+  <body>
+    <div id="main" class="main">
+<section>
+<h1>Example</h1>
+<ul>
+  <li>10</li>
+  <li>20</li>
+  <li>30</li>
+</ul>
+</section>
+    </div>
+  </body>
+</html>
+END
+      obj = HelloClass.new(:items=>[10,20,30])
+      actual = obj.eruby_render_html(:'welcome', layout: :'_layout2')
+      assert_equal expected, actual
+    end
+  end
+end

data/test/run_all.rb CHANGED Viewed

@@ -1,8 +1,8 @@
 # -*- coding: utf-8 -*-
 ###
-### $Release: 2.0.0 $
-### $Copyright: copyright(c) 2014 kuwata-lab.com all rights reserved $
+### $Release: 2.1.0 $
+### $Copyright: copyright(c) 2014-2015 kuwata-lab.com all rights reserved $
 ### $License: MIT License $
 ###

data/test/script_test.rb CHANGED Viewed

@@ -1,8 +1,8 @@
 # -*- coding: utf-8 -*-
 ###
-### $Release: 2.0.0 $
-### $Copyright: copyright(c) 2014 kuwata-lab.com all rights reserved $
+### $Release: 2.1.0 $
+### $Copyright: copyright(c) 2014-2015 kuwata-lab.com all rights reserved $
 ### $License: MIT License $
 ###
@@ -479,6 +479,7 @@ END
         end
       end
       expected = "-f #{ctx_file}: JSON syntax error: (JSON::ParserError) 743: unexpected token\n"
+      expected = expected.sub(/743/, '814') if RUBY_VERSION >= '2.2'
       expected = expected.sub(/743/, '795') if RUBY_VERSION >= '2.0'
       assert_equal "", sout
       assert_equal expected, serr

data/test/template_test.rb CHANGED Viewed

@@ -1,8 +1,8 @@
 # -*- coding: utf-8 -*-
 ###
-### $Release: 2.0.0 $
-### $Copyright: copyright(c) 2014 kuwata-lab.com all rights reserved $
+### $Release: 2.1.0 $
+### $Copyright: copyright(c) 2014-2015 kuwata-lab.com all rights reserved $
 ### $License: MIT License $
 ###

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: baby_erubis
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - makoto kuwata
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-12-09 00:00:00.000000000 Z
+date: 2015-10-26 00:00:00.000000000 Z
 dependencies: []
 description: |
   BabyErubis is an yet another eRuby implementation, based on Erubis.
@@ -25,19 +25,20 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- baby_erubis.gemspec
+- bin/baby_erubis
 - lib/baby_erubis.rb
 - lib/baby_erubis/rails.rb
+- setup.rb
 - test/context_test.rb
 - test/rails_test.rb
+- test/renderer_test.rb
 - test/run_all.rb
 - test/script_test.rb
 - test/template_test.rb
-- bin/baby_erubis
-- README.md
-- MIT-LICENSE
-- setup.rb
-- baby_erubis.gemspec
-- Rakefile
 homepage: https://github.com/kwatch/BabyErubis/tree/ruby
 licenses:
 - MIT License
@@ -48,17 +49,17 @@ 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.0.14
+rubygems_version: 2.4.5.1
 signing_key:
 specification_version: 4
 summary: yet another eRuby implementation based on Erubis