erubis 1.1.0 → 2.0.0

data/lib/erubis/engine.rb

@@ -0,0 +1,260 @@
+##
+## $Rev: 21 $
+## $Release: 2.0.0 $
+## copyright(c) 2006 kuwata-lab all rights reserved.
+##
+
+require 'abstract'
+
+
+module Erubis
+
+
+  ##
+  ## base error class
+  ##
+  class ErubisError < StandardError
+  end
+
+
+  ##
+  ## .[abstract] context object for Engine#evaluate
+  ##
+  ## ex.
+  ##   template = <<'END'
+  ##   Hello <%= @user %>!
+  ##   <% for item in @list %>
+  ##    - <%= item %>
+  ##   <% end %>
+  ##   END
+  ##
+  ##   context = Erubis::Context.new(:user=>'World', :list=>['a','b','c'])
+  ##   # or
+  ##   # context = Erubis::Context.new
+  ##   # context[:user] = 'World'
+  ##   # context[:list] = ['a', 'b', 'c']
+  ##
+  ##   eruby = Erubis::Eruby.new(template)
+  ##   print eruby.evaluate(context)
+  ##
+  class Context
+
+    def initialize(hash=nil)
+      hash.each do |name, value|
+        self[name] = value
+      end if hash
+    end
+
+    def [](key)
+      return instance_variable_get("@#{key}")
+    end
+
+    def []=(key, value)
+      return instance_variable_set("@#{key}", value)
+    end
+
+    def keys
+      return instance_variables.collect { |name| name[1,name.length-1] }
+    end
+
+  end
+
+
+  ##
+  ## [abstract] base engine class
+  ##
+  class Engine
+
+    def self.supported_properties    # :nodoc:
+      return [
+              [:pattern,  '<% %>', "embed pattern"],
+              #[:filename,  nil,    "filename"],
+              [:trim,      true,   "trim spaces around <% ... %>"],
+              [:preamble,  nil,    "preamble (no preamble when false)"],
+              [:postamble, nil,    "postamble (no postamble when false)"],
+              [:escape,    nil,     "escape function name"],
+             ]
+    end
+
+    def initialize(input, properties={})
+      #@input    = input
+      @pattern   = properties[:pattern]  || '<% %>'
+      @filename  = properties[:filename]
+      @trim      = properties[:trim] != false
+      @preamble  = properties[:preamble]
+      @postamble = properties[:postamble]
+      @escape    = properties[:escape]
+      @src       = compile(input) if input
+    end
+    attr_reader :src
+    attr_accessor :filename
+
+    ## load file and create engine object
+    def self.load_file(filename, properties={})
+      input = File.open(filename, 'rb') { |f| f.read }
+      input.untaint   # is it ok?
+      properties[:filename] = filename
+      engine = self.new(input, properties)
+      return engine
+    end
+
+    ## eval(@src) with binding
+    def result(_binding_or_hash=TOPLEVEL_BINDING)
+      _arg = _binding_or_hash
+      if _arg.is_a?(Hash)
+        ## load _context data as local variables by eval
+        eval _arg.keys.inject("") { |s, k| s << "#{k.to_s} = _arg[#{k.inspect}];" }
+        _arg = binding()
+      end
+      return eval(@src, _arg, (@filename || '(erubis)'))
+    end
+
+    ## call context.instance_eval(@src)
+    def evaluate(context=Context.new)
+      context = Context.new(context) if context.is_a?(Hash)
+      return context.instance_eval(@src, (@filename || '(erubis)'))
+    end
+
+    DEFAULT_REGEXP = /(.*?)(^[ \t]*)?<%(=+|\#)?(.*?)-?%>([ \t]*\r?\n)?/m
+
+    ## return regexp of pattern to parse eRuby script
+    def pattern_regexp(pattern=@pattern)
+      if pattern == '<% %>'
+        return DEFAULT_REGEXP
+      else
+        prefix, postfix = pattern.split()
+        return /(.*?)(^[ \t]*)?#{prefix}(=+|\#)?(.*?)-?#{postfix}([ \t]*\r?\n)?/m
+      end
+    end
+    protected :pattern_regexp
+
+    ## compile input string into target language
+    def compile(input)
+      src = ""
+      @preamble.nil? ? add_preamble(src) : (@preamble && (src << @preamble))
+      regexp = pattern_regexp(@pattern)
+      input.scan(regexp) do |text, lspace, indicator, code, rspace|
+        add_text(src, text)
+        ## * when '<%= %>', do nothing
+        ## * when '<% %>' or '<%# %>', delete spaces iff only spaces are around '<% %>'
+        if !indicator               # <% %>
+          if @trim && lspace && rspace
+            add_stmt(src, "#{lspace}#{code}#{rspace}")
+          else
+            add_text(src, lspace) if lspace
+            add_stmt(src, code)
+            add_text(src, rspace) if rspace
+          end
+        elsif indicator[0] == ?\#   # <%# %>
+          n = code.count("\n") + (rspace ? 1 : 0)
+          if @trim && lspace && rspace
+            add_stmt(src, "\n" * n)
+          else
+            add_text(src, lspace) if lspace
+            add_stmt(src, "\n" * n)
+            add_text(src, rspace) if lspace
+          end
+          #flag_trim = @trim && lspace && rspace
+          #add_text(src, lspace) if !flag_trim && lspace
+          #n = code.count("\n") + (rspace ? 1 : 0)
+          #add_stmt(src, "\n" * n)
+          #add_text(src, rspace) if !flag_trim && rspace
+        else                        # <%= %>
+          add_text(src, lspace) if lspace
+          add_expr(src, code, indicator)
+          add_text(src, rspace) if rspace
+        end
+        #if indicator && indicator[0] == ?=
+        #  flag_trim = false
+        #else
+        #  flag_trim = @trim && lspace && rspace
+        #end
+        ##flag_trim = @trim && !(indicator && indicator[0]==?=) && lspace && rspace
+        #add_text(src, text)
+        #add_text(src, lspace) if !flag_trim && lspace
+        #if !indicator             # <% %>
+        #  code = "#{lspace}#{code}#{rspace}" if flag_trim
+        #  add_stmt(src, code)
+        #elsif indicator[0] == ?\# # <%# %>
+        #  n = code.count("\n") + (rspace ? 1 : 0)
+        #  add_stmt(src, "\n" * n)
+        #else                      # <%= %>
+        #  add_expr(src, code, indicator)
+        #end
+        #add_text(src, rspace) if !flag_trim && rspace
+      end
+      rest = $' || input     # add input when no matched
+      add_text(src, rest)
+      @postamble.nil? ? add_postamble(src) : (@postamble && (src << @postamble))
+      return src
+    end
+
+    ## compile input string and set it to @src
+    def compile!(input)
+      @src = compile(input)
+    end
+
+    protected
+
+    ## escape text string
+    def escape_text(text)
+      return text
+    end
+
+    ## return escaped expression code
+    def escaped_expr(code)
+      @escape ||= 'escape'
+      return "#{@escape}(#{code.strip})"
+    end
+
+    ## .[empty] add @preamble to src
+    def add_preamble(src)
+      # empty
+    end
+
+    ## .[abstract] add text string to src
+    def add_text(src, text)
+      not_implemented
+    end
+
+    ## .[abstract] add statement code to src
+    def add_stmt(src, code)
+      not_implemented
+    end
+
+    ## add expression code to src
+    def add_expr(src, code, indicator)
+      case indicator
+      when '='
+        add_expr_literal(src, code)
+      when '=='
+        add_expr_escaped(src, code)
+      when '==='
+        add_expr_debug(src, code)
+      end
+    end
+
+    ## .[abstract] add expression literal code to src. this is called by add_expr().
+    def add_expr_literal(src, code)
+      not_implemented
+    end
+
+    ## .[abstract] add escaped expression code to src. this is called by add_expr().
+    def add_expr_escaped(src, code)
+      not_implemented
+    end
+
+    ## .[empty] add expression code to src for debug. this is called by add_expr().
+    def add_expr_debug(src, code)
+      # empty
+    end
+
+    ## .[empty] add @postamble to src
+    def add_postamble(src)
+      # empty
+    end
+
+  end  # end of class Engine
+
+
+end

data/lib/erubis/engine/ec.rb

@@ -0,0 +1,106 @@
+##
+## $Rev: 21 $
+## $Release: 2.0.0 $
+## copyright(c) 2006 kuwata-lab all rights reserved.
+##
+
+require 'erubis/engine'
+require 'erubis/enhancer'
+
+
+module Erubis
+
+
+  ##
+  ## engine for C
+  ##
+  class Ec < Engine
+
+    def self.supported_properties()  # :nodoc:
+      list = super
+      list << [:indent, '',       "indent spaces (ex. '  ')"]
+      list << [:out,    'stdout', "output file pointer name"]
+      return list
+    end
+
+    def initialize(input, properties={})
+      @indent = properties[:indent] || ''
+      @out = properties[:out] || 'stdout'
+      super
+    end
+
+    def add_preamble(src)
+      src << "#line 1 \"#{self.filename}\"\n" if self.filename
+    end
+
+    def escape_text(text)
+      @@table_ ||= { "\r"=>"\\r", "\n"=>"\\n", "\t"=>"\\t", '"'=>'\\"', "\\"=>"\\\\" }
+      text.gsub!(/[\r\n\t"\\]/) { |m| @@table_[m] }
+      return text
+    end
+
+    def escaped_expr(code)
+      @escape ||= "escape"
+      code.strip!
+      if code =~ /\A(\".*?\")\s*,\s*(.*)/
+        return "#{$1}, #{@escape}(#{$2})"
+      else
+        return "#{@escape}(#{code})"
+      end
+    end
+
+    def add_text(src, text)
+      return if text.empty?
+      src << (src.empty? || src[-1] == ?\n ? @indent : ' ')
+      src << "fputs("
+      i = 0
+      text.each_line do |line|
+        src << "\n" << @indent << '      ' if i > 0
+        i += 1
+        src << '"' << escape_text(line) << '"'
+      end
+      src << ", #{@out});"   #<< (text[-1] == ?\n ? "\n" : "")
+      src << "\n" if text[-1] == ?\n
+    end
+
+    def add_stmt(src, code)
+      src << code
+    end
+
+    def add_expr_literal(src, code)
+      src << @indent if src.empty? || src[-1] == ?\n
+      src << " fprintf(#{@out}, " << code.strip << ');'
+    end
+
+    def add_expr_escaped(src, code)
+      src << @indent if src.empty? || src[-1] == ?\n
+      src << " fprintf(#{@out}, " << escaped_expr(code) << ');'
+    end
+
+    def add_expr_debug(src, code)
+      code.strip!
+      s = nil
+      if code =~ /\A\".*?\"\s*,\s*(.*)/
+        s = $1.gsub(/[%"]/, '\\\1') + '='
+      end
+      src << @indent if src.empty? || src[-1] == ?\n
+      src << " fprintf(stderr, \"*** debug: #{s}\" #{code});"
+    end
+
+    def add_postamble(src)
+    end
+
+  end
+
+
+  class EscapedEc < Ec
+    include EscapeEnhancer
+  end
+
+
+  #class XmlEc < Ec
+  #  include EscapeEnhancer
+  #end
+
+
+end

data/lib/erubis/engine/ejava.rb

@@ -0,0 +1,101 @@
+##
+## $Rev: 21 $
+## $Release: 2.0.0 $
+## copyright(c) 2006 kuwata-lab all rights reserved.
+##
+
+require 'erubis/engine'
+require 'erubis/enhancer'
+
+
+module Erubis
+
+
+  ##
+  ## engine for Java
+  ##
+  class Ejava < Engine
+
+    def self.supported_properties()   # :nodoc:
+      list = super
+      list << [:indent,   '',       "indent spaces (ex. '  ')"]
+      list << [:buf,      '_buf',   "output buffer name"]
+      list << [:bufclass, 'StringBuffer', "output buffer class (ex. 'StringBuilder')"]
+      return list
+    end
+
+    def initialize(input, properties={})
+      @indent = properties[:indent] || ''
+      @buf = properties[:buf] || '_buf'
+      @bufclass = properties[:bufclass] || 'StringBuffer'
+      super
+    end
+
+    def add_preamble(src)
+      src << "#{@indent}#{@bufclass} #{@buf} = new #{@bufclass}();"
+    end
+
+    def escape_text(text)
+      @@table_ ||= { "\r"=>"\\r", "\n"=>"\\n", "\t"=>"\\t", '"'=>'\\"', "\\"=>"\\\\" }
+      return text.gsub!(/[\r\n\t"\\]/) { |m| @@table_[m] } || text
+    end
+
+    #--
+    #def escaped_expr(code)
+    #  @escape ||= 'escape'
+    #  return "#{@escape}(#{code.strip})"
+    #end
+    #++
+
+    def add_text(src, text)
+      return if text.empty?
+      src << (src.empty? || src[-1] == ?\n ? @indent : ' ')
+      src << @buf << ".append("
+      i = 0
+      text.each_line do |line|
+        src << "\n" << @indent << '          + ' if i > 0
+        i += 1
+        src << '"' << escape_text(line) << '"'
+      end
+      src << ");" << (text[-1] == ?\n ? "\n" : "")
+    end
+
+    def add_stmt(src, code)
+      src << code
+    end
+
+    def add_expr_literal(src, code)
+      src << @indent if src.empty? || src[-1] == ?\n
+      src << ' ' << @buf << '.append(' << code.strip << ');'
+    end
+
+    def add_expr_escaped(src, code)
+      src << @indent if src.empty? || src[-1] == ?\n
+      src << ' ' << @buf << '.append(' << escaped_expr(code) << ');'
+    end
+
+    def add_expr_debug(src, code)
+      code.strip!
+      src << @indent if src.empty? || src[-1] == ?\n
+      src << " System.err.println(\"*** debug: #{code}=\"+(#{code}));"
+    end
+
+    def add_postamble(src)
+      src << "\n" if src[-1] == ?;
+      src << @indent << "return " << @buf << ".toString();\n"
+    end
+
+  end
+
+
+  class EscapedEjava < Ejava
+    include EscapeEnhancer
+  end
+
+
+  #class XmlEjava < Ejava
+  #  include EscapeEnhancer
+  #end
+
+
+end