prosopite 1.0.7 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77b0146b180d4bf96cf36dc03c4579f44b7e8aff4693742bfcce6321057027b2
-  data.tar.gz: 8203dc334b5787907b5d1d25a29927b228f51c62d3814edfacd22424f0a9d20f
+  metadata.gz: 5e7209ed5070fd604f22b0e2a6c0256cf3e30bdc9492403f9c427edef00e5a3c
+  data.tar.gz: 75bd921fee0f39354db2fd7a4136f4c32387bd7b2373b5fc34028340105de9e8
 SHA512:
-  metadata.gz: 07ec42c20dc33120d6ae393f9272aa9bce89d0c18e29544ddbf9d6da02688b110d85700b4d9913ca1abcb6468f0eb57ba1259ff7990ec80f2600e02321845f63
-  data.tar.gz: c8194ba025357e7afba769c163fad93cc2dfc1adf489d497acc9c94efdd5f50949b724517e8d9032b1e7267e3c4075c51ed67e4a6a63de5139ed284b7277fb51
+  metadata.gz: 2c393693a5477df4f7e1615c7d67c71cf77b060deb62a8b47e771604b5af5f2a52bcea1639c345173f50d1d11decc263522565cab89a64bea4974a08c6770d8e
+  data.tar.gz: 7eaece0588d418afb0fecc543b697ca3261567d1bed34e549b826800c2861f7be854999accac0b46e96a7bf7a24b00ea5e6485218b566456bfe76bfb7b3b20c6

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.7)
+    prosopite (1.1.1)
 
 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,11 +225,19 @@ Prosopite.scan
 Prosopite.finish
 ```
 
-or 
+In block form the `Prosopite.finish` is called automatically for you at the end of the block:
 
 ```ruby
 Prosopite.scan do
-<code to scan>
+  <code to scan>
+end
+```
+
+The result of the code block is also returned by `Prosopite.scan`, so you can wrap calls as follows:
+
+```ruby
+my_object = Prosopite.scan do
+  MyObjectFactory.create(params)
 end
 ```
 
@@ -223,6 +255,20 @@ Prosopite.resume
 Prosopite.finish
 ```
 
+You can also pause items in a block, and the `Prosopite.resume` will be done
+for you automatically:
+
+```ruby
+Prosopite.scan
+# <code to scan>
+
+result = Prosopite.pause do
+  # <code that has n+1s>
+end
+
+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.
 

data/lib/prosopite/version.rb

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

data/lib/prosopite.rb

@@ -8,6 +8,7 @@ module Prosopite
                 :stderr_logger,
                 :rails_logger,
                 :prosopite_logger,
+                :custom_logger,
                 :allow_stack_paths,
                 :ignore_queries
 
@@ -33,8 +34,9 @@ module Prosopite
 
       if block_given?
         begin
-          yield
+          block_result = yield
           finish
+          block_result
         ensure
           tc[:prosopite_scan] = false
         end
@@ -47,6 +49,14 @@ module Prosopite
 
     def pause
       tc[:prosopite_scan] = false
+
+      if block_given?
+        begin
+          yield
+        ensure
+          tc[:prosopite_scan] = true
+        end
+      end
     end
 
     def resume
@@ -83,7 +93,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 +165,7 @@ module Prosopite
     end
 
     def send_notifications
+      @custom_logger ||= false
       @rails_logger ||= false
       @stderr_logger ||= false
       @prosopite_logger ||= false
@@ -172,6 +183,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.7
+  version: 1.1.1
 platform: ruby
 authors:
 - Mpampis Kostas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-20 00:00:00.000000000 Z
+date: 2022-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry