erubis 2.3.1 → 2.7.0

data/{CHANGES → CHANGES.txt}

@@ -1,6 +1,376 @@
-# $Rev: 83 $
-# $Release: 2.3.1 $
-# copyright(c) 2006-2007 kuwata-lab.com all rights reserved.
+# -*- coding: utf-8 -*-
+# $Release: 2.7.0 $
+# copyright(c) 2006-2011 kuwata-lab.com all rights reserved.
+
+- release:   2.7.0
+  date: 2011-04-01
+  enhancements:
+
+    - |
+	New option ':bufvar' supported to specify buffer variable name.
+
+	ex:
+	    input = "Hello <%= name %>!"
+	    eruby = Erubis::Eruby.new(input)
+	    puts eruby.src
+	       #=>  _buf = ''; _buf << "Hello "; _buf << ( name ).to_s; _buf << '!';
+
+	    eruby = Erubis::Eruby.new(input, :bufvar=>'@_out')
+	    puts eruby.src
+	       #=>  @_out = ''; @_out << 'Hello '; @_out << ( name ).to_s; @_out << '!';
+
+    - |
+	New enhancer 'PrefixedLineEnhancer' which is a customizable version
+	of PercentLineEnhancer.
+	The difference between PrefixedLineEnhancer and PercentLineEnhancer is:
+	* You can indent Ruby statetment lines starting with '%'
+	* You can specify prefix character by :prefixchar option.
+
+	ex:
+	    class MyEruby < Erubis::Eruby
+	      include Erubis::PrefixedLineEnhancer
+	    end
+	    input = <<END
+	    <ul>
+	      % for item in @items
+	      <li><%= item %></li>
+	      % end
+	      %% you can indent '%' lines
+	    </ul>
+	    END
+	    eruby = MyEruby.new(input, :prefixchar=>'%')   # default '%'
+	    puts eruby.src
+
+	output:
+	    _buf = ''; _buf << '<ul>
+	    ';   for item in @items
+	     _buf << '  <li>'; _buf << ( item ).to_s; _buf << '</li>
+	    ';   end
+	      % you can indent '%' lines
+	     _buf << '</ul>
+	    ';
+	    _buf.to_s
+
+    - |
+	Add helper CGI script. See 'public_html/README.txt' for details.
+
+    - |
+	Rubinius is supported as first-class Ruby implementation.
+
+    - |
+	C++ support. Try '-l cpp' command-line option.
+
+	
+  changes:
+
+    - |
+	Remove dependency to 'abstract' library.
+	You don't need to install 'abstract' gem.
+
+    - |
+	Erubis::Eruby#load_file() now sets cache file timestamp to the same
+	value as original eRuby file. For example, if you restore eRuby files
+	from backup, Erubis::Eruby#load_file() can detect it and generate
+	cache file again.
+
+	    ## generates cache file (A.rhtml.cache).
+	    eruby = Erubis::Eruby.load_file('A.rhtml')
+	    p File.mtime('A.rhtml') == File.mtime('A.rhtml.cache')  #=> true
+
+	    
+
+- release:   2.6.6
+  date: 2010-06-27
+  bugfixes:
+
+    - |
+	Fixed a bug around InterporationEnhancer and FastEruby to escape back-quote. (thanks to Andrew R Jackson)
+
+
+- release:   2.6.5
+  date: 2009-07-20
+  bugfixes:
+
+    - |
+	Fixed bug around '-z' option.
+
+
+- release:   2.6.4
+  date: 2009-02-18
+  enhancements:
+
+    - |
+	Rails 2.2 and 2.3 support.
+
+
+
+- release:   2.6.3
+  date: 2009-02-07
+  bugfixes:
+
+    - Enhancer name was not displayed in Ruby 1.9.1 when it was missing.
+
+    - Command option argument name was not displayed correctly as a part of error message.
+
+    - MethoNotFound error was raised when invalid option was specified.
+	
+
+- release:   2.6.2
+  date:	2008-06-12
+  enhancements:
+
+    - |
+	Ruby 1.9 support.
+
+  bugfixes:
+
+    - |
+	Fixed installation problem on Windows (Thanks to Tim Morgan and Allen).
+
+
+- release:   2.6.1
+  date: 2008-06-06
+  enhancements:
+
+    - |
+	Rails 2.1 support. (special thanks José Valim)
+
+
+
+- release:   2.6.0
+  date: 2008-05-05
+  enhancements:
+
+    - |
+	Improved support of Ruby on Rails 2.0.2.
+	New class ActionView::TemplateHandlers::Erubis is defined and
+	registered as default handler of *.html.erb and *.rhtml.
+	
+    - |
+	'<%% %>' and '<%%= %>' are converted into '<% %>' and '<%= %>' respectively.
+	This is for compatibility with ERB.
+
+	ex1.rhtml:
+	    <ul>
+	    <%% for item in @list %>
+	      <li><%%= item %></li>
+	    <%% end %>
+	    </ul>
+
+	result:
+	    $ erubis ex1.rhtml
+	    <ul>
+	    <% for item in @list %>
+	      <li><%= item %></li>
+	    <% end %>
+	    </ul>
+
+    - |
+	'<%= -%>' removes tail spaces and newlines.
+	This is for compatibiliy with ERB when trim mode is '-'.
+	'<%= =%>' also removes tail spaces and newlines, and this is
+	Erubis-original enhancement (cooler than '<%= -%>', isn't it?).
+
+	ex2.rhtml:
+	   <div>
+	   <%= @var -%>          # or <%= @var =%>
+	   </div>
+
+	result (version 2.6.0):
+	    $ erubis -c '{var: "AAA\n"}' ex2.rhtml
+	    <div>
+	    AAA
+	    </div>
+
+	result (version 2.5.0):
+	    $ erubis -c '{var: "AAA\n"}' ex2.rhtml
+	    <div>
+	    AAA
+	    
+	    </div>
+
+    - |
+	Erubis::Eruby.load_file() now allows you to change cache filename.
+
+	ex.
+	    eruby = Erubis::Eruby.load_file("ex3.rhtml",
+		                            :cachename=>'ex3.rhtml.cache')
+
+
+- release:   2.5.0
+  date:	     2008-01-30
+  enhancements:
+
+    - |
+      Ruby on Rails 2.0 support.
+      If you are using preprocessing, notice that _?('foo.id') will be NG
+      because it contains period ('.') character.
+
+      --------------------
+      <!-- NG in Rails 2.0 -->
+      [%= link_to 'Edit', edit_user_path(_?('@user.id')) %]
+      [%= link_to 'Show', @user %]
+      [%= link_to 'Delete', @user, :confirm=>'OK?', :method=>:delete %]
+      
+      <!-- OK in Rails 2.0 -->
+      <%= user_id = @user.id %>
+      [%= link_to 'Edit', edit_user_path(_?('user_id')) %]
+      [%= link_to 'Show', :action=>'show', :id=>_?('user_id') %]
+      [%= link_to 'Delete', {:action=>'destroy', :id=>_?('user_id')},
+                            {:confirm=>'OK?', :method=>:delete} %]
+      --------------------
+	
+    - |
+      (experimental)
+      Rails form helper methods for preprocessing are added.
+      These helper methos are available with preprocessing.
+
+      ex. _form.rhtml
+      --------------------
+       Name: <%= text_field :user, :name %>
+       Name: [%= pp_text_field :user, :name %]
+      --------------------
+
+      preprocessed:
+      --------------------
+       Name: <%= text_field :user, :name %>
+       Name: <input id="stock_name" name="stock[name]" size="30" type="text" value="<%=h @stock.name%>" />
+      --------------------
+
+      Ruby code:
+      --------------------
+       _buf << '
+        Name: '; _buf << ( text_field :stock, :name ).to_s; _buf << '
+        Name: <input id="stock_name" name="stock[name]" size="30" type="text" value="'; _buf << (h @stock.name).to_s; _buf << '" />
+      ';
+      --------------------
+
+      This shows that text_filed() is called every time when rendering,
+      but pp_text_filed() is called only once when loading template,
+      so pp_text_field() with prepocessing is much faster than text_field().
+
+      See User's guide for details.
+      http://www.kuwata-lab.com/erubis/users-guide.05.html#rails-formhelpers
+
+#
+- release:   2.4.1
+  date:      2007-09-25
+  enhancements:
+
+    - |
+      Add new section 'evaluate(context) v.s. result(binding)' to user's guide.
+      This section describes why Erubis::Eruby#evaluate(context) is recommended
+      rather than Erubis::Eruby#result(binding).
+      User's Guide > Other Topics > evaluate(context) v.s. result(binding)
+      http://www.kuwata-lab.com/erubis/users-guide.06.html#topics-context-vs-binding
+
+    - |
+      Add new command-line property '--docwrite={true|false}' to
+      Erubis::Ejavascript.
+      If this property is true then 'document.write(_buf.join(""));' is used
+      as postamble and if it is false then '_buf.join("")' is used.
+      Default is true for compatibility reason but it will be false in the
+      future release.
+      (This feature was proposed by D.Dribin. Thank you.)
+
+  bugfix:
+
+    - |
+      When using Erubis::Eruby#evaluate(), changing local variables in
+      templates have affected to variables accessible with TOPLEVEL_BINDING.
+      It means that if you change variables in templates, it is possible to
+      change variables in main program.
+      This was a bug and is now fixed not to affect to variables in main
+      program.
+
+      ex. template.rhtml
+      --------------------
+      <% for x in @items %>
+      item = <%= x %>
+      <% end %>
+      --------------------
+
+      ex. main-program.rb
+      --------------------
+      require 'erubis'
+      x = 10
+      items = ['foo', 'bar', 'baz']
+      eruby = Erubis::Eruby.new(File.read('template.rhtml'))
+      s = eruby.evaluate(:items=>items)
+      print s
+      $stderr.puts "*** debug: x=#{x.inspect}"  #=> x="baz" (2.4.0)
+                                                #=> x=10    (2.4.1)
+      --------------------
+
+    - |
+      PercentLineEnhancer was very slow. Now performance problem is solved.
+
+
+#
+- release:   2.4.0
+  date: 2007-07-19
+  enhancements:
+
+    - |
+      Preprocessing is supported by Ruby on Rails helper.
+      Preprocessing makes Ruby on Rails application about 20-40 percent faster.
+
+      For example,
+
+         [%= link_to 'Show', :action=>'show', :id=>_?('@user.id') %]
+
+      is evaluate by preprocessor and expanded into the following
+      when template file is loaded.
+
+         <a href="/users/show/<%=@user.id%>">Show</a>
+
+      It means that link_to() is not called when template is rendered
+      and rendering speed will be much faster in the result.
+
+      See User's Guide for details.
+
+    - |
+      Erubis::Eruby#evaluate() (or Erubis::RubyEvaluator#evaluate()) now
+      creates Proc object from @src and eval it.
+
+        def evaluate(context=Context.new)
+          context = Context.new(context) if context.is_a?(Hash)
+          @_proc ||= eval("proc { #{@src} }", TOPLEVEL_BINDING, @filename || '(erubis)')
+          return context.instance_eval(&@_proc)
+        end
+
+      This makes evaluate() much faster when eruby object is reused.
+      
+    - |
+      Erubis::Eruby#def_method() is supported.
+      This method defines ruby code as instance method or singleton metod.
+
+        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 an object
+        obj = Object.new
+        eruby.def_method(obj, 'render(name)', filename)    # filename is optional
+        p obj.render('world')      #=> "hello world"
+
+      This is equivarent to ERB#def_method().
+
+    - |
+      Erubis::XmlHelper.url_escape() and u() which is alias of url_escape()
+      are added.
+      This is equivarent to ERB#Util.url_escape().
+
+
+  bugfix:
+    - Help message was not shown when '-h' is specified. Fixed.
+    - 'def method()' was not availabe in template file. Fixed.
 
 
 #

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-copyright(c) 2006-2007 kuwata-lab.com all rights reserved.
+copyright(c) 2006-2011 kuwata-lab.com all rights reserved.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.txt

@@ -1,7 +1,7 @@
 = README
 
-release::	2.3.1
-copyright::	copyright(c) 2006-2007 kuwata-lab.com all rights reserved.
+release::	2.7.0
+copyright::	copyright(c) 2006-2011 kuwata-lab.com all rights reserved.
 
 
 
@@ -20,6 +20,7 @@ Erubis is an implementation of eRuby. It has the following features.
 * Ruby on Rails support
 
 Erubis is implemented in pure Ruby.  It requires Ruby 1.8 or higher.
+Erubis now supports Ruby 1.9.
 
 See doc/users-guide.html for details.
 
@@ -27,9 +28,9 @@ See doc/users-guide.html for details.
 
 == Installation
 
-* If you have installed RubyGems, just type <tt>gem install --remote erubis</tt>.
+* If you have installed RubyGems, just type <tt>gem install erubis</tt>.
 
-    $ sudo gem install --remote erubis
+    $ sudo gem install erubis
 
 * Else install abstract[http://rubyforge.org/projects/abstract/] at first,
   and download erubis_X.X.X.tar.bz2 and install it by setup.rb.
@@ -62,7 +63,7 @@ and restart web server.
      require 'erubis/helpers/rails_helper'
      #Erubis::Helpers::RailsHelper.engine_class = Erubis::Eruby
      #Erubis::Helpers::RailsHelper.init_properties = {}
-     #Erubis::Helpers::RailsHelper.show_src = false
+     #Erubis::Helpers::RailsHelper.show_src = nil
 
 If Erubis::Helpers::RailsHelper.show_src is ture, Erubis prints converted Ruby code
 into log file ('log/development.log' or so).  It is useful for debug.

data/benchmark/bench.rb

@@ -1,9 +1,8 @@
 #!/usr/bin/env ruby
 
 ###
-### $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 'erb'
@@ -93,7 +92,8 @@ class BenchmarkApplication
 
   def execute_eruby(filename, context)
     return unless ERuby
-    eval context2code(context)
+    #eval context2code(context)
+    list = context['list']
     @ntimes.times do
       ERuby.import(filename)
     end
@@ -101,7 +101,8 @@ class BenchmarkApplication
   end
 
   def execute_erb(filename, context)
-    eval context2code(context)
+    #eval context2code(context)
+    list = context['list']
     output = nil
     @ntimes.times do
       eruby = ERB.new(File.read(filename))
@@ -112,7 +113,8 @@ class BenchmarkApplication
   end
 
   def execute_erb_cached(filename, context)
-    eval context2code(context)
+    #eval context2code(context)
+    list = context['list']
     output = nil
     cachefile = filename + '.cache'
     File.unlink(cachefile) if test(?f, cachefile)
@@ -135,7 +137,8 @@ class BenchmarkApplication
   for klass in %w[Eruby FastEruby TinyEruby ArrayBufferEruby PrintOutEruby StdoutEruby] do
     s = <<-END
     def execute_erubis_#{klass.downcase}(filename, context)
-      eval context2code(context)
+      #eval context2code(context)
+      list = context['list']
       output = nil
       @ntimes.times do
         eruby = Erubis::#{klass}.new(File.read(filename))
@@ -152,7 +155,8 @@ class BenchmarkApplication
   for klass in %w[Eruby FastEruby] do
     s = <<-END
     def execute_erubis_#{klass.downcase}_cached(filename, context)
-      eval context2code(context)
+      #eval context2code(context)
+      list = context['list']
       cachefile = filename + '.cache'
       File.unlink(cachefile) if test(?f, cachefile)
       output = nil
@@ -173,7 +177,8 @@ class BenchmarkApplication
 
   def convert_eruby(filename, context)
     return unless ERuby
-    eval context2code(context)
+    #eval context2code(context)
+    list = context['list']
     output = nil
     @ntimes.times do
       output = ERuby::Compiler.new.compile_string(File.read(filename))
@@ -182,7 +187,8 @@ class BenchmarkApplication
   end
 
   def convert_erb(filename, context)
-    eval context2code(context)
+    #eval context2code(context)
+    list = context['list']
     output = nil
     @ntimes.times do
       eruby = ERB.new(File.read(filename))
@@ -194,7 +200,8 @@ class BenchmarkApplication
   for klass in %w[Eruby FastEruby TinyEruby]
     s = <<-END
       def convert_erubis_#{klass.downcase}(filename, context)
-        eval context2code(context)
+        #eval context2code(context)
+        list = context['list']
         output = nil
         @ntimes.times do
           eruby = Erubis::#{klass}.new(File.read(filename))

data/bin/erubis

@@ -1,9 +1,8 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
 
 ###
-### $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 'erubis/main'