bldr 0.5.5 → 0.6.0

data/HISTORY.md

@@ -1,3 +1,11 @@
+## 0.6.0 (2012-xx-xx)
+* Feature: Add the ability to pass-through objects directly to `object` and
+  `collection` DSL methods
+
+## 0.5.5 (2012-05-15)
+* Bug: Allow .bldr extensions at the end of partial template names
+* Bug: `#attribute` DSL method returns self, allowing use at top level
+
 ## 0.5.4 (2012-04-24)
 * Fix bug to allow using `template` method at the root of a bldr template
 * Add `locals` reader method to allow access to locals passed into a bldr template

data/lib/bldr/node.rb

@@ -57,45 +57,88 @@ module Bldr
     #     attributes(:url) { url }
     #   end
     #
+    # @example "Pass-through" objects
+    #   object :person => person do
+    #     object :hobbies => hobbies
+    #   end
+    #
     # @param [Hash, Nil] hash a key/value pair indicating the output key name
     #   and the object to serialize.
     # @param [Proc] block the code block to evaluate
     #
     # @return [Bldr::Node] returns self
     def object(base = nil, &block)
-      if base.kind_of? Hash
-        key   = base.keys.first
-        value = base.values.first
+      if block_given?
+        if keyed_object?(base)
+          key   = base.keys.first
+          value = base.values.first
+        else
+          key = base
+          value = nil
+        end
+
+        # Short circuit here if the object passed in pointed
+        # at a nil value. There's some debate about how this
+        # should behave by default -- should it build the keyspace,
+        # pointing a null value, or should it leave the key out.
+        # With this implementation, it leaves the keyspace out.
+        return nil if value.nil? and keyed_object?(base)
+
+        node  = Node.new(value, opts.merge(:parent => self), &block)
+        merge_result!(key, node.result)
       else
-        key = base
-        value = nil
+        merge_result!(nil, base)
       end
 
-      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
 
+    # Build a collection of objects, either passing each object
+    # into the block provided, or rendering the collection
+    # "pass-through", i.e. exactly as it appears.
+    #
+    # @example
+    #   object :person => person do
+    #     attributes :id, :name, :age
+    #
+    #     collection :friends => person.friends do
+    #       attributes :name, :age, :friend_count
+    #     end
+    #   end
+    #
+    # @example "Pass-through" collections
+    #   object :person => person do
+    #     collection :hobbies => hobbies
+    #   end
+    #
+    # @param [Array, Hash] items Either an array of items, or a hash.
+    #   If an array is passed in, the objects will be rendered at the
+    #   "top level", i.e. without a key pointing to them.
     # @return [Bldr::Node] returns self
     def collection(items, &block)
 
-      if items.respond_to?('keys')
+      # Does this collection live in a key, or is it top-level?
+      if keyed_object?(items)
         key = items.keys.first
         values = items.values.to_a.first
       else
         key = nil
         values = items
       end
-      
+
       vals = if values
-               values.map{|item| Node.new(item, opts.merge(:parent => self), &block).result}
-             else
-               []
-             end
+        if block_given?
+          values.map do |item|
+            Node.new(item, opts.merge(:parent => self), &block).result
+          end
+        else
+          values
+        end
+      else
+        []
+      end
 
-      if items.respond_to?('keys')
+      if keyed_object?(items)
         merge_result! key, vals
       else
         @result = massage_value(vals)
@@ -200,6 +243,16 @@ module Bldr
     end
 
     private
+
+    # Determines if an object was passed in with a key pointing to it, or if
+    # it was passed in as the "root" of the current object. Essentially, this
+    # checks if `obj` quacks like a hash.
+    #
+    # @param [Object] obj
+    # @return [Boolean]
+    def keyed_object?(obj)
+      obj.respond_to?(:keys)
+    end
     
     def find_template(template)
       path = []

data/lib/bldr/version.rb

@@ -1,4 +1,4 @@
 
 module Bldr
-  VERSION = '0.5.5'
+  VERSION = '0.6.0'
 end

data/spec/models/post.rb

@@ -1,6 +1,8 @@
+class Author < Struct.new(:name)
+end
 
 class Post
-  attr_accessor :title, :body, :comments
+  attr_accessor :title, :body, :comments, :author
 
   def initialize(title = nil, body = nil)
     @title, @body = title, body

data/spec/unit/node_spec.rb

@@ -18,6 +18,15 @@ describe "Node#attributes" do
 end
 
 describe "Node#object" do
+  context "rendering an object exactly as it exists" do
+    it "renders the object exactly as it appears when passed an object with no block" do
+      obj = {'key' => 'val', 'nested' => {'key' => 'val'}}
+      node = node_wrap do
+        object obj
+      end
+      node.result.should == obj
+    end
+  end
 
   context "a zero arg root object node" do
 
@@ -406,6 +415,30 @@ describe "Node#to_json" do
 end
 
 describe "Node#collection" do
+  context "when passed an object with no block" do
+    it "renders the object exactly as it exists" do
+      coll = [{'key' => 'val'}]
+      node = node_wrap do
+        collection coll
+      end
+
+      node.result.should == coll
+    end
+
+    it "renders complex collection objects correctly" do
+      hobbies = [{'name' => "Gym"}, {'name' => "Tan"}, {'name' => "Laundry"}]
+
+      node = node_wrap do
+        object 'person' => Person.new("Alex") do
+          attribute :name
+          collection 'hobbies' => hobbies
+        end
+      end
+
+      node.result.should == {'person' => {:name => "Alex", 'hobbies' => hobbies}}
+    end
+  end
+
   it "iterates through the collection and renders them as nodes" do
     node = node_wrap do
       object :person => Person.new('alex', 26) do
@@ -488,6 +521,28 @@ describe "Node#collection" do
     }
   end
 
+  it "renders objects nested in collections properly" do
+    post = Post.new 'foo'
+    post.author = Author.new('John Doe')
+    posts = [post]
+
+    nodes = node_wrap do
+      collection :data => posts do
+        attributes :title
+
+        object :author => current_object.author do
+          attributes :name
+        end
+      end
+    end
+
+    nodes.result.should == {
+      :data => [
+        {:title => 'foo', :author => {:name => 'John Doe'}}
+      ]
+    }
+  end
+
   it "renders nested collections with dynamic property values correctly" do
     post1 = Post.new("post 1")
     post2 = Post.new("post 2")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bldr
 version: !ruby/object:Gem::Version
-  version: 0.5.5
+  version: 0.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-15 00:00:00.000000000 Z
+date: 2012-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &70314605956260 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70314605956260
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: json_pure
-  requirement: &70314605955840 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70314605955840
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &70314605955340 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +53,15 @@ dependencies:
         version: 1.2.6
   type: :development
   prerelease: false
-  version_requirements: *70314605955340
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.6
 - !ruby/object:Gem::Dependency
   name: tilt
-  requirement: &70314605954840 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +69,15 @@ dependencies:
         version: 1.3.2
   type: :development
   prerelease: false
-  version_requirements: *70314605954840
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.2
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
-  requirement: &70314605954380 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +85,15 @@ dependencies:
         version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *70314605954380
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: actionpack
-  requirement: &70314605953920 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,7 +101,12 @@ dependencies:
         version: 3.0.7
   type: :development
   prerelease: false
-  version_requirements: *70314605953920
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.7
 description: Provides a simple and intuitive templating DSL for serializing objects
   to JSON.
 email:
@@ -137,7 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: bldr
-rubygems_version: 1.8.15
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Templating library with a simple, minimalist DSL.