jbuilder 2.7.0 → 2.11.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/.gitignore +2 -0
- data/.travis.yml +34 -48
- data/Appraisals +16 -12
- data/CHANGELOG.md +62 -0
- data/CONTRIBUTING.md +1 -3
- data/Gemfile +0 -1
- data/MIT-LICENSE +1 -1
- data/README.md +47 -12
- data/gemfiles/rails_5_0.gemfile +1 -4
- data/gemfiles/rails_5_1.gemfile +1 -4
- data/gemfiles/{rails_4_2.gemfile → rails_5_2.gemfile} +1 -4
- data/gemfiles/rails_6_0.gemfile +10 -0
- data/gemfiles/rails_head.gemfile +10 -0
- data/jbuilder.gemspec +9 -4
- data/lib/generators/rails/jbuilder_generator.rb +12 -2
- data/lib/generators/rails/scaffold_controller_generator.rb +6 -0
- data/lib/generators/rails/templates/api_controller.rb +4 -4
- data/lib/generators/rails/templates/controller.rb +14 -19
- data/lib/generators/rails/templates/index.json.jbuilder +1 -1
- data/lib/generators/rails/templates/partial.json.jbuilder +15 -1
- data/lib/jbuilder.rb +64 -23
- data/lib/jbuilder/jbuilder_template.rb +10 -9
- data/test/jbuilder_dependency_tracker_test.rb +1 -1
- data/test/jbuilder_generator_test.rb +25 -5
- data/test/jbuilder_template_test.rb +193 -338
- data/test/jbuilder_test.rb +228 -3
- data/test/scaffold_api_controller_generator_test.rb +17 -2
- data/test/scaffold_controller_generator_test.rb +21 -7
- data/test/test_helper.rb +26 -6
- metadata +9 -22
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
|
-
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: '039b14d174dd7bfb3a5e00d5a315aee89f1efd46a570244191ab985bb44fc328'
|
4
|
+
data.tar.gz: 4eda58d10150903687b7940b858fa02c6f0a2cbca8858cd2ae9866c5be5a4b62
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 1d20f2794455635cbb3272bd4b6e8f91781e2c55aa40c7228d5347b4b6ad049cd3cc22ebc9ef708b8bbe4a05811774de07770b175035342123458a4637b9240f
|
7
|
+
data.tar.gz: 383aca1c7489eda135339e4538fa8a9dec80900c7c8bab786729a7c323d63f3a75657889ee6dad6bf91b769ced3eb507e41ef7daa15faa8bb3c5d0261c0c0394
|
data/.gitignore
CHANGED
data/.travis.yml
CHANGED
@@ -1,66 +1,52 @@
|
|
1
1
|
language: ruby
|
2
2
|
|
3
|
-
sudo: false
|
4
3
|
cache: bundler
|
5
4
|
|
5
|
+
before_install:
|
6
|
+
- "gem install bundler -v '<2'"
|
7
|
+
|
6
8
|
rvm:
|
7
|
-
-
|
8
|
-
- 2.
|
9
|
-
- 2.
|
10
|
-
- 2.
|
11
|
-
- 2.
|
12
|
-
- 2.
|
9
|
+
- 2.2.10
|
10
|
+
- 2.3.8
|
11
|
+
- 2.4.10
|
12
|
+
- 2.5.8
|
13
|
+
- 2.6.6
|
14
|
+
- 2.7.1
|
13
15
|
- ruby-head
|
14
|
-
- jruby-19mode
|
15
|
-
- rbx
|
16
16
|
|
17
17
|
gemfile:
|
18
|
-
- gemfiles/rails_3_0.gemfile
|
19
|
-
- gemfiles/rails_3_1.gemfile
|
20
|
-
- gemfiles/rails_3_2.gemfile
|
21
|
-
- gemfiles/rails_4_0.gemfile
|
22
|
-
- gemfiles/rails_4_1.gemfile
|
23
|
-
- gemfiles/rails_4_2.gemfile
|
24
18
|
- gemfiles/rails_5_0.gemfile
|
25
19
|
- gemfiles/rails_5_1.gemfile
|
20
|
+
- gemfiles/rails_5_2.gemfile
|
21
|
+
- gemfiles/rails_6_0.gemfile
|
22
|
+
- gemfiles/rails_head.gemfile
|
26
23
|
|
27
24
|
matrix:
|
28
|
-
allow_failures:
|
29
|
-
- rvm: jruby-19mode
|
30
|
-
- rvm: rbx
|
31
|
-
- rvm: ruby-head
|
32
|
-
fast_finish: true
|
33
25
|
exclude:
|
34
|
-
- rvm: 1
|
35
|
-
gemfile: gemfiles/rails_5_0.gemfile
|
36
|
-
- rvm: 1.9
|
37
|
-
gemfile: gemfiles/rails_5_1.gemfile
|
38
|
-
- rvm: 2.0
|
39
|
-
gemfile: gemfiles/rails_5_0.gemfile
|
40
|
-
- rvm: 2.0
|
41
|
-
gemfile: gemfiles/rails_5_1.gemfile
|
42
|
-
- rvm: 2.1
|
26
|
+
- rvm: 2.7.1
|
43
27
|
gemfile: gemfiles/rails_5_0.gemfile
|
44
|
-
- rvm: 2.1
|
28
|
+
- rvm: 2.7.1
|
45
29
|
gemfile: gemfiles/rails_5_1.gemfile
|
46
|
-
- rvm:
|
47
|
-
gemfile: gemfiles/
|
48
|
-
- rvm:
|
49
|
-
gemfile: gemfiles/
|
50
|
-
- rvm:
|
51
|
-
gemfile: gemfiles/
|
52
|
-
- rvm:
|
53
|
-
gemfile: gemfiles/
|
54
|
-
- rvm: 2.4.
|
55
|
-
gemfile: gemfiles/
|
56
|
-
- rvm: 2.
|
57
|
-
gemfile: gemfiles/
|
58
|
-
- rvm: 2.
|
59
|
-
gemfile: gemfiles/
|
60
|
-
- rvm: 2.4.
|
61
|
-
gemfile: gemfiles/
|
62
|
-
|
63
|
-
|
30
|
+
- rvm: 2.2.10
|
31
|
+
gemfile: gemfiles/rails_5_2.gemfile
|
32
|
+
- rvm: 2.7.1
|
33
|
+
gemfile: gemfiles/rails_5_2.gemfile
|
34
|
+
- rvm: 2.2.10
|
35
|
+
gemfile: gemfiles/rails_6_0.gemfile
|
36
|
+
- rvm: 2.3.8
|
37
|
+
gemfile: gemfiles/rails_6_0.gemfile
|
38
|
+
- rvm: 2.4.10
|
39
|
+
gemfile: gemfiles/rails_6_0.gemfile
|
40
|
+
- rvm: 2.2.10
|
41
|
+
gemfile: gemfiles/rails_head.gemfile
|
42
|
+
- rvm: 2.3.8
|
43
|
+
gemfile: gemfiles/rails_head.gemfile
|
44
|
+
- rvm: 2.4.10
|
45
|
+
gemfile: gemfiles/rails_head.gemfile
|
46
|
+
allow_failures:
|
47
|
+
- rvm: ruby-head
|
48
|
+
- gemfile: gemfiles/rails_head.gemfile
|
49
|
+
fast_finish: true
|
64
50
|
|
65
51
|
notifications:
|
66
52
|
email: false
|
data/Appraisals
CHANGED
@@ -1,17 +1,21 @@
|
|
1
|
-
appraise "rails-4-2" do
|
2
|
-
gem "railties", "~> 4.2.0"
|
3
|
-
gem "actionpack", "~> 4.2.0"
|
4
|
-
gem "activemodel", "~> 4.2.0"
|
5
|
-
end
|
6
|
-
|
7
1
|
appraise "rails-5-0" do
|
8
|
-
gem "
|
9
|
-
gem "actionpack", "~> 5.0.0"
|
10
|
-
gem "activemodel", "~> 5.0.0"
|
2
|
+
gem "rails", "~> 5.0.0"
|
11
3
|
end
|
12
4
|
|
13
5
|
appraise "rails-5-1" do
|
14
|
-
gem "
|
15
|
-
|
16
|
-
|
6
|
+
gem "rails", "~> 5.1.0"
|
7
|
+
end
|
8
|
+
|
9
|
+
appraise "rails-5-2" do
|
10
|
+
gem "rails", "~> 5.2.0"
|
11
|
+
end
|
12
|
+
|
13
|
+
if RUBY_VERSION >= "2.5.0"
|
14
|
+
appraise "rails-6-0" do
|
15
|
+
gem "rails", "~> 6.0.0"
|
16
|
+
end
|
17
|
+
|
18
|
+
appraise "rails-head" do
|
19
|
+
gem "rails", github: "rails/rails"
|
20
|
+
end
|
17
21
|
end
|
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,67 @@
|
|
1
1
|
# Changelog
|
2
2
|
|
3
|
+
2.11.2
|
4
|
+
------
|
5
|
+
|
6
|
+
* [Improve key formatting for nested hashes and disable by default](https://github.com/rails/jbuilder/pull/497)
|
7
|
+
|
8
|
+
2.11.1
|
9
|
+
------
|
10
|
+
|
11
|
+
* Use symbols instead of strings for before_action filters [DHH]
|
12
|
+
* Slim down comments in generated scaffold code [DHH]
|
13
|
+
|
14
|
+
2.11.0
|
15
|
+
------
|
16
|
+
|
17
|
+
* [Allow jbuilder instance to be passed to #merge!](https://github.com/rails/jbuilder/pull/485)
|
18
|
+
* [Fix for key_format! when using nested hashes](https://github.com/rails/jbuilder/pull/486)
|
19
|
+
* [Include rich_text, attachment, and attachments fields in json partial](https://github.com/rails/jbuilder/pull/459)
|
20
|
+
|
21
|
+
2.10.2
|
22
|
+
------
|
23
|
+
|
24
|
+
* Update scaffold generator to use double quotes, 422 form error responds, and modern string-of-arrays syntax [DHH]
|
25
|
+
|
26
|
+
2.10.1
|
27
|
+
------
|
28
|
+
|
29
|
+
* Fix keyword arguments warning on Ruby 2.7
|
30
|
+
|
31
|
+
2.10.0
|
32
|
+
------
|
33
|
+
|
34
|
+
* Requires Rails 5+ and Ruby 2.2+
|
35
|
+
* Nested hashes are deep-merged
|
36
|
+
|
37
|
+
2.9.1
|
38
|
+
-----
|
39
|
+
|
40
|
+
* [Respect JSON encoding customizations](https://github.com/rails/jbuilder/commit/e2e8623b08078ad6a2323ce8ecaf642b7afe1166)
|
41
|
+
|
42
|
+
2.9.0
|
43
|
+
-----
|
44
|
+
|
45
|
+
* [Fix passing object with partial without locals](https://github.com/rails/jbuilder/pull/435)
|
46
|
+
* [Fix deprecation warning in Rails 6.0](https://github.com/rails/jbuilder/pull/453)
|
47
|
+
* [Use quotes consistently in generated templates](https://github.com/rails/jbuilder/pull/455)
|
48
|
+
* [Allow omitting timestamps from generated partials](https://github.com/rails/jbuilder/pull/448)
|
49
|
+
* [Respect changing scaffold generator](https://github.com/rails/jbuilder/pull/458)
|
50
|
+
* [Use a symbolic default format for Rails 6.0 forward compatibility](https://github.com/rails/jbuilder/commit/3895a7243f3db292b0bf15513fc05494e6e50576)
|
51
|
+
* [Drop MultiJSON in favor of Ruby standard library JSON](https://github.com/rails/jbuilder/commit/b952ae096eb1828b0fcfde06e6ba62311494ec49)
|
52
|
+
|
53
|
+
2.8.0
|
54
|
+
-----
|
55
|
+
|
56
|
+
* [Replace deprecated fragment_cache_key for Rails 5.2 support](https://github.com/rails/jbuilder/pull/430)
|
57
|
+
|
58
|
+
2.7.0
|
59
|
+
-----
|
60
|
+
|
61
|
+
* [Requires Rails 4+](https://github.com/rails/jbuilder/commit/5207ff394533177fffdd768bfaa6413a0cd16dc8)
|
62
|
+
* [Fix implicitly rendering a JSON partial with the same name as an
|
63
|
+
HTML partial](https://github.com/rails/jbuilder/pull/400)
|
64
|
+
|
3
65
|
2.6.4
|
4
66
|
-----
|
5
67
|
|
data/CONTRIBUTING.md
CHANGED
@@ -4,18 +4,16 @@ Contributing to Jbuilder
|
|
4
4
|
[![Build Status](https://api.travis-ci.org/rails/jbuilder.svg?branch=master)][travis]
|
5
5
|
[![Gem Version](https://badge.fury.io/rb/jbuilder.svg)][gem]
|
6
6
|
[![Code Climate](https://codeclimate.com/github/rails/jbuilder/badges/gpa.svg)][codeclimate]
|
7
|
-
[![Dependencies Status](https://gemnasium.com/rails/jbuilder.svg)][gemnasium]
|
8
7
|
|
9
8
|
[travis]: https://travis-ci.org/rails/jbuilder
|
10
9
|
[gem]: https://rubygems.org/gems/jbuilder
|
11
10
|
[codeclimate]: https://codeclimate.com/github/rails/jbuilder
|
12
|
-
[gemnasium]: https://gemnasium.com/rails/jbuilder
|
13
11
|
|
14
12
|
Jbuilder is work of [many contributors](https://github.com/rails/jbuilder/graphs/contributors). You're encouraged to submit [pull requests](https://github.com/rails/jbuilder/pulls), [propose features and discuss issues](https://github.com/rails/jbuilder/issues).
|
15
13
|
|
16
14
|
#### Fork the Project
|
17
15
|
|
18
|
-
Fork the [project on
|
16
|
+
Fork the [project on GitHub](https://github.com/rails/jbuilder) and check out your copy.
|
19
17
|
|
20
18
|
```
|
21
19
|
git clone https://github.com/contributor/jbuilder.git
|
data/Gemfile
CHANGED
data/MIT-LICENSE
CHANGED
data/README.md
CHANGED
@@ -67,6 +67,19 @@ end
|
|
67
67
|
# => {"author": { "name": "David" }}
|
68
68
|
```
|
69
69
|
|
70
|
+
|
71
|
+
To merge existing hash or array to current context:
|
72
|
+
|
73
|
+
``` ruby
|
74
|
+
hash = { author: { name: "David" } }
|
75
|
+
json.post do
|
76
|
+
json.title "Merge HOWTO"
|
77
|
+
json.merge! hash
|
78
|
+
end
|
79
|
+
|
80
|
+
# => "post": { "title": "Merge HOWTO", "author": { "name": "David" } }
|
81
|
+
```
|
82
|
+
|
70
83
|
Top level arrays can be handled directly. Useful for index and other collection actions.
|
71
84
|
|
72
85
|
``` ruby
|
@@ -143,7 +156,6 @@ if current_user.admin?
|
|
143
156
|
end
|
144
157
|
```
|
145
158
|
|
146
|
-
|
147
159
|
You can use partials as well. The following will render the file
|
148
160
|
`views/comments/_comments.json.jbuilder`, and set a local variable
|
149
161
|
`comments` with all this message's comments, which you can use inside
|
@@ -171,6 +183,25 @@ json.partial! partial: 'posts/post', collection: @posts, as: :post
|
|
171
183
|
json.comments @post.comments, partial: 'comments/comment', as: :comment
|
172
184
|
```
|
173
185
|
|
186
|
+
The `as: :some_symbol` is used with partials. It will take care of mapping the passed in object to a variable for the partial. If the value is a collection (either implicitly or explicitly by using the `collection:` option, then each value of the collection is passed to the partial as the variable `some_symbol`. If the value is a singular object, then the object is passed to the partial as the variable `some_symbol`.
|
187
|
+
|
188
|
+
Be sure not to confuse the `as:` option to mean nesting of the partial. For example:
|
189
|
+
|
190
|
+
```ruby
|
191
|
+
# Use the default `views/comments/_comment.json.jbuilder`, putting @comment as the comment local variable.
|
192
|
+
# Note, `comment` attributes are "inlined".
|
193
|
+
json.partial! @comment, as: :comment
|
194
|
+
```
|
195
|
+
|
196
|
+
is quite different than:
|
197
|
+
|
198
|
+
```ruby
|
199
|
+
# comment attributes are nested under a "comment" property
|
200
|
+
json.comment do
|
201
|
+
json.partial! "/comments/comment.json.jbuilder", comment: @comment
|
202
|
+
end
|
203
|
+
```
|
204
|
+
|
174
205
|
You can pass any objects into partial templates with or without `:locals` option.
|
175
206
|
|
176
207
|
```ruby
|
@@ -243,20 +274,24 @@ environment.rb for example):
|
|
243
274
|
Jbuilder.key_format camelize: :lower
|
244
275
|
```
|
245
276
|
|
246
|
-
|
247
|
-
|
277
|
+
By default, key format is not applied to keys of hashes that are
|
278
|
+
passed to methods like `set!`, `array!` or `merge!`. You can opt into
|
279
|
+
deeply transforming these as well:
|
280
|
+
|
281
|
+
``` ruby
|
282
|
+
json.key_format! camelize: :lower
|
283
|
+
json.deep_format_keys!
|
284
|
+
json.settings([{some_value: "abc"}])
|
285
|
+
|
286
|
+
# => { "settings": [{ "someValue": "abc" }]}
|
287
|
+
```
|
248
288
|
|
249
|
-
|
250
|
-
|
251
|
-
which is slow (fixed in Rails >= 4.1). For faster Jbuilder rendering, you can
|
252
|
-
specify something like the Yajl JSON generator instead. You'll need to include
|
253
|
-
the `yajl-ruby` gem in your Gemfile and then set the following configuration
|
254
|
-
for MultiJson:
|
289
|
+
You can set this globally with the class method `deep_format_keys` (from inside your
|
290
|
+
environment.rb for example):
|
255
291
|
|
256
292
|
``` ruby
|
257
|
-
|
258
|
-
|
259
|
-
```
|
293
|
+
Jbuilder.deep_format_keys true
|
294
|
+
```
|
260
295
|
|
261
296
|
## Contributing to Jbuilder
|
262
297
|
|
data/gemfiles/rails_5_0.gemfile
CHANGED
data/gemfiles/rails_5_1.gemfile
CHANGED
@@ -5,9 +5,6 @@ source "https://rubygems.org"
|
|
5
5
|
gem "rake"
|
6
6
|
gem "mocha", require: false
|
7
7
|
gem "appraisal"
|
8
|
-
gem "
|
9
|
-
gem "railties", ">= 5.1.0", "< 5.2"
|
10
|
-
gem "actionpack", ">= 5.1.0", "< 5.2"
|
11
|
-
gem "activemodel", ">= 5.1.0", "< 5.2"
|
8
|
+
gem "rails", "~> 5.1.0"
|
12
9
|
|
13
10
|
gemspec path: "../"
|
data/jbuilder.gemspec
CHANGED
@@ -1,16 +1,21 @@
|
|
1
1
|
Gem::Specification.new do |s|
|
2
2
|
s.name = 'jbuilder'
|
3
|
-
s.version = '2.
|
3
|
+
s.version = '2.11.2'
|
4
4
|
s.authors = 'David Heinemeier Hansson'
|
5
5
|
s.email = 'david@basecamp.com'
|
6
6
|
s.summary = 'Create JSON structures via a Builder-style DSL'
|
7
7
|
s.homepage = 'https://github.com/rails/jbuilder'
|
8
8
|
s.license = 'MIT'
|
9
9
|
|
10
|
-
s.required_ruby_version = '>=
|
10
|
+
s.required_ruby_version = '>= 2.2.2'
|
11
11
|
|
12
|
-
s.add_dependency 'activesupport', '>=
|
13
|
-
|
12
|
+
s.add_dependency 'activesupport', '>= 5.0.0'
|
13
|
+
|
14
|
+
if RUBY_ENGINE == 'rbx'
|
15
|
+
s.add_development_dependency('racc')
|
16
|
+
s.add_development_dependency('json')
|
17
|
+
s.add_development_dependency('rubysl')
|
18
|
+
end
|
14
19
|
|
15
20
|
s.files = `git ls-files`.split("\n")
|
16
21
|
s.test_files = `git ls-files -- test/*`.split("\n")
|
@@ -10,6 +10,8 @@ module Rails
|
|
10
10
|
|
11
11
|
argument :attributes, type: :array, default: [], banner: 'field:type field:type'
|
12
12
|
|
13
|
+
class_option :timestamps, type: :boolean, default: true
|
14
|
+
|
13
15
|
def create_root_folder
|
14
16
|
path = File.join('app/views', controller_file_path)
|
15
17
|
empty_directory path unless File.directory?(path)
|
@@ -33,8 +35,12 @@ module Rails
|
|
33
35
|
[name, :json, :jbuilder] * '.'
|
34
36
|
end
|
35
37
|
|
36
|
-
def
|
37
|
-
|
38
|
+
def full_attributes_list
|
39
|
+
if options[:timestamps]
|
40
|
+
attributes_list(attributes_names + %w(created_at updated_at))
|
41
|
+
else
|
42
|
+
attributes_list(attributes_names)
|
43
|
+
end
|
38
44
|
end
|
39
45
|
|
40
46
|
def attributes_list(attributes = attributes_names)
|
@@ -44,6 +50,10 @@ module Rails
|
|
44
50
|
|
45
51
|
attributes.map { |a| ":#{a}"} * ', '
|
46
52
|
end
|
53
|
+
|
54
|
+
def virtual_attributes
|
55
|
+
attributes.select {|name| name.respond_to?(:virtual?) && name.virtual? }
|
56
|
+
end
|
47
57
|
end
|
48
58
|
end
|
49
59
|
end
|