This module contains various helpful methods to make it easier to do various tasks. {Haml::Helpers} is automatically included in the context that a Haml template is parsed in, so all these methods are at your disposal from within the template.
Characters that need to be escaped to HTML entities from user input
@return [Boolean] Whether or not ActionView is loaded
# File lib/haml/helpers.rb, line 53
53: def self.action_view?
54: @@action_view_defined
55: end
Returns whether or not `block` is defined directly in a Haml template.
@param block [Proc] A Ruby block @return [Boolean] Whether or not `block` is defined directly in a Haml template
# File lib/haml/helpers.rb, line 538
538: def block_is_haml?(block)
539: eval('_hamlout', block.binding)
540: true
541: rescue
542: false
543: end
Captures the result of a block of Haml code, gets rid of the excess indentation, and returns it as a string. For example, after the following,
.foo
* foo = capture_haml(13) do |a|
%p= a
the local variable `foo` would be assigned to `”
13
n“`.@param args [Array] Arguments to pass into the block @yield [args] A block of Haml code that will be converted to a string @yieldparam args [Array] `args`
# File lib/haml/helpers.rb, line 337
337: def capture_haml(*args, &block)
338: buffer = eval('_hamlout', block.binding) rescue haml_buffer
339: with_haml_buffer(buffer) do
340: position = haml_buffer.buffer.length
341:
342: haml_buffer.capture_position = position
343: block.call(*args)
344:
345: captured = haml_buffer.buffer.slice!(position..1)
346: return captured if haml_buffer.options[:ugly]
347: captured = captured.split(/^/)
348:
349: min_tabs = nil
350: captured.each do |line|
351: tabs = line.index(/[^ ]/) || line.length
352: min_tabs ||= tabs
353: min_tabs = min_tabs > tabs ? tabs : min_tabs
354: end
355:
356: captured.map do |line|
357: line[min_tabs..1]
358: end.join
359: end
360: ensure
361: haml_buffer.capture_position = nil
362: end
Escapes HTML entities in `text`, but without escaping an ampersand that is already part of an escaped entity.
@param text [String] The string to sanitize @return [String] The sanitized string
# File lib/haml/helpers.rb, line 517
517: def escape_once(text)
518: Haml::Util.silence_warnings do
519: text.to_s.gsub(/[\"><]|&(?!(?:[a-zA-Z]+|(#\d+));)/) {|s| HTML_ESCAPE[s]}
520: end
521: end
Uses {#preserve} to convert any newlines inside whitespace-sensitive tags into the HTML entities for endlines.
@param tags [Array
@overload find_and_preserve(input, tags = haml_buffer.options[:preserve])
Escapes newlines within a string. @param input [String] The string within which to escape newlines
@overload find_and_preserve(tags = haml_buffer.options[:preserve])
Escapes newlines within a block of Haml code. @yield The block within which to escape newlines
# File lib/haml/helpers.rb, line 108
108: def find_and_preserve(input = nil, tags = haml_buffer.options[:preserve], &block)
109: return find_and_preserve(capture_haml(&block), input || tags) if block
110: input.to_s.gsub(/<(#{tags.map(&Regexp.method(:escape)).join('|')})([^>]*)>(.*?)(<\/\11>>)/m) do
111: "<#{$1}#{$2}>#{preserve($3)}</#{$1}>"
112: end
113: end
Outputs text directly to the Haml buffer, with the proper indentation.
@param text [#] The text to output
# File lib/haml/helpers.rb, line 367
367: def haml_concat(text = "")
368: unless haml_buffer.options[:ugly] || haml_indent == 0
369: haml_buffer.buffer << haml_indent <<
370: text.to_s.gsub("\n", "\n" + haml_indent) << "\n"
371: else
372: haml_buffer.buffer << text.to_s << "\n"
373: end
374: ErrorReturn.new("haml_concat")
375: end
@return [String] The indentation string for the current line
# File lib/haml/helpers.rb, line 378
378: def haml_indent
379: ' ' * haml_buffer.tabulation
380: end
Creates an HTML tag with the given name and optionally text and attributes. Can take a block that will run between the opening and closing tags. If the block is a Haml block or outputs text using {#haml_concat}, the text will be properly indented.
`name` can be a string using the standard Haml class/id shorthand (e.g. “span#.bar”, “#“). Just like standard Haml tags, these class and id values will be merged with manually-specified attributes.
`flags` is a list of symbol flags like those that can be put at the end of a Haml tag (`:/`, `:<`, and `:>`). Currently, only `:/` and `:<` are supported.
`haml_tag` outputs directly to the buffer; its return value should not be used. If you need to get the results as a string, use {#capture_haml}.
For example,
haml_tag :table do
haml_tag :tr do
haml_tag 'td.cell' do
haml_tag :strong, "strong!"
haml_concat "data"
end
haml_tag :td do
haml_concat "more_data"
end
end
end
outputs
<table>
<tr>
<td class='cell'>
<strong>
strong!
</strong>
data
</td>
<td>
more_data
</td>
</tr>
</table>
@param name [#] The name of the tag @param flags [Array
@overload haml_tag(name, *flags, attributes = {})
@yield The block of Haml code within the tag
@overload haml_tag(name, text, *flags, attributes = {})
@param text [#to_s] The text within the tag
# File lib/haml/helpers.rb, line 439
439: def haml_tag(name, *rest, &block)
440: ret = ErrorReturn.new("haml_tag")
441:
442: text = rest.shift.to_s unless [Symbol, Hash, NilClass].any? {|t| rest.first.is_a? t}
443: flags = []
444: flags << rest.shift while rest.first.is_a? Symbol
445: name, attrs = merge_name_and_attributes(name.to_s, rest.shift || {})
446:
447: attributes = Haml::Precompiler.build_attributes(haml_buffer.html?,
448: haml_buffer.options[:attr_wrapper],
449: attrs)
450:
451: if text.nil? && block.nil? && (haml_buffer.options[:autoclose].include?(name) || flags.include?(:/))
452: haml_concat "<#{name}#{attributes} />"
453: return ret
454: end
455:
456: if flags.include?(:/)
457: raise Error.new("Self-closing tags can't have content.") if text
458: raise Error.new("Illegal nesting: nesting within a self-closing tag is illegal.") if block
459: end
460:
461: tag = "<#{name}#{attributes}>"
462: if block.nil?
463: text = text.to_s
464: if text.include?("\n")
465: haml_concat tag
466: tab_up
467: haml_concat text
468: tab_down
469: haml_concat "</#{name}>"
470: else
471: tag << text << "</#{name}>"
472: haml_concat tag
473: end
474: return ret
475: end
476:
477: if text
478: raise Error.new("Illegal nesting: content can't be both given to haml_tag :#{name} and nested within it.")
479: end
480:
481: if flags.include?(:<)
482: tag << capture_haml(&block).strip << "</#{name}>"
483: haml_concat tag
484: return ret
485: end
486:
487: haml_concat tag
488: tab_up
489: block.call
490: tab_down
491: haml_concat "</#{name}>"
492:
493: ret
494: end
Returns a hash containing default assignments for the `xmlns`, `lang`, and `xml:lang` attributes of the `html` HTML element. For example,
%html{html_attrs}
becomes
<html xmlns='http://www.w3.org/1999/xhtml' xml:lang='en-US' lang='en-US'>
@param lang [String] The value of `xml:lang` and `lang` @return [{# => String}] The attribute hash
# File lib/haml/helpers.rb, line 196
196: def html_attrs(lang = 'en-US')
197: {:xmlns => "http://www.w3.org/1999/xhtml", 'xml:lang' => lang, :lang => lang}
198: end
Returns a copy of `text` with ampersands, angle brackets and quotes escaped into HTML entities.
Note that if ActionView is loaded and XSS protection is enabled (as is the default for Rails 3.0+, and optional for version 2.3.5+), this won’t escape text declared as “safe”.
@param text [String] The string to sanitize @return [String] The sanitized string
# File lib/haml/helpers.rb, line 508
508: def html_escape(text)
509: Haml::Util.silence_warnings {text.to_s.gsub(/[\"><&]/) {|s| HTML_ESCAPE[s]}}
510: end
Note: this does *not* need to be called when using Haml helpers normally in Rails.
Initializes the current object as though it were in the same context as a normal ActionView instance using Haml. This is useful if you want to use the helpers in a context other than the normal setup with ActionView. For example:
context = Object.new
class << context
include Haml::Helpers
end
context.init_haml_helpers
context.haml_tag :p, "Stuff"
# File lib/haml/helpers.rb, line 73
73: def init_haml_helpers
74: @haml_buffer = Haml::Buffer.new(@haml_buffer, Haml::Engine.new('').send(:options_for_buffer))
75: nil
76: end
Returns whether or not the current template is a Haml template.
This function, unlike other {Haml::Helpers} functions, also works in other `ActionView` templates, where it will always return false.
@return [Boolean] Whether or not the current template is a Haml template
# File lib/haml/helpers.rb, line 530
530: def is_haml?
531: !@haml_buffer.nil? && @haml_buffer.active?
532: end
Takes an `Enumerable` object and a block and iterates over the enum, yielding each element to a Haml block and putting the result into `
= list_of([['hello'], ['yall']]) do |i|
= i[0]
Produces:
<li>hello</li>
<li>yall</li>
And
= list_of({:title => 'All the stuff', :description => 'A book about all the stuff.'}) do |key, val|
%h3= key.humanize
%p= val
Produces:
<li>
<h3>Title</h3>
<p>All the stuff</p>
</li>
<li>
<h3>Description</h3>
<p>A book about all the stuff.</p>
</li>
@param enum [Enumerable] The list of objects to iterate over @yield [item] A block which contains Haml code that goes within list items @yieldparam item An element of `enum`
# File lib/haml/helpers.rb, line 168
168: def list_of(enum, &block)
169: to_return = enum.collect do |i|
170: result = capture_haml(i, &block)
171:
172: if result.count("\n") > 1
173: result.gsub!("\n", "\n ")
174: result = "\n #{result.strip}\n"
175: else
176: result.strip!
177: end
178:
179: "<li>#{result}</li>"
180: end
181: to_return.join("\n")
182: end
Runs a block of code in a non-Haml context (i.e. {#is_haml?} will return false).
This is mainly useful for rendering sub-templates such as partials in a non-Haml language, particularly where helpers may behave differently when run from Haml.
Note that this is automatically applied to Rails partials.
@yield A block which won’t register as Haml
# File lib/haml/helpers.rb, line 87
87: def non_haml
88: was_active = @haml_buffer.active?
89: @haml_buffer.active = false
90: yield
91: ensure
92: @haml_buffer.active = was_active
93: end
Prepends a string to the beginning of a Haml block, with no whitespace between. For example:
= precede '*' do
%span.small Not really
Produces:
*<span class='small'>Not really</span>
@param str [String] The string to add before the Haml @yield A block of Haml to prepend to
# File lib/haml/helpers.rb, line 300
300: def precede(str, &block)
301: "#{str}#{capture_haml(&block).chomp}\n"
302: end
Takes any string, finds all the newlines, and converts them to HTML entities so they’ll render correctly in whitespace-sensitive tags without screwing up the indentation.
@overload perserve(input)
Escapes newlines within a string. @param input [String] The string within which to escape all newlines
@overload perserve
Escapes newlines within a block of Haml code. @yield The block within which to escape newlines
# File lib/haml/helpers.rb, line 127
127: def preserve(input = nil, &block)
128: return preserve(capture_haml(&block)) if block
129: input.to_s.chomp("\n").gsub(/\n/, '
').gsub(/\r/, '')
130: end
Appends a string to the end of a Haml block, with no whitespace between. For example:
click
= succeed '.' do
%a{:href=>"thing"} here
Produces:
click
<a href='thing'>here</a>.
@param str [String] The string to add after the Haml @yield A block of Haml to append to
# File lib/haml/helpers.rb, line 319
319: def succeed(str, &block)
320: "#{capture_haml(&block).chomp}#{str}\n"
321: end
Surrounds a block of Haml code with strings, with no whitespace in between. For example:
= surround '(', ')' do
%a{:href => "food"} chicken
Produces:
(<a href='food'>chicken</a>)
and
= surround '*' do
%strong angry
Produces:
*<strong>angry</strong>*
@param front [String] The string to add before the Haml @param back [String] The string to add after the Haml @yield A block of Haml to surround
# File lib/haml/helpers.rb, line 281
281: def surround(front, back = front, &block)
282: output = capture_haml(&block)
283:
284: "#{front}#{output.chomp}#{back}\n"
285: end
Decrements the number of tabs the buffer automatically adds to the lines of the template.
@param i [Fixnum] The number of tabs by which to decrease the indentation @see #
# File lib/haml/helpers.rb, line 227
227: def tab_down(i = 1)
228: haml_buffer.tabulation -= i
229: end
Increments the number of tabs the buffer automatically adds to the lines of the template. For example:
%h1 foo
* tab_up
%p bar
* tab_down
%strong baz
Produces:
<h1>foo</h1>
<p>bar</p>
<strong>baz</strong>
@param i [Fixnum] The number of tabs by which to increase the indentation @see #
# File lib/haml/helpers.rb, line 218
218: def tab_up(i = 1)
219: haml_buffer.tabulation += i
220: end
Sets the number of tabs the buffer automatically adds to the lines of the template, but only for the duration of the block. For example:
%h1 foo
* with_tabs(2) do
%p bar
%strong baz
Produces:
<h1>foo</h1>
<p>bar</p>
<strong>baz</strong>
@param i [Fixnum] The number of tabs to use @yield A block in which the indentation will be `i` spaces
# File lib/haml/helpers.rb, line 250
250: def with_tabs(i)
251: old_tabs = haml_buffer.tabulation
252: haml_buffer.tabulation = i
253: yield
254: ensure
255: haml_buffer.tabulation = old_tabs
256: end
Gives a proc the same local `_hamlout` and `_erbout` variables that the current template has.
@param proc [#] The proc to bind @return [Proc] A new proc with the new variables bound
# File lib/haml/helpers.rb, line 585
585: def haml_bind_proc(&proc)
586: _hamlout = haml_buffer
587: _erbout = _hamlout.buffer
588: proc { |*args| proc.call(*args) }
589: end
The current {Haml::Buffer} object.
@return [Haml::Buffer]
# File lib/haml/helpers.rb, line 576
576: def haml_buffer
577: @haml_buffer
578: end
Parses the tag name used for {#haml_tag} and merges it with the Ruby attributes hash.
# File lib/haml/helpers.rb, line 549
549: def merge_name_and_attributes(name, attributes_hash = {})
550: # skip merging if no ids or classes found in name
551: return name, attributes_hash unless name =~ /^(.+?)?([\.#].*)$/
552:
553: return $1 || "div", Buffer.merge_attrs(
554: Precompiler.parse_class_and_id($2),
555: Haml::Util.map_keys(attributes_hash) {|key| key.to_s})
556: end
Runs a block of code with the given buffer as the currently active buffer.
@param buffer [Haml::Buffer] The Haml buffer to use temporarily @yield A block in which the given buffer should be used
# File lib/haml/helpers.rb, line 562
562: def with_haml_buffer(buffer)
563: @haml_buffer, old_buffer = buffer, @haml_buffer
564: old_buffer.active, old_was_active = false, old_buffer.active? if old_buffer
565: @haml_buffer.active, was_active = true, @haml_buffer.active?
566: yield
567: ensure
568: @haml_buffer.active = was_active
569: old_buffer.active = old_was_active if old_buffer
570: @haml_buffer = old_buffer
571: end
Disabled; run with --debug to generate this.
Generated with the Darkfish Rdoc Generator 1.1.6.