rabl 0.6.12 → 0.6.13

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # CHANGELOG
 
+## 0.6.13
+
+  * Small tweak to is_collection detection (look for each and map) 
+  * Adds `include_child_root` configuration option (Thanks @yoon)
+
 ## 0.6.12
 
   * Fix view_path options for renderer (Thanks @ivanvanderbyl and @route)

data/README.md

@@ -110,7 +110,8 @@ Rabl.configure do |config|
   # config.include_msgpack_root = true
   # config.include_bson_root = true
   # config.include_plist_root = true
-  # config.include_xml_root  = false
+  # config.include_xml_root  = false      
+  # config.include_child_root = true
   # config.enable_json_callbacks = false
   # config.xml_options = { :dasherize  => true, :skip_types => false }
   # config.view_paths = []
@@ -118,8 +119,11 @@ end
 ```
 
 Each option specifies behavior related to RABL's output. If `include_json_root` is disabled that removes the
-root node for each child in the output, and `enable_json_callbacks` enables support for 'jsonp' style callback
-output if the incoming request has a 'callback' parameter.
+root node for each root object in the output, and `enable_json_callbacks` enables support for 'jsonp' style callback
+output if the incoming request has a 'callback' parameter. 
+
+If `include_child_root` is set to false then child objects in the response will not include 
+a root node by default. This allows you to further fine-tune your desired response structure.
 
 If `cache_sources` is set to `true`, template lookups will be cached for improved performance.
 The cache can be reset manually by running `Rabl.reset_source_cache!` within your application.

data/lib/rabl/configuration.rb

@@ -23,6 +23,7 @@ module Rabl
   # Rabl.host
   class Configuration
     attr_accessor :include_json_root
+    attr_accessor :include_child_root
     attr_accessor :include_msgpack_root
     attr_accessor :include_plist_root
     attr_accessor :include_xml_root
@@ -43,6 +44,7 @@ module Rabl
 
     def initialize
       @include_json_root     = true
+      @include_child_root    = true
       @include_msgpack_root  = true
       @include_plist_root    = true
       @include_xml_root      = false

data/lib/rabl/engine.rb

@@ -54,7 +54,8 @@ module Rabl
     # to_json(:root => true)
     def to_json(options={})
       include_root = Rabl.configuration.include_json_root
-      options = options.reverse_merge(:root => include_root, :child_root => include_root)
+      include_child_root = Rabl.configuration.include_child_root
+      options = options.reverse_merge(:root => include_root, :child_root => include_child_root)
       result = collection_root_name ? { collection_root_name => to_hash(options) } : to_hash(options)
       format_json(result)
     end
@@ -63,7 +64,8 @@ module Rabl
     # to_msgpack(:root => true)
     def to_msgpack(options={})
       include_root = Rabl.configuration.include_msgpack_root
-      options = options.reverse_merge(:root => include_root, :child_root => include_root)
+      include_child_root = Rabl.configuration.include_child_root
+      options = options.reverse_merge(:root => include_root, :child_root => include_child_root)
       result = collection_root_name ? { collection_root_name => to_hash(options) } : to_hash(options)
       Rabl.configuration.msgpack_engine.pack result
     end
@@ -73,7 +75,8 @@ module Rabl
     # to_plist(:root => true)
     def to_plist(options={})
       include_root = Rabl.configuration.include_plist_root
-      options = options.reverse_merge(:root => include_root, :child_root => include_root)
+      include_child_root = Rabl.configuration.include_child_root
+      options = options.reverse_merge(:root => include_root, :child_root => include_child_root)
       result = defined?(@_collection_name) ? { @_collection_name => to_hash(options) } : to_hash(options)
       Rabl.configuration.plist_engine.dump(result)
     end
@@ -82,7 +85,8 @@ module Rabl
     # to_xml(:root => true)
     def to_xml(options={})
       include_root = Rabl.configuration.include_xml_root
-      options = options.reverse_merge(:root => include_root, :child_root => include_root)
+      include_child_root = include_root && Rabl.configuration.include_child_root
+      options = options.reverse_merge(:root => include_root, :child_root => include_child_root)
       xml_options = Rabl.configuration.default_xml_options.merge(:root => data_name(@_data))
       to_hash(options).to_xml(xml_options)
     end
@@ -91,7 +95,8 @@ module Rabl
     # to_bson(:root => true)
     def to_bson(options={})
       include_root = Rabl.configuration.include_bson_root
-      options = options.reverse_merge(:root => include_root, :child_root => include_root)
+      include_child_root = Rabl.configuration.include_child_root
+      options = options.reverse_merge(:root => include_root, :child_root => include_child_root)
       result = if collection_root_name
                  { collection_root_name => to_hash(options) }
                elsif is_collection?(@_data) && @_data.is_a?(Array)

data/lib/rabl/helpers.rb

@@ -50,17 +50,17 @@ module Rabl
       end
     end
 
-    # Returns true if obj is not enumerable
+    # Returns true if obj is not a collection
     # is_object?(@user) => true
     # is_object?([]) => false
     # is_object?({}) => false
     def is_object?(obj)
-      obj && !data_object(obj).respond_to?(:map)
+      obj && (!data_object(obj).respond_to?(:map) || !data_object(obj).respond_to?(:each))
     end
 
     # Returns true if the obj is a collection of items
     def is_collection?(obj)
-      obj && data_object(obj).respond_to?(:map)
+      obj && data_object(obj).respond_to?(:map) && data_object(obj).respond_to?(:each)
     end
 
     # Returns the scope wrapping this engine, used for retrieving data, invoking methods, etc

data/lib/rabl/version.rb

@@ -1,3 +1,3 @@
 module Rabl
-  VERSION = "0.6.12"
+  VERSION = "0.6.13"
 end

data/test/configuration_test.rb

@@ -8,6 +8,7 @@ context 'Rabl::Configuration' do
     setup { Rabl.configuration }
 
     asserts(:include_json_root).equals true
+    asserts(:include_child_root).equals true
     asserts(:include_xml_root).equals false
     asserts(:enable_json_callbacks).equals false
     asserts(:view_paths).equals []

data/test/engine_test.rb

@@ -475,4 +475,31 @@ context "Rabl::Engine" do
       Rabl.reset_configuration!
     end
   end
+  
+  context "without child root" do
+    setup do
+      Rabl.configure do |config|
+        config.include_child_root    = false
+        config.include_xml_root      = false
+        config.enable_json_callbacks = false
+      end
+    end
+    
+    context "#child" do
+      
+      asserts "that it can create a child node without child root" do
+        template = rabl %{
+          child @users
+        }
+        scope = Object.new
+        scope.instance_variable_set :@users, [User.new, User.new]
+        template.render(scope)
+      end.equals "{\"users\":[{},{}]}"
+
+    end
+
+    teardown do
+      Rabl.reset_configuration!
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rabl
 version: !ruby/object:Gem::Version
-  version: 0.6.12
+  version: 0.6.13
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-20 00:00:00.000000000 Z
+date: 2012-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport