curly-templates 0.10.2 → 0.11.0

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 ### Unreleased
 
+### Curly 0.11.0 (July 31, 2013)
+
+* Make Curly raise an exception when a reference or comment is not closed.
+
+  *Daniel Schierbeck*
+
+* Fix a bug that caused an infinite loop when there was whitespace in a reference.
+
+  *Daniel Schierbeck*
+
 ### Curly 0.10.2 (July 11, 2013)
 
 * Fix a bug that caused non-string presenter method return values to be

data/curly-templates.gemspec

@@ -4,8 +4,8 @@ Gem::Specification.new do |s|
   s.rubygems_version = '1.3.5'
 
   s.name              = 'curly-templates'
-  s.version           = '0.10.2'
-  s.date              = '2013-07-11'
+  s.version           = '0.11.0'
+  s.date              = '2013-07-31'
 
   s.summary     = "Free your views!"
   s.description = "A view layer for your Rails apps that separates structure and logic."
@@ -42,6 +42,7 @@ Gem::Specification.new do |s|
     lib/curly/presenter.rb
     lib/curly/railtie.rb
     lib/curly/scanner.rb
+    lib/curly/syntax_error.rb
     lib/curly/template_handler.rb
     lib/generators/curly/controller/controller_generator.rb
     lib/generators/curly/controller/templates/presenter.rb.erb
@@ -52,6 +53,7 @@ Gem::Specification.new do |s|
     spec/presenter_spec.rb
     spec/scanner_spec.rb
     spec/spec_helper.rb
+    spec/syntax_error_spec.rb
     spec/template_handler_spec.rb
   ]
   # = MANIFEST =

data/lib/curly.rb

@@ -26,7 +26,7 @@
 # See Curly::Presenter for more information on presenters.
 #
 module Curly
-  VERSION = "0.10.2"
+  VERSION = "0.11.0"
 
   # Compiles a Curly template to Ruby code.
   #

data/lib/curly/compiler.rb

@@ -85,10 +85,6 @@ module Curly
       'buffer.safe_concat(%s)' % text.inspect
     end
 
-    def compile_comment_line(comment)
-      "" # Replace the content with an empty string.
-    end
-
     def compile_comment(comment)
       "" # Replace the content with an empty string.
     end

data/lib/curly/scanner.rb

@@ -1,4 +1,5 @@
 require 'strscan'
+require 'curly/syntax_error'
 
 module Curly
 
@@ -8,9 +9,9 @@ module Curly
   # until the end of the template is reached.
   #
   class Scanner
-    REFERENCE_REGEX = %r(\{\{[\w\.]+\}\})
-    COMMENT_REGEX = %r(\{\{!.*\}\})
-    COMMENT_LINE_REGEX = %r(\s*#{COMMENT_REGEX}\s*\n)
+    CURLY_START = /\{\{/
+    CURLY_END = /\}\}/
+    COMMENT_MARKER = /!/
 
     # Scans a Curly template for tokens.
     #
@@ -44,58 +45,41 @@ module Curly
     # Returns a two-element Array, the first element being the Symbol type of
     #   the token and the second being the String value.
     def scan_token
-      scan_reference ||
-        scan_comment_line ||
-        scan_comment ||
-        scan_text ||
-        scan_remainder
+      scan_curly || scan_text
     end
 
-    # Scans a reference token, if a reference is the next token in the template.
-    #
-    # Returns an Array representing the token, or nil if no reference token can
-    #   be found at the current position.
-    def scan_reference
-      if value = @scanner.scan(REFERENCE_REGEX)
-        # Return the reference name excluding "{{" and "}}".
-        [:reference, value[2..-3]]
+    def scan_curly
+      if @scanner.scan(CURLY_START)
+        scan_reference_or_comment or syntax_error!
       end
     end
 
-    # Scans a comment line token, if a comment line is the next token in the
-    # template.
-    #
-    # Returns an Array representing the token, or nil if no comment line token
-    #   can be found at the current position.
-    def scan_comment_line
-      if value = @scanner.scan(COMMENT_LINE_REGEX)
-        # Returns the comment excluding "{{!" and "}}".
-        [:comment_line, value[3..-4]]
+    def scan_reference_or_comment
+      if @scanner.scan(COMMENT_MARKER)
+        scan_comment
+      else
+        scan_reference
       end
     end
 
-    # Scans a comment token, if a comment is the next token in the template.
-    #
-    # Returns an Array representing the token, or nil if no comment token can
-    #   be found at the current position.
     def scan_comment
-      if value = @scanner.scan(COMMENT_REGEX)
-        # Returns the comment excluding "{{!" and "}}".
-        [:comment, value[3..-3]]
+      if value = scan_until_end_of_curly
+        [:comment, value]
+      end
+    end
+
+    def scan_reference
+      if value = scan_until_end_of_curly
+        [:reference, value]
       end
     end
 
-    # Scans a text token, if a text is the next token in the template.
-    #
-    # Returns an Array representing the token, or nil if no text token can
-    #   be found at the current position.
     def scan_text
-      if value = @scanner.scan_until(/\{\{/)
-        # Rewind the scanner until before the "{{"
+      if value = scan_until_start_of_curly
         @scanner.pos -= 2
-
-        # Return the text up until "{{".
-        [:text, value[0..-3]]
+        [:text, value]
+      else
+        scan_remainder
       end
     end
 
@@ -107,5 +91,21 @@ module Curly
         [:text, value]
       end
     end
+
+    def scan_until_start_of_curly
+      if value = @scanner.scan_until(CURLY_START)
+        value[0..-3]
+      end
+    end
+
+    def scan_until_end_of_curly
+      if value = @scanner.scan_until(CURLY_END)     
+        value[0..-3]
+      end
+    end
+
+    def syntax_error!
+      raise SyntaxError.new(@scanner.pos, @scanner.string)
+    end
   end
 end

data/lib/curly/syntax_error.rb

@@ -0,0 +1,14 @@
+module Curly
+  class SyntaxError < StandardError
+    def initialize(position, source)
+      @position, @source = position, source
+    end
+
+    def message
+      start = [@position - 8, 0].max
+      stop = [@position + 8, @source.length].min
+      snippet = @source[start..stop].strip
+      "invalid syntax near `#{snippet}` in template:\n\n#{@source}\n"
+    end
+  end
+end

data/spec/compiler_spec.rb

@@ -108,14 +108,6 @@ describe Curly::Compiler do
       evaluate("HELO{{! I'm a comment, yo }}WORLD").should == "HELOWORLD"
     end
 
-    it "removes comment lines from the output" do
-      evaluate(<<-CURLY.strip_heredoc).should == "HELO\nWORLD\n"
-        HELO
-        {{! I'm a comment }}
-        WORLD
-      CURLY
-    end
-
     it "does not execute arbitrary Ruby code" do
       evaluate('#{foo}').should == '#{foo}'
     end

data/spec/scanner_spec.rb

@@ -15,6 +15,12 @@ describe Curly::Scanner, ".scan" do
     ]
   end
 
+  it "allows references with whitespace" do
+    scan("{{ foo bar}}").should == [
+      [:reference, " foo bar"]
+    ]
+  end
+
   it "scans comments in the source" do
     scan("foo {{!bar}} baz").should == [
       [:text, "foo "],
@@ -23,11 +29,9 @@ describe Curly::Scanner, ".scan" do
     ]
   end
 
-  it "scans comment lines in the source" do
-    scan("foo\n{{!bar}}\nbaz").should == [
-      [:text, "foo\n"],
-      [:comment_line, "bar"],
-      [:text, "baz"]
+  it "allows newlines in comments" do
+    scan("{{!\nfoo\n}}").should == [
+      [:comment, "\nfoo\n"]
     ]
   end
 
@@ -49,6 +53,18 @@ describe Curly::Scanner, ".scan" do
     ]
   end
 
+  it "raises Curly::SyntaxError on unclosed references" do
+    ["{{", "{{yolo"].each do |template|
+      expect { scan(template) }.to raise_error(Curly::SyntaxError)
+    end
+  end
+
+  it "raises Curly::SyntaxError on unclosed comments" do
+    ["{{!", "{{! foo bar"].each do |template|
+      expect { scan(template) }.to raise_error(Curly::SyntaxError)
+    end
+  end
+
   def scan(source)
     Curly::Scanner.scan(source)
   end

data/spec/syntax_error_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe Curly::SyntaxError, "#message" do
+  it "includes the context of the error in the message" do
+    source = "I am a very bad error that has snuck in"
+    error = Curly::SyntaxError.new(13, source)
+    
+    error.message.should == <<-MESSAGE.strip_heredoc
+      invalid syntax near `a very bad error` in template:
+
+      I am a very bad error that has snuck in
+    MESSAGE
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: curly-templates
 version: !ruby/object:Gem::Version
-  version: 0.10.2
+  version: 0.11.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-11 00:00:00.000000000 Z
+date: 2013-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -123,6 +123,7 @@ files:
 - lib/curly/presenter.rb
 - lib/curly/railtie.rb
 - lib/curly/scanner.rb
+- lib/curly/syntax_error.rb
 - lib/curly/template_handler.rb
 - lib/generators/curly/controller/controller_generator.rb
 - lib/generators/curly/controller/templates/presenter.rb.erb
@@ -133,6 +134,7 @@ files:
 - spec/presenter_spec.rb
 - spec/scanner_spec.rb
 - spec/spec_helper.rb
+- spec/syntax_error_spec.rb
 - spec/template_handler_spec.rb
 homepage: https://github.com/zendesk/curly
 licenses:
@@ -150,7 +152,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1930897478710122249
+      hash: 1896340551249669380
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -168,5 +170,6 @@ test_files:
 - spec/generators/controller_generator_spec.rb
 - spec/presenter_spec.rb
 - spec/scanner_spec.rb
+- spec/syntax_error_spec.rb
 - spec/template_handler_spec.rb
 has_rdoc: