module Haml::Helpers::XssMods
This module overrides Haml helpers to work properly in the context of ActionView. Currently it's only used for modifying the helpers to work with Rails' XSS protection methods.
Public Class Methods
# File lib/haml/helpers/xss_mods.rb, line 8 def self.included(base) %w[html_escape find_and_preserve preserve list_of surround precede succeed capture_haml haml_concat haml_internal_concat haml_indent escape_once].each do |name| base.send(:alias_method, "#{name}_without_haml_xss", name) base.send(:alias_method, name, "#{name}_with_haml_xss") end end
Public Instance Methods
Output is always HTML safe
# File lib/haml/helpers/xss_mods.rb, line 60 def capture_haml_with_haml_xss(*args, &block) Haml::Util.html_safe(capture_haml_without_haml_xss(*args, &block)) end
Output is always HTML safe
# File lib/haml/helpers/xss_mods.rb, line 88 def escape_once_with_haml_xss(*args) Haml::Util.html_safe(escape_once_without_haml_xss(*args)) end
Output is always HTML safe
# File lib/haml/helpers/xss_mods.rb, line 26 def find_and_preserve_with_haml_xss(*args, &block) Haml::Util.html_safe(find_and_preserve_without_haml_xss(*args, &block)) end
Input will be escaped unless this is in a `with_raw_haml_concat` block. See #Haml::Helpers::ActionViewExtensions#with_raw_haml_concat.
# File lib/haml/helpers/xss_mods.rb, line 66 def haml_concat_with_haml_xss(text = "") raw = instance_variable_defined?(:@_haml_concat_raw) ? @_haml_concat_raw : false if raw haml_internal_concat_raw text else haml_internal_concat text end ErrorReturn.new("haml_concat") end
Output is always HTML safe
# File lib/haml/helpers/xss_mods.rb, line 83 def haml_indent_with_haml_xss Haml::Util.html_safe(haml_indent_without_haml_xss) end
Don't escape text that's already safe, output is always HTML safe
# File lib/haml/helpers/xss_mods.rb, line 19 def html_escape_with_haml_xss(text) str = text.to_s return text if str.html_safe? Haml::Util.html_safe(html_escape_without_haml_xss(str)) end
Output is always HTML safe
# File lib/haml/helpers/xss_mods.rb, line 36 def list_of_with_haml_xss(*args, &block) Haml::Util.html_safe(list_of_without_haml_xss(*args, &block)) end
Input is escaped, output is always HTML safe
# File lib/haml/helpers/xss_mods.rb, line 50 def precede_with_haml_xss(str, &block) Haml::Util.html_safe(precede_without_haml_xss(haml_xss_html_escape(str), &block)) end
Output is always HTML safe
# File lib/haml/helpers/xss_mods.rb, line 31 def preserve_with_haml_xss(*args, &block) Haml::Util.html_safe(preserve_without_haml_xss(*args, &block)) end
Input is escaped, output is always HTML safe
# File lib/haml/helpers/xss_mods.rb, line 55 def succeed_with_haml_xss(str, &block) Haml::Util.html_safe(succeed_without_haml_xss(haml_xss_html_escape(str), &block)) end
Input is escaped, output is always HTML safe
# File lib/haml/helpers/xss_mods.rb, line 41 def surround_with_haml_xss(front, back = front, &block) Haml::Util.html_safe( surround_without_haml_xss( haml_xss_html_escape(front), haml_xss_html_escape(back), &block)) end
Private Instance Methods
Input is escaped
# File lib/haml/helpers/xss_mods.rb, line 77 def haml_internal_concat_with_haml_xss(text="", newline=true, indent=true) haml_internal_concat_without_haml_xss(haml_xss_html_escape(text), newline, indent) end
Escapes the HTML in the text if and only if Rails XSS protection is enabled and the `:escape_html` option is set.
# File lib/haml/helpers/xss_mods.rb, line 96 def haml_xss_html_escape(text) return text unless Haml::Util.rails_xss_safe? && haml_buffer.options[:escape_html] html_escape(text) end