rabl 0.7.0 → 0.7.1

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 # CHANGELOG
 
-## 0.7.1 (Unreleased)
+## 0.7.2 (unreleased)
+
+## 0.7.1
+
+  * Improved renderer interface (Thanks @siong1987)
+  * Pass current object into blocks (Thanks @braddunbar)
 
 ## 0.7.0
 

data/README.md

@@ -243,7 +243,7 @@ attributes :bar => :baz, :dog => :animal
 # => # { baz : <bar value>, animal : <dog value> }
 ```
 
-This currently does not work:
+Named and aliased attributes can not be combined on the same line. This currently does not work:
 
 ```ruby
 attributes :foo, :bar => :baz # throws exception
@@ -277,6 +277,15 @@ child :posts => :foobar do
 end
 ```
 
+You can also pass in the current object:
+
+```ruby
+object @user
+child :posts do |user|
+  attribute :title unless user.suspended?
+end
+```
+
 ### Gluing Attributes ###
 
 You can also append child attributes back to the root node:
@@ -290,6 +299,13 @@ end
 
 Use glue to add additional attributes to the parent object.
 
+You can also pass in the current object:
+
+```ruby
+object @user
+glue(@post) {|user| attribute :title if user.active? }
+```
+
 ### Custom Nodes ###
 
 This will generate a json response based on the result of the `node` block:
@@ -440,6 +456,19 @@ Rabl::Renderer.xml(@post, 'posts/show')
 
 These methods allow RABL to be used for arbitrary conversions of an object into a desired format.
 
+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!" })
+````
+
+Then, in your template, you can use `@custom_title` as:
+
+```
+attribute :content
+node(:title) { @custom_title }
+```
+
 ### Content Type Headers ###
 
 Currently in RABL, the content-type of your response is not set automatically. This is because RABL is intended
@@ -532,7 +561,9 @@ Thanks to [Miso](http://gomiso.com) for allowing me to create this for our appli
 * [Alli Witheford](https://github.com/alzeih) - Added Plist format support
 * [Ryan Bigg](https://github.com/radar) - Improved template resolution code
 * [Ivan Vanderbyl](https://github.com/ivanvanderbyl) - Added general purpose renderer
-* [Cyril Mougel](https://github.com/shingara) - Added cache_engine pluggable support
+* [Cyril Mougel](https://github.com/shingara) - Added cache_engine pluggable support and renderer tweaks
+* [Teng Siong Ong](https://github.com/siong1987) - Improved renderer interface
+* [Brad Dunbar](https://github.com/braddunbar) - Pass current object into blocks
 
 and many more contributors listed in the [CHANGELOG](https://github.com/nesquena/rabl/blob/master/CHANGELOG.md).
 
@@ -555,3 +586,4 @@ Thanks again for all of these great projects.
 ## Copyright ##
 
 Copyright © 2011-2012 Nathan Esquenazi. See [MIT-LICENSE](https://github.com/nesquena/rabl/blob/master/MIT-LICENSE) for details.
+

data/lib/rabl/engine.rb

@@ -31,7 +31,7 @@ module Rabl
       else # without source location
         instance_eval(@_source) if @_source.present?
       end
-      instance_eval(&block) if block_given?
+      instance_exec(data_object(@_data), &block) if block_given?
       cache_results { self.send("to_" + @_options[:format].to_s) }
     end
 

data/lib/rabl/renderer.rb

@@ -31,6 +31,13 @@ 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.0"
+  VERSION = "0.7.1"
 end

data/test/engine_test.rb

@@ -263,6 +263,18 @@ context "Rabl::Engine" do
         template.render(scope).split('').sort
 
       end.equals "{\"user\":{\"name\":\"leo\",\"person\":{\"city\":\"LA\"}}}".split('').sort
+
+      asserts "that it passes the data object to the block" do
+        template = rabl %{
+          object @user
+          child(@user => :person) do |user|
+            attribute :name if user.name == 'leo'
+          end
+        }
+        scope = Object.new
+        scope.instance_variable_set :@user, User.new(:name => 'leo')
+        template.render(scope)
+      end.equals "{\"user\":{\"person\":{\"name\":\"leo\"}}}"
     end
 
     context "#glue" do
@@ -277,6 +289,16 @@ context "Rabl::Engine" do
         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
+
+      asserts "that it passes the data object to the block" do
+        template = rabl %{
+          object @user
+          glue(@user) {|user| attribute :age if user.name == 'leo' }
+        }
+        scope = Object.new
+        scope.instance_variable_set :@user, User.new(:name => 'leo', :age => 12)
+        template.render(scope)
+      end.equals "{\"user\":{\"age\":12}}"
     end
 
     teardown do
@@ -475,7 +497,7 @@ context "Rabl::Engine" do
       Rabl.reset_configuration!
     end
   end
-  
+
   context "without child root" do
     setup do
       Rabl.configure do |config|
@@ -484,9 +506,9 @@ context "Rabl::Engine" do
         config.enable_json_callbacks = false
       end
     end
-    
+
     context "#child" do
-      
+
       asserts "that it can create a child node without child root" do
         template = rabl %{
           child @users

data/test/renderer_test.rb

@@ -61,13 +61,14 @@ context "Rabl::Renderer" do
     asserts 'passes :locals to render' do
       source = %q{
         attribute :name, :as => 'city'
+        node(:zipcode) { @zipcode }
       }
 
       user = User.new(:name => 'irvine')
 
-      renderer = Rabl::Renderer.new(source, nil, { :format => 'json', :locals => {:object => user} })
+      renderer = Rabl::Renderer.new(source, nil, { :format => 'json', :locals => {:object => user, :zipcode => "92602"} })
       renderer.render.split("").sort
-    end.equals "{\"user\":{\"city\":\"irvine\"}}".split("").sort
+    end.equals "{\"user\":{\"city\":\"irvine\",\"zipcode\":\"92602\"}}".split("").sort
 
     asserts 'loads source from file' do
       File.open(tmp_path + "test.json.rabl", "w") do |f|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rabl
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-16 00:00:00.000000000 Z
+date: 2012-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -444,7 +444,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: rabl
-rubygems_version: 1.8.21
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: General ruby templating with json, bson, xml and msgpack support