rabl 0.8.1 → 0.8.2

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 0.8.2
+
+ * Passing locals when rendering templates via partials or inheritance (Thanks @simsalabim)
+
 ## 0.8.1
 
  * Fix to respect @collection :root for xml output (Thanks @chinshr)

data/README.md

@@ -3,7 +3,7 @@
 [![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. 
+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.
 
@@ -21,11 +21,11 @@ RABL is a general templating system created to solve these problems by approachi
 
 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, 2013) 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.
 
@@ -179,8 +179,8 @@ the primary JSON encoding engine simply add that to your Gemfile:
 gem 'oj'
 ```
 
-and RABL will use that engine automatically for encoding your JSON responses. 
-Set your own custom json_engine which define a `dump` or `encode` 
+and RABL will use that engine automatically for encoding your JSON responses.
+Set your own custom json_engine which define a `dump` or `encode`
 method for converting to JSON from ruby data:
 
 ```ruby
@@ -422,6 +422,33 @@ Using partials and inheritance can significantly reduce code duplication in your
 
 You can see more examples on the [Reusing Templates wiki page](https://github.com/nesquena/rabl/wiki/Reusing-templates).
 
+### Passing Locals in Partials ###
+
+You can pass an arbitrary set of locals when rendering partials or extending templates.
+For example, if we want to show on `posts/:id.json` any information regarding particular post and associated comments
+but in other cases we want to hide those comments. We can use locals to do this:
+
+```ruby
+# app/views/posts/index.json.rabl
+collection @posts
+
+extends('posts/show', :locals => { :hide_comments => true })
+# or using partial instead of extends
+# node(false) { |post| partial('posts/show', :object => :post, :locals => { :hide_comments => true })}
+```
+
+and then access locals in the sub-template:
+
+```ruby
+# app/views/posts/show.json.rabl
+object @post
+
+attributes :id, :title, :body, :created_at
+node(:comments) { |post| post.comments } unless locals[:hide_comments]
+```
+
+This can be useful as an advanced tool when extending or rendering partials.
+
 ### Template Scope ###
 
 In RABL, you have access to everything you need to build an API response. Each RABL template has full access to the controllers

data/Rakefile

@@ -14,7 +14,7 @@ end
 
 # Running integration tests
 # rake test:clean
-# rake test:stup
+# rake test:setup
 # rake test:full
 
 fixture_list = "{padrino_test,sinatra_test,rails2,rails3,rails3_2}"
@@ -23,7 +23,7 @@ desc "Clean up the fixtures being tested by cleaning and installing dependencies
 task "test:clean" do
   Dir[File.dirname(__FILE__) + "/fixtures/#{fixture_list}"].each do |fixture|
     puts "\n*** Cleaning up for #{File.basename(fixture)} tests ***\n"
-    puts `cd #{fixture}; rm Gemfile.lock`
+    Dir.chdir(fixture) { puts `rm Gemfile.lock` }
   end
 end
 
@@ -31,8 +31,10 @@ desc "Prepares the fixtures being tested by installing dependencies"
 task "test:setup" do
   Dir[File.dirname(__FILE__) + "/fixtures/#{fixture_list}"].each do |fixture|
     puts "\n*** Setting up for #{File.basename(fixture)} tests ***\n"
-    `export BUNDLE_GEMFILE=#{fixture}/Gemfile` if ENV['TRAVIS']
-    puts `cd #{fixture}; mkdir -p tmp/cache; bundle install;`
+    `export BUNDLE_GEMFILE="#{fixture}/Gemfile"` if ENV["TRAVIS"]
+    Bundler.with_clean_env {
+      Dir.chdir(fixture) { puts `mkdir -p tmp/cache; bundle install --gemfile="#{fixture}/Gemfile"`; }
+    }
   end
 end
 
@@ -40,7 +42,9 @@ desc "Executes the fixture tests"
 task "test:fixtures" do
   Dir[File.dirname(__FILE__) + "/fixtures/#{fixture_list}"].each do |fixture|
     puts "\n*** Running tests for #{File.basename(fixture)}... ***\n"
-    puts `cd #{fixture}; bundle check; bundle exec rake test:rabl`
+    Bundler.with_clean_env {
+      Dir.chdir(fixture) { puts `bundle check; bundle exec rake test:rabl` }
+    }
   end
 end
 

data/fixtures/ashared/views_rails_3/users/index.json.rabl

@@ -1,3 +1,3 @@
 collection @users
 
-extends "users/show"
+extends "users/show", :locals => { :reversed => true }

data/fixtures/ashared/views_rails_3/users/phone_number.json.rabl

@@ -1,6 +1,8 @@
 attributes :prefix, :suffix, :area_code
 attributes :is_primary => :primary
 
-node :formatted do |n|
-  n.formatted
+if locals[:reversed]
+  node(:reversed) { |n| n.formatted.reverse }
+else
+  node(:formatted) { |n| n.formatted }
 end

data/fixtures/ashared/views_rails_3/users/phone_number.xml.rabl

@@ -1,6 +1,8 @@
 attributes :prefix, :suffix, :area_code
 attributes :is_primary => :primary
 
-node :formatted do |n|
-  n.formatted
+if locals[:reversed]
+  node(:reversed) { |n| n.formatted.reverse }
+else
+  node(:formatted) { |n| n.formatted }
 end

data/fixtures/ashared/views_rails_3/users/show.json.rabl

@@ -12,5 +12,5 @@ child :phone_numbers => :pnumbers do
 end
 
 node :node_numbers do |u|
-  partial("users/phone_number", :object => u.phone_numbers)
+  partial("users/phone_number", :object => u.phone_numbers, :locals => { :reversed => locals[:reversed].presence })
 end

data/fixtures/padrino_test/Gemfile

@@ -1,4 +1,4 @@
-source :rubygems
+source 'https://rubygems.org'
 
 # Project requirements
 gem 'rake'

data/fixtures/rails2/Gemfile

@@ -1,5 +1,6 @@
-source :gemcutter
-gem "rails", "~> 2.3.14"
+source 'https://rubygems.org'
+
+gem "rails", "~> 2.3.18"
 gem "sqlite3", :require => "sqlite3"
 gem 'json'
 gem 'rabl', :path => File.expand_path(File.dirname(__FILE__) + "/../../")

data/fixtures/rails2/config/environment.rb

@@ -1,7 +1,7 @@
 # Be sure to restart your server when you modify this file
 
 # Specifies gem version of Rails to use when vendor/rails is not present
-RAILS_GEM_VERSION = '2.3.14' unless defined? RAILS_GEM_VERSION
+RAILS_GEM_VERSION = '2.3.18' unless defined? RAILS_GEM_VERSION
 
 # Bootstrap the Rails environment, frameworks, and default configuration
 require File.join(File.dirname(__FILE__), 'boot')

data/fixtures/rails3/Gemfile

@@ -1,4 +1,4 @@
-source 'http://rubygems.org'
+source 'https://rubygems.org'
 
 gem 'rails', '~> 3.0.17'
 

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

@@ -48,9 +48,9 @@ context "UsersController" do
     end.equals { @users.map { |u| u.phone_numbers.map(&:formatted) } }
 
     # Node (renders collection partial)
-    asserts("contains formatted node numbers") do
-      json_output.map { |u| u["user"]["node_numbers"].map { |n| n["formatted"] } }
-    end.equals { @users.map { |u| u.phone_numbers.map(&:formatted) } }
+    asserts("contains reversed node numbers") do
+      json_output.map { |u| u["user"]["node_numbers"].map { |n| n["reversed"] } }
+    end.equals { @users.map { |u| u.phone_numbers.map(&:formatted).map(&:reverse) } }
   end # index
 
   context "for show action" do

data/fixtures/sinatra_test/Gemfile

@@ -1,4 +1,4 @@
-source :rubygems
+source 'https://rubygems.org'
 
 gem 'rake'
 gem 'activerecord', :require => "active_record"

data/lib/rabl/engine.rb

@@ -21,6 +21,7 @@ module Rabl
     # Rabl::Engine.new("...source...", { :format => "xml" }).render(scope, { :foo => "bar", :object => @user })
     def render(scope, locals, &block)
       reset_options!
+      locals.merge!(locals.delete(:locals) || {})
       @_locals, @_scope = locals, scope
       self.copy_instance_variables_from(@_scope, [:@assigns, :@helpers])
       locals.each { |k,v| instance_variable_set(:"@#{k}", v) }

data/lib/rabl/partials.rb

@@ -24,7 +24,7 @@ module Rabl
       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)
+      Rabl::Engine.new(options[:source], engine_options).render(@_scope, :object => object, :locals => options[:locals], &block)
     end
 
     # Returns source for a given relative file

data/lib/rabl/version.rb

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

data/test/builder_test.rb

@@ -144,7 +144,7 @@ context "Rabl::Builder" do
   context "#extend" do
     asserts "that it does not genereate if no data is present" do
       b = builder :extends => [{ :file => 'users/show', :options => {}, :block => lambda { |u| attribute :name  }}]
-      mock(b).partial('users/show',{ :object => @user}).returns({}).subject
+      mock(b).partial('users/show',{ :object => @user }).returns({}).subject
       b.build(@user)
     end.equals({})
 

data/test/engine_test.rb

@@ -306,10 +306,29 @@ context "Rabl::Engine" do
       end.equals "{\"user\":{\"age\":12}}"
     end
 
+    context "#partial" do
+      asserts "that it creates object from partial and passes local" do
+        template = rabl %{
+         object false
+         node :foo do
+           partial("foo/bar", :object => @user, :locals => { :foo => "bar" })
+         end
+        }
+        scope = Object.new
+        @user = User.new(:name => 'leo', :city => 'LA', :age => 12)
+        scope.instance_variable_set :@user, @user
+        any_instance_of(Rabl::Engine) do |b|
+          mock(b).fetch_source("foo/bar", :view_path => nil).once
+          mock(b).object_to_hash(@user, :locals => { :foo => "bar" }, :source => nil, :source_location => nil).returns({ :name => 'leo', :city => 'LA', :age => 12 })
+        end
+        JSON.parse(template.render(scope))
+      end.equals JSON.parse("{ \"foo\" : {\"name\":\"leo\",\"city\":\"LA\",\"age\":12} }")
+    end
+
     teardown do
       Rabl.reset_configuration!
     end
-  end
+  end # with json root
 
   context "without json root" do
     setup do
@@ -585,7 +604,7 @@ context "Rabl::Engine" do
     teardown do
       Rabl.reset_configuration!
     end
-  end
+  end # without json root
 
   context "without child root" do
     setup do

data/test/integration/rails3_2/users_controller_test.rb

@@ -48,9 +48,9 @@ context "UsersController" do
     end.equals { @users.map { |u| u.phone_numbers.map(&:formatted) } }
 
     # Node (renders collection partial)
-    asserts("contains formatted node numbers") do
-      json_output.map { |u| u["user"]["node_numbers"].map { |n| n["formatted"] } }
-    end.equals { @users.map { |u| u.phone_numbers.map(&:formatted) } }
+    asserts("contains reversed node numbers") do
+      json_output.map { |u| u["user"]["node_numbers"].map { |n| n["reversed"] } }
+    end.equals { @users.map { |u| u.phone_numbers.map(&:formatted).map(&:reverse) } }
   end # index
 
   context "for show action" do

data/test/partials_test.rb

@@ -131,5 +131,5 @@ context "Rabl::Partials" do
         Rabl.configuration.view_paths = []
       end
     end
-  end
-end
+  end # Rails
+end # Rabl::Partials

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rabl
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.8.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-25 00:00:00.000000000 Z
+date: 2013-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -351,17 +351,14 @@ files:
 - fixtures/rails3_2/public/index.html
 - fixtures/rails3_2/public/robots.txt
 - fixtures/rails3_2/script/rails
-- fixtures/rails3_2/test/fixtures/.gitkeep
 - fixtures/rails3_2/test/fixtures/phone_numbers.yml
 - fixtures/rails3_2/test/fixtures/posts.yml
 - fixtures/rails3_2/test/fixtures/users.yml
-- fixtures/rails3_2/test/functional/.gitkeep
 - fixtures/rails3_2/test/functional/posts_controller_test.rb
 - fixtures/rails3_2/test/functional/users_controller_test.rb
 - fixtures/rails3_2/test/integration/.gitkeep
 - fixtures/rails3_2/test/performance/browsing_test.rb
 - fixtures/rails3_2/test/test_helper.rb
-- fixtures/rails3_2/test/unit/.gitkeep
 - fixtures/rails3_2/test/unit/helpers/posts_helper_test.rb
 - fixtures/rails3_2/test/unit/helpers/users_helper_test.rb
 - fixtures/rails3_2/test/unit/phone_number_test.rb
@@ -424,7 +421,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2506448699878914083
+      hash: 1400362274549242151
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -433,7 +430,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2506448699878914083
+      hash: 1400362274549242151
 requirements: []
 rubyforge_project: rabl
 rubygems_version: 1.8.25