hamlit 1.7.2 → 2.0.1

data/lib/hamlit/parser/haml_error.rb

@@ -0,0 +1,61 @@
+module Hamlit
+  # An exception raised by Haml code.
+  class HamlError < StandardError
+
+    MESSAGES = {
+      :bad_script_indent            => '"%s" is indented at wrong level: expected %d, but was at %d.',
+      :cant_run_filter              => 'Can\'t run "%s" filter; you must require its dependencies first',
+      :cant_use_tabs_and_spaces     => "Indentation can't use both tabs and spaces.",
+      :deeper_indenting             => "The line was indented %d levels deeper than the previous line.",
+      :filter_not_defined           => 'Filter "%s" is not defined.',
+      :gem_install_filter_deps      => '"%s" filter\'s %s dependency missing: try installing it or adding it to your Gemfile',
+      :illegal_element              => "Illegal element: classes and ids must have values.",
+      :illegal_nesting_content      => "Illegal nesting: nesting within a tag that already has content is illegal.",
+      :illegal_nesting_header       => "Illegal nesting: nesting within a header command is illegal.",
+      :illegal_nesting_line         => "Illegal nesting: content can't be both given on the same line as %%%s and nested within it.",
+      :illegal_nesting_plain        => "Illegal nesting: nesting within plain text is illegal.",
+      :illegal_nesting_self_closing => "Illegal nesting: nesting within a self-closing tag is illegal.",
+      :inconsistent_indentation     => "Inconsistent indentation: %s used for indentation, but the rest of the document was indented using %s.",
+      :indenting_at_start           => "Indenting at the beginning of the document is illegal.",
+      :install_haml_contrib         => 'To use the "%s" filter, please install the haml-contrib gem.',
+      :invalid_attribute_list       => 'Invalid attribute list: %s.',
+      :invalid_filter_name          => 'Invalid filter name ":%s".',
+      :invalid_tag                  => 'Invalid tag: "%s".',
+      :missing_if                   => 'Got "%s" with no preceding "if"',
+      :no_ruby_code                 => "There's no Ruby code for %s to evaluate.",
+      :self_closing_content         => "Self-closing tags can't have content.",
+      :unbalanced_brackets          => 'Unbalanced brackets.',
+      :no_end                       => <<-END
+You don't need to use "- end" in Haml. Un-indent to close a block:
+- if foo?
+  %strong Foo!
+- else
+  Not foo.
+%p This line is un-indented, so it isn't part of the "if" block
+END
+    }
+
+    def self.message(key, *args)
+      string = MESSAGES[key] or raise "[HAML BUG] No error messages for #{key}"
+      (args.empty? ? string : string % args).rstrip
+    end
+
+    # The line of the template on which the error occurred.
+    #
+    # @return [Fixnum]
+    attr_reader :line
+
+    # @param message [String] The error message
+    # @param line [Fixnum] See \{#line}
+    def initialize(message = nil, line = nil)
+      super(message)
+      @line = line
+    end
+  end
+
+  # SyntaxError is the type of exception raised when Haml encounters an
+  # ill-formatted document.
+  # It's not particularly interesting,
+  # except in that it's a subclass of {Haml::Error}.
+  class HamlSyntaxError < HamlError; end
+end

data/lib/hamlit/parser/haml_helpers.rb

@@ -0,0 +1,727 @@
+require 'hamlit/parser/haml_error'
+require 'hamlit/parser/haml_buffer'
+require 'hamlit/parser/haml_options'
+require 'hamlit/parser/haml_compiler'
+require 'hamlit/parser/haml_parser'
+
+module Hamlit
+  # 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.
+  module HamlHelpers
+    # An object that raises an error when \{#to\_s} is called.
+    # It's used to raise an error when the return value of a helper is used
+    # when it shouldn't be.
+    class ErrorReturn
+      def initialize(method)
+        @message = <<MESSAGE
+#{method} outputs directly to the Haml template.
+Disregard its return value and use the - operator,
+or use capture_haml to get the value as a String.
+MESSAGE
+      end
+
+      # Raises an error.
+      #
+      # @raise [Haml::Error] The error
+      def to_s
+        raise ::Hamlit::HamlError.new(@message)
+      rescue ::Hamlit::HamlError => e
+        e.backtrace.shift
+
+        # If the ErrorReturn is used directly in the template,
+        # we don't want Haml's stuff to get into the backtrace,
+        # so we get rid of the format_script line.
+        #
+        # We also have to subtract one from the Haml line number
+        # since the value is passed to format_script the line after
+        # it's actually used.
+        if e.backtrace.first =~ /^\(eval\):\d+:in `format_script/
+          e.backtrace.shift
+          e.backtrace.first.gsub!(/^\(haml\):(\d+)/) {|s| "(haml):#{$1.to_i - 1}"}
+        end
+        raise e
+      end
+
+      # @return [String] A human-readable string representation
+      def inspect
+        "::Hamlit::HamlHelpers::ErrorReturn(#{@message.inspect})"
+      end
+    end
+
+    self.extend self
+
+    @@action_view_defined = false
+
+    # @return [Boolean] Whether or not ActionView is loaded
+    def self.action_view?
+      @@action_view_defined
+    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"
+    #
+    def init_haml_helpers
+      @haml_buffer = ::Hamlit::HamlBuffer.new(haml_buffer, ::Hamlit::HamlOptions.new.for_buffer)
+      nil
+    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
+    def non_haml
+      was_active = @haml_buffer.active?
+      @haml_buffer.active = false
+      yield
+    ensure
+      @haml_buffer.active = was_active
+    end
+
+    # Uses \{#preserve} to convert any newlines inside whitespace-sensitive tags
+    # into the HTML entities for endlines.
+    #
+    # @param tags [Array<String>] Tags that should have newlines escaped
+    #
+    # @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
+    def find_and_preserve(input = nil, tags = haml_buffer.options[:preserve], &block)
+      return find_and_preserve(capture_haml(&block), input || tags) if block
+      tags = tags.each_with_object('') do |t, s|
+        s << '|' unless s.empty?
+        s << Regexp.escape(t)
+      end
+      re = /<(#{tags})([^>]*)>(.*?)(<\/\1>)/im
+      input.to_s.gsub(re) do |s|
+        s =~ re # Can't rely on $1, etc. existing since Rails' SafeBuffer#gsub is incompatible
+        "<#{$1}#{$2}>#{preserve($3)}</#{$1}>"
+      end
+    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 preserve(input)
+    #   Escapes newlines within a string.
+    #
+    #   @param input [String] The string within which to escape all newlines
+    # @overload preserve
+    #   Escapes newlines within a block of Haml code.
+    #
+    #   @yield The block within which to escape newlines
+    def preserve(input = nil, &block)
+      return preserve(capture_haml(&block)) if block
+      s = input.to_s.chomp("\n")
+      s.gsub!(/\n/, '&#x000A;')
+      s.delete!("\r")
+      s
+    end
+    alias_method :flatten, :preserve
+
+    # 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>
+    #
+    # While:
+    #
+    #     = list_of(["Home", "About", "Contact", "FAQ"], {class: "nav", role: "nav"}) do |item|
+    #       %a{ href="#" }= item
+    #
+    # Produces:
+    #
+    #     <li class='nav' role='nav'>
+    #       <a href='#'>Home</a>
+    #     </li>
+    #     <li class='nav' role='nav'>
+    #       <a href='#'>About</a>
+    #     </li>
+    #     <li class='nav' role='nav'>
+    #       <a href='#'>Contact</a>
+    #     </li>
+    #     <li class='nav' role='nav'>
+    #       <a href='#'>FAQ</a>
+    #     </li>
+    #
+    #  `[[class", "nav"], [role", "nav"]]` could have been used instead of `{class: "nav", role: "nav"}` (or any enumerable collection where each pair of items responds to #to_s)
+    #
+    # @param enum [Enumerable] The list of objects to iterate over
+    # @param [Enumerable<#to_s,#to_s>] opts Each key/value pair will become an attribute pair for each list item element.
+    # @yield [item] A block which contains Haml code that goes within list items
+    # @yieldparam item An element of `enum`
+    def list_of(enum, opts={}, &block)
+      opts_attributes = opts.each_with_object('') {|(k, v), s| s << " #{k}='#{v}'"}
+      enum.each_with_object('') do |i, ret|
+        result = capture_haml(i, &block)
+
+        if result.count("\n") > 1
+          result.gsub!("\n", "\n  ")
+          result = "\n  #{result.strip!}\n"
+        else
+          result.strip!
+        end
+
+        ret << "\n" unless ret.empty?
+        ret << %Q!<li#{opts_attributes}>#{result}</li>!
+      end
+    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 [{#to_s => String}] The attribute hash
+    def html_attrs(lang = 'en-US')
+      if haml_buffer.options[:format] == :xhtml
+        {:xmlns => "http://www.w3.org/1999/xhtml", 'xml:lang' => lang, :lang => lang}
+      else
+        {:lang => lang}
+      end
+    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 #tab_down
+    def tab_up(i = 1)
+      haml_buffer.tabulation += i
+    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 #tab_up
+    def tab_down(i = 1)
+      haml_buffer.tabulation -= i
+    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
+    def with_tabs(i)
+      old_tabs = haml_buffer.tabulation
+      haml_buffer.tabulation = i
+      yield
+    ensure
+      haml_buffer.tabulation = old_tabs
+    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
+    def surround(front, back = front, &block)
+      output = capture_haml(&block)
+
+      "#{front}#{output.chomp}#{back}\n"
+    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
+    def precede(str, &block)
+      "#{str}#{capture_haml(&block).chomp}\n"
+    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
+    def succeed(str, &block)
+      "#{capture_haml(&block).chomp}#{str}\n"
+    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 `"<p>13</p>\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`
+    def capture_haml(*args, &block)
+      buffer = eval('if defined? _hamlout then _hamlout else nil end', block.binding) || haml_buffer
+      with_haml_buffer(buffer) do
+        position = haml_buffer.buffer.length
+
+        haml_buffer.capture_position = position
+        value = block.call(*args)
+
+        captured = haml_buffer.buffer.slice!(position..-1)
+
+        if captured == '' and value != haml_buffer.buffer
+          captured = (value.is_a?(String) ? value : nil)
+        end
+
+        return nil if captured.nil?
+        return (haml_buffer.options[:ugly] ? captured : prettify(captured))
+      end
+    ensure
+      haml_buffer.capture_position = nil
+    end
+
+    # Outputs text directly to the Haml buffer, with the proper indentation.
+    #
+    # @param text [#to_s] The text to output
+    def haml_concat(text = "")
+      haml_internal_concat text
+      ErrorReturn.new("haml_concat")
+    end
+
+    # Internal method to write directly to the buffer with control of
+    # whether the first line should be indented, and if there should be a
+    # final newline.
+    #
+    # Lines added will have the proper indentation. This can be controlled
+    # for the first line.
+    #
+    # Used by #haml_concat and #haml_tag.
+    #
+    # @param text [#to_s] The text to output
+    # @param newline [Boolean] Whether to add a newline after the text
+    # @param indent [Boolean] Whether to add indentation to the first line
+    def haml_internal_concat(text = "", newline = true, indent = true)
+      if haml_buffer.options[:ugly] || haml_buffer.tabulation == 0
+        haml_buffer.buffer << "#{text}#{"\n" if newline}"
+      else
+        haml_buffer.buffer << %[#{haml_indent if indent}#{text.to_s.gsub("\n", "\n#{haml_indent}")}#{"\n" if newline}]
+      end
+    end
+    private :haml_internal_concat
+
+    # Allows writing raw content. `haml_internal_concat_raw` isn't
+    # effected by XSS mods. Used by #haml_tag to write the actual tags.
+    alias :haml_internal_concat_raw :haml_internal_concat
+
+    # @return [String] The indentation string for the current line
+    def haml_indent
+      '  ' * haml_buffer.tabulation
+    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#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>
+    #
+    # @param name [#to_s] The name of the tag
+    #
+    # @overload haml_tag(name, *rest, 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
+    #   @param flags [Array<Symbol>] Haml end-of-tag flags
+    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
+      attrs = (rest.shift || {})
+      attrs.keys.each {|key| attrs[key.to_s] = attrs.delete(key)} unless attrs.empty?
+      name, attrs = merge_name_and_attributes(name.to_s, attrs)
+
+      attributes = ::Hamlit::HamlCompiler.build_attributes(haml_buffer.html?,
+        haml_buffer.options[:attr_wrapper],
+        haml_buffer.options[:escape_attrs],
+        haml_buffer.options[:hyphenate_data_attrs],
+        attrs)
+
+      if text.nil? && block.nil? && (haml_buffer.options[:autoclose].include?(name) || flags.include?(:/))
+        haml_internal_concat_raw "<#{name}#{attributes}#{' /' if haml_buffer.options[:format] == :xhtml}>"
+        return ret
+      end
+
+      if flags.include?(:/)
+        raise ::Hamlit::HamlError.new(::Hamlit::HamlError.message(:self_closing_content)) if text
+        raise ::Hamlit::HamlError.new(::Hamlit::HamlError.message(:illegal_nesting_self_closing)) if block
+      end
+
+      tag = "<#{name}#{attributes}>"
+      end_tag = "</#{name}>"
+      if block.nil?
+        text = text.to_s
+        if text.include?("\n")
+          haml_internal_concat_raw tag
+          tab_up
+          haml_internal_concat text
+          tab_down
+          haml_internal_concat_raw end_tag
+        else
+          haml_internal_concat_raw tag, false
+          haml_internal_concat text, false, false
+          haml_internal_concat_raw end_tag, true, false
+        end
+        return ret
+      end
+
+      if text
+        raise ::Hamlit::HamlError.new(::Hamlit::HamlError.message(:illegal_nesting_line, name))
+      end
+
+      if flags.include?(:<)
+        haml_internal_concat_raw tag, false
+        haml_internal_concat "#{capture_haml(&block).strip}", false, false
+        haml_internal_concat_raw end_tag, true, false
+        return ret
+      end
+
+      haml_internal_concat_raw tag
+      tab_up
+      block.call
+      tab_down
+      haml_internal_concat_raw end_tag
+
+      ret
+    end
+
+    # Conditionally wrap a block in an element. If `condition` is `true` then
+    # this method renders the tag described by the arguments in `tag` (using
+    # \{#haml_tag}) with the given block inside, otherwise it just renders the block.
+    #
+    # For example,
+    #
+    #     - haml_tag_if important, '.important' do
+    #       %p
+    #         A (possibly) important paragraph.
+    #
+    # will produce
+    #
+    #     <div class='important'>
+    #       <p>
+    #         A (possibly) important paragraph.
+    #       </p>
+    #     </div>
+    #
+    # if `important` is truthy, and just
+    #
+    #     <p>
+    #       A (possibly) important paragraph.
+    #     </p>
+    #
+    # otherwise.
+    #
+    # Like \{#haml_tag}, `haml_tag_if` outputs directly to the buffer and its
+    # return value should not be used. Use \{#capture_haml} if you need to use
+    # its results as a string.
+    #
+    # @param condition The condition to test to determine whether to render
+    #   the enclosing tag
+    # @param tag Definition of the enclosing tag. See \{#haml_tag} for details
+    #   (specifically the form that takes a block)
+    def haml_tag_if(condition, *tag)
+      if condition
+        haml_tag(*tag){ yield }
+      else
+        yield
+      end
+      ErrorReturn.new("haml_tag_if")
+    end
+
+    # Characters that need to be escaped to HTML entities from user input
+    HTML_ESCAPE = { '&' => '&amp;', '<' => '&lt;', '>' => '&gt;', '"' => '&quot;', "'" => '&#039;' }
+
+    HTML_ESCAPE_REGEX = /[\"><&]/
+
+    # 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
+    def html_escape(text)
+      text = text.to_s
+      text.gsub(HTML_ESCAPE_REGEX, HTML_ESCAPE)
+    end
+
+    HTML_ESCAPE_ONCE_REGEX = /[\"><]|&(?!(?:[a-zA-Z]+|#(?:\d+|[xX][0-9a-fA-F]+));)/
+
+    # 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
+    def escape_once(text)
+      text = text.to_s
+      text.gsub(HTML_ESCAPE_ONCE_REGEX, HTML_ESCAPE)
+    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
+    def is_haml?
+      !@haml_buffer.nil? && @haml_buffer.active?
+    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
+    def block_is_haml?(block)
+      eval('!!defined?(_hamlout)', block.binding)
+    end
+
+    private
+
+    # Parses the tag name used for \{#haml\_tag}
+    # and merges it with the Ruby attributes hash.
+    def merge_name_and_attributes(name, attributes_hash = {})
+      # skip merging if no ids or classes found in name
+      return name, attributes_hash unless name =~ /^(.+?)?([\.#].*)$/
+
+      return $1 || "div", ::Hamlit::HamlBuffer.merge_attrs(
+        ::Hamlit::HamlParser.parse_class_and_id($2), attributes_hash)
+    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
+    def with_haml_buffer(buffer)
+      @haml_buffer, old_buffer = buffer, @haml_buffer
+      old_buffer.active, old_was_active = false, old_buffer.active? if old_buffer
+      @haml_buffer.active, was_active = true, @haml_buffer.active?
+      yield
+    ensure
+      @haml_buffer.active = was_active
+      old_buffer.active = old_was_active if old_buffer
+      @haml_buffer = old_buffer
+    end
+
+    # The current {Haml::Buffer} object.
+    #
+    # @return [Haml::Buffer]
+    def haml_buffer
+      @haml_buffer if defined? @haml_buffer
+    end
+
+    # Gives a proc the same local `_hamlout` and `_erbout` variables
+    # that the current template has.
+    #
+    # @param proc [#call] The proc to bind
+    # @return [Proc] A new proc with the new variables bound
+    def haml_bind_proc(&proc)
+      _hamlout = haml_buffer
+      #double assignment is to avoid warnings
+      _erbout = _erbout = _hamlout.buffer
+      proc { |*args| proc.call(*args) }
+    end
+
+    def prettify(text)
+      text = text.split(/^/)
+      text.delete('')
+
+      min_tabs = nil
+      text.each do |line|
+        tabs = line.index(/[^ ]/) || line.length
+        min_tabs ||= tabs
+        min_tabs = min_tabs > tabs ? tabs : min_tabs
+      end
+
+      text.each_with_object('') do |line, str|
+        str << line.slice(min_tabs, line.length)
+      end
+    end
+  end
+end
+
+# @private
+class Object
+  # Haml overrides various `ActionView` helpers,
+  # which call an \{#is\_haml?} method
+  # to determine whether or not the current context object
+  # is a proper Haml context.
+  # Because `ActionView` helpers may be included in non-`ActionView::Base` classes,
+  # it's a good idea to define \{#is\_haml?} for all objects.
+  def is_haml?
+    false
+  end
+end