grape-rabl 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ebef1acc9ea4453a55850d6af0a663f497681f23
-  data.tar.gz: ccb43ab0335200f0c3194325e3b1de87d711be62
+  metadata.gz: d621405f4d7c383ff47dea4a2db866618aaeff12
+  data.tar.gz: 3ec7ec4c04e7bd20a390fa55acba8ac84171e6d2
 SHA512:
-  metadata.gz: a2dee5455c625c89ec8c2c86858b6d4ba27c6f6b6d63b47e6ad23d6b824d089cd23958de9e1bd1a3731364cd60170d7b4dd701902edcf149530b1f88e9227c48
-  data.tar.gz: 129d37a3b51bd384bcaeda98b092eba9b94d6adacb494c9731279ca398e5876cbf14136d1ab8edd459f757060ff63b172a97962f9c3866c50ed8f0e71713c090
+  metadata.gz: 66582082999fe94194742f88ba1d4644dcce4dd83717403ea0202a45544c114f6a1e47c2358205c7d951509bee9771a43501ae8e7ad5684b39f1eadcd0584a42
+  data.tar.gz: 399b670fd1ac71cac4b0b4fe40006274dbe58b878ffe95a031f7b172a354fe2013aea1d725c6348e7e589c96c8128b7b677d5d80a6592b169b2ea1e323576e86

data/CHANGELOG.md

@@ -1,14 +1,18 @@
+#### v0.3.1
+
+* The `render` method will no longer modify endpoint options at runtime. [#35](https://github.com/LTe/grape-rabl/issues/35) [@yesmeck](https://github.com/yesmeck)
+
 #### v0.3.0
 
-* 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) [view commit](https://github.com/LTe/grape-rabl/commit/6c24130f6a670e52e6119c56904b8ed2e6f60b39)
+* 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) [view commit](https://github.com/LTe/grape-rabl/commit/6c24130f6a670e52e6119c56904b8ed2e6f60b39)
 * Enable support for template caching. [#28](https://github.com/LTe/grape-rabl/pull/28) [@kushkella](https://github.com/kushkella) [view commit](https://github.com/LTe/grape-rabl/commit/79b1e58d767c6286b510af669e718310c0ad25c2)
 
 #### v0.2.2
 
-* Relaxed dependency on a specific version of Grape [#20](https://github.com/LTe/grape-rabl/pull/20) [@cheef](https://github.com/cheef) [view commit](https://github.com/LTe/grape-rabl/commit/56da0a5bcecb16501cdd93ac25f3b6ca6d7a86f0)
+* Relaxed dependency on a specific version of Grape. [#20](https://github.com/LTe/grape-rabl/pull/20) [@cheef](https://github.com/cheef) [view commit](https://github.com/LTe/grape-rabl/commit/56da0a5bcecb16501cdd93ac25f3b6ca6d7a86f0)
 
 #### v0.2.1
 
@@ -16,7 +20,7 @@
 
 #### v0.2.0
 
-* Allow to use partials in grape. [#10](https://github.com/LTe/grape-rabl/pull/10) [@ichilton](https://github.com/ichilton) [view commit](http://github.com/LTe/grape-rabl/commit/72c96c5acc9d8000f56ee8400ae0229053fb3e7e)
+* Allow to use partials in Grape. [#10](https://github.com/LTe/grape-rabl/pull/10) [@ichilton](https://github.com/ichilton) [view commit](http://github.com/LTe/grape-rabl/commit/72c96c5acc9d8000f56ee8400ae0229053fb3e7e)
 * Stick to gem conventions. [@LTe](https://github.com/lte) [view commit](http://github.com/LTe/grape-rabl/commit/aabd0e2ad72f56a75427eebcc586deed57cf5f58)
 * Update for Grape 0.3 compatibility. [@alovak](https://github.com/alovak) [view commit](http://github.com/LTe/grape-rabl/commit/78bfdceffbfe90b700868ff1e79ab87e8baded81)
 * Format fix. [@LTe](https://github.com/lte) [view commit](http://github.com/LTe/grape-rabl/commit/13749cc18d332dcd0050bb32980cc233868a7992)

data/Gemfile

@@ -12,6 +12,7 @@ group :test do
   gem "rack-test"
   gem "rake"
   gem "coveralls", require: false
+  gem "rabl", :github => "nesquena/rabl"
 
   platforms :rbx do
     gem "iconv"

data/README.md

@@ -2,11 +2,11 @@
 
 Use [Rabl](https://github.com/nesquena/rabl) templates in [Grape](https://github.com/intridea/grape)!
 
-[![Build Status](https://secure.travis-ci.org/LTe/grape-rabl.png)](http://travis-ci.org/LTe/grape-rabl)
-[![Dependency Status](https://gemnasium.com/LTe/grape-rabl.png)](https://gemnasium.com/LTe/grape-rabl)
-[![Code Climate](https://codeclimate.com/github/LTe/grape-rabl.png)](https://codeclimate.com/github/LTe/grape-rabl)
-[![Coverage Status](https://coveralls.io/repos/LTe/grape-rabl/badge.png?branch=master)](https://coveralls.io/r/LTe/grape-rabl?branch=master)
-[![Gem Version](https://badge.fury.io/rb/grape-rabl.png)](http://badge.fury.io/rb/grape-rabl)
+[![Gem Version](http://img.shields.io/gem/v/grape-rabl.svg)](http://badge.fury.io/rb/grape-rabl)
+[![Build Status](http://img.shields.io/travis/LTe/grape-rabl.svg)](https://travis-ci.org/LTe/grape-rabl)
+[![Dependency Status](https://gemnasium.com/LTe/grape-rabl.svg)](https://gemnasium.com/LTe/grape-rabl)
+[![Code Climate](https://codeclimate.com/github/LTe/grape-rabl.svg)](https://codeclimate.com/github/LTe/grape-rabl)
+[![Coverage Status](https://img.shields.io/coveralls/LTe/grape-rabl.svg)](https://coveralls.io/r/LTe/grape-rabl?branch=master)
 
 ## Installation
 
@@ -124,16 +124,31 @@ class UserAPI < Grape::API
   format :json
   formatter :json, Grape::Formatter::Rabl
 
-  # use rabl with 'user.rabl' template
-  get '/user/:id', :rabl => 'user' do
+  get '/user/:id' do
     @user = User.find(params[:id])
 
+    # use rabl with 'user.rabl' or 'admin.rabl' template
     if @user.admin?
-      # overwrite the template (and pass locals) with the #render method
-      render rabl: 'admin', locals: { details: 'this user is a admin' }
+      # pass locals with the #render method
+      render rabl: 'admin', locals: { details: 'this user is an admin' }
+    else
+      render rabl: 'user'
     end
   end
 
+  get '/admin/:id', :rabl => 'admin' do
+    @user = User.find(params[:id])
+
+    # use rabl with 'super_admin.rabl'
+    render rabl: 'super_admin' if @user.super_admin?
+    # when render method has not been used use template from endpoint definition
+  end
+
+  # use rabl with 'user_history.rabl' template
+  get '/user/:id/history', :rabl => 'user_history' do
+    @history = User.find(params[:id]).history
+  end
+
   # do not use rabl, fallback to the defalt Grape JSON formatter
   get '/users' do
     User.all

data/lib/grape-rabl/formatter.rb

@@ -37,18 +37,21 @@ module Grape
         end
 
         def rablable?
-          !!endpoint.options[:route_options][:rabl]
+          !!rabl_template
         end
 
         def rabl
-          template = endpoint.options[:route_options][:rabl]
-          fail 'missing rabl template' unless template
+          fail 'missing rabl template' unless rabl_template
           set_view_root unless env['api.tilt.root']
-          yield template
+          yield rabl_template
         end
 
         def locals
-          endpoint.options[:route_options][:rabl_locals] || {}
+          env['api.tilt.rabl_locals'] || endpoint.options[:route_options][:rabl_locals] || {}
+        end
+
+        def rabl_template
+          env['api.tilt.rabl'] || endpoint.options[:route_options][:rabl]
         end
 
         def set_view_root

data/lib/grape-rabl/render.rb

@@ -1,8 +1,8 @@
 module GrapeRabl
   module Render
     def render(options = {})
-      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)
+      env['api.tilt.rabl'] = options[:rabl]
+      env['api.tilt.rabl_locals'] = options[:locals]
     end
   end
 end

data/lib/grape-rabl/version.rb

@@ -1,5 +1,5 @@
 module Grape
   module Rabl
-    VERSION = '0.3.0'
+    VERSION = '0.3.1'
   end
 end

data/spec/grape_rabl_layout_spec.rb

@@ -1,6 +1,8 @@
 require 'spec_helper'
 
 describe 'Grape::Rabl layout' do
+  let(:parsed_response) { JSON.parse(last_response.body) }
+
   subject do
     Class.new(Grape::API)
   end
@@ -26,8 +28,8 @@ describe 'Grape::Rabl layout' do
       end
 
       get('/about')
-      last_response.body.should ==
-        %Q({"status":200,"result":{"user":{"name":"LTe","project":{"name":"First"}}}})
+      parsed_response.should ==
+        JSON.parse(%Q({"status":200,"result":{"user":{"name":"LTe","project":{"name":"First"}}}}))
     end
   end
 
@@ -45,8 +47,8 @@ describe 'Grape::Rabl layout' do
 
       get('/about')
       puts last_response.body
-      last_response.body.should ==
-        %Q({"result":{"user":{"name":"LTe","project":{"name":"First"}}}})
+      parsed_response.should ==
+        JSON.parse(%Q({"result":{"user":{"name":"LTe","project":{"name":"First"}}}}))
     end
   end
 

data/spec/grape_rabl_partials_spec.rb

@@ -1,6 +1,8 @@
 require 'spec_helper'
 
 describe 'Grape::Rabl partials' do
+  let(:parsed_response) { JSON.parse(last_response.body) }
+
   subject do
     Class.new(Grape::API)
   end
@@ -23,7 +25,7 @@ describe 'Grape::Rabl partials' do
     end
 
     get('/home')
-    last_response.body.should ==
-      "{\"project\":{\"name\":\"First\",\"info\":{\"type\":\"paper\"},\"author\":{\"author\":\"LTe\"}}}"
+    parsed_response.should ==
+      JSON.parse("{\"project\":{\"name\":\"First\",\"info\":{\"type\":\"paper\"},\"author\":{\"author\":\"LTe\"}}}")
   end
 end

data/spec/grape_rabl_spec.rb

@@ -31,6 +31,8 @@ describe Grape::Rabl do
   end
 
   context 'titl root is setup'  do
+    let(:parsed_response) { JSON.parse(last_response.body) }
+
     before do
       subject.before { env['api.tilt.root'] = "#{File.dirname(__FILE__)}/views" }
     end
@@ -39,7 +41,7 @@ describe Grape::Rabl do
       it 'should execute helper' do
         subject.get('/home', rabl: 'helper') { @user = OpenStruct.new }
         get '/home'
-        last_response.body.should == "{\"user\":{\"helper\":\"my_helper\"}}"
+        parsed_response.should == JSON.parse("{\"user\":{\"helper\":\"my_helper\"}}")
       end
     end
 
@@ -50,6 +52,12 @@ describe Grape::Rabl do
           render rabl: 'admin'
         end
 
+        subject.get('/admin/:id', rabl: 'user') do
+          @user = OpenStruct.new(name: 'LTe')
+
+          render rabl: 'admin' if params[:id] == '1'
+        end
+
         subject.get('/home-detail', rabl: 'user') do
           @user = OpenStruct.new(name: 'LTe')
           render rabl: 'admin', locals: { details: 'amazing detail' }
@@ -67,23 +75,38 @@ describe Grape::Rabl do
 
       it 'renders template passed as argument to render method' do
         get('/home')
-        last_response.body.should == '{"admin":{"name":"LTe"}}'
+        parsed_response.should == JSON.parse('{"admin":{"name":"LTe"}}')
+      end
+
+      it 'renders admin template' do
+        get('/admin/1')
+        parsed_response.should == JSON.parse('{"admin":{"name":"LTe"}}')
+      end
+
+      it 'renders user template' do
+        get('/admin/2')
+        parsed_response.should == JSON.parse('{"user":{"name":"LTe","project":null}}')
       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"}}'
+        parsed_response.should == JSON.parse('{"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}}'
+        parsed_response.should == JSON.parse('{"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')
-        last_response.body.should == '{"user":{"name":"LTe","project":null}}'
+        parsed_response.should == JSON.parse('{"user":{"name":"LTe","project":null}}')
+      end
+
+      it 'does not modify endpoint options' do
+        get '/home'
+        expect(last_request.env['api.endpoint'].options[:route_options][:rabl]).to eq 'user'
       end
     end
 
@@ -108,7 +131,7 @@ describe Grape::Rabl do
         end
 
         get '/home'
-        last_response.body.should == '{"user":{"name":"LTe","email":"email@example.com","project":{"name":"First"}}}'
+        parsed_response.should == JSON.parse('{"user":{"name":"LTe","email":"email@example.com","project":{"name":"First"}}}')
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-rabl
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Piotr Niełacny
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-26 00:00:00.000000000 Z
+date: 2015-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -126,7 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Use rabl in grape