From ed19bab600e363c2fa8c4b99f622795b2ac22656 Mon Sep 17 00:00:00 2001
From: "(no author)" <(no author)@c9e70521-770b-0410-b9ac-ce6205b42a9f>
Date: Sun, 11 Feb 2007 05:15:33 +0000
Subject: - [release] release preparation
---
doc/users-guide.html | 59 +++++++++++++++++++++++++++++++++++++---------------
1 file changed, 42 insertions(+), 17 deletions(-)
(limited to 'doc')
diff --git a/doc/users-guide.html b/doc/users-guide.html
index 9d90677..5ab21cd 100644
--- a/doc/users-guide.html
+++ b/doc/users-guide.html
@@ -43,7 +43,7 @@ It has the following features.
Easy to expand and customize in subclass
-Ruby on Rails support
+Ruby on Rails support
Erubis is implemented in pure Ruby. It requires Ruby 1.8 or higher.
@@ -1946,11 +1946,11 @@ document.write(_buf.join(""));
Other Topics
Syntax Checking
-Command-line option '-X' checks syntax. It is similar to 'erubis -x file.rhtml | ruby -wc', but it can take several file names.
+
Command-line option '-z' checks syntax. It is similar to 'erubis -x file.rhtml | ruby -wc', but it can take several file names.
-example of command-line option '-X'
-$ erubis -X app/views/*/*.rhtml
+example of command-line option '-z'
+$ erubis -z app/views/*/*.rhtml
Syntax OK
@@ -1989,7 +1989,7 @@ try Erubis::TinyEruby class.
Ruby on Rails Support
-Erubis supports Ruby on Rails.
+
Erubis supports Ruby on Rails. ActionView::Helpers::CaptureHelper#capture() and ActionView::Helpers::Texthelper#concat() are available.
- Add the following code to your 'config/environment.rb'.
@@ -2001,6 +2001,10 @@ config/environment.rb
#Erubis::Helpers::RailsHelper.show_src = false
+
+ This will replace ERB in Rails by Erubis entirely.
+
+
- (Optional) apply the following patch to 'action_pack/lib/action_view/base.rb'.
action_view_base_rb.patch
@@ -2028,7 +2032,7 @@ action_view_base_rb.patch
@@template_args[render_symbol] ||= {}
- This patch is included in erubis_X.X.X/contrib directory and the following is an
+
This patch is included in erubis_2.X.X/contrib directory and the following is an
example to apply this patch.
@@ -2038,7 +2042,7 @@ $ sudo patch -p1 < /tmp/erubis_2.X.X/contrib/action_view_base_rb.patch
-
Notice that this patch is optinal if you are using Ruby on Rails ver 1.1 or 1.2.
+
Notice that this patch is not necessary if you are using Ruby on Rails ver 1.1 or 1.2, but it is recommended.
- Restart web server.
@@ -2246,15 +2250,16 @@ MacOS X 10.4 Tiger, Intel CoreDuo 1.83GHz, Ruby1.8.5, eruby1.0.5, gcc4.0.1
This shows that...
@@ -2272,6 +2277,26 @@ Erubis::TinyEruby 18.370000 0.660000 19.030000 ( 21.475423)
- Erubis::TinyEruby (at 'erubis/tiny.rb') is the fastest in all eRuby implementations when no caching.
+Escaping HTML characters (such as '< > & "') makes Erubis more faster than eruby and ERB,
+because Erubis::XmlHelper.escape_html() works faster than CGI.escapeHTML() and ERB::Util.h().
+The following shows that Erubis is more than 30 percent faster than eruby.
+
+
+When escaping HTML characters with option '-e'
+$ ruby erubybench.rb -n 10000 -m execute -e
+## execute
+ user system total real
+eruby 41.800000 0.820000 42.620000 ( 45.547137)
+ERB 86.030000 1.340000 87.370000 ( 92.739382)
+Erubis::Eruby 30.960000 0.820000 31.780000 ( 33.783879)
+Erubis::Eruby(cached) 23.150000 0.970000 24.120000 ( 25.599809)
+Erubis::ArrayBufferEruby 31.180000 0.830000 32.010000 ( 33.815682)
+Erubis::SimplifiedEruby 29.120000 0.810000 29.930000 ( 31.788697)
+Erubis::StdoutEruby 32.670000 0.840000 33.510000 ( 35.592838)
+Erubis::PrintOutEruby 32.560000 0.850000 33.410000 ( 35.365003)
+Erubis::TinyEruby 30.220000 0.810000 31.030000 ( 32.996905)
+Erubis::PI::Eruby 31.880000 0.850000 32.730000 ( 35.329514)
+
@@ -2306,7 +2331,7 @@ Erubis::TinyEruby 18.370000 0.660000 19.030000 ( 21.475423)
Show compiled source.
-
--X
+-z
-
Syntax checking.
--
cgit v1.2.1