erubis 2.3.1 → 2.7.0

data/lib/erubis/main.rb

@@ -1,7 +1,6 @@
 ###
-### $Rev: 78 $
-### $Release: 2.3.1 $
-### copyright(c) 2006-2007 kuwata-lab.com all rights reserved.
+### $Release: 2.7.0 $
+### copyright(c) 2006-2011 kuwata-lab.com all rights reserved.
 ###
 
 require 'yaml'
@@ -12,6 +11,7 @@ require 'erubis/engine/optimized'
 require 'erubis/engine/eruby'
 require 'erubis/engine/ephp'
 require 'erubis/engine/ec'
+require 'erubis/engine/ecpp'
 require 'erubis/engine/ejava'
 require 'erubis/engine/escheme'
 require 'erubis/engine/eperl'
@@ -52,34 +52,34 @@ module Erubis
       @single_options = "hvxztTSbeBXNUC"
       @arg_options    = "pcrfKIlaE" #C
       @option_names   = {
-        ?h => :help,
-        ?v => :version,
-        ?x => :source,
-        ?z => :syntax,
-        ?T => :unexpand,
-        ?t => :untabify,      # obsolete
-        ?S => :intern,
-        ?b => :bodyonly,
-        ?B => :binding,
-        ?p => :pattern,
-        ?c => :context,
-        #?C => :class,
-        ?e => :escape,
-        ?r => :requires,
-        ?f => :datafiles,
-        ?K => :kanji,
-        ?I => :includes,
-        ?l => :lang,
-        ?a => :action,
-        ?E => :enhancers,
-        ?X => :notext,
-        ?N => :linenum,
-        ?U => :unique,
-        ?C => :compact,
+        'h' => :help,
+        'v' => :version,
+        'x' => :source,
+        'z' => :syntax,
+        'T' => :unexpand,
+        't' => :untabify,      # obsolete
+        'S' => :intern,
+        'b' => :bodyonly,
+        'B' => :binding,
+        'p' => :pattern,
+        'c' => :context,
+        #'C' => :class,
+        'e' => :escape,
+        'r' => :requires,
+        'f' => :datafiles,
+        'K' => :kanji,
+        'I' => :includes,
+        'l' => :lang,
+        'a' => :action,
+        'E' => :enhancers,
+        'X' => :notext,
+        'N' => :linenum,
+        'U' => :unique,
+        'C' => :compact,
       }
       assert unless @single_options.length + @arg_options.length == @option_names.length
       (@single_options + @arg_options).each_byte do |ch|
-        assert unless @option_names.key?(ch)
+        assert unless @option_names.key?(ch.chr)
       end
     end
 
@@ -88,9 +88,9 @@ module Erubis
       ## parse command-line options
       options, properties = parse_argv(argv, @single_options, @arg_options)
       filenames = argv
-      options[?h] = true if properties[:help]
+      options['h'] = true if properties[:help]
       opts = Object.new
-      arr = @option_names.collect { |ch, name| "def #{name}; @#{name}; end\n" }
+      arr = @option_names.collect {|ch, name| "def #{name}; @#{name}; end\n" }
       opts.instance_eval arr.join
       options.each do |ch, val|
         name = @option_names[ch]
@@ -166,14 +166,15 @@ module Erubis
       msg = "Syntax OK\n"
       if filenames && !filenames.empty?
         filenames.each do |filename|
-          test(?f, filename)  or raise CommandOptionError.new("#{filename}: file not found.")
+          File.file?(filename)  or
+            raise CommandOptionError.new("#{filename}: file not found.")
           engine.filename = filename
           engine.convert!(File.read(filename))
           val = do_action(action, engine, context, filename, opts)
           msg = nil if val
         end
       else
-        engine.filename = '(stdin)'
+        engine.filename = filename = '(stdin)'
         engine.convert!($stdin.read())
         val = do_action(action, engine, context, filename, opts)
         msg = nil if val
@@ -215,8 +216,8 @@ module Erubis
       return source
     end
 
-    def usage
-      command = File.basename($0)
+    def usage(command=nil)
+      command ||= File.basename($0)
       buf = []
       buf << "erubis - embedded program converter for multi-language"
       buf << "Usage: #{command} [..options..] [file ...]"
@@ -231,7 +232,7 @@ module Erubis
       buf << "  -z            : syntax checking"
       buf << "  -e            : escape (equal to '--E Escape')"
       buf << "  -p pattern    : embedded pattern (default '<% %>')"
-      buf << "  -l lang       : convert but no execute (ruby/php/c/java/scheme/perl/js)"
+      buf << "  -l lang       : convert but no execute (ruby/php/c/cpp/java/scheme/perl/js)"
       buf << "  -E e1,e2,...  : enhancer names (Escape, PercentLine, BiPattern, ...)"
       buf << "  -I path       : library include path"
       buf << "  -K kanji      : kanji code (euc/sjis/utf8) (default none)"
@@ -247,10 +248,9 @@ module Erubis
       #  -c class      : class name (XmlEruby/PercentLineEruby/...) (default Eruby)
       #  -r library    : require library
       #  -a            : action (convert/execute)
-      return join("\n")
+      return buf.join("\n")
     end
 
-
     def collect_supported_properties(erubis_klass)
       list = []
       erubis_klass.ancestors.each do |klass|
@@ -270,7 +270,7 @@ module Erubis
       list << ['(common)', common_props]
       list << ['(basic)',  basic_props - common_props]
       list << ['(pi)',     pi_props    - common_props]
-      %w[ruby php c java scheme perl javascript].each do |lang|
+      %w[ruby php c cpp java scheme perl javascript].each do |lang|
         klass = Erubis.const_get("E#{lang}")
         list << [lang, collect_supported_properties(klass) - basic_props]
       end
@@ -285,14 +285,13 @@ module Erubis
     end
 
     def show_enhancers
+      dict = {}
+      ObjectSpace.each_object(Module) do |mod|
+        dict[$1] = mod if mod.name =~ /\AErubis::(.*)Enhancer\z/
+      end
       s = "enhancers:\n"
-      list = []
-      ObjectSpace.each_object(Module) do |m| list << m end
-      list.sort_by { |m| m.name }.each do |m|
-        next unless m.name =~ /\AErubis::(.*)Enhancer\z/
-        name = $1
-        desc = m.desc
-        s << ("  %-13s : %s\n" % [name, desc])
+      dict.sort_by {|name, mod| name }.each do |name, mod|
+        s << ("  %-13s : %s\n" % [name, mod.desc])
       end
       return s
     end
@@ -309,10 +308,9 @@ module Erubis
         optstr = optstr[1, optstr.length-1]
         #
         if optstr[0] == ?-    # context
-          unless optstr =~ /\A\-([-\w]+)(?:=(.*))?/
+          optstr =~ /\A\-([-\w]+)(?:=(.*))?/  or
             raise CommandOptionError.new("-#{optstr}: invalid context value.")
-          end
-          name = $1;  value = $2
+          name, value = $1, $2
           name  = name.gsub(/-/, '_').intern
           #value = value.nil? ? true : YAML.load(value)   # error, why?
           value = value.nil? ? true : YAML.load("---\n#{value}\n")
@@ -320,16 +318,13 @@ module Erubis
           #
         else                  # options
           while optstr && !optstr.empty?
-            optchar = optstr[0]
-            optstr[0,1] = ""
+            optchar = optstr[0].chr
+            optstr = optstr[1..-1]
             if arg_none.include?(optchar)
               options[optchar] = true
             elsif arg_required.include?(optchar)
-              arg = optstr.empty? ? argv.shift : optstr
-              unless arg
-                mesg = "-#{optchar.chr}: #{@option_args[optchar]} required."
-                raise CommandOptionError.new(mesg)
-              end
+              arg = optstr.empty? ? argv.shift : optstr  or
+                raise CommandOptionError.new("-#{optchar}: #{@option_names[optchar]} required.")
               options[optchar] = arg
               optstr = nil
             elsif arg_optional.include?(optchar)
@@ -337,7 +332,7 @@ module Erubis
               options[optchar] = arg
               optstr = nil
             else
-              raise CommandOptionError.new("-#{optchar.chr}: unknown option.")
+              raise CommandOptionError.new("-#{optchar}: unknown option.")
             end
           end
         end
@@ -396,18 +391,19 @@ module Erubis
       enhancers = []
       shortname = nil
       begin
-        enhancer_names.split(/,/).each do |shortname|
+        enhancer_names.split(/,/).each do |name|
+          shortname = name
           enhancers << Erubis.const_get("#{shortname}Enhancer")
         end
       rescue NameError
-        raise CommandOptionError.new("#{shortname}: no such Enhancer (try '-E' to show all enhancers).")
+        raise CommandOptionError.new("#{shortname}: no such Enhancer (try '-h' to show all enhancers).")
       end
       return enhancers
     end
 
     def load_datafiles(filenames, opts)
       context = Erubis::Context.new
-      return hash unless filenames
+      return context unless filenames
       filenames.split(/,/).each do |filename|
         filename.strip!
         test(?f, filename) or raise CommandOptionError.new("#{filename}: file not found.")
@@ -473,7 +469,10 @@ module Erubis
 
     def check_syntax(filename, src)
       require 'open3'
-      stdin, stdout, stderr = Open3.popen3('ruby -wc')
+      #command = (ENV['_'] || 'ruby') + ' -wc'   # ENV['_'] stores command name
+      bin = ENV['_'] && File.basename(ENV['_']) =~ /^ruby/ ? ENV['_'] : 'ruby'
+      command = bin + ' -wc'
+      stdin, stdout, stderr = Open3.popen3(command)
       stdin.write(src)
       stdin.close
       result = stdout.read()
@@ -486,6 +485,32 @@ module Erubis
       return "#{filename}:#{linenum}: #{message}"
     end
 
+    if defined?(RUBY_ENGINE) && RUBY_ENGINE == "rbx"
+      def check_syntax(filename, src)
+        require 'compiler'
+        verbose = $VERBOSE
+        msg = nil
+        begin
+          $VERBOSE = true
+          Rubinius::Compiler.compile_string(src, filename)
+        rescue SyntaxError => ex
+          ex_linenum = ex.line
+          linenum = 0
+          srcline = src.each_line do |line|
+            linenum += 1
+            break line if linenum == ex_linenum
+          end
+          msg = "#{ex.message}\n"
+          msg << srcline
+          msg << "\n" unless srcline =~ /\n\z/
+          msg << (" " * (ex.column-1)) << "^\n"
+        ensure
+          $VERBOSE = verbose
+        end
+        return msg
+      end
+    end
+
   end
 
 end

data/lib/erubis/preprocessing.rb

@@ -0,0 +1,58 @@
+###
+### $Release: 2.7.0 $
+### copyright(c) 2006-2011 kuwata-lab.com all rights reserved.
+###
+
+require 'cgi'
+
+
+module Erubis
+
+
+  ##
+  ## for preprocessing
+  ##
+  class PreprocessingEruby < Erubis::Eruby
+
+    def initialize(input, params={})
+      params = params.dup
+      params[:pattern] ||= '\[% %\]'    # use '[%= %]' instead of '<%= %>'
+      #params[:escape] = true            # transport '[%= %]' and '[%== %]'
+      super
+    end
+
+    def add_expr_escaped(src, code)
+      add_expr_literal(src, "_decode((#{code}))")
+    end
+
+  end
+
+
+  ##
+  ## helper methods for preprocessing
+  ##
+  module PreprocessingHelper
+
+    module_function
+
+    def _p(arg)
+      return "<%=#{arg}%>"
+    end
+
+    def _P(arg)
+      return "<%=h(#{arg})%>"
+    end
+
+    alias _? _p
+
+    def _decode(arg)
+      arg = arg.to_s
+      arg.gsub!(/%3C%25(?:=|%3D)(.*?)%25%3E/) { "<%=#{CGI.unescape($1)}%>" }
+      arg.gsub!(/&lt;%=(.*?)%&gt;/) { "<%=#{CGI.unescapeHTML($1)}%>" }
+      return arg
+    end
+
+  end
+
+
+end

data/lib/erubis/tiny.rb

@@ -1,7 +1,6 @@
 ##
-## $Rev: 77 $
-## $Release: 2.3.1 $
-## copyright(c) 2006-2007 kuwata-lab.com all rights reserved.
+## $Release: 2.7.0 $
+## copyright(c) 2006-2011 kuwata-lab.com all rights reserved.
 ##
 
 module Erubis
@@ -28,10 +27,9 @@ module Erubis
       src = "_buf = '';"           # preamble
       pos = 0
       input.scan(EMBEDDED_PATTERN) do |indicator, code|
-        match = Regexp.last_match
-        len   = match.begin(0) - pos
-        text  = input[pos, len]
-        pos   = match.end(0)
+        m = Regexp.last_match
+        text = input[pos...m.begin(0)]
+        pos  = m.end(0)
         #src << " _buf << '" << escape_text(text) << "';"
         text.gsub!(/['\\]/, '\\\\\&')
         src << " _buf << '" << text << "';" unless text.empty?
@@ -43,7 +41,8 @@ module Erubis
           src << " _buf << (" << code << ").to_s;"
         end
       end
-      rest = $' || input
+      #rest = $' || input                        # ruby1.8
+      rest = pos == 0 ? input : input[pos..-1]   # ruby1.9
       #src << " _buf << '" << escape_text(rest) << "';"
       rest.gsub!(/['\\]/, '\\\\\&')
       src << " _buf << '" << rest << "';" unless rest.empty?
@@ -113,7 +112,8 @@ module Erubis
           end
         end
       end
-      rest = $' || input
+      #rest = $' || input                        # ruby1.8
+      rest = pos == 0 ? input : input[pos..-1]   # ruby1.9
       #src << " _buf << '" << escape_text(rest) << "';"
       rest.gsub!(/['\\]/, '\\\\\&')
       src << " _buf << '" << rest << "';" unless rest.empty?

data/lib/erubis/util.rb

@@ -0,0 +1,22 @@
+##
+## $Release: 2.7.0 $
+## copyright(c) 2006-2011 kuwata-lab.com all rights reserved.
+##
+
+module Kernel
+
+  ##
+  ## raise NotImplementedError
+  ##
+  def not_implemented     #:doc:
+    backtrace = caller()
+    method_name = (backtrace.shift =~ /`(\w+)'$/) && $1
+    mesg = "class #{self.class.name} must implement abstract method '#{method_name}()'."
+    #mesg = "#{self.class.name}##{method_name}() is not implemented."
+    err = NotImplementedError.new mesg
+    err.set_backtrace backtrace
+    raise err
+  end
+  private :not_implemented
+
+end

data/lib/erubis.rb

@@ -1,7 +1,6 @@
 ##
-## $Rev: 59 $
-## 2.3.1
-## copyright(c) 2006-2007 kuwata-lab.com all rights reserved.
+## $Release: 2.7.0 $
+## copyright(c) 2006-2011 kuwata-lab.com all rights reserved.
 ##
 
 ##
@@ -48,7 +47,7 @@
 
 
 module Erubis
-  VERSION = ('$Release: 2.3.1 $' =~ /([.\d]+)/) && $1
+  VERSION = ('$Release: 2.7.0 $' =~ /([.\d]+)/) && $1
 end
 
 require 'erubis/engine'
@@ -57,6 +56,7 @@ require 'erubis/engine'
 #require 'erubis/evaluator'
 #require 'erubis/error'
 #require 'erubis/context'
+#requier 'erubis/util'
 require 'erubis/helper'
 require 'erubis/enhancer'
 #require 'erubis/tiny'

data/test/assert-text-equal.rb

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

data/test/data/users-guide/bufvar-example.rb

@@ -0,0 +1,10 @@
+require 'erubis'
+input = File.read('example.eruby')
+
+puts "----- default -----"
+eruby = Erubis::FastEruby.new(input)
+puts eruby.src
+
+puts "----- with :bufvar option -----"
+eruby = Erubis::FastEruby.new(input, :bufvar=>'@_out_buf')
+print eruby.src

data/test/data/users-guide/bufvar-example.result

@@ -0,0 +1,17 @@
+$ ruby bufvar-example.rb
+----- default -----
+_buf = ''; _buf << %Q`<div>\n`
+ for item in list 
+ _buf << %Q`  <p>#{ item }</p>
+  <p>#{Erubis::XmlHelper.escape_xml( item )}</p>\n`
+ end 
+ _buf << %Q`</div>\n`
+_buf.to_s
+----- with :bufvar option -----
+@_out_buf = ''; @_out_buf << %Q`<div>\n`
+ for item in list 
+ @_out_buf << %Q`  <p>#{ item }</p>
+  <p>#{Erubis::XmlHelper.escape_xml( item )}</p>\n`
+ end 
+ @_out_buf << %Q`</div>\n`
+@_out_buf.to_s

data/test/data/users-guide/def_method.rb

@@ -0,0 +1,14 @@
+require 'erubis'
+s = "hello <%= name %>"
+eruby = Erubis::Eruby.new(s)
+filename = 'hello.rhtml'
+
+## define instance method to Dummy class (or module)
+class Dummy; end
+eruby.def_method(Dummy, 'render(name)', filename)  # filename is optional
+p Dummy.new.render('world')    #=> "hello world"
+
+## define singleton method to dummy object
+obj = Object.new
+eruby.def_method(obj, 'render(name)', filename)    # filename is optional
+p obj.render('world')          #=> "hello world"

data/test/data/users-guide/def_method.result

@@ -0,0 +1,3 @@
+$ ruby def_method.rb
+"hello world"
+"hello world"

data/test/data/users-guide/example.ecpp

@@ -0,0 +1,30 @@
+<%
+#include <string>
+#include <iostream>
+#include <sstream>
+
+int main(int argc, char *argv[])
+{
+    std::stringstream _buf;
+%>
+<html>
+ <body>
+  <p>Hello <%= argv[0] %>!</p>
+  <table>
+   <tbody>
+    <% for (int i = 1; i < argc; i++) { %>
+    <tr bgcolor="<%= i % 2 == 0 ? "#FFCCCC" : "#CCCCFF" %>">
+      <td><%= i %></td>
+      <td><%= argv[i] %></td>
+    </tr>
+    <% } %>
+   </tbody>
+  </table>
+ </body>
+</html>
+<%
+    std::string output = _buf.str();
+    std::cout << output;
+    return 0; 
+}
+%>

data/test/data/users-guide/example1.rb

@@ -8,6 +8,7 @@ puts eruby.src                      # print script source
 puts "---------- result ----------"
 list = ['aaa', 'bbb', 'ccc']
 puts eruby.result(binding())        # get result
+## or puts eruby.result(:list=>list)  # or pass Hash instead of Binding
 
 ## # or
 ## eruby = Erubis::Eruby.new

data/test/data/users-guide/example_c.result

@@ -1,29 +1,32 @@
-$ erubis -l c example.ec
-#line 1 "example.ec"
+$ erubis -l cpp example.ecpp
+#line 1 "example.ecpp"
 
-#include <stdio.h>
+#include <string>
+#include <iostream>
+#include <sstream>
 
 int main(int argc, char *argv[])
 {
-    int i;
+    std::stringstream _buf;
 
-
-fputs("<html>\n"
-      " <body>\n"
-      "  <p>Hello ", stdout); fprintf(stdout, "%s", argv[0]); fputs("!</p>\n"
-      "  <table>\n"
-      "   <tbody>\n", stdout);
-     for (i = 1; i < argc; i++) { 
-fputs("    <tr bgcolor=\"", stdout); fprintf(stdout, i % 2 == 0 ? "#FFCCCC" : "#CCCCFF"); fputs("\">\n"
-      "      <td>", stdout); fprintf(stdout, "%d", i); fputs("</td>\n"
-      "      <td>", stdout); fprintf(stdout, "%s", argv[i]); fputs("</td>\n"
-      "    </tr>\n", stdout);
+_buf << "<html>\n"
+        " <body>\n"
+        "  <p>Hello "; _buf << (argv[0]); _buf << "!</p>\n"
+        "  <table>\n"
+        "   <tbody>\n";
+     for (int i = 1; i < argc; i++) { 
+_buf << "    <tr bgcolor=\""; _buf << (i % 2 == 0 ? "#FFCCCC" : "#CCCCFF"); _buf << "\">\n"
+        "      <td>"; _buf << (i); _buf << "</td>\n"
+        "      <td>"; _buf << (argv[i]); _buf << "</td>\n"
+        "    </tr>\n";
      } 
-fputs("   </tbody>\n"
-      "  </table>\n"
-      " </body>\n"
-      "</html>\n", stdout);
+_buf << "   </tbody>\n"
+        "  </table>\n"
+        " </body>\n"
+        "</html>\n";
 
+    std::string output = _buf.str();
+    std::cout << output;
     return 0; 
 }
 

data/test/data/users-guide/fasteruby-example.rb

@@ -0,0 +1,8 @@
+require 'erubis'
+input = File.read('example.eruby')
+
+puts "----- Erubis::Eruby -----"
+print Erubis::Eruby.new(input).src
+
+puts "----- Erubis::FastEruby -----"
+print Erubis::FastEruby.new(input).src

data/test/data/users-guide/fasteruby-example.result

@@ -0,0 +1,18 @@
+$ ruby fasteruby-example.rb
+----- Erubis::Eruby -----
+_buf = ''; _buf << '<div>
+'; for item in list 
+ _buf << '  <p>'; _buf << ( item ).to_s; _buf << '</p>
+  <p>'; _buf << Erubis::XmlHelper.escape_xml( item ); _buf << '</p>
+'; end 
+ _buf << '</div>
+';
+_buf.to_s
+----- Erubis::FastEruby -----
+_buf = ''; _buf << %Q`<div>\n`
+ for item in list 
+ _buf << %Q`  <p>#{ item }</p>
+  <p>#{Erubis::XmlHelper.escape_xml( item )}</p>\n`
+ end 
+ _buf << %Q`</div>\n`
+_buf.to_s

data/test/data/users-guide/main_program1.rb

@@ -0,0 +1,8 @@
+require 'erubis'
+eruby = Erubis::Eruby.new(File.read('template1.rhtml'))
+items = ['foo', 'bar', 'baz']
+x = 1
+## local variable 'x' and 'eruby' are passed to template as well as 'items'!
+print eruby.result(binding())    
+## local variable 'x' is changed unintendedly because it is changed in template!
+puts "** debug: x=#{x.inspect}"  #=> "baz"

data/test/data/users-guide/main_program1.result

@@ -0,0 +1,6 @@
+$ ruby main_program1.rb
+item = foo
+item = bar
+item = baz
+** debug: local variables=["eruby", "items", "x", "_buf"]
+** debug: x="baz"

data/test/data/users-guide/main_program2.rb

@@ -0,0 +1,8 @@
+require 'erubis'
+eruby = Erubis::Eruby.new(File.read('template2.rhtml'))
+items = ['foo', 'bar', 'baz']
+x = 1
+## only 'items' are passed to template
+print eruby.evaluate(:items=>items)    
+## local variable 'x' is not changed!
+puts "** debug: x=#{x.inspect}"  #=> 1

data/test/data/users-guide/main_program2.result

@@ -0,0 +1,6 @@
+$ ruby main_program2.rb
+item = foo
+item = bar
+item = baz
+** debug: local variables=["_context", "x", "_buf"]
+** debug: x=1

data/test/data/users-guide/percentline-example.rhtml

@@ -1,4 +1,6 @@
+<ul>
 % for item in list
-  <b><%= item %></b>
+  <li><%= item %></li>
 % end
+</ul>
 %% lines with '%%'