haml_ejs 0.0.1

data/lib/haml/html.rb

@@ -0,0 +1,412 @@
+require File.dirname(__FILE__) + '/../haml'
+
+require 'haml/engine'
+require 'rubygems'
+require 'cgi'
+require 'hpricot'
+
+# Haml monkeypatches various Hpricot classes
+# to add methods for conversion to Haml.
+# @private
+module Hpricot
+  # @see Hpricot
+  module Node
+    # Whether this node has already been converted to Haml.
+    # Only used for text nodes and elements.
+    #
+    # @return [Boolean]
+    attr_accessor :converted_to_haml
+
+    # Returns the Haml representation of the given node.
+    #
+    # @param tabs [Fixnum] The indentation level of the resulting Haml.
+    # @option options (see Haml::HTML#initialize)
+    def to_haml(tabs, options)
+      return "" if converted_to_haml || to_s.strip.empty?
+      text = uninterp(self.to_s)
+      node = next_node
+      while node.is_a?(::Hpricot::Elem) && node.name == "haml:loud"
+        node.converted_to_haml = true
+        text << '#{' <<
+          CGI.unescapeHTML(node.inner_text).gsub(/\n\s*/, ' ').strip << '}'
+
+        if node.next_node.is_a?(::Hpricot::Text)
+          node = node.next_node
+          text << uninterp(node.to_s)
+          node.converted_to_haml = true
+        end
+
+        node = node.next_node
+      end
+      return parse_text_with_interpolation(text, tabs)
+    end
+
+    private
+
+    def erb_to_interpolation(text, options)
+      return text unless options[:erb]
+      text = CGI.escapeHTML(uninterp(text))
+      %w[<haml:loud> </haml:loud>].each {|str| text.gsub!(CGI.escapeHTML(str), str)}
+      ::Hpricot::XML(text).children.inject("") do |str, elem|
+        if elem.is_a?(::Hpricot::Text)
+          str + CGI.unescapeHTML(elem.to_s)
+        else # <haml:loud> element
+          str + '#{' + CGI.unescapeHTML(elem.innerText.strip) + '}'
+        end
+      end
+    end
+
+    def tabulate(tabs)
+      '  ' * tabs
+    end
+
+    def uninterp(text)
+      text.gsub('#{', '\#{') #'
+    end
+
+    def attr_hash
+      attributes.to_hash
+    end
+
+    def parse_text(text, tabs)
+      parse_text_with_interpolation(uninterp(text), tabs)
+    end
+
+    def parse_text_with_interpolation(text, tabs)
+      text.strip!
+      return "" if text.empty?
+
+      text.split("\n").map do |line|
+        line.strip!
+        "#{tabulate(tabs)}#{'\\' if Haml::Engine::SPECIAL_CHARACTERS.include?(line[0])}#{line}\n"
+      end.join
+    end
+  end
+end
+
+# @private
+HAML_TAGS = %w[haml:block haml:loud haml:silent]
+
+HAML_TAGS.each do |t|
+  Hpricot::ElementContent[t] = {}
+  Hpricot::ElementContent.keys.each do |key|
+    Hpricot::ElementContent[t][key.hash] = true
+  end
+end
+
+Hpricot::ElementContent.keys.each do |k|
+  HAML_TAGS.each do |el|
+    val = Hpricot::ElementContent[k]
+    val[el.hash] = true if val.is_a?(Hash)
+  end
+end
+
+module Haml
+  # Converts HTML documents into Haml templates.
+  # Depends on [Hpricot](http://github.com/whymirror/hpricot) for HTML parsing.
+  # If ERB conversion is being used, also depends on 
+  # [Erubis](http://www.kuwata-lab.com/erubis) to parse the ERB
+  # and [ruby_parser](http://parsetree.rubyforge.org/) to parse the Ruby code.
+  #
+  # Example usage:
+  #
+  #     Haml::HTML.new("<a href='http://google.com'>Blat</a>").render
+  #       #=> "%a{:href => 'http://google.com'} Blat"
+  class HTML
+    # @param template [String, Hpricot::Node] The HTML template to convert
+    # @option options :erb [Boolean] (false) Whether or not to parse
+    #   ERB's `<%= %>` and `<% %>` into Haml's `=` and `-`
+    # @option options :xhtml [Boolean] (false) Whether or not to parse
+    #   the HTML strictly as XHTML
+    def initialize(template, options = {})
+      @options = options
+
+      if template.is_a? Hpricot::Node
+        @template = template
+      else
+        if template.is_a? IO
+          template = template.read
+        end
+
+        template = Haml::Util.check_encoding(template) {|msg, line| raise Haml::Error.new(msg, line)}
+
+        if @options[:erb]
+          require 'haml/html/erb'
+          template = ERB.compile(template)
+        end
+
+        method = @options[:xhtml] ? Hpricot.method(:XML) : method(:Hpricot)
+        @template = method.call(template.gsub('&', '&amp;'))
+      end
+    end
+
+    # Processes the document and returns the result as a string
+    # containing the Haml template.
+    def render
+      @template.to_haml(0, @options)
+    end
+    alias_method :to_haml, :render
+
+    TEXT_REGEXP = /^(\s*).*$/
+
+    # @see Hpricot
+    # @private
+    class ::Hpricot::Doc
+      # @see Haml::HTML::Node#to_haml
+      def to_haml(tabs, options)
+        (children || []).inject('') {|s, c| s << c.to_haml(0, options)}
+      end
+    end
+
+    # @see Hpricot
+    # @private
+    class ::Hpricot::XMLDecl
+      # @see Haml::HTML::Node#to_haml
+      def to_haml(tabs, options)
+        "#{tabulate(tabs)}!!! XML\n"
+      end
+    end
+
+    # @see Hpricot
+    # @private
+    class ::Hpricot::CData
+      # @see Haml::HTML::Node#to_haml
+      def to_haml(tabs, options)
+        content = parse_text_with_interpolation(
+          erb_to_interpolation(self.content, options), tabs + 1)
+        "#{tabulate(tabs)}:cdata\n#{content}"
+      end
+    end
+
+    # @see Hpricot
+    # @private
+    class ::Hpricot::DocType
+      # @see Haml::HTML::Node#to_haml
+      def to_haml(tabs, options)
+        attrs = public_id.nil? ? ["", "", ""] :
+          public_id.scan(/DTD\s+([^\s]+)\s*([^\s]*)\s*([^\s]*)\s*\/\//)[0]
+        raise Haml::SyntaxError.new("Invalid doctype") if attrs == nil
+
+        type, version, strictness = attrs.map { |a| a.downcase }
+        if type == "html"
+          version = ""
+          strictness = "strict" if strictness == ""
+        end
+
+        if version == "1.0" || version.empty?
+          version = nil
+        end
+
+        if strictness == 'transitional' || strictness.empty?
+          strictness = nil
+        end
+
+        version = " #{version.capitalize}" if version
+        strictness = " #{strictness.capitalize}" if strictness
+
+        "#{tabulate(tabs)}!!!#{version}#{strictness}\n"
+      end
+    end
+
+    # @see Hpricot
+    # @private
+    class ::Hpricot::Comment
+      # @see Haml::HTML::Node#to_haml
+      def to_haml(tabs, options)
+        content = self.content
+        if content =~ /\A(\[[^\]]+\])>(.*)<!\[endif\]\z/m
+          condition = $1
+          content = $2
+        end
+
+        if content.include?("\n")
+          "#{tabulate(tabs)}/#{condition}\n#{parse_text(content, tabs + 1)}"
+        else
+          "#{tabulate(tabs)}/#{condition} #{content.strip}\n"
+        end
+      end
+    end
+
+    # @see Hpricot
+    # @private
+    class ::Hpricot::Elem
+      # @see Haml::HTML::Node#to_haml
+      def to_haml(tabs, options)
+        return "" if converted_to_haml
+        if name == "script" &&
+            (attr_hash['type'].nil? || attr_hash['type'] == "text/javascript") &&
+            (attr_hash.keys - ['type']).empty?
+          return to_haml_filter(:javascript, tabs, options)
+        elsif name == "style" &&
+            (attr_hash['type'].nil? || attr_hash['type'] == "text/css") &&
+            (attr_hash.keys - ['type']).empty?
+          return to_haml_filter(:css, tabs, options)
+        end
+
+        output = tabulate(tabs)
+        if options[:erb] && name[0...5] == 'haml:'
+          case name[5..-1]
+          when "loud"
+            lines = CGI.unescapeHTML(inner_text).split("\n").
+              map {|s| s.rstrip}.reject {|s| s.strip.empty?}
+            lines.first.gsub!(/^[ \t]*/, "= ")
+
+            if lines.size > 1 # Multiline script block
+              # Normalize the indentation so that the last line is the base
+              indent_str = lines.last[/^[ \t]*/]
+              indent_re = /^[ \t]{0,#{indent_str.count(" ") + 8 * indent_str.count("\t")}}/
+              lines.map! {|s| s.gsub!(indent_re, '')}
+
+              # Add an extra "  " to make it indented relative to "= "
+              lines[1..-1].each {|s| s.gsub!(/^/, "  ")}
+
+              # Add | at the end, properly aligned
+              length = lines.map {|s| s.size}.max + 1
+              lines.map! {|s| "%#{-length}s|" % s}
+
+              if next_sibling && next_sibling.is_a?(Hpricot::Elem) && next_sibling.name == "haml:loud" &&
+                  next_sibling.inner_text.split("\n").reject {|s| s.strip.empty?}.size > 1
+                lines << "-#"
+              end
+            end
+            return lines.map {|s| output + s + "\n"}.join
+          when "silent"
+            return CGI.unescapeHTML(inner_text).split("\n").map do |line|
+              next "" if line.strip.empty?
+              "#{output}- #{line.strip}\n"
+            end.join
+          when "block"
+            return render_children("", tabs, options)
+          end
+        end
+
+        if self.next && self.next.text? && self.next.content =~ /\A[^\s]/
+          if self.previous.nil? || self.previous.text? &&
+              (self.previous.content =~ /[^\s]\Z/ ||
+               self.previous.content =~ /\A\s*\Z/ && self.previous.previous.nil?)
+            nuke_outer_whitespace = true
+          else
+            output << "= succeed #{self.next.content.slice!(/\A[^\s]+/).dump} do\n"
+            tabs += 1
+            output << tabulate(tabs)
+          end
+        end
+
+        output << "%#{name}" unless name == 'div' &&
+          (static_id?(options) ||
+           static_classname?(options) &&
+           attr_hash['class'].split(' ').any?(&method(:haml_css_attr?)))
+
+        if attr_hash
+          if static_id?(options)
+            output << "##{attr_hash['id']}"
+            remove_attribute('id')
+          end
+          if static_classname?(options)
+            leftover = attr_hash['class'].split(' ').reject do |c|
+              next unless haml_css_attr?(c)
+              output << ".#{c}"
+            end
+            remove_attribute('class')
+            set_attribute('class', leftover.join(' ')) unless leftover.empty?
+          end
+          output << haml_attributes(options) if attr_hash.length > 0
+        end
+
+        output << ">" if nuke_outer_whitespace
+        output << "/" if empty? && !etag
+
+        if children && children.size == 1
+          child = children.first
+          if child.is_a?(::Hpricot::Text)
+            if !child.to_s.include?("\n")
+              text = child.to_haml(tabs + 1, options)
+              return output + " " + text.lstrip.gsub(/^\\/, '') unless text.chomp.include?("\n")
+              return output + "\n" + text
+            elsif ["pre", "textarea"].include?(name) ||
+                (name == "code" && parent.is_a?(::Hpricot::Elem) && parent.name == "pre")
+              return output + "\n#{tabulate(tabs + 1)}:preserve\n" +
+                innerText.gsub(/^/, tabulate(tabs + 2))
+            end
+          elsif child.is_a?(::Hpricot::Elem) && child.name == "haml:loud"
+            return output + child.to_haml(tabs + 1, options).lstrip
+          end
+        end
+
+        render_children(output + "\n", tabs, options)
+      end
+
+      private
+
+      def render_children(so_far, tabs, options)
+        (self.children || []).inject(so_far) do |output, child|
+          output + child.to_haml(tabs + 1, options)
+        end
+      end
+      
+      def dynamic_attributes
+        @dynamic_attributes ||= begin
+          Haml::Util.map_hash(attr_hash) do |name, value|
+            next if value.empty?
+            full_match = nil
+            ruby_value = value.gsub(%r{<haml:loud>\s*(.+?)\s*</haml:loud>}) do
+              full_match = $`.empty? && $'.empty?
+              CGI.unescapeHTML(full_match ? $1: "\#{#{$1}}")
+            end
+            next if ruby_value == value
+            [name, full_match ? ruby_value : %("#{ruby_value}")]
+          end
+        end
+      end
+
+      def to_haml_filter(filter, tabs, options)
+        content =
+          if children.first.is_a?(::Hpricot::CData)
+            children.first.content
+          else
+            CGI.unescapeHTML(self.innerText)
+          end
+          
+        content = erb_to_interpolation(content, options)
+        content.gsub!(/\A\s*\n(\s*)/, '\1')
+        original_indent = content[/\A(\s*)/, 1]
+        if content.split("\n").all? {|l| l.strip.empty? || l =~ /^#{original_indent}/}
+          content.gsub!(/^#{original_indent}/, tabulate(tabs + 1))
+        end
+
+        "#{tabulate(tabs)}:#{filter}\n#{content}"
+      end
+
+      def static_attribute?(name, options)
+        attr_hash[name] && !dynamic_attribute?(name, options)
+      end
+      
+      def dynamic_attribute?(name, options)
+        options[:erb] and dynamic_attributes.key?(name)
+      end
+      
+      def static_id?(options)
+        static_attribute?('id', options) && haml_css_attr?(attr_hash['id'])
+      end
+      
+      def static_classname?(options)
+        static_attribute?('class', options)
+      end
+
+      def haml_css_attr?(attr)
+        attr =~ /^[-:\w]+$/
+      end
+
+      # Returns a string representation of an attributes hash
+      # that's prettier than that produced by Hash#inspect
+      def haml_attributes(options)
+        attrs = attr_hash.sort.map do |name, value|
+          value = dynamic_attribute?(name, options) ? dynamic_attributes[name] : value.inspect
+          name = name.index(/\W/) ? name.inspect : ":#{name}"
+          "#{name} => #{value}"
+        end
+        "{#{attrs.join(', ')}}"
+      end
+    end
+  end
+end

data/lib/haml/html/erb.rb

@@ -0,0 +1,141 @@
+require 'cgi'
+require 'erubis'
+require 'ruby_parser'
+
+module Haml
+  class HTML
+    # A class for converting ERB code into a format that's easier
+    # for the {Haml::HTML} Hpricot-based parser to understand.
+    #
+    # Uses [Erubis](http://www.kuwata-lab.com/erubis)'s extensible parsing powers
+    # to parse the ERB in a reliable way,
+    # and [ruby_parser](http://parsetree.rubyforge.org/)'s Ruby knowledge
+    # to figure out whether a given chunk of Ruby code starts a block or not.
+    #
+    # The ERB tags are converted to HTML tags in the following way.
+    # `<% ... %>` is converted into `<haml:silent> ... </haml:silent>`.
+    # `<%= ... %>` is converted into `<haml:loud> ... </haml:loud>`.
+    # Finally, if either of these opens a Ruby block,
+    # `<haml:block> ... </haml:block>` will wrap the entire contents of the block -
+    # that is, everything that should be indented beneath the previous silent or loud tag.
+    class ERB < Erubis::Basic::Engine
+      # Compiles an ERB template into a HTML document containing `haml:` tags.
+      #
+      # @param template [String] The ERB template
+      # @return [String] The output document
+      # @see Haml::HTML::ERB
+      def self.compile(template)
+        new(template).src
+      end
+
+      # `html2haml` doesn't support HTML-escaped expressions.
+      def escaped_expr(code)
+        raise Haml::Error.new("html2haml doesn't support escaped expressions.")
+      end
+
+      # The ERB-to-Hamlized-HTML conversion has no preamble.
+      def add_preamble(src); end
+
+      # The ERB-to-Hamlized-HTML conversion has no postamble.
+      def add_postamble(src); end
+
+      # Concatenates the text onto the source buffer.
+      #
+      # @param src [String] The source buffer
+      # @param text [String] The raw text to add to the buffer
+      def add_text(src, text)
+        src << text
+      end
+
+      # Concatenates a silent Ruby statement onto the source buffer.
+      # This uses the `<haml:silent>` tag,
+      # and may close and/or open a Ruby block with the `<haml:block>` tag.
+      #
+      # In particular, a block is closed if this statement is some form of `end`,
+      # opened if it's a block opener like `do`, `if`, or `begin`,
+      # and both closed and opened if it's a mid-block keyword
+      # like `else` or `when`.
+      #
+      # @param src [String] The source buffer
+      # @param code [String] The Ruby statement to add to the buffer
+      def add_stmt(src, code)
+        src << '</haml:block>' if block_closer?(code) || mid_block?(code)
+        src << '<haml:silent>' << h(code) << '</haml:silent>' unless code.strip == "end"
+        src << '<haml:block>' if block_opener?(code) || mid_block?(code)
+      end
+
+      # Concatenates a Ruby expression that's printed to the document
+      # onto the source buffer.
+      # This uses the `<haml:silent>` tag,
+      # and may open a Ruby block with the `<haml:block>` tag.
+      # An expression never closes a block.
+      #
+      # @param src [String] The source buffer
+      # @param code [String] The Ruby expression to add to the buffer
+      def add_expr_literal(src, code)
+        src << '<haml:loud>' << h(code) << '</haml:loud>'
+        src << '<haml:block>' if block_opener?(code)
+      end
+
+      # `html2haml` doesn't support debugging expressions.
+      def add_expr_debug(src, code)
+        raise Haml::Error.new("html2haml doesn't support debugging expressions.")
+      end
+
+      private
+
+      # HTML-escaped some text (in practice, always Ruby code).
+      # A utility method.
+      #
+      # @param text [String] The text to escape
+      # @return [String] The escaped text
+      def h(text)
+        CGI.escapeHTML(text)
+      end
+
+      # Returns whether the code is valid Ruby code on its own.
+      #
+      # @param code [String] Ruby code to check
+      # @return [Boolean]
+      def valid_ruby?(code)
+        RubyParser.new.parse(code)
+      rescue Racc::ParseError => e
+        false
+      end
+
+      # Checks if a string of Ruby code opens a block.
+      # This could either be something like `foo do |a|`
+      # or a keyword that requires a matching `end`
+      # like `if`, `begin`, or `case`.
+      #
+      # @param code [String] Ruby code to check
+      # @return [Boolean]
+      def block_opener?(code)
+        valid_ruby?(code + "\nend") ||
+          valid_ruby?(code + "\nwhen foo\nend")
+      end
+
+      # Checks if a string of Ruby code closes a block.
+      # This is always `end` followed optionally by some method calls.
+      #
+      # @param code [String] Ruby code to check
+      # @return [Boolean]
+      def block_closer?(code)
+        valid_ruby?("begin\n" + code)
+      end
+
+      # Checks if a string of Ruby code comes in the middle of a block.
+      # This could be a keyword like `else`, `rescue`, or `when`,
+      # or even `end` with a method call that takes a block.
+      #
+      # @param code [String] Ruby code to check
+      # @return [Boolean]
+      def mid_block?(code)
+        return if valid_ruby?(code)
+        valid_ruby?("if foo\n#{code}\nend") || # else, elsif
+          valid_ruby?("begin\n#{code}\nend") || # rescue, ensure
+          valid_ruby?("case foo\n#{code}\nend") # when
+      end
+    end
+  end
+end