erubis 2.1.0 → 2.2.0

data/lib/erubis/local-setting.rb

@@ -1,10 +1,10 @@
 ##
-## $Rev: 13 $
-## $Release: 2.1.0 $
-## copyright(c) 2006 kuwata-lab all rights reserved.
+## $Rev: 42 $
+## $Release: 2.2.0 $
+## copyright(c) 2006-2007 kuwata-lab all rights reserved.
 ##
 
 ##
 ## you can add site-local settings here.
-## this files is 'require'd by erubis.rb
+## this files is required by erubis.rb
 ##

data/lib/erubis/main.rb

@@ -1,7 +1,7 @@
 ###
-### $Rev: 41 $
-### $Release: 2.1.0 $
-### copyright(c) 2006 kuwata-lab all rights reserved.
+### $Rev: 65 $
+### $Release: 2.2.0 $
+### copyright(c) 2006-2007 kuwata-lab all rights reserved.
 ###
 
 require 'yaml'
@@ -49,22 +49,24 @@ module Erubis
     end
 
     def initialize
-      @single_options = "hvxTtSbeB"
-      @arg_options    = "pcrfKIlaE"
+      @single_options = "hvxztSbeB"
+      @arg_options    = "pcrfKIlaEC"
       @option_names   = {
         ?h => :help,
         ?v => :version,
         ?x => :source,
-        ?T => :notrim,
+        ?z => :syntax,
+        #?T => :notrim,
         ?t => :untabify,
         ?S => :intern,
         ?b => :bodyonly,
         ?B => :binding,
         ?p => :pattern,
-        ?c => :class,
+        ?c => :context,
+        ?C => :class,
         ?e => :escape,
         ?r => :requires,
-        ?f => :yamlfiles,
+        ?f => :datafiles,
         ?K => :kanji,
         ?I => :includes,
         ?l => :lang,
@@ -112,6 +114,7 @@ module Erubis
 
       ## action
       action = opts.action
+      action ||= 'syntax'  if opts.syntax
       action ||= 'convert' if opts.source
 
       ## lang
@@ -126,13 +129,18 @@ module Erubis
       $KCODE = opts.kanji if opts.kanji
 
       ## read context values from yaml file
-      yamlfiles = opts.yamlfiles
-      context = load_yamlfiles(yamlfiles, opts)
+      datafiles = opts.datafiles
+      context = load_datafiles(datafiles, opts)
+
+      ## parse context data
+      if opts.context
+        context = parse_context_data(opts.context, opts)
+      end
 
       ## properties for engine
       properties[:escape]   = true         if opts.escape && !properties.key?(:escape)
       properties[:pattern]  = opts.pattern if opts.pattern
-      properties[:trim]     = false        if opts.notrim
+      #properties[:trim]     = false        if opts.notrim
       properties[:preamble] = properties[:postamble] = false if opts.bodyonly
       properties[:pi]       = nil          if properties[:pi] == true
 
@@ -147,32 +155,39 @@ module Erubis
 
       ## convert and execute
       val = nil
+      msg = "Syntax OK\n"
       if filenames && !filenames.empty?
         filenames.each do |filename|
           test(?f, filename)  or raise CommandOptionError.new("#{filename}: file not found.")
           engine.filename = filename
           engine.convert!(File.read(filename))
-          print val if val = do_action(action, engine, context, opts)
+          val = do_action(action, engine, context, filename, opts)
+          msg = nil if val
         end
       else
         engine.filename = '(stdin)'
         engine.convert!($stdin.read())
-        print val if val = do_action(action, engine, context, opts)
+        val = do_action(action, engine, context, filename, opts)
+        msg = nil if val
       end
+      print msg if action == 'syntax' && msg
 
     end
 
     private
 
-    def do_action(action, engine, context, opts)
+    def do_action(action, engine, context, filename, opts)
       case action
       when 'convert'
         s = engine.src
       when nil, 'exec', 'execute'
-        s = opts.binding ? engine.result(context) : engine.evaluate(context)
+        s = opts.binding ? engine.result(context.to_hash) : engine.evaluate(context)
+      when 'syntax'
+        s = check_syntax(filename, engine.src)
       else
         raise "*** internal error"
       end
+      print s if s
       return s
     end
 
@@ -183,8 +198,8 @@ erubis - embedded program converter for multi-language
 Usage: #{command} [..options..] [file ...]
   -h, --help    : help
   -v            : version
-  -x            : converted code
-  -T            : don't trim spaces around '<% %>'
+  -x            : show converted code
+  -z            : syntax checking
   -b            : body only (no preamble nor postamble)
   -e            : escape (equal to '--E Escape')
   -p pattern    : embedded pattern (default '<% %>')
@@ -192,7 +207,8 @@ Usage: #{command} [..options..] [file ...]
   -E e1,e2,...  : enhancer names (Escape, PercentLine, BiPattern, ...)
   -I path       : library include path
   -K kanji      : kanji code (euc/sjis/utf8) (default none)
-  -f file.yaml  : YAML file for context values (read stdin if filename is '-')
+  -c context    : context data string (yaml inline style or ruby code)
+  -f datafile   : context data file ('*.yaml', '*.yml', or '*.rb')
   -t            : expand tab character in YAML file
   -S            : convert mapping key from string to symbol in YAML file
   -B            : invoke 'result(binding)' instead of 'evaluate(context)'
@@ -200,6 +216,7 @@ Usage: #{command} [..options..] [file ...]
 
 END
       #'
+      #  -T            : don't trim spaces around '<% %>'
       #  -c class      : class name (XmlEruby/PercentLineEruby/...) (default Eruby)
       #  -r library    : require library
       #  -a            : action (convert/execute)
@@ -254,8 +271,7 @@ END
     end
 
     def version
-      release = ('$Release: 2.1.0 $' =~ /([.\d]+)/) && $1
-      return release
+      return Erubis::VERSION
     end
 
     def parse_argv(argv, arg_none='', arg_required='', arg_optional='')
@@ -362,27 +378,51 @@ END
       return enhancers
     end
 
-    def load_yamlfiles(yamlfiles, opts)
-      hash = {}
-      return hash unless yamlfiles
-      yamlfiles.split(/,/).each do |yamlfile|
-        if yamlfile == '-'
-          str = $stdin.read()
+    def load_datafiles(filenames, opts)
+      context = Erubis::Context.new
+      return hash unless filenames
+      filenames.split(/,/).each do |filename|
+        filename.strip!
+        test(?f, filename) or raise CommandOptionError.new("#{filename}: file not found.")
+        if filename =~ /\.ya?ml$/
+          if opts.untabify
+            ydoc = YAML.load(untabify(File.read(filename)))
+          else
+            ydoc = YAML.load_file(filename)
+          end
+          ydoc.is_a?(Hash) or raise CommandOptionError.new("#{filename}: root object is not a mapping.")
+          intern_hash_keys(ydoc) if opts.intern
+          context.update(ydoc)
+        elsif filename =~ /\.rb$/
+          str = File.read(filename)
+          context2 = Erubis::Context.new
+          _instance_eval(context2, str)
+          context.update(context2)
         else
-          test(?f, yamlfile)  or raise CommandOptionError.new("#{yamlfile}: file not found.")
-          str = File.read(yamlfile)
+          CommandOptionError.new("#{filename}: '*.yaml', '*.yml', or '*.rb' required.")
         end
-        str = yamlfile == '-' ? $stdin.read() : File.read(yamlfile)
-        str = untabify(str) if opts.untabify
-        ydoc = YAML.load(str)
+      end
+      return context
+    end
+
+    def _instance_eval(_context, _str)
+      _context.instance_eval(_str)
+    end
+
+    def parse_context_data(context_str, opts)
+      if context_str[0] == ?{
+        require 'yaml'
+        ydoc = YAML.load(context_str)
         unless ydoc.is_a?(Hash)
-          raise CommandOptionError.new("#{yamlfile}: root object is not a mapping.")
+          raise CommandOptionError.new("-c: root object is not a mapping.")
         end
         intern_hash_keys(ydoc) if opts.intern
-        hash.update(ydoc)
+        return ydoc
+      else
+        context = Erubis::Context.new
+        context.instance_eval(context_str, '-c')
+        return context
       end
-      context = hash
-      return context
     end
 
     def intern_hash_keys(obj, done={})
@@ -404,6 +444,21 @@ END
       end
     end
 
+    def check_syntax(filename, src)
+      require 'open3'
+      stdin, stdout, stderr = Open3.popen3('ruby -wc')
+      stdin.write(src)
+      stdin.close
+      result = stdout.read()
+      stdout.close()
+      errmsg = stderr.read()
+      stderr.close()
+      return nil unless errmsg && !errmsg.empty?
+      errmsg =~ /\A-:(\d+): /
+      linenum, message = $1, $'
+      return "#{filename}:#{linenum}: #{message}"
+    end
+
   end
 
 end

data/lib/erubis/tiny.rb

@@ -1,7 +1,7 @@
 ##
-## $Rev: 35 $
-## $Release: 2.1.0 $
-## copyright(c) 2006 kuwata-lab all rights reserved.
+## $Rev: 54 $
+## $Release: 2.2.0 $
+## copyright(c) 2006-2007 kuwata-lab all rights reserved.
 ##
 
 module Erubis
@@ -25,44 +25,47 @@ module Erubis
     EMBEDDED_PATTERN = /<%(=+|\#)?(.*?)-?%>/m
 
     def convert(input)
-      src = "_buf = [];"           # preamble
+      src = "_buf = '';"           # preamble
       pos = 0
       input.scan(EMBEDDED_PATTERN) do |indicator, code|
         match = Regexp.last_match
-        index = match.begin(0)
-        text  = input[pos, index - pos]
+        len   = match.begin(0) - pos
+        text  = input[pos, len]
         pos   = match.end(0)
-        src << " _buf << '" << escape_text(text) << "';"
+        #src << " _buf << '" << escape_text(text) << "';"
+        text.gsub!(/['\\]/, '\\\\\&')
+        src << " _buf << '" << text << "';" unless text.empty?
         if !indicator              # <% %>
           src << code << ";"
-        elsif indicator[0] == ?\#  # <%# %>
-          n = code.count("\n")
-          add_stmt(src, "\n" * n)
+        elsif indicator == '#'     # <%# %>
+          src << ("\n" * code.count("\n"))
         else                       # <%= %>
           src << " _buf << (" << code << ").to_s;"
         end
       end
       rest = $' || input
-      src << " _buf << '" << escape_text(rest) << "';"
-      src << "\n_buf.join\n"       # postamble
+      #src << " _buf << '" << escape_text(rest) << "';"
+      rest.gsub!(/['\\]/, '\\\\\&')
+      src << " _buf << '" << rest << "';" unless rest.empty?
+      src << "\n_buf.to_s\n"       # postamble
       return src
     end
 
-    def escape_text(text)
-      return text.gsub!(/['\\]/, '\\\\\&') || text
-    end
+    #def escape_text(text)
+    #  return text.gsub!(/['\\]/, '\\\\\&') || text
+    #end
 
-    def result(binding=TOPLEVEL_BINDING)
-      eval @src, binding
+    def result(_binding=TOPLEVEL_BINDING)
+      eval @src, _binding
     end
 
-    def evaluate(context=Object.new)
-      if context.is_a?(Hash)
-        obj = Object.new
-        context.each do |k, v| obj.instance_variable_set("@#{k}", v) end
-        context = obj
+    def evaluate(_context=Object.new)
+      if _context.is_a?(Hash)
+        _obj = Object.new
+        _context.each do |k, v| _obj.instance_variable_set("@#{k}", v) end
+        _context = _obj
       end
-      context.instance_eval @src
+      _context.instance_eval @src
     end
 
   end
@@ -81,56 +84,58 @@ module Erubis
 
     attr_reader :src
 
-    EMBEDDED_PATTERN = /(^[ \t]*)?<\?rb(\s.*?)\?>([ \t]*\r?\n)?|\$(!*)?\{(.*?)\}/
+    EMBEDDED_PATTERN = /(^[ \t]*)?<\?rb(\s.*?)\?>([ \t]*\r?\n)?|@(!+)?\{(.*?)\}@/m
 
     def convert(input)
-      src = "_buf = [];"           # preamble
+      src = "_buf = '';"           # preamble
       pos = 0
-      input.scan(EMBEDDED_PATTERN) do |lspace, stmtcode, rspace, indicator, exprcode|
+      input.scan(EMBEDDED_PATTERN) do |lspace, stmt, rspace, indicator, expr|
         match = Regexp.last_match
-        index = match.begin(0)
-        text  = input[pos, index - pos]
+        len   = match.begin(0) - pos
+        text  = input[pos, len]
         pos   = match.end(0)
-        if stmtcode                # <?rb ... ?>
-          code = stmtcode
-          src << " _buf << '" << escape_text(text) << "';"
+        #src << " _buf << '" << escape_text(text) << "';"
+        text.gsub!(/['\\]/, '\\\\\&')
+        src << " _buf << '" << text << "';" unless text.empty?
+        if stmt                # <?rb ... ?>
           if lspace && rspace
-            src << "#{lspace}#{code}#{rspace}"
+            src << "#{lspace}#{stmt}#{rspace}"
           else
-            src << " _buf << '#{lspace}';" if lspace
-            src << code << ";"
-            src << " _buf << '#{rspace}';" if rspace
+            src << " _buf << '" << lspace << "';" if lspace
+            src << stmt << ";"
+            src << " _buf << '" << rspace << "';" if rspace
           end
         else                       # ${...}, $!{...}
-          code = exprcode
-          if indicator.nil? || indicator.empty?
-            src << " _buf << #{@escape}(" << code << ");"
+          if !indicator
+            src << " _buf << " << @escape << "(" << expr << ");"
           elsif indicator == '!'
-            src << " _buf << (" << code << ").to_s;"
+            src << " _buf << (" << expr << ").to_s;"
           end
         end
       end
       rest = $' || input
-      src << " _buf << '" << escape_text(rest) << "';"
-      src << "\n_buf.join\n"       # postamble
+      #src << " _buf << '" << escape_text(rest) << "';"
+      rest.gsub!(/['\\]/, '\\\\\&')
+      src << " _buf << '" << rest << "';" unless rest.empty?
+      src << "\n_buf.to_s\n"       # postamble
       return src
     end
 
-    def escape_text(text)
-      return text.gsub!(/['\\]/, '\\\\\&') || text
-    end
+    #def escape_text(text)
+    #  return text.gsub!(/['\\]/, '\\\\\&') || text
+    #end
 
-    def result(binding=TOPLEVEL_BINDING)
-      eval @src, binding
+    def result(_binding=TOPLEVEL_BINDING)
+      eval @src, _binding
     end
 
-    def evaluate(context=Object.new)
-      if context.is_a?(Hash)
-        obj = Object.new
-        context.each do |k, v| obj.instance_variable_set("@#{k}", v) end
-        context = obj
+    def evaluate(_context=Object.new)
+      if _context.is_a?(Hash)
+        _obj = Object.new
+        _context.each do |k, v| _obj.instance_variable_set("@#{k}", v) end
+        _context = _obj
       end
-      context.instance_eval @src
+      _context.instance_eval @src
     end
 
   end

data/test/assert-text-equal.rb

@@ -1,7 +1,7 @@
 ###
 ### $Rev: 6 $
-### $Release: 2.1.0 $
-### copyright(c) 2006 kuwata-lab all rights reserved.
+### $Release: 2.2.0 $
+### copyright(c) 2006-2007 kuwata-lab all rights reserved.
 ###
 
 require 'test/unit'

data/test/test-engines.rb

@@ -1,7 +1,7 @@
 ##
-## $Rev: 40 $
-## $Release: 2.1.0 $
-## copyright(c) 2006 kuwata-lab all rights reserved.
+## $Rev: 54 $
+## $Release: 2.2.0 $
+## copyright(c) 2006-2007 kuwata-lab all rights reserved.
 ##
 
 require "#{File.dirname(__FILE__)}/test.rb"
@@ -50,7 +50,7 @@ __END__
       </table>
       <%=== i+1 %>
   expected: |
-      _buf = []; _buf << '<table>
+      _buf = ''; _buf << '<table>
        <tbody>
       ';   i = 0
            list.each_with_index do |item, i| 
@@ -63,7 +63,7 @@ __END__
       </table>
       '; $stderr.puts("*** debug: i+1=#{(i+1).inspect}"); _buf << '
       ';
-      _buf.join
+      _buf.to_s
 ##
 - name:  php1
   lang:  php