2009-02-04 21:26:08 +01:00
|
|
|
require 'action_view/erb/util'
|
2008-09-07 07:54:05 +02:00
|
|
|
require 'set'
|
2007-01-22 14:43:50 +01:00
|
|
|
|
|
|
|
module ActionView
|
2007-02-09 09:04:31 +01:00
|
|
|
module Helpers #:nodoc:
|
2007-12-21 08:48:59 +01:00
|
|
|
# Provides methods to generate HTML tags programmatically when you can't use
|
2007-02-09 09:04:31 +01:00
|
|
|
# a Builder. By default, they output XHTML compliant tags.
|
2007-01-22 14:43:50 +01:00
|
|
|
module TagHelper
|
|
|
|
include ERB::Util
|
|
|
|
|
2008-11-24 22:53:39 +01:00
|
|
|
BOOLEAN_ATTRIBUTES = %w(disabled readonly multiple checked).to_set
|
2008-09-07 07:54:05 +02:00
|
|
|
BOOLEAN_ATTRIBUTES.merge(BOOLEAN_ATTRIBUTES.map(&:to_sym))
|
2007-12-21 08:48:59 +01:00
|
|
|
|
2008-10-27 07:47:01 +01:00
|
|
|
# Returns an empty HTML tag of type +name+ which by default is XHTML
|
|
|
|
# compliant. Set +open+ to true to create an open tag compatible
|
|
|
|
# with HTML 4.0 and below. Add HTML attributes by passing an attributes
|
2007-12-21 08:48:59 +01:00
|
|
|
# hash to +options+. Set +escape+ to false to disable attribute value
|
|
|
|
# escaping.
|
|
|
|
#
|
|
|
|
# ==== Options
|
2008-10-27 07:47:01 +01:00
|
|
|
# The +options+ hash is used with attributes with no value like (<tt>disabled</tt> and
|
2007-12-21 08:48:59 +01:00
|
|
|
# <tt>readonly</tt>), which you can give a value of true in the +options+ hash. You can use
|
2007-02-09 09:04:31 +01:00
|
|
|
# symbols or strings for the attribute names.
|
|
|
|
#
|
2007-12-21 08:48:59 +01:00
|
|
|
# ==== Examples
|
2007-02-09 09:04:31 +01:00
|
|
|
# tag("br")
|
2007-12-21 08:48:59 +01:00
|
|
|
# # => <br />
|
|
|
|
#
|
2007-02-09 09:04:31 +01:00
|
|
|
# tag("br", nil, true)
|
2007-12-21 08:48:59 +01:00
|
|
|
# # => <br>
|
|
|
|
#
|
2008-10-27 07:47:01 +01:00
|
|
|
# tag("input", { :type => 'text', :disabled => true })
|
2007-12-21 08:48:59 +01:00
|
|
|
# # => <input type="text" disabled="disabled" />
|
|
|
|
#
|
|
|
|
# tag("img", { :src => "open & shut.png" })
|
|
|
|
# # => <img src="open & shut.png" />
|
|
|
|
#
|
|
|
|
# tag("img", { :src => "open & shut.png" }, false, false)
|
|
|
|
# # => <img src="open & shut.png" />
|
|
|
|
def tag(name, options = nil, open = false, escape = true)
|
2008-09-07 07:54:05 +02:00
|
|
|
"<#{name}#{tag_options(options, escape) if options}#{open ? ">" : " />"}"
|
2007-01-22 14:43:50 +01:00
|
|
|
end
|
|
|
|
|
2007-02-09 09:04:31 +01:00
|
|
|
# Returns an HTML block tag of type +name+ surrounding the +content+. Add
|
2008-10-27 07:47:01 +01:00
|
|
|
# HTML attributes by passing an attributes hash to +options+.
|
2007-12-21 08:48:59 +01:00
|
|
|
# Instead of passing the content as an argument, you can also use a block
|
|
|
|
# in which case, you pass your +options+ as the second parameter.
|
|
|
|
# Set escape to false to disable attribute value escaping.
|
2007-02-09 09:04:31 +01:00
|
|
|
#
|
2007-12-21 08:48:59 +01:00
|
|
|
# ==== Options
|
2008-10-27 07:47:01 +01:00
|
|
|
# The +options+ hash is used with attributes with no value like (<tt>disabled</tt> and
|
2007-12-21 08:48:59 +01:00
|
|
|
# <tt>readonly</tt>), which you can give a value of true in the +options+ hash. You can use
|
|
|
|
# symbols or strings for the attribute names.
|
|
|
|
#
|
|
|
|
# ==== Examples
|
2007-02-09 09:04:31 +01:00
|
|
|
# content_tag(:p, "Hello world!")
|
|
|
|
# # => <p>Hello world!</p>
|
|
|
|
# content_tag(:div, content_tag(:p, "Hello world!"), :class => "strong")
|
|
|
|
# # => <div class="strong"><p>Hello world!</p></div>
|
|
|
|
# content_tag("select", options, :multiple => true)
|
|
|
|
# # => <select multiple="multiple">...options...</select>
|
|
|
|
#
|
|
|
|
# <% content_tag :div, :class => "strong" do -%>
|
|
|
|
# Hello world!
|
|
|
|
# <% end -%>
|
2008-10-27 07:47:01 +01:00
|
|
|
# # => <div class="strong">Hello world!</div>
|
2007-12-21 08:48:59 +01:00
|
|
|
def content_tag(name, content_or_options_with_block = nil, options = nil, escape = true, &block)
|
2007-02-09 09:04:31 +01:00
|
|
|
if block_given?
|
|
|
|
options = content_or_options_with_block if content_or_options_with_block.is_a?(Hash)
|
2008-10-27 07:47:01 +01:00
|
|
|
content_tag = content_tag_string(name, capture(&block), options, escape)
|
|
|
|
|
|
|
|
if block_called_from_erb?(block)
|
|
|
|
concat(content_tag)
|
|
|
|
else
|
|
|
|
content_tag
|
|
|
|
end
|
2007-02-09 09:04:31 +01:00
|
|
|
else
|
2008-10-27 07:47:01 +01:00
|
|
|
content_tag_string(name, content_or_options_with_block, options, escape)
|
2007-02-09 09:04:31 +01:00
|
|
|
end
|
2007-01-22 14:43:50 +01:00
|
|
|
end
|
|
|
|
|
2007-02-09 09:04:31 +01:00
|
|
|
# Returns a CDATA section with the given +content+. CDATA sections
|
2007-01-22 14:43:50 +01:00
|
|
|
# are used to escape blocks of text containing characters which would
|
|
|
|
# otherwise be recognized as markup. CDATA sections begin with the string
|
2007-02-09 09:04:31 +01:00
|
|
|
# <tt><![CDATA[</tt> and end with (and may not contain) the string <tt>]]></tt>.
|
|
|
|
#
|
2007-12-21 08:48:59 +01:00
|
|
|
# ==== Examples
|
2007-02-09 09:04:31 +01:00
|
|
|
# cdata_section("<hello world>")
|
2007-12-21 08:48:59 +01:00
|
|
|
# # => <![CDATA[<hello world>]]>
|
|
|
|
#
|
|
|
|
# cdata_section(File.read("hello_world.txt"))
|
|
|
|
# # => <![CDATA[<hello from a text file]]>
|
2007-01-22 14:43:50 +01:00
|
|
|
def cdata_section(content)
|
|
|
|
"<![CDATA[#{content}]]>"
|
|
|
|
end
|
|
|
|
|
2007-12-21 08:48:59 +01:00
|
|
|
# Returns an escaped version of +html+ without affecting existing escaped entities.
|
2007-02-09 09:04:31 +01:00
|
|
|
#
|
2007-12-21 08:48:59 +01:00
|
|
|
# ==== Examples
|
2009-02-04 21:26:08 +01:00
|
|
|
# escape_once("1 < 2 & 3")
|
2007-12-21 08:48:59 +01:00
|
|
|
# # => "1 < 2 & 3"
|
|
|
|
#
|
|
|
|
# escape_once("<< Accept & Checkout")
|
|
|
|
# # => "<< Accept & Checkout"
|
2007-02-09 09:04:31 +01:00
|
|
|
def escape_once(html)
|
2007-12-21 08:48:59 +01:00
|
|
|
html.to_s.gsub(/[\"><]|&(?!([a-zA-Z]+|(#\d+));)/) { |special| ERB::Util::HTML_ESCAPE[special] }
|
2007-02-09 09:04:31 +01:00
|
|
|
end
|
|
|
|
|
2007-01-22 14:43:50 +01:00
|
|
|
private
|
2008-10-27 07:47:01 +01:00
|
|
|
BLOCK_CALLED_FROM_ERB = 'defined? __in_erb_template'
|
|
|
|
|
|
|
|
if RUBY_VERSION < '1.9.0'
|
|
|
|
# Check whether we're called from an erb template.
|
|
|
|
# We'd return a string in any other case, but erb <%= ... %>
|
|
|
|
# can't take an <% end %> later on, so we have to use <% ... %>
|
|
|
|
# and implicitly concat.
|
|
|
|
def block_called_from_erb?(block)
|
|
|
|
block && eval(BLOCK_CALLED_FROM_ERB, block)
|
|
|
|
end
|
|
|
|
else
|
|
|
|
def block_called_from_erb?(block)
|
|
|
|
block && eval(BLOCK_CALLED_FROM_ERB, block.binding)
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2007-12-21 08:48:59 +01:00
|
|
|
def content_tag_string(name, content, options, escape = true)
|
|
|
|
tag_options = tag_options(options, escape) if options
|
2007-02-09 09:04:31 +01:00
|
|
|
"<#{name}#{tag_options}>#{content}</#{name}>"
|
|
|
|
end
|
2007-01-22 14:43:50 +01:00
|
|
|
|
2007-12-21 08:48:59 +01:00
|
|
|
def tag_options(options, escape = true)
|
|
|
|
unless options.blank?
|
|
|
|
attrs = []
|
|
|
|
if escape
|
2008-11-24 22:53:39 +01:00
|
|
|
options.each_pair do |key, value|
|
|
|
|
if BOOLEAN_ATTRIBUTES.include?(key)
|
|
|
|
attrs << %(#{key}="#{key}") if value
|
|
|
|
else
|
|
|
|
attrs << %(#{key}="#{escape_once(value)}") if !value.nil?
|
|
|
|
end
|
2007-12-21 08:48:59 +01:00
|
|
|
end
|
|
|
|
else
|
|
|
|
attrs = options.map { |key, value| %(#{key}="#{value}") }
|
|
|
|
end
|
|
|
|
" #{attrs.sort * ' '}" unless attrs.empty?
|
|
|
|
end
|
2007-01-22 14:43:50 +01:00
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|