bullet 7.0.1 → 7.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 823bcc1af2be934ec4f10df71ea2951223834d3146e9c323afada99ba4ae4254
-  data.tar.gz: 4cda048b45bd219d62bee22e0041027561c943d283ee262ea71686a15e6e4345
+  metadata.gz: ad1f81292cc89778a41c6dd178bbfb6342fe1b69c4e57c3fdad0d8003d97b525
+  data.tar.gz: 5c1c8113f6e03ecdb449bce5e12273b969f29c323a5bb802c13c0539ea439a69
 SHA512:
-  metadata.gz: 9a2398eb23da7201bb8ab3fb1dbea3d48089d6c51d4a0e473d25009841aab41c68a5b0c27fb6ac6b77084e2465a836a5b848ffda63a2ea3b457a9571b04d428f
-  data.tar.gz: ab3debd03dc9cafbbd8ef9237f747c67d14bf3d8bf116b7dbed4e145176cf3f10045862b32641036e9bb00caca6eee841c75f9b3defad83ca681d0d70a5c6f0d
+  metadata.gz: 1f0d4d73910f96ab8c6ae5b6b1bc58de547c2c32a7c689c2984778465dae29d2c2cae81c23699b3848d2eaef30223db66bcca6ccb421b9078d5616f497421d45
+  data.tar.gz: 3b9001966918da22bfe7b2960526ac0db471a75e79e7939b099bebe3dde1fb27ea69b1afbdec0fcc98a6cb4260b845b5551a1a07cec036207c885be4e14ef7b9

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## Next Release
 
+## 7.0.3 (08/13/2022)
+
+* Replace `Array()` with `Array.wrap()`
+
+## 7.0.2 (05/31/2022)
+
+* Drop growl support
+* Do not check html tag in Bullet::Rack anymore
+
 ## 7.0.1 (01/15/2022)
 
 * Get rid of *_whitelist methods

data/README.md

@@ -49,7 +49,7 @@ mongoid.
 
 ## Configuration
 
-Bullet won't do ANYTHING unless you tell it to explicitly. Append to
+Bullet won't enable any notification systems unless you tell it to explicitly. Append to
 `config/environments/development.rb` initializer with the following code:
 
 ```ruby
@@ -59,7 +59,6 @@ config.after_initialize do
   Bullet.alert = true
   Bullet.bullet_logger = true
   Bullet.console = true
-  Bullet.growl = true
   Bullet.xmpp = { :account  => 'bullets_account@jabber.org',
                   :password => 'bullets_password_for_jabber',
                   :receiver => 'your_account@jabber.org',
@@ -85,7 +84,6 @@ The code above will enable all of the Bullet notification systems:
 * `Bullet.alert`: pop up a JavaScript alert in the browser
 * `Bullet.bullet_logger`: log to the Bullet log file (Rails.root/log/bullet.log)
 * `Bullet.console`: log warnings to your browser's console.log (Safari/Webkit browsers or Firefox w/Firebug installed)
-* `Bullet.growl`: pop up Growl warnings if your system has Growl installed. Requires a little bit of configuration
 * `Bullet.xmpp`: send XMPP/Jabber notifications to the receiver indicated. Note that the code will currently not handle the adding of contacts, so you will need to make both accounts indicated know each other manually before you will receive any notifications. If you restart the development server frequently, the 'coming online' sound for the Bullet account may start to annoy - in this case set :show_online_status to false; you will still get notifications, but the Bullet account won't announce it's online status anymore.
 * `Bullet.rails_logger`: add warnings directly to the Rails log
 * `Bullet.honeybadger`: add notifications to Honeybadger
@@ -156,25 +154,26 @@ The Bullet log `log/bullet.log` will look something like this:
 * N+1 Query:
 
 ```
-2009-08-25 20:40:17[INFO] N+1 Query: PATH_INFO: /posts;    model: Post => associations: [comments]·
-Add to your finder: :include => [:comments]
-2009-08-25 20:40:17[INFO] N+1 Query: method call stack:·
-/Users/richard/Downloads/test/app/views/posts/index.html.erb:11:in `_run_erb_app47views47posts47index46html46erb'
-/Users/richard/Downloads/test/app/views/posts/index.html.erb:8:in `each'
-/Users/richard/Downloads/test/app/views/posts/index.html.erb:8:in `_run_erb_app47views47posts47index46html46erb'
-/Users/richard/Downloads/test/app/controllers/posts_controller.rb:7:in `index'
+2009-08-25 20:40:17[INFO] USE eager loading detected:
+  Post => [:comments]·
+  Add to your query: .includes([:comments])
+2009-08-25 20:40:17[INFO] Call stack
+  /Users/richard/Downloads/test/app/views/posts/index.html.erb:8:in `each'
+  /Users/richard/Downloads/test/app/controllers/posts_controller.rb:7:in `index'
 ```
 
-The first two lines are notifications that N+1 queries have been encountered. The remaining lines are stack traces so you can find exactly where the queries were invoked in your code, and fix them.
+The first log entry is a notification that N+1 queries have been encountered. The remaining entry is a stack trace so you can find exactly where the queries were invoked in your code, and fix them.
 
 * Unused eager loading:
 
 ```
-2009-08-25 20:53:56[INFO] Unused eager loadings: PATH_INFO: /posts;    model: Post => associations: [comments]·
-Remove from your finder: :include => [:comments]
+2009-08-25 20:53:56[INFO] AVOID eager loading detected
+  Post => [:comments]·
+  Remove from your query: .includes([:comments])
+2009-08-25 20:53:56[INFO] Call stack
 ```
 
-These two lines are notifications that unused eager loadings have been encountered.
+These lines are notifications that unused eager loadings have been encountered.
 
 * Need counter cache:
 
@@ -183,10 +182,14 @@ These two lines are notifications that unused eager loadings have been encounter
   Post => [:comments]
 ```
 
-## Growl, XMPP/Jabber and Airbrake Support
+## XMPP/Jabber and Airbrake Support
 
 see [https://github.com/flyerhzm/uniform_notifier](https://github.com/flyerhzm/uniform_notifier)
 
+## Growl Support
+
+Growl support is dropped from uniform_notifier 1.16.0, if you still want it, please use uniform_notifier 1.15.0.
+
 ## Important
 
 If you find Bullet does not work for you, *please disable your browser's cache*.

data/lib/bullet/active_record5.rb

@@ -179,7 +179,7 @@ module Bullet
                 refl = reflection.through_reflection
                 Bullet::Detector::NPlusOneQuery.call_association(owner, refl.name)
                 association = owner.association refl.name
-                Array(association.target).each do |through_record|
+                Array.wrap(association.target).each do |through_record|
                   Bullet::Detector::NPlusOneQuery.call_association(through_record, source_reflection.name)
                 end
 

data/lib/bullet/active_record52.rb

@@ -152,7 +152,7 @@ module Bullet
               if is_a? ::ActiveRecord::Associations::ThroughAssociation
                 Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.through_reflection.name)
                 association = owner.association reflection.through_reflection.name
-                Array(association.target).each do |through_record|
+                Array.wrap(association.target).each do |through_record|
                   Bullet::Detector::NPlusOneQuery.call_association(through_record, source_reflection.name)
                 end
 
@@ -199,7 +199,7 @@ module Bullet
                 if is_a? ::ActiveRecord::Associations::ThroughAssociation
                   Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.through_reflection.name)
                   association = owner.association reflection.through_reflection.name
-                  Array(association.target).each do |through_record|
+                  Array.wrap(association.target).each do |through_record|
                     Bullet::Detector::NPlusOneQuery.call_association(through_record, source_reflection.name)
                   end
 

data/lib/bullet/active_record60.rb

@@ -179,7 +179,7 @@ module Bullet
               if is_a? ::ActiveRecord::Associations::ThroughAssociation
                 Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.through_reflection.name)
                 association = owner.association(reflection.through_reflection.name)
-                Array(association.target).each do |through_record|
+                Array.wrap(association.target).each do |through_record|
                   Bullet::Detector::NPlusOneQuery.call_association(through_record, source_reflection.name)
                 end
 
@@ -226,7 +226,7 @@ module Bullet
                 if is_a? ::ActiveRecord::Associations::ThroughAssociation
                   Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.through_reflection.name)
                   association = owner.association(reflection.through_reflection.name)
-                  Array(association.target).each do |through_record|
+                  Array.wrap(association.target).each do |through_record|
                     Bullet::Detector::NPlusOneQuery.call_association(through_record, source_reflection.name)
                   end
 

data/lib/bullet/active_record61.rb

@@ -179,7 +179,7 @@ module Bullet
               if is_a? ::ActiveRecord::Associations::ThroughAssociation
                 Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.through_reflection.name)
                 association = owner.association(reflection.through_reflection.name)
-                Array(association.target).each do |through_record|
+                Array.wrap(association.target).each do |through_record|
                   Bullet::Detector::NPlusOneQuery.call_association(through_record, source_reflection.name)
                 end
 
@@ -226,7 +226,7 @@ module Bullet
                 if is_a? ::ActiveRecord::Associations::ThroughAssociation
                   Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.through_reflection.name)
                   association = owner.association(reflection.through_reflection.name)
-                  Array(association.target).each do |through_record|
+                  Array.wrap(association.target).each do |through_record|
                     Bullet::Detector::NPlusOneQuery.call_association(through_record, source_reflection.name)
                   end
 

data/lib/bullet/active_record70.rb

@@ -182,7 +182,7 @@ module Bullet
               if is_a? ::ActiveRecord::Associations::ThroughAssociation
                 Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.through_reflection.name)
                 association = owner.association(reflection.through_reflection.name)
-                Array(association.target).each do |through_record|
+                Array.wrap(association.target).each do |through_record|
                   Bullet::Detector::NPlusOneQuery.call_association(through_record, source_reflection.name)
                 end
 
@@ -229,7 +229,7 @@ module Bullet
                 if is_a? ::ActiveRecord::Associations::ThroughAssociation
                   Bullet::Detector::NPlusOneQuery.call_association(owner, reflection.through_reflection.name)
                   association = owner.association(reflection.through_reflection.name)
-                  Array(association.target).each do |through_record|
+                  Array.wrap(association.target).each do |through_record|
                     Bullet::Detector::NPlusOneQuery.call_association(through_record, source_reflection.name)
                   end
 

data/lib/bullet/bullet_xhr.js

@@ -20,7 +20,7 @@
     if (this.onload) {
       this._storedOnload = this.onload;
     }
-    this.onload = null
+    this.onload = null;
     this.addEventListener("load", bulletXHROnload);
     return Reflect.apply(oldSend, this, arguments);
   }
@@ -31,7 +31,7 @@
     ) {
       var bulletFooterText = this.getResponseHeader("X-bullet-footer-text");
       if (bulletFooterText) {
-        setTimeout(function() {
+        setTimeout(function () {
           var oldHtml = document.querySelector("#bullet-footer").innerHTML.split("<br>");
           var header = oldHtml[0];
           oldHtml = oldHtml.slice(1, oldHtml.length);
@@ -42,7 +42,7 @@
       }
       var bulletConsoleText = this.getResponseHeader("X-bullet-console-text");
       if (bulletConsoleText && typeof console !== "undefined" && console.log) {
-        setTimeout(function() {
+        setTimeout(function () {
           JSON.parse(bulletConsoleText).forEach((message) => {
             if (console.groupCollapsed && console.groupEnd) {
               console.groupCollapsed("Uniform Notifier");

data/lib/bullet/detector/counter_cache.rb

@@ -20,7 +20,7 @@ module Bullet
           return unless Bullet.start?
           return unless Bullet.counter_cache_enable?
 
-          objects = Array(object_or_objects)
+          objects = Array.wrap(object_or_objects)
           return if objects.map(&:bullet_primary_key_value).compact.empty?
 
           Bullet.debug(
@@ -54,7 +54,7 @@ module Bullet
         private
 
         def create_notification(klazz, associations)
-          notify_associations = Array(associations) - Bullet.get_safelist_associations(:counter_cache, klazz)
+          notify_associations = Array.wrap(associations) - Bullet.get_safelist_associations(:counter_cache, klazz)
 
           if notify_associations.present?
             notice = Bullet::Notification::CounterCache.new klazz, notify_associations

data/lib/bullet/detector/n_plus_one_query.rb

@@ -7,7 +7,7 @@ module Bullet
       extend StackTraceFilter
 
       class << self
-        # executed when object.assocations is called.
+        # executed when object.associations is called.
         # first, it keeps this method call for object.association.
         # then, it checks if this associations call is unpreload.
         #   if it is, keeps this unpreload associations and caller.
@@ -33,7 +33,7 @@ module Bullet
           return unless Bullet.start?
           return unless Bullet.n_plus_one_query_enable?
 
-          objects = Array(object_or_objects)
+          objects = Array.wrap(object_or_objects)
           return if objects.map(&:bullet_primary_key_value).compact.empty?
           return if objects.all? { |obj| obj.class.name =~ /^HABTM_/ }
 
@@ -95,7 +95,7 @@ module Bullet
         private
 
         def create_notification(callers, klazz, associations)
-          notify_associations = Array(associations) - Bullet.get_safelist_associations(:n_plus_one_query, klazz)
+          notify_associations = Array.wrap(associations) - Bullet.get_safelist_associations(:n_plus_one_query, klazz)
 
           if notify_associations.present?
             notice = Bullet::Notification::NPlusOneQuery.new(callers, klazz, notify_associations)

data/lib/bullet/detector/unused_eager_loading.rb

@@ -10,7 +10,7 @@ module Bullet
         # check if there are unused preload associations.
         #   get related_objects from eager_loadings associated with object and associations
         #   get call_object_association from associations of call_object_associations whose object is in related_objects
-        #   if association not in call_object_association, then the object => association - call_object_association is ununsed preload assocations
+        #   if association not in call_object_association, then the object => association - call_object_association is ununsed preload associations
         def check_unused_preload_associations
           return unless Bullet.start?
           return unless Bullet.unused_eager_loading_enable?
@@ -65,7 +65,7 @@ module Bullet
         private
 
         def create_notification(callers, klazz, associations)
-          notify_associations = Array(associations) - Bullet.get_safelist_associations(:unused_eager_loading, klazz)
+          notify_associations = Array.wrap(associations) - Bullet.get_safelist_associations(:unused_eager_loading, klazz)
 
           if notify_associations.present?
             notice = Bullet::Notification::UnusedEagerLoading.new(callers, klazz, notify_associations)

data/lib/bullet/rack.rb

@@ -79,7 +79,7 @@ module Bullet
     end
 
     def html_request?(headers, response)
-      headers['Content-Type']&.include?('text/html') && response_body(response).include?('<html')
+      headers['Content-Type']&.include?('text/html')
     end
 
     def response_body(response)

data/lib/bullet/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Bullet
-  VERSION = '7.0.1'
+  VERSION = '7.0.3'
 end

data/lib/bullet.rb

@@ -109,7 +109,7 @@ module Bullet
     end
 
     def get_safelist_associations(type, class_name)
-      Array(@safelist[type][class_name])
+      Array.wrap(@safelist[type][class_name])
     end
 
     def reset_safelist

data/lib/generators/bullet/install_generator.rb

@@ -16,7 +16,6 @@ module Bullet
               Bullet.alert         = true
               Bullet.bullet_logger = true
               Bullet.console       = true
-            # Bullet.growl         = true
               Bullet.rails_logger  = true
               Bullet.add_footer    = true
             end

data/spec/bullet/detector/n_plus_one_query_spec.rb

@@ -39,7 +39,7 @@ module Bullet
 
         it 'should be false if object, association pair is not existed' do
           NPlusOneQuery.add_object_associations(@post, :association1)
-          expect(NPlusOneQuery.association?(@post, :associatio2)).to eq false
+          expect(NPlusOneQuery.association?(@post, :association2)).to eq false
         end
       end
 

data/spec/bullet/notification/base_spec.rb

@@ -74,8 +74,8 @@ module Bullet
         it 'should send full_notice to notifier' do
           notifier = double
           allow(subject).to receive(:notifier).and_return(notifier)
-          allow(subject).to receive(:notification_data).and_return(foo: :bar)
-          expect(notifier).to receive(:inline_notify).with(foo: :bar)
+          allow(subject).to receive(:notification_data).and_return({ foo: :bar })
+          expect(notifier).to receive(:inline_notify).with({ foo: :bar })
           subject.notify_inline
         end
       end
@@ -84,8 +84,8 @@ module Bullet
         it 'should send full_out_of_channel to notifier' do
           notifier = double
           allow(subject).to receive(:notifier).and_return(notifier)
-          allow(subject).to receive(:notification_data).and_return(foo: :bar)
-          expect(notifier).to receive(:out_of_channel_notify).with(foo: :bar)
+          allow(subject).to receive(:notification_data).and_return({ foo: :bar })
+          expect(notifier).to receive(:out_of_channel_notify).with({ foo: :bar })
           subject.notify_out_of_channel
         end
       end

data/spec/bullet/rack_spec.rb

@@ -31,12 +31,6 @@ module Bullet
         response = double(body: '<html><head></head><body></body></html>')
         expect(middleware).not_to be_html_request(headers, response)
       end
-
-      it "should be false if response body doesn't contain html tag" do
-        headers = { 'Content-Type' => 'text/html' }
-        response = double(body: '<div>Partial</div>')
-        expect(middleware).not_to be_html_request(headers, response)
-      end
     end
 
     context 'empty?' do

data/spec/support/sqlite_seed.rb

@@ -92,7 +92,7 @@ module Support
       page3 = Page.create(name: 'page3', parent_id: folder2.id, author_id: author2.id)
       page4 = Page.create(name: 'page4', parent_id: folder2.id, author_id: author2.id)
 
-      role1 = Role.create(name: 'Amdin')
+      role1 = Role.create(name: 'Admin')
       role2 = Role.create(name: 'User')
 
       user1 = User.create(name: 'user1', category: category1)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bullet
 version: !ruby/object:Gem::Version
-  version: 7.0.1
+  version: 7.0.3
 platform: ruby
 authors:
 - Richard Huang
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-15 00:00:00.000000000 Z
+date: 2022-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -195,7 +195,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: help to kill N+1 queries and unused eager loading.