debug_logging 3.1.0 → 3.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: efda45f99c32dcb0acc32896a61f2d209c527cf62bd74a74282cf044607f396f
-  data.tar.gz: d4af27fc700abaa9a536d15c56af36f8a202db7c40d0107a8d8eb1262252aaeb
+  metadata.gz: 77770fe7ac99f46e73cbcbc12eeaef1ad69978ab9880ae8758758d203c9e1267
+  data.tar.gz: 9e09d725eba529f29103468581fb8718eee02946d02a97cbeb444a7df946bfc1
 SHA512:
-  metadata.gz: d857b33f90f75e8bdfb3f2deedfb5c503bd90adbabb6b9aead0ecb305ba72715c25435f9d543ff8471454b5c9c5ff631792b870a97864fdb30e530ba4c0e6fb0
-  data.tar.gz: 6985ed5caff4dbe017946a61b4f4242867110bcafcf266b62c98ce340d8af28f148b1dee364d3291296d2d5444789a429b254bedcd54bd63be28e4ce5a771b10
+  metadata.gz: e26b9a71370c7f87ffc03a202cee289a0510f9e552dba96edd7034fad32f16c6d4b83da7b64d2f4e516d81af0743b3a70f21896f9e08bd87f68c962e8aeb12b9
+  data.tar.gz: e85efa9c27319c63fc3d9923602ac901eb1ca32ecbe726f0cdd54eec656706426b17a69d3ee2b1bb96f76b8b801569b7b54b544966903f9316603da54c3ff64f

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,13 @@
 # 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"?
+
+**Ugly** debug logging is added inside the body of a method, so it runs when a method is called. This can create a mess of your git history, and can even introduce new bugs to your code.
+
+**Unobtrusive** debug logging stays out of the method, changes no logic, can't break your code, and yet it still runs when your method is called, and tells you everything you wanted to know. It doesn't mess with the git history of the method at all!
 
 | Project                 |  DebugLogging           |
 |------------------------ | ----------------------- |
@@ -26,12 +33,15 @@ 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*
 * **so many free ponies** 🎠🐴🎠🐴🎠🐴
 
 ## Next Level Magic
@@ -43,9 +53,9 @@ Herein you will find:
 * 100% clean, 0% obtrusive
 * 100% tested
 * 100% Ruby 2.1+ compatible
-  - use version ~1.0 for Ruby < 2.3
-  - use version ~2.0 for Ruby 2.3
-  - use version ~3.0 for Ruby 2.4+
+  - use version `gem "debug_logging", "~> 1.0"` for Ruby < 2.3
+  - use version `gem "debug_logging", "~> 2.0"` for Ruby 2.3
+  - use version `gem "debug_logging", "~> 3.0"` for Ruby 2.4+
 
 NOTE: The manner this is made to work for class methods is totally different than the way this is made to work for instance methods.
 
@@ -80,7 +90,7 @@ 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}" }
@@ -92,7 +102,7 @@ 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
 ```
 
@@ -100,7 +110,7 @@ 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}" }
@@ -112,7 +122,7 @@ 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
 end
 ```
@@ -136,42 +146,83 @@ Every time a method is called, you can now get logs, optionally with arguments,
 
 ```ruby
 class Car
-
-  # adds the helper methods to the class, all are prefixed with debug_*,
-  #   except for the logged class method, which comes from extending DebugLogging::ClassLogger
+  # Adds the helper methods to the class.
+  #   All helpers prefixed with debug_*,
+  #   except for the *logged* decorator, which comes from extending DebugLogging::ClassLogger
   extend DebugLogging
 
   # per class configuration overrides!
   self.debug_class_benchmarks = true
   self.debug_instance_benchmarks = true
 
-  # For instance methods:
-  # Option 1: specify the exact method(s) to add logging to
-  include DebugLogging::InstanceLogger.new(i_methods: [:drive, :stop])
-
-  # Provides the `logged` method decorator
+  # For class methods
+  #   Provides the versatile `logged` method decorator / macro
+  # For instance methods
+  #   Provides the versatile `i_logged` method decorator / macro
   extend DebugLogging::ClassLogger
 
-  logged def make; new; end
-  def design(*args); new; end
-  def safety(*args); new; end
-  def dealer_options(*args); new; end
+  # == 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
+
+  # Option 2: Use *logged* as a macro
   logged :design, :safety
-  # override options for any instance method(s), by passing a hash as the last argument
-  logged :dealer_options, { multiple_last_hashes: true }
+  # Override configuration options for any class 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
+  logged :dealer_options, {
+    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
+  # == 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: %i[drive stop])
+
+  def drive(speed)
+    speed
+  end
 
-  def drive(speed); speed; end
-  def stop(**opts); 0; 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))
 
-  # override options for any instance method(s)
-  include DebugLogging::InstanceLogger.new(i_methods: [:stop], config: { multiple_last_hashes: true })
+  def faster(**_opts)
+    0
+  end
 
-  def will_not_be_logged; false; 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
+  # == END INSTANCE METHODS ==
 end
 ```
 
@@ -195,37 +246,82 @@ Every time a method is called, class and instance method events are instrumented
 
 ```ruby
 class Car
-
-  # adds the helper methods to the class, all are prefixed with debug_*,
-  #   except for the instrumented class method, which comes from extending DebugLogging::ClassNotifier
+  # Adds the helper methods to the class.
+  #   All helpers prefixed with debug_*,
+  #   except for the *notifies* decorator, which comes from extending DebugLogging::ClassNotifier
   extend DebugLogging
 
   # For instance methods:
-  # Option 1: specify the exact method(s) to add instrumentation to (including capturing instance variable values as part of the event payload)
+  # Option 1: specify the exact method(s) to add instrumentation to
+  #   NOTE: You can capture instance variable values as part of the event payload
   include DebugLogging::InstanceNotifier.new(i_methods: [:drive,
                                                          :stop,
                                                          [:turn, { instance_variables: %i[direction angle] }]])
 
-  # Provides the `notifies` method decorator
+  # For class methods
+  #   Provides the versatile `notifies` method decorator / macro
+  # For instance methods
+  #   Provides the versatile `i_notifies` method decorator / macro
   extend DebugLogging::ClassNotifier
 
-  notifies def make; new; end
-  def design(*args); new; end
-  def safety(*args); new; end
-  def dealer_options(*args); new; end
+  # == 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
+
+  # Option 2: Use *logged* as a macro
   notifies :design, :safety
-  # adding additional event payload options for any instance method(s), by passing a hash as the last argument
-  notifies :dealer_options, { sport_package: true }
-
-  def drive(speed); speed; end
-  def stop(**opts); 0; end
+  # Override configuration options for any class 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
+  notifies :dealer_options, {
+    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
+  # == END CLASS METHODS ==
+
+  # == BEGIN INSTANCE METHODS ==
+  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 will_not_be_logged; false; 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
+  # == END INSTANCE METHODS ==
 end
 ```
 
@@ -289,6 +385,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