baby_erubis 0.1.0 → 1.0.0

data/lib/baby_erubis.rb

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 
 ###
-### $Release: 0.1.0 $
+### $Release: 1.0.0 $
 ### $Copyright: copyright(c) 2014 kuwata-lab.com all rights reserved $
 ### $License: MIT License $
 ###
@@ -25,6 +25,8 @@
 
 module BabyErubis
 
+  RELEASE = '$Release: 1.0.0 $'.split(' ')[1]
+
 
   class Template
 
@@ -38,7 +40,9 @@ module BabyErubis
     end
 
     def from_file(filename, encoding='utf-8')
-      input = File.open(filename, "rb:#{encoding}") {|f| f.read() }
+      mode = "rb:#{encoding}"
+      mode = "rb" if RUBY_VERSION < '1.9'
+      input = File.open(filename, mode) {|f| f.read() }
       compile(parse(input), filename, 1)
       return self
     end
@@ -94,7 +98,7 @@ module BabyErubis
     end
 
     def render(context={})
-      ctxobj = context.is_a?(Hash) ? new_context(context) : context
+      ctxobj = context.nil? || context.is_a?(Hash) ? new_context(context) : context
       return ctxobj.instance_eval(&@proc)
     end
 
@@ -155,11 +159,10 @@ module BabyErubis
 
   class HtmlTemplate < Template
 
-    protected
-
     def escaped_expr(code)
       return "escape(#{code})"   # escape() is defined in HtmlTemplateContext
     end
+    protected :escaped_expr
 
     def new_context(hash)
       return HtmlTemplateContext.new(hash)

data/test/context_test.rb

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

data/test/run_all.rb

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

data/test/script_test.rb

@@ -0,0 +1,646 @@
+# -*- coding: utf-8 -*-
+
+###
+### $Release: 1.0.0 $
+### $Copyright: copyright(c) 2014 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'
+
+## enforce not to use String#freeze() even if RUBY_VERSION >= 2.1
+#require 'baby_erubis'
+#BabyErubis::Template.class_eval do
+#  remove_const :FREEZE
+#  FREEZE = false
+#end
+
+## load script file ('bin/baby_erubis.rb')
+NOEXEC_SCRIPT = true
+load File.join(File.dirname(libpath), 'bin', 'baby_erubis')
+
+## helper to steal stdin, stdout and stderr
+require 'stringio'
+def dummy_stdio(input=nil)
+  stdin, stdout, stderr = $stdin, $stdout, $stderr
+  $stdin  = StringIO.new(input || '')
+  $stdout = StringIO.new
+  $stderr = StringIO.new
+  yield
+  return $stdout.string, $stderr.string
+ensure
+  $stdin  = stdin
+  $stdout = stdout
+  $stderr = stderr
+end
+
+## helper to create dummy file temporarily
+def with_tmpfile(filename, content)
+  File.open(filename, 'wb') {|f| f.write(content) }
+  yield filename
+ensure
+  File.unlink(filename) if File.exist?(filename)
+end
+
+## helper to create eruby file temporarily
+def with_erubyfile(content=nil)
+  content ||= ERUBY_TEMPLATE
+  filename = "test_eruby.rhtml"
+  with_tmpfile(filename, content) do
+    yield filename
+  end
+end
+
+
+describe Main do
+
+  def _modify(ruby_code)
+    if (''.freeze).equal?(''.freeze)
+      return ruby_code.gsub(/([^'])';/m, "\\1'.freeze;")
+    else
+      return ruby_code
+    end
+  end
+
+  def on_rubinius?
+    return defined?(RUBY_ENGINE) && RUBY_ENGINE == 'rbx'
+  end
+
+  help_message = <<'END'.gsub(/\$SCRIPT/, File.basename($0))
+Usage: $SCRIPT [..options..] [erubyfile]
+  -h, --help                  : help
+  -v, --version               : version
+  -x                          : show ruby code
+  -X                          : show ruby code only (no text part)
+  -N                          : numbering: add line numbers   (for '-x/-X')
+  -U                          : unique: compress empty lines  (for '-x/-X')
+  -C                          : compact: remove empty lines   (for '-x/-X')
+  -c context                  : context string (yaml inline style or ruby code)
+  -f file                     : context data file (*.yaml, *.json, or *.rb)
+  -H                          : same as --format=html
+      --format={text|html}    : format (default: text)
+      --encoding=name         : encoding (default: utf-8)
+      --freeze={true|false}   : use String#freeze() or not
+
+Example:
+  ## convert eRuby file into Ruby code
+  $ $SCRIPT -x   file.erb     # text
+  $ $SCRIPT -xH  file.erb     # html
+  $ $SCRIPT -X   file.erb     # embedded code only
+  ## render eRuby file with context data
+  $ $SCRIPT -c '{items: [A, B, C]}'   file.erb    # YAML
+  $ $SCRIPT -c '@items=["A","B","C"]' file.erb    # Ruby
+  $ $SCRIPT -f data.yaml file.erb                 # or -f *.json, *.rb
+  ## debug eRuby file
+  $ $SCRIPT -xH file.erb | ruby -wc     # check syntax error
+  $ $SCRIPT -XHNU file.erb              # show embedded ruby code
+END
+
+  ERUBY_TEMPLATE = <<'END'
+<html>
+  <body>
+    <h1><%= @title %></h1>
+    <h1><%== @title %></h1>
+    <div>
+      <ul>
+        <% for item in @items %>
+        <li><%= item %></li>
+        <% end %>
+      </ul>
+    </div>
+  </body>
+</html>
+END
+  SOURCE_TEXT = <<'END'
+_buf = ''; _buf << '<html>
+  <body>
+    <h1>'; _buf << (@title).to_s; _buf << '</h1>
+    <h1>'; _buf << (@title).to_s; _buf << '</h1>
+    <div>
+      <ul>
+';         for item in @items;
+ _buf << '        <li>'; _buf << (item).to_s; _buf << '</li>
+';         end;
+ _buf << '      </ul>
+    </div>
+  </body>
+</html>
+'; _buf.to_s
+END
+  SOURCE_HTML = <<'END'
+_buf = ''; _buf << '<html>
+  <body>
+    <h1>'; _buf << escape(@title); _buf << '</h1>
+    <h1>'; _buf << (@title).to_s; _buf << '</h1>
+    <div>
+      <ul>
+';         for item in @items;
+ _buf << '        <li>'; _buf << escape(item); _buf << '</li>
+';         end;
+ _buf << '      </ul>
+    </div>
+  </body>
+</html>
+'; _buf.to_s
+END
+  SOURCE_NO_TEXT = <<'END'
+_buf = '';
+
+         _buf << (@title).to_s;
+         _buf << (@title).to_s;
+
+
+         for item in @items;
+             _buf << (item).to_s;
+         end;
+
+
+
+ _buf.to_s
+END
+  OUTPUT_HTML = <<'END'
+<html>
+  <body>
+    <h1>Love&amp;Peace</h1>
+    <h1>Love&Peace</h1>
+    <div>
+      <ul>
+        <li>A</li>
+        <li>B</li>
+        <li>C</li>
+      </ul>
+    </div>
+  </body>
+</html>
+END
+  OUTPUT_TEXT = OUTPUT_HTML.sub(/&amp;/, '&')
+
+
+  describe '-h, --help' do
+
+    it "prints help message." do
+      sout, serr = dummy_stdio { Main.main(["-h"]) }
+      assert_equal help_message, sout
+      assert_equal "", serr
+      sout, serr = dummy_stdio { Main.main(["--help"]) }
+      assert_equal help_message, sout
+      assert_equal "", serr
+    end
+
+  end
+
+
+  describe '-v, --version' do
+
+    it "prints release version." do
+      expected = "#{BabyErubis::RELEASE}\n"
+      sout, serr = dummy_stdio { Main.main(["-v"]) }
+      assert_equal expected, sout
+      assert_equal "", serr
+      sout, serr = dummy_stdio { Main.main(["--version"]) }
+      assert_equal expected, sout
+      assert_equal "", serr
+    end
+
+  end
+
+
+  describe '-x' do
+
+    it "shows ruby code compiled." do
+      sout, serr = with_erubyfile do |fname|
+        dummy_stdio { Main.main(['-x', fname]) }
+      end
+      assert_equal _modify(SOURCE_TEXT), sout
+      assert_equal "", serr
+    end
+
+    it "reads stdin when no file specified." do
+      sout, serr = dummy_stdio(ERUBY_TEMPLATE) { Main.main(['-x']) }
+      assert_equal _modify(SOURCE_TEXT), sout
+      assert_equal "", serr
+    end
+
+  end
+
+
+  describe '-X' do
+
+    it "shows ruby code only (no text part)." do
+      expected = <<'END'
+_buf = '';
+
+         _buf << (@title).to_s;
+         _buf << (@title).to_s;
+
+
+         for item in @items;
+             _buf << (item).to_s;
+         end;
+
+
+
+
+ _buf.to_s
+END
+      sout, serr = with_erubyfile do |fname|
+        dummy_stdio { Main.main(['-X', fname]) }
+      end
+      assert_equal expected, sout
+      assert_equal "", serr
+    end
+
+  end
+
+
+  describe '-N' do
+
+    it "adds line numbers." do
+      expected = <<'END'
+   1: _buf = '';
+   2: 
+   3:          _buf << (@title).to_s;
+   4:          _buf << (@title).to_s;
+   5: 
+   6: 
+   7:          for item in @items;
+   8:              _buf << (item).to_s;
+   9:          end;
+  10: 
+  11: 
+  12: 
+  13: 
+  14:  _buf.to_s
+END
+      sout, serr = with_erubyfile do |fname|
+        dummy_stdio { Main.main(['-XN', fname]) }
+      end
+      assert_equal expected, sout
+      assert_equal "", serr
+    end
+
+  end
+
+
+  describe '-U' do
+
+    it "compresses empty lines." do
+      expected = <<'END'
+   1: _buf = '';
+
+   3:          _buf << (@title).to_s;
+   4:          _buf << (@title).to_s;
+
+   7:          for item in @items;
+   8:              _buf << (item).to_s;
+   9:          end;
+
+  14:  _buf.to_s
+END
+      sout, serr = with_erubyfile do |fname|
+        dummy_stdio { Main.main(['-XNU', fname]) }
+      end
+      assert_equal expected, sout
+      assert_equal "", serr
+    end
+
+  end
+
+
+  describe '-C' do
+
+    it "removes empty lines." do
+      expected = <<'END'
+   1: _buf = '';
+   3:          _buf << (@title).to_s;
+   4:          _buf << (@title).to_s;
+   7:          for item in @items;
+   8:              _buf << (item).to_s;
+   9:          end;
+  14:  _buf.to_s
+END
+      sout, serr = with_erubyfile do |fname|
+        dummy_stdio { Main.main(['-XNC', fname]) }
+      end
+      assert_equal expected, sout
+      assert_equal "", serr
+    end
+
+  end
+
+
+  describe '-H' do
+
+    it "escapes expressions." do
+      sout, serr = with_erubyfile do |fname|
+        dummy_stdio { Main.main(['-Hx', fname]) }
+      end
+      assert_equal _modify(SOURCE_HTML), sout
+      assert_equal "", serr
+    end
+
+  end
+
+
+  describe '-c cotnext' do
+
+    it "can specify context data in YAML format." do
+      context_str = "{title: Love&Peace, items: [A, B, C]}"
+      sout, serr = with_erubyfile do |fname|
+        dummy_stdio { Main.main(['-Hc', context_str, fname]) }
+      end
+      assert_equal OUTPUT_HTML, sout
+      assert_equal "", serr
+      ## when syntax error exists
+      context_str = "{title:Love&Peace,items:[A,B,C]"
+      sout, serr = with_erubyfile do |fname|
+        dummy_stdio { Main.main(['-Hc', context_str, fname]) }
+      end
+      assert_equal "", sout
+      if on_rubinius?
+        assert_equal "-c '{title:Love&Peace,items:[A,B,C]': YAML syntax error: (ArgumentError) col 31\n", serr
+      else
+        assert_equal "-c '{title:Love&Peace,items:[A,B,C]': YAML syntax error: (Psych::SyntaxError) found unexpected ':' while scanning a plain scalar at line 1 column 2\n", serr
+      end
+    end
+
+    it "can specify context data as Ruby code." do
+      context_str = "@title = 'Love&Peace'; @items = ['A','B','C']"
+      sout, serr = with_erubyfile do |fname|
+        dummy_stdio { Main.main(['-Hc', context_str, fname]) }
+      end
+      assert_equal OUTPUT_HTML, sout
+      assert_equal "", serr
+      ## when syntax error exists
+      context_str = "@title = 'Love&Peace' @items = ['A','B','C']"
+      sout, serr = with_erubyfile do |fname|
+        dummy_stdio { Main.main(['-Hc', context_str, fname]) }
+      end
+      expected = "-c '@title = 'Love&Peace' @items = ['A','B','C']': Ruby syntax error: (SyntaxError) unexpected tIVAR, expecting $end
+@title = 'Love&Peace' @items = ['A','B','C']
+                            ^
+"
+      expected = expected.sub(/\$end/, "end-of-input") if RUBY_VERSION =~ /^2\./
+      expected = "-c '@title = 'Love&Peace' @items = ['A','B','C']': Ruby syntax error: (SyntaxError) expecting $end: (eval):1:28\n" if on_rubinius?
+      assert_equal "", sout
+      assert_equal expected, serr
+    end
+
+  end
+
+
+  describe '-f datafile' do
+
+    it "can specify context data in YAML format." do
+      ctx_str = "{title: Love&Peace, items: [A, B, C]}"
+      ctx_file = "tmpdata.yaml"
+      sout, serr = with_erubyfile do |fname|
+        with_tmpfile(ctx_file, ctx_str) do
+          dummy_stdio { Main.main(['-Hf', ctx_file, fname]) }
+        end
+      end
+      assert_equal OUTPUT_HTML, sout
+      assert_equal "", serr
+      ## when file not found
+      sout, serr = with_erubyfile do |fname|
+        dummy_stdio { Main.main(['-Hf', ctx_file, fname]) }
+      end
+      assert_equal "", sout
+      assert_equal "-f #{ctx_file}: file not found.\n", serr
+      ## when syntax error exists
+      ctx_str = "{title:Love&Peace,items:[A, B, C]"
+      sout, serr = with_erubyfile do |fname|
+        with_tmpfile(ctx_file, ctx_str) do
+          dummy_stdio { Main.main(['-Hf', ctx_file, fname]) }
+        end
+      end
+      assert_equal "", sout
+      if on_rubinius?
+        assert_equal "-f #{ctx_file}: YAML syntax error: (ArgumentError) col 33\n", serr
+      else
+        assert_equal "-f #{ctx_file}: YAML syntax error: (Psych::SyntaxError) found unexpected ':' while scanning a plain scalar at line 1 column 2\n", serr
+      end
+    end
+
+    it "can specify context data in JSON format." do
+      ctx_str = '{"title":"Love&Peace","items":["A","B","C"]}'
+      ctx_file = "tmpdata.json"
+      sout, serr = with_erubyfile do |fname|
+        with_tmpfile(ctx_file, ctx_str) do
+          dummy_stdio { Main.main(['-Hf', ctx_file, fname]) }
+        end
+      end
+      assert_equal OUTPUT_HTML, sout
+      assert_equal "", serr
+      ## when file not found
+      sout, serr = with_erubyfile do |fname|
+        dummy_stdio { Main.main(['-Hf', ctx_file, fname]) }
+      end
+      assert_equal "", sout
+      assert_equal "-f #{ctx_file}: file not found.\n", serr
+      ## when syntax error exists
+      ctx_str = '{"title":"Love&Peace",items:["A","B","C"],}'
+      sout, serr = with_erubyfile do |fname|
+        with_tmpfile(ctx_file, ctx_str) do
+          dummy_stdio { Main.main(['-Hf', ctx_file, fname]) }
+        end
+      end
+      expected = "-f #{ctx_file}: JSON syntax error: (JSON::ParserError) 743: unexpected token\n"
+      expected = expected.sub(/743/, '795') if RUBY_VERSION >= '2.0'
+      assert_equal "", sout
+      assert_equal expected, serr
+    end
+
+    it "can specify context data as Ruby code." do
+      ctx_str = "@title = 'Love&Peace'; @items = ['A','B','C']"
+      ctx_file = "tmpdata.rb"
+      sout, serr = with_erubyfile do |fname|
+        with_tmpfile(ctx_file, ctx_str) do
+          dummy_stdio { Main.main(["-Hf#{ctx_file}", fname]) }
+        end
+      end
+      assert_equal OUTPUT_HTML, sout
+      assert_equal "", serr
+      ## when file not found
+      sout, serr = with_erubyfile do |fname|
+        dummy_stdio { Main.main(['-Hf', ctx_file, fname]) }
+      end
+      assert_equal "", sout
+      assert_equal "-f #{ctx_file}: file not found.\n", serr
+      ## when syntax error exists
+      ctx_str = "@title = 'Love&Peace' @items = ['A','B','C']"
+      sout, serr = with_erubyfile do |fname|
+        with_tmpfile(ctx_file, ctx_str) do
+          dummy_stdio { Main.main(['-Hf', ctx_file, fname]) }
+        end
+      end
+      expected = "-f #{ctx_file}: Ruby syntax error: (SyntaxError) unexpected tIVAR, expecting $end
+@title = 'Love&Peace' @items = ['A','B','C']
+                            ^\n"
+      expected = expected.sub(/\$end/, "end-of-input") if RUBY_VERSION =~ /^2\./
+      expected = "-f #{ctx_file}: Ruby syntax error: (SyntaxError) expecting $end: (eval):1:28\n" if defined?(RUBY_ENGINE) && RUBY_ENGINE == 'rbx'
+      assert_equal "", sout
+      assert_equal expected, serr
+    end
+
+    it "reports error when unknown data file suffix." do
+      ctx_str = '{"title": "Love&Peace", "items": ["A","B","C"]}'
+      ctx_file = "tmpdata.js"
+      sout, serr = with_erubyfile do |fname|
+        with_tmpfile(ctx_file, ctx_str) do
+          dummy_stdio { Main.main(["-Hf#{ctx_file}", fname]) }
+        end
+      end
+      assert_equal "", sout
+      assert_equal "-f #{ctx_file}: unknown suffix (expected '.yaml', '.json', or '.rb').\n", serr
+    end
+
+  end
+
+
+  describe '--format={text|html}' do
+
+    it "can enforce text format." do
+      ctx_str = "{title: Love&Peace, items: [A, B, C]}"
+      sout, serr = with_erubyfile do |fname|
+        dummy_stdio { Main.main(['--format=text', '-c', ctx_str, fname]) }
+      end
+      assert_equal OUTPUT_TEXT, sout
+      assert_equal "", serr
+    end
+
+    it "can enforce html format." do
+      ctx_str = "{title: Love&Peace, items: [A, B, C]}"
+      sout, serr = with_erubyfile do |fname|
+        dummy_stdio { Main.main(['--format=html', '-c', ctx_str, fname]) }
+      end
+      assert_equal OUTPUT_HTML, sout
+      assert_equal "", serr
+    end
+
+    it "reports error when argument is missng." do
+      status = nil
+      sout, serr = with_erubyfile do |fname|
+        dummy_stdio { status = Main.main(['-x', '--format', fname]) }
+      end
+      assert_equal "", sout
+      assert_equal "#{File.basename($0)}: --format: argument required.\n", serr
+      assert_equal 1, status
+    end
+
+    it "reports error when unknown argument." do
+      status = nil
+      sout, serr = with_erubyfile do |fname|
+        dummy_stdio { status = Main.main(['-x', '--format=json', fname]) }
+      end
+      assert_equal "", sout
+      assert_equal "#{File.basename($0)}: --format=json: 'text' or 'html' expected\n", serr
+      assert_equal 1, status
+    end
+
+  end
+
+
+  describe '--encoding=name' do
+
+    it "can specify encoding of file content." do
+      sout, serr = with_erubyfile do |fname|
+        dummy_stdio { status = Main.main(['-x', '--encoding=utf-8', fname]) }
+      end
+      assert_equal _modify(SOURCE_TEXT), sout
+      assert_equal "" , serr
+    end
+
+  end
+
+
+  describe '--freeze={true|false}' do
+
+    it "can generate ruby code using String#freeze." do
+      sout, serr = with_erubyfile do |fname|
+        dummy_stdio { Main.main(['-x', '--freeze=true', fname]) }
+      end
+      expected = _modify(SOURCE_TEXT).gsub(/([^'])';/, "\\1'.freeze;")
+      assert_equal expected, sout
+    end
+
+    it "can generate ruby code without String#freeze." do
+      sout, serr = with_erubyfile do |fname|
+        dummy_stdio { Main.main(['-x', '--freeze=false', fname]) }
+      end
+      expected = SOURCE_TEXT
+      assert_equal expected, sout
+    end
+
+    it "reports error when argument is missing." do
+      status = nil
+      sout, serr = with_erubyfile do |fname|
+        dummy_stdio { status = Main.main(['-x', '--freeze', fname]) }
+      end
+      assert_equal "", sout
+      assert_equal "#{File.basename($0)}: --freeze: argument required.\n", serr
+      assert_equal 1, status
+    end
+
+    it "reports error when unknown argument." do
+      status = nil
+      sout, serr = with_erubyfile do |fname|
+        dummy_stdio { status = Main.main(['-x', '--freeze=yes', fname]) }
+      end
+      assert_equal "", sout
+      assert_equal "#{File.basename($0)}: --freeze=yes: 'true' or 'false' expected\n", serr
+      assert_equal 1, status
+    end
+
+  end
+
+
+end
+
+
+describe Cmdopt::Parser do
+
+  let(:parser) { Main.new.__send__(:build_parser) }
+
+
+  describe '#parse()' do
+
+    it "parses short options." do
+      argv = ["-vh", "-xc", "{x: 1}", "-fdata.txt", "file1", "file2"]
+      options = parser.parse(argv)
+      expected = {'version'=>true, 'help'=>true, 'x'=>true, 'c'=>'{x: 1}', 'f'=>'data.txt'}
+      assert_equal expected, options
+      assert_equal ["file1", "file2"], argv
+    end
+
+    it "parses long options" do
+      argv = ["--help", "--version", "--format=html", "--freeze=true", "file1", "file2"]
+      options = parser.parse(argv)
+      expected = {'version'=>true, 'help'=>true, 'format'=>'html', 'freeze'=>'true'}
+      assert_equal expected, options
+      assert_equal ["file1", "file2"], argv
+    end
+
+    it "raises error when required argument of short option is missing." do
+      argv = ["-f"]
+      ex = assert_raises Cmdopt::ParseError do
+        options = parser.parse(argv)
+      end
+      assert_equal "#{File.basename($0)}: -f: argument required.", ex.message
+    end
+
+    it "raises error when required argument of long option is missing." do
+      argv = ["--format", "file1"]
+      ex = assert_raises Cmdopt::ParseError do
+        options = parser.parse(argv)
+      end
+      assert_equal "#{File.basename($0)}: --format: argument required.", ex.message
+    end
+
+  end
+
+
+end