bullet 7.0.7 → 7.1.3

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 associations
+        #   if association not in call_object_association, then the object => association - call_object_association is unused preload associations
         def check_unused_preload_associations
           return unless Bullet.start?
           return unless Bullet.unused_eager_loading_enable?
@@ -65,7 +65,10 @@ module Bullet
         private
 
         def create_notification(callers, klazz, associations)
-          notify_associations = Array.wrap(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/ext/object.rb

@@ -9,11 +9,22 @@ class Object
     return if respond_to?(:persisted?) && !persisted?
 
     if self.class.respond_to?(:primary_keys) && self.class.primary_keys
-      self.class.primary_keys.map { |primary_key| send primary_key }.join(',')
+      primary_key = self.class.primary_keys
     elsif self.class.respond_to?(:primary_key) && self.class.primary_key
-      send self.class.primary_key
+      primary_key = self.class.primary_key
     else
-      id
+      primary_key = :id
     end
+
+    bullet_join_potential_composite_primary_key(primary_key)
+  end
+
+  private
+
+  def bullet_join_potential_composite_primary_key(primary_keys)
+    return send(primary_keys) unless primary_keys.is_a?(Enumerable)
+
+    primary_keys.map { |primary_key| send primary_key }
+                .join(',')
   end
 end

data/lib/bullet/mongoid8x.rb

@@ -0,0 +1,59 @@
+module Bullet
+  module Mongoid
+    def self.enable
+      require 'mongoid'
+      ::Mongoid::Contextual::Mongo.class_eval do
+        alias_method :origin_first, :first
+        alias_method :origin_last, :last
+        alias_method :origin_each, :each
+        alias_method :origin_eager_load, :eager_load
+
+        def first(opts = {})
+          result = origin_first(opts)
+          Bullet::Detector::NPlusOneQuery.add_impossible_object(result) if result
+          result
+        end
+
+        def last(opts = {})
+          result = origin_last(opts)
+          Bullet::Detector::NPlusOneQuery.add_impossible_object(result) if result
+          result
+        end
+
+        def each(&block)
+          return to_enum unless block_given?
+
+          records = []
+          origin_each { |record| records << record }
+          if records.length > 1
+            Bullet::Detector::NPlusOneQuery.add_possible_objects(records)
+          elsif records.size == 1
+            Bullet::Detector::NPlusOneQuery.add_impossible_object(records.first)
+          end
+          records.each(&block)
+        end
+
+        def eager_load(docs)
+          associations = criteria.inclusions.map(&:name)
+          docs.each do |doc|
+            Bullet::Detector::NPlusOneQuery.add_object_associations(doc, associations)
+          end
+          Bullet::Detector::UnusedEagerLoading.add_eager_loadings(docs, associations)
+          origin_eager_load(docs)
+        end
+      end
+
+      ::Mongoid::Association::Accessors.class_eval do
+        alias_method :origin_get_relation, :get_relation
+
+        def get_relation(name, association, object, reload = false)
+          result = origin_get_relation(name, association, object, reload)
+          unless association.embedded?
+            Bullet::Detector::NPlusOneQuery.call_association(self, name)
+          end
+          result
+        end
+      end
+    end
+  end
+end

data/lib/bullet/notification/base.rb

@@ -28,13 +28,13 @@ module Bullet
       def whoami
         @user ||=
           ENV['USER'].presence ||
-            (
-              begin
-                `whoami`.chomp
-              rescue StandardError
-                ''
-              end
-            )
+          (
+            begin
+              `whoami`.chomp
+            rescue StandardError
+              ''
+            end
+          )
         @user.present? ? "user: #{@user}" : ''
       end
 
@@ -73,7 +73,8 @@ module Bullet
       end
 
       def associations_str
-        ".includes(#{@associations.map { |a| a.to_s.to_sym }.inspect})"
+        ".includes(#{@associations.map { |a| a.to_s.to_sym }
+.inspect})"
       end
     end
   end

data/lib/bullet/notification/counter_cache.rb

@@ -8,7 +8,7 @@ module Bullet
       end
 
       def title
-        'Need Counter Cache'
+        'Need Counter Cache with Active Record size'
       end
     end
   end

data/lib/bullet/rack.rb

@@ -18,7 +18,7 @@ module Bullet
 
       response_body = nil
 
-      if Bullet.notification?
+      if Bullet.notification? || Bullet.always_append_html_body
         if Bullet.inject_into_page? && !file?(headers) && !sse?(headers) && !empty?(response) && status == 200
           if html_request?(headers, response)
             response_body = response_body(response)
@@ -49,6 +49,7 @@ module Bullet
       # response may be ["Not Found"], ["Move Permanently"], etc, but
       # those should not happen if the status is 200
       return true if !response.respond_to?(:body) && !response.respond_to?(:first)
+
       body = response_body(response)
       body.nil? || body.empty?
     end
@@ -135,7 +136,8 @@ module Bullet
     end
 
     def with_security_policy_nonce(headers)
-      matched = (headers['Content-Security-Policy'] || '').match(NONCE_MATCHER)
+      csp = headers['Content-Security-Policy'] || headers['Content-Security-Policy-Report-Only'] || ''
+      matched = csp.match(NONCE_MATCHER)
       nonce = matched[:nonce] if matched
 
       if nonce

data/lib/bullet/registry/association.rb

@@ -8,7 +8,8 @@ module Bullet
       end
 
       def similarly_associated(base, associations)
-        @registry.select { |key, value| key.include?(base) && value == associations }.collect(&:first).flatten
+        @registry.select { |key, value| key.include?(base) && value == associations }
+                 .collect(&:first).flatten
       end
     end
   end

data/lib/bullet/stack_trace_filter.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "bundler"
 
 module Bullet
@@ -14,8 +15,8 @@ module Bullet
         caller_path = location_as_path(location)
         caller_path.include?(Bullet.app_root) && !caller_path.include?(vendor_root) &&
           !caller_path.include?(bundler_path) || Bullet.stacktrace_includes.any? { |include_pattern|
-          pattern_matches?(location, include_pattern)
-        }
+                                                   pattern_matches?(location, include_pattern)
+                                                 }
       end
     end
 

data/lib/bullet/version.rb

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

data/lib/bullet.rb

@@ -40,10 +40,11 @@ module Bullet
                 :stacktrace_excludes,
                 :skip_html_injection
     attr_reader :safelist
-    attr_accessor :add_footer, :orm_patches_applied, :skip_http_headers
+    attr_accessor :add_footer, :orm_patches_applied, :skip_http_headers, :always_append_html_body
 
     available_notifiers =
-      UniformNotifier::AVAILABLE_NOTIFIERS.select { |notifier| notifier != :raise }.map { |notifier| "#{notifier}=" }
+      UniformNotifier::AVAILABLE_NOTIFIERS.select { |notifier| notifier != :raise }
+                                          .map { |notifier| "#{notifier}=" }
     available_notifiers_options = { to: UniformNotifier }
     delegate(*available_notifiers, **available_notifiers_options)
 
@@ -70,10 +71,14 @@ module Bullet
       end
     end
 
+    alias enabled= enable=
+
     def enable?
       !!@enable
     end
 
+    alias enabled? enable?
+
     # Rails.root might be nil if `railties` is a dependency on a project that does not use Rails
     def app_root
       @app_root ||= (defined?(::Rails.root) && !::Rails.root.nil? ? Rails.root.to_s : Dir.pwd).to_s

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bullet
 version: !ruby/object:Gem::Version
-  version: 7.0.7
+  version: 7.1.3
 platform: ruby
 authors:
 - Richard Huang
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-03 00:00:00.000000000 Z
+date: 2023-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -45,31 +45,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/main.yml"
-- ".gitignore"
-- ".rspec"
 - CHANGELOG.md
-- Gemfile
-- Gemfile.mongoid
-- Gemfile.mongoid-4.0
-- Gemfile.mongoid-5.0
-- Gemfile.mongoid-6.0
-- Gemfile.mongoid-7.0
-- Gemfile.rails-4.0
-- Gemfile.rails-4.1
-- Gemfile.rails-4.2
-- Gemfile.rails-5.0
-- Gemfile.rails-5.1
-- Gemfile.rails-5.2
-- Gemfile.rails-6.0
-- Gemfile.rails-6.1
-- Gemfile.rails-7.0
-- Guardfile
-- Hacking.md
 - MIT-LICENSE
 - README.md
-- Rakefile
-- bullet.gemspec
 - lib/bullet.rb
 - lib/bullet/active_job.rb
 - lib/bullet/active_record4.rb
@@ -80,6 +58,7 @@ files:
 - lib/bullet/active_record60.rb
 - lib/bullet/active_record61.rb
 - lib/bullet/active_record70.rb
+- lib/bullet/active_record71.rb
 - lib/bullet/bullet_xhr.js
 - lib/bullet/dependency.rb
 - lib/bullet/detector.rb
@@ -94,6 +73,7 @@ files:
 - lib/bullet/mongoid5x.rb
 - lib/bullet/mongoid6x.rb
 - lib/bullet/mongoid7x.rb
+- lib/bullet/mongoid8x.rb
 - lib/bullet/notification.rb
 - lib/bullet/notification/base.rb
 - lib/bullet/notification/counter_cache.rb
@@ -109,78 +89,12 @@ files:
 - lib/bullet/stack_trace_filter.rb
 - lib/bullet/version.rb
 - lib/generators/bullet/install_generator.rb
-- perf/benchmark.rb
-- rails/init.rb
-- spec/bullet/detector/association_spec.rb
-- spec/bullet/detector/base_spec.rb
-- spec/bullet/detector/counter_cache_spec.rb
-- spec/bullet/detector/n_plus_one_query_spec.rb
-- spec/bullet/detector/unused_eager_loading_spec.rb
-- spec/bullet/ext/object_spec.rb
-- spec/bullet/ext/string_spec.rb
-- spec/bullet/notification/base_spec.rb
-- spec/bullet/notification/counter_cache_spec.rb
-- spec/bullet/notification/n_plus_one_query_spec.rb
-- spec/bullet/notification/unused_eager_loading_spec.rb
-- spec/bullet/notification_collector_spec.rb
-- spec/bullet/rack_spec.rb
-- spec/bullet/registry/association_spec.rb
-- spec/bullet/registry/base_spec.rb
-- spec/bullet/registry/object_spec.rb
-- spec/bullet/stack_trace_filter_spec.rb
-- spec/bullet_spec.rb
-- spec/integration/active_record/association_spec.rb
-- spec/integration/counter_cache_spec.rb
-- spec/integration/mongoid/association_spec.rb
-- spec/models/address.rb
-- spec/models/attachment.rb
-- spec/models/author.rb
-- spec/models/base_user.rb
-- spec/models/category.rb
-- spec/models/city.rb
-- spec/models/client.rb
-- spec/models/comment.rb
-- spec/models/company.rb
-- spec/models/country.rb
-- spec/models/deal.rb
-- spec/models/document.rb
-- spec/models/entry.rb
-- spec/models/firm.rb
-- spec/models/folder.rb
-- spec/models/group.rb
-- spec/models/mongoid/address.rb
-- spec/models/mongoid/category.rb
-- spec/models/mongoid/comment.rb
-- spec/models/mongoid/company.rb
-- spec/models/mongoid/entry.rb
-- spec/models/mongoid/post.rb
-- spec/models/mongoid/user.rb
-- spec/models/newspaper.rb
-- spec/models/page.rb
-- spec/models/person.rb
-- spec/models/pet.rb
-- spec/models/post.rb
-- spec/models/relationship.rb
-- spec/models/reply.rb
-- spec/models/role.rb
-- spec/models/student.rb
-- spec/models/submission.rb
-- spec/models/teacher.rb
-- spec/models/user.rb
-- spec/models/writer.rb
-- spec/spec_helper.rb
-- spec/support/bullet_ext.rb
-- spec/support/mongo_seed.rb
-- spec/support/rack_double.rb
-- spec/support/sqlite_seed.rb
 - tasks/bullet_tasks.rake
-- test.sh
-- update.sh
 homepage: https://github.com/flyerhzm/bullet
 licenses:
 - MIT
 metadata:
-  changelog_uri: https://github.com/flyerhzm/bullet/blob/master/CHANGELOG.md
+  changelog_uri: https://github.com/flyerhzm/bullet/blob/main/CHANGELOG.md
   source_code_uri: https://github.com/flyerhzm/bullet
 post_install_message:
 rdoc_options: []
@@ -197,70 +111,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubygems_version: 3.4.1
+rubygems_version: 3.4.20
 signing_key:
 specification_version: 4
 summary: help to kill N+1 queries and unused eager loading.
-test_files:
-- spec/bullet/detector/association_spec.rb
-- spec/bullet/detector/base_spec.rb
-- spec/bullet/detector/counter_cache_spec.rb
-- spec/bullet/detector/n_plus_one_query_spec.rb
-- spec/bullet/detector/unused_eager_loading_spec.rb
-- spec/bullet/ext/object_spec.rb
-- spec/bullet/ext/string_spec.rb
-- spec/bullet/notification/base_spec.rb
-- spec/bullet/notification/counter_cache_spec.rb
-- spec/bullet/notification/n_plus_one_query_spec.rb
-- spec/bullet/notification/unused_eager_loading_spec.rb
-- spec/bullet/notification_collector_spec.rb
-- spec/bullet/rack_spec.rb
-- spec/bullet/registry/association_spec.rb
-- spec/bullet/registry/base_spec.rb
-- spec/bullet/registry/object_spec.rb
-- spec/bullet/stack_trace_filter_spec.rb
-- spec/bullet_spec.rb
-- spec/integration/active_record/association_spec.rb
-- spec/integration/counter_cache_spec.rb
-- spec/integration/mongoid/association_spec.rb
-- spec/models/address.rb
-- spec/models/attachment.rb
-- spec/models/author.rb
-- spec/models/base_user.rb
-- spec/models/category.rb
-- spec/models/city.rb
-- spec/models/client.rb
-- spec/models/comment.rb
-- spec/models/company.rb
-- spec/models/country.rb
-- spec/models/deal.rb
-- spec/models/document.rb
-- spec/models/entry.rb
-- spec/models/firm.rb
-- spec/models/folder.rb
-- spec/models/group.rb
-- spec/models/mongoid/address.rb
-- spec/models/mongoid/category.rb
-- spec/models/mongoid/comment.rb
-- spec/models/mongoid/company.rb
-- spec/models/mongoid/entry.rb
-- spec/models/mongoid/post.rb
-- spec/models/mongoid/user.rb
-- spec/models/newspaper.rb
-- spec/models/page.rb
-- spec/models/person.rb
-- spec/models/pet.rb
-- spec/models/post.rb
-- spec/models/relationship.rb
-- spec/models/reply.rb
-- spec/models/role.rb
-- spec/models/student.rb
-- spec/models/submission.rb
-- spec/models/teacher.rb
-- spec/models/user.rb
-- spec/models/writer.rb
-- spec/spec_helper.rb
-- spec/support/bullet_ext.rb
-- spec/support/mongo_seed.rb
-- spec/support/rack_double.rb
-- spec/support/sqlite_seed.rb
+test_files: []

data/.github/workflows/main.yml

@@ -1,82 +0,0 @@
-# This workflow uses actions that are not certified by GitHub.
-# They are provided by a third-party and are governed by
-# separate terms of service, privacy policy, and support
-# documentation.
-# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
-# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
-
-name: CI
-
-on:
-  push:
-    branches: [ main ]
-  pull_request:
-    branches: [ main ]
-
-jobs:
-  test_rails_4:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        gemfile: ['Gemfile.rails-4.0', 'Gemfile.rails-4.1', 'Gemfile.rails-4.2']
-    env: # $BUNDLE_GEMFILE must be set at the job level, so it is set for all steps
-      BUNDLE_GEMFILE: ${{ github.workspace }}/${{ matrix.gemfile }}
-    steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: 2.3
-        bundler: 1
-        bundler-cache: true
-    - name: Run tests
-      run: bundle exec rake
-  test_rails_5:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        gemfile: ['Gemfile.rails-5.0', 'Gemfile.rails-5.1', 'Gemfile.rails-5.2']
-    env: # $BUNDLE_GEMFILE must be set at the job level, so it is set for all steps
-      BUNDLE_GEMFILE: ${{ github.workspace }}/${{ matrix.gemfile }}
-    steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: 2.5
-        bundler: 1
-        bundler-cache: true
-    - name: Run tests
-      run: bundle exec rake
-  test_rails_6:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        gemfile: ['Gemfile.rails-6.0', 'Gemfile.rails-6.1']
-    env: # $BUNDLE_GEMFILE must be set at the job level, so it is set for all steps
-      BUNDLE_GEMFILE: ${{ github.workspace }}/${{ matrix.gemfile }}
-    steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: 2.7
-        bundler-cache: true
-    - name: Run tests
-      run: bundle exec rake
-  test_rails_7:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        gemfile: ['Gemfile.rails-7.0']
-    env: # $BUNDLE_GEMFILE must be set at the job level, so it is set for all steps
-      BUNDLE_GEMFILE: ${{ github.workspace }}/${{ matrix.gemfile }}
-    steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: 3.1
-        bundler-cache: true
-    - name: Run tests
-      run: bundle exec rake

data/.gitignore

@@ -1,15 +0,0 @@
-log/**
-pkg/**
-.DS_Store
-lib/.DS_Store
-.*.swp
-coverage.data
-tags
-.bundle
-*.gem
-benchmark_profile*
-/nbproject/private/
-coverage/
-.coveralls.yml
-Gemfile*.lock
-.idea/

data/.rspec

@@ -1,2 +0,0 @@
---colour
---format progress

data/Gemfile

@@ -1,24 +0,0 @@
-source 'https://rubygems.org'
-
-git_source(:github) do |repo_name|
-  repo_name = "#{repo_name}/#{repo_name}" unless repo_name.include?('/')
-  "https://github.com/#{repo_name}.git"
-end
-
-gemspec
-
-gem 'rails', github: 'rails'
-gem 'sqlite3', platforms: [:ruby]
-gem 'activerecord-jdbcsqlite3-adapter', platforms: [:jruby]
-gem 'activerecord-import'
-
-gem 'rspec'
-gem 'guard'
-gem 'guard-rspec'
-
-gem 'coveralls', require: false
-
-platforms :rbx do
-  gem 'rubysl', '~> 2.0'
-  gem 'rubinius-developer_tools'
-end

data/Gemfile.mongoid

@@ -1,12 +0,0 @@
-source "https://rubygems.org"
-
-gemspec
-
-gem 'rails'
-gem 'sqlite3', platforms: [:ruby]
-gem 'activerecord-jdbcsqlite3-adapter', platforms: [:jruby]
-gem 'mongoid', github: 'mongoid/mongoid'
-
-gem "rspec"
-
-gem 'coveralls', require: false

data/Gemfile.mongoid-4.0

@@ -1,15 +0,0 @@
-source "https://rubygems.org"
-
-gemspec
-
-gem 'rails', '~> 4.0.0'
-gem 'sqlite3', platforms: [:ruby]
-gem 'activerecord-jdbcsqlite3-adapter', platforms: [:jruby]
-gem 'mongoid', '~> 4.0.0'
-
-gem "rspec"
-
-platforms :rbx do
-  gem 'rubysl', '~> 2.0'
-  gem 'rubinius-developer_tools'
-end

data/Gemfile.mongoid-5.0

@@ -1,15 +0,0 @@
-source "https://rubygems.org"
-
-gemspec
-
-gem 'rails', '~> 4.0.0'
-gem 'sqlite3', platforms: [:ruby]
-gem 'activerecord-jdbcsqlite3-adapter', platforms: [:jruby]
-gem 'mongoid', '~> 5.1.0'
-
-gem "rspec"
-
-platforms :rbx do
-  gem 'rubysl', '~> 2.0'
-  gem 'rubinius-developer_tools'
-end

data/Gemfile.mongoid-6.0

@@ -1,15 +0,0 @@
-source "https://rubygems.org"
-
-gemspec
-
-gem 'rails', '~> 5.0.0'
-gem 'sqlite3', platforms: [:ruby]
-gem 'activerecord-jdbcsqlite3-adapter', platforms: [:jruby]
-gem 'mongoid', '~> 6.0.0'
-
-gem "rspec"
-
-platforms :rbx do
-  gem 'rubysl', '~> 2.0'
-  gem 'rubinius-developer_tools'
-end

data/Gemfile.mongoid-7.0

@@ -1,15 +0,0 @@
-source "https://rubygems.org"
-
-gemspec
-
-gem 'rails', '~> 5.0'
-gem 'sqlite3', platforms: [:ruby]
-gem 'activerecord-jdbcsqlite3-adapter', platforms: [:jruby]
-gem 'mongoid', '~> 7.0.0'
-
-gem "rspec"
-
-platforms :rbx do
-  gem 'rubysl', '~> 2.0'
-  gem 'rubinius-developer_tools'
-end

data/Gemfile.rails-4.0

@@ -1,16 +0,0 @@
-source "https://rubygems.org"
-
-gemspec
-
-gem 'rails', '~> 4.0.0'
-gem 'sqlite3', '~> 1.3.6', platforms: [:ruby]
-gem 'activerecord-jdbcsqlite3-adapter', platforms: [:jruby]
-gem 'activerecord-import'
-gem 'tins', '~> 1.6.0', platforms: [:ruby_19]
-
-gem "rspec"
-
-platforms :rbx do
-  gem 'rubysl', '~> 2.0'
-  gem 'rubinius-developer_tools'
-end