erubis 2.2.0 → 2.3.0

data/CHANGES

@@ -1,8 +1,125 @@
-# $Rev: 65 $
-# $Release: 2.2.0 $
+# $Rev: 78 $
+# $Release: 2.3.0 $
 # copyright(c) 2006-2007 kuwata-lab all rights reserved.
 
 
+#
+- release:   2.3.0
+  date:
+  enhancements:
+    - |
+      New class 'Erubis::FastEruby' is added.
+      It is a subclass of Erubis::Eruby and includes InterpolationEnhancer.
+      Erubis::FastEruby is compatible with and faster than Erubis::Eruby.
+
+    - |
+      New enhancer 'InterpolationEnhancer' is added.
+      This enhancer uses expression interpolation to eliminate method call
+      of String#<<. In the result, this enhancer makes Eruby a little faster.
+
+      --------------------
+      ## Assume that input is '<a href="<%=url%>"><%=name%></a>'.
+      ## Eruby convert input into the following code.  String#<< is called 5 times.
+      _buf << '<a href="'; _buf << (url).to_s; _buf << '">'; _buf << (name).to_s; _buf << '</a>';
+      
+      ## When InterpolationEnhancer is used, String#<< is called only once.
+      _buf << %Q`<a href="#{url}">#{name}</a>`;
+      --------------------
+
+    - |
+      New enhancer 'ErboutEnhancer' is added.
+      ErboutEnhancer set '_erbout' as well as '_buf' to be compatible with ERB.
+
+      ex.
+      ====================
+      $ cat ex.rhtml
+      <p>Hello</p>
+      $ erubis -x ex.rhtml
+      _buf = ''; _buf << '<p>Hello</p>
+      ';
+      _buf.to_s
+      $ erubis -xE Erbout ex.rhtml
+      _erbout = _buf = ''; _buf << '<p>Hello</p>
+      ';
+      _buf.to_s
+      ====================
+
+    - |
+      [experimental]
+      New enhancer 'DeleteIndentEnhancer' is added.
+      This enhancer deletes indentation of HTML file.
+
+      ex.
+      ====================
+      $ cat ex.rhtml
+      <div>
+        <ul>
+        <% for item in ['AAA', 'BBB', 'CCC'] %>
+          <li><%= item %></li>
+        <% end %>
+        </ul>
+      </div>
+      $ erubis ex.rhtml
+      <div>
+        <ul>
+          <li>AAA</li>
+          <li>BBB</li>
+          <li>CCC</li>
+        </ul>
+      </div>
+      $ erubis -E DeleteIndent ex.rhtml
+      <div>
+      <ul>
+      <li>AAA</li>
+      <li>BBB</li>
+      <li>CCC</li>
+      </ul>
+      </div>
+      ====================
+
+    - |
+      Mod_ruby is supported (very thanks to Andrew R Jackson!).
+      See users-guide and 'contrib/erubis-run.rb' for details.
+      
+    - |
+      New command-line option '-X', '-N', '-U', and '-C' are added.
+      These are intended to be a replacement of 'notext' command.
+      '-X' shows only ruby statements and expressions.
+      '-N' adds line numbers.
+      '-U' compress empty lines into a line.
+      '-C' removes empty lines.
+
+
+  changes:
+
+    - |
+      'helpers/rails_helper.rb' is changed to use ErboutEnhancer.
+      The following is an examle to use Erubis with Ruby on Rails.
+
+      File 'config/environment.rb':
+      ----------------------------------------
+      require 'erubis/helpers/rails_helper'
+      #Erubis::Helpers::RailsHelper.engine_class = Erubis::Eruby # or Erubis::FastEruby
+      #Erubis::Helpers::RailsHelper.init_properties = {}
+      #Erubis::Helpers::RailsHelper.show_src = false             # set true for debugging
+      ----------------------------------------
+      
+    - |
+      Command 'notext' has been removed. Use '-X', '-N', '-U', and '-C'
+      instead.
+
+    - |
+      Tab characters in YAML file are expaneded automatically.
+      If you want not to expand tab characters, add command-line optio '-T'.
+
+    - |
+      Benchmark scripts (benchmark/bench.*) are rewrited.
+
+    - |
+      Users-guide (doc/users-guide.html) is updated.
+
+    
+
 #
 - release:   2.2.0
   date:      2007-02-11
@@ -78,7 +195,7 @@
       $ erubis -c '{title: Example, list: [AAA, BBB, CCC]}' example.rhtml
       ====================
 
-      ex. YAML inline style
+      ex. Ruby style
       ====================
       $ erubis -c '@title="Example"; @list=%w[AAA BBB CCC]' example.rhtml
       ====================

data/README.txt

@@ -1,6 +1,6 @@
 = README
 
-release::	$Release: 2.2.0 $
+release::	2.3.0
 copyright::	copyright(c) 2006-2007 kuwata-lab all rights reserved.
 
 

data/benchmark/Makefile

@@ -0,0 +1,6 @@
+
+bench:
+	ruby bench.rb -n 10000
+
+clean:
+	rm -rf bench_*.rhtml*

data/benchmark/bench.rb

@@ -0,0 +1,306 @@
+#!/usr/bin/env ruby
+
+###
+### $Rev: 77 $
+### $Release: 2.3.0 $
+### copyright(c) 2006-2007 kuwata-lab all rights reserved.
+###
+
+require 'erb'
+require 'erubis'
+require 'erubis/tiny'
+require 'erubis/engine/enhanced'
+require 'yaml'
+require 'cgi'
+include ERB::Util
+
+begin
+  require 'eruby'
+rescue LoadError
+  ERuby = nil
+end
+
+def File.write(filename, content)
+  File.open(filename, 'w') { |f| f.write(content) }
+end
+
+
+## change benchmark library to use $stderr instead of $stdout
+require 'benchmark'
+module Benchmark
+  class Report
+    def print(*args)
+      $stderr.print(*args)
+    end
+  end
+  module_function
+  def print(*args)
+    $stderr.print(*args)
+  end
+end
+
+
+class BenchmarkApplication
+
+  TARGETS = %w[eruby
+               ERB               ERB(cached)
+               Erubis::Eruby     Erubis::Eruby(cached)
+               Erubis::FastEruby Erubis::FastEruby(cached)
+               Erubis::TinyEruby
+               Erubis::ArrayBufferEruby
+               Erubis::PrintOutEruby
+               Erubis::StdoutEruby
+              ]
+
+  def initialize(ntimes, context, targets=nil, params={})
+    @ntimes      = ntimes
+    @context     = context
+    @targets     = targets && !targets.empty? ? targets : TARGETS.dup
+    @testmode    = params[:testmode]    || 'execute'
+    @erubyfile   = params[:erubyfile]   || 'erubybench.rhtml'
+    @printout    = params[:printout]    || false
+  end
+
+  attr_accessor :ntimes, :targets
+  attr_accessor :testmode, :erubyfile, :contextfile, :printout
+
+  def context2code(context, varname='context')
+    s = ''
+    context.each { |k, | s << "#{k} = #{varname}[#{k.inspect}]; " }
+    return s
+  end
+
+  def perform_benchmark
+    width = 30
+    $stderr.puts "*** ntimes=#{@ntimes}, testmode=#{@testmode}"
+    Benchmark.bm(width) do |job|
+      for target in @targets do
+        method = "#{@testmode}_#{target.gsub(/::|-|\(/, '_').gsub(/\)/, '').downcase}"
+        #$stderr.puts "*** debug: method=#{method.inspect}"
+        next unless self.respond_to?(method)
+        filename = "bench_#{(target =~ /^(\w+)/) && $1.downcase}.rhtml"
+        title = target
+        output = nil
+        job.report(title) do
+          output = self.__send__(method, filename, @context)
+        end
+        File.write("output.#{target.gsub(/[^\w]/,'')}", output) if @printout && output && !output.empty?
+      end
+    end
+  end
+
+  ##
+
+  def execute_eruby(filename, context)
+    return unless ERuby
+    eval context2code(context)
+    @ntimes.times do
+      ERuby.import(filename)
+    end
+    return nil
+  end
+
+  def execute_erb(filename, context)
+    eval context2code(context)
+    output = nil
+    @ntimes.times do
+      eruby = ERB.new(File.read(filename))
+      output = eruby.result(binding())
+      print output
+    end
+    return output
+  end
+
+  def execute_erb_cached(filename, context)
+    eval context2code(context)
+    output = nil
+    cachefile = filename + '.cache'
+    File.unlink(cachefile) if test(?f, cachefile)
+    @ntimes.times do
+      if !test(?f, cachefile) || File.mtime(filename) > File.mtime(cachefile)
+        eruby = ERB.new(File.read(filename))
+        File.write(cachefile, eruby.src)
+      else
+        eruby = ERB.new('')
+        #eruby.src = File.read(cachefile)
+        eruby.instance_variable_set("@src", File.read(cachefile))
+      end
+      output = eruby.result(binding())
+      print output
+    end
+    return output
+  end
+
+  ## no cached
+  for klass in %w[Eruby FastEruby TinyEruby ArrayBufferEruby PrintOutEruby StdoutEruby] do
+    s = <<-END
+    def execute_erubis_#{klass.downcase}(filename, context)
+      eval context2code(context)
+      output = nil
+      @ntimes.times do
+        eruby = Erubis::#{klass}.new(File.read(filename))
+        output = eruby.result(binding())
+        print output
+      end
+      return output
+    end
+    END
+    eval s
+  end
+
+  ## cached
+  for klass in %w[Eruby FastEruby] do
+    s = <<-END
+    def execute_erubis_#{klass.downcase}_cached(filename, context)
+      eval context2code(context)
+      cachefile = filename + '.cache'
+      File.unlink(cachefile) if test(?f, cachefile)
+      output = nil
+      @ntimes.times do
+        eruby = Erubis::#{klass}.load_file(filename)
+        output = eruby.result(binding())
+        print output
+      end
+      savefile = cachefile.sub(/\\.cache$/, '.#{klass.downcase}.cache')
+      File.rename(cachefile, savefile)
+      return output
+    end
+    END
+    eval s
+  end
+
+  ##
+
+  def convert_eruby(filename, context)
+    return unless ERuby
+    eval context2code(context)
+    output = nil
+    @ntimes.times do
+      output = ERuby::Compiler.new.compile_string(File.read(filename))
+    end
+    return output
+  end
+
+  def convert_erb(filename, context)
+    eval context2code(context)
+    output = nil
+    @ntimes.times do
+      eruby = ERB.new(File.read(filename))
+      output = eruby.src
+    end
+    return output
+  end
+
+  for klass in %w[Eruby FastEruby TinyEruby]
+    s = <<-END
+      def convert_erubis_#{klass.downcase}(filename, context)
+        eval context2code(context)
+        output = nil
+        @ntimes.times do
+          eruby = Erubis::#{klass}.new(File.read(filename))
+          output = eruby.src
+        end
+        return output
+      end
+    END
+    eval s
+  end
+
+end
+
+
+require 'optparse'
+
+class MainApplication
+
+  def parse_argv(argv=ARGV)
+    optparser = OptionParser.new
+    options = {}
+    ['-h', '-n N', '-t erubyfile', '-f contextfile', '-A', '-e',
+      '-x exclude', '-m testmode', '-X', '-p', '-D'].each do |opt|
+      optparser.on(opt) { |val| options[opt[1].chr] = val }
+    end
+    begin
+      targets = optparser.parse!(argv)
+    rescue => ex
+      $stderr.puts "#{@script}: #{ex.to_s}"
+      exit(1)
+    end
+    return options, targets
+  end
+
+  def execute
+    @script = File.basename($0)
+    ntimes = 1000
+    targets = BenchmarkApplication::TARGETS.dup
+    testmode = 'execute'
+    contextfile = 'bench_context.yaml'
+    #
+    options, args = parse_argv(ARGV)
+    ntimes      = options['n'].to_i if options['n']
+    targets     = args if args && !args.empty?
+    targets     = targets - options['x'].split(/,/) if options['x']
+    testmode    = options['m'] if options['m']
+    contextfile = options['f'] if options['f']
+    erubyfile   = options['t'] if options['t']
+    #
+    if options['h']
+      $stderr.puts "Usage: ruby #{@script} [..options..] [..targets..]"
+      $stderr.puts "  -h           :  help"
+      $stderr.puts "  -n N         :  loop N times"
+      $stderr.puts "  -f datafile  :  context data filename (*.yaml)"
+      $stderr.puts "  -x exclude   :  exclude target name"
+      $stdout.puts "  -m testmode  :  'execute' or 'convert' (default 'execute')"
+      $stderr.puts "  -p           :  print output to file (filename: 'output.TARGETNAME')"
+      return
+    end
+    #
+    #if ! options['t']
+    for item in %w[eruby erb erubis]
+      fname = "bench_#{item}.rhtml"
+      header = File.read("templates/_header.html")
+      #body   = File.read("templates/#{erubyfile}")
+      body   = File.read("templates/#{fname}")
+      footer = File.read("templates/_footer.html")
+      content = header + body + footer
+      File.write(fname, content)
+    end
+    #
+    if options['e']   # escape
+      tuples = [
+        [ 'bench_eruby.rhtml',  '<%= CGI.escapeHTML((\1).to_s) %>' ],
+        [ 'bench_erb.rhtml',    '<%=h \1 %>' ],
+        [ 'bench_erubis.rhtml', '<%== \1 %>' ],
+      ]
+      for fname, replace in tuples
+        content = File.read(fname).gsub(/<%= ?(.*?) ?%>/, replace)
+        File.write(fname, content)
+      end
+      targets.delete('Erubis::TinyEruby')   ## because TinyEruby doesn't support '<%== =>'
+    end
+    #
+    context = YAML.load_file(contextfile)
+    #
+    params = {
+      :printout=>options['p'],
+      :testmode=>testmode,
+    }
+    app = BenchmarkApplication.new(ntimes, context, targets, params)
+    app.perform_benchmark()
+  end
+
+end
+
+
+if __FILE__ == $0
+
+  ## open /dev/null
+  $stdout = File.open('/dev/null', 'w')
+  at_exit do
+    $stdout.close()
+  end
+
+  ## start benchmark
+  MainApplication.new().execute()
+
+end