jbuilder 2.9.1 → 2.11.5

Sign up to get free protection for your applications and to get access to all the features.
@@ -99,7 +99,7 @@ class JbuilderTest < ActiveSupport::TestCase
99
99
  assert_equal 32, result['age']
100
100
  end
101
101
 
102
- test 'extracting from object using call style for 1.9' do
102
+ test 'extracting from object using call style' do
103
103
  person = Struct.new(:name, :age).new('David', 32)
104
104
 
105
105
  result = jbuild do |json|
@@ -159,6 +159,25 @@ class JbuilderTest < ActiveSupport::TestCase
159
159
  assert_equal 32, result['author']['age']
160
160
  end
161
161
 
162
+ test 'nested blocks are additive' do
163
+ result = jbuild do |json|
164
+ json.author do
165
+ json.name do
166
+ json.first 'David'
167
+ end
168
+ end
169
+
170
+ json.author do
171
+ json.name do
172
+ json.last 'Heinemeier Hansson'
173
+ end
174
+ end
175
+ end
176
+
177
+ assert_equal 'David', result['author']['name']['first']
178
+ assert_equal 'Heinemeier Hansson', result['author']['name']['last']
179
+ end
180
+
162
181
  test 'support merge! method' do
163
182
  result = jbuild do |json|
164
183
  json.merge! 'foo' => 'bar'
@@ -177,6 +196,18 @@ class JbuilderTest < ActiveSupport::TestCase
177
196
  assert_equal 'Pavel', result['author']['name']
178
197
  end
179
198
 
199
+ test 'support merge! method with Jbuilder instance' do
200
+ obj = jbuild do |json|
201
+ json.foo 'bar'
202
+ end
203
+
204
+ result = jbuild do |json|
205
+ json.merge! obj
206
+ end
207
+
208
+ assert_equal 'bar', result['foo']
209
+ end
210
+
180
211
  test 'blocks are additive via extract syntax' do
181
212
  person = Person.new('Pavel', 27)
182
213
 
@@ -281,7 +312,7 @@ class JbuilderTest < ActiveSupport::TestCase
281
312
  assert_equal 'world', result['comments'].second['content']
282
313
  end
283
314
 
284
- test 'nesting multiple chilren from a non-Enumerable that responds to #map with inline loop' do
315
+ test 'nesting multiple children from a non-Enumerable that responds to #map with inline loop' do
285
316
  comments = NonEnumerable.new([ Comment.new('hello', 1), Comment.new('world', 2) ])
286
317
 
287
318
  result = jbuild do |json|
@@ -535,6 +566,36 @@ class JbuilderTest < ActiveSupport::TestCase
535
566
  assert_equal 'one', result['level1']
536
567
  end
537
568
 
569
+ test 'key_format! can be changed in child elements' do
570
+ result = jbuild do |json|
571
+ json.key_format! camelize: :lower
572
+
573
+ json.level_one do
574
+ json.key_format! :upcase
575
+ json.value 'two'
576
+ end
577
+ end
578
+
579
+ assert_equal ['levelOne'], result.keys
580
+ assert_equal ['VALUE'], result['levelOne'].keys
581
+ end
582
+
583
+ test 'key_format! can be changed in array!' do
584
+ result = jbuild do |json|
585
+ json.key_format! camelize: :lower
586
+
587
+ json.level_one do
588
+ json.array! [{value: 'two'}] do |object|
589
+ json.key_format! :upcase
590
+ json.value object[:value]
591
+ end
592
+ end
593
+ end
594
+
595
+ assert_equal ['levelOne'], result.keys
596
+ assert_equal ['VALUE'], result['levelOne'][0].keys
597
+ end
598
+
538
599
  test 'key_format! with no parameter' do
539
600
  result = jbuild do |json|
540
601
  json.key_format! :upcase
@@ -562,6 +623,161 @@ class JbuilderTest < ActiveSupport::TestCase
562
623
  assert_equal ['oats and friends'], result.keys
563
624
  end
564
625
 
626
+ test 'key_format! is not applied deeply by default' do
627
+ names = { first_name: 'camel', last_name: 'case' }
628
+ result = jbuild do |json|
629
+ json.key_format! camelize: :lower
630
+ json.set! :all_names, names
631
+ end
632
+
633
+ assert_equal %i[first_name last_name], result['allNames'].keys
634
+ end
635
+
636
+ test 'applying key_format! deeply can be enabled per scope' do
637
+ names = { first_name: 'camel', last_name: 'case' }
638
+ result = jbuild do |json|
639
+ json.key_format! camelize: :lower
640
+ json.scope do
641
+ json.deep_format_keys!
642
+ json.set! :all_names, names
643
+ end
644
+ json.set! :all_names, names
645
+ end
646
+
647
+ assert_equal %w[firstName lastName], result['scope']['allNames'].keys
648
+ assert_equal %i[first_name last_name], result['allNames'].keys
649
+ end
650
+
651
+ test 'applying key_format! deeply can be disabled per scope' do
652
+ names = { first_name: 'camel', last_name: 'case' }
653
+ result = jbuild do |json|
654
+ json.key_format! camelize: :lower
655
+ json.deep_format_keys!
656
+ json.set! :all_names, names
657
+ json.scope do
658
+ json.deep_format_keys! false
659
+ json.set! :all_names, names
660
+ end
661
+ end
662
+
663
+ assert_equal %w[firstName lastName], result['allNames'].keys
664
+ assert_equal %i[first_name last_name], result['scope']['allNames'].keys
665
+ end
666
+
667
+ test 'applying key_format! deeply can be enabled globally' do
668
+ names = { first_name: 'camel', last_name: 'case' }
669
+
670
+ Jbuilder.deep_format_keys true
671
+ result = jbuild do |json|
672
+ json.key_format! camelize: :lower
673
+ json.set! :all_names, names
674
+ end
675
+
676
+ assert_equal %w[firstName lastName], result['allNames'].keys
677
+ Jbuilder.send(:class_variable_set, '@@deep_format_keys', false)
678
+ end
679
+
680
+ test 'deep key_format! with merge!' do
681
+ hash = { camel_style: 'for JS' }
682
+ result = jbuild do |json|
683
+ json.key_format! camelize: :lower
684
+ json.deep_format_keys!
685
+ json.merge! hash
686
+ end
687
+
688
+ assert_equal ['camelStyle'], result.keys
689
+ end
690
+
691
+ test 'deep key_format! with merge! deep' do
692
+ hash = { camel_style: { sub_attr: 'for JS' } }
693
+ result = jbuild do |json|
694
+ json.key_format! camelize: :lower
695
+ json.deep_format_keys!
696
+ json.merge! hash
697
+ end
698
+
699
+ assert_equal ['subAttr'], result['camelStyle'].keys
700
+ end
701
+
702
+ test 'deep key_format! with set! array of hashes' do
703
+ names = [{ first_name: 'camel', last_name: 'case' }]
704
+ result = jbuild do |json|
705
+ json.key_format! camelize: :lower
706
+ json.deep_format_keys!
707
+ json.set! :names, names
708
+ end
709
+
710
+ assert_equal %w[firstName lastName], result['names'][0].keys
711
+ end
712
+
713
+ test 'deep key_format! with set! extracting hash from object' do
714
+ comment = Struct.new(:author).new({ first_name: 'camel', last_name: 'case' })
715
+ result = jbuild do |json|
716
+ json.key_format! camelize: :lower
717
+ json.deep_format_keys!
718
+ json.set! :comment, comment, :author
719
+ end
720
+
721
+ assert_equal %w[firstName lastName], result['comment']['author'].keys
722
+ end
723
+
724
+ test 'deep key_format! with array! of hashes' do
725
+ names = [{ first_name: 'camel', last_name: 'case' }]
726
+ result = jbuild do |json|
727
+ json.key_format! camelize: :lower
728
+ json.deep_format_keys!
729
+ json.array! names
730
+ end
731
+
732
+ assert_equal %w[firstName lastName], result[0].keys
733
+ end
734
+
735
+ test 'deep key_format! with merge! array of hashes' do
736
+ names = [{ first_name: 'camel', last_name: 'case' }]
737
+ new_names = [{ first_name: 'snake', last_name: 'case' }]
738
+ result = jbuild do |json|
739
+ json.key_format! camelize: :lower
740
+ json.deep_format_keys!
741
+ json.array! names
742
+ json.merge! new_names
743
+ end
744
+
745
+ assert_equal %w[firstName lastName], result[1].keys
746
+ end
747
+
748
+ test 'deep key_format! is applied to hash extracted from object' do
749
+ comment = Struct.new(:author).new({ first_name: 'camel', last_name: 'case' })
750
+ result = jbuild do |json|
751
+ json.key_format! camelize: :lower
752
+ json.deep_format_keys!
753
+ json.extract! comment, :author
754
+ end
755
+
756
+ assert_equal %w[firstName lastName], result['author'].keys
757
+ end
758
+
759
+ test 'deep key_format! is applied to hash extracted from hash' do
760
+ comment = {author: { first_name: 'camel', last_name: 'case' }}
761
+ result = jbuild do |json|
762
+ json.key_format! camelize: :lower
763
+ json.deep_format_keys!
764
+ json.extract! comment, :author
765
+ end
766
+
767
+ assert_equal %w[firstName lastName], result['author'].keys
768
+ end
769
+
770
+ test 'deep key_format! is applied to hash extracted directly from array' do
771
+ comments = [Struct.new(:author).new({ first_name: 'camel', last_name: 'case' })]
772
+ result = jbuild do |json|
773
+ json.key_format! camelize: :lower
774
+ json.deep_format_keys!
775
+ json.array! comments, :author
776
+ end
777
+
778
+ assert_equal %w[firstName lastName], result[0]['author'].keys
779
+ end
780
+
565
781
  test 'default key_format!' do
566
782
  Jbuilder.key_format camelize: :lower
567
783
  result = jbuild{ |json| json.camel_style 'for JS' }
@@ -47,7 +47,7 @@ if Rails::VERSION::MAJOR > 4
47
47
  end
48
48
  end
49
49
 
50
- test 'dont use require and permit if there are no attributes' do
50
+ test "don't use require and permit if there are no attributes" do
51
51
  run_generator %w(Post --api)
52
52
 
53
53
  assert_file 'app/controllers/posts_controller.rb' do |content|
@@ -55,5 +55,16 @@ if Rails::VERSION::MAJOR > 4
55
55
  assert_match %r{params\.fetch\(:post, \{\}\)}, content
56
56
  end
57
57
  end
58
+
59
+
60
+ if Rails::VERSION::MAJOR >= 6
61
+ test 'handles virtual attributes' do
62
+ run_generator ["Message", "content:rich_text", "video:attachment", "photos:attachments"]
63
+
64
+ assert_file 'app/controllers/messages_controller.rb' do |content|
65
+ assert_match %r{params\.require\(:message\)\.permit\(:content, :video, photos: \[\]\)}, content
66
+ end
67
+ end
68
+ end
58
69
  end
59
70
  end
@@ -31,22 +31,22 @@ class ScaffoldControllerGeneratorTest < Rails::Generators::TestCase
31
31
  assert_instance_method :create, content do |m|
32
32
  assert_match %r{@post = Post\.new\(post_params\)}, m
33
33
  assert_match %r{@post\.save}, m
34
- assert_match %r{format\.html \{ redirect_to @post, notice: 'Post was successfully created\.' \}}, m
34
+ assert_match %r{format\.html \{ redirect_to post_url\(@post\), notice: "Post was successfully created\." \}}, m
35
35
  assert_match %r{format\.json \{ render :show, status: :created, location: @post \}}, m
36
- assert_match %r{format\.html \{ render :new \}}, m
36
+ assert_match %r{format\.html \{ render :new, status: :unprocessable_entity \}}, m
37
37
  assert_match %r{format\.json \{ render json: @post\.errors, status: :unprocessable_entity \}}, m
38
38
  end
39
39
 
40
40
  assert_instance_method :update, content do |m|
41
- assert_match %r{format\.html \{ redirect_to @post, notice: 'Post was successfully updated\.' \}}, m
41
+ assert_match %r{format\.html \{ redirect_to post_url\(@post\), notice: "Post was successfully updated\." \}}, m
42
42
  assert_match %r{format\.json \{ render :show, status: :ok, location: @post \}}, m
43
- assert_match %r{format\.html \{ render :edit \}}, m
43
+ assert_match %r{format\.html \{ render :edit, status: :unprocessable_entity \}}, m
44
44
  assert_match %r{format\.json \{ render json: @post.errors, status: :unprocessable_entity \}}, m
45
45
  end
46
46
 
47
47
  assert_instance_method :destroy, content do |m|
48
48
  assert_match %r{@post\.destroy}, m
49
- assert_match %r{format\.html \{ redirect_to posts_url, notice: 'Post was successfully destroyed\.' \}}, m
49
+ assert_match %r{format\.html \{ redirect_to posts_url, notice: "Post was successfully destroyed\." \}}, m
50
50
  assert_match %r{format\.json \{ head :no_content \}}, m
51
51
  end
52
52
 
@@ -59,7 +59,26 @@ class ScaffoldControllerGeneratorTest < Rails::Generators::TestCase
59
59
  end
60
60
  end
61
61
 
62
- test 'dont use require and permit if there are no attributes' do
62
+ if Rails::VERSION::MAJOR >= 6
63
+ test 'controller with namespace' do
64
+ run_generator %w(Admin::Post --model-name=Post)
65
+ assert_file 'app/controllers/admin/posts_controller.rb' do |content|
66
+ assert_instance_method :create, content do |m|
67
+ assert_match %r{format\.html \{ redirect_to admin_post_url\(@post\), notice: "Post was successfully created\." \}}, m
68
+ end
69
+
70
+ assert_instance_method :update, content do |m|
71
+ assert_match %r{format\.html \{ redirect_to admin_post_url\(@post\), notice: "Post was successfully updated\." \}}, m
72
+ end
73
+
74
+ assert_instance_method :destroy, content do |m|
75
+ assert_match %r{format\.html \{ redirect_to admin_posts_url, notice: "Post was successfully destroyed\." \}}, m
76
+ end
77
+ end
78
+ end
79
+ end
80
+
81
+ test "don't use require and permit if there are no attributes" do
63
82
  run_generator %w(Post)
64
83
 
65
84
  assert_file 'app/controllers/posts_controller.rb' do |content|
@@ -67,4 +86,14 @@ class ScaffoldControllerGeneratorTest < Rails::Generators::TestCase
67
86
  assert_match %r{params\.fetch\(:post, \{\}\)}, content
68
87
  end
69
88
  end
89
+
90
+ if Rails::VERSION::MAJOR >= 6
91
+ test 'handles virtual attributes' do
92
+ run_generator %w(Message content:rich_text video:attachment photos:attachments)
93
+
94
+ assert_file 'app/controllers/messages_controller.rb' do |content|
95
+ assert_match %r{params\.require\(:message\)\.permit\(:content, :video, photos: \[\]\)}, content
96
+ end
97
+ end
98
+ end
70
99
  end
data/test/test_helper.rb CHANGED
@@ -1,17 +1,16 @@
1
1
  require "bundler/setup"
2
2
 
3
- require "active_support"
3
+ require "rails"
4
+
5
+ require "jbuilder"
6
+
4
7
  require "active_support/core_ext/array/access"
5
8
  require "active_support/cache/memory_store"
6
9
  require "active_support/json"
7
10
  require "active_model"
8
- require "action_view"
9
- require "rails/version"
10
-
11
- require "jbuilder"
12
11
 
13
12
  require "active_support/testing/autorun"
14
- require "mocha/setup"
13
+ require "mocha/minitest"
15
14
 
16
15
  ActiveSupport.test_order = :random
17
16
 
@@ -21,7 +20,13 @@ class << Rails
21
20
  end
22
21
  end
23
22
 
24
- class Post < Struct.new(:id, :body, :author_name); end
23
+ Jbuilder::CollectionRenderer.collection_cache = Rails.cache
24
+
25
+ class Post < Struct.new(:id, :body, :author_name)
26
+ def cache_key
27
+ "post-#{id}"
28
+ end
29
+ end
25
30
 
26
31
  class Racer < Struct.new(:id, :name)
27
32
  extend ActiveModel::Naming
@@ -29,6 +34,3 @@ class Racer < Struct.new(:id, :name)
29
34
  end
30
35
 
31
36
  ActionView::Template.register_template_handler :jbuilder, JbuilderHandler
32
-
33
- ActionView::Base.remove_possible_method :fragment_name_with_digest
34
- ActionView::Base.remove_possible_method :cache_fragment_name
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: jbuilder
3
3
  version: !ruby/object:Gem::Version
4
- version: 2.9.1
4
+ version: 2.11.5
5
5
  platform: ruby
6
6
  authors:
7
7
  - David Heinemeier Hansson
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2019-05-14 00:00:00.000000000 Z
11
+ date: 2021-12-21 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: activesupport
@@ -16,34 +16,47 @@ dependencies:
16
16
  requirements:
17
17
  - - ">="
18
18
  - !ruby/object:Gem::Version
19
- version: 4.2.0
19
+ version: 5.0.0
20
20
  type: :runtime
21
21
  prerelease: false
22
22
  version_requirements: !ruby/object:Gem::Requirement
23
23
  requirements:
24
24
  - - ">="
25
25
  - !ruby/object:Gem::Version
26
- version: 4.2.0
26
+ version: 5.0.0
27
+ - !ruby/object:Gem::Dependency
28
+ name: actionview
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - ">="
32
+ - !ruby/object:Gem::Version
33
+ version: 5.0.0
34
+ type: :runtime
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - ">="
39
+ - !ruby/object:Gem::Version
40
+ version: 5.0.0
27
41
  description:
28
42
  email: david@basecamp.com
29
43
  executables: []
30
44
  extensions: []
31
45
  extra_rdoc_files: []
32
46
  files:
47
+ - ".github/workflows/ruby.yml"
33
48
  - ".gitignore"
34
- - ".travis.yml"
35
49
  - Appraisals
36
- - CHANGELOG.md
37
50
  - CONTRIBUTING.md
38
51
  - Gemfile
39
52
  - MIT-LICENSE
40
53
  - README.md
41
54
  - Rakefile
42
- - gemfiles/rails_4_2.gemfile
43
55
  - gemfiles/rails_5_0.gemfile
44
56
  - gemfiles/rails_5_1.gemfile
45
57
  - gemfiles/rails_5_2.gemfile
46
58
  - gemfiles/rails_6_0.gemfile
59
+ - gemfiles/rails_6_1.gemfile
47
60
  - gemfiles/rails_head.gemfile
48
61
  - jbuilder.gemspec
49
62
  - lib/generators/rails/jbuilder_generator.rb
@@ -55,6 +68,7 @@ files:
55
68
  - lib/generators/rails/templates/show.json.jbuilder
56
69
  - lib/jbuilder.rb
57
70
  - lib/jbuilder/blank.rb
71
+ - lib/jbuilder/collection_renderer.rb
58
72
  - lib/jbuilder/dependency_tracker.rb
59
73
  - lib/jbuilder/errors.rb
60
74
  - lib/jbuilder/jbuilder.rb
@@ -71,7 +85,12 @@ files:
71
85
  homepage: https://github.com/rails/jbuilder
72
86
  licenses:
73
87
  - MIT
74
- metadata: {}
88
+ metadata:
89
+ bug_tracker_uri: https://github.com/rails/jbuilder/issues
90
+ changelog_uri: https://github.com/rails/jbuilder/releases/tag/v2.11.5
91
+ mailing_list_uri: https://discuss.rubyonrails.org/c/rubyonrails-talk
92
+ source_code_uri: https://github.com/rails/jbuilder/tree/v2.11.5
93
+ rubygems_mfa_required: 'true'
75
94
  post_install_message:
76
95
  rdoc_options: []
77
96
  require_paths:
@@ -80,14 +99,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
80
99
  requirements:
81
100
  - - ">="
82
101
  - !ruby/object:Gem::Version
83
- version: 1.9.3
102
+ version: 2.2.2
84
103
  required_rubygems_version: !ruby/object:Gem::Requirement
85
104
  requirements:
86
105
  - - ">="
87
106
  - !ruby/object:Gem::Version
88
107
  version: '0'
89
108
  requirements: []
90
- rubygems_version: 3.0.3
109
+ rubygems_version: 3.2.32
91
110
  signing_key:
92
111
  specification_version: 4
93
112
  summary: Create JSON structures via a Builder-style DSL
data/.travis.yml DELETED
@@ -1,67 +0,0 @@
1
- language: ruby
2
-
3
- cache: bundler
4
-
5
- before_install:
6
- - "gem update --system 2.7.9"
7
- - "gem install bundler -v '<2'"
8
-
9
- rvm:
10
- - 2.2.10
11
- - 2.3.8
12
- - 2.4.6
13
- - 2.5.5
14
- - 2.6.2
15
- - ruby-head
16
- - rbx-3.107
17
-
18
- gemfile:
19
- - gemfiles/rails_4_2.gemfile
20
- - gemfiles/rails_5_0.gemfile
21
- - gemfiles/rails_5_1.gemfile
22
- - gemfiles/rails_5_2.gemfile
23
- - gemfiles/rails_6_0.gemfile
24
- - gemfiles/rails_head.gemfile
25
-
26
- matrix:
27
- include:
28
- - rvm: 1.9
29
- gemfile: gemfiles/rails_4_2.gemfile
30
- - rvm: 2.0
31
- gemfile: gemfiles/rails_4_2.gemfile
32
- - rvm: 2.1
33
- gemfile: gemfiles/rails_4_2.gemfile
34
- - rvm: 2.3
35
- gemfile: gemfiles/rails_4_2.gemfile
36
- - rvm: jruby-19mode
37
- gemfile: gemfiles/rails_4_2.gemfile
38
- - rvm: rbx-3.107
39
- gemfile: gemfiles/rails_4_2.gemfile
40
- exclude:
41
- - rvm: 2.4.6
42
- gemfile: gemfiles/rails_4_2.gemfile
43
- - rvm: 2.5.5
44
- gemfile: gemfiles/rails_4_2.gemfile
45
- - rvm: 2.6.2
46
- gemfile: gemfiles/rails_4_2.gemfile
47
- - rvm: 2.2.10
48
- gemfile: gemfiles/rails_6_0.gemfile
49
- - rvm: 2.3.8
50
- gemfile: gemfiles/rails_6_0.gemfile
51
- - rvm: 2.4.6
52
- gemfile: gemfiles/rails_6_0.gemfile
53
- - rvm: 2.2.10
54
- gemfile: gemfiles/rails_head.gemfile
55
- - rvm: 2.3.8
56
- gemfile: gemfiles/rails_head.gemfile
57
- - rvm: 2.4.6
58
- gemfile: gemfiles/rails_head.gemfile
59
- allow_failures:
60
- - rvm: jruby-19mode
61
- - rvm: rbx-3.107
62
- - rvm: ruby-head
63
- - gemfile: gemfiles/rails_head.gemfile
64
- fast_finish: true
65
-
66
- notifications:
67
- email: false