curly-templates 0.9.1 → 0.10.0

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 ### Unreleased
 
+### Curly 0.10.0 (July 11, 2013)
+
+* Allow comments in Curly templates using the `{{! ... }}` syntax:
+
+  ```
+  {{! This is a comment }}
+  ```
+
+  *Daniel Schierbeck*
+
 ### Curly 0.9.1 (June 20, 2013)
 
 * Better error handling. If a presenter class cannot be found, we not raise a

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.9.1'
-  s.date              = '2013-06-20'
+  s.version           = '0.10.0'
+  s.date              = '2013-07-11'
 
   s.summary     = "Free your views!"
   s.description = "A view layer for your Rails apps that separates structure and logic."
@@ -41,6 +41,7 @@ Gem::Specification.new do |s|
     lib/curly/invalid_reference.rb
     lib/curly/presenter.rb
     lib/curly/railtie.rb
+    lib/curly/scanner.rb
     lib/curly/template_handler.rb
     lib/generators/curly/controller/controller_generator.rb
     lib/generators/curly/controller/templates/presenter.rb.erb
@@ -49,6 +50,7 @@ Gem::Specification.new do |s|
     spec/compiler_spec.rb
     spec/generators/controller_generator_spec.rb
     spec/presenter_spec.rb
+    spec/scanner_spec.rb
     spec/spec_helper.rb
     spec/template_handler_spec.rb
   ]

data/lib/curly.rb

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

data/lib/curly/compiler.rb

@@ -1,64 +1,92 @@
+require 'curly/scanner'
 require 'curly/invalid_reference'
 
 module Curly
+
+  # Compiles Curly templates into executable Ruby code.
+  #
+  # A template must be accompanied by a presenter class. This class defines the
+  # references that are valid within the template.
+  #
   class Compiler
-    REFERENCE_REGEX = %r(\{\{([\w\.]+)\}\})
+    # Compiles a Curly template to Ruby code.
+    #
+    # template        - The template String that should be compiled.
+    # presenter_class - The presenter Class.
+    #
+    # Returns a String containing the Ruby code.
+    def self.compile(template, presenter_class)
+      new(template, presenter_class).compile
+    end
 
-    class << self
+    # Whether the Curly template is valid. This includes whether all
+    # references are available on the presenter class.
+    #
+    # template        - The template String that should be validated.
+    # presenter_class - The presenter Class.
+    #
+    # Returns true if the template is valid, false otherwise.
+    def self.valid?(template, presenter_class)
+      compile(template, presenter_class)
+
+      true
+    rescue InvalidReference
+      false
+    end
 
-      # Compiles a Curly template to Ruby code.
-      #
-      # template - The template String that should be compiled.
-      #
-      # Returns a String containing the Ruby code.
-      def compile(template, presenter_class)
-        if presenter_class.nil?
-          raise ArgumentError, "presenter class cannot be nil"
-        end
+    attr_reader :template, :presenter_class
 
-        source = template.inspect
-        source.gsub!(REFERENCE_REGEX) { compile_reference($1, presenter_class) }
+    def initialize(template, presenter_class)
+      @template, @presenter_class = template, presenter_class
+    end
 
-        source
+    def compile
+      if presenter_class.nil?
+        raise ArgumentError, "presenter class cannot be nil"
       end
 
-      # Whether the Curly template is valid. This includes whether all
-      # references are available on the presenter class.
-      #
-      # template        - The template String that should be validated.
-      # presenter_class - The presenter Class.
-      #
-      # Returns true if the template is valid, false otherwise.
-      def valid?(template, presenter_class)
-        compile(template, presenter_class)
-
-        true
-      rescue InvalidReference
-        false
+      tokens = Scanner.scan(template)
+
+      parts = tokens.map do |type, value|
+        send("compile_#{type}", value)
       end
 
-      private
+      parts.join(" << ")
+    end
 
-      def compile_reference(reference, presenter_class)
-        method, argument = reference.split(".", 2)
+    private
 
-        unless presenter_class.method_available?(method.to_sym)
-          raise Curly::InvalidReference.new(method.to_sym)
-        end
+    def compile_reference(reference)
+      method, argument = reference.split(".", 2)
 
-        if presenter_class.instance_method(method).arity == 1
-          # The method accepts a single argument -- pass it in.
-          code = <<-RUBY
-            presenter.#{method}(#{argument.inspect}) {|*args| yield(*args) }
-          RUBY
-        else
-          code = <<-RUBY
-            presenter.#{method} {|*args| yield(*args) }
-          RUBY
-        end
+      unless presenter_class.method_available?(method.to_sym)
+        raise Curly::InvalidReference.new(method.to_sym)
+      end
 
-        '#{ERB::Util.html_escape(%s)}' % code.strip
+      if presenter_class.instance_method(method).arity == 1
+        # The method accepts a single argument -- pass it in.
+        code = <<-RUBY
+          presenter.#{method}(#{argument.inspect}) {|*args| yield(*args) }
+        RUBY
+      else
+        code = <<-RUBY
+          presenter.#{method} {|*args| yield(*args) }
+        RUBY
       end
+
+      'ERB::Util.html_escape(%s)' % code.strip
+    end
+
+    def compile_text(text)
+      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
   end
 end

data/lib/curly/scanner.rb

@@ -0,0 +1,111 @@
+require 'strscan'
+
+module Curly
+
+  # Scans Curly templates for tokens.
+  #
+  # The Scanner goes through the template piece by piece, extracting tokens
+  # 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)
+
+    # Scans a Curly template for tokens.
+    #
+    # source - The String source of the template.
+    #
+    # Example
+    #
+    #   Curly::Scanner.scan("hello {{name}}!")
+    #   #=> [[:text, "hello "], [:reference, "name"], [:text, "!"]]
+    #
+    # Returns an Array of type/value pairs representing the tokens in the
+    #   template.
+    def self.scan(source)
+      new(source).scan
+    end
+
+    def initialize(source)
+      @scanner = StringScanner.new(source)
+    end
+
+    def scan
+      tokens = []
+      tokens << scan_token until @scanner.eos?
+      tokens
+    end
+
+    private
+
+    # Scans the next token in the template.
+    #
+    # 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
+    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]]
+      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]]
+      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]]
+      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 "{{"
+        @scanner.pos -= 2
+
+        # Return the text up until "{{".
+        [:text, value[0..-3]]
+      end
+    end
+
+    # Scans the remainder of the template and treats it as a text token.
+    #
+    # Returns an Array representing the token, or nil if no text is remaining.
+    def scan_remainder
+      if value = @scanner.scan(/.+/m)
+        [:text, value]
+      end
+    end
+  end
+end

data/spec/compiler_spec.rb

@@ -94,6 +94,22 @@ describe Curly::Compiler do
       presenter.stub(:dirty) { "<p>dirty</p>".html_safe }
       evaluate("{{dirty}}").should == "<p>dirty</p>"
     end
+
+    it "removes comments from the output" 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
   end
 
   describe ".valid?" do

data/spec/scanner_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe Curly::Scanner, ".scan" do
+  it "returns the tokens in the source" do
+    scan("foo {{bar}} baz").should == [
+      [:text, "foo "],
+      [:reference, "bar"],
+      [:text, " baz"]
+    ]
+  end
+
+  it "scans parameterized references" do
+    scan("{{foo.bar}}").should == [
+      [:reference, "foo.bar"]
+    ]
+  end
+
+  it "scans comments in the source" do
+    scan("foo {{!bar}} baz").should == [
+      [:text, "foo "],
+      [:comment, "bar"],
+      [:text, " baz"]
+    ]
+  end
+
+  it "scans comment lines in the source" do
+    scan("foo\n{{!bar}}\nbaz").should == [
+      [:text, "foo\n"],
+      [:comment_line, "bar"],
+      [:text, "baz"]
+    ]
+  end
+
+  it "scans to the end of the source" do
+    scan("foo\n").should == [
+      [:text, "foo\n"]
+    ]
+  end
+
+  it "treats quotes as text" do
+    scan('"').should == [
+      [:text, '"']
+    ]
+  end
+
+  it "treats Ruby interpolation as text" do
+    scan('#{foo}').should == [
+      [:text, '#{foo}']
+    ]
+  end
+
+  def scan(source)
+    Curly::Scanner.scan(source)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: curly-templates
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.10.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-20 00:00:00.000000000 Z
+date: 2013-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -122,6 +122,7 @@ files:
 - lib/curly/invalid_reference.rb
 - lib/curly/presenter.rb
 - lib/curly/railtie.rb
+- lib/curly/scanner.rb
 - lib/curly/template_handler.rb
 - lib/generators/curly/controller/controller_generator.rb
 - lib/generators/curly/controller/templates/presenter.rb.erb
@@ -130,6 +131,7 @@ files:
 - spec/compiler_spec.rb
 - spec/generators/controller_generator_spec.rb
 - spec/presenter_spec.rb
+- spec/scanner_spec.rb
 - spec/spec_helper.rb
 - spec/template_handler_spec.rb
 homepage: https://github.com/zendesk/curly
@@ -148,7 +150,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3388653685709819519
+      hash: 4015061898851795676
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -165,5 +167,6 @@ test_files:
 - spec/compiler_spec.rb
 - spec/generators/controller_generator_spec.rb
 - spec/presenter_spec.rb
+- spec/scanner_spec.rb
 - spec/template_handler_spec.rb
 has_rdoc: