rabl 0.8.0 → 0.8.1

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 0.8.1
+
+ * Fix to respect @collection :root for xml output (Thanks @chinshr)
+
 ## 0.8.0
 
  * Remove multi_json dependency, simpler JSON handling

data/Gemfile

@@ -1,4 +1,4 @@
-source :rubygems
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in rabl.gemspec
 gemspec
@@ -23,5 +23,5 @@ group :test do
 end
 
 group :development, :test do
-  gem 'debugger'
+  # gem 'debugger'
 end

data/README.md

@@ -3,10 +3,11 @@
 [![Continuous Integration status](https://secure.travis-ci.org/nesquena/rabl.png)](http://travis-ci.org/nesquena/rabl)
 [![Dependency Status](https://gemnasium.com/nesquena/rabl.png)](https://gemnasium.com/nesquena/rabl)
 
-RABL (Ruby API Builder Language) is a Rails and [Padrino](http://padrinorb.com) ruby templating system for generating JSON, XML, MessagePack, PList and BSON. When using the ActiveRecord 'to_json' method, I tend to quickly find myself wanting a more expressive and powerful solution for generating APIs.
-This is especially frustrating when the JSON representation is complex or doesn't match the exact schema defined in the database.
+RABL (Ruby API Builder Language) is a Rails and [Padrino](http://padrinorb.com) ruby templating system for generating JSON, XML, MessagePack, PList and BSON. 
+When using the ActiveRecord 'to_json' method, I find myself wanting a more expressive and powerful solution for generating APIs.
+This is especially true when the JSON representation is complex or doesn't match the exact schema defined within the database.
 
-I wanted a simple and flexible system for generating my APIs. In particular, I wanted to easily:
+In particular, I want to easily:
 
  * Create arbitrary nodes named based on combining data in an object
  * Pass arguments to methods and store the result as a child node
@@ -16,14 +17,15 @@ I wanted a simple and flexible system for generating my APIs. In particular, I w
  * Include nodes only if a certain condition has been met
 
 Anyone who has tried the 'to_json' method used in ActiveRecord for generating a JSON response has felt the pain of this restrictive approach.
-RABL is a general templating system created to solve these problems in an entirely new way.
+RABL is a general templating system created to solve these problems by approaching API response generation in an entirely new way.
 
+RABL at the core is all about adhering to MVC principles by deferring API data representations to the **view** layer of your application.
 For a breakdown of common misconceptions about RABL, please check out our guide to
-[understanding RABL](https://github.com/nesquena/rabl/wiki/Understanding-RABL) which can help clear up any confusion about this project.
+[understanding RABL](https://github.com/nesquena/rabl/wiki/Understanding-RABL) which can help clear up any confusion about this project. 
 
 ## Breaking Changes ##
 
- * v0.8.0 (released Feb 14, 2012) removes multi_json dependency and 
+ * v0.8.0 (released Feb 14, 2013) removes multi_json dependency and 
    relies on Oj (or JSON) as the json parser. Simplifies code, removes a dependency
    but you might want to remove any references to MultiJson.
 
@@ -541,7 +543,8 @@ the [RABL Wiki](https://github.com/nesquena/rabl/wiki) for other usages.
 
 Tutorials can always be helpful when first getting started:
 
- * [Railscasts #322](http://railscasts.com/episodes/322-rabl)
+ * [Railscasts #322](http://railscasts.com/episodes/322-rabl) - Ryan Bates explains RABL
+ * [BackboneRails](http://www.backbonerails.com/) - Great screencasts by Brian Mann
  * [Creating an API with RABL and Padrino](http://blog.crowdint.com/2012/10/22/rabl-with-padrino.html)
  * http://blog.joshsoftware.com/2011/12/23/designing-rails-api-using-rabl-and-devise/
  * http://engineering.gomiso.com/2011/06/27/building-a-platform-api-on-rails/

data/lib/rabl/engine.rb

@@ -89,8 +89,9 @@ module Rabl
       include_root = Rabl.configuration.include_xml_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)
-      to_hash(options).to_xml(xml_options)
+      xml_options = Rabl.configuration.default_xml_options.merge(:root => collection_root_name || @_data_name)
+      result = to_hash(options)
+      result.to_xml(xml_options)
     end
 
     # Returns a bson representation of the data object

data/lib/rabl/version.rb

@@ -1,3 +1,3 @@
 module Rabl
-  VERSION = "0.8.0"
+  VERSION = "0.8.1"
 end

data/test/xml_test.rb

@@ -50,12 +50,12 @@ context "Rabl::Engine" do
 
       asserts "that it sets root node for objects" do
         template = rabl %{
-          collection @users => :person
+          collection @users => :smors
         }
         scope = Object.new
         scope.instance_variable_set :@users, [User.new, User.new]
         template.render(scope)
-      end.equals "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<people type=\"array\">\n  <person>\n  </person>\n  <person>\n  </person>\n</people>\n"
+      end.equals "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<smors type=\"array\">\n  <smor>\n  </smor>\n  <smor>\n  </smor>\n</smors>\n"
     end
 
     context "#attribute" do
@@ -187,12 +187,22 @@ context "Rabl::Engine" do
 
       asserts "that it sets root node for objects" do
         template = rabl %{
-          collection @users => :person
+          collection @users => :people
         }
         scope = Object.new
         scope.instance_variable_set :@users, [User.new, User.new]
         template.render(scope)
       end.equals "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<people type=\"array\">\n  <person>\n    <person>\n    </person>\n  </person>\n  <person>\n    <person>\n    </person>\n  </person>\n</people>\n"
+
+      asserts "that it sets root node for objects with :root parameter" do
+        template = rabl %{
+          collection @users, :root => :people, :object_root => :person
+        }
+        scope = Object.new
+        scope.instance_variable_set :@users, [User.new, User.new]
+        template.render(scope)
+      end.equals "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<people type=\"array\">\n  <person>\n    <person>\n    </person>\n  </person>\n  <person>\n    <person>\n    </person>\n  </person>\n</people>\n"
+
     end
 
     context "#attribute" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rabl
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-14 00:00:00.000000000 Z
+date: 2013-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -422,15 +422,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 2506448699878914083
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 2506448699878914083
 requirements: []
 rubyforge_project: rabl
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: General ruby templating with json, bson, xml and msgpack support