grape-builder 0.0.1
Sign up to get free protection for your applications and to get access to all the features.
- data/.DS_Store +0 -0
- data/CHANGELOG.md +12 -0
- data/Gemfile +4 -0
- data/Gemfile.lock +93 -0
- data/LICENSE.txt +23 -0
- data/README.md +210 -0
- data/Rakefile +10 -0
- data/grape-builder.gemspec +32 -0
- data/lib/grape/builder.rb +9 -0
- data/lib/grape/builder/partial.rb +20 -0
- data/lib/grape/builder/renderer.rb +33 -0
- data/lib/grape/builder/version.rb +5 -0
- data/lib/grape/formatter/builder.rb +38 -0
- data/spec/acceptance/partials_spec.rb +34 -0
- data/spec/acceptance/templates_spec.rb +63 -0
- data/spec/grape/builder/renderer_spec.rb +47 -0
- data/spec/grape/formatter/builder_spec.rb +55 -0
- data/spec/spec_helper.rb +20 -0
- data/spec/views/_partial.builder +1 -0
- data/spec/views/project.builder +9 -0
- data/spec/views/test.builder +1 -0
- data/spec/views/user.builder +8 -0
- metadata +237 -0
data/.DS_Store
ADDED
Binary file
|
data/CHANGELOG.md
ADDED
@@ -0,0 +1,12 @@
|
|
1
|
+
0.2.0
|
2
|
+
=====
|
3
|
+
|
4
|
+
* [#4](https://github.com/milkcocoa/grape-jbuilder/pull/4) Shifting rendering into a separate class, to support dynamic changing of templates within the logic of a Grape endpoint.
|
5
|
+
* [#4](https://github.com/milkcocoa/grape-jbuilder/pull/4) Drop support MRI 1.9.2.
|
6
|
+
* Support MRI 2.1.1.
|
7
|
+
|
8
|
+
0.1.0
|
9
|
+
=====
|
10
|
+
|
11
|
+
* Initial commit.
|
12
|
+
|
data/Gemfile
ADDED
data/Gemfile.lock
ADDED
@@ -0,0 +1,93 @@
|
|
1
|
+
PATH
|
2
|
+
remote: .
|
3
|
+
specs:
|
4
|
+
grape-builder (0.0.1)
|
5
|
+
builder
|
6
|
+
grape (>= 0.3)
|
7
|
+
i18n
|
8
|
+
tilt
|
9
|
+
|
10
|
+
GEM
|
11
|
+
remote: https://rubygems.org/
|
12
|
+
specs:
|
13
|
+
activesupport (4.2.5.1)
|
14
|
+
i18n (~> 0.7)
|
15
|
+
json (~> 1.7, >= 1.7.7)
|
16
|
+
minitest (~> 5.1)
|
17
|
+
thread_safe (~> 0.3, >= 0.3.4)
|
18
|
+
tzinfo (~> 1.1)
|
19
|
+
axiom-types (0.1.1)
|
20
|
+
descendants_tracker (~> 0.0.4)
|
21
|
+
ice_nine (~> 0.11.0)
|
22
|
+
thread_safe (~> 0.3, >= 0.3.1)
|
23
|
+
builder (3.2.2)
|
24
|
+
coercible (1.0.0)
|
25
|
+
descendants_tracker (~> 0.0.1)
|
26
|
+
descendants_tracker (0.0.4)
|
27
|
+
thread_safe (~> 0.3, >= 0.3.1)
|
28
|
+
diff-lcs (1.2.5)
|
29
|
+
equalizer (0.0.11)
|
30
|
+
equivalent-xml (0.6.0)
|
31
|
+
nokogiri (>= 1.4.3)
|
32
|
+
grape (0.14.0)
|
33
|
+
activesupport
|
34
|
+
builder
|
35
|
+
hashie (>= 2.1.0)
|
36
|
+
multi_json (>= 1.3.2)
|
37
|
+
multi_xml (>= 0.5.2)
|
38
|
+
rack (>= 1.3.0)
|
39
|
+
rack-accept
|
40
|
+
rack-mount
|
41
|
+
virtus (>= 1.0.0)
|
42
|
+
hashie (3.4.3)
|
43
|
+
i18n (0.7.0)
|
44
|
+
ice_nine (0.11.2)
|
45
|
+
json (1.8.3)
|
46
|
+
mini_portile2 (2.0.0)
|
47
|
+
minitest (5.8.4)
|
48
|
+
multi_json (1.11.2)
|
49
|
+
multi_xml (0.5.5)
|
50
|
+
nokogiri (1.6.7.2)
|
51
|
+
mini_portile2 (~> 2.0.0.rc2)
|
52
|
+
rack (1.6.4)
|
53
|
+
rack-accept (0.4.5)
|
54
|
+
rack (>= 0.4)
|
55
|
+
rack-mount (0.8.3)
|
56
|
+
rack (>= 1.0.0)
|
57
|
+
rack-test (0.6.3)
|
58
|
+
rack (>= 1.0)
|
59
|
+
rake (10.5.0)
|
60
|
+
rspec (3.4.0)
|
61
|
+
rspec-core (~> 3.4.0)
|
62
|
+
rspec-expectations (~> 3.4.0)
|
63
|
+
rspec-mocks (~> 3.4.0)
|
64
|
+
rspec-core (3.4.2)
|
65
|
+
rspec-support (~> 3.4.0)
|
66
|
+
rspec-expectations (3.4.0)
|
67
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
68
|
+
rspec-support (~> 3.4.0)
|
69
|
+
rspec-mocks (3.4.1)
|
70
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
71
|
+
rspec-support (~> 3.4.0)
|
72
|
+
rspec-support (3.4.1)
|
73
|
+
thread_safe (0.3.5)
|
74
|
+
tilt (2.0.2)
|
75
|
+
tzinfo (1.2.2)
|
76
|
+
thread_safe (~> 0.1)
|
77
|
+
virtus (1.0.5)
|
78
|
+
axiom-types (~> 0.1)
|
79
|
+
coercible (~> 1.0)
|
80
|
+
descendants_tracker (~> 0.0, >= 0.0.3)
|
81
|
+
equalizer (~> 0.0, >= 0.0.9)
|
82
|
+
|
83
|
+
PLATFORMS
|
84
|
+
ruby
|
85
|
+
|
86
|
+
DEPENDENCIES
|
87
|
+
bundler
|
88
|
+
equivalent-xml
|
89
|
+
grape-builder!
|
90
|
+
nokogiri
|
91
|
+
rack-test
|
92
|
+
rake
|
93
|
+
rspec
|
data/LICENSE.txt
ADDED
@@ -0,0 +1,23 @@
|
|
1
|
+
Copyright (c) 2012 Piotr Niełacny
|
2
|
+
Copyright (c) 2013 Shu Masuda
|
3
|
+
|
4
|
+
MIT License
|
5
|
+
|
6
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
7
|
+
a copy of this software and associated documentation files (the
|
8
|
+
"Software"), to deal in the Software without restriction, including
|
9
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
10
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
11
|
+
permit persons to whom the Software is furnished to do so, subject to
|
12
|
+
the following conditions:
|
13
|
+
|
14
|
+
The above copyright notice and this permission notice shall be
|
15
|
+
included in all copies or substantial portions of the Software.
|
16
|
+
|
17
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
18
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
19
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
20
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
21
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
22
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
23
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,210 @@
|
|
1
|
+
# Grape::Builder
|
2
|
+
|
3
|
+
Use [Builder](https://github.com/jimweirich/builder) templates in [Grape](https://github.com/intridea/grape)!
|
4
|
+
|
5
|
+
This gem is completely based on [grape-jbuilder](https://github.com/milkcocoa/grape-jbuilder) which in turn is completely based on [grape-rabl](https://github.com/LTe/grape-rabl).
|
6
|
+
|
7
|
+
## Installation
|
8
|
+
|
9
|
+
Add this line to your application's Gemfile:
|
10
|
+
|
11
|
+
gem 'grape-builder'
|
12
|
+
|
13
|
+
And then execute:
|
14
|
+
|
15
|
+
$ bundle
|
16
|
+
|
17
|
+
<!--Or install it yourself as:-->
|
18
|
+
|
19
|
+
<!-- $ gem install grape-builder-->
|
20
|
+
|
21
|
+
## Usage
|
22
|
+
|
23
|
+
### Require grape-builder
|
24
|
+
|
25
|
+
```ruby
|
26
|
+
# config.ru
|
27
|
+
require 'grape/jbuilder'
|
28
|
+
```
|
29
|
+
|
30
|
+
### Setup view root directory
|
31
|
+
```ruby
|
32
|
+
# config.ru
|
33
|
+
require 'grape/builder'
|
34
|
+
|
35
|
+
use Rack::Config do |env|
|
36
|
+
env['api.tilt.root'] = '/path/to/view/root/directory'
|
37
|
+
end
|
38
|
+
```
|
39
|
+
|
40
|
+
### Tell your API to use Grape::Formatter:: Builder
|
41
|
+
|
42
|
+
```ruby
|
43
|
+
class API < Grape::API
|
44
|
+
format :xml
|
45
|
+
formatter :xml, Grape::Formatter::Builder
|
46
|
+
end
|
47
|
+
```
|
48
|
+
|
49
|
+
### Use Builder templates conditionally
|
50
|
+
|
51
|
+
Add the template name to the API options.
|
52
|
+
|
53
|
+
```ruby
|
54
|
+
get '/user/:id', builder: 'user.builder' do
|
55
|
+
@user = User.find(params[:id])
|
56
|
+
end
|
57
|
+
```
|
58
|
+
|
59
|
+
You can use instance variables in the builder template.
|
60
|
+
|
61
|
+
```ruby
|
62
|
+
xml.user do
|
63
|
+
xml.name(@user.name)
|
64
|
+
xml.email(@user.email)j
|
65
|
+
xml.project do
|
66
|
+
xml.name(@project.name)
|
67
|
+
end
|
68
|
+
end
|
69
|
+
```
|
70
|
+
|
71
|
+
### Use builder templates dynamically
|
72
|
+
|
73
|
+
```ruby
|
74
|
+
get ':id' do
|
75
|
+
user = User.find_by(id: params[:id])
|
76
|
+
if article
|
77
|
+
env['api.tilt.template'] = 'users/show'
|
78
|
+
env['api.tilt.locals'] = {user: user}
|
79
|
+
else
|
80
|
+
status 404
|
81
|
+
{'status' => 'Not Found', 'errors' => "User id '#{params[:id]}' is not found."}
|
82
|
+
end
|
83
|
+
end
|
84
|
+
```
|
85
|
+
|
86
|
+
## You can omit .builder
|
87
|
+
|
88
|
+
The following are identical.
|
89
|
+
|
90
|
+
```ruby
|
91
|
+
get '/home', builder: 'view'
|
92
|
+
get '/home', builder: 'view.jbuilder'
|
93
|
+
```
|
94
|
+
|
95
|
+
### Example
|
96
|
+
|
97
|
+
```ruby
|
98
|
+
# config.ru
|
99
|
+
require 'grape/builder'
|
100
|
+
|
101
|
+
use Rack::Config do |env|
|
102
|
+
env['api.tilt.root'] = '/path/to/view/root/directory'
|
103
|
+
end
|
104
|
+
|
105
|
+
class UserAPI < Grape::API
|
106
|
+
format :xml
|
107
|
+
formatter :xml, Grape::Formatter::Builder
|
108
|
+
|
109
|
+
# use Builder with 'user.builder' template
|
110
|
+
get '/user/:id', builder: 'user' do
|
111
|
+
@user = User.find(params[:id])
|
112
|
+
end
|
113
|
+
|
114
|
+
# do not use builder, fallback to the defalt Grape XML formatter
|
115
|
+
get '/users' do
|
116
|
+
User.all
|
117
|
+
end
|
118
|
+
end
|
119
|
+
```
|
120
|
+
|
121
|
+
```ruby
|
122
|
+
# user.builder
|
123
|
+
xml.user do
|
124
|
+
xmlname(@user.name)
|
125
|
+
end
|
126
|
+
```
|
127
|
+
|
128
|
+
## Usage with Rails
|
129
|
+
|
130
|
+
Create a grape application.
|
131
|
+
|
132
|
+
```ruby
|
133
|
+
# app/api/user.rb
|
134
|
+
class MyAPI < Grape::API
|
135
|
+
format :xml
|
136
|
+
formatter :xml, Grape::Formatter::Builder
|
137
|
+
get '/user/:id', builder: 'user' do
|
138
|
+
@user = User.find(params[:id])
|
139
|
+
end
|
140
|
+
end
|
141
|
+
```
|
142
|
+
|
143
|
+
```ruby
|
144
|
+
# app/views/api/user.builder
|
145
|
+
xml.user do
|
146
|
+
xml.name(@user.name)
|
147
|
+
end
|
148
|
+
```
|
149
|
+
|
150
|
+
Edit your **config/application.rb** and add view path
|
151
|
+
|
152
|
+
```ruby
|
153
|
+
# application.rb
|
154
|
+
class Application < Rails::Application
|
155
|
+
config.middleware.use(Rack::Config) do |env|
|
156
|
+
env['api.tilt.root'] = Rails.root.join 'app', 'views', 'api'
|
157
|
+
end
|
158
|
+
end
|
159
|
+
```
|
160
|
+
|
161
|
+
Mount application to Rails router
|
162
|
+
|
163
|
+
```ruby
|
164
|
+
# routes.rb
|
165
|
+
GrapeExampleRails::Application.routes.draw do
|
166
|
+
mount MyAPI , at: '/api'
|
167
|
+
end
|
168
|
+
```
|
169
|
+
|
170
|
+
## Partials
|
171
|
+
|
172
|
+
|
173
|
+
Use the `partial.render` method to render a partial template
|
174
|
+
|
175
|
+
```ruby
|
176
|
+
# app/views/api/user/index.builder
|
177
|
+
xml.users do
|
178
|
+
@users.each do |u|
|
179
|
+
xml << partial.render('user/show', user: u)
|
180
|
+
end
|
181
|
+
end
|
182
|
+
```
|
183
|
+
|
184
|
+
```ruby
|
185
|
+
# app/views/api/user/show.builder
|
186
|
+
xml.user do
|
187
|
+
xml.name(@user.name)
|
188
|
+
end
|
189
|
+
```
|
190
|
+
|
191
|
+
## Rspec
|
192
|
+
|
193
|
+
See "Writing Tests" in https://github.com/intridea/grape.
|
194
|
+
|
195
|
+
Enjoy :)
|
196
|
+
|
197
|
+
|
198
|
+
## Special Thanks
|
199
|
+
|
200
|
+
Special thanks to [@milkcocoa](https://github.com/milkcocoa) because this gem is completely based on [grape-jbuilder](https://github.com/milkcocoa/grape-jbuilder).
|
201
|
+
|
202
|
+
Also thanks to [@LTe](https://github.com/LTe) since `grape-jbuilder` is based on [grape-rabl](https://github.com/LTe/grape-rabl).
|
203
|
+
|
204
|
+
## Contributing
|
205
|
+
|
206
|
+
1. Fork it
|
207
|
+
2. Create your feature branch (`git checkout -b my-new-feature`)
|
208
|
+
3. Commit your changes (`git commit -am 'Add some feature'`)
|
209
|
+
4. Push to the branch (`git push origin my-new-feature`)
|
210
|
+
5. Create new Pull Request
|
data/Rakefile
ADDED
@@ -0,0 +1,32 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'grape/builder/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "grape-builder"
|
8
|
+
spec.version = Grape::Builder::VERSION
|
9
|
+
spec.authors = ["Plex"]
|
10
|
+
spec.email = ["jose@plexapp.com"]
|
11
|
+
spec.description = %q{Use Builder in Grape}
|
12
|
+
spec.summary = %q{Use Builder in Grape}
|
13
|
+
spec.homepage = "https://github.com/plexinc/grape-builder"
|
14
|
+
spec.license = "MIT"
|
15
|
+
|
16
|
+
spec.files = `git ls-files`.split($/)
|
17
|
+
spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
|
18
|
+
spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
|
19
|
+
spec.require_paths = ["lib"]
|
20
|
+
|
21
|
+
spec.add_dependency "grape", ">= 0.3"
|
22
|
+
spec.add_dependency "builder"
|
23
|
+
spec.add_dependency "tilt"
|
24
|
+
spec.add_dependency "i18n"
|
25
|
+
|
26
|
+
spec.add_development_dependency "bundler"
|
27
|
+
spec.add_development_dependency "rack-test"
|
28
|
+
spec.add_development_dependency "nokogiri"
|
29
|
+
spec.add_development_dependency "equivalent-xml"
|
30
|
+
spec.add_development_dependency "rake"
|
31
|
+
spec.add_development_dependency "rspec"
|
32
|
+
end
|
@@ -0,0 +1,20 @@
|
|
1
|
+
module Grape
|
2
|
+
module Builder
|
3
|
+
module Scope
|
4
|
+
attr_accessor :partial
|
5
|
+
end
|
6
|
+
class Partial
|
7
|
+
attr_reader :view_path, :scope
|
8
|
+
|
9
|
+
def initialize(view_path, scope)
|
10
|
+
@view_path = view_path
|
11
|
+
@scope = scope
|
12
|
+
end
|
13
|
+
|
14
|
+
def render(template, locals={})
|
15
|
+
Grape::Builder::Renderer.new(view_path, template).
|
16
|
+
render(scope, locals)
|
17
|
+
end
|
18
|
+
end
|
19
|
+
end
|
20
|
+
end
|
@@ -0,0 +1,33 @@
|
|
1
|
+
module Grape
|
2
|
+
module Builder
|
3
|
+
class Renderer
|
4
|
+
def initialize(view_path, template)
|
5
|
+
@view_path, @template = view_path, template
|
6
|
+
end
|
7
|
+
|
8
|
+
def render(scope, locals = {})
|
9
|
+
unless view_path
|
10
|
+
raise "Use Rack::Config to set 'api.tilt.root' in config.ru"
|
11
|
+
end
|
12
|
+
|
13
|
+
scope.extend Grape::Builder::Scope
|
14
|
+
scope.partial = Grape::Builder::Partial.new(view_path, scope)
|
15
|
+
|
16
|
+
engine = ::Tilt.new file, nil, view_path: view_path
|
17
|
+
engine.render scope, locals
|
18
|
+
end
|
19
|
+
|
20
|
+
private
|
21
|
+
|
22
|
+
attr_reader :view_path, :template
|
23
|
+
|
24
|
+
def file
|
25
|
+
File.join view_path, template_with_extension
|
26
|
+
end
|
27
|
+
|
28
|
+
def template_with_extension
|
29
|
+
template[/\.builder$/] ? template : "#{template}.builder"
|
30
|
+
end
|
31
|
+
end
|
32
|
+
end
|
33
|
+
end
|
@@ -0,0 +1,38 @@
|
|
1
|
+
module Grape
|
2
|
+
module Formatter
|
3
|
+
class Builder
|
4
|
+
attr_reader :env, :endpoint, :object
|
5
|
+
|
6
|
+
def self.call(object, env)
|
7
|
+
new(object, env).call
|
8
|
+
end
|
9
|
+
|
10
|
+
def initialize(object, env)
|
11
|
+
@object, @env = object, env
|
12
|
+
@endpoint = env['api.endpoint']
|
13
|
+
end
|
14
|
+
|
15
|
+
def call
|
16
|
+
return Grape::Formatter::Xml.call(object, env) unless template?
|
17
|
+
|
18
|
+
Grape::Builder::Renderer.new(env['api.tilt.root'], template).
|
19
|
+
render(endpoint, locals)
|
20
|
+
end
|
21
|
+
|
22
|
+
private
|
23
|
+
|
24
|
+
def locals
|
25
|
+
env['api.tilt.locals'] || {}
|
26
|
+
end
|
27
|
+
|
28
|
+
def template
|
29
|
+
env['api.tilt.template'] ||
|
30
|
+
endpoint.options.fetch(:route_options, {})[:builder]
|
31
|
+
end
|
32
|
+
|
33
|
+
def template?
|
34
|
+
!!template
|
35
|
+
end
|
36
|
+
end
|
37
|
+
end
|
38
|
+
end
|
@@ -0,0 +1,34 @@
|
|
1
|
+
require 'spec_helper'
|
2
|
+
|
3
|
+
describe 'Grape::Builder partials' do
|
4
|
+
let(:app) { Class.new(Grape::API) }
|
5
|
+
|
6
|
+
before :each do
|
7
|
+
app.format :xml
|
8
|
+
app.formatter :xml, Grape::Formatter::Builder
|
9
|
+
app.before do
|
10
|
+
env['api.tilt.root'] = "#{File.dirname(__FILE__)}/../views"
|
11
|
+
end
|
12
|
+
end
|
13
|
+
|
14
|
+
it 'proper render partials' do
|
15
|
+
app.get('/home', builder: 'project') do
|
16
|
+
@author = OpenStruct.new(author: 'LTe')
|
17
|
+
@type = OpenStruct.new(type: 'paper')
|
18
|
+
@project = OpenStruct.new(name: 'First', type: @type, author: @author)
|
19
|
+
end
|
20
|
+
|
21
|
+
pattern = Nokogiri::XML::Builder.new do |xml|
|
22
|
+
xml.project do
|
23
|
+
xml.name 'First'
|
24
|
+
xml.info do
|
25
|
+
xml.type 'paper'
|
26
|
+
end
|
27
|
+
xml.author 'LTe'
|
28
|
+
end
|
29
|
+
end
|
30
|
+
|
31
|
+
get('/home')
|
32
|
+
expect(pattern.to_xml).to be_equivalent_to(Nokogiri::XML(last_response.body))
|
33
|
+
end
|
34
|
+
end
|
@@ -0,0 +1,63 @@
|
|
1
|
+
require 'spec_helper'
|
2
|
+
|
3
|
+
describe Grape::Builder do
|
4
|
+
let(:app) { Class.new(Grape::API) }
|
5
|
+
|
6
|
+
before do
|
7
|
+
app.format :xml
|
8
|
+
app.formatter :xml, Grape::Formatter::Builder
|
9
|
+
app.before do
|
10
|
+
env['api.tilt.root'] = "#{File.dirname(__FILE__)}/../views"
|
11
|
+
end
|
12
|
+
end
|
13
|
+
|
14
|
+
it 'should work without builder template' do
|
15
|
+
app.get('/home') { { hello: 'world' } }
|
16
|
+
|
17
|
+
pattern = Nokogiri::XML('<hash><hello>world</hello></hash>')
|
18
|
+
get '/home'
|
19
|
+
|
20
|
+
expect(last_response.body).to be_equivalent_to(pattern)
|
21
|
+
end
|
22
|
+
|
23
|
+
it 'should work with dynamically set templates' do
|
24
|
+
app.get('/home') { env['api.tilt.template'] = 'test' }
|
25
|
+
|
26
|
+
pattern = Nokogiri::XML('<foo>bar</foo>')
|
27
|
+
get '/home'
|
28
|
+
|
29
|
+
expect(last_response.body).to be_equivalent_to(pattern)
|
30
|
+
end
|
31
|
+
|
32
|
+
it 'should respond with proper content-type' do
|
33
|
+
app.get('/home', jbuilder: 'user') do
|
34
|
+
@user = OpenStruct.new(name: 'LTe', email: 'email@example.com')
|
35
|
+
@project = OpenStruct.new(name: 'First')
|
36
|
+
end
|
37
|
+
|
38
|
+
get('/home')
|
39
|
+
|
40
|
+
expect(last_response.headers['Content-Type']).to eq('application/xml')
|
41
|
+
end
|
42
|
+
|
43
|
+
it "renders the template's content" do
|
44
|
+
app.get('/home', builder: 'user') do
|
45
|
+
@user = OpenStruct.new(name: 'LTe', email: 'email@example.com')
|
46
|
+
@project = OpenStruct.new(name: 'First')
|
47
|
+
end
|
48
|
+
|
49
|
+
get('/home')
|
50
|
+
|
51
|
+
pattern = Nokogiri::XML::Builder.new do |xml|
|
52
|
+
xml.user do
|
53
|
+
xml.name 'LTe'
|
54
|
+
xml.email 'email@example.com'
|
55
|
+
xml.project do
|
56
|
+
xml.name 'First'
|
57
|
+
end
|
58
|
+
end
|
59
|
+
end
|
60
|
+
|
61
|
+
expect(last_response.body).to be_equivalent_to(pattern.to_xml)
|
62
|
+
end
|
63
|
+
end
|
@@ -0,0 +1,47 @@
|
|
1
|
+
require 'spec_helper'
|
2
|
+
|
3
|
+
describe Grape::Builder::Renderer do
|
4
|
+
# let(:engine) { double :render => '' }
|
5
|
+
# let(:scope) { double }
|
6
|
+
|
7
|
+
# before :each do
|
8
|
+
# Tilt.stub :new => engine
|
9
|
+
# end
|
10
|
+
|
11
|
+
# describe '#render' do
|
12
|
+
# it "raises an error if the view path is nil" do
|
13
|
+
# renderer = Grape::Jbuilder::Renderer.new(nil, 'file')
|
14
|
+
|
15
|
+
# expect { renderer.render scope }.to raise_error
|
16
|
+
# end
|
17
|
+
|
18
|
+
# it "creates a new Tilt engine with the file and view path" do
|
19
|
+
# renderer = Grape::Jbuilder::Renderer.new('/tmp', 'file.jbuilder')
|
20
|
+
|
21
|
+
# expect(Tilt).to receive(:new).
|
22
|
+
# with('/tmp/file.jbuilder', nil, :view_path => '/tmp').
|
23
|
+
# and_return(engine)
|
24
|
+
|
25
|
+
# renderer.render scope
|
26
|
+
# end
|
27
|
+
|
28
|
+
# it "appends jbuilder extension to the file if required" do
|
29
|
+
# renderer = Grape::Jbuilder::Renderer.new('/tmp', 'file')
|
30
|
+
|
31
|
+
# expect(Tilt).to receive(:new).
|
32
|
+
# with('/tmp/file.jbuilder', nil, :view_path => '/tmp').
|
33
|
+
# and_return(engine)
|
34
|
+
|
35
|
+
# renderer.render scope
|
36
|
+
# end
|
37
|
+
|
38
|
+
# it "renders with the provided scope and locals" do
|
39
|
+
# renderer = Grape::Jbuilder::Renderer.new('/tmp', 'file')
|
40
|
+
|
41
|
+
# expect(engine).to receive(:render).with(scope, :foo => :bar).
|
42
|
+
# and_return('')
|
43
|
+
|
44
|
+
# renderer.render scope, :foo => :bar
|
45
|
+
# end
|
46
|
+
# end
|
47
|
+
end
|
@@ -0,0 +1,55 @@
|
|
1
|
+
require 'spec_helper'
|
2
|
+
|
3
|
+
describe Grape::Formatter::Builder do
|
4
|
+
# let(:object) { double }
|
5
|
+
# let(:env) { {'api.endpoint' => endpoint, 'api.tilt.root' => '/tmp'} }
|
6
|
+
# let(:endpoint) { double :options => {} }
|
7
|
+
# let(:renderer) { double :render => '' }
|
8
|
+
|
9
|
+
# before :each do
|
10
|
+
# Grape::Jbuilder::Renderer.stub :new => renderer
|
11
|
+
|
12
|
+
# endpoint.options[:route_options] = {:jbuilder => 'user'}
|
13
|
+
# end
|
14
|
+
|
15
|
+
# describe '.call' do
|
16
|
+
# it "passes the call to the Json render if no template is provided" do
|
17
|
+
# endpoint.options.clear
|
18
|
+
|
19
|
+
# expect(Grape::Formatter::Json).to receive(:call).with(object, env)
|
20
|
+
|
21
|
+
# Grape::Formatter::Jbuilder.call object, env
|
22
|
+
# end
|
23
|
+
|
24
|
+
# it "creates a renderer with the root and template" do
|
25
|
+
# expect(Grape::Jbuilder::Renderer).to receive(:new).with('/tmp', 'user').
|
26
|
+
# and_return(renderer)
|
27
|
+
|
28
|
+
# Grape::Formatter::Jbuilder.call object, env
|
29
|
+
# end
|
30
|
+
|
31
|
+
# it "accepts templates in the env hash" do
|
32
|
+
# env['api.tilt.template'] = 'foo'
|
33
|
+
|
34
|
+
# expect(Grape::Jbuilder::Renderer).to receive(:new).with('/tmp', 'foo').
|
35
|
+
# and_return(renderer)
|
36
|
+
|
37
|
+
# Grape::Formatter::Jbuilder.call object, env
|
38
|
+
# end
|
39
|
+
|
40
|
+
# it "passes the endpoint in as the render scope" do
|
41
|
+
# expect(renderer).to receive(:render).with(endpoint, {}).and_return('')
|
42
|
+
|
43
|
+
# Grape::Formatter::Jbuilder.call object, env
|
44
|
+
# end
|
45
|
+
|
46
|
+
# it "accepts custom locals for the render call" do
|
47
|
+
# env['api.tilt.locals'] = {:foo => :bar}
|
48
|
+
|
49
|
+
# expect(renderer).to receive(:render).with(endpoint, {:foo => :bar}).
|
50
|
+
# and_return('')
|
51
|
+
|
52
|
+
# Grape::Formatter::Jbuilder.call object, env
|
53
|
+
# end
|
54
|
+
# end
|
55
|
+
end
|
data/spec/spec_helper.rb
ADDED
@@ -0,0 +1,20 @@
|
|
1
|
+
$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
|
2
|
+
$LOAD_PATH.unshift(File.dirname(__FILE__))
|
3
|
+
|
4
|
+
require 'bundler'
|
5
|
+
Bundler.setup :default, :test
|
6
|
+
|
7
|
+
require 'active_support/core_ext/hash/conversions'
|
8
|
+
require 'grape/builder'
|
9
|
+
require 'ostruct'
|
10
|
+
require 'nokogiri'
|
11
|
+
require 'rspec/matchers' # req by equivalent-xml custom matcher `be_equivalent_to`
|
12
|
+
require 'equivalent-xml'
|
13
|
+
require 'rack/test'
|
14
|
+
require 'rspec'
|
15
|
+
|
16
|
+
RSpec.configure do |config|
|
17
|
+
config.include Rack::Test::Methods
|
18
|
+
end
|
19
|
+
|
20
|
+
Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
|
@@ -0,0 +1 @@
|
|
1
|
+
xml.type(@type.type)
|
@@ -0,0 +1 @@
|
|
1
|
+
xml.foo 'bar'
|
metadata
ADDED
@@ -0,0 +1,237 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: grape-builder
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.0.1
|
5
|
+
prerelease:
|
6
|
+
platform: ruby
|
7
|
+
authors:
|
8
|
+
- Plex
|
9
|
+
autorequire:
|
10
|
+
bindir: bin
|
11
|
+
cert_chain: []
|
12
|
+
date: 2016-02-11 00:00:00.000000000 Z
|
13
|
+
dependencies:
|
14
|
+
- !ruby/object:Gem::Dependency
|
15
|
+
name: grape
|
16
|
+
requirement: !ruby/object:Gem::Requirement
|
17
|
+
none: false
|
18
|
+
requirements:
|
19
|
+
- - ! '>='
|
20
|
+
- !ruby/object:Gem::Version
|
21
|
+
version: '0.3'
|
22
|
+
type: :runtime
|
23
|
+
prerelease: false
|
24
|
+
version_requirements: !ruby/object:Gem::Requirement
|
25
|
+
none: false
|
26
|
+
requirements:
|
27
|
+
- - ! '>='
|
28
|
+
- !ruby/object:Gem::Version
|
29
|
+
version: '0.3'
|
30
|
+
- !ruby/object:Gem::Dependency
|
31
|
+
name: builder
|
32
|
+
requirement: !ruby/object:Gem::Requirement
|
33
|
+
none: false
|
34
|
+
requirements:
|
35
|
+
- - ! '>='
|
36
|
+
- !ruby/object:Gem::Version
|
37
|
+
version: '0'
|
38
|
+
type: :runtime
|
39
|
+
prerelease: false
|
40
|
+
version_requirements: !ruby/object:Gem::Requirement
|
41
|
+
none: false
|
42
|
+
requirements:
|
43
|
+
- - ! '>='
|
44
|
+
- !ruby/object:Gem::Version
|
45
|
+
version: '0'
|
46
|
+
- !ruby/object:Gem::Dependency
|
47
|
+
name: tilt
|
48
|
+
requirement: !ruby/object:Gem::Requirement
|
49
|
+
none: false
|
50
|
+
requirements:
|
51
|
+
- - ! '>='
|
52
|
+
- !ruby/object:Gem::Version
|
53
|
+
version: '0'
|
54
|
+
type: :runtime
|
55
|
+
prerelease: false
|
56
|
+
version_requirements: !ruby/object:Gem::Requirement
|
57
|
+
none: false
|
58
|
+
requirements:
|
59
|
+
- - ! '>='
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '0'
|
62
|
+
- !ruby/object:Gem::Dependency
|
63
|
+
name: i18n
|
64
|
+
requirement: !ruby/object:Gem::Requirement
|
65
|
+
none: false
|
66
|
+
requirements:
|
67
|
+
- - ! '>='
|
68
|
+
- !ruby/object:Gem::Version
|
69
|
+
version: '0'
|
70
|
+
type: :runtime
|
71
|
+
prerelease: false
|
72
|
+
version_requirements: !ruby/object:Gem::Requirement
|
73
|
+
none: false
|
74
|
+
requirements:
|
75
|
+
- - ! '>='
|
76
|
+
- !ruby/object:Gem::Version
|
77
|
+
version: '0'
|
78
|
+
- !ruby/object:Gem::Dependency
|
79
|
+
name: bundler
|
80
|
+
requirement: !ruby/object:Gem::Requirement
|
81
|
+
none: false
|
82
|
+
requirements:
|
83
|
+
- - ! '>='
|
84
|
+
- !ruby/object:Gem::Version
|
85
|
+
version: '0'
|
86
|
+
type: :development
|
87
|
+
prerelease: false
|
88
|
+
version_requirements: !ruby/object:Gem::Requirement
|
89
|
+
none: false
|
90
|
+
requirements:
|
91
|
+
- - ! '>='
|
92
|
+
- !ruby/object:Gem::Version
|
93
|
+
version: '0'
|
94
|
+
- !ruby/object:Gem::Dependency
|
95
|
+
name: rack-test
|
96
|
+
requirement: !ruby/object:Gem::Requirement
|
97
|
+
none: false
|
98
|
+
requirements:
|
99
|
+
- - ! '>='
|
100
|
+
- !ruby/object:Gem::Version
|
101
|
+
version: '0'
|
102
|
+
type: :development
|
103
|
+
prerelease: false
|
104
|
+
version_requirements: !ruby/object:Gem::Requirement
|
105
|
+
none: false
|
106
|
+
requirements:
|
107
|
+
- - ! '>='
|
108
|
+
- !ruby/object:Gem::Version
|
109
|
+
version: '0'
|
110
|
+
- !ruby/object:Gem::Dependency
|
111
|
+
name: nokogiri
|
112
|
+
requirement: !ruby/object:Gem::Requirement
|
113
|
+
none: false
|
114
|
+
requirements:
|
115
|
+
- - ! '>='
|
116
|
+
- !ruby/object:Gem::Version
|
117
|
+
version: '0'
|
118
|
+
type: :development
|
119
|
+
prerelease: false
|
120
|
+
version_requirements: !ruby/object:Gem::Requirement
|
121
|
+
none: false
|
122
|
+
requirements:
|
123
|
+
- - ! '>='
|
124
|
+
- !ruby/object:Gem::Version
|
125
|
+
version: '0'
|
126
|
+
- !ruby/object:Gem::Dependency
|
127
|
+
name: equivalent-xml
|
128
|
+
requirement: !ruby/object:Gem::Requirement
|
129
|
+
none: false
|
130
|
+
requirements:
|
131
|
+
- - ! '>='
|
132
|
+
- !ruby/object:Gem::Version
|
133
|
+
version: '0'
|
134
|
+
type: :development
|
135
|
+
prerelease: false
|
136
|
+
version_requirements: !ruby/object:Gem::Requirement
|
137
|
+
none: false
|
138
|
+
requirements:
|
139
|
+
- - ! '>='
|
140
|
+
- !ruby/object:Gem::Version
|
141
|
+
version: '0'
|
142
|
+
- !ruby/object:Gem::Dependency
|
143
|
+
name: rake
|
144
|
+
requirement: !ruby/object:Gem::Requirement
|
145
|
+
none: false
|
146
|
+
requirements:
|
147
|
+
- - ! '>='
|
148
|
+
- !ruby/object:Gem::Version
|
149
|
+
version: '0'
|
150
|
+
type: :development
|
151
|
+
prerelease: false
|
152
|
+
version_requirements: !ruby/object:Gem::Requirement
|
153
|
+
none: false
|
154
|
+
requirements:
|
155
|
+
- - ! '>='
|
156
|
+
- !ruby/object:Gem::Version
|
157
|
+
version: '0'
|
158
|
+
- !ruby/object:Gem::Dependency
|
159
|
+
name: rspec
|
160
|
+
requirement: !ruby/object:Gem::Requirement
|
161
|
+
none: false
|
162
|
+
requirements:
|
163
|
+
- - ! '>='
|
164
|
+
- !ruby/object:Gem::Version
|
165
|
+
version: '0'
|
166
|
+
type: :development
|
167
|
+
prerelease: false
|
168
|
+
version_requirements: !ruby/object:Gem::Requirement
|
169
|
+
none: false
|
170
|
+
requirements:
|
171
|
+
- - ! '>='
|
172
|
+
- !ruby/object:Gem::Version
|
173
|
+
version: '0'
|
174
|
+
description: Use Builder in Grape
|
175
|
+
email:
|
176
|
+
- jose@plexapp.com
|
177
|
+
executables: []
|
178
|
+
extensions: []
|
179
|
+
extra_rdoc_files: []
|
180
|
+
files:
|
181
|
+
- .DS_Store
|
182
|
+
- CHANGELOG.md
|
183
|
+
- Gemfile
|
184
|
+
- Gemfile.lock
|
185
|
+
- LICENSE.txt
|
186
|
+
- README.md
|
187
|
+
- Rakefile
|
188
|
+
- grape-builder.gemspec
|
189
|
+
- lib/grape/builder.rb
|
190
|
+
- lib/grape/builder/partial.rb
|
191
|
+
- lib/grape/builder/renderer.rb
|
192
|
+
- lib/grape/builder/version.rb
|
193
|
+
- lib/grape/formatter/builder.rb
|
194
|
+
- spec/acceptance/partials_spec.rb
|
195
|
+
- spec/acceptance/templates_spec.rb
|
196
|
+
- spec/grape/builder/renderer_spec.rb
|
197
|
+
- spec/grape/formatter/builder_spec.rb
|
198
|
+
- spec/spec_helper.rb
|
199
|
+
- spec/views/_partial.builder
|
200
|
+
- spec/views/project.builder
|
201
|
+
- spec/views/test.builder
|
202
|
+
- spec/views/user.builder
|
203
|
+
homepage: https://github.com/plexinc/grape-builder
|
204
|
+
licenses:
|
205
|
+
- MIT
|
206
|
+
post_install_message:
|
207
|
+
rdoc_options: []
|
208
|
+
require_paths:
|
209
|
+
- lib
|
210
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
211
|
+
none: false
|
212
|
+
requirements:
|
213
|
+
- - ! '>='
|
214
|
+
- !ruby/object:Gem::Version
|
215
|
+
version: '0'
|
216
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
217
|
+
none: false
|
218
|
+
requirements:
|
219
|
+
- - ! '>='
|
220
|
+
- !ruby/object:Gem::Version
|
221
|
+
version: '0'
|
222
|
+
requirements: []
|
223
|
+
rubyforge_project:
|
224
|
+
rubygems_version: 1.8.23
|
225
|
+
signing_key:
|
226
|
+
specification_version: 3
|
227
|
+
summary: Use Builder in Grape
|
228
|
+
test_files:
|
229
|
+
- spec/acceptance/partials_spec.rb
|
230
|
+
- spec/acceptance/templates_spec.rb
|
231
|
+
- spec/grape/builder/renderer_spec.rb
|
232
|
+
- spec/grape/formatter/builder_spec.rb
|
233
|
+
- spec/spec_helper.rb
|
234
|
+
- spec/views/_partial.builder
|
235
|
+
- spec/views/project.builder
|
236
|
+
- spec/views/test.builder
|
237
|
+
- spec/views/user.builder
|