curly-templates 0.12.0 → 1.0.0rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a564172d0d4f15b3bae6c5f05579d5deb0fe845b
-  data.tar.gz: d28d0cf8d4998251a08d88fb13d3e44250a61a5c
+  metadata.gz: c1d51d31a9e02cb1bccbdac92afeee3faa5ae093
+  data.tar.gz: 08eb307eecf7be51a180cc11a257b3ad460d6fa6
 SHA512:
-  metadata.gz: 6b360305771e280435d7ad2cb0fd07cd982728223e83701af89411037c1f61926f02e0594aee6c7e696da369dae600dcd3aceb437fc82178d2250897bf8a8a67
-  data.tar.gz: 8a16c5647e0059ec808fc48e92a4f843530d4036b7a744cc6aef3f19d52ae149f6d20e27c327f215b4cb2df40522b32d97a1b88d7559f34c84fff6ad9a7f7fdd
+  metadata.gz: 62a6e70667b692c94e5b48dae4dffa84d49f096a8a34104dc827e4a5087f53df8a870b684cf106c606e6b208067ec233cf35ada8f9dfa580910ec1d55278472b
+  data.tar.gz: a07ef3ed26980e8751287a9a00770f32badd4c6fa3e1e50b16be83d23ae0cd3f17cbfd910add61050d780cee9e88abbf03a308c75d6c0d11058a3981d34173a4

data/CHANGELOG.md

@@ -1,5 +1,7 @@
 ### Unreleased
 
+### Curly 0.12.0 (December 3, 2013)
+
 * Allow Curly to output Curly syntax by using the `{{{ ... }}` syntax:
 
   ```

data/CONTRIBUTING.md

@@ -0,0 +1,17 @@
+In order to keep the Curly code base nice and tidy, please observe these best practises when making contributions:
+
+- Add tests for all your code. Make sure the tests are clear and fail with proper error messages. It's a good idea to let your test fail in order to review whether the message makes sense; then make the test pass.
+- Document any unclear things in the code. Even better, don't make the code do unclear things.
+- Use the coding style already present in the code base.
+- Make your commit messages precise and to the point. Add a short summary (50 chars max) followed by a blank line and then a longer description, if necessary, e.g.
+  
+  > Make invalid references raise an exception
+  >
+  > In order to avoid nasty errors when doing stuff, make the Curly compiler
+  > fail early when an invalid reference is encountered.
+
+
+Before making a contribution, you should make sure to understand what Curly is and isn't:
+
+- The template language will never be super advanced: one of the primary use cases for Curly is to allow end users to mess around with Curly templates and have them safely compiled and rendered on a server. As such, the template language will always be as simple as possible.
+- The template language is declarative, and is going to stay that way.

data/README.md

@@ -34,9 +34,11 @@ at Zendesk, where it performs admirably.
 
 1. [Installing](#installing)
 2. [How to use Curly](#how-to-use-curly)
+    1. [Conditional blocks](#conditional-blocks)
+    2. [Escaping Curly syntax](#escaping-curly-syntax)
 3. [Presenters](#presenters)
     1. [Layouts and Content Blocks](#layouts-and-content-blocks)
-    1. [Examples](#examples)
+    2. [Examples](#examples)
 4. [Caching](#caching)
 
 
@@ -71,6 +73,10 @@ Add some HTML to the partial template along with some Curly variables:
   </p>
 
   {{body}}
+
+  {{#author?}}
+    <a href="{{delete_url}}">delete comment</a>
+  {{/author?}}
 </div>
 ```
 
@@ -93,6 +99,10 @@ class Posts::CommentPresenter < Curly::Presenter
   def time_ago
     time_ago_in_words(@comment.created_at)
   end
+  
+  def author?
+    @comment.author == current_user
+  end
 end
 ```
 
@@ -105,9 +115,36 @@ render collection: post.comments
 ```
 
 
+### Conditional blocks
+
+If there is some content you only want rendered under specific circumstances, you can
+use _conditional blocks_. The `{{#admin?}}...{{/admin?}}` syntax will only render the
+content of the block if the `admin?` method on the presenter returns true, while the
+`{{^admin?}}...{{/admin?}}` syntax will only render the content if it returns false.
+
+Both forms can be parameterized by a single argument: `{{#locale.en?}}...{{/locale.en?}}`
+will only render the block if the `locale?` method on the presenter returns true given the
+argument `"en"`. Here's how to implement that method in the presenter:
+
+```ruby
+class SomePresenter < Curly::Presenter
+  # Allows rendering content only if the locale matches a specified identifier.
+  def locale?(identifier)
+    current_locale == identifier
+  end
+end
+```
+
+
 ### Escaping Curly syntax
 
-If you need to have `{{` rendered, you should use `{{{` in your Curly template.
+In order to have `{{` appear verbatim in the rendered HTML, use the triple Curly escape syntax:
+
+```
+This is {{{escaped}}.
+```
+
+You don't need to escape the closing `}}`.
 
 
 Presenters

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.12.0'
-  s.date              = '2013-12-03'
+  s.version           = '1.0.0rc1'
+  s.date              = '2014-02-18'
 
   s.summary     = "Free your views!"
   s.description = "A view layer for your Rails apps that separates structure and logic."
@@ -29,6 +29,7 @@ Gem::Specification.new do |s|
   # = MANIFEST =
   s.files = %w[
     CHANGELOG.md
+    CONTRIBUTING.md
     Gemfile
     README.md
     Rakefile
@@ -38,6 +39,10 @@ Gem::Specification.new do |s|
     lib/curly/compilation_error.rb
     lib/curly/compiler.rb
     lib/curly/dependency_tracker.rb
+    lib/curly/error.rb
+    lib/curly/incomplete_block_error.rb
+    lib/curly/incorrect_ending_error.rb
+    lib/curly/invalid_block_error.rb
     lib/curly/invalid_reference.rb
     lib/curly/presenter.rb
     lib/curly/railtie.rb

data/lib/curly.rb

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

data/lib/curly/compilation_error.rb

@@ -1,5 +1,7 @@
+require 'curly/error'
+
 module Curly
-  class CompilationError < StandardError
+  class CompilationError < Error
     attr_reader :path
 
     def initialize(path)

data/lib/curly/compiler.rb

@@ -1,5 +1,9 @@
 require 'curly/scanner'
+require 'curly/error'
 require 'curly/invalid_reference'
+require 'curly/invalid_block_error'
+require 'curly/incorrect_ending_error'
+require 'curly/incomplete_block_error'
 
 module Curly
 
@@ -30,7 +34,7 @@ module Curly
       compile(template, presenter_class)
 
       true
-    rescue InvalidReference
+    rescue Error
       false
     end
 
@@ -47,10 +51,16 @@ module Curly
 
       tokens = Scanner.scan(template)
 
+      @blocks = []
+
       parts = tokens.map do |type, value|
         send("compile_#{type}", value)
       end
 
+      if @blocks.any?
+        raise IncompleteBlockError.new(@blocks.pop)
+      end
+
       <<-RUBY
         buffer = ActiveSupport::SafeBuffer.new
         #{parts.join("\n")}
@@ -60,6 +70,47 @@ module Curly
 
     private
 
+    def compile_block_start(reference)
+      compile_conditional_block "if", reference
+    end
+
+    def compile_inverse_block_start(reference)
+      compile_conditional_block "unless", reference
+    end
+
+    def compile_conditional_block(keyword, reference)
+      m = reference.match(/\A(.+?)(?:\.(.+))?\?\z/)
+      method, argument = "#{m[1]}?", m[2]
+
+      @blocks.push reference
+
+      unless presenter_class.method_available?(method.to_sym)
+        raise Curly::InvalidReference.new(method.to_sym)
+      end
+
+      if presenter_class.instance_method(method).arity == 1
+        <<-RUBY
+          #{keyword} presenter.#{method}(#{argument.inspect})
+        RUBY
+      else
+        <<-RUBY
+          #{keyword} presenter.#{method}
+        RUBY
+      end
+    end
+
+    def compile_block_end(reference)
+      last_block = @blocks.pop
+
+      unless last_block == reference
+        raise Curly::IncorrectEndingError.new(reference, last_block)
+      end
+
+      <<-RUBY
+        end
+      RUBY
+    end
+
     def compile_reference(reference)
       method, argument = reference.split(".", 2)
 

data/lib/curly/error.rb

@@ -0,0 +1,4 @@
+module Curly
+  class Error < StandardError
+  end
+end

data/lib/curly/incomplete_block_error.rb

@@ -0,0 +1,11 @@
+module Curly
+  class IncompleteBlockError < Error
+    def initialize(reference)
+      @reference = reference
+    end
+
+    def message
+      "error compiling `{{##{@reference}}}`: conditional block must be terminated with `{{/#{@reference}}}}`"
+    end
+  end
+end

data/lib/curly/incorrect_ending_error.rb

@@ -0,0 +1,11 @@
+module Curly
+  class IncorrectEndingError < Error
+    def initialize(reference, last_block)
+      @reference, @last_block = reference, last_block
+    end
+
+    def message
+      "error compiling `{{##{@last_block}}}`: expected `{{/#{@last_block}}}`, got `{{/#{@reference}}}`"
+    end
+  end
+end

data/lib/curly/invalid_block_error.rb

@@ -0,0 +1,9 @@
+module Curly
+  class InvalidBlockError < Error
+    attr_reader :reference
+
+    def initialize(reference)
+      @reference = reference
+    end
+  end
+end

data/lib/curly/invalid_reference.rb

@@ -1,5 +1,5 @@
 module Curly
-  class InvalidReference < StandardError
+  class InvalidReference < Error
     attr_reader :reference
 
     def initialize(reference)

data/lib/curly/scanner.rb

@@ -15,6 +15,10 @@ module Curly
     ESCAPED_CURLY_START = /\{\{\{/
 
     COMMENT_MARKER = /!/
+    BLOCK_MARKER = /#/
+    INVERSE_BLOCK_MARKER = /\^/
+    END_BLOCK_MARKER = /\//
+
 
     # Scans a Curly template for tokens.
     #
@@ -59,13 +63,19 @@ module Curly
 
     def scan_curly
       if @scanner.scan(CURLY_START)
-        scan_reference_or_comment or syntax_error!
+        scan_tag or syntax_error!
       end
     end
 
-    def scan_reference_or_comment
+    def scan_tag
       if @scanner.scan(COMMENT_MARKER)
         scan_comment
+      elsif @scanner.scan(BLOCK_MARKER)
+        scan_block_start
+      elsif @scanner.scan(INVERSE_BLOCK_MARKER)
+        scan_inverse_block_start
+      elsif @scanner.scan(END_BLOCK_MARKER)
+        scan_block_end
       else
         scan_reference
       end
@@ -77,6 +87,24 @@ module Curly
       end
     end
 
+    def scan_block_start
+      if value = scan_until_end_of_curly
+        [:block_start, value]
+      end
+    end
+
+    def scan_inverse_block_start
+      if value = scan_until_end_of_curly
+        [:inverse_block_start, value]
+      end
+    end
+
+    def scan_block_end
+      if value = scan_until_end_of_curly
+        [:block_end, value]
+      end
+    end
+
     def scan_reference
       if value = scan_until_end_of_curly
         [:reference, value]

data/lib/curly/syntax_error.rb

@@ -1,5 +1,7 @@
+require 'curly/error'
+
 module Curly
-  class SyntaxError < StandardError
+  class SyntaxError < Error
     def initialize(position, source)
       @position, @source = position, source
     end

data/spec/compiler_spec.rb

@@ -15,6 +15,10 @@ describe Curly::Compiler do
         "#{yield :foo}, please?"
       end
 
+      def hello?(value)
+        value == "world"
+      end
+
       def unicorns
         "UNICORN"
       end
@@ -23,12 +27,21 @@ describe Curly::Compiler do
         nil
       end
 
+      def false?
+        false
+      end
+
+      def true?
+        true
+      end
+
       def parameterized(value)
         value
       end
 
       def self.method_available?(method)
-        [:foo, :parameterized, :high_yield, :yield_value, :dirty].include?(method)
+        [:foo, :parameterized, :high_yield, :yield_value, :dirty,
+          :false?, :true?, :hello?].include?(method)
       end
 
       def self.available_methods
@@ -108,6 +121,44 @@ describe Curly::Compiler do
       evaluate("HELO{{! I'm a comment, yo }}WORLD").should == "HELOWORLD"
     end
 
+    it "removes text in false blocks" do
+      evaluate("test{{#false?}}bar{{/false?}}").should == "test"
+    end
+
+    it "keeps text in true blocks" do
+      evaluate("test{{#true?}}bar{{/true?}}").should == "testbar"
+    end
+
+    it "removes text in inverse true blocks" do
+      evaluate("test{{^true?}}bar{{/true?}}").should == "test"
+    end
+
+    it "keeps kext in inverse false blocks" do
+      evaluate("test{{^false?}}bar{{/false?}}").should == "testbar"
+    end
+
+    it "passes an argument to blocks" do
+      evaluate("{{#hello.world?}}foo{{/hello.world?}}{{#hello.foo?}}bar{{/hello.foo?}}").should == "foo"
+    end
+
+    it "gives an error on mismatching blocks" do
+      expect do
+        evaluate("test{{#false?}}bar{{/true?}}")
+      end.to raise_exception(Curly::IncorrectEndingError)
+    end
+
+    it "gives an error on incomplete blocks" do
+      expect do
+        evaluate("test{{#false?}}bar")
+      end.to raise_exception(Curly::IncompleteBlockError)
+    end
+
+    it "gives an error on mismatching block ends" do
+      expect do
+        evaluate("{{#true?}}test{{#false?}}bar{{/true?}}{{/false?}}")
+      end.to raise_exception(Curly::IncorrectEndingError)
+    end
+
     it "does not execute arbitrary Ruby code" do
       evaluate('#{foo}').should == '#{foo}'
     end
@@ -127,6 +178,14 @@ describe Curly::Compiler do
       validate("Hello, {{inspect}}").should == false
     end
 
+    it "returns true with a block" do
+      validate("Hello {{#true?}}world{{/true?}}").should == true
+    end
+
+    it "returns false with an incomplete block" do
+      validate("Hello {{#true?}}world").should == false
+    end
+
     def validate(template)
       Curly.valid?(template, presenter_class)
     end

data/spec/presenter_spec.rb

@@ -19,28 +19,38 @@ describe Curly::Presenter do
     presents :elephant, default: "Babar"
   end
 
-  it "sets the presented parameters as instance variables" do
-    context = double("context")
+  class FancyCircusPresenter < CircusPresenter
+    presents :champagne
+  end
 
-    presenter = CircusPresenter.new(context,
-      midget: "Meek Harolson",
-      clown: "Bubbles"
-    )
+  describe "#initialize" do
+    let(:context) { double("context") }
 
-    presenter.midget.should == "Meek Harolson"
-    presenter.clown.should == "Bubbles"
-  end
+    it "sets the presented parameters as instance variables" do
+      presenter = CircusPresenter.new(context,
+        midget: "Meek Harolson",
+        clown: "Bubbles"
+      )
+
+      presenter.midget.should == "Meek Harolson"
+      presenter.clown.should == "Bubbles"
+    end
 
-  it "allows specifying default values for parameters" do
-    context = double("context")
+    it "raises an exception if a required parameter is not specified" do
+      expect {
+        FancyCircusPresenter.new(context, {})
+      }.to raise_exception(ArgumentError, "required parameter `champagne` missing")
+    end
 
-    # Make sure subclasses can change default values.
-    french_presenter = FrenchCircusPresenter.new(context)
-    french_presenter.elephant.should == "Babar"
+    it "allows specifying default values for parameters" do
+      # Make sure subclasses can change default values.
+      french_presenter = FrenchCircusPresenter.new(context)
+      french_presenter.elephant.should == "Babar"
 
-    # The subclass shouldn't change the superclass' defaults, though.
-    presenter = CircusPresenter.new(context)
-    presenter.elephant.should == "Dumbo"
+      # The subclass shouldn't change the superclass' defaults, though.
+      presenter = CircusPresenter.new(context)
+      presenter.elephant.should == "Dumbo"
+    end
   end
 
   describe ".presenter_for_path" do

data/spec/scanner_spec.rb

@@ -59,6 +59,24 @@ describe Curly::Scanner, ".scan" do
     ]
   end
 
+  it "scans block tags" do
+    scan('foo {{#bar}} hello {{/bar}}').should == [
+      [:text, "foo "],
+      [:block_start, "bar"],
+      [:text, " hello "],
+      [:block_end, "bar"]
+    ]
+  end
+
+  it "scans inverse block tags" do
+    scan('foo {{^bar}} hello {{/bar}}').should == [
+      [:text, "foo "],
+      [:inverse_block_start, "bar"],
+      [:text, " hello "],
+      [:block_end, "bar"]
+    ]
+  end
+
   it "treats quotes as text" do
     scan('"').should == [
       [:text, '"']

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: curly-templates
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 1.0.0rc1
 platform: ruby
 authors:
 - Daniel Schierbeck
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-03 00:00:00.000000000 Z
+date: 2014-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -99,6 +99,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
+- CONTRIBUTING.md
 - Gemfile
 - README.md
 - Rakefile
@@ -108,6 +109,10 @@ files:
 - lib/curly/compilation_error.rb
 - lib/curly/compiler.rb
 - lib/curly/dependency_tracker.rb
+- lib/curly/error.rb
+- lib/curly/incomplete_block_error.rb
+- lib/curly/incorrect_ending_error.rb
+- lib/curly/invalid_block_error.rb
 - lib/curly/invalid_reference.rb
 - lib/curly/presenter.rb
 - lib/curly/railtie.rb
@@ -141,12 +146,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 2
 summary: Free your views!