debug_logging 3.1.1 → 3.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a39fc11d3fc815e37db037fd9ce8b08e74e5d98e7612a50f191231ba3ce95231
-  data.tar.gz: 99ef91cf9302dfc413ebba74435464933524cfa1a2e70f9623b97ff64c849729
+  metadata.gz: fb9df42efa08fe95b6c9270a4474132b2dbb55ed8d154d17c20dfde074781a8c
+  data.tar.gz: 459f277689fcb9b328b4c904730ae25bfe1c55fc87a5ab292157393f6b13c36b
 SHA512:
-  metadata.gz: 22ec37827bdf34889a023d235315ee4ca85642cdc070a22751be328f58c8f4b8b22c952da52c2d6900f3bc44431d8d0dd5800483419532f3fd5a5aca9227d529
-  data.tar.gz: 5b5456b83dfff252840e31ea81af17e5d3b50bdc025e090d55731fcd16353d41352b2304ba53818c791f9ec3970a447e4b01624fd269d6663951a444a876ac6d
+  metadata.gz: 5af7096cfbadcea5695cc19bdce85e4d6ac8eecf02139378cb2dc0d734d99011bc49ff239fe1d816ce9570a883b75b4f6e0772fdfbf7feda147e7890c56d415a
+  data.tar.gz: f471d3858ad20c1d3347b4ce328254c01572da54fd0e566ccbf6b15827996c561cf86c5fcb23f14ad127d5a9449b045c63281768c082b2375d754e566f3d4561

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

@@ -86,7 +86,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}" }
@@ -98,7 +98,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
 ```
 
@@ -106,7 +106,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}" }
@@ -118,7 +118,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
 ```
@@ -160,10 +160,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 +184,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 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))
 
-  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 +263,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 +287,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
 ```

data/debug_logging.gemspec

@@ -33,7 +33,10 @@ Automatically log selected methods and their arguments as they are called at run
   spec.add_development_dependency 'rake', '>= 13'
   spec.add_development_dependency 'rspec', '>= 3'
   spec.add_development_dependency 'rspec-pending_for', '>= 0'
-  spec.add_development_dependency 'rubocop', '>= 0.92'
-  spec.add_development_dependency 'rubocop-rspec', '>= 1'
+  spec.add_development_dependency 'rubocop', '~> 1.0'
+  spec.add_development_dependency 'rubocop-md'
+  spec.add_development_dependency 'rubocop-performance'
+  spec.add_development_dependency 'rubocop-rake'
+  spec.add_development_dependency 'rubocop-rspec', '~> 2.0'
   spec.add_development_dependency 'silent_stream', '>= 1'
 end

data/lib/debug_logging/argument_printer.rb

@@ -38,7 +38,7 @@ module DebugLogging
       "#{klass_string}#{separator}#{method_string}"
     end
 
-    def debug_signature_to_s(args: nil, config_proxy: nil) # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+    def debug_signature_to_s(args: nil, config_proxy: nil) # rubocop:disable Metrics/CyclomaticComplexity
       return '' unless args && config_proxy
 
       printed_args = ''

data/lib/debug_logging/configuration.rb

@@ -51,7 +51,7 @@ module DebugLogging
     #     )
     #
     CONFIG_KEYS.each do |key|
-      alias :"debug_#{key}" :"#{key}"
+      alias_method :"debug_#{key}", :"#{key}"
     end
 
     class << self
@@ -76,7 +76,7 @@ module DebugLogging
       return unless enabled
       return unless logger
 
-      if block_given?
+      if block
         logger.send(log_level, &block)
       else
         logger.send(log_level, message)

data/lib/debug_logging/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DebugLogging
-  VERSION = '3.1.1'
+  VERSION = '3.1.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: debug_logging
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 3.1.2
 platform: ruby
 authors:
 - Peter Boling
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-09 00:00:00.000000000 Z
+date: 2020-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -116,32 +116,74 @@ dependencies:
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-md
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.92'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.92'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-rspec
+  name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: silent_stream
   requirement: !ruby/object:Gem::Requirement