prosopite 1.0.6 → 1.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77276ce50263c0d9e2e4a9e0c525924ac5810367f036d783197222819f8fb312
-  data.tar.gz: b43868ebc87b40d97997db1c7a77fb3ee34cb032a76a0b290adb174c8d04c6d3
+  metadata.gz: dc0695c895e2f636c3c2a2caa2c4b211cad0f7d57f8bd4842fbc534ba9e55190
+  data.tar.gz: 2dcd4426e5b792a58cee89ec601e3388bacc97cb0de57aa3b87dd7600dd6b020
 SHA512:
-  metadata.gz: 5fc318b3becb5095f93244d8e23699c27e604c43ba7a3dc489ee3939d19b23e26a47eb4957d6355f28fdaa18fb6ecaa2caf27721a03fcadadefa73a5cbcfec7e
-  data.tar.gz: e5954aa6aec45c26722f807dcb2fde6aae4c1090d097cc7172a306cdde9639b734d226826fa1d6dcab59a9d22857dc7901978eb4297287ac49b81a63b23ae0e1
+  metadata.gz: b2c1c6a4723c44c24ab800fede6c14d49f74ba1c97c4aa60c59a231725e001ca45416abb878331157402582114e144931e39774a9af51fb422d12ba4f668403b
+  data.tar.gz: 2175b7c1bd661c5bca41c1263e9a750d63b205e548ef1d2f13ca2aac43c6306eaad3e3bb8420e627ab2576821565311c525e6b51576b4e30431c41420b3b7f0b

data/.github/workflows/ci.yml

@@ -4,7 +4,7 @@ jobs:
   test:
     strategy:
       matrix:
-        ruby: [2.5, 2.6, 2.7, '3.0', head]
+        ruby: [2.5, 2.6, 2.7, '3.0', 3.1, head]
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2

data/Gemfile.lock

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

data/README.md

@@ -115,10 +115,34 @@ Or install it yourself as:
 
 The preferred type of notifications can be configured with:
 
+* `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
+* `Prosopite.custom_logger = my_custom_logger`:
+
+### 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
 
@@ -128,7 +152,7 @@ Prosopite auto-detection can be enabled on all controllers:
 class ApplicationController < ActionController::Base
   unless Rails.env.production?
     around_action :n_plus_one_detection
-    
+
     def n_plus_one_detection
       Prosopite.scan
       yield
@@ -179,10 +203,10 @@ WARNING: scan/finish should run before/after **each** test and NOT before/after
 
 ## Allow list
 
-Ignore notifications for call stacks containing one or more substrings:
+Ignore notifications for call stacks containing one or more substrings / regex:
 
 ```ruby
-Prosopite.allow_stack_paths = ['substring_in_call_stack']
+Prosopite.allow_stack_paths = ['substring_in_call_stack', /regex/]
 ```
 
 Ignore notifications matching a specific SQL query:
@@ -201,7 +225,7 @@ Prosopite.scan
 Prosopite.finish
 ```
 
-or 
+or
 
 ```ruby
 Prosopite.scan do

data/lib/prosopite/version.rb

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

data/lib/prosopite.rb

@@ -8,6 +8,7 @@ module Prosopite
                 :stderr_logger,
                 :rails_logger,
                 :prosopite_logger,
+                :custom_logger,
                 :allow_stack_paths,
                 :ignore_queries
 
@@ -50,7 +51,7 @@ module Prosopite
     end
 
     def resume
-      tc[:prosopite_scan] = true
+      scan
     end
 
     def scan?
@@ -83,7 +84,7 @@ module Prosopite
 
           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.any? { |s| f.match?(s) } }
 
           unless is_allowed
             queries = tc[:prosopite_query_holder][location_key]
@@ -155,6 +156,7 @@ module Prosopite
     end
 
     def send_notifications
+      @custom_logger ||= false
       @rails_logger ||= false
       @stderr_logger ||= false
       @prosopite_logger ||= false
@@ -172,6 +174,8 @@ module Prosopite
         notifications_str << "\n"
       end
 
+      @custom_logger.warn(notifications_str) if @custom_logger
+
       Rails.logger.warn(red(notifications_str)) if @rails_logger
       $stderr.puts(red(notifications_str)) if @stderr_logger
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prosopite
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 1.0.9
 platform: ruby
 authors:
 - Mpampis Kostas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-19 00:00:00.000000000 Z
+date: 2022-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry