prosopite 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3fac117d558ad73ba2057f45ce8ec278898d8c1b00aec41ec9a169f76c842c02
-  data.tar.gz: ee3a372e02cb138bdbaf1770b5758693c51bdedc173ff2ca93aed20413b22245
+  metadata.gz: 79f272a757baeae3f05f7721b7204130588532ac09fb28d163d09737512f8edd
+  data.tar.gz: d45ecc27ba09f2b55447eb82f9fc35773846cf44d924b710a83eaa5ada5260a0
 SHA512:
-  metadata.gz: e49619ff0354d91b0ebade2c418ef5a2d189d68ed3f259dca8674e378366d441144a71c0ff1d615baa834c8a00d1aea60ac7be6435fdb1035da63a61fefc3731
-  data.tar.gz: a6ca678e0052bdc3cdbce19e95c88ca233162bfe45a18f87f70f2ad77e68e2c0264e18e517979356159be90ac22f103f8c4779cd5fa29766a55d72228e5e1d09
+  metadata.gz: 60cd8f6dc74fc8a51e7ada04ae53212c8965309ffbe67ad83f6e2537a289bb205a4e626e44fda4b14673aed407cf2bb706306ba0f47051d22da7a16c78f73fcb
+  data.tar.gz: 66c392a288ddbdf44bacc433740c9b6c2e7213c714e80c77992581460736300451a0f7add73196d81203a0533900424128754960ffbce6914d20c9e01cfdb8c5

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    prosopite (2.0.0)
+    prosopite (2.1.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -117,6 +117,9 @@ 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. 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`.
@@ -124,29 +127,6 @@ The preferred type of notifications can be configured with:
 * `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 = "2.0.0"
+  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] = {}
 
@@ -217,7 +233,6 @@ module Prosopite
       @rails_logger ||= false
       @stderr_logger ||= false
       @prosopite_logger ||= false
-      @raise ||= false
 
       notifications_str = String.new('')
 
@@ -246,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: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Mpampis Kostas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-02-20 00:00:00.000000000 Z
+date: 2025-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry