bullet 6.0.2 → 7.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (63) hide show
  1. checksums.yaml +4 -4
  2. data/.github/workflows/main.yml +82 -0
  3. data/CHANGELOG.md +52 -0
  4. data/Gemfile.rails-6.0 +1 -1
  5. data/Gemfile.rails-6.1 +15 -0
  6. data/Gemfile.rails-7.0 +10 -0
  7. data/README.md +39 -25
  8. data/lib/bullet/active_job.rb +1 -3
  9. data/lib/bullet/active_record4.rb +9 -23
  10. data/lib/bullet/active_record41.rb +8 -19
  11. data/lib/bullet/active_record42.rb +9 -16
  12. data/lib/bullet/active_record5.rb +188 -170
  13. data/lib/bullet/active_record52.rb +182 -162
  14. data/lib/bullet/active_record60.rb +191 -178
  15. data/lib/bullet/active_record61.rb +272 -0
  16. data/lib/bullet/active_record70.rb +275 -0
  17. data/lib/bullet/bullet_xhr.js +18 -23
  18. data/lib/bullet/dependency.rb +52 -34
  19. data/lib/bullet/detector/association.rb +24 -18
  20. data/lib/bullet/detector/counter_cache.rb +12 -8
  21. data/lib/bullet/detector/n_plus_one_query.rb +20 -10
  22. data/lib/bullet/detector/unused_eager_loading.rb +7 -4
  23. data/lib/bullet/mongoid4x.rb +3 -7
  24. data/lib/bullet/mongoid5x.rb +3 -7
  25. data/lib/bullet/mongoid6x.rb +3 -7
  26. data/lib/bullet/mongoid7x.rb +26 -13
  27. data/lib/bullet/notification/base.rb +14 -18
  28. data/lib/bullet/notification/n_plus_one_query.rb +2 -4
  29. data/lib/bullet/notification/unused_eager_loading.rb +2 -4
  30. data/lib/bullet/notification.rb +2 -1
  31. data/lib/bullet/rack.rb +28 -17
  32. data/lib/bullet/stack_trace_filter.rb +10 -17
  33. data/lib/bullet/version.rb +1 -1
  34. data/lib/bullet.rb +52 -42
  35. data/lib/generators/bullet/install_generator.rb +22 -23
  36. data/perf/benchmark.rb +11 -14
  37. data/spec/bullet/detector/counter_cache_spec.rb +6 -6
  38. data/spec/bullet/detector/n_plus_one_query_spec.rb +8 -4
  39. data/spec/bullet/detector/unused_eager_loading_spec.rb +25 -8
  40. data/spec/bullet/ext/object_spec.rb +1 -1
  41. data/spec/bullet/notification/base_spec.rb +5 -7
  42. data/spec/bullet/notification/n_plus_one_query_spec.rb +16 -3
  43. data/spec/bullet/notification/unused_eager_loading_spec.rb +5 -1
  44. data/spec/bullet/rack_spec.rb +154 -13
  45. data/spec/bullet/registry/association_spec.rb +2 -2
  46. data/spec/bullet/registry/base_spec.rb +1 -1
  47. data/spec/bullet_spec.rb +25 -44
  48. data/spec/integration/active_record/association_spec.rb +104 -130
  49. data/spec/integration/counter_cache_spec.rb +14 -34
  50. data/spec/integration/mongoid/association_spec.rb +19 -33
  51. data/spec/models/attachment.rb +5 -0
  52. data/spec/models/deal.rb +5 -0
  53. data/spec/models/post.rb +2 -0
  54. data/spec/models/role.rb +7 -0
  55. data/spec/models/submission.rb +1 -0
  56. data/spec/models/user.rb +2 -0
  57. data/spec/spec_helper.rb +4 -10
  58. data/spec/support/bullet_ext.rb +8 -9
  59. data/spec/support/mongo_seed.rb +3 -16
  60. data/spec/support/sqlite_seed.rb +38 -0
  61. data/test.sh +2 -0
  62. metadata +17 -7
  63. data/.travis.yml +0 -31
@@ -13,233 +13,251 @@ module Bullet
13
13
  module ActiveRecord
14
14
  def self.enable
15
15
  require 'active_record'
16
- ::ActiveRecord::Base.extend(Module.new do
17
- def find_by_sql(sql, binds = [], preparable: nil, &block)
18
- result = super
19
- if Bullet.start?
20
- if result.is_a? Array
21
- if result.size > 1
22
- Bullet::Detector::NPlusOneQuery.add_possible_objects(result)
23
- Bullet::Detector::CounterCache.add_possible_objects(result)
24
- elsif result.size == 1
25
- Bullet::Detector::NPlusOneQuery.add_impossible_object(result.first)
26
- Bullet::Detector::CounterCache.add_impossible_object(result.first)
16
+ ::ActiveRecord::Base.extend(
17
+ Module.new do
18
+ def find_by_sql(sql, binds = [], preparable: nil, &block)
19
+ result = super
20
+ if Bullet.start?
21
+ if result.is_a? Array
22
+ if result.size > 1
23
+ Bullet::Detector::NPlusOneQuery.add_possible_objects(result)
24
+ Bullet::Detector::CounterCache.add_possible_objects(result)
25
+ elsif result.size == 1
26
+ Bullet::Detector::NPlusOneQuery.add_impossible_object(result.first)
27
+ Bullet::Detector::CounterCache.add_impossible_object(result.first)
28
+ end
29
+ elsif result.is_a? ::ActiveRecord::Base
30
+ Bullet::Detector::NPlusOneQuery.add_impossible_object(result)
31
+ Bullet::Detector::CounterCache.add_impossible_object(result)
27
32
  end
28
- elsif result.is_a? ::ActiveRecord::Base
29
- Bullet::Detector::NPlusOneQuery.add_impossible_object(result)
30
- Bullet::Detector::CounterCache.add_impossible_object(result)
31
33
  end
34
+ result
32
35
  end
33
- result
34
36
  end
35
- end)
37
+ )
36
38
 
37
39
  ::ActiveRecord::Base.prepend(SaveWithBulletSupport)
38
40
 
39
- ::ActiveRecord::Relation.prepend(Module.new do
40
- # if select a collection of objects, then these objects have possible to cause N+1 query.
41
- # if select only one object, then the only one object has impossible to cause N+1 query.
42
- def records
43
- result = super
44
- if Bullet.start?
45
- if result.first.class.name !~ /^HABTM_/
46
- if result.size > 1
47
- Bullet::Detector::NPlusOneQuery.add_possible_objects(result)
48
- Bullet::Detector::CounterCache.add_possible_objects(result)
49
- elsif result.size == 1
50
- Bullet::Detector::NPlusOneQuery.add_impossible_object(result.first)
51
- Bullet::Detector::CounterCache.add_impossible_object(result.first)
41
+ ::ActiveRecord::Relation.prepend(
42
+ Module.new do
43
+ # if select a collection of objects, then these objects have possible to cause N+1 query.
44
+ # if select only one object, then the only one object has impossible to cause N+1 query.
45
+ def records
46
+ result = super
47
+ if Bullet.start?
48
+ if result.first.class.name !~ /^HABTM_/
49
+ if result.size > 1
50
+ Bullet::Detector::NPlusOneQuery.add_possible_objects(result)
51
+ Bullet::Detector::CounterCache.add_possible_objects(result)
52
+ elsif result.size == 1
53
+ Bullet::Detector::NPlusOneQuery.add_impossible_object(result.first)
54
+ Bullet::Detector::CounterCache.add_impossible_object(result.first)
55
+ end
52
56
  end
53
57
  end
58
+ result
54
59
  end
55
- result
56
60
  end
57
- end)
58
-
59
- ::ActiveRecord::Associations::Preloader.prepend(Module.new do
60
- def preloaders_for_one(association, records, scope)
61
- if Bullet.start?
62
- records.compact!
63
- if records.first.class.name !~ /^HABTM_/
64
- records.each do |record|
65
- Bullet::Detector::Association.add_object_associations(record, association)
61
+ )
62
+
63
+ ::ActiveRecord::Associations::Preloader.prepend(
64
+ Module.new do
65
+ def preloaders_for_one(association, records, scope)
66
+ if Bullet.start?
67
+ records.compact!
68
+ if records.first.class.name !~ /^HABTM_/
69
+ records.each { |record| Bullet::Detector::Association.add_object_associations(record, association) }
70
+ Bullet::Detector::UnusedEagerLoading.add_eager_loadings(records, association)
66
71
  end
67
- Bullet::Detector::UnusedEagerLoading.add_eager_loadings(records, association)
68
72
  end
73
+ super
69
74
  end
70
- super
71
75
  end
72
- end)
76
+ )
73
77
 
74
- ::ActiveRecord::FinderMethods.prepend(Module.new do
75
- # add includes in scope
76
- def find_with_associations
77
- return super { |r| yield r } if block_given?
78
+ ::ActiveRecord::FinderMethods.prepend(
79
+ Module.new do
80
+ # add includes in scope
81
+ def find_with_associations
82
+ return super { |r| yield r } if block_given?
78
83
 
79
- records = super
80
- if Bullet.start?
81
- associations = (eager_load_values + includes_values).uniq
82
- records.each do |record|
83
- Bullet::Detector::Association.add_object_associations(record, associations)
84
+ records = super
85
+ if Bullet.start?
86
+ associations = (eager_load_values + includes_values).uniq
87
+ records.each { |record| Bullet::Detector::Association.add_object_associations(record, associations) }
88
+ Bullet::Detector::UnusedEagerLoading.add_eager_loadings(records, associations)
84
89
  end
85
- Bullet::Detector::UnusedEagerLoading.add_eager_loadings(records, associations)
90
+ records
86
91
  end
87
- records
88
92
  end
89
- end)
93
+ )
90
94
 
91
- ::ActiveRecord::Associations::JoinDependency.prepend(Module.new do
92
- if ::ActiveRecord::Associations::JoinDependency.instance_method(:instantiate).parameters.last[0] == :block
93
- # ActiveRecord >= 5.1.5
94
- def instantiate(result_set, &block)
95
- @bullet_eager_loadings = {}
96
- records = super
95
+ ::ActiveRecord::Associations::JoinDependency.prepend(
96
+ Module.new do
97
+ if ::ActiveRecord::Associations::JoinDependency.instance_method(:instantiate).parameters.last[0] == :block
98
+ # ActiveRecord >= 5.1.5
99
+ def instantiate(result_set, &block)
100
+ @bullet_eager_loadings = {}
101
+ records = super
97
102
 
98
- if Bullet.start?
99
- @bullet_eager_loadings.each do |_klazz, eager_loadings_hash|
100
- objects = eager_loadings_hash.keys
101
- Bullet::Detector::UnusedEagerLoading.add_eager_loadings(objects, eager_loadings_hash[objects.first].to_a)
103
+ if Bullet.start?
104
+ @bullet_eager_loadings.each do |_klazz, eager_loadings_hash|
105
+ objects = eager_loadings_hash.keys
106
+ Bullet::Detector::UnusedEagerLoading.add_eager_loadings(
107
+ objects,
108
+ eager_loadings_hash[objects.first].to_a
109
+ )
110
+ end
102
111
  end
112
+ records
103
113
  end
104
- records
105
- end
106
- else
107
- # ActiveRecord <= 5.1.4
108
- def instantiate(result_set, aliases)
109
- @bullet_eager_loadings = {}
110
- records = super
114
+ else
115
+ # ActiveRecord <= 5.1.4
116
+ def instantiate(result_set, aliases)
117
+ @bullet_eager_loadings = {}
118
+ records = super
111
119
 
112
- if Bullet.start?
113
- @bullet_eager_loadings.each do |_klazz, eager_loadings_hash|
114
- objects = eager_loadings_hash.keys
115
- Bullet::Detector::UnusedEagerLoading.add_eager_loadings(objects, eager_loadings_hash[objects.first].to_a)
120
+ if Bullet.start?
121
+ @bullet_eager_loadings.each do |_klazz, eager_loadings_hash|
122
+ objects = eager_loadings_hash.keys
123
+ Bullet::Detector::UnusedEagerLoading.add_eager_loadings(
124
+ objects,
125
+ eager_loadings_hash[objects.first].to_a
126
+ )
127
+ end
116
128
  end
129
+ records
117
130
  end
118
- records
119
131
  end
120
- end
121
132
 
122
- def construct(ar_parent, parent, row, rs, seen, model_cache, aliases)
123
- if Bullet.start?
124
- unless ar_parent.nil?
125
- parent.children.each do |node|
126
- key = aliases.column_alias(node, node.primary_key)
127
- id = row[key]
128
- next unless id.nil?
129
-
130
- associations = node.reflection.name
131
- Bullet::Detector::Association.add_object_associations(ar_parent, associations)
132
- Bullet::Detector::NPlusOneQuery.call_association(ar_parent, associations)
133
- @bullet_eager_loadings[ar_parent.class] ||= {}
134
- @bullet_eager_loadings[ar_parent.class][ar_parent] ||= Set.new
135
- @bullet_eager_loadings[ar_parent.class][ar_parent] << associations
133
+ def construct(ar_parent, parent, row, rs, seen, model_cache, aliases)
134
+ if Bullet.start?
135
+ unless ar_parent.nil?
136
+ parent.children.each do |node|
137
+ key = aliases.column_alias(node, node.primary_key)
138
+ id = row[key]
139
+ next unless id.nil?
140
+
141
+ associations = node.reflection.name
142
+ Bullet::Detector::Association.add_object_associations(ar_parent, associations)
143
+ Bullet::Detector::NPlusOneQuery.call_association(ar_parent, associations)
144
+ @bullet_eager_loadings[ar_parent.class] ||= {}
145
+ @bullet_eager_loadings[ar_parent.class][ar_parent] ||= Set.new
146
+ @bullet_eager_loadings[ar_parent.class][ar_parent] << associations
147
+ end
136
148
  end
137
149
  end
150
+
151
+ super
138
152
  end
139
153
 
140
- super
141
- end
154
+ # call join associations
155
+ def construct_model(record, node, row, model_cache, id, aliases)
156
+ result = super
142
157
 
143
- # call join associations
144
- def construct_model(record, node, row, model_cache, id, aliases)
145
- result = super
146
-
147
- if Bullet.start?
148
- associations = node.reflection.name
149
- Bullet::Detector::Association.add_object_associations(record, associations)
150
- Bullet::Detector::NPlusOneQuery.call_association(record, associations)
151
- @bullet_eager_loadings[record.class] ||= {}
152
- @bullet_eager_loadings[record.class][record] ||= Set.new
153
- @bullet_eager_loadings[record.class][record] << associations
154
- end
158
+ if Bullet.start?
159
+ associations = node.reflection.name
160
+ Bullet::Detector::Association.add_object_associations(record, associations)
161
+ Bullet::Detector::NPlusOneQuery.call_association(record, associations)
162
+ @bullet_eager_loadings[record.class] ||= {}
163
+ @bullet_eager_loadings[record.class][record] ||= Set.new
164
+ @bullet_eager_loadings[record.class][record] << associations
165
+ end
155
166
 
156
- result
167
+ result
168
+ end
157
169
  end
158
- end)
159
-
160
- ::ActiveRecord::Associations::CollectionAssociation.prepend(Module.new do
161
- def load_target
162
- records = super
163
-
164
- if Bullet.start?
165
- if is_a? ::ActiveRecord::Associations::ThroughAssociation
166
- refl = reflection.through_reflection
167
- Bullet::Detector::NPlusOneQuery.call_association(owner, refl.name)
168
- association = owner.association refl.name
169
- Array(association.target).each do |through_record|
170
- Bullet::Detector::NPlusOneQuery.call_association(through_record, source_reflection.name)
171
- end
170
+ )
172
171
 
173
- if refl.through_reflection?
174
- refl = refl.through_reflection while refl.through_reflection?
172
+ ::ActiveRecord::Associations::CollectionAssociation.prepend(
173
+ Module.new do
174
+ def load_target
175
+ records = super
175
176
 
177
+ if Bullet.start?
178
+ if is_a? ::ActiveRecord::Associations::ThroughAssociation
179
+ refl = reflection.through_reflection
176
180
  Bullet::Detector::NPlusOneQuery.call_association(owner, refl.name)
181
+ association = owner.association refl.name
182
+ Array.wrap(association.target).each do |through_record|
183
+ Bullet::Detector::NPlusOneQuery.call_association(through_record, source_reflection.name)
184
+ end
185
+
186
+ if refl.through_reflection?
187
+ refl = refl.through_reflection while refl.through_reflection?
188
+
189
+ Bullet::Detector::NPlusOneQuery.call_association(owner, refl.name)
190
+ end
177
191
  end
178
- end
179
- Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.name) unless @inversed
180
- if records.first.class.name !~ /^HABTM_/
181
- if records.size > 1
182
- Bullet::Detector::NPlusOneQuery.add_possible_objects(records)
183
- Bullet::Detector::CounterCache.add_possible_objects(records)
184
- elsif records.size == 1
185
- Bullet::Detector::NPlusOneQuery.add_impossible_object(records.first)
186
- Bullet::Detector::CounterCache.add_impossible_object(records.first)
192
+ Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.name) unless @inversed
193
+ if records.first.class.name !~ /^HABTM_/
194
+ if records.size > 1
195
+ Bullet::Detector::NPlusOneQuery.add_possible_objects(records)
196
+ Bullet::Detector::CounterCache.add_possible_objects(records)
197
+ elsif records.size == 1
198
+ Bullet::Detector::NPlusOneQuery.add_impossible_object(records.first)
199
+ Bullet::Detector::CounterCache.add_impossible_object(records.first)
200
+ end
187
201
  end
188
202
  end
203
+ records
189
204
  end
190
- records
191
- end
192
205
 
193
- def empty?
194
- if Bullet.start? && !reflection.has_cached_counter?
195
- Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.name)
206
+ def empty?
207
+ if Bullet.start? && !reflection.has_cached_counter?
208
+ Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.name)
209
+ end
210
+ super
196
211
  end
197
- super
198
- end
199
212
 
200
- def include?(object)
201
- if Bullet.start?
202
- Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.name)
213
+ def include?(object)
214
+ Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.name) if Bullet.start?
215
+ super
203
216
  end
204
- super
205
217
  end
206
- end)
207
-
208
- ::ActiveRecord::Associations::SingularAssociation.prepend(Module.new do
209
- # call has_one and belongs_to associations
210
- def target
211
- result = super()
212
- if Bullet.start?
213
- if owner.class.name !~ /^HABTM_/ && !@inversed
214
- Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.name)
215
- if Bullet::Detector::NPlusOneQuery.impossible?(owner)
216
- Bullet::Detector::NPlusOneQuery.add_impossible_object(result) if result
217
- else
218
- Bullet::Detector::NPlusOneQuery.add_possible_objects(result) if result
218
+ )
219
+
220
+ ::ActiveRecord::Associations::SingularAssociation.prepend(
221
+ Module.new do
222
+ # call has_one and belongs_to associations
223
+ def target
224
+ result = super()
225
+
226
+ if Bullet.start?
227
+ if owner.class.name !~ /^HABTM_/ && !@inversed
228
+ Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.name)
229
+
230
+ if Bullet::Detector::NPlusOneQuery.impossible?(owner)
231
+ Bullet::Detector::NPlusOneQuery.add_impossible_object(result) if result
232
+ else
233
+ Bullet::Detector::NPlusOneQuery.add_possible_objects(result) if result
234
+ end
219
235
  end
220
236
  end
237
+ result
221
238
  end
222
- result
223
239
  end
224
- end)
240
+ )
225
241
 
226
- ::ActiveRecord::Associations::HasManyAssociation.prepend(Module.new do
227
- def empty?
228
- result = super
229
- if Bullet.start? && !reflection.has_cached_counter?
230
- Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.name)
242
+ ::ActiveRecord::Associations::HasManyAssociation.prepend(
243
+ Module.new do
244
+ def empty?
245
+ result = super
246
+ if Bullet.start? && !reflection.has_cached_counter?
247
+ Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.name)
248
+ end
249
+ result
231
250
  end
232
- result
233
- end
234
251
 
235
- def count_records
236
- result = reflection.has_cached_counter?
237
- if Bullet.start? && !result && !is_a?(::ActiveRecord::Associations::ThroughAssociation)
238
- Bullet::Detector::CounterCache.add_counter_cache(owner, reflection.name)
252
+ def count_records
253
+ result = reflection.has_cached_counter?
254
+ if Bullet.start? && !result && !is_a?(::ActiveRecord::Associations::ThroughAssociation)
255
+ Bullet::Detector::CounterCache.add_counter_cache(owner, reflection.name)
256
+ end
257
+ super
239
258
  end
240
- super
241
259
  end
242
- end)
260
+ )
243
261
  end
244
262
  end
245
263
  end