rabl 0.2.8 → 0.3.0

data/README.md

@@ -30,7 +30,7 @@ gem 'rabl'
 
 and run `bundle install` to install the dependency.
 
-If you are using **Rails 2.X, Rails 3 or Padrino**, RABL works without configuration.
+If you are using **Rails 2.X, Rails 3, Rails 3.X or Padrino**, RABL works without configuration.
 
 With Sinatra, or any other tilt-based framework, simply register:
 
@@ -86,6 +86,7 @@ RABL is intended to require little to no configuration to get working. This is t
 # config/initializers/rabl_init.rb
 Rabl.configure do |config|
   # Commented as these are the defaults
+  # config.json_engine = nil # Any multi\_json engines
   # config.include_json_root = true
   # config.include_xml_root  = false
   # config.enable_json_callbacks = false
@@ -95,6 +96,15 @@ 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.
 
+Note that the `json_engine` option uses the [multi_json](http://intridea.com/2010/6/14/multi-json-the-swappable-json-handler) intelligent engine defaults so in most cases you **don't need to configure this** directly. If you wish to use yajl as the primary JSON encoding engine simply add that to your Gemfile:
+
+```ruby
+# Gemfile
+gem 'yajl-ruby', :require => "yajl"
+```
+
+and RABL will automatically start using that engine for encoding your JSON responses!
+
 ## Usage ##
 
 ### Object Assignment ###
@@ -327,6 +337,7 @@ Thanks to [Miso](http://gomiso.com) for allowing me to create this for our appli
 * [Rick Thomas](https://github.com/rickthomasjr) - Added options passing for extends and Sinatra testing
 * [Marjun](https://github.com/mpagalan) - Added xml option configurations
 * [Chris Kimpton](https://github.com/kimptoc) - Helping with documentation and wiki
+* [Sasha Koss](https://github.com/kossnocorp) - Added multi_json support
 
 More to come hopefully! Please fork and contribute, any help is appreciated!
 

data/TODO

@@ -1,3 +1 @@
-= TODO
-
- * Support xml and json rendering in Tilt template
+= TODO

data/lib/rabl/configuration.rb

@@ -4,6 +4,7 @@ module Rabl
     attr_accessor :include_json_root
     attr_accessor :include_xml_root
     attr_accessor :enable_json_callbacks
+    attr_accessor :json_engine
     attr_writer   :xml_options
 
     DEFAULT_XML_OPTIONS = { :dasherize  => true, :skip_types => false }
@@ -12,6 +13,7 @@ module Rabl
       @include_json_root     = true
       @include_xml_root      = false
       @enable_json_callbacks = false
+      @json_engine           = nil
       @xml_options           = {}
     end
 

data/lib/rabl/engine.rb

@@ -1,3 +1,5 @@
+require 'multi_json'
+
 module Rabl
   class Engine
     include Rabl::Helpers
@@ -7,6 +9,10 @@ module Rabl
     def initialize(source, options={})
       @_source = source
       @_options = options
+
+      if Rabl.configuration.json_engine
+        MultiJson.engine = Rabl.configuration.json_engine
+      end
     end
 
     # Renders the representation based on source, object, scope and locals
@@ -41,7 +47,7 @@ module Rabl
       include_root = Rabl.configuration.include_json_root
       options = options.reverse_merge(:root => include_root, :child_root => include_root)
       result = @_collection_name ? { @_collection_name => to_hash(options) } : to_hash(options)
-      format_json(result.to_json)
+      format_json MultiJson.encode(result)
     end
 
     # Returns an xml representation of the data object

data/lib/rabl/template.rb

@@ -63,5 +63,5 @@ if defined?(Rails) && Rails.version =~ /^3/
     end # handlers
   end
 
-  ActionView::Template.register_template_handler :rabl, ActionView::TemplateHandlers::Rabl
+  ActionView::Template.register_template_handler :rabl, ActionView::Template::Handlers::Rabl
 end

data/lib/rabl/version.rb

@@ -1,3 +1,3 @@
 module Rabl
-  VERSION = "0.2.8"
+  VERSION = "0.3.0"
 end

data/rabl.gemspec

@@ -19,9 +19,12 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
+  s.add_dependency 'multi_json', '~> 1.0.3'
+
   s.add_development_dependency 'riot', '~>0.12.3'
   s.add_development_dependency 'rr', '~>1.0.2'
   s.add_development_dependency 'mongoid'
   s.add_development_dependency 'tilt'
   s.add_development_dependency 'bson_ext'
+  s.add_development_dependency 'yajl-ruby'
 end

data/test/configuration_test.rb

@@ -9,6 +9,7 @@ context "Rabl::Configuration" do
     asserts(:include_json_root).equals true
     asserts(:include_xml_root).equals false
     asserts(:enable_json_callbacks).equals false
+    asserts(:json_engine).equals nil
   end
 
   context "with configuration" do
@@ -17,6 +18,7 @@ context "Rabl::Configuration" do
         config.include_json_root     = false
         config.include_xml_root      = true
         config.enable_json_callbacks = true
+        config.json_engine           = :yajl
       end
       Rabl.configuration
     end
@@ -24,6 +26,13 @@ context "Rabl::Configuration" do
     asserts(:include_json_root).equals false
     asserts(:include_xml_root).equals true
     asserts(:enable_json_callbacks).equals true
+    asserts(:json_engine).equals :yajl
+
+    teardown do
+      Rabl.configure do |config|
+        config.json_engine = MultiJson.default_engine
+      end
+    end
   end
 
 end

data/test/engine_test.rb

@@ -131,8 +131,8 @@ context "Rabl::Engine" do
         }
         scope = Object.new
         scope.instance_variable_set :@user, User.new(:name => 'leo', :city => 'LA')
-        template.render(scope)
-      end.equals "{\"user\":{\"name\":\"leo\",\"user\":{\"city\":\"LA\"}}}"
+        template.render(scope).split('').sort
+      end.equals "{\"user\":{\"name\":\"leo\",\"user\":{\"city\":\"LA\"}}}".split('').sort
 
       asserts "that it can create a child node with different key" do
         template = rabl %{
@@ -142,9 +142,9 @@ context "Rabl::Engine" do
         }
         scope = Object.new
         scope.instance_variable_set :@user, User.new(:name => 'leo', :city => 'LA')
-        template.render(scope)
+        template.render(scope).split('').sort
 
-      end.equals "{\"user\":{\"name\":\"leo\",\"person\":{\"city\":\"LA\"}}}"
+      end.equals "{\"user\":{\"name\":\"leo\",\"person\":{\"city\":\"LA\"}}}".split('').sort
     end
 
     context "#glue" do
@@ -158,11 +158,39 @@ context "Rabl::Engine" do
         }
         scope = Object.new
         scope.instance_variable_set :@user, User.new(:name => 'leo', :city => 'LA', :age => 12)
-        template.render(scope)
-      end.equals "{\"user\":{\"name\":\"leo\",\"city\":\"LA\",\"age\":12}}"
+        template.render(scope).split('').sort
+      end.equals "{\"user\":{\"name\":\"leo\",\"city\":\"LA\",\"age\":12}}".split('').sort
     end
   end
 
+  context "with json_engine" do
+    setup do
+      class CustomEncodeEngine
+        def self.encode string, options = {}
+          42
+        end
+      end
+
+      Rabl.configure do |config|
+        config.json_engine = CustomEncodeEngine
+      end
+    end
+
+    asserts 'that it returns process by custom to_json' do
+      template = rabl %q{
+        object @user
+      }
+      scope = Object.new
+      scope.instance_variable_set :@user, User.new
+      template.render(scope)
+    end.equals 42
+
+    teardown do
+      Rabl.configure do |config|
+        config.json_engine = MultiJson.default_engine
+      end
+    end
+  end
 
   context "without json root" do
     setup do
@@ -289,9 +317,9 @@ context "Rabl::Engine" do
         }
         scope = Object.new
         scope.instance_variable_set :@user, User.new(:name => 'leo', :city => 'LA')
-        template.render(scope)
+        template.render(scope).split('').sort
 
-      end.equals "{\"name\":\"leo\",\"person\":{\"city\":\"LA\"}}"
+      end.equals "{\"name\":\"leo\",\"person\":{\"city\":\"LA\"}}".split('').sort
     end
 
     context "#glue" do
@@ -305,8 +333,8 @@ context "Rabl::Engine" do
         }
         scope = Object.new
         scope.instance_variable_set :@user, User.new(:name => 'leo', :city => 'LA', :age => 12)
-        template.render(scope)
-      end.equals "{\"name\":\"leo\",\"city\":\"LA\",\"age\":12}"
+        template.render(scope).split('').sort
+      end.equals "{\"name\":\"leo\",\"city\":\"LA\",\"age\":12}".split('').sort
     end
   end
 end

metadata

@@ -2,7 +2,7 @@
 name: rabl
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.2.8
+  version: 0.3.0
 platform: ruby
 authors: 
 - Nathan Esquenazi
@@ -10,44 +10,43 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-03 00:00:00 -07:00
-default_executable: 
+date: 2011-07-01 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: riot
+  name: multi_json
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 0.12.3
-  type: :development
+        version: 1.0.3
+  type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: rr
+  name: riot
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 1.0.2
+        version: 0.12.3
   type: :development
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: mongoid
+  name: rr
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        version: "0"
+        version: 1.0.2
   type: :development
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: tilt
+  name: mongoid
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
@@ -58,7 +57,7 @@ dependencies:
   type: :development
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: bson_ext
+  name: tilt
   prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
@@ -68,6 +67,28 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: bson_ext
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: yajl-ruby
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id007
 description: General ruby templating for json or xml
 email: 
 - nesquena@gmail.com
@@ -103,7 +124,6 @@ files:
 - test/models/user.rb
 - test/template_test.rb
 - test/teststrap.rb
-has_rdoc: true
 homepage: https://github.com/nesquena/rabl
 licenses: []
 
@@ -127,7 +147,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: rabl
-rubygems_version: 1.6.2
+rubygems_version: 1.7.2
 signing_key: 
 specification_version: 3
 summary: General ruby templating for json or xml