Class: Haml::Buffer

Inherits:

Object

• Object
• Haml::Buffer

show all

Includes:

Helpers, Util

Defined in:

/var/www/haml-pages/.haml/lib/haml/buffer.rb

Overview

Constant Summary

Constants included from Util

RUBY_VERSION

Instance Attribute Summary

• - (Boolean) active writeonly
• - (String) buffer The string that holds the compiled HTML.
• - (Fixnum^?) capture_position nil if there’s no capture_haml block running, and the position at which it’s beginning the capture if there is one.
• - ({String => Object}) options The options hash passed in from Haml::Engine.
• - (Buffer) upper The Buffer for the enclosing Haml document.

Class Method Summary

• + ({String => String}) merge_attrs(to, from) Merges two attribute hashes.

Instance Method Summary

• - (Boolean) active? Whether or not this buffer is currently being used to render a Haml template.
• - adjust_tabs(tab_change) Modifies the indentation of the document.
• - (Boolean) html4? Whether or not the format is HTML4.
• - (Boolean) html5? Whether or not the format is HTML5.
• - (Boolean) html? Whether or not the format is any flavor of HTML.
• - (Buffer) initialize(upper = nil, options = {}) constructor A new instance of Buffer.
• - open_tag(name, self_closing, try_one_line, preserve_tag, escape_html, class_id, nuke_outer_whitespace, nuke_inner_whitespace, obj_ref, content, *attributes_hashes) Takes the various information about the opening tag for an element, formats it, and appends it to the buffer.
• - push_text(text, tab_change, dont_tab_up) Appends text to the buffer, properly tabulated.
• - rstrip! Remove the whitespace from the right side of the buffer string.
• - (Fixnum) tabulation The current indentation level of the document.
• - tabulation(val) Sets the current tabulation of the document.
• - (Boolean) toplevel? Whether or not this buffer is a top-level template, as opposed to a nested partial.
• - (Boolean) xhtml? Whether or not the format is XHTML.

Methods included from Helpers

action_view?, #block_is_haml?, #capture_haml, #escape_once, #find_and_preserve, #haml_concat, #haml_indent, #haml_tag, #html_attrs, #html_escape, #init_haml_helpers, #is_haml?, #list_of, #non_haml, #precede, #preserve, #succeed, #surround, #tab_down, #tab_up, #with_tabs

Methods included from Helpers::ActionViewExtensions

#page_class, #with_raw_haml_concat

Methods included from Util

#ap_geq?, #ap_geq_3?, #assert_html_safe!, #av_template_class, #caller_info, #check_encoding, #check_haml_encoding, #check_sass_encoding, #def_static_method, #enum_cons, #enum_slice, #enum_with_index, #flatten, #haml_warn, #has?, #html_safe, #intersperse, #lcs, #map_hash, #map_keys, #map_vals, #merge_adjacent_strings, #ord, #paths, #powerset, #rails_env, #rails_root, #rails_safe_buffer_class, #rails_xss_safe?, #restrict, #ruby1_8?, #ruby1_8_6?, #scope, #set_eql?, #set_hash, #silence_haml_warnings, #silence_warnings, #static_method_name, #strip_string_array, #substitute, #to_hash, #version_geq, #version_gt, #windows?

90
91
92
93
94
95
96
97
98
99
100

# File '/var/www/haml-pages/.haml/lib/haml/buffer.rb', line 90

def initialize(upper = nil, options = {})
  @active = true
  @upper = upper
  @options = options
  @buffer = ruby1_8? ? "" : "".encode(Encoding.find(options[:encoding]))
  @tabulation = 0

  # The number of tabs that Engine thinks we should have
  # @real_tabs + @tabulation is the number of tabs actually output
  @real_tabs = 0
end

37
38
39

# File '/var/www/haml-pages/.haml/lib/haml/buffer.rb', line 37

def active=(value)
  @active = value
end

14
15
16

# File '/var/www/haml-pages/.haml/lib/haml/buffer.rb', line 14

def buffer
  @buffer
end

33
34
35

# File '/var/www/haml-pages/.haml/lib/haml/buffer.rb', line 33

def capture_position
  @capture_position
end

20
21
22

# File '/var/www/haml-pages/.haml/lib/haml/buffer.rb', line 20

def options
  @options
end

27
28
29

# File '/var/www/haml-pages/.haml/lib/haml/buffer.rb', line 27

def upper
  @upper
end

248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275

# File '/var/www/haml-pages/.haml/lib/haml/buffer.rb', line 248

def self.merge_attrs(to, from)
  from['id'] = Precompiler.filter_and_join(from['id'], '_') if from['id']
  if to['id'] && from['id']
    to['id'] << '_' << from.delete('id').to_s
  elsif to['id'] || from['id']
    from['id'] ||= to['id']
  end

  from['class'] = Precompiler.filter_and_join(from['class'], ' ') if from['class']
  if to['class'] && from['class']
    # Make sure we don't duplicate class names
    from['class'] = (from['class'].to_s.split(' ') | to['class'].split(' ')).sort.join(' ')
  elsif to['class'] || from['class']
    from['class'] ||= to['class']
  end

  from_data = from['data'].is_a?(Hash)
  to_data = to['data'].is_a?(Hash)
  if from_data && to_data
    to['data'] = to['data'].merge(from['data'])
  elsif to_data
    to = Haml::Util.map_keys(to.delete('data')) {|name| "data-#{name}"}.merge(to)
  elsif from_data
    from = Haml::Util.map_keys(from.delete('data')) {|name| "data-#{name}"}.merge(from)
  end

  to.merge!(from)
end

70
71
72

# File '/var/www/haml-pages/.haml/lib/haml/buffer.rb', line 70

def active?
  @active
end

126
127
128

# File '/var/www/haml-pages/.haml/lib/haml/buffer.rb', line 126

def adjust_tabs(tab_change)
  @real_tabs += tab_change
end

50
51
52

# File '/var/www/haml-pages/.haml/lib/haml/buffer.rb', line 50

def html4?
  @options[:format] == :html4
end

55
56
57

# File '/var/www/haml-pages/.haml/lib/haml/buffer.rb', line 55

def html5?
  @options[:format] == :html5
end

45
46
47

# File '/var/www/haml-pages/.haml/lib/haml/buffer.rb', line 45

def html?
  html4? or html5?
end

193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222

# File '/var/www/haml-pages/.haml/lib/haml/buffer.rb', line 193

def open_tag(name, self_closing, try_one_line, preserve_tag, escape_html, class_id,
             nuke_outer_whitespace, nuke_inner_whitespace, obj_ref, content, *attributes_hashes)
  tabulation = @real_tabs

  attributes = class_id
  attributes_hashes.each do |old|
    self.class.merge_attrs(attributes, to_hash(old.map {|k, v| [k.to_s, v]}))
  end
  self.class.merge_attrs(attributes, parse_object_ref(obj_ref)) if obj_ref

  if self_closing && xhtml?
    str = " />" + (nuke_outer_whitespace ? "" : "\n")
  else
    str = ">" + ((if self_closing && html?
                    nuke_outer_whitespace
                  else
                    try_one_line || preserve_tag || nuke_inner_whitespace
                  end) ? "" : "\n")
  end

  attributes = Precompiler.build_attributes(html?, @options[:attr_wrapper], attributes)
  @buffer << "#{nuke_outer_whitespace || @options[:ugly] ? '' : tabs(tabulation)}<#{name}#{attributes}#{str}"

  if content
    @buffer << "#{content}" << (nuke_outer_whitespace ? "" : "\n")
    return
  end

  @real_tabs += 1 unless self_closing || nuke_inner_whitespace
end

109
110
111
112
113
114
115
116
117
118
119
120

# File '/var/www/haml-pages/.haml/lib/haml/buffer.rb', line 109

def push_text(text, tab_change, dont_tab_up)
  if @tabulation > 0
    # Have to push every line in by the extra user set tabulation.
    # Don't push lines with just whitespace, though,
    # because that screws up precompiled indentation.
    text.gsub!(/^(?!\s+$)/m, tabs)
    text.sub!(tabs, '') if dont_tab_up
  end

  @buffer << text
  @real_tabs += tab_change
end

226
227
228
229
230
231
232
233

# File '/var/www/haml-pages/.haml/lib/haml/buffer.rb', line 226

def rstrip!
  if capture_position.nil?
    buffer.rstrip!
    return
  end

  buffer << buffer.slice!(capture_position..-1).rstrip
end

75
76
77

# File '/var/www/haml-pages/.haml/lib/haml/buffer.rb', line 75

def tabulation
  @real_tabs + @tabulation
end

82
83
84
85

# File '/var/www/haml-pages/.haml/lib/haml/buffer.rb', line 82

def tabulation=(val)
  val = val - @real_tabs
  @tabulation = val > -1 ? val : 0
end

61
62
63

# File '/var/www/haml-pages/.haml/lib/haml/buffer.rb', line 61

def toplevel?
  upper.nil?
end

40
41
42

# File '/var/www/haml-pages/.haml/lib/haml/buffer.rb', line 40

def xhtml?
  not html?
end