rabl 0.7.1 → 0.7.2

data/.travis.yml

@@ -9,4 +9,3 @@ notifications:
   recipients:
     - nesquena@gmail.com
     - databyte@gmail.com
-

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 # CHANGELOG
 
-## 0.7.2 (unreleased)
+## 0.7.3 (unreleased)
+
+## 0.7.2
+
+  * Set instance variables for locals in engine instead of renderer (Thanks @geehsien)
+  * Changes default JSON engine for Rails, move logic to separate class (Thanks @shmeltex)
 
 ## 0.7.1
 

data/Gemfile

@@ -3,17 +3,21 @@ source :rubygems
 # Specify your gem's dependencies in rabl.gemspec
 gemspec
 
-gem "rake"
-gem "i18n", '~> 0.6'
+gem 'rake', :require => false
+gem 'i18n', '~> 0.6'
 
 platforms :mri_18 do
   gem 'SystemTimer'
 end
 
-# FIXTURES
 group :test do
-  gem 'rack-test', :require => "rack/test"
-  gem 'activerecord', :require => "active_record"
+  # RABL TEST
+  gem 'activesupport', :require => 'active_support'
+  gem 'builder'
+
+  # FIXTURES
+  gem 'rack-test', :require => 'rack/test'
+  gem 'activerecord', :require => 'active_record'
   gem 'sqlite3'
   gem 'sinatra', '>= 1.2.0'
 end

data/Gemfile.ci

@@ -10,3 +10,5 @@ platforms :mri_18 do
   gem 'SystemTimer'
 end
 
+gem 'activesupport', :require => 'active_support'
+gem 'builder'

data/README.md

@@ -1,5 +1,8 @@
 # RABL #
 
+[![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.
 
@@ -109,7 +112,7 @@ Rabl.configure do |config|
   # config.cache_sources = Rails.env != 'development' # Defaults to false
   # config.cache_engine = Rabl::CacheEngine.new # Defaults to Rails cache
   # config.escape_all_output = false
-  # config.json_engine = nil # Any multi\_json engines
+  # config.json_engine = nil # Any multi_json engines or a Class with #encode method
   # config.msgpack_engine = nil # Defaults to ::MessagePack
   # config.bson_engine = nil # Defaults to ::BSON
   # config.plist_engine = nil # Defaults to ::Plist::Emit
@@ -148,7 +151,7 @@ If `view_paths` is set to a path, this view path will be checked for every rabl
 Add to this path especially when including Rabl in an engine and using view paths within a another Rails app.
 
 Note that the `json_engine` option uses [multi_json](http://intridea.com/2010/6/14/multi-json-the-swappable-json-handler) engine
-defaults so that in most cases you **don't need to configure this** directly. If you wish to use yajl as
+defaults so that in most cases you **don't need to configure this** directly. For example, if you wish to use yajl as
 the primary JSON encoding engine simply add that to your Gemfile:
 
 ```ruby
@@ -158,6 +161,13 @@ gem 'yajl-ruby', :require => "yajl"
 
 and RABL will automatically start using that engine for encoding your JSON responses!
 
+To use RABL with JSON engine not supported by `multi_json`, ensure that JSON engine
+supports `encode` method and set `json_engine` option to the engine's Class name:
+
+```ruby
+config.json_engine = ActiveSupport::JSON
+```
+
 ### Format Configuration ###
 
 RABL supports configuration for MessagePack, BSON, and Plist. Check the
@@ -347,7 +357,7 @@ node :location do
 end
 ```
 
-or event access an object associated with the parent model:
+or even access an object associated with the parent model:
 
 ```ruby
 node :location do |m|
@@ -449,17 +459,20 @@ Rabl.render(object, template, :view_path => 'app/views', :format => :json) #=> "
 You can use convenience methods on `Rabl::Renderer` to render the objects as well:
 
 ```ruby
-Rabl::Renderer.new(@post, 'posts/show', :view_path => 'app/views')
 Rabl::Renderer.json(@post, 'posts/show')
 Rabl::Renderer.xml(@post, 'posts/show')
 ```
 
 These methods allow RABL to be used for arbitrary conversions of an object into a desired format.
 
+```ruby
+Rabl::Renderer.new('posts/show', @post, :view_path => 'app/views', :format => 'hash').render
+```
+
 You can also pass in other instance variables to be used in your template as:
 
 ```ruby
-Rabl::Renderer.new(@post, 'posts/show', :locals => { :custom_title => "Hello world!" })
+Rabl::Renderer.new('posts/show', @post, :locals => { :custom_title => "Hello world!" })
 ````
 
 Then, in your template, you can use `@custom_title` as:
@@ -535,12 +548,6 @@ Check out the [Issues](https://github.com/nesquena/rabl/issues) tab for a full l
 
  * Rigorous benchmarking and performance optimizations
 
-## Continuous Integration ##
-
-[![Continuous Integration status](https://secure.travis-ci.org/nesquena/rabl.png)](http://travis-ci.org/nesquena/rabl)
-
-CI is hosted by [travis-ci.org](http://travis-ci.org).
-
 ## Authors and Contributors ##
 
 Thanks to [Miso](http://gomiso.com) for allowing me to create this for our applications and release this project!

data/fixtures/ashared/views_rails_3/posts/show.rabl

@@ -16,8 +16,10 @@ code(:created_date) do |p|
   partial("posts/date", :object => p.created_at)
 end
 
-node(:foo) { helper_foo }
-
 node(:post) do |post|
   [post.title, post.body]
 end
+
+node(:foo) { helper_foo }
+
+node(:created_at_in_words) {|p| time_ago_in_words(p.created_at) }

data/fixtures/padrino_test/Gemfile

@@ -12,6 +12,6 @@ gem 'riot', :group => "test"
 gem 'rack-test', :require => "rack/test", :group => "test"
 
 # Padrino
-gem 'padrino', '0.10.2'
+gem 'padrino', '~> 0.10.7'
 gem 'json'
-gem 'rabl', :path => File.expand_path(File.dirname(__FILE__) + "/../../")
+gem 'rabl', :path => File.expand_path(File.dirname(__FILE__) + "/../../")

data/fixtures/rails3/Gemfile

@@ -1,6 +1,6 @@
 source 'http://rubygems.org'
 
-gem 'rails', '3.0.12'
+gem 'rails', '~> 3.0.17'
 
 # Bundle edge Rails instead:
 # gem 'rails', :git => 'git://github.com/rails/rails.git'

data/fixtures/rails3_2/Gemfile

@@ -1,6 +1,6 @@
 source 'https://rubygems.org'
 
-gem 'rails', '3.2.3'
+gem 'rails', '~> 3.2.8'
 
 # Bundle edge Rails instead:
 # gem 'rails', :git => 'git://github.com/rails/rails.git'
@@ -9,7 +9,6 @@ gem 'sqlite3'
 gem 'rabl', :path => File.expand_path(File.dirname(__FILE__) + "/../../")
 gem 'riot', :group => "test"
 
-
 # Gems used only for assets and not required
 # in production environments by default.
 group :assets do

data/fixtures/rails3_2/test/functional/posts_controller_test.rb

@@ -134,6 +134,7 @@ context "PostsController" do
     end # date node
 
     asserts("contains helper action") { topic["foo"] }.equals { "BAR!" }
+    denies("contains helper action") { topic["created_at_in_words"] }.nil
 
     asserts("contains post attributes via node") { topic["post"] }.equals { [@post1.title, @post1.body] }
   end # show action, json

data/fixtures/sinatra_test/Gemfile

@@ -4,10 +4,10 @@ gem 'rake'
 gem 'activerecord', :require => "active_record"
 gem 'sqlite3'
 
-gem 'sinatra', '>= 1.2.0'
+gem 'sinatra', '>= 1.3.3'
 gem 'json'
 gem 'rabl', :path => File.expand_path(File.dirname(__FILE__) + "/../../")
 
 # Test requirements
 gem 'riot', :group => "test"
-gem 'rack-test', :require => "rack/test", :group => "test"
+gem 'rack-test', :require => "rack/test", :group => "test"

data/lib/rabl.rb

@@ -12,6 +12,7 @@ require 'rabl/builder'
 require 'rabl/configuration'
 require 'rabl/renderer'
 require 'rabl/cache_engine'
+require 'rabl/json_engine'
 require 'rabl/railtie' if defined?(Rails) && Rails.version =~ /^3/
 
 # Rabl.register!

data/lib/rabl/configuration.rb

@@ -16,9 +16,6 @@ begin
 rescue LoadError
 end
 
-# Load MultiJSON
-require 'multi_json'
-
 module Rabl
   # Rabl.host
   class Configuration
@@ -65,19 +62,16 @@ module Rabl
       @cache_engine          = Rabl::CacheEngine.new
     end
 
-    # @param [Symbol, String, #encode] engine_name The name of a JSON engine,
+    # @param [Symbol, Class] engine_name The name of a JSON engine,
     #   or class that responds to `encode`, to use to encode Rabl templates
     #   into JSON. For more details, see the MultiJson gem.
     def json_engine=(engine_name_or_class)
-      @engine_name = engine_name_or_class
-      # multi_json compatibility TODO
-      MultiJson.respond_to?(:use) ? MultiJson.use(@engine_name) :
-        MultiJson.engine = @engine_name
+      JsonEngine.instance.set(engine_name_or_class)
     end
 
     # @return The JSON engine used to encode Rabl templates into JSON
     def json_engine
-      get_json_engine
+      JsonEngine.instance.current_engine
     end
 
     ##
@@ -109,16 +103,5 @@ module Rabl
     def default_xml_options
       @_default_xml_options ||= @xml_options.reverse_merge(DEFAULT_XML_OPTIONS)
     end
-
-    private
-
-    def get_json_engine
-      if !defined?(@engine_name) && defined?(Rails)
-        ActiveSupport::JSON
-      else # use multi_json
-        # multi_json compatibility TODO
-        MultiJson.respond_to?(:adapter) ? MultiJson.adapter : MultiJson.engine
-      end
-    end
   end
 end

data/lib/rabl/engine.rb

@@ -23,6 +23,7 @@ module Rabl
       reset_options!
       @_locals, @_scope = locals, scope
       self.copy_instance_variables_from(@_scope, [:@assigns, :@helpers])
+      locals.each { |k,v| instance_variable_set(:"@#{k}", v) }
       @_options[:scope] = @_scope
       @_options[:format] ||= self.request_format
       @_data = locals[:object] || self.default_object

data/lib/rabl/json_engine.rb

@@ -0,0 +1,33 @@
+# Defines the default JSON engine for RABL when rendering JSON is invoked on a template.
+# You can define your own json engine by creating an object that responds to the `encode` method
+# and setting the corresponding configuration option:
+#
+#     config.json_engine = ActiveSupport::JSON
+#
+
+require 'multi_json'
+require 'singleton'
+
+module Rabl
+  class JsonEngine
+    include Singleton
+
+    attr_reader :current_engine
+
+    def initialize
+      @current_engine = MultiJson.respond_to?(:adapter) ? MultiJson.adapter : MultiJson.engine
+    end
+
+    def set(engine_name_or_class)
+      @current_engine = begin
+        MultiJson.respond_to?(:use) ?
+          MultiJson.use(engine_name_or_class) :
+          MultiJson.engine = engine_name_or_class
+      rescue RuntimeError => e #
+        # Re-raise if engine_name_or_class is invalid
+        raise e unless engine_name_or_class.respond_to?(:encode)
+        engine_name_or_class
+      end
+    end
+  end # JsonEngine
+end # Rabl

data/lib/rabl/renderer.rb

@@ -32,12 +32,6 @@ module Rabl
       @options = options
       @object = object
 
-      if @options[:locals]
-        @options[:locals].delete(:object) if @object
-        @options[:locals].each do |k,v|
-          instance_variable_set(:"@#{k}", v)
-        end
-      end
       engine.source = self.process_source(source)
     end
 

data/lib/rabl/version.rb

@@ -1,3 +1,3 @@
 module Rabl
-  VERSION = "0.7.1"
+  VERSION = "0.7.2"
 end

data/rabl.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rake'
   s.add_development_dependency 'tilt'
   s.add_development_dependency 'yajl-ruby'
-  s.add_development_dependency 'msgpack', '~> 0.4.5'
-  s.add_development_dependency 'bson', '~> 1.5.2'
+  s.add_development_dependency 'msgpack',  '~> 0.4.5'
+  s.add_development_dependency 'bson',     '~> 1.7.0'
   s.add_development_dependency 'plist'
 end

data/test.watchr

@@ -45,4 +45,3 @@ Signal.trap 'INT' do
     run_all_tests
   end
 end
-

data/test/bson_engine_test.rb

@@ -1,7 +1,5 @@
 require File.expand_path('../teststrap', __FILE__)
-require File.expand_path('../../lib/rabl', __FILE__)
-require File.expand_path('../../lib/rabl/template', __FILE__)
-require File.expand_path('../models/user', __FILE__)
+require 'rabl/template'
 
 context "Rabl::Engine" do
   helper(:rabl) { |t| RablTemplate.new("code", :format => 'bson') { t } }

data/test/builder_test.rb

@@ -1,5 +1,4 @@
 require File.expand_path('../teststrap',   __FILE__)
-require File.expand_path('../models/user', __FILE__)
 
 context "Rabl::Builder" do
   helper(:builder)    { |opt| Rabl::Builder.new(opt) }

data/test/configuration_test.rb

@@ -1,5 +1,4 @@
 require File.expand_path('../teststrap', __FILE__)
-require File.expand_path('../../lib/rabl', __FILE__)
 
 context 'Rabl::Configuration' do
   context 'defaults' do
@@ -16,7 +15,7 @@ context 'Rabl::Configuration' do
     asserts(:cache_engine).is_a?(Rabl::CacheEngine)
   end
 
-  context 'custom JSON engine' do
+  context 'custom JSON engine configured as Symbol' do
     setup do
       Rabl.configure do |c|
         c.json_engine = :yajl
@@ -24,5 +23,23 @@ context 'Rabl::Configuration' do
     end
 
     asserts('uses a custom JSON engine') { topic.json_engine.to_s =~ /MultiJson.*::Yajl/ }
-  end
+  end # custom json, symbol
+
+  context 'custom JSON engine configured as Class' do
+    setup do
+      Rabl.configure do |c|
+        c.json_engine = ActiveSupport::JSON
+      end
+    end
+
+    asserts('uses a custom JSON engine') { topic.json_engine.to_s == 'ActiveSupport::JSON' }
+  end # custom JSON, class
+
+  context 'invalid JSON engine configured' do
+    asserts {
+      Rabl.configure do |c|
+        c.json_engine = Kernel
+      end
+    }.raises(RuntimeError)
+  end # invalid
 end

data/test/engine_test.rb

@@ -1,7 +1,6 @@
+require 'json'
 require File.expand_path('../teststrap', __FILE__)
-require File.expand_path('../../lib/rabl', __FILE__)
-require File.expand_path('../../lib/rabl/template', __FILE__)
-require File.expand_path('../models/user', __FILE__)
+require 'rabl/template'
 require File.expand_path('../models/ormless', __FILE__)
 
 context "Rabl::Engine" do
@@ -173,8 +172,8 @@ context "Rabl::Engine" do
         }
         scope = Object.new
         scope.instance_variable_set :@user, User.new(:name => 'irvine')
-        template.render(scope).split('').sort
-      end.equals "{\"user\":{\"name\":\"irvine\"}}".split('').sort
+        JSON.parse(template.render(scope))
+      end.equals JSON.parse("{\"user\":{\"name\":\"irvine\"}}")
 
       asserts "that it can add attribute under a different key name through :as" do
         template = rabl %{
@@ -183,8 +182,8 @@ context "Rabl::Engine" do
         }
         scope = Object.new
         scope.instance_variable_set :@user, User.new(:name => 'irvine')
-        template.render(scope).split('').sort
-      end.equals "{\"user\":{\"city\":\"irvine\"}}".split('').sort
+        JSON.parse(template.render(scope))
+      end.equals JSON.parse("{\"user\":{\"city\":\"irvine\"}}")
 
       asserts "that it can add attribute under a different key name through hash" do
         template = rabl %{
@@ -193,8 +192,8 @@ context "Rabl::Engine" do
         }
         scope = Object.new
         scope.instance_variable_set :@user, User.new(:name => 'irvine')
-        template.render(scope).split('').sort
-      end.equals "{\"user\":{\"city\":\"irvine\"}}".split('').sort
+        JSON.parse(template.render(scope))
+      end.equals JSON.parse("{\"user\":{\"city\":\"irvine\"}}")
     end
 
     context "#code" do
@@ -202,15 +201,15 @@ context "Rabl::Engine" do
         template = rabl %{
           code(:foo) { 'bar' }
         }
-        template.render(Object.new).split('').sort
-      end.equals "{\"foo\":\"bar\"}".split('').sort
+        template.render(Object.new)
+      end.equals "{\"foo\":\"bar\"}"
 
       asserts "that it can be passed conditionals" do
         template = rabl %{
           code(:foo, :if => lambda { |i| false }) { 'bar' }
         }
-        template.render(Object.new).split('').sort
-      end.equals "{}".split('').sort
+        template.render(Object.new)
+      end.equals "{}"
 
       asserts "that it can merge the result with a collection element given no name" do
         template = rabl %{
@@ -221,8 +220,8 @@ context "Rabl::Engine" do
         }
         scope = Object.new
         scope.instance_variable_set :@users, [User.new(:name => 'a'), User.new(:name => 'b')]
-        template.render(scope).split('').sort
-      end.equals "[{\"user\":{\"name\":\"a\"}},{\"user\":{\"name\":\"b\"}}]".split('').sort
+        JSON.parse(template.render(scope))
+      end.equals JSON.parse("[{\"user\":{\"name\":\"a\"}},{\"user\":{\"name\":\"b\"}}]")
 
       asserts "that it can merge the result on a child node given no name" do
         template = rabl %{
@@ -236,8 +235,8 @@ context "Rabl::Engine" do
         }
         scope = Object.new
         scope.instance_variable_set :@user, User.new(:name => 'leo', :city => 'LA')
-        template.render(scope).split('').sort
-      end.equals "{\"user\":{\"name\":\"leo\",\"user\":{\"city\":\"LA\"}}}".split('').sort
+        JSON.parse(template.render(scope))
+      end.equals JSON.parse("{\"user\":{\"name\":\"leo\",\"user\":{\"city\":\"LA\"}}}")
     end
 
     context "#child" do
@@ -249,8 +248,8 @@ context "Rabl::Engine" do
         }
         scope = Object.new
         scope.instance_variable_set :@user, User.new(:name => 'leo', :city => 'LA')
-        template.render(scope).split('').sort
-      end.equals "{\"user\":{\"name\":\"leo\",\"user\":{\"city\":\"LA\"}}}".split('').sort
+        JSON.parse(template.render(scope))
+      end.equals JSON.parse("{\"user\":{\"name\":\"leo\",\"user\":{\"city\":\"LA\"}}}")
 
       asserts "that it can create a child node with different key" do
         template = rabl %{
@@ -260,9 +259,8 @@ context "Rabl::Engine" do
         }
         scope = Object.new
         scope.instance_variable_set :@user, User.new(:name => 'leo', :city => 'LA')
-        template.render(scope).split('').sort
-
-      end.equals "{\"user\":{\"name\":\"leo\",\"person\":{\"city\":\"LA\"}}}".split('').sort
+        JSON.parse(template.render(scope))
+      end.equals JSON.parse("{\"user\":{\"name\":\"leo\",\"person\":{\"city\":\"LA\"}}}")
 
       asserts "that it passes the data object to the block" do
         template = rabl %{
@@ -287,8 +285,8 @@ context "Rabl::Engine" do
         }
         scope = Object.new
         scope.instance_variable_set :@user, User.new(:name => 'leo', :city => 'LA', :age => 12)
-        template.render(scope).split('').sort
-      end.equals "{\"user\":{\"name\":\"leo\",\"city\":\"LA\",\"age\":12}}".split('').sort
+        JSON.parse(template.render(scope))
+      end.equals JSON.parse("{\"user\":{\"name\":\"leo\",\"city\":\"LA\",\"age\":12}}")
 
       asserts "that it passes the data object to the block" do
         template = rabl %{
@@ -451,8 +449,8 @@ context "Rabl::Engine" do
         }
         scope = Object.new
         scope.instance_variable_set :@user, User.new(:name => 'leo', :city => 'LA')
-        template.render(scope).split('').sort
-      end.equals "{\"name\":\"leo\",\"user\":{\"city\":\"LA\"}}".split('').sort
+        JSON.parse(template.render(scope))
+      end.equals JSON.parse("{\"name\":\"leo\",\"user\":{\"city\":\"LA\"}}")
 
       asserts "that it can create a child node with different key" do
         template = rabl %{
@@ -462,9 +460,8 @@ context "Rabl::Engine" do
         }
         scope = Object.new
         scope.instance_variable_set :@user, User.new(:name => 'leo', :city => 'LA')
-        template.render(scope).split('').sort
-
-      end.equals "{\"name\":\"leo\",\"person\":{\"city\":\"LA\"}}".split('').sort
+        JSON.parse(template.render(scope))
+      end.equals JSON.parse("{\"name\":\"leo\",\"person\":{\"city\":\"LA\"}}")
 
       asserts "that it can be passed conditionals" do
         template = rabl %{
@@ -474,9 +471,8 @@ context "Rabl::Engine" do
         }
         scope = Object.new
         scope.instance_variable_set :@user, User.new(:name => 'leo', :city => 'LA')
-        template.render(scope).split('').sort
-
-      end.equals "{\"name\":\"leo\"}".split('').sort
+        template.render(scope)
+      end.equals "{\"name\":\"leo\"}"
     end
 
     context "#glue" do
@@ -489,8 +485,8 @@ context "Rabl::Engine" do
         }
         scope = Object.new
         scope.instance_variable_set :@user, User.new(:name => 'leo', :city => 'LA', :age => 12)
-        template.render(scope).split('').sort
-      end.equals "{\"name\":\"leo\",\"city\":\"LA\",\"age\":12}".split('').sort
+        JSON.parse(template.render(scope))
+      end.equals JSON.parse("{\"name\":\"leo\",\"city\":\"LA\",\"age\":12}")
     end
 
     teardown do
@@ -508,7 +504,6 @@ context "Rabl::Engine" do
     end
 
     context "#child" do
-
       asserts "that it can create a child node without child root" do
         template = rabl %{
           child @users
@@ -517,7 +512,6 @@ context "Rabl::Engine" do
         scope.instance_variable_set :@users, [User.new, User.new]
         template.render(scope)
       end.equals "{\"users\":[{},{}]}"
-
     end
 
     teardown do

data/test/helpers_test.rb

@@ -1,7 +1,6 @@
 require 'tmpdir'
 require 'pathname'
 require File.expand_path('../teststrap', __FILE__)
-require File.expand_path('../../lib/rabl', __FILE__)
 
 class TestHelperMethods
   include Rabl::Helpers

data/test/integration/rails3_2/posts_controller_test.rb

@@ -134,6 +134,7 @@ context "PostsController" do
     end # date node
 
     asserts("contains helper action") { topic["foo"] }.equals { "BAR!" }
+    denies("contains helper action") { topic["created_at_in_words"] }.nil
 
     asserts("contains post attributes via node") { topic["post"] }.equals { [@post1.title, @post1.body] }
   end # show action, json

data/test/models/ormless.rb

@@ -1,2 +1,3 @@
 class Ormless
+  # Nothing here
 end

data/test/models/user.rb

@@ -1,22 +1,26 @@
-class User
-  attr_accessor :age, :city, :name, :first
+unless defined?(User)
+  class User
+    attr_accessor :age, :city, :name, :first
 
-  DEFAULT_AGE   = 24
-  DEFAULT_CITY  = 'irvine'
-  DEFAULT_NAME  = 'rabl'
-  DEFAULT_FIRST = 'bob'
+    DEFAULT_AGE   = 24
+    DEFAULT_CITY  = 'irvine'
+    DEFAULT_NAME  = 'rabl'
+    DEFAULT_FIRST = 'bob'
 
-  def initialize(attributes={})
-    self.age   = attributes[:age]   || DEFAULT_AGE
-    self.city  = attributes[:city]  || DEFAULT_CITY
-    self.name  = attributes[:name]  || DEFAULT_NAME
-    self.first = attributes[:first] || DEFAULT_FIRST
+    def initialize(attributes={})
+      self.age   = attributes[:age]   || DEFAULT_AGE
+      self.city  = attributes[:city]  || DEFAULT_CITY
+      self.name  = attributes[:name]  || DEFAULT_NAME
+      self.first = attributes[:first] || DEFAULT_FIRST
+    end
   end
 end
 
-module NestedScope
-  class User
-    def controller; self; end
-    def controller_name; self.class.name.downcase; end
+unless defined?(NestedScope::User)
+  module NestedScope
+    class User
+      def controller; self; end
+      def controller_name; self.class.name.downcase; end
+    end
   end
 end

data/test/msgpack_engine_test.rb

@@ -1,7 +1,5 @@
 require File.expand_path('../teststrap', __FILE__)
-require File.expand_path('../../lib/rabl', __FILE__)
-require File.expand_path('../../lib/rabl/template', __FILE__)
-require File.expand_path('../models/user', __FILE__)
+require 'rabl/template'
 
 context "Rabl::Engine" do
   helper(:rabl) { |t| RablTemplate.new("code", :format => 'msgpack') { t } }

data/test/partials_test.rb

@@ -1,7 +1,6 @@
 require 'tmpdir'
 require 'pathname'
 require File.expand_path('../teststrap', __FILE__)
-require File.expand_path('../../lib/rabl', __FILE__)
 
 class TestPartial
   include Rabl::Partials

data/test/plist_engine_test.rb

@@ -1,7 +1,5 @@
 require File.expand_path('../teststrap', __FILE__)
-require File.expand_path('../../lib/rabl', __FILE__)
-require File.expand_path('../../lib/rabl/template', __FILE__)
-require File.expand_path('../models/user', __FILE__)
+require 'rabl/template'
 
 context "Rabl::Engine" do
   helper(:rabl) { |t| RablTemplate.new("code", :format => 'plist') { t } }

data/test/renderer_test.rb

@@ -1,7 +1,7 @@
 require 'tmpdir'
 require 'pathname'
+require 'json'
 require File.expand_path('../teststrap', __FILE__)
-require File.expand_path('../../lib/rabl', __FILE__)
 
 context "Rabl::Renderer" do
   helper(:tmp_path) { @tmp_path ||= Pathname.new(Dir.mktmpdir) }
@@ -29,8 +29,8 @@ context "Rabl::Renderer" do
       user = User.new(:name => 'irvine')
 
       renderer = Rabl::Renderer.new(source, user, { :format => 'json', :root => true, :view_path => '/path/to/views' })
-      renderer.render
-    end.equals "{\"user\":{\"city\":\"irvine\"}}"
+      JSON.parse(renderer.render)
+    end.equals JSON.parse("{\"user\":{\"city\":\"irvine\"}}")
 
     asserts 'allows redirecting scope to another object' do
       source = %q{
@@ -42,8 +42,8 @@ context "Rabl::Renderer" do
       scope.instance_variable_set :@user, User.new(:name => 'irvine')
 
       renderer = Rabl::Renderer.new(source, nil, { :format => 'json', :scope => scope })
-      renderer.render
-    end.equals "{\"user\":{\"city\":\"irvine\"}}"
+      JSON.parse(renderer.render)
+    end.equals JSON.parse("{\"user\":{\"city\":\"irvine\"}}")
 
     asserts 'accepts scope on render' do
       source = %q{
@@ -55,8 +55,8 @@ context "Rabl::Renderer" do
       scope.instance_variable_set :@user, User.new(:name => 'irvine')
 
       renderer = Rabl::Renderer.new(source)
-      renderer.render(scope)
-    end.equals "{\"user\":{\"city\":\"irvine\"}}"
+      JSON.parse(renderer.render(scope))
+    end.equals JSON.parse("{\"user\":{\"city\":\"irvine\"}}")
 
     asserts 'passes :locals to render' do
       source = %q{
@@ -67,8 +67,8 @@ context "Rabl::Renderer" do
       user = User.new(:name => 'irvine')
 
       renderer = Rabl::Renderer.new(source, nil, { :format => 'json', :locals => {:object => user, :zipcode => "92602"} })
-      renderer.render.split("").sort
-    end.equals "{\"user\":{\"city\":\"irvine\",\"zipcode\":\"92602\"}}".split("").sort
+      JSON.parse(renderer.render)
+    end.equals JSON.parse("{\"user\":{\"city\":\"irvine\",\"zipcode\":\"92602\"}}")
 
     asserts 'loads source from file' do
       File.open(tmp_path + "test.json.rabl", "w") do |f|
@@ -81,8 +81,8 @@ context "Rabl::Renderer" do
       user = User.new(:name => 'irvine')
 
       renderer = Rabl::Renderer.new('test', user, :view_path => tmp_path)
-      renderer.render.split("").sort
-    end.equals "{\"user\":{\"age\":24,\"name\":\"irvine\"}}".split("").sort
+      JSON.parse(renderer.render)
+    end.equals JSON.parse("{\"user\":{\"age\":24,\"name\":\"irvine\"}}")
 
     asserts 'uses globally configured view paths' do
       Rabl.configure do |config|
@@ -98,9 +98,8 @@ context "Rabl::Renderer" do
       user = User.new(:name => 'irvine')
 
       renderer = Rabl::Renderer.new('test', user)
-      renderer.render.split("").sort
-    end.equals "{\"user\":{\"age\":24,\"name\":\"irvine\"}}".split("").sort
-
+      JSON.parse(renderer.render)
+    end.equals JSON.parse("{\"user\":{\"age\":24,\"name\":\"irvine\"}}")
 
     asserts 'handles paths for extends' do
       File.open(tmp_path + "test.json.rabl", "w") do |f|
@@ -120,8 +119,30 @@ context "Rabl::Renderer" do
       user = User.new(:name => 'irvine')
 
       renderer = Rabl::Renderer.new('user', user, :view_path => tmp_path)
-      renderer.render.split("").sort
-    end.equals "{\"user\":{\"age\":24,\"name\":\"irvine\"}}".split("").sort
+      JSON.parse(renderer.render)
+    end.equals JSON.parse("{\"user\":{\"age\":24,\"name\":\"irvine\"}}")
+
+    # FIXME template is found and rendered but not included in final results
+    # asserts 'handles paths for partial' do
+    #   File.open(tmp_path + "test.json.rabl", "w") do |f|
+    #     f.puts %q{
+    #       attributes :age
+    #     }
+    #   end
+
+    #   File.open(tmp_path + "user.json.rabl", "w") do |f|
+    #     f.puts %(
+    #       object @user
+    #       attribute :name
+    #       partial 'test', :object => @user
+    #     )
+    #   end
+
+    #   user = User.new(:name => 'irvine')
+
+    #   renderer = Rabl::Renderer.new('user', user, :view_path => tmp_path)
+    #   JSON.parse(renderer.render)
+    # end.equals JSON.parse("{\"user\":{\"age\":24,\"name\":\"irvine\"}}")
 
     asserts 'Rabl.render calls Renderer' do
       File.open(tmp_path + "test.json.rabl", "w") do |f|
@@ -133,8 +154,8 @@ context "Rabl::Renderer" do
 
       user = User.new(:name => 'irvine')
 
-      Rabl.render(user, 'test', :view_path => tmp_path).split("").sort
-    end.equals "{\"user\":{\"age\":24,\"name\":\"irvine\"}}".split("").sort
+      JSON.parse(Rabl.render(user, 'test', :view_path => tmp_path))
+    end.equals JSON.parse("{\"user\":{\"age\":24,\"name\":\"irvine\"}}")
 
     asserts 'it renders collections' do
       File.open(tmp_path + "test.json.rabl", "w") do |f|
@@ -146,8 +167,8 @@ context "Rabl::Renderer" do
 
       scope = Object.new
       scope.instance_variable_set :@users, nil
-      Rabl.render([], 'test', :view_path => tmp_path, :scope => scope).split("").sort
-    end.equals "{\"users\":[]}".split("").sort
+      Rabl.render([], 'test', :view_path => tmp_path, :scope => scope)
+    end.equals "{\"users\":[]}"
 
     asserts 'it renders an array when given an empty collection' do
       File.open(tmp_path + "test.json.rabl", "w") do |f|
@@ -188,8 +209,8 @@ context "Rabl::Renderer" do
       stub(user).profile { stub!.gender { "male" } }
 
       renderer = Rabl::Renderer.new('user', user, :view_path => tmp_path)
-      renderer.render.split("").sort
-    end.equals "{\"user\":{\"name\":\"irvine\",\"object\":{\"gender\":\"male\"},\"gender\":\"male\"}}".split("").sort
+      JSON.parse(renderer.render)
+    end.equals JSON.parse("{\"user\":{\"name\":\"irvine\",\"object\":{\"gender\":\"male\"},\"gender\":\"male\"}}")
   end
 
   context '.json' do
@@ -202,8 +223,8 @@ context "Rabl::Renderer" do
       end
 
       user = User.new(:name => 'ivan')
-      Rabl::Renderer.json(user, 'test', :view_path => tmp_path).split("").sort
-    end.equals "{\"user\":{\"age\":24,\"name\":\"ivan\"}}".split("").sort
+      JSON.parse(Rabl::Renderer.json(user, 'test', :view_path => tmp_path))
+    end.equals JSON.parse("{\"user\":{\"age\":24,\"name\":\"ivan\"}}")
   end
 
   context '.msgpack' do
@@ -216,8 +237,8 @@ context "Rabl::Renderer" do
       end
 
       user = User.new(:name => 'ivan')
-      Rabl::Renderer.msgpack(user, 'test', :view_path => tmp_path).split("").sort
-    end.equals "\x81\xA4user\x82\xA3age\x18\xA4name\xA4ivan".split("").sort
+      Rabl::Renderer.msgpack(user, 'test', :view_path => tmp_path)
+    end.equals "\x81\xA4user\x82\xA3age\x18\xA4name\xA4ivan"
   end
 
   context '.plist' do

data/test/template_test.rb

@@ -1,5 +1,5 @@
 require File.expand_path('../teststrap',__FILE__)
-require File.expand_path('../../lib/rabl/template', __FILE__)
+require 'rabl/template'
 
 class Scope
 end

data/test/teststrap.rb

@@ -1,3 +1,5 @@
+$LOAD_PATH.unshift(File.expand_path("../../lib", __FILE__))
+
 module Kernel
   def silence_warnings
     with_warnings(nil) { yield }
@@ -15,7 +17,8 @@ silence_warnings do
   require 'riot'
   require 'riot/rr'
   require 'tilt'
-  require File.expand_path('../../lib/rabl',__FILE__)
+  require 'rabl'
+  require File.expand_path('../models/user', __FILE__)
 end
 
 Riot.pretty_dots

data/test/xml_test.rb

@@ -0,0 +1,287 @@
+require 'active_support/core_ext/hash/conversions'
+require File.expand_path('../teststrap', __FILE__)
+require 'rabl/template'
+
+context "Rabl::Engine" do
+  helper(:rabl) { |t| RablTemplate.new("code", :format => 'xml') { t } }
+
+  # TODO fix annoying warnings in this file:
+  # gems/builder-3.0.3/lib/builder/xmlbase.rb:181: warning: method redefined; discarding old user
+  setup { @old_verbose, $VERBOSE = $VERBOSE, nil }
+  teardown { $VERBOSE = @old_verbose }
+
+  context "with xml defaults" do
+    setup do
+      Rabl.configure do |config|
+        # Comment this line out because include_xml_root to false is default.
+        #config.include_xml_root = false
+      end
+    end
+
+    context "#object" do
+      asserts "that it sets data source" do
+        template = rabl %q{
+          object @user
+        }
+        scope = Object.new
+        scope.instance_variable_set :@user, User.new
+        template.render(scope)
+      end.matches ""
+
+      asserts "that it can set root node" do
+        template = rabl %q{
+          object @user => :person
+        }
+        scope = Object.new
+        scope.instance_variable_set :@user, User.new
+        template.render(scope)
+      end.equals "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<person>\n</person>\n"
+    end
+
+    context "#collection" do
+      asserts "that it sets object to be casted as a simple array" do
+        template = rabl %{
+          collection @users
+        }
+        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<users type=\"array\">\n  <user>\n  </user>\n  <user>\n  </user>\n</users>\n"
+
+      asserts "that it sets root node for objects" do
+        template = rabl %{
+          collection @users => :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</people>\n"
+    end
+
+    context "#attribute" do
+      asserts "that it adds an attribute or method to be included in output" do
+        template = rabl %{
+          object @user
+          attribute :name
+        }
+        scope = Object.new
+        scope.instance_variable_set :@user, User.new(:name => 'irvine')
+        template.render(scope)
+      end.equals "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<user>\n  <name>irvine</name>\n</user>\n"
+
+      asserts "that it can add attribute under a different key name through :as" do
+        template = rabl %{
+          object @user
+          attribute :name, :as => 'city'
+        }
+        scope = Object.new
+        scope.instance_variable_set :@user, User.new(:name => 'irvine')
+        template.render(scope)
+      end.equals "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<user>\n  <city>irvine</city>\n</user>\n"
+
+      asserts "that it can add attribute under a different key name through hash" do
+        template = rabl %{
+          object @user
+          attribute :name => :city
+        }
+        scope = Object.new
+        scope.instance_variable_set :@user, User.new(:name => 'irvine')
+        template.render(scope)
+      end.equals "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<user>\n  <city>irvine</city>\n</user>\n"
+    end
+
+    context "#code" do
+      asserts "that it can create an arbitraty code node" do
+        template = rabl %{
+          code(:foo) { 'bar' }
+        }
+        template.render(Object.new)
+      end.equals "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<hash>\n  <foo>bar</foo>\n</hash>\n"
+
+      asserts "that it can be passed conditionals" do
+        template = rabl %{
+          code(:foo, :if => lambda { |i| false }) { 'bar' }
+        }
+        template.render(Object.new)
+      end.equals "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<hash>\n</hash>\n"
+    end
+
+    context "#child" do
+      asserts "that it can create a child node" do
+        template = rabl %{
+          object @user
+          child(@user) { attribute :city }
+        }
+        scope = Object.new
+        scope.instance_variable_set :@user, User.new(:name => 'leo', :city => 'LA')
+        template.render(scope)
+      end.equals "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<user>\n  <user>\n    <city>LA</city>\n  </user>\n</user>\n"
+
+      asserts "that it can create a child node with different key" do
+        template = rabl %{
+          object @user
+          attribute :name
+          child(@user => :person) { attribute :city }
+        }
+        scope = Object.new
+        scope.instance_variable_set :@user, User.new(:name => 'leo', :city => 'LA')
+        template.render(scope)
+      end.equals "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<user>\n  <name>leo</name>\n  <person>\n    <city>LA</city>\n  </person>\n</user>\n"
+    end
+
+    context "#glue" do
+      asserts "that it glues data from a child node" do
+        template = rabl %{
+          object @user
+          attribute :name
+          glue(@user) { attribute :city }
+          glue(@user) { attribute :age  }
+        }
+        scope = Object.new
+        scope.instance_variable_set :@user, User.new(:name => 'leo', :city => 'LA', :age => 12)
+        template.render(scope)
+      end.equals "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<user>\n  <name>leo</name>\n  <city>LA</city>\n  <age type=\"integer\">12</age>\n</user>\n"
+    end
+
+    teardown do
+      Rabl.reset_configuration!
+    end
+  end
+
+  context "with xml root" do
+    setup do
+      Rabl.configure do |config|
+        config.include_xml_root = true
+      end
+    end
+
+    context "#object" do
+      asserts "that it sets data source" do
+        template = rabl %q{
+          object @user
+        }
+        scope = Object.new
+        scope.instance_variable_set :@user, User.new
+        template.render(scope)
+      end.matches "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<user>\n  <user>\n  </user>\n</user>\n"
+
+      asserts "that it can set root node" do
+        template = rabl %q{
+          object @user => :person
+        }
+        scope = Object.new
+        scope.instance_variable_set :@user, User.new
+        template.render(scope)
+      end.equals "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<person>\n  <person>\n  </person>\n</person>\n"
+    end
+
+    context "#collection" do
+      asserts "that it sets object to be casted as a simple array" do
+        template = rabl %{
+          collection @users
+        }
+        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<users type=\"array\">\n  <user>\n    <user>\n    </user>\n  </user>\n  <user>\n    <user>\n    </user>\n  </user>\n</users>\n"
+
+      asserts "that it sets root node for objects" do
+        template = rabl %{
+          collection @users => :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
+      asserts "that it adds an attribute or method to be included in output" do
+        template = rabl %{
+          object @user
+          attribute :name
+        }
+        scope = Object.new
+        scope.instance_variable_set :@user, User.new(:name => 'irvine')
+        template.render(scope)
+      end.equals "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<user>\n  <user>\n    <name>irvine</name>\n  </user>\n</user>\n"
+
+      asserts "that it can add attribute under a different key name through :as" do
+        template = rabl %{
+          object @user
+          attribute :name, :as => 'city'
+        }
+        scope = Object.new
+        scope.instance_variable_set :@user, User.new(:name => 'irvine')
+        template.render(scope)
+      end.equals "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<user>\n  <user>\n    <city>irvine</city>\n  </user>\n</user>\n"
+
+      asserts "that it can add attribute under a different key name through hash" do
+        template = rabl %{
+          object @user
+          attribute :name => :city
+        }
+        scope = Object.new
+        scope.instance_variable_set :@user, User.new(:name => 'irvine')
+        template.render(scope)
+      end.equals "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<user>\n  <user>\n    <city>irvine</city>\n  </user>\n</user>\n"
+    end
+
+    context "#code" do
+      asserts "that it can create an arbitrary code node" do
+        template = rabl %{
+          code(:foo) { 'bar' }
+        }
+        template.render(Object.new)
+      end.equals "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<hash>\n  <foo>bar</foo>\n</hash>\n"
+
+      asserts "that it can be passed conditionals" do
+        template = rabl %{
+          code(:foo, :if => lambda { |i| false }) { 'bar' }
+        }
+        template.render(Object.new)
+      end.equals "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<hash>\n</hash>\n"
+    end
+
+    context "#child" do
+      asserts "that it can create a child node" do
+        template = rabl %{
+          object @user
+          child(@user) { attribute :city }
+        }
+        scope = Object.new
+        scope.instance_variable_set :@user, User.new(:name => 'leo', :city => 'LA')
+        template.render(scope)
+      end.equals "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<user>\n  <user>\n    <user>\n      <city>LA</city>\n    </user>\n  </user>\n</user>\n"
+
+      asserts "that it can create a child node with different key" do
+        template = rabl %{
+          object @user
+          attribute :name
+          child(@user => :person) { attribute :city }
+        }
+        scope = Object.new
+        scope.instance_variable_set :@user, User.new(:name => 'leo', :city => 'LA')
+        template.render(scope)
+      end.equals "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<user>\n  <user>\n    <name>leo</name>\n    <person>\n      <city>LA</city>\n    </person>\n  </user>\n</user>\n"
+    end
+
+    context "#glue" do
+      asserts "that it glues data from a child node" do
+        template = rabl %{
+          object @user
+          attribute :name
+          glue(@user) { attribute :city }
+          glue(@user) { attribute :age  }
+        }
+        scope = Object.new
+        scope.instance_variable_set :@user, User.new(:name => 'leo', :city => 'LA', :age => 12)
+        template.render(scope)
+      end.equals "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<user>\n  <user>\n    <name>leo</name>\n    <city>LA</city>\n    <age type=\"integer\">12</age>\n  </user>\n</user>\n"
+    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.7.1
+  version: 0.7.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-07 00:00:00.000000000 Z
+date: 2012-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -146,7 +146,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.5.2
+        version: 1.7.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -154,7 +154,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.5.2
+        version: 1.7.0
 - !ruby/object:Gem::Dependency
   name: plist
   requirement: !ruby/object:Gem::Requirement
@@ -398,6 +398,7 @@ files:
 - lib/rabl/configuration.rb
 - lib/rabl/engine.rb
 - lib/rabl/helpers.rb
+- lib/rabl/json_engine.rb
 - lib/rabl/partials.rb
 - lib/rabl/railtie.rb
 - lib/rabl/renderer.rb
@@ -424,6 +425,7 @@ files:
 - test/silence.rb
 - test/template_test.rb
 - test/teststrap.rb
+- test/xml_test.rb
 homepage: https://github.com/nesquena/rabl
 licenses: []
 post_install_message: 
@@ -468,3 +470,4 @@ test_files:
 - test/silence.rb
 - test/template_test.rb
 - test/teststrap.rb
+- test/xml_test.rb