hamlet 0.2.1 → 0.3.0

data/README.md

@@ -29,22 +29,32 @@ see, it is just HTML! Designers love Hamlet because it is just HTML! Closing tag
 You can see the [original hamlet templating langauge](http://www.yesodweb.com/book/templates) and the
 [javascript port](hamlet: https://github.com/gregwebs/hamlet.js).
 
-This Hamlet works on top of [slim](https://github.com/stonean/slim/). Please see [slim documentation](http://slim-lang.com). There is one important difference: hamlet always defers to HTML syntax. In slim you have:
+This Hamlet works on top of [slim](https://github.com/stonean/slim/). Please take a look at the [slim documentation](http://slim-lang.com) if you are looking to see if a more advanced feature is supported.
 
-    p data-attr=foo Text
+## Difference with Slim
+
+The most important difference is that hamlet always uses angle brackets. Hamlet also does not require attributes to be quoted - unquoted is considered a normal html attribute value and quotes will be added. Hamlet also uses a '#' for code comments and the normal <!-- for HTML comments. Hamlet also uses different whitespace indicators - see the next section.
+
+In Slim you have:
+
+    /! HTML comment
+    p data-attr="foo" Text
       | More Text
+      / Comment
 
 In hamlet you have:
 
+    <!-- HTML comment
     <p data-attr=foo>Text
       More Text
+      # Comment
 
 ## Whitespace
 
-This is currently a bit of a Slim Frankenstein, but I added the same syntax that hamlet.js uses to indicate whitespace: a closing bracket
+I added the same syntax that hamlet.js uses to indicate whitespace: a closing bracket to the left and a code comment to the right. I will probably take out some of the slim white space techniques.
 
-    <p>   White space to the left
-      >   White space to the left again
+    <p>   White space to the left        # and to the right
+      >   White space to the left again# None to the right
 
 
 ## Limitations

data/hamlet.gemspec

@@ -4,7 +4,7 @@ require 'date'
 
 Gem::Specification.new do |s|
   s.name              = 'hamlet'
-  s.version           = '0.2.1'
+  s.version           = '0.3.0'
   s.date              = Date.today.to_s
   s.authors           = ['Greg Weber']
   s.email             = ['greg@gregweber.info']
@@ -16,7 +16,7 @@ Gem::Specification.new do |s|
   s.rubyforge_project = s.name
 
   s.files         = `git ls-files`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  #s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = %w(lib)
 
   s.add_dependency('slim', ['~> 1.0.0'])
@@ -29,6 +29,9 @@ Gem::Specification.new do |s|
   s.add_development_dependency('creole', ['>= 0'])
   s.add_development_dependency('builder', ['>= 0'])
   s.add_development_dependency('pry', ['>= 0'])
+  if RUBY_VERSION =~ /1.9/
+    s.add_development_dependency('ruby-debug19', ['>= 0'])
+  end
 
   unless defined?(RUBY_ENGINE) && RUBY_ENGINE == 'rbx'
     s.add_development_dependency('rcov', ['>= 0'])

data/lib/hamlet/forked_slim_parser.rb

@@ -74,12 +74,6 @@ module ForkedSlim
     DELIMITER_REGEX = /\A[\(\[\{]/
     ATTR_NAME_REGEX = '\A\s*(\w[:\w-]*)'
 
-    if RUBY_VERSION > '1.9'
-      CLASS_ID_REGEX = /\A(#|\.)([\w\u00c0-\uFFFF][\w:\u00c0-\uFFFF-]*)/
-    else
-      CLASS_ID_REGEX = /\A(#|\.)(\w[\w:-]*)/
-    end
-
     def reset(lines = nil, stacks = nil)
       # Since you can indent however you like in Slim, we need to keep a list
       # of how deeply indented you are. For instance, in a template like this:

data/lib/hamlet/parser.rb

@@ -3,77 +3,114 @@ require 'hamlet/forked_slim_parser'
 # @api private
 module Hamlet
   class Parser < ForkedSlim::Parser
-    private
+    if RUBY_VERSION > '1.9'
+      CLASS_ID_REGEX = /\A\s*(#|\.)([\w\u00c0-\uFFFF][\w:\u00c0-\uFFFF-]*)/
+    else
+      CLASS_ID_REGEX = /\A\s*(#|\.)(\w[\w:-]*)/
+    end
+
+    # Compile string to Temple expression
+    #
+    # @param [String] str Slim code
+    # @return [Array] Temple expression representing the code]]
+    def call(str)
+      # Set string encoding if option is set
+      if options[:encoding] && str.respond_to?(:encoding)
+        old = str.encoding
+        str = str.dup if str.frozen?
+        str.force_encoding(options[:encoding])
+        # Fall back to old encoding if new encoding is invalid
+        str.force_encoding(old_enc) unless str.valid_encoding?
+      end
+
+      result = [:multi]
+      reset(str.split($/), [result])
+
+      while @lines.first && @lines.first =~ /\A\s*\Z/
+        @stacks.last << [:newline]
+        next_line 
+      end
+      if @lines.first and @lines.first =~ /\A<doctype\s+([^>]*)/i
+        if !$'.empty? and $'[0] !~ /\s*#/
+          fail("did not expect content after doctype")
+        end
+        @stacks.last << [:html, :doctype, $1]
+        next_line
+      end
+
+      parse_line while next_line
+
+      reset
+      result
+    end
+
+  private
 
     def parse_line_indicators
       case @line
-      when /\A\//
-        # Found a comment block.
-        if @line =~ %r{\A/!( ?)(.*)\Z}
-          # HTML comment
-          block = [:multi]
-          @stacks.last <<  [:html, :comment, block]
-          @stacks << block
-          @stacks.last << [:slim, :interpolate, $2] unless $2.empty?
-          parse_text_block($2.empty? ? nil : @indents.last + $1.size + 2)
-        elsif @line =~ %r{\A/\[\s*(.*?)\s*\]\s*\Z}
-          # HTML conditional comment
-          block = [:multi]
-          @stacks.last << [:slim, :condcomment, $1, block]
-          @stacks << block
-        else
-          # Slim comment
-          parse_comment_block
-        end
-      when /\A-/
-        # Found a code block.
-        # We expect the line to be broken or the next line to be indented.
+      when /\A-/ # code block.
         block = [:multi]
         @line.slice!(0)
         @stacks.last << [:slim, :control, parse_broken_line, block]
         @stacks << block
-      when /\A=/
-        # Found an output block.
-        # We expect the line to be broken or the next line to be indented.
+      when /\A=/ # output block.
         @line =~ /\A=(=?)('?)/
         @line = $'
         block = [:multi]
         @stacks.last << [:slim, :output, $1.empty?, parse_broken_line, block]
         @stacks.last << [:static, ' '] unless $2.empty?
         @stacks << block
-      when /\A<(\w+):\s*\Z/
-        # Embedded template detected. It is treated as block.
+      when /\A<(\w+):\s*\Z/ # Embedded template. It is treated as block.
         block = [:multi]
         @stacks.last << [:newline] << [:slim, :embedded, $1, block]
         @stacks << block
-        parse_text_block
+        parse_text_block(nil, true)
         return # Don't append newline, this has already been done before
-      when /\Adoctype\s+/i
-        # Found doctype declaration
-        @stacks.last << [:html, :doctype, $'.strip]
-      when /\A<([#\.]|\w[:\w-]*)/
-        # Found a HTML tag.
+      when /\A<([#\.]|\w[:\w-]*)/ # HTML tag.
         parse_tag($1)
-      when /\A(?:>( *))?(.*)?\Z/
-        # Found a text block.
-        @stacks.last << [:slim, :interpolate, $1 ? $1 << $2 : $2] unless $2.empty?
-        parse_text_block($2.empty? ? nil : @indents.last + $1.to_s.size)
+      when /\A<!--( ?)(.*)\Z/ # HTML comment
+        block = [:multi]
+        @stacks.last <<  [:html, :comment, block]
+        @stacks << block
+        @stacks.last << [:slim, :interpolate, $2] unless $2.empty?
+        parse_text_block($2.empty? ? nil : @indents.last + $1.size + 2)
+      when %r{\A#\[\s*(.*?)\s*\]\s*\Z} # HTML conditional comment
+        block = [:multi]
+        @stacks.last << [:slim, :condcomment, $1, block]
+        @stacks << block
+      when /\A(?:\s*>( *))?/ # text block.
+        @stacks.last << [:slim, :interpolate, $1 ? $1 << $' : $']
+        parse_text_block($'.empty? ? nil : @indents.last + $1.to_s.size)
       else
         syntax_error! 'Unknown line indicator'
       end
       @stacks.last << [:newline]
     end
 
-    def parse_text_block(text_indent = nil)
+    def parse_text_block(text_indent = nil, special = nil)
       empty_lines = 0
+      multi_line = false
+      if special == :from_tag
+        multi_line = true
+        special = nil
+      end
+
+      first_line = true
+      close_bracket = false
       until @lines.empty?
-        if @lines.first =~ /\A\s*\Z/
+        if @lines.first =~ /\A\s*>?\s*\Z/
           next_line
           @stacks.last << [:newline]
           empty_lines += 1 if text_indent
         else
           indent = get_indent(@lines.first)
           break if indent <= @indents.last
+          if @lines.first =~ /\A\s*>/
+            indent += 1 #$1.size if $1
+            close_bracket = true
+          else
+            close_bracket = false
+          end
 
           if empty_lines > 0
             @stacks.last << [:slim, :interpolate, "\n" * empty_lines]
@@ -85,16 +122,28 @@ module Hamlet
           # The text block lines must be at least indented
           # as deep as the first line.
           if text_indent && indent < text_indent
-            @line.lstrip!
-            syntax_error!('Unexpected text indentation')
+            # special case for a leading '>' being back 1 char
+            unless first_line && close_bracket && (text_indent - indent == 1)
+              @line.lstrip!
+              syntax_error!('Unexpected text indentation')
+            end
           end
 
           @line.slice!(0, text_indent || indent)
+          @line = $' if @line =~ /\A>/
+          # a code comment
+          if @line =~ /(\A|[^\\])#([^{]|\Z)/
+            @line = $` + $1
+          end
+          @stacks.last << [:newline] if multi_line && !special
           @stacks.last << [:slim, :interpolate, (text_indent ? "\n" : '') + @line] << [:newline]
 
           # The indentation of first line of the text block
           # determines the text base indentation.
           text_indent ||= indent
+
+          first_line = false
+          multi_line = true
         end
       end
     end
@@ -111,27 +160,25 @@ module Hamlet
       @stacks.last << tag
 
       case @line
-      when /\A\s*>?=(=?)('?)/
-        # Handle output code
+      when /\A=(=?)('?)/ # Handle output code
         block = [:multi]
         @line = $'
         content = [:slim, :output, $1 != '=', parse_broken_line, block]
         tag << content
         @stacks.last << [:static, ' '] unless $2.empty?
         @stacks << block
-      when /\A\s*\//
-        # Closed tag. Do nothing
-      when /\A\s*>?\s*\Z/
+      when /\A\s*\Z/
         # Empty content
         content = [:multi]
         tag << content
         @stacks << content
-      when /\A( ?)>?(.*)\Z/
-        # Text content
-        content = [:multi, [:slim, :interpolate, $2]]
+      when %r!\A/>!
+        # Do nothing for closing tag
+      else # Text content
+        content = [:multi, [:slim, :interpolate, @line]]
         tag << content
         @stacks << content
-        parse_text_block(@orig_line.size - @line.size + $1.size)
+        parse_text_block(@orig_line.size - @line.size, :from_tag)
       end
     end
 
@@ -147,44 +194,45 @@ module Hamlet
       end
 
       # Check to see if there is a delimiter right after the tag name
-      delimiter = nil
-      if @line =~ DELIMITER_REGEX
-        delimiter = DELIMITERS[$&]
-        @line.slice!(0)
-      end
+      delimiter = '>'
 
       orig_line = @orig_line
       lineno = @lineno
       while true
         # Parse attributes
-        attr_regex = delimiter ? /#{ATTR_NAME_REGEX}(=|\s|(?=#{Regexp.escape delimiter}))/ : /#{ATTR_NAME_REGEX}=/
-        while @line =~ attr_regex
-          @line = $'
+        while @line =~ /#{ATTR_NAME_REGEX}\s*(=\s*)?/
           name = $1
-          if delimiter && $2 != '='
+          @line = $'
+          if !$2
             attributes << [:slim, :attr, name, false, 'true']
           elsif @line =~ /\A["']/
             # Value is quoted (static)
             @line = $'
             attributes << [:html, :attr, name, [:slim, :interpolate, parse_quoted_attribute($&)]]
-          else
-            @line =~ /[^ >]+/
+          elsif @line =~ /\A[^ >]+/
             @line = $'
             attributes << [:html, :attr, name, [:slim, :interpolate, $&]]
           end
         end
 
-        # No ending delimiter, attribute end
-        break unless delimiter
+        @line.lstrip!
 
         # Find ending delimiter
-        if @line =~ /\A\s*#{Regexp.escape delimiter}/
+        if @line =~ /\A(>|\Z)/
           @line = $'
           break
+        elsif @line =~ %r!\A/>!
+          # Do nothing for closing tag
+          # don't eat the line either, we check for it again
+          if not $'.empty? and $' !~ /\s*#/
+            syntax_error!("Did not expect any content after self closing tag",
+                           :orig_line => orig_line,
+                           :lineno => lineno,
+                           :column => orig_line.size)
+          end
+          break
         end
 
-        # Found something where an attribute should be
-        @line.lstrip!
         syntax_error!('Expected attribute') unless @line.empty?
 
         # Attributes span multiple lines

data/test/slim/test_chain_manipulation.rb

@@ -19,7 +19,7 @@ p Test
 p Test
 }
     chain = proc do |engine|
-      engine.before(Slim::Parser, :WrapInput) do |input|
+      engine.before(Hamlet::Parser, :WrapInput) do |input|
         "p Header\n#{input}\np Footer"
       end
     end
@@ -32,7 +32,7 @@ p Test
 p Test
 }
     chain = proc do |engine|
-      engine.after(Slim::Parser, :ReplaceParsedExp) do |exp|
+      engine.after(Hamlet::Parser, :ReplaceParsedExp) do |exp|
         [:slim, :output, false, '1+1', [:multi]]
       end
     end

data/test/slim/test_code_blocks.rb

@@ -3,9 +3,9 @@ require 'helper'
 class TestSlimCodeBlocks < TestSlim
   def test_render_with_output_code_block
     source = %q{
-p
+<p
   = hello_world "Hello Ruby!" do
-    | Hello from within a block!
+    Hello from within a block!
 }
 
     assert_html '<p>Hello Ruby! Hello from within a block! Hello Ruby!</p>', source
@@ -13,7 +13,7 @@ p
 
   def test_render_with_output_code_within_block
     source = %q{
-p
+<p
   = hello_world "Hello Ruby!" do
     = hello_world "Hello from within a block!"
 }
@@ -23,7 +23,7 @@ p
 
   def test_render_with_output_code_within_block_2
     source = %q{
-p
+<p
   = hello_world "Hello Ruby!" do
     = hello_world "Hello from within a block!" do
       = hello_world "And another one!"
@@ -34,10 +34,10 @@ p
 
   def test_output_block_with_arguments
     source = %q{
-p
+<p
   = define_macro :person do |first_name, last_name|
-    .first_name = first_name
-    .last_name = last_name
+    <.first_name>= first_name
+    <.last_name>= last_name
   == call_macro :person, 'John', 'Doe'
   == call_macro :person, 'Max', 'Mustermann'
 }
@@ -48,9 +48,9 @@ p
 
   def test_render_with_control_code_loop
     source = %q{
-p
+<p
   - 3.times do
-    | Hey!
+    Hey!
 }
 
     assert_html '<p>Hey!Hey!Hey!</p>', source
@@ -60,7 +60,7 @@ p
     source = %q{
 = hello_world "Hello Ruby!" do
   - if true
-    | Hello from within a block!
+    Hello from within a block!
 }
 
     assert_html 'Hello Ruby! Hello from within a block! Hello Ruby!', source

data/test/slim/test_code_escaping.rb

@@ -3,7 +3,7 @@ require 'helper'
 class TestSlimCodeEscaping < TestSlim
   def test_escaping_evil_method
     source = %q{
-p = evil_method
+<p>= evil_method
 }
 
     assert_html '<p>&lt;script&gt;do_something_evil();&lt;&#47;script&gt;</p>', source
@@ -11,7 +11,7 @@ p = evil_method
 
   def test_render_without_html_safe
     source = %q{
-p = "<strong>Hello World\\n, meet \\"Slim\\"</strong>."
+<p>= "<strong>Hello World\\n, meet \\"Slim\\"</strong>."
 }
 
     assert_html "<p>&lt;strong&gt;Hello World\n, meet \&quot;Slim\&quot;&lt;&#47;strong&gt;.</p>", source
@@ -19,7 +19,7 @@ p = "<strong>Hello World\\n, meet \\"Slim\\"</strong>."
 
   def test_render_with_html_safe_false
     source = %q{
-p = HtmlUnsafeString.new("<strong>Hello World\\n, meet \\"Slim\\"</strong>.")
+<p>= HtmlUnsafeString.new("<strong>Hello World\\n, meet \\"Slim\\"</strong>.")
 }
 
     assert_html "<p>&lt;strong&gt;Hello World\n, meet \&quot;Slim\&quot;&lt;&#47;strong&gt;.</p>", source, :use_html_safe => true
@@ -27,7 +27,7 @@ p = HtmlUnsafeString.new("<strong>Hello World\\n, meet \\"Slim\\"</strong>.")
 
   def test_render_with_html_safe_true
     source = %q{
-p = HtmlSafeString.new("<strong>Hello World\\n, meet \\"Slim\\"</strong>.")
+<p>= HtmlSafeString.new("<strong>Hello World\\n, meet \\"Slim\\"</strong>.")
 }
 
     assert_html "<p><strong>Hello World\n, meet \"Slim\"</strong>.</p>", source, :use_html_safe => true