rabl 0.7.5 → 0.7.6

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 # CHANGELOG
 
-## 0.7.6 (unreleased)
+## 0.7.7 (unreleased)
+
+## 0.7.6
+
+  * Fix render behavior by separating data_object and data_name in engine
+  * Fix regression with 'child' behavior with nil on extends (with tests)
 
 ## 0.7.5
 

data/lib/rabl/engine.rb

@@ -26,13 +26,14 @@ module Rabl
       locals.each { |k,v| instance_variable_set(:"@#{k}", v) }
       @_options[:scope] = @_scope
       @_options[:format] ||= self.request_format
-      @_data = locals[:object].nil? ? self.default_object : locals[:object]
+      data = locals[:object].nil? ? self.default_object : locals[:object]
+      @_data_object, @_data_name = data_object(data), data_name(data)
       if @_options[:source_location]
         instance_eval(@_source, @_options[:source_location]) if @_source.present?
       else # without source location
         instance_eval(@_source) if @_source.present?
       end
-      instance_exec(data_object(@_data), &block) if block_given?
+      instance_exec(@_data_object, &block) if block_given?
       cache_results { self.send("to_" + @_options[:format].to_s) }
     end
 
@@ -40,9 +41,9 @@ module Rabl
     # to_hash(:root => true, :child_root => true)
     def to_hash(options={})
       options = @_options.merge(options)
-      data = data_object(@_data)
+      data = @_data_object
       builder = Rabl::Builder.new(options)
-      options[:root_name] = determine_object_root(@_data, options[:root])
+      options[:root_name] = determine_object_root(@_data_object, @_data_name, options[:root])
 
       if is_object?(data) || !data # object @user
         builder.build(data, options)
@@ -88,7 +89,7 @@ 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(@_data))
+      xml_options = Rabl.configuration.default_xml_options.merge(:root => @_data_name)
       to_hash(options).to_xml(xml_options)
     end
 
@@ -100,8 +101,8 @@ module Rabl
       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_name(@_data) => to_hash(options) }
+               elsif is_collection?(@_data_object) && @_data_object.is_a?(Array)
+                 { @_data_name => to_hash(options) }
                else
                  to_hash(options)
                end
@@ -112,15 +113,17 @@ module Rabl
     # object(@user)
     # object @user => :person
     # object @users
-    def object(data)
-      @_data = data unless @_locals[:object]
+    def object(template_data)
+      current_data  = (@_locals[:object].nil? || template_data == false) ? template_data : @_locals[:object]
+      @_data_object = data_object(current_data)
+      @_data_name   = data_name(template_data.is_a?(Hash) && !current_data.is_a?(Hash) ? template_data : current_data)
     end
 
     # Returns the current object that is the topic of this template
     # Can be the collection or the object depending on topic assigned
     # root_object => @user
     def root_object
-      @_data
+      @_data_object
     end
 
     # Sets the object as a collection casted to a simple array
@@ -143,7 +146,7 @@ module Rabl
     # cache 'user', expires_in: 1.hour
     # options is passed through to the cache store
     def cache(key = nil, options = nil)
-      key ||= @_data # if called but missing, use object
+      key ||= @_data_object # if called but missing, use object
       @_cache = [key, options]
     end
 

data/lib/rabl/helpers.rb

@@ -37,15 +37,15 @@ module Rabl
 
     # Returns the object rootname based on if the root should be included
     # Can be called with data as a collection or object
-    # determine_object_root(@user, true) => "user"
-    # determine_object_root(@user => :person) => "person"
+    # determine_object_root(@user, :user, true) => "user"
+    # determine_object_root(@user, :person) => "person"
     # determine_object_root([@user, @user]) => "user"
-    def determine_object_root(data, include_root=true)
+    def determine_object_root(data_object, data_name=nil, include_root=true)
       return if object_root_name == false
-      root_name = data_name(data).to_s if include_root
-      if is_object?(data)
+      root_name = data_name.to_s if include_root
+      if is_object?(data_object)
         root_name
-      elsif is_collection?(data)
+      elsif is_collection?(data_object)
         object_root_name || (root_name.singularize if root_name)
       end
     end

data/lib/rabl/partials.rb

@@ -21,6 +21,7 @@ module Rabl
     # options must have :source (rabl file contents)
     # options can have :source_location (source filename)
     def object_to_hash(object, options={}, &block)
+      return object if object.nil?
       return [] if is_collection?(object) && object.blank? # empty collection
       engine_options = options.reverse_merge(:format => "hash", :view_path => @_view_path, :root => (options[:root] || false))
       Rabl::Engine.new(options[:source], engine_options).render(@_scope, :object => object, &block)

data/lib/rabl/version.rb

@@ -1,3 +1,3 @@
 module Rabl
-  VERSION = "0.7.5"
+  VERSION = "0.7.6"
 end

data/test/configuration_test.rb

@@ -22,7 +22,7 @@ context 'Rabl::Configuration' do
       end
     end
 
-    asserts('uses a custom JSON engine') { topic.json_engine.to_s =~ /MultiJson.*::Yajl/ }
+    asserts('uses a custom JSON engine') { topic.json_engine.to_s =~ /yajl/i }
   end # custom json, symbol
 
   context 'custom JSON engine configured as Class' do

data/test/renderer_test.rb

@@ -9,6 +9,7 @@ context "Rabl::Renderer" do
   helper(:context_scope) { |name, value|
     scope = Object.new
     stub(scope).controller { stub(Object).controller_name { name } }
+    scope.instance_variable_set :"@#{name.pluralize}", nil
     scope.instance_variable_set :"@#{name}", value
     scope
   }
@@ -129,6 +130,39 @@ context "Rabl::Renderer" do
       JSON.parse(renderer.render)
     end.equals JSON.parse("{\"user\":{\"age\":24,\"name\":\"irvine\"}}")
 
+
+    asserts 'handles extends with child as nil' do
+      File.open(tmp_path + "foo.json.rabl", "w") do |f|
+        f.puts %q{
+          object @foo
+          node(:test) do |foo|
+            {
+              test: "#{foo.attribute}"
+            }
+          end
+        }
+      end
+
+      File.open(tmp_path + "bar.json.rabl", "w") do |f|
+        f.puts %q{
+          object false
+          node do
+            {
+              test_attribute: 'test_value'
+            }
+          end
+          child(@foos => :foo_collection) do
+            extends 'foo'
+          end
+        }
+      end
+
+      sc = Object.new
+      sc.instance_variable_set :@foos, nil
+      renderer = Rabl::Renderer.new('bar', false, :view_path => tmp_path, :scope => sc)
+      JSON.parse(renderer.render)
+    end.equals JSON.parse("{\"test_attribute\":\"test_value\", \"foo_collection\":null}")
+
     asserts 'handles extends with custom node and object set false' do
       File.open(tmp_path + "test.json.rabl", "w") do |f|
         f.puts %q{
@@ -211,9 +245,9 @@ context "Rabl::Renderer" do
         }
       end
 
-      scope = Object.new
-      scope.instance_variable_set :@users, nil
-      Rabl.render([], 'test', :view_path => tmp_path, :scope => scope)
+      sc = Object.new
+      sc.instance_variable_set :@users, nil
+      Rabl.render([], 'test', :view_path => tmp_path, :scope => sc)
     end.equals "{\"users\":[]}"
 
     asserts 'it renders an array when given an empty collection' do
@@ -257,7 +291,60 @@ context "Rabl::Renderer" do
       renderer = Rabl::Renderer.new('user', user, :view_path => tmp_path)
       JSON.parse(renderer.render)
     end.equals JSON.parse("{\"user\":{\"name\":\"irvine\",\"object\":{\"gender\":\"male\"},\"gender\":\"male\"}}")
-  end
+
+
+    asserts "it renders for object false" do
+      File.open(tmp_path + "test2.rabl", "w") do |f|
+        f.puts %q{
+          object false
+          node(:foo) { 'bar' }
+        }
+      end
+
+      user = User.new(:name => 'ivan')
+      JSON.parse(Rabl.render(user, 'test2', :view_path => tmp_path))
+    end.equals JSON.parse("{\"foo\":\"bar\"}")
+
+    asserts "it renders for object key specified in template" do
+      File.open(tmp_path + "test3.rabl", "w") do |f|
+        f.puts %q{
+          object @user => :person
+          attributes :age, :name
+        }
+      end
+
+      user = User.new(:name => 'ivan')
+      JSON.parse(Rabl.render(user, 'test3', :view_path => tmp_path))
+    end.equals JSON.parse("{\"person\":{\"age\":24,\"name\":\"ivan\"} }")
+
+    asserts "it renders for overwriting object key specified in render" do
+      File.open(tmp_path + "test4.rabl", "w") do |f|
+        f.puts %q{
+          object @user => :person
+          attributes :age, :name
+        }
+      end
+
+      sc = Object.new
+      sc.instance_variable_set :@user, nil
+      user = User.new(:name => 'ivan')
+      JSON.parse(Rabl.render({ user => :human }, 'test4', :view_path => tmp_path, :scope => sc))
+    end.equals JSON.parse("{\"human\":{\"age\":24,\"name\":\"ivan\"} }")
+
+    asserts "it renders for specific object key passed to render" do
+      File.open(tmp_path + "test5.rabl", "w") do |f|
+        f.puts %q{
+          object @user
+          attributes :age, :name
+        }
+      end
+
+      sc = Object.new
+      sc.instance_variable_set :@user, nil
+      user = User.new(:name => 'ivan')
+      JSON.parse(Rabl.render({ user => :person }, 'test5', :view_path => tmp_path, :scope => sc))
+    end.equals JSON.parse("{\"person\":{\"age\":24,\"name\":\"ivan\"} }")
+  end # render
 
   context '.json' do
     asserts 'it renders json' do
@@ -271,7 +358,7 @@ context "Rabl::Renderer" do
       user = User.new(:name => 'ivan')
       JSON.parse(Rabl::Renderer.json(user, 'test', :view_path => tmp_path))
     end.equals JSON.parse("{\"user\":{\"age\":24,\"name\":\"ivan\",\"float\":1234.56}}")
-  end
+  end # json
 
   context '.msgpack' do
     asserts 'it renders msgpack' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rabl
 version: !ruby/object:Gem::Version
-  version: 0.7.5
+  version: 0.7.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-29 00:00:00.000000000 Z
+date: 2012-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport