2012-11-09 18:33:11 +04:00
|
|
|
# -*- coding: us-ascii -*-
|
2017-10-21 18:02:46 +03:00
|
|
|
# frozen_string_literal: true
|
2004-11-25 18:23:19 +03:00
|
|
|
# = ERB -- Ruby Templating
|
|
|
|
#
|
|
|
|
# Author:: Masatoshi SEKI
|
2011-05-14 22:24:11 +04:00
|
|
|
# Documentation:: James Edward Gray II, Gavin Sinclair, and Simon Chiang
|
2004-11-25 18:23:19 +03:00
|
|
|
#
|
|
|
|
# See ERB for primary documentation and ERB::Util for a couple of utility
|
|
|
|
# routines.
|
|
|
|
#
|
|
|
|
# Copyright (c) 1999-2000,2002,2003 Masatoshi SEKI
|
|
|
|
#
|
2002-11-17 19:11:40 +03:00
|
|
|
# You can redistribute it and/or modify it under the same terms as Ruby.
|
|
|
|
|
2021-01-21 08:43:04 +03:00
|
|
|
require 'cgi/util'
|
|
|
|
require 'erb/version'
|
2022-11-25 02:40:48 +03:00
|
|
|
require 'erb/compiler'
|
|
|
|
require 'erb/def_method'
|
|
|
|
require 'erb/util'
|
2012-08-13 08:17:00 +04:00
|
|
|
|
2004-11-25 18:23:19 +03:00
|
|
|
#
|
|
|
|
# = ERB -- Ruby Templating
|
|
|
|
#
|
|
|
|
# == Introduction
|
|
|
|
#
|
|
|
|
# ERB provides an easy to use but powerful templating system for Ruby. Using
|
|
|
|
# ERB, actual Ruby code can be added to any plain text document for the
|
|
|
|
# purposes of generating document information details and/or flow control.
|
|
|
|
#
|
|
|
|
# A very simple example is this:
|
2009-03-06 06:56:38 +03:00
|
|
|
#
|
2004-11-25 18:23:19 +03:00
|
|
|
# require 'erb'
|
|
|
|
#
|
|
|
|
# x = 42
|
|
|
|
# template = ERB.new <<-EOF
|
|
|
|
# The value of x is: <%= x %>
|
|
|
|
# EOF
|
|
|
|
# puts template.result(binding)
|
|
|
|
#
|
|
|
|
# <em>Prints:</em> The value of x is: 42
|
|
|
|
#
|
|
|
|
# More complex examples are given below.
|
|
|
|
#
|
|
|
|
#
|
|
|
|
# == Recognized Tags
|
|
|
|
#
|
|
|
|
# ERB recognizes certain tags in the provided template and converts them based
|
|
|
|
# on the rules below:
|
|
|
|
#
|
|
|
|
# <% Ruby code -- inline with output %>
|
|
|
|
# <%= Ruby expression -- replace with result %>
|
2021-05-06 09:13:26 +03:00
|
|
|
# <%# comment -- ignored -- useful in testing %> (`<% #` doesn't work. Don't use Ruby comments.)
|
2004-11-25 18:23:19 +03:00
|
|
|
# % a line of Ruby code -- treated as <% line %> (optional -- see ERB.new)
|
|
|
|
# %% replaced with % if first thing on a line and % processing is used
|
|
|
|
# <%% or %%> -- replace with <% or %> respectively
|
|
|
|
#
|
|
|
|
# All other text is passed through ERB filtering unchanged.
|
|
|
|
#
|
|
|
|
#
|
|
|
|
# == Options
|
|
|
|
#
|
|
|
|
# There are several settings you can change when you use ERB:
|
|
|
|
# * the nature of the tags that are recognized;
|
|
|
|
# * the binding used to resolve local variables in the template.
|
|
|
|
#
|
|
|
|
# See the ERB.new and ERB#result methods for more detail.
|
|
|
|
#
|
2008-12-29 12:26:34 +03:00
|
|
|
# == Character encodings
|
|
|
|
#
|
2013-07-18 17:50:32 +04:00
|
|
|
# ERB (or Ruby code generated by ERB) returns a string in the same
|
2008-12-29 12:26:34 +03:00
|
|
|
# character encoding as the input string. When the input string has
|
|
|
|
# a magic comment, however, it returns a string in the encoding specified
|
|
|
|
# by the magic comment.
|
|
|
|
#
|
2014-07-25 11:55:58 +04:00
|
|
|
# # -*- coding: utf-8 -*-
|
2008-12-29 12:26:34 +03:00
|
|
|
# require 'erb'
|
|
|
|
#
|
|
|
|
# template = ERB.new <<EOF
|
|
|
|
# <%#-*- coding: Big5 -*-%>
|
|
|
|
# \_\_ENCODING\_\_ is <%= \_\_ENCODING\_\_ %>.
|
|
|
|
# EOF
|
|
|
|
# puts template.result
|
|
|
|
#
|
|
|
|
# <em>Prints:</em> \_\_ENCODING\_\_ is Big5.
|
|
|
|
#
|
2004-11-25 18:23:19 +03:00
|
|
|
#
|
|
|
|
# == Examples
|
|
|
|
#
|
|
|
|
# === Plain Text
|
|
|
|
#
|
|
|
|
# ERB is useful for any generic templating situation. Note that in this example, we use the
|
|
|
|
# convenient "% at start of line" tag, and we quote the template literally with
|
|
|
|
# <tt>%q{...}</tt> to avoid trouble with the backslash.
|
|
|
|
#
|
|
|
|
# require "erb"
|
2009-03-06 06:56:38 +03:00
|
|
|
#
|
2004-11-25 18:23:19 +03:00
|
|
|
# # Create template.
|
|
|
|
# template = %q{
|
|
|
|
# From: James Edward Gray II <james@grayproductions.net>
|
|
|
|
# To: <%= to %>
|
|
|
|
# Subject: Addressing Needs
|
2009-03-06 06:56:38 +03:00
|
|
|
#
|
2004-11-25 18:23:19 +03:00
|
|
|
# <%= to[/\w+/] %>:
|
2009-03-06 06:56:38 +03:00
|
|
|
#
|
2004-11-25 18:23:19 +03:00
|
|
|
# Just wanted to send a quick note assuring that your needs are being
|
|
|
|
# addressed.
|
2009-03-06 06:56:38 +03:00
|
|
|
#
|
2004-11-25 18:23:19 +03:00
|
|
|
# I want you to know that my team will keep working on the issues,
|
|
|
|
# especially:
|
2009-03-06 06:56:38 +03:00
|
|
|
#
|
2004-11-25 18:23:19 +03:00
|
|
|
# <%# ignore numerous minor requests -- focus on priorities %>
|
|
|
|
# % priorities.each do |priority|
|
|
|
|
# * <%= priority %>
|
|
|
|
# % end
|
2009-03-06 06:56:38 +03:00
|
|
|
#
|
2004-11-25 18:23:19 +03:00
|
|
|
# Thanks for your patience.
|
2009-03-06 06:56:38 +03:00
|
|
|
#
|
2004-11-25 18:23:19 +03:00
|
|
|
# James Edward Gray II
|
|
|
|
# }.gsub(/^ /, '')
|
2009-03-06 06:56:38 +03:00
|
|
|
#
|
2018-02-22 16:28:25 +03:00
|
|
|
# message = ERB.new(template, trim_mode: "%<>")
|
2009-03-06 06:56:38 +03:00
|
|
|
#
|
2004-11-25 18:23:19 +03:00
|
|
|
# # Set up template data.
|
|
|
|
# to = "Community Spokesman <spokesman@ruby_community.org>"
|
|
|
|
# priorities = [ "Run Ruby Quiz",
|
|
|
|
# "Document Modules",
|
|
|
|
# "Answer Questions on Ruby Talk" ]
|
2009-03-06 06:56:38 +03:00
|
|
|
#
|
2004-11-25 18:23:19 +03:00
|
|
|
# # Produce result.
|
|
|
|
# email = message.result
|
|
|
|
# puts email
|
|
|
|
#
|
|
|
|
# <i>Generates:</i>
|
|
|
|
#
|
|
|
|
# From: James Edward Gray II <james@grayproductions.net>
|
|
|
|
# To: Community Spokesman <spokesman@ruby_community.org>
|
|
|
|
# Subject: Addressing Needs
|
2009-03-06 06:56:38 +03:00
|
|
|
#
|
2004-11-25 18:23:19 +03:00
|
|
|
# Community:
|
2009-03-06 06:56:38 +03:00
|
|
|
#
|
2004-11-25 18:23:19 +03:00
|
|
|
# Just wanted to send a quick note assuring that your needs are being addressed.
|
2009-03-06 06:56:38 +03:00
|
|
|
#
|
2004-11-25 18:23:19 +03:00
|
|
|
# I want you to know that my team will keep working on the issues, especially:
|
2009-03-06 06:56:38 +03:00
|
|
|
#
|
2004-11-25 18:23:19 +03:00
|
|
|
# * Run Ruby Quiz
|
|
|
|
# * Document Modules
|
|
|
|
# * Answer Questions on Ruby Talk
|
2009-03-06 06:56:38 +03:00
|
|
|
#
|
2004-11-25 18:23:19 +03:00
|
|
|
# Thanks for your patience.
|
2009-03-06 06:56:38 +03:00
|
|
|
#
|
2004-11-25 18:23:19 +03:00
|
|
|
# James Edward Gray II
|
|
|
|
#
|
|
|
|
# === Ruby in HTML
|
|
|
|
#
|
|
|
|
# ERB is often used in <tt>.rhtml</tt> files (HTML with embedded Ruby). Notice the need in
|
|
|
|
# this example to provide a special binding when the template is run, so that the instance
|
|
|
|
# variables in the Product object can be resolved.
|
|
|
|
#
|
|
|
|
# require "erb"
|
2009-03-06 06:56:38 +03:00
|
|
|
#
|
2004-11-25 18:23:19 +03:00
|
|
|
# # Build template data class.
|
|
|
|
# class Product
|
|
|
|
# def initialize( code, name, desc, cost )
|
|
|
|
# @code = code
|
|
|
|
# @name = name
|
|
|
|
# @desc = desc
|
|
|
|
# @cost = cost
|
2009-03-06 06:56:38 +03:00
|
|
|
#
|
2004-11-25 18:23:19 +03:00
|
|
|
# @features = [ ]
|
|
|
|
# end
|
2009-03-06 06:56:38 +03:00
|
|
|
#
|
2004-11-25 18:23:19 +03:00
|
|
|
# def add_feature( feature )
|
|
|
|
# @features << feature
|
|
|
|
# end
|
2009-03-06 06:56:38 +03:00
|
|
|
#
|
2004-11-25 18:23:19 +03:00
|
|
|
# # Support templating of member data.
|
|
|
|
# def get_binding
|
|
|
|
# binding
|
|
|
|
# end
|
2009-03-06 06:56:38 +03:00
|
|
|
#
|
2004-11-25 18:23:19 +03:00
|
|
|
# # ...
|
|
|
|
# end
|
2009-03-06 06:56:38 +03:00
|
|
|
#
|
2004-11-25 18:23:19 +03:00
|
|
|
# # Create template.
|
|
|
|
# template = %{
|
|
|
|
# <html>
|
|
|
|
# <head><title>Ruby Toys -- <%= @name %></title></head>
|
|
|
|
# <body>
|
2009-03-06 06:56:38 +03:00
|
|
|
#
|
2004-11-25 18:23:19 +03:00
|
|
|
# <h1><%= @name %> (<%= @code %>)</h1>
|
|
|
|
# <p><%= @desc %></p>
|
2009-03-06 06:56:38 +03:00
|
|
|
#
|
2004-11-25 18:23:19 +03:00
|
|
|
# <ul>
|
|
|
|
# <% @features.each do |f| %>
|
|
|
|
# <li><b><%= f %></b></li>
|
|
|
|
# <% end %>
|
|
|
|
# </ul>
|
2009-03-06 06:56:38 +03:00
|
|
|
#
|
2004-11-25 18:23:19 +03:00
|
|
|
# <p>
|
|
|
|
# <% if @cost < 10 %>
|
|
|
|
# <b>Only <%= @cost %>!!!</b>
|
|
|
|
# <% else %>
|
|
|
|
# Call for a price, today!
|
|
|
|
# <% end %>
|
|
|
|
# </p>
|
2009-03-06 06:56:38 +03:00
|
|
|
#
|
2004-11-25 18:23:19 +03:00
|
|
|
# </body>
|
|
|
|
# </html>
|
|
|
|
# }.gsub(/^ /, '')
|
2009-03-06 06:56:38 +03:00
|
|
|
#
|
2004-11-25 18:23:19 +03:00
|
|
|
# rhtml = ERB.new(template)
|
2009-03-06 06:56:38 +03:00
|
|
|
#
|
2004-11-25 18:23:19 +03:00
|
|
|
# # Set up template data.
|
|
|
|
# toy = Product.new( "TZ-1002",
|
|
|
|
# "Rubysapien",
|
|
|
|
# "Geek's Best Friend! Responds to Ruby commands...",
|
|
|
|
# 999.95 )
|
|
|
|
# toy.add_feature("Listens for verbal commands in the Ruby language!")
|
|
|
|
# toy.add_feature("Ignores Perl, Java, and all C variants.")
|
|
|
|
# toy.add_feature("Karate-Chop Action!!!")
|
|
|
|
# toy.add_feature("Matz signature on left leg.")
|
|
|
|
# toy.add_feature("Gem studded eyes... Rubies, of course!")
|
2009-03-06 06:56:38 +03:00
|
|
|
#
|
2004-11-25 18:23:19 +03:00
|
|
|
# # Produce result.
|
|
|
|
# rhtml.run(toy.get_binding)
|
|
|
|
#
|
|
|
|
# <i>Generates (some blank lines removed):</i>
|
|
|
|
#
|
|
|
|
# <html>
|
|
|
|
# <head><title>Ruby Toys -- Rubysapien</title></head>
|
|
|
|
# <body>
|
2009-03-06 06:56:38 +03:00
|
|
|
#
|
2004-11-25 18:23:19 +03:00
|
|
|
# <h1>Rubysapien (TZ-1002)</h1>
|
|
|
|
# <p>Geek's Best Friend! Responds to Ruby commands...</p>
|
2009-03-06 06:56:38 +03:00
|
|
|
#
|
2004-11-25 18:23:19 +03:00
|
|
|
# <ul>
|
|
|
|
# <li><b>Listens for verbal commands in the Ruby language!</b></li>
|
|
|
|
# <li><b>Ignores Perl, Java, and all C variants.</b></li>
|
|
|
|
# <li><b>Karate-Chop Action!!!</b></li>
|
|
|
|
# <li><b>Matz signature on left leg.</b></li>
|
|
|
|
# <li><b>Gem studded eyes... Rubies, of course!</b></li>
|
|
|
|
# </ul>
|
2009-03-06 06:56:38 +03:00
|
|
|
#
|
2004-11-25 18:23:19 +03:00
|
|
|
# <p>
|
|
|
|
# Call for a price, today!
|
|
|
|
# </p>
|
2009-03-06 06:56:38 +03:00
|
|
|
#
|
2004-11-25 18:23:19 +03:00
|
|
|
# </body>
|
|
|
|
# </html>
|
|
|
|
#
|
2009-03-06 06:56:38 +03:00
|
|
|
#
|
2004-11-25 18:23:19 +03:00
|
|
|
# == Notes
|
|
|
|
#
|
2019-10-26 09:34:14 +03:00
|
|
|
# There are a variety of templating solutions available in various Ruby projects.
|
|
|
|
# For example, RDoc, distributed with Ruby, uses its own template engine, which
|
|
|
|
# can be reused elsewhere.
|
2004-11-25 18:23:19 +03:00
|
|
|
#
|
2019-10-26 09:34:14 +03:00
|
|
|
# Other popular engines could be found in the corresponding
|
|
|
|
# {Category}[https://www.ruby-toolbox.com/categories/template_engines] of
|
|
|
|
# The Ruby Toolbox.
|
2004-11-25 18:23:19 +03:00
|
|
|
#
|
2002-11-17 19:11:40 +03:00
|
|
|
class ERB
|
2013-01-26 07:58:33 +04:00
|
|
|
Revision = '$Date:: $' # :nodoc: #'
|
2021-01-21 09:24:02 +03:00
|
|
|
deprecate_constant :Revision
|
2002-11-17 19:11:40 +03:00
|
|
|
|
2004-11-25 18:23:19 +03:00
|
|
|
# Returns revision information for the erb.rb module.
|
2002-11-17 19:11:40 +03:00
|
|
|
def self.version
|
2021-01-21 09:24:02 +03:00
|
|
|
VERSION
|
2002-11-17 19:11:40 +03:00
|
|
|
end
|
2009-03-06 06:56:38 +03:00
|
|
|
|
2004-11-25 18:23:19 +03:00
|
|
|
#
|
|
|
|
# Constructs a new ERB object with the template specified in _str_.
|
2009-03-06 06:56:38 +03:00
|
|
|
#
|
2004-11-25 18:23:19 +03:00
|
|
|
# An ERB object works by building a chunk of Ruby code that will output
|
2019-09-21 05:06:22 +03:00
|
|
|
# the completed template when run.
|
2009-03-06 06:56:38 +03:00
|
|
|
#
|
2004-11-25 18:23:19 +03:00
|
|
|
# If _trim_mode_ is passed a String containing one or more of the following
|
|
|
|
# modifiers, ERB will adjust its code generation as listed:
|
2009-03-06 06:56:38 +03:00
|
|
|
#
|
2011-05-19 04:07:25 +04:00
|
|
|
# % enables Ruby code processing for lines beginning with %
|
|
|
|
# <> omit newline for lines starting with <% and ending in %>
|
|
|
|
# > omit newline for lines ending in %>
|
2012-12-23 11:07:18 +04:00
|
|
|
# - omit blank lines ending in -%>
|
2009-03-06 06:56:38 +03:00
|
|
|
#
|
2004-11-25 18:23:19 +03:00
|
|
|
# _eoutvar_ can be used to set the name of the variable ERB will build up
|
|
|
|
# its output in. This is useful when you need to run multiple ERB
|
|
|
|
# templates through the same binding and/or when you want to control where
|
|
|
|
# output ends up. Pass the name of the variable to be used inside a String.
|
|
|
|
#
|
|
|
|
# === Example
|
|
|
|
#
|
|
|
|
# require "erb"
|
2009-03-06 06:56:38 +03:00
|
|
|
#
|
2004-11-25 18:23:19 +03:00
|
|
|
# # build data class
|
|
|
|
# class Listings
|
|
|
|
# PRODUCT = { :name => "Chicken Fried Steak",
|
|
|
|
# :desc => "A well messages pattie, breaded and fried.",
|
|
|
|
# :cost => 9.95 }
|
2009-03-06 06:56:38 +03:00
|
|
|
#
|
2004-11-25 18:23:19 +03:00
|
|
|
# attr_reader :product, :price
|
2009-03-06 06:56:38 +03:00
|
|
|
#
|
2004-11-25 18:23:19 +03:00
|
|
|
# def initialize( product = "", price = "" )
|
|
|
|
# @product = product
|
|
|
|
# @price = price
|
|
|
|
# end
|
2009-03-06 06:56:38 +03:00
|
|
|
#
|
2004-11-25 18:23:19 +03:00
|
|
|
# def build
|
|
|
|
# b = binding
|
2008-06-04 13:37:38 +04:00
|
|
|
# # create and run templates, filling member data variables
|
2018-02-22 16:28:25 +03:00
|
|
|
# ERB.new(<<-'END_PRODUCT'.gsub(/^\s+/, ""), trim_mode: "", eoutvar: "@product").result b
|
2004-11-25 18:23:19 +03:00
|
|
|
# <%= PRODUCT[:name] %>
|
|
|
|
# <%= PRODUCT[:desc] %>
|
|
|
|
# END_PRODUCT
|
2018-02-22 16:28:25 +03:00
|
|
|
# ERB.new(<<-'END_PRICE'.gsub(/^\s+/, ""), trim_mode: "", eoutvar: "@price").result b
|
2004-11-25 18:23:19 +03:00
|
|
|
# <%= PRODUCT[:name] %> -- <%= PRODUCT[:cost] %>
|
|
|
|
# <%= PRODUCT[:desc] %>
|
|
|
|
# END_PRICE
|
|
|
|
# end
|
|
|
|
# end
|
2009-03-06 06:56:38 +03:00
|
|
|
#
|
2004-11-25 18:23:19 +03:00
|
|
|
# # setup template data
|
|
|
|
# listings = Listings.new
|
|
|
|
# listings.build
|
2009-03-06 06:56:38 +03:00
|
|
|
#
|
2004-11-25 18:23:19 +03:00
|
|
|
# puts listings.product + "\n" + listings.price
|
|
|
|
#
|
|
|
|
# _Generates_
|
|
|
|
#
|
|
|
|
# Chicken Fried Steak
|
|
|
|
# A well messages pattie, breaded and fried.
|
2009-03-06 06:56:38 +03:00
|
|
|
#
|
2004-11-25 18:23:19 +03:00
|
|
|
# Chicken Fried Steak -- 9.95
|
|
|
|
# A well messages pattie, breaded and fried.
|
2009-03-06 06:56:38 +03:00
|
|
|
#
|
2022-01-17 23:37:46 +03:00
|
|
|
def initialize(str, safe_level=NOT_GIVEN, legacy_trim_mode=NOT_GIVEN, legacy_eoutvar=NOT_GIVEN, trim_mode: nil, eoutvar: '_erbout')
|
|
|
|
# Complex initializer for $SAFE deprecation at [Feature #14256]. Use keyword arguments to pass trim_mode or eoutvar.
|
|
|
|
if safe_level != NOT_GIVEN
|
|
|
|
warn 'Passing safe_level with the 2nd argument of ERB.new is deprecated. Do not use it, and specify other arguments as keyword arguments.', uplevel: 1
|
|
|
|
end
|
|
|
|
if legacy_trim_mode != NOT_GIVEN
|
|
|
|
warn 'Passing trim_mode with the 3rd argument of ERB.new is deprecated. Use keyword argument like ERB.new(str, trim_mode: ...) instead.', uplevel: 1
|
|
|
|
trim_mode = legacy_trim_mode
|
|
|
|
end
|
|
|
|
if legacy_eoutvar != NOT_GIVEN
|
|
|
|
warn 'Passing eoutvar with the 4th argument of ERB.new is deprecated. Use keyword argument like ERB.new(str, eoutvar: ...) instead.', uplevel: 1
|
|
|
|
eoutvar = legacy_eoutvar
|
|
|
|
end
|
|
|
|
|
2012-12-04 19:10:17 +04:00
|
|
|
compiler = make_compiler(trim_mode)
|
2002-11-17 19:11:40 +03:00
|
|
|
set_eoutvar(compiler, eoutvar)
|
2016-01-29 08:16:29 +03:00
|
|
|
@src, @encoding, @frozen_string = *compiler.compile(str)
|
2003-12-10 12:07:52 +03:00
|
|
|
@filename = nil
|
2014-12-12 13:31:47 +03:00
|
|
|
@lineno = 0
|
2019-03-28 06:46:48 +03:00
|
|
|
@_init = self.class.singleton_class
|
2002-11-17 19:11:40 +03:00
|
|
|
end
|
2018-02-22 16:28:25 +03:00
|
|
|
NOT_GIVEN = Object.new
|
|
|
|
private_constant :NOT_GIVEN
|
2004-11-25 18:23:19 +03:00
|
|
|
|
2013-01-26 07:58:33 +04:00
|
|
|
##
|
|
|
|
# Creates a new compiler for ERB. See ERB::Compiler.new for details
|
|
|
|
|
2012-12-04 19:10:17 +04:00
|
|
|
def make_compiler(trim_mode)
|
|
|
|
ERB::Compiler.new(trim_mode)
|
|
|
|
end
|
|
|
|
|
2004-11-25 18:23:19 +03:00
|
|
|
# The Ruby code generated by ERB
|
2003-12-10 12:07:52 +03:00
|
|
|
attr_reader :src
|
2004-11-25 18:23:19 +03:00
|
|
|
|
2014-12-12 13:48:57 +03:00
|
|
|
# The encoding to eval
|
|
|
|
attr_reader :encoding
|
|
|
|
|
2004-11-25 18:23:19 +03:00
|
|
|
# The optional _filename_ argument passed to Kernel#eval when the ERB code
|
|
|
|
# is run
|
2003-12-10 12:07:52 +03:00
|
|
|
attr_accessor :filename
|
2002-11-17 19:11:40 +03:00
|
|
|
|
2014-12-12 13:31:47 +03:00
|
|
|
# The optional _lineno_ argument passed to Kernel#eval when the ERB code
|
|
|
|
# is run
|
|
|
|
attr_accessor :lineno
|
|
|
|
|
2019-10-26 09:34:14 +03:00
|
|
|
#
|
|
|
|
# Sets optional filename and line number that will be used in ERB code
|
|
|
|
# evaluation and error reporting. See also #filename= and #lineno=
|
|
|
|
#
|
|
|
|
# erb = ERB.new('<%= some_x %>')
|
|
|
|
# erb.render
|
|
|
|
# # undefined local variable or method `some_x'
|
|
|
|
# # from (erb):1
|
|
|
|
#
|
|
|
|
# erb.location = ['file.erb', 3]
|
|
|
|
# # All subsequent error reporting would use new location
|
|
|
|
# erb.render
|
|
|
|
# # undefined local variable or method `some_x'
|
|
|
|
# # from file.erb:4
|
|
|
|
#
|
2014-12-12 13:31:47 +03:00
|
|
|
def location=((filename, lineno))
|
|
|
|
@filename = filename
|
|
|
|
@lineno = lineno if lineno
|
|
|
|
end
|
|
|
|
|
2004-11-25 18:23:19 +03:00
|
|
|
#
|
2012-12-23 11:13:07 +04:00
|
|
|
# Can be used to set _eoutvar_ as described in ERB::new. It's probably
|
|
|
|
# easier to just use the constructor though, since calling this method
|
|
|
|
# requires the setup of an ERB _compiler_ object.
|
2004-11-25 18:23:19 +03:00
|
|
|
#
|
2002-11-17 19:11:40 +03:00
|
|
|
def set_eoutvar(compiler, eoutvar = '_erbout')
|
2017-05-15 16:38:02 +03:00
|
|
|
compiler.put_cmd = "#{eoutvar}.<<"
|
|
|
|
compiler.insert_cmd = "#{eoutvar}.<<"
|
2017-05-27 06:06:55 +03:00
|
|
|
compiler.pre_cmd = ["#{eoutvar} = +''"]
|
erb.rb: Use script encoding instead of force_encoding
The original intention of introducing `_erbout.force_encoding`
in r21170 was:
- "returns a string in the same character encoding as the input string."
- "When the input string has a magic comment, however, it returns a string
in the encoding specified by the magic comment."
And they are tested by test/erb/test_erb_m17n.rb well and this patch
passes the test.
Since magic comment is always added in ERB compiled code, using ''.dup
instead of String.new will set correct encoding without calling
force_encoding method.
The benchmark results are:
* Before
$ ./ruby benchmark/run.rb --matzruby=./ruby -m bm_app_erb
MatzRuby:
ruby 2.5.0dev (2017-05-26 skip-force-enc.. 58903) [x86_64-linux]
last_commit=Skip force_encoding in compiled code of erb
Ruby:
app_erb:
matz 0.715
* After
$ ./ruby benchmark/run.rb --matzruby=./ruby -m bm_app_erb
MatzRuby:
ruby 2.5.0dev (2017-05-26 skip-force-enc.. 58903) [x86_64-linux]
last_commit=Skip force_encoding in compiled code of erb
Ruby:
app_erb:
matz 0.672
And perf(1) results are:
* Before
$ sudo perf stat ./ruby benchmark/bm_app_erb.rb
Performance counter stats for './ruby benchmark/bm_app_erb.rb':
709.571746 task-clock (msec) # 1.000 CPUs utilized
5 context-switches # 0.007 K/sec
1 cpu-migrations # 0.001 K/sec
1,337 page-faults # 0.002 M/sec
3,088,936,521 cycles # 4.353 GHz
<not supported> stalled-cycles-frontend
<not supported> stalled-cycles-backend
4,849,564,282 instructions # 1.57 insns per cycle
1,027,042,087 branches # 1447.411 M/sec
19,983,456 branch-misses # 1.95% of all branches
0.709747823 seconds time elapsed
* After
$ sudo perf stat ./ruby benchmark/bm_app_erb.rb
Performance counter stats for './ruby benchmark/bm_app_erb.rb':
693.494673 task-clock (msec) # 1.000 CPUs utilized
7 context-switches # 0.010 K/sec
1 cpu-migrations # 0.001 K/sec
1,316 page-faults # 0.002 M/sec
3,025,639,349 cycles # 4.363 GHz
<not supported> stalled-cycles-frontend
<not supported> stalled-cycles-backend
4,694,848,271 instructions # 1.55 insns per cycle
994,496,704 branches # 1434.037 M/sec
19,693,239 branch-misses # 1.98% of all branches
0.693724345 seconds time elapsed
[fix GH-1147]
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@58904 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
2017-05-26 15:12:13 +03:00
|
|
|
compiler.post_cmd = [eoutvar]
|
2002-11-17 19:11:40 +03:00
|
|
|
end
|
|
|
|
|
2004-11-25 18:23:19 +03:00
|
|
|
# Generate results and print them. (see ERB#result)
|
2012-11-09 18:33:11 +04:00
|
|
|
def run(b=new_toplevel)
|
2002-11-17 19:11:40 +03:00
|
|
|
print self.result(b)
|
|
|
|
end
|
|
|
|
|
2004-11-25 18:23:19 +03:00
|
|
|
#
|
|
|
|
# Executes the generated ERB code to produce a completed template, returning
|
2012-12-23 11:13:07 +04:00
|
|
|
# the results of that code. (See ERB::new for details on how this process
|
|
|
|
# can be affected by _safe_level_.)
|
2009-03-06 06:56:38 +03:00
|
|
|
#
|
2014-05-30 05:22:23 +04:00
|
|
|
# _b_ accepts a Binding object which is used to set the context of
|
2004-11-25 18:23:19 +03:00
|
|
|
# code evaluation.
|
|
|
|
#
|
2012-11-09 18:33:11 +04:00
|
|
|
def result(b=new_toplevel)
|
2019-03-28 06:46:48 +03:00
|
|
|
unless @_init.equal?(self.class.singleton_class)
|
|
|
|
raise ArgumentError, "not initialized"
|
|
|
|
end
|
2019-09-21 05:06:22 +03:00
|
|
|
eval(@src, b, (@filename || '(erb)'), @lineno)
|
2002-11-17 19:11:40 +03:00
|
|
|
end
|
|
|
|
|
2017-05-25 18:38:25 +03:00
|
|
|
# Render a template on a new toplevel binding with local variables specified
|
|
|
|
# by a Hash object.
|
|
|
|
def result_with_hash(hash)
|
2017-12-22 11:08:31 +03:00
|
|
|
b = new_toplevel(hash.keys)
|
2017-05-25 18:38:25 +03:00
|
|
|
hash.each_pair do |key, value|
|
|
|
|
b.local_variable_set(key, value)
|
|
|
|
end
|
|
|
|
result(b)
|
|
|
|
end
|
|
|
|
|
2013-01-26 07:58:33 +04:00
|
|
|
##
|
|
|
|
# Returns a new binding each time *near* TOPLEVEL_BINDING for runs that do
|
|
|
|
# not specify a binding.
|
|
|
|
|
2017-12-22 11:08:31 +03:00
|
|
|
def new_toplevel(vars = nil)
|
|
|
|
b = TOPLEVEL_BINDING
|
|
|
|
if vars
|
|
|
|
vars = vars.select {|v| b.local_variable_defined?(v)}
|
|
|
|
unless vars.empty?
|
|
|
|
return b.eval("tap {|;#{vars.join(',')}| break binding}")
|
|
|
|
end
|
|
|
|
end
|
|
|
|
b.dup
|
2012-11-09 18:33:11 +04:00
|
|
|
end
|
|
|
|
private :new_toplevel
|
|
|
|
|
2013-07-18 17:50:32 +04:00
|
|
|
# Define _methodname_ as instance method of _mod_ from compiled Ruby source.
|
2009-01-03 18:36:14 +03:00
|
|
|
#
|
|
|
|
# example:
|
|
|
|
# filename = 'example.rhtml' # 'arg1' and 'arg2' are used in example.rhtml
|
|
|
|
# erb = ERB.new(File.read(filename))
|
|
|
|
# erb.def_method(MyClass, 'render(arg1, arg2)', filename)
|
|
|
|
# print MyClass.new.render('foo', 123)
|
|
|
|
def def_method(mod, methodname, fname='(ERB)')
|
2016-01-29 08:14:31 +03:00
|
|
|
src = self.src.sub(/^(?!#|$)/) {"def #{methodname}\n"} << "\nend\n"
|
2008-12-29 12:26:34 +03:00
|
|
|
mod.module_eval do
|
2016-01-29 08:14:31 +03:00
|
|
|
eval(src, binding, fname, -1)
|
2008-12-29 12:26:34 +03:00
|
|
|
end
|
2002-11-17 19:11:40 +03:00
|
|
|
end
|
|
|
|
|
2009-01-03 18:36:14 +03:00
|
|
|
# Create unnamed module, define _methodname_ as instance method of it, and return it.
|
|
|
|
#
|
|
|
|
# example:
|
|
|
|
# filename = 'example.rhtml' # 'arg1' and 'arg2' are used in example.rhtml
|
|
|
|
# erb = ERB.new(File.read(filename))
|
|
|
|
# erb.filename = filename
|
|
|
|
# MyModule = erb.def_module('render(arg1, arg2)')
|
|
|
|
# class MyClass
|
|
|
|
# include MyModule
|
|
|
|
# end
|
|
|
|
def def_module(methodname='erb')
|
2002-11-17 19:11:40 +03:00
|
|
|
mod = Module.new
|
2009-01-03 18:36:14 +03:00
|
|
|
def_method(mod, methodname, @filename || '(ERB)')
|
2002-11-17 19:11:40 +03:00
|
|
|
mod
|
|
|
|
end
|
|
|
|
|
2009-01-03 18:36:14 +03:00
|
|
|
# Define unnamed class which has _methodname_ as instance method, and return it.
|
|
|
|
#
|
|
|
|
# example:
|
|
|
|
# class MyClass_
|
|
|
|
# def initialize(arg1, arg2)
|
|
|
|
# @arg1 = arg1; @arg2 = arg2
|
|
|
|
# end
|
|
|
|
# end
|
|
|
|
# filename = 'example.rhtml' # @arg1 and @arg2 are used in example.rhtml
|
|
|
|
# erb = ERB.new(File.read(filename))
|
|
|
|
# erb.filename = filename
|
|
|
|
# MyClass = erb.def_class(MyClass_, 'render()')
|
|
|
|
# print MyClass.new('foo', 123).render()
|
|
|
|
def def_class(superklass=Object, methodname='result')
|
2002-11-21 17:39:26 +03:00
|
|
|
cls = Class.new(superklass)
|
2009-01-03 18:36:14 +03:00
|
|
|
def_method(cls, methodname, @filename || '(ERB)')
|
2002-11-17 19:11:40 +03:00
|
|
|
cls
|
|
|
|
end
|
|
|
|
end
|