debug_logging 4.0.5 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c07adf4ce090f66cddfa9c79c7e365910e512a1594ce42b01dc9b08937cba496
-  data.tar.gz: 25872a14875d155d6d0e5ada1e798a5e0dc4e6fd54663225243db2d6c2a34f8c
+  metadata.gz: 07a1d4c942b3a784a80ee0b72882b3c3c1d098a16e1e789963051e92c9ad4ae0
+  data.tar.gz: 9cd8ebc10d446eb9bb25088180a3f078dea600248a2a4144c7d1f4c6a719f32d
 SHA512:
-  metadata.gz: 11afaaea977ac656bfffc1f94f1e93cc28853b2d183a29d8f26ad1d3d143a7be64fdeb3ea719f9d14a24f9ca9616570de3e60fa6e60006f9243abab8b25cc876
-  data.tar.gz: 2a82a36a4da174576ca77e2353dad2bb1dd705cfb15acf485582ca223edbd72c2b6164b853abbd09e33983f69703054205db9ddd937eb1cda6d39bc661cd01bf
+  metadata.gz: 4534e3a8bba1767e856e3ac60f855d8ab4100cfa2d1fc23102ee657592ada1473ceac57826fd730e5e9c9b0072f35a869134e5755db7fecde6b1a7e922505ffe
+  data.tar.gz: b651325b49c4cfbcf475b100a64f9858eed735a0c9087d24b1bbdcff999e4b2ce20dd8c571e6a454ba5b95231e33c7c98cd8c5f73c50c66926ff9f9fc537a1ff

data/CHANGELOG.md

@@ -30,6 +30,19 @@ Please file a bug if you notice a violation of semantic versioning.
 
 ### Security
 
+## [4.1.0] - 2026-07-02
+
+- TAG: [v4.1.0][4.1.0t]
+- COVERAGE: 97.46% -- 730/749 lines in 28 files
+- BRANCH COVERAGE: 86.34% -- 177/205 branches in 28 files
+- 20.94% documented
+
+### Added
+
+- Ruby keyword option support for `logged`, `notified`, `i_logged`, and
+  `i_notified`, while preserving legacy last-hash configuration and payload
+  handling.
+
 ## [4.0.5] - 2026-07-02
 
 - TAG: [v4.0.5][4.0.5t]
@@ -312,7 +325,9 @@ Please file a bug if you notice a violation of semantic versioning.
 
 - Initial release
 
-[Unreleased]: https://github.com/galtzo-floss/debug_logging/compare/v4.0.5...HEAD
+[Unreleased]: https://github.com/galtzo-floss/debug_logging/compare/v4.1.0...HEAD
+[4.1.0]: https://github.com/galtzo-floss/debug_logging/compare/v4.0.5...v4.1.0
+[4.1.0t]: https://github.com/galtzo-floss/debug_logging/releases/tag/v4.1.0
 [4.0.5]: https://github.com/galtzo-floss/debug_logging/compare/v4.0.4...v4.0.5
 [4.0.5t]: https://github.com/galtzo-floss/debug_logging/releases/tag/v4.0.5
 [4.0.4]: https://github.com/galtzo-floss/debug_logging/compare/v4.0.3...v4.0.4

data/README.md

@@ -797,7 +797,7 @@ Thanks for RTFM. ☺️
 [📌gitmoji]: https://gitmoji.dev
 [📌gitmoji-img]: https://img.shields.io/badge/gitmoji_commits-%20%F0%9F%98%9C%20%F0%9F%98%8D-34495e.svg?style=flat-square
 [🧮kloc]: https://www.youtube.com/watch?v=dQw4w9WgXcQ
-[🧮kloc-img]: https://img.shields.io/badge/KLOC-0.745-FFDD67.svg?style=for-the-badge&logo=YouTube&logoColor=blue
+[🧮kloc-img]: https://img.shields.io/badge/KLOC-0.749-FFDD67.svg?style=for-the-badge&logo=YouTube&logoColor=blue
 [🔐security]: https://github.com/galtzo-floss/debug_logging/blob/main/SECURITY.md
 [🔐security-img]: https://img.shields.io/badge/security-policy-259D6C.svg?style=flat
 [📄copyright-notice-explainer]: https://opensource.stackexchange.com/questions/5778/why-do-licenses-such-as-the-mit-license-specify-a-single-year

data/lib/debug_logging/class_logger.rb

@@ -6,11 +6,12 @@ module DebugLogging
       end
     end
 
-    def logged(*methods_to_log)
+    def logged(*methods_to_log, **options)
       methods_to_log, payload, config_opts = DebugLogging::Util.extract_payload_and_config(
         method_names: methods_to_log,
         payload: nil,
-        config: nil
+        config: nil,
+        options:
       )
       Array(methods_to_log).each do |decorated_method|
         decorated_method, method_payload, method_config_opts = DebugLogging::Util.extract_payload_and_config(

data/lib/debug_logging/class_notifier.rb

@@ -6,11 +6,12 @@ module DebugLogging
       end
     end
 
-    def notified(*methods_to_notify)
+    def notified(*methods_to_notify, **options)
       methods_to_notify, payload, config_opts = DebugLogging::Util.extract_payload_and_config(
         method_names: methods_to_notify,
         payload: nil,
-        config: nil
+        config: nil,
+        options:
       )
       Array(methods_to_notify).each do |decorated_method|
         decorated_method, method_payload, method_config_opts = DebugLogging::Util.extract_payload_and_config(

data/lib/debug_logging/instance_logger.rb

@@ -6,33 +6,33 @@ module DebugLogging
       end
     end
 
-    # NOTE: These params can be passed in / hidden in a last hash of *args
+    # NOTE: These options can also be passed in / hidden in a last hash of *args
     # NOTE: They can also be passed in discretely for each method, by passing *args as an array of arrays
-    # TODO: Refactor to use modern Ruby 3 *args, **kwargs instead
-    # @param logger [Logger] Logger.new($stdout), # probably want to override to be the Rails.logger
-    # @param log_level [Symbol] default: :debug, at what level do the messages created by this gem sent at?
-    # @param multiple_last_hashes [true, false] default: false,
-    # @param last_hash_to_s_proc [nil, Proc] default: nil, e.g. ->(hash) { "keys: #{hash.keys}" }
-    # @param last_hash_max_length [Integer] default: 1_000,
-    # @param args_to_s_proc [nil, Proc] default: nil, e.g. ->(*record) { "record id: #{record.first.id}" }
-    # @param args_max_length [Integer] default: 1_000,
-    # @param colorized_chain_for_method [false, Proc] default: false, e.g. ->(colorized_string) { colorized_string.red.on_blue.underline }
-    # @param colorized_chain_for_class [false, Proc] default: false, e.g. ->(colorized_string) { colorized_string.colorize(:light_blue ).colorize( :background => :red) }
-    # @param add_invocation_id [true, false] default: true, allows unique identification of method call; association of entry and exit log lines
-    # @param ellipsis [String] default: " ✂️ …".freeze,
-    # @param mark_scope_exit [true, false] default: false,
-    # @param add_payload [true, false, Proc] default: true, # Can also be a proc returning a string, which will be called when printing the payload
-    # @param payload_max_length [Integer] default: 1_000,
-    # @param error_handler_proc [nil, Proc] default: nil,
-    # @param time_formatter_proc [nil, Proc] default: DebugLogging::Constants::DEFAULT_TIME_FORMATTER,
-    # @param add_timestamp [true, false] default: false,
-    # @param instance_benchmarks [true, false] default: false,
-    # @param class_benchmarks [true, false] default: false,
-    def i_logged(*methods_to_log)
+    # @option options [Logger] :logger Logger.new($stdout), # probably want to override to be the Rails.logger
+    # @option options [Symbol] :log_level default: :debug, at what level do the messages created by this gem sent at?
+    # @option options [true, false] :multiple_last_hashes default: false,
+    # @option options [nil, Proc] :last_hash_to_s_proc default: nil, e.g. ->(hash) { "keys: #{hash.keys}" }
+    # @option options [Integer] :last_hash_max_length default: 1_000,
+    # @option options [nil, Proc] :args_to_s_proc default: nil, e.g. ->(*record) { "record id: #{record.first.id}" }
+    # @option options [Integer] :args_max_length default: 1_000,
+    # @option options [false, Proc] :colorized_chain_for_method default: false, e.g. ->(colorized_string) { colorized_string.red.on_blue.underline }
+    # @option options [false, Proc] :colorized_chain_for_class default: false, e.g. ->(colorized_string) { colorized_string.colorize(:light_blue ).colorize( :background => :red) }
+    # @option options [true, false] :add_invocation_id default: true, allows unique identification of method call; association of entry and exit log lines
+    # @option options [String] :ellipsis default: " ✂️ …".freeze,
+    # @option options [true, false] :mark_scope_exit default: false,
+    # @option options [true, false, Proc] :add_payload default: true, # Can also be a proc returning a string, which will be called when printing the payload
+    # @option options [Integer] :payload_max_length default: 1_000,
+    # @option options [nil, Proc] :error_handler_proc default: nil,
+    # @option options [nil, Proc] :time_formatter_proc default: DebugLogging::Constants::DEFAULT_TIME_FORMATTER,
+    # @option options [true, false] :add_timestamp default: false,
+    # @option options [true, false] :instance_benchmarks default: false,
+    # @option options [true, false] :class_benchmarks default: false,
+    def i_logged(*methods_to_log, **options)
       methods_to_log, payload, config_opts = DebugLogging::Util.extract_payload_and_config(
         method_names: methods_to_log,
         payload: nil,
-        config: nil
+        config: nil,
+        options:
       )
       instance_method_modules =
         Array(methods_to_log).map do |decorated_method|

data/lib/debug_logging/instance_notifier.rb

@@ -6,11 +6,12 @@ module DebugLogging
       end
     end
 
-    def i_notified(*methods_to_log)
+    def i_notified(*methods_to_log, **options)
       method_names, payload, config_opts = DebugLogging::Util.extract_payload_and_config(
         method_names: methods_to_log,
         payload: nil,
-        config: nil
+        config: nil,
+        options:
       )
       instance_method_notifier = DebugLogging::InstanceNotifierModulizer.to_mod(
         methods_to_notify: Array(method_names),

data/lib/debug_logging/util.rb

@@ -18,7 +18,7 @@ module DebugLogging
 
     # methods_to_log may be an array of a single method name, followed by config options and payload,
     #   or it could be an array of method names followed by config options and payload to be shared by the whole set.
-    def extract_payload_and_config(method_names:, payload: nil, config: nil)
+    def extract_payload_and_config(method_names:, payload: nil, config: nil, options: nil)
       # When scoped config is present it will always be a new configuration instance per method
       # When scoped config is not present it will reuse the class' configuration object
       scoped_payload = (method_names.is_a?(Array) && method_names.last.is_a?(Hash) && method_names.pop.clone(freeze: false)) || {}
@@ -32,6 +32,11 @@ module DebugLogging
       unless payload.empty?
         DebugLogging::Configuration::CONFIG_KEYS.each { |k| config_opts[k] = payload.delete(k) if payload.key?(k) }
       end
+      if options && !options.empty?
+        scoped_options = options.clone(freeze: false)
+        DebugLogging::Configuration::CONFIG_KEYS.each { |k| config_opts[k] = scoped_options.delete(k) if scoped_options.key?(k) }
+        payload.merge!(scoped_options)
+      end
       method_names =
         case method_names
         when Symbol

data/lib/debug_logging/version.rb

@@ -2,7 +2,7 @@
 
 module DebugLogging
   module Version
-    VERSION = "4.0.5"
+    VERSION = "4.1.0"
   end
   VERSION = Version::VERSION # Traditional Constant Location
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: debug_logging
 version: !ruby/object:Gem::Version
-  version: 4.0.5
+  version: 4.1.0
 platform: ruby
 authors:
 - Peter H. Boling
@@ -318,10 +318,10 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://debug-logging.galtzo.com/
-  source_code_uri: https://github.com/galtzo-floss/debug_logging/tree/v4.0.5
-  changelog_uri: https://github.com/galtzo-floss/debug_logging/blob/v4.0.5/CHANGELOG.md
+  source_code_uri: https://github.com/galtzo-floss/debug_logging/tree/v4.1.0
+  changelog_uri: https://github.com/galtzo-floss/debug_logging/blob/v4.1.0/CHANGELOG.md
   bug_tracker_uri: https://github.com/galtzo-floss/debug_logging/issues
-  documentation_uri: https://www.rubydoc.info/gems/debug_logging/4.0.5
+  documentation_uri: https://www.rubydoc.info/gems/debug_logging/4.1.0
   funding_uri: https://github.com/sponsors/pboling
   wiki_uri: https://github.com/galtzo-floss/debug_logging/wiki
   news_uri: https://www.railsbling.com/tags/debug_logging

metadata.gz.sig

@@ -1,3 +1,2 @@
-3p
�d?^/U�U1<1J�S�D�~�ߓ�4
�4oۼ���Cm��q�k��pP�[<8N7y�Dt_�GŬ�QG��_�|cN��EVr��n+�u=�j�!g-�uE�<�����i��/�����.���S�W��֖�a߻xx��sR�:��*�/�k���WNM%0�\�ϥtl\�x{r
k�J���
-s�����%�?����ջ�7�*�g�G�ђ$�b�}hw�]����_�uo�dŒ�uT�&$^K��
-(���6v��};~�R�7����h�T��Ӵ�*��F��\$H����'\���bmTR€Q/�5��8��殎'LB��{�����"�_��o58O�[E�R?W���5�^�<�s�U����u�w靅�A�1����
+�����d&M4�&Er�˗y��9�"Ƚ77�a�?��Xo�t��^��`��;~>d9|���_=�S%� G�Ǵ�����IE?��Y"}!0�|��W��8go�½͘�i��Vn��ȽD�H���gR�
+9{L�}U	OT)fm��bx�l�EUAH{�>�B��Ml�^�yE�[c�aVR�
~/�	�f��r�}�XL��=�jS�;I���iE�%V�a�KŒMpG�F@���F���J����	��PԄ�;$��w�����$#���?�l�"�k�$���i��1�����#�dFsͻZ>���c�t�M��l�kt�V�&U!