prosopite 1.0.8 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1af17b69a330a3d3f6671044a52767af5f93c6245c24f8f690320bf70b863b5f
-  data.tar.gz: 3abb664fad375de93c92f909e42bcc68d89287271b9be57d85a1c1f9cb561cba
+  metadata.gz: 56e92147fb7087e1f4248449f64fa9a1e991c1d3646f71e54d74f72f2ccc98c9
+  data.tar.gz: c77c7bc6e0b856de8d634f331b9e8cc56f79359921258ba3a033b374c673b4f8
 SHA512:
-  metadata.gz: acdecfb19aff6229c9ec15dd62794b786caf21e30a96d5c8a0038412b1805938217f70380d7501054721f8a716ff40c883b12d21e888befcf434f6a503d2cf99
-  data.tar.gz: 5d71d8b945b92e3db0a3f9993217ab85a363b5e259134f95be03bb214e8ffdb9bd9e814983104571e698dcb1863f9bb9e3ec89bf0246ebdfbc8d15c75fa9a3b9
+  metadata.gz: b5da98b794a360629a55c940dfb73972acc2a4871840fc5577abf346e9fd31d4077dfdc27b874c86ce1aeed179246ae74e47082aa8bf893083327e347df8020e
+  data.tar.gz: d74e37b39e303c552e087d53dd3aee596ad441d62a2ae6d48f166c0d2452eab01925639b26c0980e1d697dcd6c05d1c9cae7da8484e159ec27355c2cc8a294fb

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    prosopite (1.0.8)
+    prosopite (1.1.2)
 
 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
 
@@ -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.8"
+  VERSION = "1.1.2"
 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
@@ -46,7 +48,17 @@ module Prosopite
     end
 
     def pause
-      tc[:prosopite_scan] = false
+      if block_given?
+        begin
+          previous = tc[:prosopite_scan]
+          tc[:prosopite_scan] = false
+          yield
+        ensure
+          tc[:prosopite_scan] = previous
+        end
+      else
+        tc[:prosopite_scan] = false
+      end
     end
 
     def resume
@@ -155,6 +167,7 @@ module Prosopite
     end
 
     def send_notifications
+      @custom_logger ||= false
       @rails_logger ||= false
       @stderr_logger ||= false
       @prosopite_logger ||= false
@@ -172,6 +185,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.8
+  version: 1.1.2
 platform: ruby
 authors:
 - Mpampis Kostas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-25 00:00:00.000000000 Z
+date: 2022-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry