diff options
author | (no author) <(no author)@c9e70521-770b-0410-b9ac-ce6205b42a9f> | 2007-02-11 05:15:33 +0000 |
---|---|---|
committer | (no author) <(no author)@c9e70521-770b-0410-b9ac-ce6205b42a9f> | 2007-02-11 05:15:33 +0000 |
commit | ed19bab600e363c2fa8c4b99f622795b2ac22656 (patch) | |
tree | 56f7ff9053cfaecd38ee0b03ddb35f08aa4dc732 | |
parent | ebddcd7c58d624e4d50599800500efa31960724d (diff) | |
download | erubis-ed19bab600e363c2fa8c4b99f622795b2ac22656.tar.gz |
- [release] release preparation
-rw-r--r-- | CHANGES | 67 | ||||
-rw-r--r-- | ChangeLog.txt | 3 | ||||
-rw-r--r-- | LGPL | 504 | ||||
-rw-r--r-- | Rookbook.yaml | 2 | ||||
-rw-r--r-- | benchmark/erubybench.rb | 11 | ||||
-rw-r--r-- | benchmark/erubybench.rhtml (renamed from benchmark/templates/_header.html) | 33 | ||||
-rw-r--r-- | benchmark/templates/_footer.html | 4 | ||||
-rw-r--r-- | benchmark/templates/erubybench.rhtml | 29 | ||||
-rw-r--r-- | doc/users-guide.html | 59 | ||||
-rw-r--r-- | erubis.gemspec | 2 | ||||
-rw-r--r-- | lib/erubis/helper.rb | 22 | ||||
-rw-r--r-- | lib/erubis/helpers/rails_helper.rb | 12 |
12 files changed, 136 insertions, 612 deletions
@@ -10,12 +10,14 @@ - | Performance tuned up. Release 2.2.0 works about 8 percent faster than 2.1.0. + As a result, Erubis works about 10 percent faster than eruby. + (eruby is the extension module of eRuby written in C.) - | - Support of Ruby on Rails improved. Methods 'capture()' and 'content_for()' - of ActionView::Helpers::CaptureHelper are available. + Support of Ruby on Rails improved. If you want to use Erubis with Ruby on Rails, add the following code into your 'config/environment.rb' and restart web server. + This will set Erubis as eRuby compiler in Ruby on Rails instead of ERB. -------------------- require 'erubis/helpers/rails_helper' @@ -24,8 +26,11 @@ #Erubis::Helpers::RailsHelper.show_src = true -------------------- + Methods 'capture()' and 'content_for()' of ActionView::Helpers::CaptureHelper + are available. Methd ActionView::Helpers::TextHelper#concat() is also available. + If Erubis::Helpers::RailsHelper.show_src is ture, Erubis prints converted - Ruby code into log file ('log/development.log' or so). + Ruby code into log file (such as 'log/development.log'). - | Erubis::Engine.load_file(filename) creates cache file (filename + @@ -40,34 +45,6 @@ -------------------- - | - Class Erubis::Eruby changed to include Erubis::StringBufferEnhancer - instead of Erubis::ArrayBufferEnhancer. - (String buffer is a litte faster than array buffer.) - - ex. - ==================== - $ cat example.rhtml - <ul> - <% for item in @list %> - <li><%= item %></li> - <% end %> - </ul> - $ erubis -x example.rhtml - _buf = ''; _buf << '<ul> - '; for item in @list - _buf << ' <li>'; _buf << ( item ).to_s; _buf << '</li> - '; end - _buf << '</ul> - '; - _buf.to_s - ==================== - - - | - Erubis::StringBufferEnhancer#add_postamble() prints "_buf.to_s" - instead of "_buf". - This is useful for 'erubis -x file.rhtml | ruby -wc'. - - - | Command-line option '-f datafile' can take Ruby script ('*.rb') as well as YAML file ('*.yaml' or '*.yml'). @@ -122,6 +99,34 @@ changes: - | + Class Erubis::Eruby changed to include Erubis::StringBufferEnhancer + instead of Erubis::ArrayBufferEnhancer. + This is for Ruby on Rails support. + + ex. + ==================== + $ cat example.rhtml + <ul> + <% for item in @list %> + <li><%= item %></li> + <% end %> + </ul> + $ erubis -x example.rhtml + _buf = ''; _buf << '<ul> + '; for item in @list + _buf << ' <li>'; _buf << ( item ).to_s; _buf << '</li> + '; end + _buf << '</ul> + '; + _buf.to_s + ==================== + + - | + Erubis::StringBufferEnhancer#add_postamble() prints "_buf.to_s" + instead of "_buf". + This is useful for 'erubis -x file.rhtml | ruby -wc'. + + - | License is changed to MIT License. - | diff --git a/ChangeLog.txt b/ChangeLog.txt index 734b913..bad2d8a 100644 --- a/ChangeLog.txt +++ b/ChangeLog.txt @@ -2,6 +2,9 @@ .?lastupdate: $Date$ .?version: $Rev$ +: Rev.64 (2007-02-11) + .- [release] release preparation + : Rev.63 (2007-02-11) .- [change] option '-X' is changed to '-z' .- [enhance] erubybench.rb supports '-e' (escape) option @@ -1,504 +0,0 @@ - GNU LESSER GENERAL PUBLIC LICENSE - Version 2.1, February 1999 - - Copyright (C) 1991, 1999 Free Software Foundation, Inc. - 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - -[This is the first released version of the Lesser GPL. It also counts - as the successor of the GNU Library Public License, version 2, hence - the version number 2.1.] - - Preamble - - The licenses for most software are designed to take away your -freedom to share and change it. By contrast, the GNU General Public -Licenses are intended to guarantee your freedom to share and change -free software--to make sure the software is free for all its users. - - This license, the Lesser General Public License, applies to some -specially designated software packages--typically libraries--of the -Free Software Foundation and other authors who decide to use it. You -can use it too, but we suggest you first think carefully about whether -this license or the ordinary General Public License is the better -strategy to use in any particular case, based on the explanations below. - - When we speak of free software, we are referring to freedom of use, -not price. Our General Public Licenses are designed to make sure that -you have the freedom to distribute copies of free software (and charge -for this service if you wish); that you receive source code or can get -it if you want it; that you can change the software and use pieces of -it in new free programs; and that you are informed that you can do -these things. - - To protect your rights, we need to make restrictions that forbid -distributors to deny you these rights or to ask you to surrender these -rights. These restrictions translate to certain responsibilities for -you if you distribute copies of the library or if you modify it. - - For example, if you distribute copies of the library, whether gratis -or for a fee, you must give the recipients all the rights that we gave -you. You must make sure that they, too, receive or can get the source -code. If you link other code with the library, you must provide -complete object files to the recipients, so that they can relink them -with the library after making changes to the library and recompiling -it. And you must show them these terms so they know their rights. - - We protect your rights with a two-step method: (1) we copyright the -library, and (2) we offer you this license, which gives you legal -permission to copy, distribute and/or modify the library. - - To protect each distributor, we want to make it very clear that -there is no warranty for the free library. Also, if the library is -modified by someone else and passed on, the recipients should know -that what they have is not the original version, so that the original -author's reputation will not be affected by problems that might be -introduced by others. - - Finally, software patents pose a constant threat to the existence of -any free program. We wish to make sure that a company cannot -effectively restrict the users of a free program by obtaining a -restrictive license from a patent holder. Therefore, we insist that -any patent license obtained for a version of the library must be -consistent with the full freedom of use specified in this license. - - Most GNU software, including some libraries, is covered by the -ordinary GNU General Public License. This license, the GNU Lesser -General Public License, applies to certain designated libraries, and -is quite different from the ordinary General Public License. We use -this license for certain libraries in order to permit linking those -libraries into non-free programs. - - When a program is linked with a library, whether statically or using -a shared library, the combination of the two is legally speaking a -combined work, a derivative of the original library. The ordinary -General Public License therefore permits such linking only if the -entire combination fits its criteria of freedom. The Lesser General -Public License permits more lax criteria for linking other code with -the library. - - We call this license the "Lesser" General Public License because it -does Less to protect the user's freedom than the ordinary General -Public License. It also provides other free software developers Less -of an advantage over competing non-free programs. These disadvantages -are the reason we use the ordinary General Public License for many -libraries. However, the Lesser license provides advantages in certain -special circumstances. - - For example, on rare occasions, there may be a special need to -encourage the widest possible use of a certain library, so that it becomes -a de-facto standard. To achieve this, non-free programs must be -allowed to use the library. A more frequent case is that a free -library does the same job as widely used non-free libraries. In this -case, there is little to gain by limiting the free library to free -software only, so we use the Lesser General Public License. - - In other cases, permission to use a particular library in non-free -programs enables a greater number of people to use a large body of -free software. For example, permission to use the GNU C Library in -non-free programs enables many more people to use the whole GNU -operating system, as well as its variant, the GNU/Linux operating -system. - - Although the Lesser General Public License is Less protective of the -users' freedom, it does ensure that the user of a program that is -linked with the Library has the freedom and the wherewithal to run -that program using a modified version of the Library. - - The precise terms and conditions for copying, distribution and -modification follow. Pay close attention to the difference between a -"work based on the library" and a "work that uses the library". The -former contains code derived from the library, whereas the latter must -be combined with the library in order to run. - - GNU LESSER GENERAL PUBLIC LICENSE - TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION - - 0. This License Agreement applies to any software library or other -program which contains a notice placed by the copyright holder or -other authorized party saying it may be distributed under the terms of -this Lesser General Public License (also called "this License"). -Each licensee is addressed as "you". - - A "library" means a collection of software functions and/or data -prepared so as to be conveniently linked with application programs -(which use some of those functions and data) to form executables. - - The "Library", below, refers to any such software library or work -which has been distributed under these terms. A "work based on the -Library" means either the Library or any derivative work under -copyright law: that is to say, a work containing the Library or a -portion of it, either verbatim or with modifications and/or translated -straightforwardly into another language. (Hereinafter, translation is -included without limitation in the term "modification".) - - "Source code" for a work means the preferred form of the work for -making modifications to it. For a library, complete source code means -all the source code for all modules it contains, plus any associated -interface definition files, plus the scripts used to control compilation -and installation of the library. - - Activities other than copying, distribution and modification are not -covered by this License; they are outside its scope. The act of -running a program using the Library is not restricted, and output from -such a program is covered only if its contents constitute a work based -on the Library (independent of the use of the Library in a tool for -writing it). Whether that is true depends on what the Library does -and what the program that uses the Library does. - - 1. You may copy and distribute verbatim copies of the Library's -complete source code as you receive it, in any medium, provided that -you conspicuously and appropriately publish on each copy an -appropriate copyright notice and disclaimer of warranty; keep intact -all the notices that refer to this License and to the absence of any -warranty; and distribute a copy of this License along with the -Library. - - You may charge a fee for the physical act of transferring a copy, -and you may at your option offer warranty protection in exchange for a -fee. - - 2. You may modify your copy or copies of the Library or any portion -of it, thus forming a work based on the Library, and copy and -distribute such modifications or work under the terms of Section 1 -above, provided that you also meet all of these conditions: - - a) The modified work must itself be a software library. - - b) You must cause the files modified to carry prominent notices - stating that you changed the files and the date of any change. - - c) You must cause the whole of the work to be licensed at no - charge to all third parties under the terms of this License. - - d) If a facility in the modified Library refers to a function or a - table of data to be supplied by an application program that uses - the facility, other than as an argument passed when the facility - is invoked, then you must make a good faith effort to ensure that, - in the event an application does not supply such function or - table, the facility still operates, and performs whatever part of - its purpose remains meaningful. - - (For example, a function in a library to compute square roots has - a purpose that is entirely well-defined independent of the - application. Therefore, Subsection 2d requires that any - application-supplied function or table used by this function must - be optional: if the application does not supply it, the square - root function must still compute square roots.) - -These requirements apply to the modified work as a whole. If -identifiable sections of that work are not derived from the Library, -and can be reasonably considered independent and separate works in -themselves, then this License, and its terms, do not apply to those -sections when you distribute them as separate works. But when you -distribute the same sections as part of a whole which is a work based -on the Library, the distribution of the whole must be on the terms of -this License, whose permissions for other licensees extend to the -entire whole, and thus to each and every part regardless of who wrote -it. - -Thus, it is not the intent of this section to claim rights or contest -your rights to work written entirely by you; rather, the intent is to -exercise the right to control the distribution of derivative or -collective works based on the Library. - -In addition, mere aggregation of another work not based on the Library -with the Library (or with a work based on the Library) on a volume of -a storage or distribution medium does not bring the other work under -the scope of this License. - - 3. You may opt to apply the terms of the ordinary GNU General Public -License instead of this License to a given copy of the Library. To do -this, you must alter all the notices that refer to this License, so -that they refer to the ordinary GNU General Public License, version 2, -instead of to this License. (If a newer version than version 2 of the -ordinary GNU General Public License has appeared, then you can specify -that version instead if you wish.) Do not make any other change in -these notices. - - Once this change is made in a given copy, it is irreversible for -that copy, so the ordinary GNU General Public License applies to all -subsequent copies and derivative works made from that copy. - - This option is useful when you wish to copy part of the code of -the Library into a program that is not a library. - - 4. You may copy and distribute the Library (or a portion or -derivative of it, under Section 2) in object code or executable form -under the terms of Sections 1 and 2 above provided that you accompany -it with the complete corresponding machine-readable source code, which -must be distributed under the terms of Sections 1 and 2 above on a -medium customarily used for software interchange. - - If distribution of object code is made by offering access to copy -from a designated place, then offering equivalent access to copy the -source code from the same place satisfies the requirement to -distribute the source code, even though third parties are not -compelled to copy the source along with the object code. - - 5. A program that contains no derivative of any portion of the -Library, but is designed to work with the Library by being compiled or -linked with it, is called a "work that uses the Library". Such a -work, in isolation, is not a derivative work of the Library, and -therefore falls outside the scope of this License. - - However, linking a "work that uses the Library" with the Library -creates an executable that is a derivative of the Library (because it -contains portions of the Library), rather than a "work that uses the -library". The executable is therefore covered by this License. -Section 6 states terms for distribution of such executables. - - When a "work that uses the Library" uses material from a header file -that is part of the Library, the object code for the work may be a -derivative work of the Library even though the source code is not. -Whether this is true is especially significant if the work can be -linked without the Library, or if the work is itself a library. The -threshold for this to be true is not precisely defined by law. - - If such an object file uses only numerical parameters, data -structure layouts and accessors, and small macros and small inline -functions (ten lines or less in length), then the use of the object -file is unrestricted, regardless of whether it is legally a derivative -work. (Executables containing this object code plus portions of the -Library will still fall under Section 6.) - - Otherwise, if the work is a derivative of the Library, you may -distribute the object code for the work under the terms of Section 6. -Any executables containing that work also fall under Section 6, -whether or not they are linked directly with the Library itself. - - 6. As an exception to the Sections above, you may also combine or -link a "work that uses the Library" with the Library to produce a -work containing portions of the Library, and distribute that work -under terms of your choice, provided that the terms permit -modification of the work for the customer's own use and reverse -engineering for debugging such modifications. - - You must give prominent notice with each copy of the work that the -Library is used in it and that the Library and its use are covered by -this License. You must supply a copy of this License. If the work -during execution displays copyright notices, you must include the -copyright notice for the Library among them, as well as a reference -directing the user to the copy of this License. Also, you must do one -of these things: - - a) Accompany the work with the complete corresponding - machine-readable source code for the Library including whatever - changes were used in the work (which must be distributed under - Sections 1 and 2 above); and, if the work is an executable linked - with the Library, with the complete machine-readable "work that - uses the Library", as object code and/or source code, so that the - user can modify the Library and then relink to produce a modified - executable containing the modified Library. (It is understood - that the user who changes the contents of definitions files in the - Library will not necessarily be able to recompile the application - to use the modified definitions.) - - b) Use a suitable shared library mechanism for linking with the - Library. A suitable mechanism is one that (1) uses at run time a - copy of the library already present on the user's computer system, - rather than copying library functions into the executable, and (2) - will operate properly with a modified version of the library, if - the user installs one, as long as the modified version is - interface-compatible with the version that the work was made with. - - c) Accompany the work with a written offer, valid for at - least three years, to give the same user the materials - specified in Subsection 6a, above, for a charge no more - than the cost of performing this distribution. - - d) If distribution of the work is made by offering access to copy - from a designated place, offer equivalent access to copy the above - specified materials from the same place. - - e) Verify that the user has already received a copy of these - materials or that you have already sent this user a copy. - - For an executable, the required form of the "work that uses the -Library" must include any data and utility programs needed for -reproducing the executable from it. However, as a special exception, -the materials to be distributed need not include anything that is -normally distributed (in either source or binary form) with the major -components (compiler, kernel, and so on) of the operating system on -which the executable runs, unless that component itself accompanies -the executable. - - It may happen that this requirement contradicts the license -restrictions of other proprietary libraries that do not normally -accompany the operating system. Such a contradiction means you cannot -use both them and the Library together in an executable that you -distribute. - - 7. You may place library facilities that are a work based on the -Library side-by-side in a single library together with other library -facilities not covered by this License, and distribute such a combined -library, provided that the separate distribution of the work based on -the Library and of the other library facilities is otherwise -permitted, and provided that you do these two things: - - a) Accompany the combined library with a copy of the same work - based on the Library, uncombined with any other library - facilities. This must be distributed under the terms of the - Sections above. - - b) Give prominent notice with the combined library of the fact - that part of it is a work based on the Library, and explaining - where to find the accompanying uncombined form of the same work. - - 8. You may not copy, modify, sublicense, link with, or distribute -the Library except as expressly provided under this License. Any -attempt otherwise to copy, modify, sublicense, link with, or -distribute the Library is void, and will automatically terminate your -rights under this License. However, parties who have received copies, -or rights, from you under this License will not have their licenses -terminated so long as such parties remain in full compliance. - - 9. You are not required to accept this License, since you have not -signed it. However, nothing else grants you permission to modify or -distribute the Library or its derivative works. These actions are -prohibited by law if you do not accept this License. Therefore, by -modifying or distributing the Library (or any work based on the -Library), you indicate your acceptance of this License to do so, and -all its terms and conditions for copying, distributing or modifying -the Library or works based on it. - - 10. Each time you redistribute the Library (or any work based on the -Library), the recipient automatically receives a license from the -original licensor to copy, distribute, link with or modify the Library -subject to these terms and conditions. You may not impose any further -restrictions on the recipients' exercise of the rights granted herein. -You are not responsible for enforcing compliance by third parties with -this License. - - 11. If, as a consequence of a court judgment or allegation of patent -infringement or for any other reason (not limited to patent issues), -conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot -distribute so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you -may not distribute the Library at all. For example, if a patent -license would not permit royalty-free redistribution of the Library by -all those who receive copies directly or indirectly through you, then -the only way you could satisfy both it and this License would be to -refrain entirely from distribution of the Library. - -If any portion of this section is held invalid or unenforceable under any -particular circumstance, the balance of the section is intended to apply, -and the section as a whole is intended to apply in other circumstances. - -It is not the purpose of this section to induce you to infringe any -patents or other property right claims or to contest validity of any -such claims; this section has the sole purpose of protecting the -integrity of the free software distribution system which is -implemented by public license practices. Many people have made -generous contributions to the wide range of software distributed -through that system in reliance on consistent application of that -system; it is up to the author/donor to decide if he or she is willing -to distribute software through any other system and a licensee cannot -impose that choice. - -This section is intended to make thoroughly clear what is believed to -be a consequence of the rest of this License. - - 12. If the distribution and/or use of the Library is restricted in -certain countries either by patents or by copyrighted interfaces, the -original copyright holder who places the Library under this License may add -an explicit geographical distribution limitation excluding those countries, -so that distribution is permitted only in or among countries not thus -excluded. In such case, this License incorporates the limitation as if -written in the body of this License. - - 13. The Free Software Foundation may publish revised and/or new -versions of the Lesser General Public License from time to time. -Such new versions will be similar in spirit to the present version, -but may differ in detail to address new problems or concerns. - -Each version is given a distinguishing version number. If the Library -specifies a version number of this License which applies to it and -"any later version", you have the option of following the terms and -conditions either of that version or of any later version published by -the Free Software Foundation. If the Library does not specify a -license version number, you may choose any version ever published by -the Free Software Foundation. - - 14. If you wish to incorporate parts of the Library into other free -programs whose distribution conditions are incompatible with these, -write to the author to ask for permission. For software which is -copyrighted by the Free Software Foundation, write to the Free -Software Foundation; we sometimes make exceptions for this. Our -decision will be guided by the two goals of preserving the free status -of all derivatives of our free software and of promoting the sharing -and reuse of software generally. - - NO WARRANTY - - 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO -WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. -EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR -OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY -KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE -IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE -LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME -THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN -WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY -AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU -FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR -CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE -LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING -RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A -FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF -SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH -DAMAGES. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Libraries - - If you develop a new library, and you want it to be of the greatest -possible use to the public, we recommend making it free software that -everyone can redistribute and change. You can do so by permitting -redistribution under these terms (or, alternatively, under the terms of the -ordinary General Public License). - - To apply these terms, attach the following notices to the library. It is -safest to attach them to the start of each source file to most effectively -convey the exclusion of warranty; and each file should have at least the -"copyright" line and a pointer to where the full notice is found. - - <one line to give the library's name and a brief idea of what it does.> - Copyright (C) <year> <name of author> - - This library is free software; you can redistribute it and/or - modify it under the terms of the GNU Lesser General Public - License as published by the Free Software Foundation; either - version 2.1 of the License, or (at your option) any later version. - - This library is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - Lesser General Public License for more details. - - You should have received a copy of the GNU Lesser General Public - License along with this library; if not, write to the Free Software - Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - -Also add information on how to contact you by electronic and paper mail. - -You should also get your employer (if you work as a programmer) or your -school, if any, to sign a "copyright disclaimer" for the library, if -necessary. Here is a sample; alter the names: - - Yoyodyne, Inc., hereby disclaims all copyright interest in the - library `Frob' (a library for tweaking knobs) written by James Random Hacker. - - <signature of Ty Coon>, 1 April 1990 - Ty Coon, President of Vice - -That's all there is to it! - - diff --git a/Rookbook.yaml b/Rookbook.yaml index 6041df6..1656437 100644 --- a/Rookbook.yaml +++ b/Rookbook.yaml @@ -122,6 +122,7 @@ recipes: base = File.basename(f) !exclude_libs.include?(base) end + rm_f "#{dir}/test/Rookbook.yaml", "#{dir}/test/test.log" # store 'benchmark/erubybench.{rb,rhtml,yaml}', 'benchmark/erubybench-lib.rb', dir # @@ -157,6 +158,7 @@ recipes: # chmod 0644, "#{dir}/**/*", :filetype=>'file' chmod 0755, "#{dir}/{bin,contrib}/*", :filetype=>'file' + chmod 0644, "#{dir}/contrib/*.patch" - product: :duplicate method*: | diff --git a/benchmark/erubybench.rb b/benchmark/erubybench.rb index 066fd73..663da10 100644 --- a/benchmark/erubybench.rb +++ b/benchmark/erubybench.rb @@ -10,9 +10,9 @@ require 'stringio' require 'cgi' include ERB::Util #module ERB::Util -# XmlEscapeTable = { '&'=>'&', '<'=>'<', '>'=>'>', '"'=>'"' } +# ESCAPE_TABLE = { '&'=>'&', '<'=>'<', '>'=>'>', '"'=>'"', "'"=>''', } # def h(value) -# value.to_s.gsub(/[&<>"]/) { |s| XmlEscapeTable[s] } +# value.to_s.gsub(/[&<>"]/) { |s| ESCAPE_TABLE[s] } # end # module_function :h #end @@ -164,10 +164,7 @@ def File.write(filename, str) end # if $erubyfile == defaults[:erubyfile] - header = File.read("templates/_header.html") - footer = File.read("templates/_footer.html") - body = File.read("templates/#{$erubyfile}") - erubystr = header + body + footer + erubystr = File.read($erubyfile) s = erubystr erubystrs = {} if $escape @@ -180,7 +177,7 @@ if $erubyfile == defaults[:erubyfile] erubystrs['eruby'] = s erubystrs['ERB'] = s erubystrs['Erubis'] = s - erubystrs['Tiny'] = s + erubystrs['Tiny'] = s erubystrs['PI'] = s.gsub(/<%=(.*?)%>/, '@!{\1}@').gsub(/<%(.*?)%>/m, '<?rb\1?>') end else diff --git a/benchmark/templates/_header.html b/benchmark/erubybench.rhtml index e7c2dcc..5343ffe 100644 --- a/benchmark/templates/_header.html +++ b/benchmark/erubybench.rhtml @@ -50,3 +50,36 @@ thead { <th>#</th><th>code</th><th>name</th><th>price</th><th>change</th><th>ratio</th> </tr> </thead> + <tbody> +<% + n = 0 + for item in list + n += 1 + %> + <tr class="<%= n % 2 == 0 ? 'even' : 'odd' %>"> + <td style="text-align: center"><%= n %></td> + <td> + <a href="/stocks/<%= item['code'] %>"><%= item['code'] %></a> + </td> + <td> + <a href="<%= item['url'] %>"><%= item['name'] %></a> + </td> + <td> + <strong><%= item['price'] %></strong> + </td> + <% if item['change'] < 0.0 %> + <td class="minus"><%= item['change'] %></td> + <td class="minus"><%= item['ratio'] %></td> + <% else %> + <td><%= item['change'] %></td> + <td><%= item['ratio'] %></td> + <% end %> + </tr> +<% + end + %> + </tbody> + </table> + + </body> +</html> diff --git a/benchmark/templates/_footer.html b/benchmark/templates/_footer.html deleted file mode 100644 index 3ae6d4d..0000000 --- a/benchmark/templates/_footer.html +++ /dev/null @@ -1,4 +0,0 @@ - </table> - - </body> -</html> diff --git a/benchmark/templates/erubybench.rhtml b/benchmark/templates/erubybench.rhtml deleted file mode 100644 index de6f188..0000000 --- a/benchmark/templates/erubybench.rhtml +++ /dev/null @@ -1,29 +0,0 @@ - <tbody> -<% - n = 0 - for item in list - n += 1 - %> - <tr class="<%= n % 2 == 0 ? 'even' : 'odd' %>"> - <td style="text-align: center"><%= n %></td> - <td> - <a href="/stocks/<%= item['code'] %>"><%= item['code'] %></a> - </td> - <td> - <a href="<%= item['url'] %>"><%= item['name'] %></a> - </td> - <td> - <strong><%= item['price'] %></strong> - </td> - <% if item['change'] < 0.0 %> - <td class="minus"><%= item['change'] %></td> - <td class="minus"><%= item['ratio'] %></td> - <% else %> - <td><%= item['change'] %></td> - <td><%= item['ratio'] %></td> - <% end %> - </tr> -<% - end - %> - </tbody> 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. </li> <li>Easy to expand and customize in subclass </li> -<li>Ruby on Rails support +<li><a href="#topics-rails">Ruby on Rails support</a> </li> </ul> <p>Erubis is implemented in pure Ruby. It requires Ruby 1.8 or higher. @@ -1946,11 +1946,11 @@ document.write(_buf.join("")); <h2 class="section1">Other Topics</h2> <a name="topics-syntax"></a> <h3 class="section2">Syntax Checking</h3> -<p>Command-line option '-X' checks syntax. It is similar to 'erubis -x file.rhtml | ruby -wc', but it can take several file names. +<p>Command-line option '-z' checks syntax. It is similar to 'erubis -x file.rhtml | ruby -wc', but it can take several file names. </p> <div class="terminal_caption"> -example of command-line option '-X'</div> -<pre class="terminal">$ erubis <strong>-X</strong> app/views/*/*.rhtml +example of command-line option '-z'</div> +<pre class="terminal">$ erubis <strong>-z</strong> app/views/*/*.rhtml Syntax OK </pre> <br> @@ -1989,7 +1989,7 @@ try Erubis::TinyEruby class. <a name="topics-rails"></a> <h3 class="section2">Ruby on Rails Support</h3> -<p>Erubis supports Ruby on Rails. +<p>Erubis supports Ruby on Rails. ActionView::Helpers::CaptureHelper#capture() and ActionView::Helpers::Texthelper#concat() are available. </p> <ol type="1"> <li>Add the following code to your 'config/environment.rb'. @@ -2001,6 +2001,10 @@ config/environment.rb</div> #Erubis::Helpers::RailsHelper.show_src = false </pre> </li> +</ol> +<p> This will replace ERB in Rails by Erubis entirely. +</p> +<ol type="1"> <li>(Optional) apply the following patch to 'action_pack/lib/action_view/base.rb'. <div class="program_caption"> action_view_base_rb.patch</div> @@ -2028,7 +2032,7 @@ action_view_base_rb.patch</div> @@template_args[render_symbol] ||= {} </pre> -<p> This patch is included in erubis_X.X.X/contrib directory and the following is an +<p> This patch is included in erubis_2.X.X/contrib directory and the following is an example to apply this patch. </p> <div class="terminal_caption"> @@ -2038,7 +2042,7 @@ $ sudo patch -p1 < /tmp/erubis_2.X.X/contrib/action_view_base_rb.patch </pre> </li> </ol> -<p> Notice that this patch is optinal if you are using Ruby on Rails ver 1.1 or 1.2. +<p> Notice that this patch is not necessary if you are using Ruby on Rails ver 1.1 or 1.2, but it is recommended. </p> <ol type="1"> <li>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</div> $ ruby erubybench.rb -n 10000 -m execute ## execute user system total real -eruby 24.460000 0.600000 25.060000 ( 29.248518) -ERB 65.190000 1.060000 66.250000 ( 77.053693) -Erubis::Eruby 21.450000 0.700000 22.150000 ( 26.237943) -Erubis::Eruby(cached) 14.440000 0.850000 15.290000 ( 18.152723) -Erubis::ArrayBufferEruby 21.730000 0.710000 22.440000 ( 26.861644) -Erubis::SimplifiedEruby 19.620000 0.660000 20.280000 ( 23.159973) -Erubis::StdoutEruby 22.810000 0.690000 23.500000 ( 26.590015) -Erubis::PrintOutEruby 22.590000 0.680000 23.270000 ( 26.336551) -Erubis::TinyEruby 18.370000 0.660000 19.030000 ( 21.475423) +eruby 23.270000 0.540000 23.810000 ( 33.621505) +ERB 68.170000 0.930000 69.100000 ( 77.182647) +Erubis::Eruby 20.650000 0.640000 21.290000 ( 23.776704) +Erubis::Eruby(cached) 13.780000 0.810000 14.590000 ( 16.420384) +Erubis::ArrayBufferEruby 20.920000 0.650000 21.570000 ( 24.031593) +Erubis::SimplifiedEruby 18.830000 0.620000 19.450000 ( 21.792011) +Erubis::StdoutEruby 22.070000 0.650000 22.720000 ( 25.483154) +Erubis::PrintOutEruby 21.930000 0.640000 22.570000 ( 25.272523) +Erubis::TinyEruby 17.620000 0.620000 18.240000 ( 20.641452) +Erubis::PI::Eruby 21.840000 0.650000 22.490000 ( 25.242539) </pre> <p>This shows that... </p> @@ -2272,6 +2277,26 @@ Erubis::TinyEruby 18.370000 0.660000 19.030000 ( 21.475423) <li>Erubis::TinyEruby (at 'erubis/tiny.rb') is the fastest in all eRuby implementations when no caching. </li> </ul> +<p>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. +</p> +<div class="terminal_caption"> +When escaping HTML characters with option '-e'</div> +<pre class="terminal">$ 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) +</pre> <br> @@ -2306,7 +2331,7 @@ Erubis::TinyEruby 18.370000 0.660000 19.030000 ( 21.475423) Show compiled source. </dd> <dt class="dt3"><b> --X </b></dt> +-z </b></dt> <dd class="dd3"> Syntax checking. </dd> diff --git a/erubis.gemspec b/erubis.gemspec index a19d855..b269230 100644 --- a/erubis.gemspec +++ b/erubis.gemspec @@ -11,7 +11,7 @@ require 'rubygems' spec = Gem::Specification.new do |s| ## package information s.name = "erubis" - s.author = "kwatch" + s.author = "makoto kuwata" s.version = ("$Release$" =~ /[\.\d]+/) && $& s.platform = Gem::Platform::RUBY s.homepage = "http://rubyforge.org/projects/erubis" diff --git a/lib/erubis/helper.rb b/lib/erubis/helper.rb index bf05763..07cdbe1 100644 --- a/lib/erubis/helper.rb +++ b/lib/erubis/helper.rb @@ -22,27 +22,11 @@ module Erubis "'" => ''', } - def escape_xml(obj) - #table = ESCAPE_TABLE - #obj.to_s.gsub(/[&<>"]/) { |s| table[s] } # or /[&<>"']/ - obj.to_s.gsub(/[&<>"]/) { |s| ESCAPE_TABLE[s] } # or /[&<>"']/ - #obj.to_s.gsub(/[&<>"]/) { ESCAPE_TABLE[$&] } + def escape_xml(value) + value.to_s.gsub(/[&<>"]/) { |s| ESCAPE_TABLE[s] } # or /[&<>"']/ + #value.to_s.gsub(/[&<>"]/) { ESCAPE_TABLE[$&] } end - #-- - #def escape_xml(obj) - # str = obj.to_s.dup - # #str = obj.to_s - # #str = str.dup if obj.__id__ == str.__id__ - # str.gsub!(/&/, '&') - # str.gsub!(/</, '<') - # str.gsub!(/>/, '>') - # str.gsub!(/"/, '"') - # str.gsub!(/'/, ''') - # return str - #end - #++ - alias h escape_xml alias html_escape escape_xml diff --git a/lib/erubis/helpers/rails_helper.rb b/lib/erubis/helpers/rails_helper.rb index 32873ca..455c1c0 100644 --- a/lib/erubis/helpers/rails_helper.rb +++ b/lib/erubis/helpers/rails_helper.rb @@ -170,6 +170,7 @@ end ### end +## set Erubis as eRuby compiler in Ruby on Rails instead of ERB class ActionView::Base # :nodoc: private def convert_template_into_ruby_code(template) @@ -185,6 +186,17 @@ class ActionView::Base # :nodoc: end +## make h() method faster +module ERB::Util # :nodoc: + ESCAPE_TABLE = { '&'=>'&', '<'=>'<', '>'=>'>', '"'=>'"', "'"=>''', } + def h(value) + value.to_s.gsub(/[&<>"]/) { |s| ESCAPE_TABLE[s] } + end + module_function :h +end + + +## finish ac = ActionController::Base.new ac.logger.info "** Erubis #{Erubis::VERSION}" #$stdout.puts "** Erubis #{Erubis::VERSION}" |