Merge pull request #26 from hobofan/master

allow locals in render method

CHANGELOG.md

@@ -3,6 +3,7 @@
 * Enable using a layout template in Rabl [@koko1000ban](https://github.com/koko1000ban) [view commit](https://github.com/LTe/grape-rabl/commit/1fbfbd58c3fb320be1b52b3247fda2a23cacc9fc)
 * Implemented Rubocop, Ruby style linter [@dblock](https://github.com/dblock) [view commit](https://github.com/LTe/grape-rabl/commit/1211056de22a5989c063d57b7b37ebb1f1977e83)
 * Removed JRuby support [@dblock](https://github.com/dblock) [view commit](https://github.com/LTe/grape-rabl/commit/59905c1b09670fe08501e09bad4ec8714839f2d3)
+* Enable using locals with #render [@hobofan](https://github.com/hobofan)
 
 #### v0.2.2
 

README.md

@@ -112,6 +112,11 @@ class UserAPI < Grape::API
   # use rabl with 'user.rabl' template
   get '/user/:id', :rabl => 'user' do
     @user = User.find(params[:id])
+
+    if @user.admin?
+      # overwrite the template (and pass locals) with the #render method
+      render rabl: 'admin', locals: { details: 'this user is a admin' }
+    end
   end
 
   # do not use rabl, fallback to the defalt Grape JSON formatter

lib/grape-rabl/formatter.rb

@@ -14,7 +14,7 @@ def call(object, env)
           if rablable?
             rabl do |template|
               engine = ::Tilt.new(view_path(template), tilt_options)
-              output = engine.render endpoint, {}
+              output = engine.render endpoint, locals
               if layout_template
                 layout_template.render(endpoint) { output }
               else
@@ -47,6 +47,10 @@ def rabl
           yield template
         end
 
+        def locals
+          endpoint.options[:route_options][:rabl_locals] || {}
+        end
+
         def set_view_root
           fail "Use Rack::Config to set 'api.tilt.root' in config.ru"
         end

lib/grape-rabl/render.rb

@@ -1,7 +1,8 @@
 module GrapeRabl
   module Render
     def render(options = {})
-      env['api.endpoint'].options[:route_options][:rabl] = options.delete(:rabl)
+      env['api.endpoint'].options[:route_options][:rabl] = options.delete(:rabl) if options.include?(:rabl)
+      env['api.endpoint'].options[:route_options][:rabl_locals] = options.delete(:locals)
     end
   end
 end

spec/grape_rabl_spec.rb

@@ -50,16 +50,36 @@ def app
           render rabl: 'admin'
         end
 
+        subject.get('/home-detail', rabl: 'user') do
+          @user = OpenStruct.new(name: 'LTe')
+          render rabl: 'admin', locals: { details: 'amazing detail' }
+        end
+
         subject.get('/about', rabl: 'user') do
           @user = OpenStruct.new(name: 'LTe')
         end
+
+        subject.get('/about-detail', rabl: 'user') do
+          @user = OpenStruct.new(name: 'LTe')
+          render locals: { details: 'just a user' }
+        end
       end
 
-      it 'renders template passed as argument to reneder method' do
+      it 'renders template passed as argument to render method' do
         get('/home')
         last_response.body.should == '{"admin":{"name":"LTe"}}'
       end
 
+      it 'renders template passed as argument to render method with locals' do
+        get('/home-detail')
+        last_response.body.should == '{"admin":{"name":"LTe","details":"amazing detail"}}'
+      end
+
+      it 'renders with locals without overriding template' do
+        get('/about-detail')
+        last_response.body.should == '{"user":{"name":"LTe","details":"just a user","project":null}}'
+      end
+
       it 'does not save rabl options after called #render method' do
         get('/home')
         get('/about')

spec/views/admin.rabl

@@ -1,2 +1,6 @@
 object @user => :admin
 attributes :name
+
+node :details, :unless => lambda { |n| locals[:details].nil? } do |m|
+  locals[:details]
+end

spec/views/user.rabl

@@ -4,3 +4,7 @@ attributes :name, :email
 child @project => :project do
   attributes :name
 end
+
+node :details, :unless => lambda { |n| locals[:details].nil? } do |m|
+  locals[:details]
+end