module Haml::Filters::Base
def self.included(base)
-
base
(Module, Class
) -- The module that this is included in
def self.included(base) Filters.defined[base.name.split("::").last.downcase] = base base.extend(base) end
def compile(compiler, text)
-
(Haml::Error)
- if none of \{#compile}, \{#render}, and
Parameters:
-
text
(String
) -- The text of the filter -
compiler
(Haml::Compiler
) -- The compiler instance
def compile(compiler, text) filter = self compiler.instance_eval do if contains_interpolation?(text) return if options[:suppress_eval] escape = options[:escape_filter_interpolations] # `escape_filter_interpolations` defaults to `escape_html` if unset. escape = options[:escape_html] if escape.nil? text = unescape_interpolation(text, escape).gsub(/(\\+)n/) do |s| escapes = $1.size next s if escapes % 2 == 0 "#{'\\' * (escapes - 1)}\n" end # We need to add a newline at the beginning to get the # filter lines to line up (since the Haml filter contains # a line that doesn't show up in the source, namely the # filter name). Then we need to escape the trailing # newline so that the whole filter block doesn't take up # too many. text = %[\n#{text.sub(/\n"\Z/, "\\n\"")}] push_script <<RUBY.rstrip, :escape_html => false nd_preserve(#{filter.inspect}.render_with_options(#{text}, _hamlout.options)) return end rendered = Haml::Helpers::find_and_preserve(filter.render_with_options(text.to_s, compiler.options), compiler.options[:preserve]) push_text("#{rendered.rstrip}\n") end end
def internal_compile(*args)
- See: #compile -
def internal_compile(*args) compile(*args) end
def render(_text)
-
(Haml::Error)
- if it's not overridden
Returns:
-
(String)
- The filtered result
Parameters:
-
text
(String
) -- The source text for the filter to process
def render(_text) raise Error.new("#{self.inspect}#render not defined!") end
def render_with_options(text, _options)
-
(Haml::Error)
- if it or \{#render} isn't overridden
Returns:
-
(String)
- The filtered result
Parameters:
-
text
(String
) -- The source text for the filter to process
Other tags:
- See: #render -
def render_with_options(text, _options) render(text) end