prosopite 1.0.5 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a80a80552bf3cde44c5364bb227937e151b53926b011be7179b48c6cc71696c0
-  data.tar.gz: 177fdf84e5340fe4d3435e93aeadbf44229678fe3316713ce3771793bbe69935
+  metadata.gz: 77276ce50263c0d9e2e4a9e0c525924ac5810367f036d783197222819f8fb312
+  data.tar.gz: b43868ebc87b40d97997db1c7a77fb3ee34cb032a76a0b290adb174c8d04c6d3
 SHA512:
-  metadata.gz: c23f05d4f8e76c8f99bd59e963a61952b245f72b44148fb8f3ec8a85a49f8fbceec17517328dc3409d1d3987a07f57de5e278365be3fb4ff526a32c8e59c0163
-  data.tar.gz: 586d95eae04d1a25c61c42760a11a870dfdab79cd81339aff4b2220f347aa6dbab33c4fda2a0cb023a72bf97058a3017a32a56fb0f7e787ddad38c88f9eaf364
+  metadata.gz: 5fc318b3becb5095f93244d8e23699c27e604c43ba7a3dc489ee3939d19b23e26a47eb4957d6355f28fdaa18fb6ecaa2caf27721a03fcadadefa73a5cbcfec7e
+  data.tar.gz: e5954aa6aec45c26722f807dcb2fde6aae4c1090d097cc7172a306cdde9639b734d226826fa1d6dcab59a9d22857dc7901978eb4297287ac49b81a63b23ae0e1

data/Gemfile.lock

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

data/README.md

@@ -182,7 +182,13 @@ WARNING: scan/finish should run before/after **each** test and NOT before/after
 Ignore notifications for call stacks containing one or more substrings:
 
 ```ruby
-Prosopite.allow_list = ['substring_in_call_stack']
+Prosopite.allow_stack_paths = ['substring_in_call_stack']
+```
+
+Ignore notifications matching a specific SQL query:
+
+```ruby
+Prosopite.ignore_queries = [/regex_match/, "SELECT * from EXACT_STRING_MATCH"]
 ```
 
 ## Scanning code outside controllers or tests

data/lib/prosopite/version.rb

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

data/lib/prosopite.rb

@@ -8,7 +8,14 @@ module Prosopite
                 :stderr_logger,
                 :rails_logger,
                 :prosopite_logger,
-                :allow_list
+                :allow_stack_paths,
+                :ignore_queries
+
+    def allow_list=(value)
+      puts "Prosopite.allow_list= is deprecated. Use Prosopite.allow_stack_paths= instead."
+
+      self.allow_stack_paths = value
+    end
 
     def scan
       tc[:prosopite_scan] ||= false
@@ -20,7 +27,7 @@ module Prosopite
       tc[:prosopite_query_holder] = Hash.new { |h, k| h[k] = [] }
       tc[:prosopite_query_caller] = {}
 
-      @allow_list ||= []
+      @allow_stack_paths ||= []
 
       tc[:prosopite_scan] = true
 
@@ -75,8 +82,9 @@ module Prosopite
           next unless fingerprints.uniq.size == 1
 
           kaller = tc[:prosopite_query_caller][location_key]
+          allow_list = (@allow_stack_paths + DEFAULT_ALLOW_LIST)
+          is_allowed = kaller.any? { |f| allow_list.any? { |s| f.include?(s) } }
 
-          is_allowed = kaller.any? { |f| (@allow_list + DEFAULT_ALLOW_LIST).any? { |s| f.include?(s) } }
           unless is_allowed
             queries = tc[:prosopite_query_holder][location_key]
             tc[:prosopite_notifications][queries] = kaller
@@ -180,6 +188,11 @@ module Prosopite
       str.split("\n").map { |line| "\e[91m#{line}\e[0m" }.join("\n")
     end
 
+    def ignore_query?(sql)
+      @ignore_queries ||= []
+      @ignore_queries.any? { |q| q === sql }
+    end
+
     def subscribe
       @subscribed ||= false
       return if @subscribed
@@ -187,7 +200,7 @@ module Prosopite
       ActiveSupport::Notifications.subscribe 'sql.active_record' do |_, _, _, _, data|
         sql, name = data[:sql], data[:name]
 
-        if scan? && name != "SCHEMA" && sql.include?('SELECT') && data[:cached].nil?
+        if scan? && name != "SCHEMA" && sql.include?('SELECT') && data[:cached].nil? && !ignore_query?(sql)
           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.5
+  version: 1.0.6
 platform: ruby
 authors:
 - Mpampis Kostas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-11 00:00:00.000000000 Z
+date: 2021-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry