erubis 1.1.0 → 2.0.0

data/lib/erubis/engine/escheme.rb

@@ -0,0 +1,96 @@
+##
+## $Rev: 21 $
+## $Release: 2.0.0 $
+## copyright(c) 2006 kuwata-lab all rights reserved.
+##
+
+require 'erubis/engine'
+require 'erubis/enhancer'
+
+
+module Erubis
+
+
+  ##
+  ## engine for Scheme
+  ##
+  class Escheme < Engine
+
+    def self.supported_properties()  # :nodoc:
+      list = super
+      list << [:func,  '_add',   "function name (ex. 'display')"]
+      return list
+    end
+
+    def initialize(input, properties={})
+      @func = properties[:func] || '_add'   # or 'display'
+      super
+    end
+
+    def add_preamble(src)
+      return unless @func == '_add'
+      src << "(let ((_buf '())) " + \
+               "(define (_add x) (set! _buf (cons x _buf))) "
+      #src << "(let* ((_buf '())" + \
+      #             " (_add (lambda (x) (set! _buf (cons x _buf))))) "
+    end
+
+    def escape_text(text)
+      @table_ ||= { '"'=>'\\"', '\\'=>'\\\\' }
+      text.gsub!(/["\\]/) { |m| @table_[m] }
+      return text
+    end
+
+    def escaped_expr(code)
+      @escape ||= 'escape'
+      return "(#{@escape} #{code.strip})"
+    end
+
+    def add_text(src, text)
+      return if text.empty?
+      t = escape_text(text)
+      if t[-1] == ?\n
+        t[-1, 1] = ''
+        src << "(#{@func} \"" << t << "\\n\")\n"
+      else
+        src << "(#{@func} \"" << t << '")'
+      end
+    end
+
+    def add_stmt(src, code)
+      src << code
+    end
+
+    def add_expr_literal(src, code)
+      src << "(#{@func} " << code.strip << ')'
+    end
+
+    def add_expr_escaped(src, code)
+      src << "(#{@func} " << escaped_expr(code) << ')'
+    end
+
+    def add_expr_debug(src, code)
+      s = (code.strip! || code).gsub(/\"/, '\\"')
+      src << "(display \"*** debug: #{s}=\")(display #{code.strip})(display \"\\n\")"
+    end
+
+    def add_postamble(src)
+      return unless @func == '_add'
+      src << "\n" unless src[-1] == ?\n
+      src << "  (reverse _buf))\n"
+    end
+
+  end
+
+
+  class EscapedEscheme < Escheme
+    include EscapeEnhancer
+  end
+
+
+  #class XmlEscheme < Escheme
+  #  include EscapeEnhancer
+  #end
+
+
+end

data/lib/erubis/engine/optimized.rb

@@ -0,0 +1,114 @@
+##
+## $Rev: 21 $
+## $Release: 2.0.0 $
+## copyright(c) 2006 kuwata-lab all rights reserved.
+##
+
+
+require 'erubis/engine/eruby'
+
+
+module Erubis
+
+
+  ##
+  ## Eruby class which generates optimized ruby code
+  ##
+  class OptimizedEruby < Engine    # Eruby
+
+    def self.supported_properties()  # :nodoc:
+      return super
+    end
+
+    def initialize(input, properties={})
+      @initialized = false
+      @prev_is_expr = false
+      super
+    end
+
+    protected
+
+    def escape_text(text)
+      text.gsub(/['\\]/, '\\\\\&')   # "'" => "\\'",  '\\' => '\\\\'
+    end
+
+    def escaped_expr(code)
+      @escape ||= 'Erubis::XmlHelper.escape_xml'
+      return "#{@escape}(#{code})"
+    end
+
+    def switch_to_expr(src)
+      return if @prev_is_expr
+      @prev_is_expr = true
+      src << ' _buf'
+    end
+
+    def switch_to_stmt(src)
+      return unless @prev_is_expr
+      @prev_is_expr = false
+      src << ';'
+    end
+
+    def add_preamble(src)
+      #@initialized = false
+      #@prev_is_expr = false
+    end
+
+    def add_text(src, text)
+      return if text.empty?
+      if @initialized
+        switch_to_expr(src)
+        src << " << '" << escape_text(text) << "'"
+      else
+        src << "_buf = '" << escape_text(text) << "';"
+        @initialized = true
+      end
+    end
+
+    def add_stmt(src, code)
+      switch_to_stmt(src) if @initialized
+      #super
+      src << code
+      src << ';' unless code[-1] == ?\n
+    end
+
+    def add_expr_literal(src, code)
+      unless @initialized; src << "_buf = ''"; @initialized = true; end
+      switch_to_expr(src)
+      src << " << (" << code << ").to_s"
+    end
+
+    def add_expr_escaped(src, code)
+      unless @initialized; src << "_buf = ''"; @initialized = true; end
+      switch_to_expr(src)
+      src << " << " << escaped_expr(code)
+    end
+
+    def add_expr_debug(src, code)
+      code.strip!
+      s = (code.dump =~ /\A"(.*)"\z/) && $1
+      src << ' $stderr.puts("*** debug: ' << s << '=#{(' << code << ').inspect}");'
+    end
+
+    def add_postamble(src)
+      #super if @initialized
+      src << "\n_buf\n" if @initialized
+    end
+
+  end  # end of class OptimizedEruby
+
+
+  ##
+  ## XmlEruby class which generates optimized ruby code
+  ##
+  class OptimizedXmlEruby < OptimizedEruby
+    include EscapeEnhancer
+
+    def add_expr_debug(src, code)
+      switch_to_stmt(src) if indicator == '===' && !@initialized
+      super
+    end
+
+  end  # end of class OptimizedXmlEruby
+
+end

data/lib/erubis/enhancer.rb

@@ -0,0 +1,487 @@
+##
+## $Rev: 21 $
+## $Release: 2.0.0 $
+## copyright(c) 2006 kuwata-lab all rights reserved.
+##
+
+
+require 'erubis/engine'
+
+
+module Erubis
+
+
+  ##
+  ## switch '<%= ... %>' to escaped and '<%== ... %>' to unescaped
+  ##
+  ## ex.
+  ##   class XmlEruby < Eruby
+  ##     include EscapeEnhancer
+  ##   end
+  ##
+  ## this is language-indenedent.
+  ##
+  module EscapeEnhancer
+
+    def self.desc   # :nodoc:
+      "switch '<%= %>' to escaped and '<%== %>' to unescaped"
+    end
+
+    #--
+    #def self.included(klass)
+    #  klass.class_eval <<-END
+    #    alias _add_expr_literal add_expr_literal
+    #    alias _add_expr_escaped add_expr_escaped
+    #    alias add_expr_literal _add_expr_escaped
+    #    alias add_expr_escaped _add_expr_literal
+    #  END
+    #end
+    #++
+
+    def add_expr(src, code, indicator)
+      case indicator
+      when '='
+        add_expr_escaped(src, code)
+        #add_expr_literal(src, code)
+      when '=='
+        add_expr_literal(src, code)
+        #add_expr_escaped(src, code)
+      when '==='
+        add_expr_debug(src, code)
+      end
+    end
+
+  end
+
+
+  #--
+  ## (obsolete)
+  #module FastEnhancer
+  #end
+  #++
+
+
+  ##
+  ## use $stdout instead of string
+  ##
+  ## this is only for Eruby.
+  ##
+  module StdoutEnhancer
+
+    def self.desc   # :nodoc:
+      "use $stdout instead of array buffer or string buffer"
+    end
+
+    def add_preamble(src)
+      src << "_buf = $stdout;"
+    end
+
+    def add_postamble(src)
+      src << "\n''\n"
+    end
+
+  end
+
+
+  ##
+  ## use print statement instead of '_buf << ...'
+  ##
+  ## this is only for Eruby.
+  ##
+  module PrintOutEnhancer
+
+    def self.desc   # :nodoc:
+      "use print statement instead of '_buf << ...'"
+    end
+
+    def add_preamble(src)
+    end
+
+    def add_text(src, text)
+      src << " print '" << escape_text(text) << "';" unless text.empty?
+    end
+
+    def add_expr_literal(src, code)
+      src << ' print((' << code << ').to_s);'
+    end
+
+    def add_expr_escaped(src, code)
+      src << ' print ' << escaped_expr(code) << ';'
+    end
+
+    def add_postamble(src)
+      src << "\n" unless src[-1] == ?\n
+    end
+
+  end
+
+
+  ##
+  ## enable print function
+  ##
+  ## Notice: use Eruby#evaluate() and don't use Eruby#result()
+  ## to be enable print function.
+  ##
+  ## this is only for Eruby.
+  ##
+  module PrintEnabledEnhancer
+
+    def self.desc   # :nodoc:
+      "enable to use print function in '<% %>'"
+    end
+
+    def add_preamble(src)
+      src << "@_buf = "
+      super
+    end
+
+    def print(*args)
+      args.each do |arg|
+        @_buf << arg.to_s
+      end
+    end
+
+    def evaluate(context=Context.new)
+      _src = @src
+      if context.is_a?(Hash)
+        context.each do |key, val| instance_variable_set("@#{key}", val) end
+      else
+        context.instance_variables.each do |name|
+          instance_variable_set(name, context.instance_variable_get(name))
+        end
+      end
+      return instance_eval(_src, (@filename || '(erubis)'))
+    end
+
+  end
+
+
+  ##
+  ## return array instead of string
+  ##
+  ## this is only for Eruby.
+  ##
+  module ArrayEnhancer
+
+    def self.desc   # :nodoc:
+      "return array instead of string"
+    end
+
+    def add_preamble(src)
+      src << "_buf = [];"
+    end
+
+    def add_postamble(src)
+      src << "\n" unless src[-1] == ?\n
+      src << "_buf\n"
+    end
+
+  end
+
+
+  ##
+  ## use an Array object as buffer (included in Eruby by default)
+  ##
+  ## this is only for Eruby.
+  ##
+  module ArrayBufferEnhancer
+
+    def self.desc   # :nodoc:
+      "use an Array object for buffering (included in Eruby class)"
+    end
+
+    def add_preamble(src)
+      src << "_buf = [];"
+    end
+
+    def add_postamble(src)
+      src << "\n" unless src[-1] == ?\n
+      src << "_buf.join\n"
+    end
+
+  end
+
+
+  ##
+  ## use String class for buffering
+  ##
+  ## this is only for Eruby.
+  ##
+  module StringBufferEnhancer
+
+    def self.desc   # :nodoc:
+      "use a String object for buffering"
+    end
+
+    def add_preamble(src)
+      src << "_buf = '';"
+    end
+
+    def add_postamble(src)
+      src << "\n" unless src[-1] == ?\n
+      src << "_buf\n"
+    end
+
+  end
+
+
+  ##
+  ## use StringIO class for buffering
+  ##
+  ## this is only for Eruby.
+  ##
+  module StringIOEnhancer  # :nodoc:
+
+    def self.desc   # :nodoc:
+      "use a StringIO object for buffering"
+    end
+
+    def add_preamble(src)
+      src << "_buf = StringIO.new;"
+    end
+
+    def add_postamble(src)
+      src << "\n" unless src[-1] == ?\n
+      src << "_buf.string\n"
+    end
+
+  end
+
+
+  ##
+  ## remove text and leave code, especially useful when debugging.
+  ##
+  ## ex.
+  ##   $ erubis -s -e NoText file.eruby | more
+  ##
+  ## this is language independent.
+  ##
+  module NoTextEnhancer
+
+    def self.desc   # :nodoc:
+      "remove text and leave code (useful when debugging)"
+    end
+
+    def add_text(src, text)
+      src << ("\n" * text.count("\n"))
+      if text[-1] != ?\n
+        text =~ /^(.*?)\z/
+        src << (' ' * $1.length)
+      end
+    end
+
+  end
+
+
+  ##
+  ## get compile faster, but spaces around '<%...%>' are not trimmed.
+  ##
+  ## this is language-independent.
+  ##
+  module SimplifyEnhancer
+
+    def self.desc   # :nodoc:
+      "get compile faster but leave spaces around '<% %>'"
+    end
+
+    #DEFAULT_REGEXP = /(.*?)(^[ \t]*)?<%(=+|\#)?(.*?)-?%>([ \t]*\r?\n)?/m
+    SIMPLE_REGEXP = /(.*?)<%(=+|\#)?(.*?)-?%>/m
+
+    def compile(input)
+      src = ""
+      add_preamble(src)
+      #regexp = pattern_regexp(@pattern)
+      input.scan(SIMPLE_REGEXP) do |text, indicator, code|
+        add_text(src, text)
+        if !indicator              # <% %>
+          add_stmt(src, code)
+        elsif indicator[0] == ?\#  # <%# %>
+          n = code.count("\n")
+          add_stmt(src, "\n" * n)
+        else                       # <%= %>
+          add_expr(src, code, indicator)
+        end
+      end
+      rest = $' || input
+      add_text(src, rest)
+      add_postamble(src)
+      return src
+    end
+
+  end
+
+
+  ##
+  ## enable to use other embedded expression pattern (default is '\[= =\]').
+  ##
+  ## notice! this is an experimental. spec may change in the future.
+  ##
+  ## ex.
+  ##   input = <<END
+  ##   <% for item in list %>
+  ##     <%= item %> : <%== item %>
+  ##     [= item =] : [== item =]
+  ##   <% end %>
+  ##   END
+  ##
+  ##   class BiPatternEruby
+  ##     include BiPatternEnhancer
+  ##   end
+  ##   eruby = BiPatternEruby.new(input, :bipattern=>'\[= =\]')
+  ##   list = ['<a>', 'b&b', '"c"']
+  ##   print eruby.result(binding())
+  ##
+  ##   ## output
+  ##     <a> : &lt;a&gt;
+  ##     <a> : &lt;a&gt;
+  ##     b&b : b&amp;b
+  ##     b&b : b&amp;b
+  ##     "c" : &quot;c&quot;
+  ##     "c" : &quot;c&quot;
+  ##
+  ## this is language independent.
+  ##
+  module BiPatternEnhancer
+
+    def self.desc   # :nodoc:
+      "another embedded expression pattern (default '\[= =\]')."
+    end
+
+    def initialize(input, properties={})
+      self.bipattern = properties[:bipattern]    # or '\$\{ \}'
+      super
+    end
+
+    ## when pat is nil then '\[= =\]' is used
+    def bipattern=(pat)   # :nodoc:
+      @bipattern = pat || '\[= =\]'
+      pre, post = @bipattern.split()
+      @bipattern_regexp = /(.*?)#{pre}(=*)(.*?)#{post}/m
+    end
+
+    def add_text(src, text)
+      return unless text
+      text.scan(@bipattern_regexp) do |txt, indicator, code|
+        super(src, txt)
+        add_expr(src, code, '=' + indicator)
+      end
+      rest = $' || text
+      super(src, rest)
+    end
+
+  end
+
+
+  ##
+  ## regards lines starting with '%' as program code
+  ##
+  ## this is for compatibility to eruby and ERB.
+  ##
+  ## this is language-independent.
+  ##
+  module PercentLineEnhancer
+
+    def self.desc   # :nodoc:
+      "regard lines starting with '%' as program code"
+    end
+
+    PERCENT_LINE_PATTERN = /(.*?)^\%(.*?\r?\n)/m
+
+    def add_text(src, text)
+      text.scan(PERCENT_LINE_PATTERN) do |txt, line|
+        super(src, txt)
+        if line[0] == ?%
+          super(src, line)
+        else
+          add_stmt(src, line)
+        end
+      end
+      rest = $' || text
+      super(src, rest)
+    end
+
+  end
+
+
+  ##
+  ## [experimental] allow header and footer in eRuby script
+  ##
+  ## ex.
+  ##   ====================
+  ##   ## without header and footer
+  ##   $ cat ex1.eruby
+  ##   <% def list_items(list) %>
+  ##   <%   for item in list %>
+  ##   <li><%= item %></li>
+  ##   <%   end %>
+  ##   <% end %>
+  ##
+  ##   $ erubis -s ex1.eruby
+  ##   _buf = []; def list_items(list)
+  ##   ;   for item in list
+  ##   ; _buf << '<li>'; _buf << ( item ).to_s; _buf << '</li>
+  ##   ';   end
+  ##   ; end
+  ##   ;
+  ##   _buf.join
+  ##
+  ##   ## with header and footer
+  ##   $ cat ex2.eruby
+  ##   <!--#header:
+  ##   def list_items(list)
+  ##    #-->
+  ##   <%  for item in list %>
+  ##   <li><%= item %></li>
+  ##   <%  end %>
+  ##   <!--#footer:
+  ##   end
+  ##    #-->
+  ##
+  ##   $ erubis -s -c HeaderFooterEruby ex4.eruby
+  ##
+  ##   def list_items(list)
+  ##    _buf = []; _buf << '
+  ##   ';  for item in list
+  ##   ; _buf << '<li>'; _buf << ( item ).to_s; _buf << '</li>
+  ##   ';  end
+  ##   ; _buf << '
+  ##   ';
+  ##   _buf.join
+  ##   end
+  ##
+  ##   ====================
+  ##
+  ## this is language-independent.
+  ##
+  module HeaderFooterEnhancer
+
+    def self.desc   # :nodoc:
+      "allow header/footer in document (ex. '<!--#header: #-->')"
+    end
+
+    HEADER_FOOTER_PATTERN = /(.*?)(^[ \t]*)?<!--\#(\w+):(.*?)\#-->([ \t]*\r?\n)?/m
+
+    def add_text(src, text)
+      text.scan(HEADER_FOOTER_PATTERN) do |txt, lspace, word, content, rspace|
+        flag_trim = @trim && lspace && rspace
+        super(src, txt)
+        content = "#{lspace}#{content}#{rspace}" if flag_trim
+        super(src, lspace) if !flag_trim && lspace
+        instance_variable_set("@#{word}", content)
+        super(src, rspace) if !flag_trim && rspace
+      end
+      rest = $' || text
+      super(src, rest)
+    end
+
+    attr_accessor :header, :footer
+
+    def compile(input)
+      source = super
+      return @src = "#{@header}#{source}#{@footer}"
+    end
+
+  end
+
+
+end