dry-logger 1.1.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ade638e79062ec058eb9745a134da64d4a97a6ee0ae794ebddc60c2463e7a74
-  data.tar.gz: f68f26b0565381b9a1d1c347d7be52d4d38a6cea69cfa2d60daaacc7a57b5124
+  metadata.gz: 8d27303efa558c60b1f0f9710b1c9419223d7b421c61b7f6efbea241b54ca486
+  data.tar.gz: ada0ee3f313045a3cfbcd26e15da7642741d6217efe3e834542935b5efbaa0b9
 SHA512:
-  metadata.gz: 4f12c24a3bee1e597b5eabdfe2b0905e2c94bd22821ec979092ad369bfa0d120f4ff84f8fd20cad9a15b6620e33036cc34e682790fb27f78952136c0cd09e0a5
-  data.tar.gz: cbca9d7176c727f69b82a99ce0fca122c8084c702a16525cbe9c24ff6c7155d845debfcde5b455a969930b7cb24baecad1bab3790f8843f7e7469d83eb85fb57
+  metadata.gz: 5c42481abe364e3550091fe8d1d8fcfbd3e2b23fa00943ca22e8a13f9d6c20cf7bf7846390498c5fb098c7cb45ff9cef461f9bddde50f4382a719e288af9731d
+  data.tar.gz: c91f8c1e74e4b1dc7fdeaa62870453e303018e7f5e4b0f25152a805cc20c15c04fea719caef6a6feb756f41291f319dd9ebca3b2275dbedc470e4ff22d5ed3fd

data/CHANGELOG.md

@@ -1,63 +1,89 @@
-<!--- DO NOT EDIT THIS FILE - IT'S AUTOMATICALLY GENERATED VIA DEVTOOLS --->
+# Changelog
 
-## 1.1.0 2025-04-17
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Break Versioning](https://www.taoensso.com/break-versioning).
+
+## [Unreleased]
 
 ### Added
 
-- Support `::Logger`'s log rotation in stream-based logger backends, via `shift_size:` and `shift_age:` arguments (@wuarmin in #31)
+### Changed
 
-[Compare v1.0.4...v1.1.0](https://github.com/dry-rb/dry-logger/compare/v1.0.4...v1.1.0)
+### Deprecated
 
-## 1.0.4 2024-05-10
+### Removed
 
+### Fixed
+
+### Security
+
+[Unreleased]: https://github.com/dry-rb/dry-logger/compare/v1.2.1...main
+
+## [1.2.1] - 2025-12-16
+
+### Changed
+
+- Support Ruby 4.0 by adding the `"logger"` gem to the list of runtime dependencies. (@timriley in #39)
 
 ### Fixed
 
-- Accept log messages via given block, ensuring compatibility with standard Ruby logger (via #28) (@komidore64)
+- Ensure changes to `logger.context` and calls to `logger.tagged` are threadsafe. (@timriley in #38)
+
+[1.2.1]: https://github.com/dry-rb/dry-logger/compare/v1.2.0...v1.2.1
+
+## [1.2.0] - 2025-11-05
 
 ### Changed
 
-- Drop support for Ruby 2.7 (via #29) (@timriley)
+- When a block is given when logging, do not execute the block if the severity is lower than the configured logger level. (@p8 in #33)
+- When a block is given when logging, and that block returns a hash, use that hash as the log payload. (@p8 in #34)
 
-[Compare v1.0.3...v1.0.4](https://github.com/dry-rb/dry-logger/compare/v1.0.3...v1.0.4)
+### Fixed
 
-## 1.0.3 2022-12-09
+- When filtering logged data, filter on a copy of the given hash, rather then mutating it directly. (@timriley in #35)
 
+## [1.1.0] - 2025-04-17
 
 ### Added
 
-- Support for ruby 2.7 (needs backports gem that *you* need to add to your Gemfile) (via #24) (@solnic)
+- Support `::Logger`'s log rotation in stream-based logger backends, via `shift_size:` and `shift_age:` arguments (@wuarmin in #31)
 
+## [1.0.4] - 2024-05-10
 
-[Compare v1.0.2...v1.0.3](https://github.com/dry-rb/dry-logger/compare/v1.0.2...v1.0.3)
+### Fixed
 
-## 1.0.2 2022-11-24
+- Accept log messages via given block, ensuring compatibility with standard Ruby logger (via #28) (@komidore64)
 
+### Changed
 
-### Fixed
+- Drop support for Ruby 2.7 (via #29) (@timriley)
 
-- Handle `:log_if` in Proxy constructors (via #23) (@solnic)
+## [1.0.3] - 2022-12-09
 
+### Added
 
-[Compare v1.0.1...v1.0.2](https://github.com/dry-rb/dry-logger/compare/v1.0.1...v1.0.2)
+- Support for ruby 2.7 (needs backports gem that *you* need to add to your Gemfile) (via #24) (@solnic)
 
-## 1.0.1 2022-11-23
+## [1.0.2] - 2022-11-24
 
+### Fixed
+
+- Handle `:log_if` in Proxy constructors (via #23) (@solnic)
+
+## [1.0.1] - 2022-11-23
 
 ### Fixed
 
 - Support for `log_if` in proxied loggers (via 81115320b490034ddf9dfe4f3775322b9271e0cd) (@solnic)
 - Support exceptions and payloads in proxied loggers (via 93b3fd59ebbdc7e63620eb064694d58455df831f) (@solnic)
 
-
-[Compare v1.0.0...v1.0.1](https://github.com/dry-rb/dry-logger/compare/v1.0.0...v1.0.1)
-
-## 1.0.0 2022-11-17
+## [1.0.0] - 2022-11-17
 
 This is a port of the original Hanami logger from hanami-utils extended with support for logging
 dispatchers that can log to different destinations and plenty more.
 
-
 ### Added
 
 - Support arbitrary logging backends through proxy (via #12) (@solnic)
@@ -78,3 +104,11 @@ dispatchers that can log to different destinations and plenty more.
 - `:rack` string log formatter which inlines request info and displays params at the end (@solnic)
 - Conditional log dispatch via `#log_if` backend's predicate (via #9) (@solnic)
 - Add support for shared context and tagged log entries (via #10) (@solnic)
+
+[1.2.0]: https://github.com/dry-rb/dry-logger/compare/v1.1.0...v1.2.0
+[1.1.0]: https://github.com/dry-rb/dry-logger/compare/v1.0.4...v1.1.0
+[1.0.4]: https://github.com/dry-rb/dry-logger/compare/v1.0.3...v1.0.4
+[1.0.3]: https://github.com/dry-rb/dry-logger/compare/v1.0.2...v1.0.3
+[1.0.2]: https://github.com/dry-rb/dry-logger/compare/v1.0.1...v1.0.2
+[1.0.1]: https://github.com/dry-rb/dry-logger/compare/v1.0.0...v1.0.1
+[1.0.0]: https://github.com/dry-rb/dry-logger/releases/tag/v1.0.0

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015-2023 dry-rb team
+Copyright (c) 2015-2025 Hanakai team
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in
@@ -18,3 +18,4 @@ FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 COPYRIGHT HOLDERS BE 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.
+

data/README.md

@@ -1,23 +1,17 @@
-<!--- this file is synced from dry-rb/template-gem project -->
+<!--- This file is synced from hanakai-rb/repo-sync -->
 
-[gem]: https://rubygems.org/gems/dry-logger
+[rubygem]: https://rubygems.org/gems/dry-logger
 [actions]: https://github.com/dry-rb/dry-logger/actions
 
-# dry-logger [![Gem Version](https://badge.fury.io/rb/dry-logger.svg)][gem] [![CI Status](https://github.com/dry-rb/dry-logger/workflows/CI/badge.svg)][actions]
+# dry-logger [![Gem Version](https://badge.fury.io/rb/dry-logger.svg)][rubygem] [![CI Status](https://github.com/dry-rb/dry-logger/workflows/CI/badge.svg)][actions]
 
 ## Links
 
-* [User documentation](https://dry-rb.org/gems/dry-logger)
-* [API documentation](http://rubydoc.info/gems/dry-logger)
-* [Forum](https://discourse.dry-rb.org)
-
-## Supported Ruby versions
-
-This library officially supports the following Ruby versions:
-
-* MRI `>= 3.0`
-* jruby `>= 9.4` (not tested on CI)
+- [User documentation](https://dry-rb.org/gems/dry-logger)
+- [API documentation](http://rubydoc.info/gems/dry-logger)
+- [Forum](https://discourse.dry-rb.org)
 
 ## License
 
 See `LICENSE` file.
+

data/dry-logger.gemspec

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# this file is synced from dry-rb/template-gem project
+# This file is synced from hanakai-rb/repo-sync. To update it, edit repo-sync.yml.
 
 lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
@@ -8,12 +8,12 @@ require "dry/logger/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "dry-logger"
-  spec.authors       = ["Luca Guidi", "Peter Solnica"]
-  spec.email         = ["me@lucaguidi.com", "peter@solnica.online"]
+  spec.authors       = ["Hanakai team"]
+  spec.email         = ["info@hanakai.org"]
   spec.license       = "MIT"
   spec.version       = Dry::Logger::VERSION.dup
 
-  spec.summary       = "Logging for Ruby"
+  spec.summary       = "Lightweight structured logging for Ruby applications"
   spec.description   = spec.summary
   spec.homepage      = "https://dry-rb.org/gems/dry-logger"
   spec.files         = Dir["CHANGELOG.md", "LICENSE", "README.md", "dry-logger.gemspec", "lib/**/*"]
@@ -21,14 +21,20 @@ Gem::Specification.new do |spec|
   spec.executables   = []
   spec.require_paths = ["lib"]
 
+  spec.extra_rdoc_files = ["README.md", "CHANGELOG.md", "LICENSE"]
+
   spec.metadata["allowed_push_host"] = "https://rubygems.org"
   spec.metadata["changelog_uri"]     = "https://github.com/dry-rb/dry-logger/blob/main/CHANGELOG.md"
   spec.metadata["source_code_uri"]   = "https://github.com/dry-rb/dry-logger"
   spec.metadata["bug_tracker_uri"]   = "https://github.com/dry-rb/dry-logger/issues"
+  spec.metadata["funding_uri"]       = "https://github.com/sponsors/hanami"
 
-  spec.required_ruby_version = ">= 3.0"
+  spec.required_ruby_version = ">= 3.2"
 
-  # to update dependencies edit project.yml
+  spec.add_runtime_dependency "logger"
 
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
 end
+

data/lib/dry/logger/constants.rb

@@ -6,7 +6,7 @@ module Dry
   module Logger
     # @since 1.0.0
     # @api private
-    NEW_LINE = $/ # rubocop:disable Style/SpecialGlobalVars
+    NEW_LINE = $/
 
     # @since 1.0.0
     # @api private

data/lib/dry/logger/dispatcher.rb

@@ -6,6 +6,7 @@ require "pathname"
 require "dry/logger/constants"
 require "dry/logger/backends/proxy"
 require "dry/logger/entry"
+require "dry/logger/execution_context"
 
 module Dry
   module Logger
@@ -18,18 +19,6 @@ module Dry
       # @api private
       attr_reader :id
 
-      # (EXPERIMENTAL) Shared payload context
-      #
-      # @example
-      #   logger.context[:component] = "test"
-      #
-      #   logger.info "Hello World"
-      #   # Hello World component=test
-      #
-      # @since 1.0.0
-      # @api public
-      attr_reader :context
-
       # @since 1.0.0
       # @api private
       attr_reader :backends
@@ -86,21 +75,13 @@ module Dry
 
       # @since 1.0.0
       # @api private
-      def self.default_context
-        Thread.current[:__dry_logger__] ||= {}
-      end
-
-      # @since 1.0.0
-      # @api private
-      def initialize(
-        id, backends: [], tags: [], context: self.class.default_context, **options
-      )
+      def initialize(id, backends: [], tags: [], context: {}, **options)
         @id = id
         @backends = backends
         @options = {**options, progname: id}
         @mutex = Mutex.new
-        @context = context
-        @tags = tags
+        @default_tags = tags.freeze
+        @default_context = context.freeze
         @clock = Clock.new(**(options[:clock] || EMPTY_HASH))
         @on_crash = options[:on_crash] || ON_CRASH
       end
@@ -205,13 +186,20 @@ module Dry
       # @since 1.0.0
       # @return [true]
       # @api public
-      def log(severity, message = nil, **payload, &block)
+      def log(severity, message = nil, **payload, &block) # rubocop:disable Metrics/PerceivedComplexity
+        return true if LEVELS[severity] < level
+
         case message
         when Hash then log(severity, **message, &block)
         else
           if block
             progname = message
-            message = block.call
+            block_result = block.call
+            case block_result
+            when Hash then payload = block_result
+            else
+              message = block_result
+            end
           end
           progname ||= id
 
@@ -219,25 +207,40 @@ module Dry
             clock: clock,
             progname: progname,
             severity: severity,
-            tags: @tags,
+            tags: current_tags,
             message: message,
             payload: {**context, **payload}
           )
 
           each_backend do |backend|
             backend.__send__(severity, entry) if backend.log?(entry)
-          rescue StandardError => e
-            on_crash.(progname: id, exception: e, message: message, payload: payload)
+          rescue StandardError => exception
+            on_crash.(progname: id, exception: exception, message: message, payload: payload)
           end
         end
 
         true
-      rescue StandardError => e
-        on_crash.(progname: id, exception: e, message: message, payload: payload)
+      rescue StandardError => exception
+        on_crash.(progname: id, exception: exception, message: message, payload: payload)
         true
       end
 
-      # (EXPERIMENTAL) Tagged logging withing the provided block
+      # Shared payload context
+      #
+      # @example
+      #   logger.context[:component] = "test"
+      #
+      #   logger.info "Hello World"
+      #   # Hello World component=test
+      #
+      # @since 1.0.0
+      # @api public
+      def context
+        @context_key ||= :"context_#{object_id}"
+        ExecutionContext[@context_key] ||= @default_context.dup
+      end
+
+      # Tagged logging withing the provided block
       #
       # @example
       #   logger.tagged("red") do
@@ -251,10 +254,10 @@ module Dry
       # @since 1.0.0
       # @api public
       def tagged(*tags)
-        @tags.concat(tags)
+        tags_stack.push(tags)
         yield
       ensure
-        @tags = []
+        tags_stack.pop
       end
 
       # Add a new backend to an existing dispatcher
@@ -303,6 +306,17 @@ module Dry
         each_backend { |backend| backend.public_send(meth, ...) }
         true
       end
+
+      private
+
+      def tags_stack
+        @tags_key ||= :"tags_#{object_id}"
+        ExecutionContext[@tags_key] ||= @default_tags.dup
+      end
+
+      def current_tags
+        tags_stack.flatten
+      end
     end
   end
 end

data/lib/dry/logger/execution_context.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Dry
+  module Logger
+    # Provides isolated thread-local storage for logger values.
+    #
+    # @api private
+    module ExecutionContext
+      CONTEXT_KEY = :__dry_logger__
+
+      class << self
+        # Returns a value from the current execution context.
+        #
+        # @param key [Symbol] the key to retrieve
+        #
+        # @return [Object, nil] the stored value, or nil if no value has been stored
+        def [](key)
+          context[key]
+        end
+
+        # Sets a value in the current execution context.
+        #
+        # @param key [Symbol] the key to store
+        # @param value [Object] the value to store
+        #
+        # @return [Object] the stored value
+        def []=(key, value)
+          context[key] = value
+        end
+
+        # Clears all values from the current execution context.
+        #
+        # @return [self]
+        def clear
+          current_store[CONTEXT_KEY] = {}
+          self
+        end
+
+        private
+
+        def context
+          current_store[CONTEXT_KEY] ||= {}
+        end
+
+        def current_store
+          Thread.current
+        end
+      end
+    end
+  end
+end

data/lib/dry/logger/filter.rb

@@ -5,18 +5,17 @@ module Dry
     # Filtering logic
     # Originaly copied from hanami/utils (see Hanami::Logger)
     #
-    # @since 0.1.0
     # @api private
     class Filter
-      # @since 0.1.0
       # @api private
       def initialize(filters = [])
         @filters = filters
       end
 
-      # @since 0.1.0
       # @api private
       def call(hash)
+        hash = _deep_dup(hash)
+
         _filtered_keys(hash).each do |key|
           *keys, last = _actual_keys(hash, key.split("."))
           keys.inject(hash, :fetch)[last] = "[FILTERED]"
@@ -27,12 +26,8 @@ module Dry
 
       private
 
-      # @since 0.1.0
-      # @api private
       attr_reader :filters
 
-      # @since 0.1.0
-      # @api private
       def _filtered_keys(hash)
         _key_paths(hash).select { |key|
           filters.any? { |filter|
@@ -41,22 +36,16 @@ module Dry
         }
       end
 
-      # @since 0.1.0
-      # @api private
       def _key_paths(hash, base = nil)
         hash.inject([]) do |results, (k, v)|
           results + (_key_paths?(v) ? _key_paths(v, _build_path(base, k)) : [_build_path(base, k)])
         end
       end
 
-      # @since 0.1.0
-      # @api private
       def _build_path(base, key)
         [base, key.to_s].compact.join(".")
       end
 
-      # @since 0.1.0
-      # @api private
       def _actual_keys(hash, keys)
         search_in = hash
 
@@ -70,13 +59,17 @@ module Dry
       # Check if the given value can be iterated (`Enumerable`) and that isn't a `File`.
       # This is useful to detect closed `Tempfiles`.
       #
-      # @since 0.1.0
-      # @api private
-      #
       # @see https://github.com/hanami/utils/pull/342
       def _key_paths?(value)
         value.is_a?(Enumerable) && !value.is_a?(File)
       end
+
+      # Returns a deeply duplicated hash to avoid mutations of the original.
+      def _deep_dup(hash)
+        hash.transform_values { |value|
+          value.is_a?(Hash) ? _deep_dup(value) : value
+        }
+      end
     end
   end
 end

data/lib/dry/logger/formatters/rack.rb

@@ -23,7 +23,7 @@ module Dry
         # @api 1.0.0
         # @api private
         def format_params(value)
-          return value unless value.empty?
+          value unless value.empty?
         end
       end
     end

data/lib/dry/logger/formatters/string.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "set"
-
 require_relative "template"
 require_relative "structured"
 
@@ -97,7 +95,7 @@ module Dry
         def format_exception(value)
           [
             "#{value.message} (#{value.class})",
-            format_backtrace(value.backtrace || EMPTY_BACKTRACE)
+            format_backtrace(value.backtrace || EMPTY_ARRAY)
           ].join(NEW_LINE)
         end
 
@@ -140,7 +138,7 @@ module Dry
         def severity_colors
           @severity_colors ||= DEFAULT_SEVERITY_COLORS.merge(
             (options[:severity_colors] || EMPTY_HASH)
-              .to_h { |key, value| [LEVELS[key.to_s], value] }
+              .transform_keys { |key| LEVELS[key.to_s] }
           )
         end
       end

data/lib/dry/logger/formatters/template.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require "set"
 require "dry/logger/constants"
 require_relative "colors"
 

data/lib/dry/logger/version.rb

@@ -2,6 +2,6 @@
 
 module Dry
   module Logger
-    VERSION = "1.1.0"
+    VERSION = "1.2.1"
   end
 end

metadata

@@ -1,16 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: dry-logger
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.1
 platform: ruby
 authors:
-- Luca Guidi
-- Peter Solnica
+- Hanakai team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-04-16 00:00:00.000000000 Z
+date: 2025-12-15 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: 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: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -25,13 +66,15 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Logging for Ruby
+description: Lightweight structured logging for Ruby applications
 email:
-- me@lucaguidi.com
-- peter@solnica.online
+- info@hanakai.org
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
+- CHANGELOG.md
+- LICENSE
 files:
 - CHANGELOG.md
 - LICENSE
@@ -47,6 +90,7 @@ files:
 - lib/dry/logger/constants.rb
 - lib/dry/logger/dispatcher.rb
 - lib/dry/logger/entry.rb
+- lib/dry/logger/execution_context.rb
 - lib/dry/logger/filter.rb
 - lib/dry/logger/formatters/colors.rb
 - lib/dry/logger/formatters/json.rb
@@ -64,6 +108,7 @@ metadata:
   changelog_uri: https://github.com/dry-rb/dry-logger/blob/main/CHANGELOG.md
   source_code_uri: https://github.com/dry-rb/dry-logger
   bug_tracker_uri: https://github.com/dry-rb/dry-logger/issues
+  funding_uri: https://github.com/sponsors/hanami
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -72,7 +117,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -82,5 +127,5 @@ requirements: []
 rubygems_version: 3.3.27
 signing_key:
 specification_version: 4
-summary: Logging for Ruby
+summary: Lightweight structured logging for Ruby applications
 test_files: []