prosopite 1.0.0 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3df6a0299972911e48ea44330995864e2cd2191ec66c199296ba324a5fa8e639
-  data.tar.gz: 4f9ee347a8cf52fd742ee66586c7e4b601c8436a4bcabe1b1afdef5e09293f44
+  metadata.gz: 66728f096f4aafd32cf868f6b24ce88daae9d282b21d2c8b95ed0b732a299d2c
+  data.tar.gz: 4259b7a737bc367742efc158d425a57c1e24c435991f3ad4bd57dbd7a6c195d4
 SHA512:
-  metadata.gz: 668bc7e58bcabd77231adc831054d56ca572e1e9857f87736d1fd06048c1eeaac9c0c0ab970c6ed6f8ce70670ae51277c3c4f56012d0ec61240c0e728c1f3795
-  data.tar.gz: '0341920f4f1beddc2b9c46553f9284724ecddfe50f30579a7cc9627c93fdf2d3c714bb57fd453dd7a4783a86951b9dd2cb0a79e721189bce3b89eda0c119c8bf'
+  metadata.gz: 3fc7f6c647ebfcbce614c0ef7c51a2e9a69b6da7090d889e65dd535891c93a33b07e4228f2d877951a26a06f8bd53687567bf86fed2b77f9558b84a0c24eaa4f
+  data.tar.gz: 139a0047ea3aed0f99a0900bf8c2bf235d5fe1723563859c85bd887daae96a8d65c2b21e5f9ad350384de6424c2ef8a3f7ea1df9d66d8bfb33af2009133f0eb4

data/Gemfile.lock

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

data/README.md

@@ -127,11 +127,12 @@ Prosopite auto-detection can be enabled on all controllers:
 ```ruby
 class ApplicationController < ActionController::Base
   unless Rails.env.production?
-    before_action do
+    around_action :n_plus_one_detection
+    
+    def n_plus_one_detection
       Prosopite.scan
-    end
-
-    after_action do
+      yield
+    ensure
       Prosopite.finish
     end
   end
@@ -194,6 +195,31 @@ Prosopite.scan
 Prosopite.finish
 ```
 
+or 
+
+```ruby
+Prosopite.scan do
+<code to scan>
+end
+```
+
+## Pausing and resuming scans
+
+Scans can be paused:
+
+```ruby
+Prosopite.scan
+# <code to scan>
+Prosopite.pause
+# <code that has n+1s>
+Prosopite.resume
+# <code to scan>
+Prosopite.finish
+```
+
+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.
+
 ## 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.0.0"
+  VERSION = "1.0.4"
 end

data/lib/prosopite.rb

@@ -1,5 +1,7 @@
 
 module Prosopite
+  DEFAULT_ALLOW_LIST = %w(active_record/associations/preloader active_record/validations/uniqueness)
+
   class NPlusOneQueriesError < StandardError; end
   class << self
     attr_writer :raise,
@@ -21,12 +23,29 @@ module Prosopite
       @allow_list ||= []
 
       tc[:prosopite_scan] = true
+
+      if block_given?
+        begin
+          yield
+          finish
+        ensure
+          tc[:prosopite_scan] = false
+        end
+      end
     end
 
     def tc
       Thread.current
     end
 
+    def pause
+      tc[:prosopite_scan] = false
+    end
+
+    def resume
+      tc[:prosopite_scan] = true
+    end
+
     def scan?
       tc[:prosopite_scan]
     end
@@ -53,14 +72,14 @@ module Prosopite
             end
           end
 
+          next unless fingerprints.uniq.size == 1
+
           kaller = tc[:prosopite_query_caller][location_key]
 
-          if fingerprints.uniq.size == 1 && !kaller.any? { |f| @allow_list.any? { |s| f.include?(s) } }
+          is_allowed = kaller.any? { |f| @allow_list.concat(DEFAULT_ALLOW_LIST).any? { |s| f.include?(s) } }
+          unless is_allowed
             queries = tc[:prosopite_query_holder][location_key]
-
-            unless kaller.any? { |f| f.include?('active_record/validations/uniqueness') }
-              tc[:prosopite_notifications][queries] = kaller
-            end
+            tc[:prosopite_notifications][queries] = kaller
           end
         end
       end
@@ -105,7 +124,7 @@ module Prosopite
 
       query.gsub!(/\btrue\b|\bfalse\b/i, "?")
 
-      query.gsub!(/[0-9+-][0-9a-f.xb+-]*/, "?")
+      query.gsub!(/[0-9+-][0-9a-f.x+-]*/, "?")
       query.gsub!(/[xb.+-]\?/, "?")
 
       query.strip!
@@ -166,9 +185,9 @@ module Prosopite
       return if @subscribed
 
       ActiveSupport::Notifications.subscribe 'sql.active_record' do |_, _, _, _, data|
-        sql = data[:sql]
+        sql, name = data[:sql], data[:name]
 
-        if scan? && sql.include?('SELECT') && data[:cached].nil?
+        if scan? && name != "SCHEMA" && sql.include?('SELECT') && data[:cached].nil?
           location_key = Digest::SHA1.hexdigest(caller.join)
 
           tc[:prosopite_query_counter][location_key] += 1

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prosopite
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.4
 platform: ruby
 authors:
 - Mpampis Kostas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-17 00:00:00.000000000 Z
+date: 2021-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry