rabl 0.1.1 → 0.1.2

data/README.md

@@ -60,6 +60,14 @@ or even specify a root node label for the collection:
 
 and this will be used as the default data for the rendering.
 
+There can also be odd cases where the root-level of the response doesn't map directly to any object:
+
+    object false
+    code(:some_count) { |m| @user.posts.count }
+    child(@user) { attribute :name }
+
+In those cases, object can be assigned to 'false' and child nodes can be constructed independently.
+
 ### Attributes ###
 
 Basic usage of the templater to define a few simple attributes for the response:
@@ -80,13 +88,19 @@ or even multiple aliased attributes:
 
 ### Child Nodes ###
 
-You can also add child nodes from an arbitrary source:
+Often a response requires including nested information from data associated with the parent model:
+
+    child :address do
+      attributes :street, :city, :zip, :state
+    end
+
+You can also add child nodes from an arbitrary data source:
 
     child @posts => :foobar do
       attributes :id, :title
     end
 
-or simply use existing model associations:
+or use model associations with an alias:
 
     # Renders all the 'posts' association
     # from the model into a node called 'foobar'

data/lib/rabl/builder.rb

@@ -66,10 +66,12 @@ module Rabl
     # Creates a child node that is included in json output
     # child(@user) { attribute :full_name }
     # child(@user => :person) { ... }
+    # child(@users => :people) { ... }
     def child(data, options={}, &block)
       return false unless data.present?
       name, object = data_name(data), data_object(data)
-      include_root = object.respond_to?(:each) # @users
+      include_root = object.respond_to?(:each) # child @users
+      object = { data_object(data) => data_name(data) } if data.respond_to?(:each_pair) # child :users => :people
       @_result[name] = self.object_to_hash(object, :root => include_root, &block) if resolve_condition(options)
     end
 

data/lib/rabl/engine.rb

@@ -28,7 +28,8 @@ module Rabl
       if is_record?(data) || !data # object @user
         Rabl::Builder.new(@_data, @_options).to_hash(options)
       elsif data.respond_to?(:each) # collection @users
-        data.map { |object| Rabl::Builder.new({ object => data_name(object) }, @_options).to_hash(options) }
+        object_name = data_name(@_data).to_s.singularize # @users => :users
+        data.map { |object| Rabl::Builder.new({ object => object_name }, @_options).to_hash(options) }
       end
     end
 

data/lib/rabl/helpers.rb

@@ -26,11 +26,11 @@ module Rabl
       end
     end
 
-    # Returns true if item is a ORM record; false otherwise
-    # is_record?(@user) => true
-    # is_record?([]) => false
-    def is_record?(obj)
-      obj && data_object(obj).respond_to?(:valid?)
+    # Renders a partial hash based on another rabl template
+    # partial("users/show", :object => @user)
+    def partial(file, options={}, &block)
+      source = self.fetch_source(file)
+      self.object_to_hash(options[:object], :source => source, &block)
     end
 
     # Returns a hash based representation of any data object given ejs template block
@@ -52,11 +52,11 @@ module Rabl
       result
     end
 
-    # Renders a partial hash based on another rabl template
-    # partial("users/show", :object => @user)
-    def partial(file, options={}, &block)
-      source = self.fetch_source(file)
-      self.object_to_hash(options[:object], :source => source, &block)
+    # Returns true if item is a ORM record; false otherwise
+    # is_record?(@user) => true
+    # is_record?([]) => false
+    def is_record?(obj)
+      obj && data_object(obj).respond_to?(:valid?)
     end
 
     # Returns source for a given relative file

data/lib/rabl/version.rb

@@ -1,3 +1,3 @@
 module Rabl
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/test/builder_test.rb

@@ -106,7 +106,7 @@ context "Rabl::Builder" do
 
     asserts "that it generates with a hash" do
       b = builder @user, {}
-      mock(b).object_to_hash(@user,{ :root => false }).returns('xyz').subject
+      mock(b).object_to_hash({ @user => :user },{ :root => false }).returns('xyz').subject
 
       b.child(@user => :user) { attribute :name }
       get_result(b)

metadata

@@ -2,7 +2,7 @@
 name: rabl
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - Nathan Esquenazi
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-18 00:00:00 -07:00
+date: 2011-04-19 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -113,7 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: rabl
-rubygems_version: 1.5.2
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: General ruby templating for json or xml