This class is used only internally. It holds the buffer of HTML that is eventually output as the resulting document. It's called from within the precompiled code, and helps reduce the amount of processing done within `instance_eval`ed code.
The string that holds the compiled HTML. This is aliased as `_erbout` for compatibility with ERB-specific code.
@return [String]
nil if there's no capture_haml block running, and the position at which it's beginning the capture if there is one.
@return [Fixnum, nil]
The options hash passed in from {Haml::Engine}.
@return [{String => Object}] @see Haml::Engine#options_for_buffer
The {Buffer} for the enclosing Haml document. This is set for partials and similar sorts of nested templates. It's `nil` at the top level (see {#toplevel?}).
@return [Buffer]
Merges two attribute hashes. This is the same as `to.merge!(from)`, except that it merges id, class, and data attributes.
ids are concatenated with `"_"`, and classes are concatenated with `" "`. data hashes are simply merged.
Destructively modifies both `to` and `from`.
@param to [{String => String}] The attribute hash to merge into @param from [{String => to_s}] The attribute hash to merge from @return [{String => String}] `to`, after being merged
# File lib/haml/buffer.rb, line 228 def self.merge_attrs(to, from) from['id'] = Compiler.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'] = Compiler.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
@param upper [Buffer] The parent buffer @param options [{Symbol => Object}] An options hash.
See {Haml::Engine#options\_for\_buffer}
# File 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 @preserve_pattern = /<[\s]*#{@options[:preserve].join("|")}/ end
Whether or not this buffer is currently being used to render a Haml template. Returns `false` if a subtemplate is being rendered, even if it's a subtemplate of this buffer's template.
@return [Boolean]
# File lib/haml/buffer.rb, line 70 def active? @active end
Modifies the indentation of the document.
@param tab_change [Fixnum] The number of tabs by which to increase
or decrease the document's indentation
# File lib/haml/buffer.rb, line 128 def adjust_tabs(tab_change) @real_tabs += tab_change end
# File lib/haml/template/plugin.rb, line 73 def append_if_string=(value) if value.is_a?(String) && !value.is_a?(ActionView::NonConcattingString) ActiveSupport::Deprecation.warn("- style block helpers are deprecated. Please use =", caller) buffer << value end end
# File lib/haml/buffer.rb, line 194 def attributes(class_id, obj_ref, *attributes_hashes) 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 Compiler.build_attributes( html?, @options[:attr_wrapper], @options[:escape_attrs], attributes) end
@return [Boolean] Whether or not the format is HTML4
# File lib/haml/buffer.rb, line 50 def html4? @options[:format] == :html4 end
@return [Boolean] Whether or not the format is HTML5.
# File lib/haml/buffer.rb, line 55 def html5? @options[:format] == :html5 end
@return [Boolean] Whether or not the format is any flavor of HTML
# File lib/haml/buffer.rb, line 45 def html? html4? or html5? end
Appends text to the buffer, properly tabulated. Also modifies the document's indentation.
@param text [String] The text to append @param tab_change [Fixnum] The number of tabs by which to increase
or decrease the document's indentation
@param dont_tab_up [Boolean] If true, don't indent the first line of `text`
# File lib/haml/buffer.rb, line 111 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+$)/, tabs) text.sub!(tabs, '') if dont_tab_up end @buffer << text @real_tabs += tab_change end
Remove the whitespace from the right side of the buffer string. Doesn't do anything if we're at the beginning of a capture_haml block.
# File lib/haml/buffer.rb, line 206 def rstrip! if capture_position.nil? buffer.rstrip! return end buffer << buffer.slice!(capture_position..-1).rstrip end
@return [Fixnum] The current indentation level of the document
# File lib/haml/buffer.rb, line 75 def tabulation @real_tabs + @tabulation end
Sets the current tabulation of the document.
@param val [Fixnum] The new tabulation
# File lib/haml/buffer.rb, line 82 def tabulation=(val) val = val - @real_tabs @tabulation = val > -1 ? val : 0 end
Generated with the Darkfish Rdoc Generator 2.