RubyGems - baby_erubis - Versions diffs - 0.1.0 - Mend

baby_erubis 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (10) hide show

data/MIT-LICENSE ADDED Viewed

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+Copyright (c) 2014 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
+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/README.md ADDED Viewed

@@ -0,0 +1,315 @@
+BabyErubis.rb
+=============
+$Release: 0.1.0 $
+BabyErubis is an yet another eRuby implementation, based on Erubis.
+* Small and fast
+* Easy to customize
+* Supports HTML as well as plain text
+* Accepts both template file and template string
+BabyErubis support Ruby 1.9 or higher.
+Examples
+========
+Render template string:
+    require 'baby_erubis'
+    template = BabyErubis::Html.new.from_str <<'END', __FILE__, __LINE__+1
+      <h1><%= @title %></h1>
+      <% for item in @items %>
+        <p><%= item %></p>
+      <% end %>
+    END
+    context = {:title=>'Example', :items=>['A', 'B', 'C']}
+    output = template.render(context)
+    print output
+Render template file:
+    require 'baby_erubis'
+    templat = BabyErubis::Html.new.from_file('example.html.erb', 'utf-8')
+    context = {:title=>'Example', :items=>['A', 'B', 'C']}
+    output = template.render(context)
+    print output
+Template Syntax
+===============
+* `<% ... %>` : Ruby statement
+* `<%= ... %>` : Ruby expression with escaping
+* `<%== ... %>` : Ruby expression without escaping
+Expression in `<%= ... %>` is escaped according to template class.
+* `BabyErubis::Text` doesn't escape anything.
+  It justs converts expression into a string.
+* `BabyErubis::Html` escapes html special characters.
+  It converts '< > & " \'' into '&lt; &gt; &amp; &quot; &#39;' respectively.
+(Experimental) `<%- ... -%>` and `<%-= ... -%>` are handled same as
+`<% ... %>` and `<%= ... %>` respectively.
+Advanced Topics
+===============
+Template Context
+----------------
+When rendering template, you can pass not only Hash object but also any object
+as context values. Internally, rendering method converts Hash object into
+`BabyErubis::TemplateContext` object automatically.
+Example:
+    require 'baby_erubis'
+    class MyApp
+      include BabyErubis::HtmlEscaper  # necessary to define escape()
+      TEMPLATE = BabyErubis::Html.new.from_str <<-'END', __FILE__, __LINE__+1
+        <html>
+          <body>
+            <p>Hello <%= @name %>!</p>
+          </body>
+        </html>
+      END
+      def initialize(name)
+        @name = name
+      end
+      def render()
+        return TEMPLATE.render(self)
+      end
+    end
+    if __FILE__ == $0
+      print MyApp.new('World').render()
+    end
+String#freeze()
+---------------
+BabyErubis supports String#freeze() automatically when Ruby version >= 2.1.
+And you can controll whether to use freeze() or not.
+    template_str = <<'END'
+    <div>
+    <b><%= message %></b>
+    </div>
+    END
+    ## don't use freeze()
+    t = BabyErubis::Text.new(:freeze=>false).from_str(template_str)
+    print t.src
+    # --- result ---
+    # _buf = ''; _buf << '<div>
+    # <b>'; _buf << (message).to_s; _buf << '</b>
+    # </div>
+    # '; _buf.to_s
+    ## use freeze() forcedly
+    t = BabyErubis::Text.new(:freeze=>true).from_str(template_str)
+    print t.src
+    # --- result ---
+    # _buf = ''; _buf << '<div>
+    # <b>'.freeze; _buf << (message).to_s; _buf << '</b>
+    # </div>
+    # '.freeze; _buf.to_s
+Customizing
+===========
+Change Embed Pattern from '<% %>' to '{% %}'
+--------------------------------------------
+Sample code:
+    require 'baby_erubis'
+    class MyTemplate < BabyErubis::Html
+      rexp = BabyErubis::Template::PATTERN
+      PATTERN = Regexp.compile(rexp.to_s.sub(/<%/, '\{%').sub(/%>/, '%\}'))
+      def pattern
+        PATTERN
+      end
+    end
+    template = MyTemplate.new <<-'END'
+    {% for item in @items %}
+    - {%= item %}
+    {% end %}
+    END
+    print template.render(:items=>['A', 'B', 'C'])
+Output:
+    - A
+    - B
+    - C
+Strip Spaces in HTML Template
+-----------------------------
+Sample code:
+    require 'baby_erubis'
+    class MyTemplate < BabyErubis::Html
+      def parse(input, *args)
+        stripped = input.gsub(/^[ \t]+</, '<')
+        return super(stripped, *args)
+      end
+    end
+    template = MyTemplate.new <<-'END'
+      <html>
+        <body>
+          <p>Hello <%= @name %>!</p>
+        </body>
+      </html>
+    END
+    print template.render(:name=>"Hello")
+Output:
+    <html>
+    <body>
+    <p>Hello Hello!</p>
+    </body>
+    </html>
+Layout Template
+---------------
+Sample code:
+    require 'baby_erubis'
+    class MyApp
+      include BabyErubis::HtmlEscaper  # necessary to define escape()
+      LAYOUT = BabyErubis::Html.new.from_str <<-'END', __FILE__, __LINE__+1
+        <html>
+          <body>
+            <% _buf << @_content %>    # or <%== @_content %>
+          </body>
+        </html>
+      END
+      TEMPLATE = BabyErubis::Html.new.from_str <<-'END', __FILE__, __LINE__+1
+        <p>Hello <%= @name %>!</p>
+      END
+      def initialize(name)
+        @name = name
+      end
+      def render()
+        @_content = TEMPLATE.render(self)
+        return LAYOUT.render(self)
+      end
+    end
+    if __FILE__ == $0
+      print MyApp.new('World').render()
+    end
+Output:
+      <html>
+        <body>
+              <p>Hello World!</p>
+        </body>
+      </html>
+Template Cache File
+-------------------
+Sample code:
+    require 'baby_erubis'
+    require 'logger'
+    $logger = Logger.new(STDERR)
+    class MyTemplate < BabyErubis::Html
+      def from_file(filename, encoding='utf-8')
+        cachefile = "#{filename}.cache"
+        timestamp = File.mtime(filename)
+        has_cache = File.file?(cachefile) && File.mtime(cachefile) == timestamp
+        if has_cache
+          $logger.info("loading template from cache file: #{cachefile}")
+          ruby_code = File.open(cachefile, "rb:#{encoding}") {|f| f.read }
+          compile(ruby_code, filename, 1)
+        else
+          super(filename, encoding)
+          $logger.info("creating template cache file: #{cachefile}")
+          ruby_code = self.src
+          tmpname = "#{cachefile}.#{rand().to_s[2,5]}"
+          File.open(tmpname, "wb:#{encoding}") {|f| f.write(ruby_code) }
+          File.utime(timestamp, timestamp, tmpname)
+          File.rename(tmpname, cachefile)
+        end
+        return self
+      end
+    end
+    p File.exist?('example.html.erb.cache')   #=> false
+    t = MyTemplate.new.from_file('example.html.erb')
+    p File.exist?('example.html.erb.cache')   #=> true
+Changes
+=======
+Release 0.1.0 (2014-05-06)
+--------------------------
+* Public release
+License
+=======
+$License: MIT License $
+Copyright
+=========
+$Copyright: copyright(c) 2014 kuwata-lab.com all rights reserved $

data/Rakefile ADDED Viewed

@@ -0,0 +1,83 @@
+# -*- coding: utf-8 -*-
+###
+RELEASE   = ENV['rel'] || '0.0.0'
+COPYRIGHT = 'copyright(c) 2014 kuwata-lab.com all rights reserved'
+LICENSE   = 'MIT License'
+###
+task :default => :test
+def edit_content(content)
+  s = content
+  s = s.gsub /\$Release\:.*?\$/,   "$Release\: #{RELEASE} $"
+  s = s.gsub /\$Copyright\:.*?\$/, "$Copyright\: #{COPYRIGHT} $"
+  s = s.gsub /\$License\:.*?\$/,   "$License\: #{LICENSE} $"
+  s = s.gsub /\$Release\$/,   RELEASE
+  s = s.gsub /\$Copyright\$/, COPYRIGHT
+  s = s.gsub /\$License\$/,   LICENSE
+  s
+end
+desc "run test scripts"
+task :test do
+  #sh "ruby -r minitest/autorun test/*_test.rb"
+  sh "ruby test/run_all.rb"
+end
+desc "copy files into 'dist/#{RELEASE}'"
+task :dist do
+  require_release_number()
+  spec_src = File.open('baby_erubis.gemspec') {|f| f.read }
+  spec = eval spec_src
+  dir = "dist/#{RELEASE}"
+  rm_rf dir
+  mkdir_p dir
+  sh "tar cf - #{spec.files.join(' ')} | (cd #{dir}; tar xvf -)"
+  spec.files.each do |fpath|
+    #filepath = File.join(dir, fpath)
+    #content = File.open(filepath, 'rb:utf-8') {|f| f.read }
+    #new_content = edit_content(content)
+    #File.open(filepath, 'wb:utf-8') {|f| f.write(new_content) }
+    content = File.open(File.join(dir, fpath), 'r+b:utf-8') do |f|
+      content = f.read
+      new_content = edit_content(content)
+      f.rewind()
+      f.truncate(0)
+      f.write(new_content)
+    end
+  end
+end
+desc "create rubygem pacakge"
+task :package => :dist do
+  require_release_number()
+  chdir "dist/#{RELEASE}" do
+    sh "gem build *.gemspec"
+  end
+  mv Dir.glob("dist/#{RELEASE}/*.gem"), 'dist'
+end
+desc "release gem"
+task :release => :package do
+  require_release_number()
+  sh "git tag ruby-#{RELEASE}"
+  chdir "dist" do
+    sh "gem push baby_erubis-#{RELEASE}.gem"
+  end
+end
+def require_release_number
+  if RELEASE == '0.0.0'
+    $stderr.puts "*** Release number is not speicified"
+    $stderr.puts "*** Usage: rake <task> rel=X.X.X"
+    raise StandardError
+  end
+end

data/baby_erubis.gemspec ADDED Viewed

@@ -0,0 +1,38 @@
+#!/usr/bin/ruby
+###
+### $Release: 0.1.0 $
+### $License: MIT License $
+### $Copyright: copyright(c) 2014 kuwata-lab.com all rights reserved $
+###
+require 'rubygems'
+Gem::Specification.new do |s|
+  ## package information
+  s.name        = "baby_erubis"
+  s.author      = "makoto kuwata"
+  s.email       = "kwa(at)kuwata-lab.com"
+  s.version     = "$Release: 0.1.0 $".split()[1]
+  s.platform    = Gem::Platform::RUBY
+  s.homepage    = "https://github.com/kwatch/BabyErubis/tree/ruby"
+  s.summary     = "yet another eRuby implementation based on Erubis"
+  s.description = <<'END'
+BabyErubis is an yet another eRuby implementation, based on Erubis.
+* Small and fast
+* Supports HTML as well as plain text
+* Accepts both template file and template string
+* Easy to customize
+BabyErubis support Ruby 1.9 or higher.
+END
+  ## files
+  files = []
+  files += Dir.glob('lib/*.rb')
+  files += Dir.glob('test/*.rb')
+  files += %w[README.md MIT-LICENSE setup.rb baby_erubis.gemspec Rakefile]
+  s.files       = files
+  s.test_file   = 'test/run_all.rb'
+end