Module: Haml::Helpers

Extended by:
Helpers
Includes:
ActionViewExtensions
Included in:
Buffer, Helpers
Defined in:
lib/haml/helpers.rb,
lib/haml/helpers/xss_mods.rb,
lib/haml/helpers/action_view_extensions.rb

Overview

This module contains various helpful methods to make it easier to do various tasks. 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.

Defined Under Namespace

Modules: ActionViewExtensions, XssMods Classes: ErrorReturn

Constant Summary collapse

HTML_ESCAPE =

Characters that need to be escaped to HTML entities from user input

{ '&'=>'&amp;', '<'=>'&lt;', '>'=>'&gt;', '"'=>'&quot;', "'"=>'&#039;', }
@@action_view_defined = 
true

Class Method Summary collapse

Instance Method Summary collapse

Methods included from ActionViewExtensions

#page_class, #with_raw_haml_concat

Class Method Details

.action_view? ⇒ Boolean

Returns Whether or not ActionView is loaded.

Returns:

  • (Boolean) —

    Whether or not ActionView is loaded



53
54
55
 
# File 'lib/haml/helpers.rb', line 53

def self.action_view?
  @@action_view_defined
end

Instance Method Details

#block_is_haml?(block) ⇒ Boolean

Returns whether or not block is defined directly in a Haml template.

Parameters:

  • block (Proc) —

    A Ruby block

Returns:

  • (Boolean) —

    Whether or not block is defined directly in a Haml template



538
539
540
541
542
543
 
# File 'lib/haml/helpers.rb', line 538

def block_is_haml?(block)
  eval('_hamlout', block.binding)
  true
rescue
  false
end

#capture_haml(*args) {|args| ... }

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 "<p>13</p>\n".

Parameters:

  • args (Array) —

    Arguments to pass into the block

Yields:

  • (args) —

    A block of Haml code that will be converted to a string

Yield Parameters:

  • args (Array) —

    args



337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/haml/helpers.rb', line 337

def capture_haml(*args, &block)
  buffer = eval('_hamlout', block.binding) rescue haml_buffer
  with_haml_buffer(buffer) do
    position = haml_buffer.buffer.length

    haml_buffer.capture_position = position
    block.call(*args)

    captured = haml_buffer.buffer.slice!(position..-1)
    return captured if haml_buffer.options[:ugly]
    captured = captured.split(/^/)

    min_tabs = nil
    captured.each do |line|
      tabs = line.index(/[^ ]/) || line.length
      min_tabs ||= tabs
      min_tabs = min_tabs > tabs ? tabs : min_tabs
    end

    captured.map do |line|
      line[min_tabs..-1]
    end.join
  end
ensure
  haml_buffer.capture_position = nil
end

#escape_once(text) ⇒ String

Escapes HTML entities in text, but without escaping an ampersand that is already part of an escaped entity.

Parameters:

  • text (String) —

    The string to sanitize

Returns:

  • (String) —

    The sanitized string



517
518
519
520
521
 
# File 'lib/haml/helpers.rb', line 517

def escape_once(text)
  Haml::Util.silence_warnings do
    text.to_s.gsub(/[\"><]|&(?!(?:[a-zA-Z]+|(#\d+));)/n) {|s| HTML_ESCAPE[s]}
  end
end

#find_and_preserve(input, tags = haml_buffer.options[:preserve]) #find_and_preserve(tags = haml_buffer.options[:preserve]) { ... }

Uses #preserve to convert any newlines inside whitespace-sensitive tags into the HTML entities for endlines.

Overloads:

  • #find_and_preserve(input, tags = haml_buffer.options[:preserve])

    Escapes newlines within a string.

    Parameters:

    • input (String) —

      The string within which to escape newlines

  • #find_and_preserve(tags = haml_buffer.options[:preserve]) { ... }

    Escapes newlines within a block of Haml code.

    Yields:

    • The block within which to escape newlines

Parameters:

  • tags (Array<String>) (defaults to: haml_buffer.options[:preserve]) —

    Tags that should have newlines escaped



108
109
110
111
112
113
 
# File 'lib/haml/helpers.rb', line 108

def find_and_preserve(input = nil, tags = haml_buffer.options[:preserve], &block)
  return find_and_preserve(capture_haml(&block), input || tags) if block
  input.to_s.gsub(/<(#{tags.map(&Regexp.method(:escape)).join('|')})([^>]*)>(.*?)(<\/\1>)/im) do
    "<#{$1}#{$2}>#{preserve($3)}</#{$1}>"
  end
end

#haml_concat(text = "")

Outputs text directly to the Haml buffer, with the proper indentation.

Parameters:

  • text (#to_s) (defaults to: "") —

    The text to output



367
368
369
370
371
372
373
374
375
 
# File 'lib/haml/helpers.rb', line 367

def haml_concat(text = "")
  unless haml_buffer.options[:ugly] || haml_indent == 0
    haml_buffer.buffer << haml_indent <<
      text.to_s.gsub("\n", "\n" + haml_indent) << "\n"
  else
    haml_buffer.buffer << text.to_s << "\n"
  end
  ErrorReturn.new("haml_concat")
end

#haml_indent ⇒ String

Returns The indentation string for the current line.

Returns:

  • (String) —

    The indentation string for the current line



378
379
380
 
# File 'lib/haml/helpers.rb', line 378

def haml_indent
  '  ' * haml_buffer.tabulation
end

#haml_tag(name, *flags, attributes = {}) { ... } #haml_tag(name, text, *flags, attributes = {})

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#foo.bar", "#foo"). 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>

Overloads:

  • #haml_tag(name, *flags, attributes = {}) { ... }

    Yields:

    • The block of Haml code within the tag

  • #haml_tag(name, text, *flags, attributes = {})

    Parameters:

    • text (#to_s) —

      The text within the tag

Parameters:

  • name (#to_s) —

    The name of the tag

  • flags (Array<Symbol>) —

    Haml end-of-tag flags



439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
 
# File 'lib/haml/helpers.rb', line 439

def haml_tag(name, *rest, &block)
  ret = ErrorReturn.new("haml_tag")

  text = rest.shift.to_s unless [Symbol, Hash, NilClass].any? {|t| rest.first.is_a? t}
  flags = []
  flags << rest.shift while rest.first.is_a? Symbol
  name, attrs = merge_name_and_attributes(name.to_s, rest.shift || {})

  attributes = Haml::Precompiler.build_attributes(haml_buffer.html?,
                                                  haml_buffer.options[:attr_wrapper],
                                                  attrs)

  if text.nil? && block.nil? && (haml_buffer.options[:autoclose].include?(name) || flags.include?(:/))
    haml_concat "<#{name}#{attributes} />"
    return ret
  end

  if flags.include?(:/)
    raise Error.new("Self-closing tags can't have content.") if text
    raise Error.new("Illegal nesting: nesting within a self-closing tag is illegal.") if block
  end

  tag = "<#{name}#{attributes}>"
  if block.nil?
    text = text.to_s
    if text.include?("\n")
      haml_concat tag
      tab_up
      haml_concat text
      tab_down
      haml_concat "</#{name}>"
    else
      tag << text << "</#{name}>"
      haml_concat tag
    end
    return ret
  end

  if text
    raise Error.new("Illegal nesting: content can't be both given to haml_tag :#{name} and nested within it.")
  end

  if flags.include?(:<)
    tag << capture_haml(&block).strip << "</#{name}>"
    haml_concat tag
    return ret
  end

  haml_concat tag
  tab_up
  block.call
  tab_down
  haml_concat "</#{name}>"

  ret
end

#html_attrs(lang = 'en-US') ⇒ {#to_s => String}

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'>

Parameters:

  • lang (String) (defaults to: 'en-US') —

    The value of xml:lang and lang

Returns:

  • ({#to_s => String}) —

    The attribute hash



196
197
198
 
# File 'lib/haml/helpers.rb', line 196

def html_attrs(lang = 'en-US')
  {:xmlns => "http://www.w3.org/1999/xhtml", 'xml:lang' => lang, :lang => lang}
end

#html_escape(text) ⇒ String

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".

Parameters:

  • text (String) —

    The string to sanitize

Returns:

  • (String) —

    The sanitized string



508
509
510
 
# File 'lib/haml/helpers.rb', line 508

def html_escape(text)
  Haml::Util.silence_warnings {text.to_s.gsub(/[\"><&]/n) {|s| HTML_ESCAPE[s]}}
end

#init_haml_helpers

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"



73
74
75
76
 
# File 'lib/haml/helpers.rb', line 73

def init_haml_helpers
  @haml_buffer = Haml::Buffer.new(@haml_buffer, Haml::Engine.new('').send(:options_for_buffer))
  nil
end

#is_haml? ⇒ Boolean

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.

Returns:

  • (Boolean) —

    Whether or not the current template is a Haml template



530
531
532
 
# File 'lib/haml/helpers.rb', line 530

def is_haml?
  !@haml_buffer.nil? && @haml_buffer.active?
end

#list_of(enum) {|item| ... }

Takes an Enumerable object and a block and iterates over the enum, yielding each element to a Haml block and putting the result into <li> elements. This creates a list of the results of the block. For example:

= 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>

Parameters:

  • enum (Enumerable) —

    The list of objects to iterate over

Yields:

  • (item) —

    A block which contains Haml code that goes within list items

Yield Parameters:

  • item —

    An element of enum



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/haml/helpers.rb', line 168

def list_of(enum, &block)
  to_return = enum.collect do |i|
    result = capture_haml(i, &block)

    if result.count("\n") > 1
      result.gsub!("\n", "\n  ")
      result = "\n  #{result.strip}\n"
    else
      result.strip!
    end

    "<li>#{result}</li>"
  end
  to_return.join("\n")
end

#non_haml { ... }

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.

Yields:

  • A block which won't register as Haml



87
88
89
90
91
92
93
 
# File 'lib/haml/helpers.rb', line 87

def non_haml
  was_active = @haml_buffer.active?
  @haml_buffer.active = false
  yield
ensure
  @haml_buffer.active = was_active
end

#precede(str) { ... }

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>

Parameters:

  • str (String) —

    The string to add before the Haml

Yields:

  • A block of Haml to prepend to



300
301
302
 
# File 'lib/haml/helpers.rb', line 300

def precede(str, &block)
  "#{str}#{capture_haml(&block).chomp}\n"
end

#perserve(input) #perserve { ... } Also known as: flatten

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.

Overloads:

  • #perserve(input)

    Escapes newlines within a string.

    Parameters:

    • input (String) —

      The string within which to escape all newlines

  • #perserve { ... }

    Escapes newlines within a block of Haml code.

    Yields:

    • The block within which to escape newlines



127
128
129
130
 
# File 'lib/haml/helpers.rb', line 127

def preserve(input = nil, &block)
  return preserve(capture_haml(&block)) if block
  input.to_s.chomp("\n").gsub(/\n/, '&#x000A;').gsub(/\r/, '')
end

#succeed(str) { ... }

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>.

Parameters:

  • str (String) —

    The string to add after the Haml

Yields:

  • A block of Haml to append to



319
320
321
 
# File 'lib/haml/helpers.rb', line 319

def succeed(str, &block)
  "#{capture_haml(&block).chomp}#{str}\n"
end

#surround(front, back = front) { ... }

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>*

Parameters:

  • front (String) —

    The string to add before the Haml

  • back (String) (defaults to: front) —

    The string to add after the Haml

Yields:

  • A block of Haml to surround



281
282
283
284
285
 
# File 'lib/haml/helpers.rb', line 281

def surround(front, back = front, &block)
  output = capture_haml(&block)

  "#{front}#{output.chomp}#{back}\n"
end

#tab_down(i = 1)

Decrements the number of tabs the buffer automatically adds to the lines of the template.

Parameters:

  • i (Fixnum) (defaults to: 1) —

    The number of tabs by which to decrease the indentation

See Also:



227
228
229
 
# File 'lib/haml/helpers.rb', line 227

def tab_down(i = 1)
  haml_buffer.tabulation -= i
end

#tab_up(i = 1)

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>

Parameters:

  • i (Fixnum) (defaults to: 1) —

    The number of tabs by which to increase the indentation

See Also:



218
219
220
 
# File 'lib/haml/helpers.rb', line 218

def tab_up(i = 1)
  haml_buffer.tabulation += i
end

#with_tabs(i) { ... }

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>

Parameters:

  • i (Fixnum) —

    The number of tabs to use

Yields:

  • A block in which the indentation will be i spaces



250
251
252
253
254
255
256
 
# File 'lib/haml/helpers.rb', line 250

def with_tabs(i)
  old_tabs = haml_buffer.tabulation
  haml_buffer.tabulation = i
  yield
ensure
  haml_buffer.tabulation = old_tabs
end