prosopite 1.4.2 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0509715095d0797998d5bd88ad33bf6390bbc68d5da7f34a10ada120bbcbe96d'
-  data.tar.gz: 3e05d4ae63f68955c002853d5820bac19ab239b7d4987576bf1d7b9dd85f7d06
+  metadata.gz: 79f272a757baeae3f05f7721b7204130588532ac09fb28d163d09737512f8edd
+  data.tar.gz: d45ecc27ba09f2b55447eb82f9fc35773846cf44d924b710a83eaa5ada5260a0
 SHA512:
-  metadata.gz: 63408215134ec404aba9cd4728ae2bdbb57b0924c08449a1cccc1f72d46cfdedec33685643b452eac0a23ff05abbb0fc74f96954b0ec874b94aef974f46d2ed0
-  data.tar.gz: d1b9a6d908bf2b17bbe9710b446a0c7b3f66a1a5b0468aaabb37b085d152d609a973faec5ae529d859ecea8c297d93ff3128917344ae6ff0159fb4fc5041a10b
+  metadata.gz: 60cd8f6dc74fc8a51e7ada04ae53212c8965309ffbe67ad83f6e2537a289bb205a4e626e44fda4b14673aed407cf2bb706306ba0f47051d22da7a16c78f73fcb
+  data.tar.gz: 66c392a288ddbdf44bacc433740c9b6c2e7213c714e80c77992581460736300451a0f7add73196d81203a0533900424128754960ffbce6914d20c9e01cfdb8c5

data/.github/workflows/ci.yml

@@ -4,7 +4,7 @@ jobs:
   test:
     strategy:
       matrix:
-        ruby: [2.7, '3.0', 3.1, 3.2]
+        ruby: [3.2, 3.3, 3.4]
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3

data/Gemfile.lock

@@ -1,87 +1,136 @@
 PATH
   remote: .
   specs:
-    prosopite (1.4.2)
+    prosopite (2.1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (6.1.3)
-      actionview (= 6.1.3)
-      activesupport (= 6.1.3)
-      rack (~> 2.0, >= 2.0.9)
+    actionpack (8.0.1)
+      actionview (= 8.0.1)
+      activesupport (= 8.0.1)
+      nokogiri (>= 1.8.5)
+      rack (>= 2.2.4)
+      rack-session (>= 1.0.1)
       rack-test (>= 0.6.3)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actionview (6.1.3)
-      activesupport (= 6.1.3)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+      useragent (~> 0.16)
+    actionview (8.0.1)
+      activesupport (= 8.0.1)
       builder (~> 3.1)
-      erubi (~> 1.4)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activemodel (6.1.3)
-      activesupport (= 6.1.3)
-    activerecord (6.1.3)
-      activemodel (= 6.1.3)
-      activesupport (= 6.1.3)
-    activesupport (6.1.3)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activemodel (8.0.1)
+      activesupport (= 8.0.1)
+    activerecord (8.0.1)
+      activemodel (= 8.0.1)
+      activesupport (= 8.0.1)
+      timeout (>= 0.4.0)
+    activesupport (8.0.1)
+      base64
+      benchmark (>= 0.3)
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
       i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
       minitest (>= 5.1)
-      tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
     ansi (1.5.0)
+    base64 (0.2.0)
+    benchmark (0.4.0)
+    bigdecimal (3.1.9)
     builder (3.2.4)
     coderay (1.1.3)
-    concurrent-ruby (1.1.8)
+    concurrent-ruby (1.3.5)
+    connection_pool (2.5.0)
     crass (1.0.6)
+    date (3.4.1)
+    drb (2.2.1)
     erubi (1.12.0)
-    factory_bot (6.1.0)
-      activesupport (>= 5.0.0)
+    factory_bot (6.5.1)
+      activesupport (>= 6.1.0)
     i18n (1.8.9)
       concurrent-ruby (~> 1.0)
-    loofah (2.19.1)
+    io-console (0.8.0)
+    irb (1.15.1)
+      pp (>= 0.6.0)
+      rdoc (>= 4.0.0)
+      reline (>= 0.4.2)
+    logger (1.6.6)
+    loofah (2.24.0)
       crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
+      nokogiri (>= 1.12.0)
     method_source (1.0.0)
-    mini_portile2 (2.8.1)
-    minitest (5.14.3)
+    mini_portile2 (2.8.8)
+    minitest (5.25.4)
     minitest-reporters (1.5.0)
       ansi
       builder
       minitest (>= 5.0)
       ruby-progressbar
-    nokogiri (1.14.1)
-      mini_portile2 (~> 2.8.0)
+    nokogiri (1.18.3)
+      mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
-    nokogiri (1.14.1-x86_64-linux)
+    nokogiri (1.18.3-x86_64-linux-gnu)
       racc (~> 1.4)
     pg_query (1.3.0)
+    pp (0.6.2)
+      prettyprint
+    prettyprint (0.2.0)
     pry (0.14.0)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    racc (1.6.2)
-    rack (2.2.6.2)
+    psych (5.2.3)
+      date
+      stringio
+    racc (1.8.1)
+    rack (3.1.10)
+    rack-session (2.1.0)
+      base64 (>= 0.1.0)
+      rack (>= 3.0.0)
     rack-test (2.0.2)
       rack (>= 1.3)
-    rails-dom-testing (2.0.3)
-      activesupport (>= 4.2.0)
+    rackup (2.2.1)
+      rack (>= 3)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.5.0)
-      loofah (~> 2.19, >= 2.19.1)
-    railties (6.1.3)
-      actionpack (= 6.1.3)
-      activesupport (= 6.1.3)
-      method_source
-      rake (>= 0.8.7)
-      thor (~> 1.0)
+    rails-html-sanitizer (1.6.2)
+      loofah (~> 2.21)
+      nokogiri (>= 1.15.7, != 1.16.7, != 1.16.6, != 1.16.5, != 1.16.4, != 1.16.3, != 1.16.2, != 1.16.1, != 1.16.0.rc1, != 1.16.0)
+    railties (8.0.1)
+      actionpack (= 8.0.1)
+      activesupport (= 8.0.1)
+      irb (~> 1.13)
+      rackup (>= 1.0.0)
+      rake (>= 12.2)
+      thor (~> 1.0, >= 1.2.2)
+      zeitwerk (~> 2.6)
     rake (13.0.6)
+    rdoc (6.12.0)
+      psych (>= 4.0.0)
+    reline (0.6.0)
+      io-console (~> 0.5)
     ruby-progressbar (1.11.0)
-    sqlite3 (1.4.2)
-    thor (1.2.1)
-    tzinfo (2.0.4)
+    securerandom (0.4.1)
+    sqlite3 (2.5.0)
+      mini_portile2 (~> 2.8.0)
+    sqlite3 (2.5.0-x86_64-linux-gnu)
+    stringio (3.1.4)
+    thor (1.3.2)
+    timeout (0.4.3)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    zeitwerk (2.4.2)
+    uri (1.0.2)
+    useragent (0.16.11)
+    zeitwerk (2.7.2)
 
 PLATFORMS
   ruby
@@ -100,4 +149,4 @@ DEPENDENCIES
   sqlite3
 
 BUNDLED WITH
-   2.2.10
+   2.6.5

data/README.md

@@ -116,37 +116,17 @@ Or install it yourself as:
 The preferred type of notifications can be configured with:
 
 * `Prosopite.min_n_queries`: Minimum number of N queries to report per N+1 case. Defaults to 2.
-* `Prosopite.raise = true`: Raise warnings as exceptions
-* `Prosopite.rails_logger = true`: Send warnings to the Rails log
-* `Prosopite.prosopite_logger = true`: Send warnings to `log/prosopite.log`
-* `Prosopite.stderr_logger = true`: Send warnings to STDERR
+* `Prosopite.raise = true`: Raise warnings as exceptions. Defaults to `false`.
+* `Prosopite.start_raise`: Raises warnings as exceptions from when this is called. Overrides `Proposite.raise`.
+* `Propsoite.stop_raise`: Disables raising warnings as exceptions if previously enabled with `Proposite.start_raise`.
+* `Prosopite.local_raise?`: Returns `true` if `Prosopite.start_raise` has been called previously.
+* `Prosopite.rails_logger = true`: Send warnings to the Rails log. Defaults to `false`.
+* `Prosopite.prosopite_logger = true`: Send warnings to `log/prosopite.log`. Defaults to `false`.
+* `Prosopite.stderr_logger = true`: Send warnings to STDERR. Defaults to `false`.
 * `Prosopite.backtrace_cleaner = my_custom_backtrace_cleaner`: use a different [ActiveSupport::BacktraceCleaner](https://api.rubyonrails.org/classes/ActiveSupport/BacktraceCleaner.html). Defaults to `Rails.backtrace_cleaner`.
-* `Prosopite.custom_logger = my_custom_logger`:
+* `Prosopite.custom_logger = my_custom_logger`: Set a custom logger. See the following section for the details. Defaults to `false`.
 * `Prosopite.enabled = true`: Enables or disables the gem. Defaults to `true`.
 
-### Custom Logging Configuration
-
-You can supply a custom logger with the `Prosopite.custom_logger` setting.
-
-This is useful for circumstances where you don't want your logs to be
-highlighted with red, or you want logs sent to a custom location.
-
-One common scenario is that you may be generating json logs and sending them to
-Datadog, ELK stack, or similar, and don't want to have to remove the default red
-escaping data from messages sent to the Rails logger, or want to tag them
-differently with your own custom logger.
-
-```ruby
-# Turns off logging with red highlights, but still sends them to the Rails logger
-Prosopite.custom_logger = Rails.logger
-```
-
-```ruby
-# Use a completely custom logging instance
-Prosopite.custom_logger = MyLoggerClass.new
-
-```
-
 ## Development Environment Usage
 
 Prosopite auto-detection can be enabled on all controllers:
@@ -174,7 +154,7 @@ config.after_initialize do
   Prosopite.rails_logger = true
 end
 ```
-
+```
 ## Test Environment Usage
 
 Tests with N+1 queries can be configured to fail with:
@@ -315,6 +295,77 @@ Pauses can be ignored with `Prosopite.ignore_pauses = true` in case you want to
 An example of when you might use this is if you are [testing Active Jobs inline](https://guides.rubyonrails.org/testing.html#testing-jobs),
 and don't want to run Prosopite on background job code, just foreground app code. In that case you could write an [Active Job callback](https://edgeguides.rubyonrails.org/active_job_basics.html#callbacks) that pauses the scan while the job is running.
 
+## Local Raise
+
+In some cases you may want to configure prosopite to not raise by default and only raise in certain scenarios.
+In this example we scan on all controllers but also provide an API to only raise on specific actions.
+
+```ruby
+Proposite.raise = false
+```
+
+```ruby
+# app/controllers/application_controller.rb
+class ApplicationController < ActionController::Base
+  def raise_on_n_plus_ones!(**options)
+    return if Rails.env.production?
+
+    prepend_around_action(:_raise_on_n_plus_ones, **options)
+  end
+
+  unless Rails.env.production?
+    around_action :n_plus_one_detection
+
+    def n_plus_one_detection
+      ...
+    end
+
+    def _raise_on_n_plus_ones
+      Proposite.start_raise
+      yield
+    ensure
+      Prosopite.stop_raise
+    end
+  end
+end
+```
+```ruby
+# app/controllers/books_controller.rb
+class BooksController < ApplicationController
+  raise_on_n_plus_ones!(only: [:index])
+
+  def index
+    @books = Book.all.map(&:author) # This will raise N+1 errors
+  end
+
+  def show
+    @book = Book.find(params[:id])
+    @book.reviews.map(&:author) # This will not raise N+1 errors
+  end
+end
+
+## Custom Logging Configuration
+
+You can supply a custom logger with the `Prosopite.custom_logger` setting.
+
+This is useful for circumstances where you don't want your logs to be
+highlighted with red, or you want logs sent to a custom location.
+
+One common scenario is that you may be generating json logs and sending them to
+Datadog, ELK stack, or similar, and don't want to have to remove the default red
+escaping data from messages sent to the Rails logger, or want to tag them
+differently with your own custom logger.
+
+```ruby
+# Turns off logging with red highlights, but still sends them to the Rails logger
+Prosopite.custom_logger = Rails.logger
+```
+
+```ruby
+# Use a completely custom logging instance
+Prosopite.custom_logger = MyLoggerClass.new
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/charkost/prosopite.

data/lib/prosopite/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Prosopite
-  VERSION = "1.4.2"
+  VERSION = "2.1.0"
 end

data/lib/prosopite.rb

@@ -113,6 +113,22 @@ module Prosopite
       tc[:prosopite_query_caller] = nil
     end
 
+    def start_raise
+      tc[:prosopite_local_raise] = true
+    end
+
+    def stop_raise
+      tc[:prosopite_local_raise] = false
+    end
+
+    def local_raise?
+      tc[:prosopite_local_raise] == true
+    end
+
+    def raise?
+      local_raise? || !!@raise
+    end
+
     def create_notifications
       tc[:prosopite_notifications] = {}
 
@@ -144,7 +160,12 @@ module Prosopite
     end
 
     def fingerprint(query)
-      db_adapter = ActiveRecord::Base.connection.adapter_name.downcase
+      conn = if ActiveRecord::Base.respond_to?(:lease_connection)
+               ActiveRecord::Base.lease_connection
+             else
+               ActiveRecord::Base.connection
+             end
+      db_adapter = conn.adapter_name.downcase
       if db_adapter.include?('mysql') || db_adapter.include?('trilogy')
         mysql_fingerprint(query)
       else
@@ -212,9 +233,8 @@ module Prosopite
       @rails_logger ||= false
       @stderr_logger ||= false
       @prosopite_logger ||= false
-      @raise ||= false
 
-      notifications_str = ''
+      notifications_str = String.new('')
 
       tc[:prosopite_notifications].each do |queries, kaller|
         notifications_str << "N+1 queries detected:\n"
@@ -241,7 +261,7 @@ module Prosopite
         end
       end
 
-      raise NPlusOneQueriesError.new(notifications_str) if @raise
+      raise NPlusOneQueriesError.new(notifications_str) if raise?
     end
 
     def red(str)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prosopite
 version: !ruby/object:Gem::Version
-  version: 1.4.2
+  version: 2.1.0
 platform: ruby
 authors:
 - Mpampis Kostas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-12-14 00:00:00.000000000 Z
+date: 2025-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -148,7 +148,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.5.3
 signing_key: 
 specification_version: 4
 summary: N+1 auto-detection for Rails with zero false positives / false negatives