bldr 0.3.0 → 0.5.2

data/.rvmrc

@@ -1 +1 @@
-rvm 1.9.2
+rvm 1.9.3

data/HISTORY.md

@@ -1,3 +1,6 @@
+## 0.5.0 (2012-02-08)
+* Add support "partials" (@ihunter)
+
 ## 0.2.0 (2011-09-09)
 * Add new `attribute` inferred object syntax (@ihunter)
 

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2011 Alex Sharp
+Copyright (c) 2011-2012 Alex Sharp
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -9,11 +9,19 @@ the box -- Rails 3 support is planned for the near future.
 
 If you would like to contribute, pull requests with specs are warmly accepted :)
 
+## Why
+
+If you're building an API, `Model#to_json` just doesn't cut it. Besides the JSON
+representation of your models arguably being a presentation concern, trying
+to cram all of this logic into an `#as_json` method quickly turns into pure chaos.
+
+There are other json templating libraries available -- [rabl](http://github.com/nesquena/rabl) being the most popular -- but I wasn't satisfied with any of the DSL's, so I created Bldr.
+
 ## Features
 
 * Simple json templating DSL
-* Uses Tilt's built-in rendering and template caching for better
-  performance
+* Uses Tilt's built-in rendering and template caching for better performance
+* Partials
 
 ## Installation
 
@@ -42,271 +50,7 @@ end
 
 ## Usage
 
-In your sinatra endpoints/actions, use the `bldr` helper method to
-render templates.
-
-```ruby
-get "/posts" do
-  # ...
-  posts = Post.all
-  bldr :'template.json', :locals => {:posts => posts}
-end
-
-# views/template.json.bldr
-collection :posts => posts do
-  attributes :title
-  attribute :comment_count { |post| post.comments.count }
-
-  collection :comments => current_object.comments do
-    attributes :body, :author, :email
-  end
-end
-```
-
-## Examples
-
-### Rendering a basic object
-
-```ruby
-object do
-  attribute :title, "my title"
-end
-```
-
-Output:
-
-```javascript
-{
-  "title": "my title"
-}
-```
-
-### Rendering a simple list of attributes
-
-```ruby
-object :post do
-  attribute :title, "my title"
-end
-```
-
-Output:
-
-```javascript
-{
-  "post": {
-    "title": "my title"
-  }
-}
-```
-
-### Rendering a simple list of attributes from an object
-
-```ruby
-object :post => post do
-  attributes :title, :body
-end
-```
-
-Output:
-
-```javascript
-{
-  "post": {
-    "title": "my title",
-    "body": "..."
-  }
-}
-```
-
-### Dynamic attributes
-
-```ruby
-object :post => post do
-  attribute :comment_count do |post|
-    post.comments.count
-  end
-end
-```
-
-Output:
-
-```javascript
-{
-  "post": {
-    "comment_count": 1
-  }
-}
-
-```
-
-### Attribute aliases
-
-```ruby
-object :post => post do
-  attributes :title, :body
-
-  object :author => post.author do
-    attribute :surname => :last_name
-  end
-end
-```
-
-Output:
-
-```javascript
-{
-  "post": {
-    "title": "my title",
-    "body": "...",
-    "author": {
-      "surname": "Doe"
-    }
-  }
-}
-```
-
-### Nested objects
-
-```ruby
-object :post => post do
-  attributes :title, :body
-
-  object :author => post.author do
-    attributes :first_name, :last_name, :email
-
-    attribute(:full_name) { |author| "#{author.first_name} #{author.last_name}" }
-  end
-end
-```
-
-Output:
-
-```javascript
-{
-  "post": {
-    "title": "my title",
-    "body": "...",
-    "author": {
-      "first_name": "John",
-      "last_name": "Doe",
-      "email": "john@doe.com",
-      "full_name": "John Doe"
-    }
-  }
-}
-```
-
-### Root-level attributes
-
-```ruby
-get '/redirector' do
-  url = params['redirect_url']
-  bldr :'redirect.json', :locals => {:url => url}
-end
-
-# views/redirect.json.bldr
-object do
-  attribute(:redirect_to) { url }
-end
-```
-
-Output:
-
-```javascript
-{"redirect_to": "http://example.org"}
-```
-
-### Collections
-
-All the examples above can be used inside a collection block. Here we
-assume a Post model which has many Comments. You might use the below
-code to render an action which returns a collection of posts, where
-each post has a collection of comments.
-
-```ruby
-collection :posts => posts do
-  attributes :title
-  attribute :comment_count { |post| post.comments.count }
-
-  # current_object
-  collection :comments => current_object.comments do
-    attributes :body, :author_name, :author_email
-  end
-end
-```
-
-Output:
-
-```javascript
-{
-  "posts": [
-    {
-      "title": "my title",
-        "comment_count": 2,
-        "comments": [
-          {
-            "body": "...",
-            "author_name": "Comment Troll",
-            "email": "troll@trolling.edu"
-          },
-          {
-            "body": "...",
-            "author_name": "Uber Troll",
-            "email": "uber.troll@earthlink.net"
-          }
-        ]
-    }
-  ]
-}
-```
-
-When inside of a collection block, you can use the `current_object`
-method to access the member of the collection currently being iterated
-over. This allows you to do nested collections, as in the example above.
-
-### Templates
-
-It is recommended to name your templates with the content type extension before
-the .bldr extension. For example: `my_template.json.bldr`.
-
-The templates themselves are just plain ruby code. They are evaluated in the context of a
-`Bldr::Node` instance, which provides the bldr DSL. The DSL is comprised
-primarily of 3 simple methods:
-
-+ `object` - Creates an object
-+ `collection` - Iterates over a collection of objects
-+ `attributes` - Add attributes to the current object.
-
-### Local Variables
-
-You may pass local variables from your sinatra actions to bldr templates
-by passing the `bldr` method a `:locals` hash, like so:
-
-```ruby
-get '/posts' do
-  posts = Post.all.recent
-
-  bldr :'posts/index.json', :locals => {:posts => posts}
-end
-```
-
-### Custom Handlers
-
-Bldr supports the definition of custom handlers, based on the class of specific
-values in the result. You would make use of this to define how specific classes
-are rendered by Bldr at a global level.
-
-For example, the `BSON::ObjectId` class defines `to_json` and `as_json` methods
-that produce a result like the following: `{"$oid": "4e77a682364141ecf5000002"}`.
-If you wanted to over-ride this default format, you could do so by defining a
-custom handler:
-
-```ruby
-# place in a file that get's loaded before your application code
-Bldr.handler BSON::ObjectId do |val|
-  val.to_s # => "4e77a682364141ecf5000002"
-end
-```
+See the [Documentation & Examples](https://github.com/ajsharp/bldr/wiki/Documentation-&-Examples) page on the wiki.
 
 ## Editor Syntax Support
 
@@ -318,20 +62,21 @@ au BufRead,BufNewFile *.bldr set filetype=ruby
 
 ## TODO
 
-* Rails 3 support
+* Rails 3 support.  An attempt for this was made for this but was reverted in e1cfd7fcbe130b316d95773d8c73ece4e247200e.  Feel free to take a shot.
 * Replace current_object with a block param for collection methods
 * XML support
 
 ## Acknowledgements
 
 * [RABL](http://github.com/nesquena/rabl) - Inspiration
-* [Tilt](https://github.com/rtomayko/tilt) - Mega awesome goodness
+* [Tilt](https://github.com/rtomayko/tilt) - Mega awesome templating goodness
 
 ## Contributors
 
 * Ian Hunter (@ihunter)
+* Justin Smestad (@jsmestad)
 
 ## Copyright
 
-Copyright (c) 2011 Alex Sharp. See the MIT-LICENSE file for full
+Copyright (c) 2011-2012 Alex Sharp. See the MIT-LICENSE file for full
 copyright information.

data/bldr.gemspec

@@ -24,5 +24,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'json_pure'
   s.add_development_dependency 'sinatra',   '~>1.2.6'
   s.add_development_dependency 'tilt',      '~>1.3.2'
-  s.add_development_dependency 'yajl-ruby'
+  s.add_development_dependency 'yajl-ruby', '>= 1.0'
+  s.add_development_dependency 'actionpack', '~> 3.0.7'
 end

data/lib/bldr.rb

@@ -1,11 +1,17 @@
-
 $:.unshift(File.dirname(File.expand_path(__FILE__)))
 
+begin
+  require 'tilt'
+rescue LoadError
+end
+
 require 'multi_json'
-require 'bldr/engine'
-require 'bldr/template'
 require 'bldr/node'
 
+if defined?(Tilt)
+  require 'bldr/template'
+end
+
 module Bldr
   class << self
 

data/lib/bldr/node.rb

@@ -3,7 +3,7 @@ module Bldr
 
   class Node
 
-    attr_reader :current_object, :result, :parent
+    attr_reader :current_object, :result, :parent, :opts, :views
 
     # Initialize a new Node instance.
     #
@@ -19,28 +19,15 @@ module Bldr
     # @param [Object] value an object to serialize.
     def initialize(value = nil, opts = {}, &block)
       @current_object = value
+      @opts           = opts
       @parent         = opts[:parent]
-
+      @views          = opts[:views]
       # Storage hash for all descendant nodes
       @result  = {}
 
       instance_eval(&block) if block_given?
     end
-
-    # Merge the local results into the ancestor result hash.
-    #
-    # @return [Hash]
-    def render!
-      result
-    end
-
-    # Return the json-encoded result hash.
-    #
-    # @return [String] the json-encoded result hash
-    def to_json
-      MultiJson.encode(result)
-    end
-
+    
     # Create and render a node.
     #
     # @example A keyed object
@@ -84,23 +71,36 @@ module Bldr
         value = nil
       end
 
-      node  = Node.new(value, :parent => self, &block)
-      merge_result!(key, node.render!)
-      self.to_json
+      return nil if value.nil? and base.kind_of? Hash
+      node  = Node.new(value, opts.merge(:parent => self), &block)
+      merge_result!(key, node.result)
+      
+      self
     end
 
     def collection(items, &block)
-      key   = items.keys.first
-      values = items.values.to_a.first
 
-      vals = if values
-        values.map{|item| Node.new(item, :parent => self, &block).render!}
+      if items.respond_to?('keys')
+        key = items.keys.first
+        values = items.values.to_a.first
       else
-        []
+        key = nil
+        values = items
       end
-      merge_result! key, vals
+      
+      vals = if values
+               values.map{|item| Node.new(item, opts.merge(:parent => self), &block).result}
+             else
+               []
+             end
 
-      self.to_json
+      if items.respond_to?('keys')
+        merge_result! key, vals
+      else
+        @result = massage_value(vals)
+      end
+        
+      self
     end
 
     # Add attributes to the result hash in a variety of ways
@@ -138,7 +138,10 @@ module Bldr
     #
     # @return [Nil]
     def attributes(*args, &block)
-      raise(ArgumentError, "You cannot use #attributes when inferred object is not present.") if current_object.nil?
+      if current_object.nil?
+        raise(ArgumentError, "No current_object to apply #attributes to.")
+      end
+
       args.each do |arg|
         if arg.is_a?(Hash)
           merge_result!(arg.keys.first, current_object.send(arg.values.first))
@@ -146,18 +149,17 @@ module Bldr
           merge_result!(arg, current_object.send(arg))
         end
       end
-      nil
     end
 
     def attribute(*args,&block)
       if block_given?
         raise(ArgumentError, "You may only pass one argument to #attribute when using the block syntax.") if args.size > 1
-        raise(ArgumentError, "You cannot use a block of arity > 0 if inferred object is not present.") if block.arity > 0 and current_object.nil?
+        raise(ArgumentError, "You cannot use a block of arity > 0 if current_object is not present.") if block.arity > 0 and current_object.nil?
         merge_result!(args.first, (block.arity == 1) ? block.call(current_object) : current_object.instance_eval(&block))
       else
         case args.size
         when 1 # inferred object
-          raise(ArgumentError, "You cannot pass one argument to #attribute when inferred object is not present.") if current_object.nil?
+          raise(ArgumentError, "#attribute can't be used when there is no current_object.") if current_object.nil?
           if args[0].is_a?(Hash)
             merge_result!(args[0].keys.first, current_object.send(args[0].values.first))
           else
@@ -169,10 +171,33 @@ module Bldr
           raise(ArgumentError, "You cannot pass more than two arguments to #attribute.")
         end
       end
-      nil
+    end
+
+    # Render a template inline within a view
+    #
+    # @example Simple render
+    #   object :person => dude do
+    #     template "path/to/template"
+    #   end
+    # 
+    # @example Using locals
+    #   object :person => dude do
+    #     template "path/to/template", :locals => {:foo => 'bar'}
+    #   end
+    def template(template,options={})
+      locals = options[:locals] || options['locals']
+      merge_result! nil, Bldr::Template.new(find_template(template)).render(self, locals).result
     end
 
     private
+    
+    def find_template(template)
+      path = []
+      path << views if views
+      template += ".json.bldr" unless template =~ /\.json\.bldr$/
+      path << template
+      File.join(*path)
+    end
 
     # Merges values into the "local" result hash.
     def merge_result!(key, val)
@@ -183,10 +208,6 @@ module Bldr
       end
     end
 
-    def append_result!(key, val)
-      result[key] << massage_value(val)
-    end
-
     # put any specializations in here
     # @todo: add config handlers to specify your own overridable Class->lambda methods of serialization
     def massage_value(val)
@@ -196,6 +217,6 @@ module Bldr
         val
       end
     end
-
+    
   end
 end

data/lib/bldr/template.rb

@@ -3,8 +3,8 @@ require 'tilt'
 module Bldr
 
   class Template < Tilt::Template
-    # attr_reader :engine
-    # self.default_mime_type = 'application/json'
+
+    self.default_mime_type = 'application/json'
 
     def initialize_engine
       require_template_library 'bldr'
@@ -15,13 +15,12 @@ module Bldr
     end
 
     def prepare
-      @engine = Bldr::Engine.new(data, options)
+      # We get NotImplementedError by Tilt when we don't have this method
     end
 
     def precompiled_template(locals)
       data.to_s
     end
-
   end
 
   Tilt.register 'bldr', Bldr::Template

data/lib/bldr/version.rb

@@ -1,4 +1,4 @@
 
 module Bldr
-  VERSION = '0.3.0'
+  VERSION = '0.5.2'
 end

data/lib/sinatra/bldr.rb

@@ -5,18 +5,30 @@ module Sinatra
   module Bldr
     module Helpers
 
+      # Wrapper for Tilt's `render` method
+      #
+      # We use this to properly set the scope the template gets rendered
+      # within to a `Bldr::Node` object and pass in local variables.
+      #
       # @param [String, Symbol] template the template to render
       #   Can be a relative file location or a string template.
       #   The template may also be passed in as the block argument
       #   to this method, in which case, template argument is nil.
       #
+      # @example Render a template in a file
+      #   get '/users/:id' do
+      #     user = User.find(params['id'])
+      #     bldr :'users/public.bldr', :locals => {:user => user}
+      #   end
+      #
       # @param [Hash] opts a hash of options
       # @option opts [Hash] :locals a hash of local variables to be used in the template
       # @option
       def bldr(template, opts = {}, &block)
-        opts[:scope] = ::Bldr::Node.new
+        opts[:scope] = ::Bldr::Node.new(nil,opts.merge(:views => (settings.views || "./views")))
         locals = opts.delete(:locals)
-        render(:bldr, template, opts, locals, &block)
+        MultiJson.encode render(:bldr, template, opts, locals, &block).result    
+        # @todo add support for alternate formats, like plist
       end
     end
 

data/spec/fixtures/partial.json.bldr

@@ -0,0 +1,3 @@
+object do
+  attribute(:foo) { "bar" }
+end

data/spec/fixtures/partial_with_locals.json.bldr

@@ -0,0 +1,3 @@
+object :name => obj do
+  attribute :foo
+end

data/spec/fixtures/some/include.json.bldr

@@ -0,0 +1,3 @@
+object do
+  attribute(:foo) { "bar" }
+end

data/spec/functional/handlers_spec.rb

@@ -8,12 +8,12 @@ describe "Defining different types of handlers" do
         "bar"
       end
 
-      output = "{\"foo\":\"bar\"}"
+      output = {:foo => 'bar'}
       node = Bldr::Node.new do
         object { attribute(:foo) { Time.now } }
       end
 
-      node.to_json.should == output
+      node.result.should == output
     end
   end
 

data/spec/functional/tilt_template_spec.rb

@@ -10,7 +10,7 @@ describe "evaluating a tilt template" do
     alex.name = 'alex'
 
     tpl = Bldr::Template.new { "object(:person => alex) { attribute(:name) }" }
-    tpl.render(Bldr::Node.new, :alex => alex).should == jsonify({:person => {:name => 'alex'}})
+    tpl.render(Bldr::Node.new, :alex => alex).result.should == {:person => {:name => 'alex'}}
   end
 
   it "works when render two top-level objects" do
@@ -24,11 +24,11 @@ describe "evaluating a tilt template" do
       RUBY
     }
 
-    result = tpl.render(Bldr::Node.new, :alex => alex, :john => john)
-    result.should == jsonify({
+    result = tpl.render(Bldr::Node.new, :alex => alex, :john => john).result
+    result.should == {
       :person_1 => {:name => 'alex'},
       :person_2 => {:name => 'john'}
-    })
+    }
   end
 
   it "renders nil -> null correctly" do
@@ -38,8 +38,8 @@ describe "evaluating a tilt template" do
         object(:person_1 => alex) { attributes(:age) }
       RUBY
     }
-    result = tpl.render(Bldr::Node.new, :alex => alex)
-    result.should == %%{"person_1":{"age":null}}%
+    result = tpl.render(Bldr::Node.new, :alex => alex).result
+    result.should == {:person_1 => {:age => nil}}
   end
 
   describe "root Object nodes" do
@@ -55,8 +55,8 @@ describe "evaluating a tilt template" do
           end
         RUBY
       }
-      result = tpl.render(Bldr::Node.new, :alex => alex, :ian => ian)
-      parse_json(result).should == {'person' => {'name' => 'alex', 'age' => 25}}
+      result = tpl.render(Bldr::Node.new, :alex => alex, :ian => ian).result
+      result.should == {:person => {:name => 'alex', :age => 25}}
     end
 
     it "returns json for root object templates with nested collections" do
@@ -71,9 +71,9 @@ describe "evaluating a tilt template" do
           end
         RUBY
       }
-      result = tpl.render(Bldr::Node.new, :alex => alex, :friends => [ian])
-      parse_json(result).should == {
-        'person'=> {'name' => 'alex', 'age' => 25, 'friends' => [{'name' => 'ian', 'age' => 32}]}
+      result = tpl.render(Bldr::Node.new, :alex => alex, :friends => [ian]).result
+      result.should == {
+        :person=> {:name => 'alex', :age => 25, :friends => [{:name => 'ian', :age => 32}]}
       }
     end
 
@@ -86,8 +86,8 @@ describe "evaluating a tilt template" do
           end
         RUBY
       }
-      result = tpl.render(Bldr::Node.new, :alex => alex)
-      result.should == %%{"person_1":{"age":null}}%
+      result = tpl.render(Bldr::Node.new, :alex => alex).result
+      result.should == {:person_1 => {:age => nil}}
     end
 
   end
@@ -105,9 +105,9 @@ describe "evaluating a tilt template" do
           end
         RUBY
       }
-      result = tpl.render(Bldr::Node.new, :people => [alex,ian])
-      parse_json(result).should == {
-        'people'=> [{'name' => 'alex', 'age' => 25},{'name' => 'ian', 'age' => 32}]
+      result = tpl.render(Bldr::Node.new, :people => [alex,ian]).result
+      result.should == {
+        :people => [{:name => 'alex', :age => 25}, {:name => 'ian', :age => 32}]
       }
     end
 
@@ -122,16 +122,16 @@ describe "evaluating a tilt template" do
           end
         RUBY
       }
-      result = tpl.render(Bldr::Node.new, :people => [alex,ian])
-      parse_json(result).should == {
-        'people'=> [{
-          'name' => 'alex',
-          'age' => 25,
-          "friends" => [{"name" => 'bo', "age" => 33}]
+      result = tpl.render(Bldr::Node.new, :people => [alex,ian]).result
+      result.should == {
+        :people=> [{
+          :name => 'alex',
+          :age => 25,
+          :friends => [{:name => 'bo', :age => 33}]
         },{
-          'name' => 'ian',
-          'age' => 32,
-          "friends" => [{"name" => 'eric', "age" => 34}]
+          :name => 'ian',
+          :age => 32,
+          :friends => [{:name => 'eric', :age => 34}]
         }]
       }
     end

data/spec/unit/node_spec.rb

@@ -1,10 +1,10 @@
 require 'spec_helper'
 
 ERROR_MESSAGES = { :attribute_lambda_one_argument              => "You may only pass one argument to #attribute when using the block syntax.",
-                   :attribute_inferred_missing_one_argument    => "You cannot pass one argument to #attribute when inferred object is not present.",
+                   :attribute_inferred_missing_one_argument    => "#attribute can't be used when there is no current_object.",
                    :attribute_more_than_two_arg                => "You cannot pass more than two arguments to #attribute.",
-                   :attribute_inferred_missing_arity_too_large => "You cannot use a block of arity > 0 if inferred object is not present.",
-                   :attributes_inferred_missing                => "You cannot use #attributes when inferred object is not present." }
+                   :attribute_inferred_missing_arity_too_large => "You cannot use a block of arity > 0 if current_object is not present.",
+                   :attributes_inferred_missing                => "No current_object to apply #attributes to." }
 
 describe "Node#object" do
 
@@ -52,7 +52,7 @@ describe "Node#object" do
       end
       it "renders 2 arguments statically" do
         node = wrap { attribute(:name, "alex") }
-        node.render!.should == {:name => 'alex'}
+        node.result.should == {:name => 'alex'}
       end
       it "renders 1 argument and one lambda with zero arity" do
         node = wrap {
@@ -60,7 +60,7 @@ describe "Node#object" do
             "alex"
           end
         }
-        node.render!.should == {:name => 'alex'}
+        node.result.should == {:name => 'alex'}
       end
       it "errors on 1 argument and one lambda with arity 1" do
         expect {
@@ -73,7 +73,7 @@ describe "Node#object" do
       end
       it "should render null attributes to null, not 'null'" do
         node = wrap { attribute(:name, nil) }
-        node.render!.should == {:name => nil}
+        node.result.should == {:name => nil}
       end
 
     end
@@ -136,7 +136,7 @@ describe "Node#object" do
       end
       it "renders 2 arguments statically" do
         node = wrap { attribute(:name, "alex") }
-        node.render!.should == {:person => {:name => 'alex'}}
+        node.result.should == {:person => {:name => 'alex'}}
       end
       it "renders 1 argument and one lambda with zero arity" do
         node = wrap {
@@ -144,7 +144,7 @@ describe "Node#object" do
             "alex"
           end
         }
-        node.render!.should == {:person => {:name => 'alex'}}
+        node.result.should == {:person => {:name => 'alex'}}
       end
       it "errors on 1 argument and one lambda with arity 1" do
         expect {
@@ -200,23 +200,23 @@ describe "Node#object" do
       end
       it "renders 1 argument to the inferred object" do
         node = wrap { attribute(:name) }
-        node.render!.should == {:person => {:name => 'alex'}}
+        node.result.should == {:person => {:name => 'alex'}}
       end
       it "renders 1 argument hash to the inferred object as the different key" do
         node = wrap { attribute(:fake => :name) }
-        node.render!.should == {:person => {:fake => 'alex'}}
+        node.result.should == {:person => {:fake => 'alex'}}
       end
       it "renders 2 arguments statically" do
         node = wrap { attribute(:name, "ian") }
-        node.render!.should == {:person => {:name => 'ian'}}
+        node.result.should == {:person => {:name => 'ian'}}
       end
       it "renders 1 argument and one lambda with zero arity" do
         node = wrap { attribute(:name){"ian"} }
-        node.render!.should == {:person => {:name => 'ian'}}
+        node.result.should == {:person => {:name => 'ian'}}
       end
       it "renders 1 argument and one lambda with arity 1" do
         node = wrap { attribute(:name){|person| person.name} }
-        node.render!.should == {:person => {:name => 'alex'}}
+        node.result.should == {:person => {:name => 'alex'}}
       end
       it "renders nil attributes" do
         node = node_wrap do
@@ -225,15 +225,14 @@ describe "Node#object" do
           end
         end
 
-        node.render!.should == {:person => {:age => nil}}
+        node.result.should == {:person => {:age => nil}}
       end
 
     end
 
     describe "#attributes" do
-
-      it "errors if the current_object is nil" do
-        expect {
+      describe "when an object key is passed a null value" do
+        subject {
           node = node_wrap do
             object(:person => nil) do
               attributes(:one, :two) do |person|
@@ -241,11 +240,20 @@ describe "Node#object" do
               end
             end
           end
-        }.to raise_error(ArgumentError, ERROR_MESSAGES[:attributes_inferred_missing])
+        }
+
+        it "does not raise an inferred object error" do
+          expect {
+            subject
+          }.not_to raise_error(ArgumentError, ERROR_MESSAGES[:attributes_inferred_missing])
+        end
+
+        its(:result) { should == {} }
       end
+
       it "renders each argument against the inferred object" do
         node = wrap { attributes(:name, :age) }
-        node.render!.should == {:person => {:name => 'alex', :age => 25}}
+        node.result.should == {:person => {:name => 'alex', :age => 25}}
       end
       it "renders nil attributes" do
         node = node_wrap do
@@ -254,7 +262,7 @@ describe "Node#object" do
           end
         end
 
-        node.render!.should == {:person => {:name => 'alex', :age => nil}}
+        node.result.should == {:person => {:name => 'alex', :age => nil}}
       end
 
     end
@@ -263,26 +271,25 @@ describe "Node#object" do
 
   describe "embedded objects" do
     it "evaluates the block and returns json" do
-      node = Bldr::Node.new
-      result = node.object(:dude => Person.new("alex")) do
-        attributes :name
-
-        object(:bro => Person.new("john")) do
+      node = node_wrap do
+        object(:dude => Person.new("alex")) do
           attributes :name
+
+          object(:bro => Person.new("john")) do
+            attributes :name
+          end
         end
       end
 
-      result.should == jsonify({
-        :dude => {:name => 'alex', :bro => {:name => 'john'}}
-      })
+      node.result.should == {:dude => {:name => 'alex', :bro => {:name => 'john'}}}
     end
   end
 
 end
 
-describe "Node#render!" do
+describe "Node#result" do
   it "returns an empty hash when not passed an object" do
-    Bldr::Node.new.render!.should == {}
+    Bldr::Node.new.result.should == {}
   end
 
   it "a document with a single node with no nesting" do
@@ -292,7 +299,7 @@ describe "Node#render!" do
       end
     end
 
-    node.render!.should == {:person => {:name => 'alex'}}
+    node.result.should == {:person => {:name => 'alex'}}
   end
 
   it "works for multiple top-level objects" do
@@ -308,7 +315,7 @@ describe "Node#render!" do
       end
     end
 
-    node.render!.should == {:alex => {:name => 'alex'}, :john => {:name => 'john'}}
+    node.result.should == {:alex => {:name => 'alex'}, :john => {:name => 'john'}}
   end
 
   it "recursively renders nested objects" do
@@ -322,7 +329,7 @@ describe "Node#render!" do
       end
     end
 
-    node.render!.should == {
+    node.result.should == {
       :alex => {
         :name => 'alex',
         :friend => {:name => 'john'}
@@ -343,7 +350,7 @@ describe "Node#render!" do
         end
       end
 
-      node.render!.should == {:person => {:surname => 'alex', :age => 25}}
+      node.result.should == {:person => {:surname => 'alex', :age => 25}}
     end
   end
 end
@@ -360,12 +367,12 @@ describe "Node#to_json" do
       end
     end
 
-    node.to_json.should == jsonify({
+    node.result.should == {
       :person => {
         :name => 'alex',
         :friend => {:name => 'pete', :age => 30}
       }
-    })
+    }
   end
 
   it "returns null values for nil attributes" do
@@ -375,8 +382,8 @@ describe "Node#to_json" do
       end
     end
 
-    parse_json(node.to_json)['person'].should have_key('age')
-    parse_json(node.to_json)['person']['age'].should be_nil
+    node.result[:person].should have_key(:age)
+    node.result[:person][:age].should be_nil
   end
 end
 
@@ -392,7 +399,7 @@ describe "Node#collection" do
       end
     end
 
-    node.render!.should == {
+    node.result.should == {
       :person => {
         :name => 'alex', :age => 26,
         :friends => [{:name => 'john', :age => 24}, {:name => 'jeff', :age => 25}]
@@ -401,14 +408,24 @@ describe "Node#collection" do
   end
 
   # @todo fix this
-  it "renders properly when a collection is the root node" do
+  it "renders properly when a collection is the named root node" do
     nodes = node_wrap do
       collection :people => [Person.new('bert'), Person.new('ernie')] do
         attributes :name
       end
     end
 
-    nodes.render!.should == {:people => [{:name => 'bert'}, {:name => 'ernie'}]}
+    nodes.result.should == {:people => [{:name => 'bert'}, {:name => 'ernie'}]}
+  end
+
+  it "renders properly when a collection is the root node" do
+    nodes = node_wrap do
+      collection [Person.new('bert'), Person.new('ernie')] do
+        attributes :name
+      end
+    end
+
+    nodes.result.should == [{:name => 'bert'}, {:name => 'ernie'}]
   end
 
   it "gracefully handles empty collections" do
@@ -418,7 +435,7 @@ describe "Node#collection" do
       end
     end
 
-    nodes.render!.should == {:people => []}
+    nodes.result.should == {:people => []}
   end
 
   it "gracefully handles nil collections" do
@@ -428,7 +445,7 @@ describe "Node#collection" do
       end
     end
 
-    nodes.render!.should == {:people => []}
+    nodes.result.should == {:people => []}
   end
 
   it "renders nested collections properly" do
@@ -446,7 +463,7 @@ describe "Node#collection" do
       end
     end
 
-    nodes.render!.should == {
+    nodes.result.should == {
       :posts => [
         {:title => 'my post', :comment_count => 1, :comments => [{:body => 'my comment'}]}
       ]
@@ -471,7 +488,7 @@ describe "Node#collection" do
       end
     end
 
-    nodes.render!.should == {
+    nodes.result.should == {
       :posts => [
         {
           :title => 'post 1',
@@ -498,7 +515,104 @@ describe "Node#collection" do
       end
     end
 
-    node.render!.should == {:name => 'john doe', :age => 25}
+    node.result.should == {:name => 'john doe', :age => 25}
   end
 
 end
+
+describe "Node#partial" do
+  it "includes the partial as a top level" do
+    nodes = node_wrap do
+      template "spec/fixtures/partial.json.bldr"
+    end
+
+    nodes.result.should == {:foo => "bar"}
+  end
+  
+  it "includes the partial on a top level object" do
+    nodes = node_wrap do
+      object :container do
+        attribute(:blah) { "baz" }
+        template "spec/fixtures/partial.json.bldr"
+      end
+    end
+
+    nodes.result.should == {:container => {:blah => "baz", :foo => "bar"}}
+  end
+  
+  it "includes the partial on a top level collection" do
+    nodes = node_wrap do
+      collection :people => [Person.new('bert'), Person.new('ernie')] do
+        attribute(:blah) { "baz" }
+        template "spec/fixtures/partial.json.bldr"
+      end
+    end
+
+    nodes.result.should == {:people => [{:blah => "baz", :foo => 'bar'}, {:blah => "baz", :foo => 'bar'}]}
+  end
+  
+  it "includes the partial on a sub object" do
+    nodes = node_wrap do
+      object :container do
+        object :sub do
+          attribute(:blah) { "baz" }
+          template "spec/fixtures/partial.json.bldr"
+        end
+      end
+    end
+
+    nodes.result.should == {:container => {:sub => {:blah => "baz", :foo => "bar"}}}
+  end
+  
+  it "includes the partial on a sub collection" do
+    nodes = node_wrap do
+      object :container do
+        collection :people => [Person.new('bert'), Person.new('ernie')] do
+          attribute(:blah) { "baz" }
+          template "spec/fixtures/partial.json.bldr"
+        end
+      end
+    end
+
+    nodes.result.should == {:container => {:people => [{:blah => "baz", :foo => 'bar'}, {:blah => "baz", :foo => 'bar'}]}}
+  end
+  
+  it "includes both the partials" do
+    nodes = node_wrap do
+      object :container do
+        template "spec/fixtures/partial.json.bldr"
+        object :sub do
+          attribute(:blah) { "baz" }
+          template "spec/fixtures/partial.json.bldr"
+        end
+      end
+    end
+
+    nodes.result.should == {:container => {:foo => "bar", :sub => {:blah => "baz", :foo => "bar"}}}
+  end
+  
+  it "includes the partial with the locals" do
+    Obj = Struct.new(:foo)
+    nodes = node_wrap do
+      template "spec/fixtures/partial_with_locals.json.bldr", :locals => {:obj => Obj.new('test')}
+    end
+
+    nodes.result.should == {:name => {:foo => 'test'}}
+  end
+  
+  it "raises an error when the partial isn't found" do
+    expect {
+      nodes = node_wrap do
+        template "unknown/path"
+      end
+    }.to raise_error(Errno::ENOENT)
+  end
+  
+  it "doesn't raise an error when with a base path option specified and the right file" do
+    nodes = node_wrap nil, :views => 'spec/fixtures/some' do
+      object :foo do
+        template "include"
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bldr
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-19 00:00:00.000000000Z
+date: 2012-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &2153229880 !ruby/object:Gem::Requirement
+  requirement: &70126171949220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 1.0.3
   type: :runtime
   prerelease: false
-  version_requirements: *2153229880
+  version_requirements: *70126171949220
 - !ruby/object:Gem::Dependency
   name: json_pure
-  requirement: &2153229460 !ruby/object:Gem::Requirement
+  requirement: &70126171948780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153229460
+  version_requirements: *70126171948780
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &2153228920 !ruby/object:Gem::Requirement
+  requirement: &70126171948200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.2.6
   type: :development
   prerelease: false
-  version_requirements: *2153228920
+  version_requirements: *70126171948200
 - !ruby/object:Gem::Dependency
   name: tilt
-  requirement: &2153228420 !ruby/object:Gem::Requirement
+  requirement: &70126171947660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,18 +54,29 @@ dependencies:
         version: 1.3.2
   type: :development
   prerelease: false
-  version_requirements: *2153228420
+  version_requirements: *70126171947660
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
-  requirement: &2153228040 !ruby/object:Gem::Requirement
+  requirement: &70126171947160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: *70126171947160
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: &70126171946680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.7
   type: :development
   prerelease: false
-  version_requirements: *2153228040
+  version_requirements: *70126171946680
 description: Provides a simple and intuitive templating DSL for serializing objects
   to JSON.
 email:
@@ -84,7 +95,6 @@ files:
 - Rakefile
 - bldr.gemspec
 - lib/bldr.rb
-- lib/bldr/engine.rb
 - lib/bldr/node.rb
 - lib/bldr/template.rb
 - lib/bldr/version.rb
@@ -93,7 +103,10 @@ files:
 - perf/benchmark.rb
 - perf/results.txt
 - spec/fixtures/nested_objects.json.bldr
+- spec/fixtures/partial.json.bldr
+- spec/fixtures/partial_with_locals.json.bldr
 - spec/fixtures/root_template.json.bldr
+- spec/fixtures/some/include.json.bldr
 - spec/functional/handlers_spec.rb
 - spec/functional/tilt_template_spec.rb
 - spec/integration/sinatra_spec.rb
@@ -123,13 +136,16 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: bldr
-rubygems_version: 1.8.6
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Templating library with a simple, minimalist DSL.
 test_files:
 - spec/fixtures/nested_objects.json.bldr
+- spec/fixtures/partial.json.bldr
+- spec/fixtures/partial_with_locals.json.bldr
 - spec/fixtures/root_template.json.bldr
+- spec/fixtures/some/include.json.bldr
 - spec/functional/handlers_spec.rb
 - spec/functional/tilt_template_spec.rb
 - spec/integration/sinatra_spec.rb

data/lib/bldr/engine.rb

@@ -1,15 +0,0 @@
-
-module Bldr
-
-  class Engine
-    attr_reader :template, :options, :result
-
-    def initialize(template, options = {})
-      @template, @options = template, options
-      @result   = {}
-      @handlers = {}
-    end
-
-  end
-
-end