rabl 0.7.8 → 0.7.9

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 # CHANGELOG
 
-## 0.7.9 (unreleased)
+## 0.7.10 (unreleased)
+
+## 0.7.9
+
+ * Replace yajl with oj in docs and tests
+ * Fix handling of empty children arrays with tests (Thanks @sethvargo)
 
 ## 0.7.8
 

data/README.md

@@ -18,6 +18,9 @@ I wanted a simple and flexible system for generating my APIs. In particular, I w
 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.
 
+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.
+
 ## Breaking Changes ##
 
  * v0.6.14 (released June 28, 2012) requires the use of render_views
@@ -37,13 +40,13 @@ or add to your Gemfile:
 ```ruby
 # Gemfile
 gem 'rabl'
-# Also add either `json` or `yajl-ruby` as the JSON parser
-gem 'yajl-ruby'
+# Also add either `oj` or `yajl-ruby` as the JSON parser
+gem 'oj'
 ```
 
 and run `bundle install` to install the dependency.
 
-If you are using **Rails 2.X, Rails 3.X or Padrino**, RABL works without configuration.
+If you are using **Rails 2.3.8 (and up), Rails 3.X or Padrino**, RABL works without configuration.
 
 **Important:** With Padrino, be sure that **the rabl gem is listed after the padrino gem in your Gemfile**, otherwise
 Rabl will not register properly as a template engine.
@@ -152,12 +155,12 @@ 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. For example, 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 [oj](https://github.com/ohler55/oj) as
 the primary JSON encoding engine simply add that to your Gemfile:
 
 ```ruby
 # Gemfile
-gem 'yajl-ruby', :require => "yajl"
+gem 'oj'
 ```
 
 and RABL will automatically start using that engine for encoding your JSON responses!
@@ -503,19 +506,20 @@ Rails and Padrino. I recommend a before_filter on that controller or directly sp
 ## Resources ##
 
 There are many resources available relating to RABL including the [RABL Wiki](https://github.com/nesquena/rabl/wiki),
-and many tutorials and guides detailed below. 
+and many tutorials and guides detailed below.
 You can check out the [RABL Site](http://nesquena.github.com/rabl) as well.
 
 ### Advanced Usage ###
 
 Links to resources for advanced usage:
 
- * Production Speed Optimizations: https://github.com/nesquena/rabl/wiki/Rabl-In-Production
- * Grape Integration: https://github.com/nesquena/rabl/wiki/Using-Rabl-with-Grape
- * Rendering JSON for a tree structure using RABL: https://github.com/nesquena/rabl/issues/70
- * Layouts (erb, haml and rabl) in RABL: https://github.com/nesquena/rabl/wiki/Using-Layouts
- * Backbone or [Ember.js](http://www.emberjs.com) Integration: https://github.com/nesquena/rabl/wiki/Backbone-Integration
- * RABL with Rails Engines: https://github.com/nesquena/rabl/wiki/Setup-rabl-with-rails-engines
+ * [Managing Complexity](https://github.com/nesquena/rabl/wiki/Managing-complexity-with-presenters)
+ * [Production Optimizations](https://github.com/nesquena/rabl/wiki/Rabl-In-Production)
+ * [Grape Integration](https://github.com/nesquena/rabl/wiki/Using-Rabl-with-Grape)
+ * [Rendering JSON for a tree structure using RABL](https://github.com/nesquena/rabl/issues/70)
+ * [Layouts (erb, haml and rabl) in RABL](https://github.com/nesquena/rabl/wiki/Using-Layouts)
+ * [Backbone or Ember.js Integration](https://github.com/nesquena/rabl/wiki/Backbone-Integration)
+ * [RABL with Rails Engines](https://github.com/nesquena/rabl/wiki/Setup-rabl-with-rails-engines)
 
 Please add your own usages and let me know so we can add them here! Also be sure to check out
 the [RABL Wiki](https://github.com/nesquena/rabl/wiki) for other usages.
@@ -541,16 +545,17 @@ Let me know if there's any other useful resources not listed here.
 
 There are other libraries that can either complement or extend the functionality of RABL:
 
+ * [versioncake](https://github.com/bwillis/versioncake) - Excellent library for easily versioning your RABL APIs
  * [gon](https://github.com/gazay/gon) - Exposes your Rails variables in JS with RABL support integrated.
- * [rabl-rails](https://github.com/ccocchi/rabl-rails) - Reimplementation for RABL and Rails 
+ * [rabl-rails](https://github.com/ccocchi/rabl-rails) - Reimplementation for RABL and Rails
    [focused on speed](https://github.com/ccocchi/rabl-benchmark/blob/master/BENCHMARK).
 
 Let me know if there's any other related libraries not listed here.
 
 ### Troubleshooting ###
 
- * Redundant calls for a collection: https://github.com/nesquena/rabl/issues/142#issuecomment-2969107
- * Testing RABL Views: https://github.com/nesquena/rabl/issues/130#issuecomment-4179285
+ * [Redundant calls for a collection](https://github.com/nesquena/rabl/issues/142#issuecomment-2969107)
+ * [Testing RABL Views](https://github.com/nesquena/rabl/issues/130#issuecomment-4179285)
 
 ### Examples ###
 

data/lib/rabl/helpers.rb

@@ -10,7 +10,7 @@ module Rabl
     # data_object(:user => :person) => @_object.send(:user)
     def data_object(data)
       data = (data.is_a?(Hash) && data.keys.size == 1) ? data.keys.first : data
-      data.is_a?(Symbol) && @_object ? @_object.__send__(data) : data
+      data.is_a?(Symbol) && defined?(@_object) && @_object ? @_object.__send__(data) : data
     end
 
     # data_object_attribute(data) => @_object.send(data)
@@ -23,14 +23,17 @@ module Rabl
     # data_name(@users) => :user
     # data_name([@user]) => "users"
     # data_name([]) => "array"
-    def data_name(data)
-      return nil unless data # nil or false
-      return data.values.first if data.is_a?(Hash) # @user => :user
-      data = @_object.__send__(data) if data.is_a?(Symbol) && @_object # :address
-      if is_collection?(data) && data.respond_to?(:first) # data collection
-        data_name(data.first).to_s.pluralize if data.first.present?
-      elsif is_object?(data) # actual data object
+    def data_name(data_token)
+      return unless data_token # nil or false
+      return data_token.values.first if data_token.is_a?(Hash) # @user => :user
+      data = data_object(data_token)
+      if is_collection?(data) && data.respond_to?(:first) # data is a collection
+        object_name = data_name(data.first).to_s.pluralize if data.first.present?
+        object_name ||= data_token if data_token.is_a?(Symbol)
+        object_name
+      elsif is_object?(data) # data is an object
         object_name = object_root_name if object_root_name
+        object_name ||= data if data.is_a?(Symbol)
         object_name ||= collection_root_name.to_s.singularize if collection_root_name
         object_name ||= data.class.respond_to?(:model_name) ? data.class.model_name.element : data.class.to_s.downcase
         object_name
@@ -42,12 +45,12 @@ module Rabl
     # determine_object_root(@user, :user, true) => "user"
     # determine_object_root(@user, :person) => "person"
     # determine_object_root([@user, @user]) => "user"
-    def determine_object_root(data_object, data_name=nil, include_root=true)
+    def determine_object_root(data_token, data_name=nil, include_root=true)
       return if object_root_name == false
       root_name = data_name.to_s if include_root
-      if is_object?(data_object)
+      if is_object?(data_token)
         root_name
-      elsif is_collection?(data_object)
+      elsif is_collection?(data_token)
         object_root_name || (root_name.singularize if root_name)
       end
     end

data/lib/rabl/version.rb

@@ -1,3 +1,3 @@
 module Rabl
-  VERSION = "0.7.8"
+  VERSION = "0.7.9"
 end

data/rabl.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rr',       '~> 1.0.2'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'tilt'
-  s.add_development_dependency 'yajl-ruby'
+  s.add_development_dependency 'oj'
   s.add_development_dependency 'msgpack',  '~> 0.4.5'
   s.add_development_dependency 'bson',     '~> 1.7.0'
   s.add_development_dependency 'plist'

data/test/configuration_test.rb

@@ -18,11 +18,11 @@ context 'Rabl::Configuration' do
   context 'custom JSON engine configured as Symbol' do
     setup do
       Rabl.configure do |c|
-        c.json_engine = :yajl
+        c.json_engine = :oj
       end
     end
 
-    asserts('uses a custom JSON engine') { topic.json_engine.to_s =~ /yajl/i }
+    asserts('uses a custom JSON engine') { topic.json_engine.to_s =~ /oj/i }
   end # custom json, symbol
 
   context 'custom JSON engine configured as Class' do

data/test/engine_test.rb

@@ -501,7 +501,7 @@ context "Rabl::Engine" do
     end
 
     context "#child" do
-      asserts "that it can create a child node" do
+      asserts "that it can create a singular child node" do
         template = rabl %{
           object @user
           attribute :name
@@ -512,7 +512,7 @@ context "Rabl::Engine" do
         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
+      asserts "that it can create a singular child node with different key" do
         template = rabl %{
           object @user
           attribute :name
@@ -523,6 +523,39 @@ context "Rabl::Engine" do
         JSON.parse(template.render(scope))
       end.equals JSON.parse("{\"name\":\"leo\",\"person\":{\"city\":\"LA\"}}")
 
+      asserts "that it can create a many child node" do
+        template = rabl %{
+          object @user
+          attribute :name
+          child(:hobbies) { attribute :name }
+        }
+        scope = Object.new
+        scope.instance_variable_set :@user, User.new(:name => 'leo', :city => 'LA')
+        JSON.parse(template.render(scope))
+      end.equals JSON.parse(%q^{"name":"leo", "hobbies":[{"hobby":{"name":"Photography"}}]}^)
+
+      asserts "that it can create a many child node with different key" do
+        template = rabl %{
+          object @user
+          attribute :name
+          child(:hobbies => :interests) { attribute :name }
+        }
+        scope = Object.new
+        scope.instance_variable_set :@user, User.new(:name => 'leo', :city => 'LA')
+        JSON.parse(template.render(scope))
+      end.equals JSON.parse(%q^{"name":"leo", "interests":[{"interest":{"name":"Photography"}}]}^)
+
+      asserts "that it can create a many child node with no data" do
+        template = rabl %{
+          object @user
+          attribute :name
+          child(:hobbies) { attribute :name }
+        }
+        scope = Object.new
+        scope.instance_variable_set :@user, User.new(:name => 'leo', :city => 'LA', :hobbies => [])
+        JSON.parse(template.render(scope))
+      end.equals JSON.parse(%q^{"name":"leo", "hobbies":[]}^)
+
       asserts "that it can be passed conditionals" do
         template = rabl %{
           object @user

data/test/helpers_test.rb

@@ -17,6 +17,10 @@ context "Rabl::Helpers" do
       @helper_class.data_name(nil)
     end.equals(nil)
 
+    asserts "returns symbol if symbol with empty children" do
+      @helper_class.data_name(:user)
+    end.equals(:user)
+
     asserts "returns alias if hash with symbol is passed" do
       @helper_class.data_name(@user => :user)
     end.equals(:user)

data/test/models/user.rb

@@ -1,21 +1,28 @@
 unless defined?(User)
   class User
-    attr_accessor :age, :city, :name, :first, :float
+    attr_accessor :age, :city, :name, :first, :float, :hobbies
 
-    DEFAULT_AGE   = 24
-    DEFAULT_CITY  = 'irvine'
-    DEFAULT_NAME  = 'rabl'
-    DEFAULT_FIRST = 'bob'
-    DEFAULT_FLOAT = 1234.56
+    DEFAULT_AGE      = 24
+    DEFAULT_CITY     = 'irvine'
+    DEFAULT_NAME     = 'rabl'
+    DEFAULT_FIRST    = 'bob'
+    DEFAULT_FLOAT    = 1234.56
+    DEFAULT_HOBBIES  = ['Photography']
 
     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
-      self.float = attributes[:float] || DEFAULT_FLOAT
+      self.age     = attributes[:age]     || DEFAULT_AGE
+      self.city    = attributes[:city]    || DEFAULT_CITY
+      self.name    = attributes[:name]    || DEFAULT_NAME
+      self.first   = attributes[:first]   || DEFAULT_FIRST
+      self.float   = attributes[:float]   || DEFAULT_FLOAT
+      self.hobbies = (attributes[:hobbies] || DEFAULT_HOBBIES).map { |h| Hobby.new(h) }
     end
   end
+
+  class Hobby
+    attr_accessor :name
+    def initialize(name); @name = name; end
+  end
 end
 
 unless defined?(NestedScope::User)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rabl
 version: !ruby/object:Gem::Version
-  version: 0.7.8
+  version: 0.7.9
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-26 00:00:00.000000000 Z
+date: 2012-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -108,7 +108,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: yajl-ruby
+  name: oj
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements: