Module: ERB::Util

Included in:
ActionView::Base
Defined in:
activesupport/lib/active_support/core_ext/string/output_safety.rb

Constant Summary collapse

HTML_ESCAPE = 
{ '&' => '&amp;',  '>' => '&gt;',   '<' => '&lt;', '"' => '&quot;' }
JSON_ESCAPE = 
{ '&' => '\u0026', '>' => '\u003E', '<' => '\u003C' }

Class Method Summary collapse

Class Method Details

.h ⇒ Object

A utility method for escaping HTML tag characters. This method is also aliased as h.

In your ERB templates, use this method to escape any unsafe content. For example:

<%=h @person.name %>

Example:

puts html_escape("is a > 0 & a < 10?")
# => is a &gt; 0 &amp; a &lt; 10?



29
30
31
32
33
34
35
36
 
# File 'activesupport/lib/active_support/core_ext/string/output_safety.rb', line 29

def html_escape(s)
  s = s.to_s
  if s.html_safe?
    s
  else
    s.gsub(/&/, "&amp;").gsub(/\"/, "&quot;").gsub(/>/, "&gt;").gsub(/</, "&lt;").html_safe
  end
end

.html_escape(s) ⇒ Object

A utility method for escaping HTML tag characters. This method is also aliased as h.

In your ERB templates, use this method to escape any unsafe content. For example:

<%=h @person.name %>

Example:

puts html_escape("is a > 0 & a < 10?")
# => is a &gt; 0 &amp; a &lt; 10?



18
19
20
21
22
23
24
25
 
# File 'activesupport/lib/active_support/core_ext/string/output_safety.rb', line 18

def html_escape(s)
  s = s.to_s
  if s.html_safe?
    s
  else
    s.gsub(/&/, "&amp;").gsub(/\"/, "&quot;").gsub(/>/, "&gt;").gsub(/</, "&lt;").html_safe
  end
end

.j ⇒ Object

A utility method for escaping HTML entities in JSON strings using uXXXX JavaScript escape sequences for string literals:

json_escape("is a > 0 & a < 10?")
# => is a \u003E 0 \u0026 a \u003C 10?

Note that after this operation is performed the output is not valid JSON. In particular double quotes are removed:

json_escape('{"name":"john","created_at":"2010-04-28T01:39:31Z","id":1}')
# => {name:john,created_at:2010-04-28T01:39:31Z,id:1}

This method is also aliased as j, and available as a helper in Rails templates:

<%=j @person.to_json %>



58
59
60
61
 
# File 'activesupport/lib/active_support/core_ext/string/output_safety.rb', line 58

def json_escape(s)
  result = s.to_s.gsub(/[&"><]/) { |special| JSON_ESCAPE[special] }
  s.html_safe? ? result.html_safe : result
end

.json_escape(s) ⇒ Object

A utility method for escaping HTML entities in JSON strings using uXXXX JavaScript escape sequences for string literals:

json_escape("is a > 0 & a < 10?")
# => is a \u003E 0 \u0026 a \u003C 10?

Note that after this operation is performed the output is not valid JSON. In particular double quotes are removed:

json_escape('{"name":"john","created_at":"2010-04-28T01:39:31Z","id":1}')
# => {name:john,created_at:2010-04-28T01:39:31Z,id:1}

This method is also aliased as j, and available as a helper in Rails templates:

<%=j @person.to_json %>



53
54
55
56
 
# File 'activesupport/lib/active_support/core_ext/string/output_safety.rb', line 53

def json_escape(s)
  result = s.to_s.gsub(/[&"><]/) { |special| JSON_ESCAPE[special] }
  s.html_safe? ? result.html_safe : result
end