rabl 0.5.5.i → 0.5.5.j

data/CHANGELOG.md

@@ -12,6 +12,7 @@
  * Adds PList format support (thanks @alzeih)
  * Fixes infinite recursion in edge case calculating object root name
  * Fixes issue with nameless node that has an array result
+ * Adds support for `object_root => false` (Thanks @Lytol)
 
 ## 0.5.4
 

data/README.md

@@ -258,7 +258,12 @@ collection @users, :root => "people", :object_root => "user"
 # => { "people" : [ { "user" : { ... } } ] }
 ```
 
-and this will be used as the default data for the rendering.
+and this will be used as the default data for the rendering, or disable the object root explicitly:
+
+```ruby
+collection @users, :root => "people", :object_root => false
+# => { "people" : [ { ... }, { ... } ] }
+```
 
 There can also be odd cases where the root-level of the response doesn't map directly to any object:
 

data/lib/rabl/engine.rb

@@ -31,14 +31,12 @@ module Rabl
     # to_hash(:root => true, :child_root => true)
     def to_hash(options={})
       options = @_options.merge(options)
-      data, root_name = data_object(@_data), data_name(@_data)
+      data = data_object(@_data)
       builder = Rabl::Builder.new(options)
+      options[:root_name] = determine_object_root(@_data, options[:root])
       if is_object?(data) || !data # object @user
-        options[:root_name] = root_name if options[:root]
         builder.build(data, options)
       elsif is_collection?(data) # collection @users
-        options[:root_name] = object_root_name if object_root_name
-        options[:root_name] ||= root_name.to_s.singularize if options[:root]
         data.map { |object| builder.build(object, options) }
       end
     end
@@ -111,7 +109,7 @@ module Rabl
     def collection(data, options={})
       @_collection_name = options[:root] if options[:root]
       @_collection_name ||= data.values.first if data.respond_to?(:each_pair)
-      @_object_root_name = options[:object_root] if options[:object_root]
+      @_object_root_name = options[:object_root] if options.has_key?(:object_root)
       self.object(data_object(data).to_a) if data
     end
 

data/lib/rabl/helpers.rb

@@ -30,6 +30,21 @@ module Rabl
       end
     end
 
+    # Returns the object rootname based on if the root should be included
+    # Can be called with data as a collection or object
+    # determine_object_root(@user, true) => "user"
+    # determine_object_root(@user => :person) => "person"
+    # determine_object_root([@user, @user]) => "user"
+    def determine_object_root(data, include_root=true)
+      return if object_root_name == false
+      root_name = data_name(data).to_s if include_root
+      if is_object?(data)
+        root_name
+      elsif is_collection?(data)
+        object_root_name || (root_name.singularize if root_name)
+      end
+    end
+
     # Returns true if obj is not enumerable
     # is_object?(@user) => true
     # is_object?([]) => false

data/lib/rabl/version.rb

@@ -1,3 +1,3 @@
 module Rabl
-  VERSION = "0.5.5.i"
+  VERSION = "0.5.5.j"
 end

data/test/engine_test.rb

@@ -77,15 +77,32 @@ context "Rabl::Engine" do
         template.render(scope)
       end.equals "[{\"user\":{}},{\"user\":{}}]"
 
-      # TODO fix this test
-      # asserts "that it sets root node for objects" do
-      #   template = rabl %{
-      #     collection @users => :people
-      #   }
-      #   scope = Object.new
-      #   scope.instance_variable_set :@users, [User.new, User.new]
-      #   template.render(scope)
-      # end.equals "{\"people\":[{\"person\":{}},{\"person\":{}}]}"
+      asserts "that it sets root node for objects" do
+        template = rabl %{
+          collection @users => :people
+        }
+        scope = Object.new
+        scope.instance_variable_set :@users, [User.new, User.new]
+        template.render(scope)
+      end.equals "{\"people\":[{\"person\":{}},{\"person\":{}}]}"
+
+      asserts "that it doesn't set root node for objects when specified" do
+       template = rabl %{
+         collection @users, :root => :people, :object_root => false
+       }
+       scope = Object.new
+       scope.instance_variable_set :@users, [User.new, User.new]
+       template.render(scope)
+      end.equals "{\"people\":[{},{}]}"
+
+      asserts "that it sets proper object and root names when specified" do
+       template = rabl %{
+         collection @users, :root => :people, :object_root => :user
+       }
+       scope = Object.new
+       scope.instance_variable_set :@users, [User.new, User.new]
+       template.render(scope)
+      end.equals "{\"people\":[{\"user\":{}},{\"user\":{}}]}"
 
       asserts "that it can use non-ORM objects" do
         template = rabl %q{

metadata

@@ -2,7 +2,7 @@
 name: rabl
 version: !ruby/object:Gem::Version 
   prerelease: 6
-  version: 0.5.5.i
+  version: 0.5.5.j
 platform: ruby
 authors: 
 - Nathan Esquenazi