debug_logging 3.1.1 → 3.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a39fc11d3fc815e37db037fd9ce8b08e74e5d98e7612a50f191231ba3ce95231
-  data.tar.gz: 99ef91cf9302dfc413ebba74435464933524cfa1a2e70f9623b97ff64c849729
+  metadata.gz: 434bf02e4e2e51b0ae6ffb99e4d5174d212a2337744e1fd7697d66d804ccc062
+  data.tar.gz: efb30cc90b8d325da9511f6899378b790916ad671af4b69df1b6171aa9cda80e
 SHA512:
-  metadata.gz: 22ec37827bdf34889a023d235315ee4ca85642cdc070a22751be328f58c8f4b8b22c952da52c2d6900f3bc44431d8d0dd5800483419532f3fd5a5aca9227d529
-  data.tar.gz: 5b5456b83dfff252840e31ea81af17e5d3b50bdc025e090d55731fcd16353d41352b2304ba53818c791f9ec3970a447e4b01624fd269d6663951a444a876ac6d
+  metadata.gz: 99ec10ad80d3caca7a1092365774530b017a15276515f06b610dfd39e0e3e7f9883f59489d53ac2162b36e6c39371eb115b588524c8c9ed2cd4355b30a61bd89
+  data.tar.gz: 9af78b97aed63a43e63c27e998d9c713ece75825bcc91b6be704cf757a289c43b96a106d5ef5bff2783828dfac3bd4d48ae110fcfd3841fb556c88cb64bb9108

data/.rubocop.yml

@@ -1,3 +1,11 @@
+inherit_from: .rubocop_todo.yml
+
+require:
+  - 'rubocop-md'
+  - 'rubocop-performance'
+  - 'rubocop-rake'
+  - 'rubocop-rspec'
+
 AllCops:
   NewCops: enable
 

data/.rubocop_todo.yml

@@ -1,89 +1,134 @@
-inherit_from: .rubocop.yml
-
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2020-10-06 07:34:51 UTC using RuboCop version 0.92.0.
+# on 2020-12-10 04:35:55 UTC using RuboCop version 1.6.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 1
-# Configuration parameters: Include.
-# Include: **/*.gemspec
-Gemspec/RequiredRubyVersion:
+# Offense count: 7
+Lint/DuplicateMethods:
   Exclude:
-    - 'debug_logging.gemspec'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBraces, SpaceBeforeBlockParameters.
-# SupportedStyles: space, no_space
-# SupportedStylesForEmptyBraces: space, no_space
-Layout/SpaceInsideBlockBraces:
-  Exclude:
-    - 'lib/debug_logging/argument_printer.rb'
+    - 'README.md'
 
-# Offense count: 5
-# Configuration parameters: IgnoredMethods.
+# Offense count: 6
+# Configuration parameters: IgnoredMethods, CountRepeatedAttributes.
 Metrics/AbcSize:
-  Max: 97
+  Max: 96
 
-# Offense count: 38
-# Configuration parameters: CountComments, CountAsOne, ExcludedMethods.
-# ExcludedMethods: refine
+# Offense count: 58
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
+# IgnoredMethods: refine
 Metrics/BlockLength:
-  Max: 810
+  Max: 851
 
 # Offense count: 6
 # Configuration parameters: CountBlocks.
 Metrics/BlockNesting:
   Max: 4
 
-# Offense count: 1
-# Configuration parameters: CountComments, CountAsOne.
-Metrics/ClassLength:
-  Max: 101
-
 # Offense count: 4
 # Configuration parameters: IgnoredMethods.
 Metrics/CyclomaticComplexity:
-  Max: 22
+  Max: 24
 
-# Offense count: 11
-# Configuration parameters: CountComments, CountAsOne, ExcludedMethods.
+# Offense count: 15
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
 Metrics/MethodLength:
-  Max: 50
+  Max: 75
 
-# Offense count: 1
+# Offense count: 2
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ModuleLength:
   Max: 112
 
-# Offense count: 4
+# Offense count: 5
 # Configuration parameters: IgnoredMethods.
 Metrics/PerceivedComplexity:
-  Max: 26
+  Max: 31
 
-# Offense count: 1
-# Configuration parameters: AllowedChars.
-Style/AsciiComments:
+# Offense count: 3
+# Configuration parameters: EnforcedStyleForLeadingUnderscores.
+# SupportedStylesForLeadingUnderscores: disallowed, required, optional
+Naming/MemoizedInstanceVariableName:
   Exclude:
     - 'lib/debug_logging/configuration.rb'
 
+# Offense count: 60
+# Configuration parameters: Prefixes.
+# Prefixes: when, with, without
+RSpec/ContextWording:
+  Exclude:
+    - 'spec/debug_logging/class_logger_spec.rb'
+    - 'spec/debug_logging/class_notifier_spec.rb'
+    - 'spec/debug_logging/configuration_spec.rb'
+    - 'spec/debug_logging/instance_logger_spec.rb'
+    - 'spec/debug_logging/instance_notifier_spec.rb'
+    - 'spec/debug_logging_spec.rb'
+
+# Offense count: 46
+# Configuration parameters: Max.
+RSpec/ExampleLength:
+  Exclude:
+    - 'spec/debug_logging/class_logger_spec.rb'
+    - 'spec/debug_logging/class_notifier_spec.rb'
+    - 'spec/debug_logging/configuration_spec.rb'
+    - 'spec/debug_logging/instance_logger_spec.rb'
+    - 'spec/debug_logging/instance_notifier_spec.rb'
+    - 'spec/debug_logging/log_subscriber_spec.rb'
+    - 'spec/debug_logging_spec.rb'
+
+# Offense count: 53
+# Configuration parameters: AssignmentOnly.
+RSpec/InstanceVariable:
+  Exclude:
+    - 'spec/debug_logging/class_notifier_spec.rb'
+    - 'spec/debug_logging/instance_notifier_spec.rb'
+    - 'spec/debug_logging/log_subscriber_spec.rb'
+
+# Offense count: 4
+RSpec/LeakyConstantDeclaration:
+  Exclude:
+    - 'spec/debug_logging/configuration_spec.rb'
+
+# Offense count: 23
+# Configuration parameters: .
+# SupportedStyles: have_received, receive
+RSpec/MessageSpies:
+  EnforcedStyle: receive
+
+# Offense count: 80
+RSpec/MultipleExpectations:
+  Max: 32
+
 # Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SingleLineConditionsOnly, IncludeTernaryExpressions.
-# SupportedStyles: assign_to_condition, assign_inside_condition
-Style/ConditionalAssignment:
+# Configuration parameters: AllowSubject.
+RSpec/MultipleMemoizedHelpers:
+  Max: 10
+
+# Offense count: 27
+RSpec/NestedGroups:
+  Max: 5
+
+# Offense count: 1
+# Configuration parameters: IgnoreNameless, IgnoreSymbolicNames.
+RSpec/VerifiedDoubles:
   Exclude:
-    - 'lib/debug_logging/argument_printer.rb'
+    - 'spec/support/shared_context.rb'
+
+# Offense count: 1
+# Configuration parameters: AllowedChars.
+Style/AsciiComments:
+  Exclude:
+    - '**/*.md'
+    - '**/*.markdown'
+    - 'lib/debug_logging/configuration.rb'
 
-# Offense count: 9
+# Offense count: 13
 Style/Documentation:
   Exclude:
-    - 'spec/**/*'
-    - 'test/**/*'
+    - '**/*.md'
+    - '**/*.markdown'
     - 'lib/debug_logging.rb'
     - 'lib/debug_logging/argument_printer.rb'
     - 'lib/debug_logging/class_logger.rb'
@@ -96,7 +141,7 @@ Style/Documentation:
     - 'lib/debug_logging/log_subscriber.rb'
     - 'lib/simple_debug_logging.rb'
 
-# Offense count: 1
+# Offense count: 2
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle.
 # SupportedStyles: empty, nil, both
@@ -105,14 +150,7 @@ Style/EmptyElse:
     - 'lib/debug_logging/class_logger.rb'
     - 'lib/debug_logging/class_notifier.rb'
 
-# Offense count: 2
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: annotated, template, unannotated
-Style/FormatStringToken:
-  Exclude:
-    - 'lib/debug_logging/argument_printer.rb'
-
-# Offense count: 4
+# Offense count: 8
 Style/IdenticalConditionalBranches:
   Exclude:
     - 'lib/debug_logging/class_logger.rb'
@@ -120,14 +158,10 @@ Style/IdenticalConditionalBranches:
     - 'lib/debug_logging/instance_logger_modulizer.rb'
     - 'lib/debug_logging/instance_notifier_modulizer.rb'
 
-# Offense count: 1
-Style/MultilineBlockChain:
-  Exclude:
-    - 'lib/debug_logging/argument_printer.rb'
-
-# Offense count: 95
+# Offense count: 67
 # Cop supports --auto-correct.
 # Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
+# IgnoredPatterns: (?-mix:^\#)
 Layout/LineLength:
-  Max: 223
+  Max: 207

data/.travis.yml

@@ -9,7 +9,7 @@ before_script:
   - ./cc-test-reporter before-build
 
 script:
-  - bundle exec rubocop -DESP --config ./.rubocop_todo.yml
+  - bundle exec rubocop -DESP
   - bundle exec rspec
 
 after_script:
@@ -33,4 +33,4 @@ rvm:
   - ruby-2.4.10
   - ruby-2.5.8
   - ruby-2.6.6
-  - ruby-2.7.1
+  - ruby-2.7.2

data/README.md

@@ -1,6 +1,7 @@
 # DebugLogging
 
 Unobtrusive, inheritable-overridable-configurable, drop-in debug logging, that won't leave a mess behind when it is time to remove it.
+Supports ActiveSupport::Notifications (thanks [@jgillson](https://github.com/jgillson)).  Optional ActiveRecord callback-style hooks that you can decorate your methods with. Hooks logic was taken from the [`slippy_method_hooks` gem](https://github.com/guckin/slippy_method_hooks), (thanks [@guckin](https://github.com/guckin)), and prefaced with `debug_` for this implementation. `DebugLogging::Finalize` is lightly modified from [this stackoverflow answer](https://stackoverflow.com/a/34559282).
 
 ## What do I mean by "unobtrusive"?
 
@@ -32,12 +33,16 @@ Unobtrusive, inheritable-overridable-configurable, drop-in debug logging, that w
 * *colorization by class/method*
 * *robust argument printer with customizable ellipsis*
 * *unique invocation identifiers*
-* *single line config, per class/instance/method config*
-* *separate logger, if needed*
+* *simple single line global config, or per class/instance/method config*
+* *separate loggers, if needed*
 * *log method calls, also when exit scope*
 * *Prevents heavy computation of strings with `logger.debug { 'log me' }` block format, since v1.0.12*
-* *ActiveSupport::Notifications integration for instrumenting/logging events on class and instance methods, since v3.1*
-* *Optional instance variable logging, sine v3.1*
+* *ActiveSupport::Notifications integration for instrumenting/logging events on class and instance methods, since v3.1.3*
+* *Optional instance, and class-instance, variable logging, since v3.1.3*
+* *ActiveRecord style callback-hooks (optional: `require 'debug_logging/hooks'` and `include DebugLogging::Hooks`), since v3.1.3*
+* *All configuration is inheritable to, and overridable by, child classes, since v3.1.3*
+* *[Class finalization hook](https://stackoverflow.com/a/34559282) (optional: `require 'debug_logging/finalize'` and `extend DebugLogging::Finalize`), since v3.1.3*
+* *Error handling hooks you can use to log problems when they happen, since v3.1.7*
 * **so many free ponies** 🎠🐴🎠🐴🎠🐴
 
 ## Next Level Magic
@@ -46,8 +51,10 @@ Herein you will find:
 
 * Classes inheriting from Module
 * Zero tolerance policy on monkey patching
+  * When the gem is loaded there are no monkey patches.
+  * Rather, your own classes/methods get "patched" and "hooked" as you configure them.
 * 100% clean, 0% obtrusive
-* 100% tested
+* ~100% tested
 * 100% Ruby 2.1+ compatible
   - use version `gem "debug_logging", "~> 1.0"` for Ruby < 2.3
   - use version `gem "debug_logging", "~> 2.0"` for Ruby 2.3
@@ -86,11 +93,12 @@ Recommend creating `config/initializers/debug_logging.rb`, or adding to `config/
 
 ```ruby
 # Showing the defaults
-DebugLogging.configuration.logger = Logger.new(STDOUT) # you probably want to override to be the Rails.logger, and if so you can't set it in the initializer, as it needs to be set after Rails.logger is set.
+DebugLogging.configuration.logger = Logger.new($stdout) # you probably want to override to be the Rails.logger, and if so you can't set it in the initializer, as it needs to be set after Rails.logger is set.
 DebugLogging.configuration.log_level = :debug # at what level do the messages created by this gem sent at?
 DebugLogging.configuration.multiple_last_hashes = false # pass every hash argument to last_hash_to_s_proc?
 DebugLogging.configuration.last_hash_to_s_proc = nil # e.g. ->(hash) { "keys: #{hash.keys}" }
 DebugLogging.configuration.last_hash_max_length = 1_000
+DebugLogging.configuration.args_to_s_proc = nil # e.g. ->(record) { "record id: #{record.id}" }
 DebugLogging.configuration.args_max_length = 1_000
 DebugLogging.configuration.instance_benchmarks = false
 DebugLogging.configuration.class_benchmarks = false
@@ -98,19 +106,23 @@ DebugLogging.configuration.active_support_notifications = false
 DebugLogging.configuration.colorized_chain_for_method = false # e.g. ->(colorized_string) { colorized_string.red.on_blue.underline }
 DebugLogging.configuration.colorized_chain_for_class = false # e.g. ->(colorized_string) { colorized_string.colorize(:light_blue ).colorize( :background => :red) }
 DebugLogging.configuration.add_invocation_id = true # identify a method call uniquely in a log, pass a proc for colorization, e.g. ->(colorized_string) { colorized_string.light_black }
-DebugLogging.configuration.ellipsis = " ✂️ …".freeze
+DebugLogging.configuration.ellipsis = ' ✂️ …'.freeze
 DebugLogging.configuration.mark_scope_exit = true # Only has an effect if benchmarking is off, since benchmarking always marks the scope exit
+DebugLogging.configuration.add_payload = false # or a proc which will be called to print the payload
+DebugLogging.configuration.payload_max_length = 1000
+DebugLogging.configuration.error_handler_proc = nil # e.g. ->(error, config, obj) { config.log { "#{error.class}: #{error.message}\n#{obj.errors.inspect}" } }
 ```
 
 If you prefer to use the block style:
 
 ```ruby
 DebugLogging.configure do |config|
-  config.logger = Logger.new(STDOUT) # probably want to override to be the Rails.logger, and if so you can't set it in the initializer, as it needs to be set after Rails.logger is set.
+  config.logger = Logger.new($stdout) # probably want to override to be the Rails.logger, and if so you can't set it in the initializer, as it needs to be set after Rails.logger is set.
   config.log_level = :debug # at what level do the messages created by this gem sent at?
   config.multiple_last_hashes = false # pass every hash argument to last_hash_to_s_proc?
   config.last_hash_to_s_proc = nil # e.g. ->(hash) { "keys: #{hash.keys}" }
   config.last_hash_max_length = 1_000
+  config.args_to_s_proc = nil # e.g. ->(record) { "record id: #{record.id}" }
   config.args_max_length = 1_000
   config.instance_benchmarks = false
   config.class_benchmarks = false
@@ -118,8 +130,11 @@ DebugLogging.configure do |config|
   config.colorized_chain_for_method = false # e.g. ->(colorized_string) { colorized_string.red.on_blue.underline }
   config.colorized_chain_for_class = false # e.g. ->(colorized_string) { colorized_string.colorize(:light_blue ).colorize( :background => :red) }
   config.add_invocation_id = true # identify a method call uniquely in a log, pass a proc for colorization, e.g. ->(colorized_string) { colorized_string.light_black }
-  config.ellipsis = " ✂️ …".freeze
+  config.ellipsis = ' ✂️ …'.freeze
   config.mark_scope_exit = true # Only has an effect if benchmarking is off, since benchmarking always marks the scope exit
+  config.add_payload = false # or a proc which will be called to print the payload
+  config.payload_max_length = 1000
+  config.error_handler_proc = nil # e.g. ->(error, config, obj) { config.log { "#{error.class}: #{error.message}\n#{obj.errors.inspect}" } }
 end
 ```
 
@@ -160,10 +175,20 @@ class Car
   # == BEGIN CLASS METHODS ==
   # For class methods:
   # Option 1: Use *logged* as a method decorator
-  logged def self.make; new; end
-  def self.design(*args); new; end
-  def self.safety(*args); new; end
-  def self.dealer_options(*args); new; end
+  logged def self.make
+    new
+  end
+  def self.design(*_args)
+    new
+  end
+
+  def self.safety(*_args)
+    new
+  end
+
+  def self.dealer_options(*_args)
+    new
+  end
 
   # Option 2: Use *logged* as a macro
   logged :design, :safety
@@ -174,29 +199,40 @@ class Car
     something: 'here', # <= will be logged, and available to last_hash_to_s_proc
     multiple_last_hashes: true # <= Overrides config
   }
-  def self.will_not_be_logged; false; end
+  def self.will_not_be_logged
+    false
+  end
   # == END CLASS METHODS ==
 
   # == BEGIN INSTANCE METHODS ==
   # For instance methods:
   # Option 1: specify the exact method(s) to add logging to
-  include DebugLogging::InstanceLogger.new(i_methods: [:drive, :stop])
+  include DebugLogging::InstanceLogger.new(i_methods: %i[drive stop])
 
-  def drive(speed); speed; end
-  def stop(**opts); 0; end
+  def drive(speed)
+    speed
+  end
+
+  def stop(**_opts)
+    0
+  end
 
   # For instance methods:
   # Option 2: add logging to all instance methods defined above (but *not* defined below)
-  include DebugLogging::InstanceLogger.new(i_methods: self.instance_methods(false))
+  include DebugLogging::InstanceLogger.new(i_methods: instance_methods(false))
 
-  def faster(**opts); 0; end
+  def faster(**_opts)
+    0
+  end
 
   # Override configuration options for any instance method(s), by passing a hash as the last argument
   # In the last hash any non-Configuration keys will be data that gets logged,
   #     and also made available to last_hash_to_s_proc
   include DebugLogging::InstanceLogger.new(i_methods: [:faster], config: { add_invocation_id: false })
 
-  def will_not_be_logged; false; end
+  def will_not_be_logged
+    false
+  end
   # == END INSTANCE METHODS ==
 end
 ```
@@ -242,10 +278,20 @@ class Car
   # == BEGIN CLASS METHODS ==
   # For class methods:
   # Option 1: Use *notifies* as a method decorator
-  notifies def self.make; new; end
-  def self.design(*args); new; end
-  def self.safety(*args); new; end
-  def self.dealer_options(*args); new; end
+  notifies def self.make
+    new
+  end
+  def self.design(*_args)
+    new
+  end
+
+  def self.safety(*_args)
+    new
+  end
+
+  def self.dealer_options(*_args)
+    new
+  end
 
   # Option 2: Use *logged* as a macro
   notifies :design, :safety
@@ -256,25 +302,36 @@ class Car
     something: 'here', # <= will be added to the event payload, and be available to last_hash_to_s_proc
     add_invocation_id: false # <= Overrides config
   }
-  def self.will_not_be_notified; false; end
+  def self.will_not_be_notified
+    false
+  end
   # == END CLASS METHODS ==
 
   # == BEGIN INSTANCE METHODS ==
-  def drive(speed); speed; end
-  def stop(**opts); 0; end
+  def drive(speed)
+    speed
+  end
+
+  def stop(**_opts)
+    0
+  end
 
   # For instance methods:
   # Option 2: add instrumentation to all instance methods defined above (but *not* defined below)
-  include DebugLogging::InstanceNotifier.new(i_methods: self.instance_methods(false))
+  include DebugLogging::InstanceNotifier.new(i_methods: instance_methods(false))
 
-  def faster(**opts); 0; end
+  def faster(**_opts)
+    0
+  end
 
   # Override options for any instance method(s), by passing a hash as the last argument
   # In the last hash any non-Configuration keys will be data that gets added to the event payload,
   #     and also made available to last_hash_to_s_proc
   include DebugLogging::InstanceNotifier.new(i_methods: [:faster], config: { add_invocation_id: false })
 
-  def will_not_be_notified; false; end
+  def will_not_be_notified
+    false
+  end
   # == END INSTANCE METHODS ==
 end
 ```
@@ -339,6 +396,10 @@ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
+### License Exceptions
+
+* [`debug_logging/finalize`](https://stackoverflow.com/a/34559282) is licensed under https://creativecommons.org/licenses/by-sa/4.0/
+
 [semver]: http://semver.org/
 [pvc]: http://docs.rubygems.org/read/chapter/16#page74
 [railsbling]: http://www.railsbling.com