lumberjack 1.4.2 → 2.0.0

metadata

@@ -1,15 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: lumberjack
 version: !ruby/object:Gem::Version
-  version: 1.4.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Brian Durand
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-09-12 00:00:00.000000000 Z
+date: 1980-01-02 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
@@ -24,7 +37,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
 email:
 - bbdurand@gmail.com
 executables: []
@@ -35,17 +47,27 @@ files:
 - CHANGELOG.md
 - MIT_LICENSE.txt
 - README.md
+- UPGRADE_GUIDE.md
 - VERSION
 - lib/lumberjack.rb
+- lib/lumberjack/attribute_formatter.rb
+- lib/lumberjack/attributes_helper.rb
 - lib/lumberjack/context.rb
+- lib/lumberjack/context_logger.rb
 - lib/lumberjack/device.rb
+- lib/lumberjack/device/buffer.rb
 - lib/lumberjack/device/date_rolling_log_file.rb
 - lib/lumberjack/device/log_file.rb
+- lib/lumberjack/device/logger_wrapper.rb
 - lib/lumberjack/device/multi.rb
 - lib/lumberjack/device/null.rb
-- lib/lumberjack/device/rolling_log_file.rb
 - lib/lumberjack/device/size_rolling_log_file.rb
+- lib/lumberjack/device/test.rb
 - lib/lumberjack/device/writer.rb
+- lib/lumberjack/device_registry.rb
+- lib/lumberjack/entry_formatter.rb
+- lib/lumberjack/fiber_locals.rb
+- lib/lumberjack/forked_logger.rb
 - lib/lumberjack/formatter.rb
 - lib/lumberjack/formatter/date_time_formatter.rb
 - lib/lumberjack/formatter/exception_formatter.rb
@@ -60,20 +82,25 @@ files:
 - lib/lumberjack/formatter/strip_formatter.rb
 - lib/lumberjack/formatter/structured_formatter.rb
 - lib/lumberjack/formatter/tagged_message.rb
+- lib/lumberjack/formatter/tags_formatter.rb
 - lib/lumberjack/formatter/truncate_formatter.rb
+- lib/lumberjack/formatter_registry.rb
+- lib/lumberjack/io_compatibility.rb
+- lib/lumberjack/local_log_template.rb
 - lib/lumberjack/log_entry.rb
+- lib/lumberjack/log_entry_matcher.rb
+- lib/lumberjack/log_entry_matcher/score.rb
 - lib/lumberjack/logger.rb
+- lib/lumberjack/message_attributes.rb
 - lib/lumberjack/rack.rb
 - lib/lumberjack/rack/context.rb
-- lib/lumberjack/rack/request_id.rb
-- lib/lumberjack/rack/unit_of_work.rb
+- lib/lumberjack/remap_attribute.rb
 - lib/lumberjack/severity.rb
 - lib/lumberjack/tag_context.rb
 - lib/lumberjack/tag_formatter.rb
-- lib/lumberjack/tagged_logger_support.rb
-- lib/lumberjack/tagged_logging.rb
 - lib/lumberjack/tags.rb
 - lib/lumberjack/template.rb
+- lib/lumberjack/template_registry.rb
 - lib/lumberjack/utils.rb
 - lumberjack.gemspec
 homepage: https://github.com/bdurand/lumberjack
@@ -83,7 +110,6 @@ metadata:
   homepage_uri: https://github.com/bdurand/lumberjack
   source_code_uri: https://github.com/bdurand/lumberjack
   changelog_uri: https://github.com/bdurand/lumberjack/blob/main/CHANGELOG.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -91,16 +117,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
-summary: A simple, powerful, and fast logging utility with excellent structured logging
-  support that can be a drop in replacement for the standard library Logger.
+summary: Extension of Ruby’s standard Logger for advanced, structured logging. Includes
+  log entry attributes, context isolation, customizable formatters, flexible output
+  devices, and testing tools.
 test_files: []

data/lib/lumberjack/device/rolling_log_file.rb

@@ -1,145 +0,0 @@
-# frozen_string_literal: true
-
-module Lumberjack
-  class Device
-    # This is an abstract class for a device that appends entries to a file and periodically archives
-    # the existing file and starts a one. Subclasses must implement the roll_file? and archive_file_suffix
-    # methods.
-    #
-    # The :keep option can be used to specify a maximum number of rolled log files to keep.
-    # Older files will be deleted based on the time they were created. The default is to keep all files.
-    #
-    # The :min_roll_check option can be used to specify the number of seconds between checking
-    # the file to determine if it needs to be rolled. The default is to check at most once per second.
-    class RollingLogFile < LogFile
-      attr_reader :path
-      attr_accessor :keep
-
-      def initialize(path, options = {})
-        @path = File.expand_path(path)
-        @keep = options[:keep]
-        super
-        @file_inode = begin
-          stream.lstat.ino
-        rescue
-          nil
-        end
-        @@rolls = []
-        @next_stat_check = Time.now.to_f
-        @min_roll_check = (options[:min_roll_check] || 1.0).to_f
-      end
-
-      # Returns a suffix that will be appended to the file name when it is archived.. The suffix should
-      # change after it is time to roll the file. The log file will be renamed when it is rolled.
-      def archive_file_suffix
-        raise NotImplementedError
-      end
-
-      # Return +true+ if the file should be rolled.
-      def roll_file?
-        raise NotImplementedError
-      end
-
-      # Roll the log file by renaming it to the archive file name and then re-opening a stream to the log
-      # file path. Rolling a file is safe in multi-threaded or multi-process environments.
-      def roll_file! # :nodoc:
-        do_once(stream) do
-          archive_file = "#{path}.#{archive_file_suffix}"
-          stream.flush
-          current_inode = begin
-            File.stat(path).ino
-          rescue
-            nil
-          end
-          if @file_inode && current_inode == @file_inode && !File.exist?(archive_file) && File.exist?(path)
-            begin
-              File.rename(path, archive_file)
-              after_roll
-              cleanup_files!
-            rescue SystemCallError
-              # Ignore rename errors since it indicates the file was already rolled
-            end
-          end
-          reopen_file
-        end
-      rescue => e
-        $stderr.write("Failed to roll file #{path}: #{e.inspect}\n#{e.backtrace.join("\n")}\n")
-      end
-
-      protected
-
-      # This method will be called after a file has been rolled. Subclasses can
-      # implement code to reset the state of the device. This method is thread safe.
-      def after_roll
-      end
-
-      # Handle rolling the file before flushing.
-      def before_flush # :nodoc:
-        if @min_roll_check <= 0.0 || Time.now.to_f >= @next_stat_check
-          @next_stat_check += @min_roll_check
-          path_inode = begin
-            File.lstat(path).ino
-          rescue
-            nil
-          end
-          if path_inode != @file_inode
-            @file_inode = path_inode
-            reopen_file
-          elsif roll_file?
-            roll_file!
-          end
-        end
-      end
-
-      private
-
-      def reopen_file
-        old_stream = stream
-        new_stream = File.open(path, "a", encoding: EXTERNAL_ENCODING)
-        new_stream.sync = true if buffer_size > 0
-        @file_inode = begin
-          new_stream.lstat.ino
-        rescue
-          nil
-        end
-        self.stream = new_stream
-        old_stream.close
-      end
-    end
-
-    def cleanup_files!
-      if keep
-        files = Dir.glob("#{path}.*").collect { |f| [f, File.ctime(f)] }.sort { |a, b| b.last <=> a.last }.collect { |a| a.first }
-        if files.size > keep
-          files[keep, files.length].each do |f|
-            File.delete(f)
-          end
-        end
-      end
-    end
-
-    def do_once(file)
-      begin
-        file.flock(File::LOCK_EX)
-      rescue SystemCallError
-        # Most likely can't lock file because the stream is closed
-        return
-      end
-      begin
-        verify = begin
-          file.lstat
-        rescue
-          nil
-        end
-        # Execute only if the file we locked is still the same one that needed to be rolled
-        yield if verify && verify.ino == @file_inode && verify.size > 0
-      ensure
-        begin
-          file.flock(File::LOCK_UN)
-        rescue
-          nil
-        end
-      end
-    end
-  end
-end

data/lib/lumberjack/rack/request_id.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-module Lumberjack
-  module Rack
-    # Support for using the Rails ActionDispatch request id in the log.
-    # The format is expected to be a random UUID and only the first chunk is used for terseness
-    # if the abbreviated argument is true.
-    #
-    # @deprecated Use tags instead of request id for unit of work. Will be removed in version 2.0.
-    class RequestId
-      REQUEST_ID = "action_dispatch.request_id"
-
-      def initialize(app, abbreviated = false)
-        Lumberjack::Utils.deprecated("Lumberjack::Rack::RequestId", "Lumberjack::Rack::RequestId will be removed in version 2.0") do
-          @app = app
-          @abbreviated = abbreviated
-        end
-      end
-
-      def call(env)
-        request_id = env[REQUEST_ID]
-        if request_id && @abbreviated
-          request_id = request_id.split("-", 2).first
-        end
-        Lumberjack.unit_of_work(request_id) do
-          @app.call(env)
-        end
-      end
-    end
-  end
-end

data/lib/lumberjack/rack/unit_of_work.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module Lumberjack
-  module Rack
-    # @deprecated Use the Lumberjack::Rack::Context middleware instead to set a global tag
-    # with an identifier to tie log entries together in a unit of work. Will be removed in version 2.0.
-    class UnitOfWork
-      def initialize(app)
-        Lumberjack::Utils.deprecated("Lumberjack::Rack::UnitOfWork", "Lumberjack::Rack::UnitOfWork will be removed in version 2.0") do
-          @app = app
-        end
-      end
-
-      def call(env)
-        Lumberjack.unit_of_work do
-          @app.call(env)
-        end
-      end
-    end
-  end
-end

data/lib/lumberjack/tagged_logger_support.rb

@@ -1,81 +0,0 @@
-# frozen_string_literal: true
-
-require "delegate"
-require "forwardable"
-
-module Lumberjack
-  # Methods to make Lumberjack::Logger API compatible with ActiveSupport::TaggedLogger.
-  module TaggedLoggerSupport
-    class Formatter < DelegateClass(Lumberjack::Formatter)
-      extend Forwardable
-      def_delegators :@logger, :tagged, :push_tags, :pop_tags, :clear_tags!
-
-      def initialize(formatter:, logger:)
-        @logger = logger
-        @formatter = formatter
-        super(formatter)
-      end
-
-      def current_tags
-        tags = @logger.instance_variable_get(:@tags)
-        if tags.is_a?(Hash)
-          Array(tags["tagged"])
-        else
-          []
-        end
-      end
-
-      def tags_text
-        tags = current_tags
-        if tags.any?
-          tags.collect { |tag| "[#{tag}] " }.join
-        end
-      end
-
-      def __formatter
-        @formatter
-      end
-    end
-
-    # Compatibility with ActiveSupport::TaggedLogging which only supports adding tags as strings.
-    # Tags will be added to the "tagged" key in the logger's tags hash as an array.
-    def tagged(*tags, &block)
-      tagged_values = Array(tag_value("tagged"))
-      flattened_tags = tags.flatten.collect(&:to_s).reject do |tag|
-        tag.respond_to?(:blank?) ? tag.blank? : tag.empty?
-      end
-      tagged_values += flattened_tags unless flattened_tags.empty?
-
-      if block || in_tag_context?
-        tag("tagged" => tagged_values, &block)
-      else
-        tag_globally("tagged" => tagged_values)
-      end
-    end
-
-    def push_tags(*tags)
-      tagged(*tags)
-    end
-
-    def pop_tags(size = 1)
-      tagged_values = tag_value("tagged")
-      return unless tagged_values.is_a?(Array)
-
-      tagged_values = ((tagged_values.size > size) ? tagged_values[0, tagged_values.size - size] : nil)
-
-      if in_tag_context?
-        tag("tagged" => tagged_values)
-      else
-        tag_globally("tagged" => tagged_values)
-      end
-    end
-
-    def clear_tags!
-      if in_tag_context?
-        tag("tagged" => nil)
-      else
-        tag_globally("tagged" => nil)
-      end
-    end
-  end
-end

data/lib/lumberjack/tagged_logging.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-module Lumberjack
-  # Monkey patch for ActiveSupport::TaggedLogger so it doesn't blow up when
-  # a Lumberjack logger is trying to be wrapped. This module will be automatically
-  # included in ActiveSupport::TaggedLogger if activesupport is already loaded.
-  module TaggedLogging
-    class << self
-      def included(base)
-        base.singleton_class.send(:prepend, ClassMethods)
-      end
-    end
-
-    module ClassMethods
-      def new(logger)
-        if logger.is_a?(Lumberjack::Logger)
-          logger = logger.tagged_logger! unless logger.respond_to?(:tagged)
-          logger
-        else
-          super
-        end
-      end
-    end
-  end
-end
-
-if defined?(ActiveSupport::TaggedLogging)
-  ActiveSupport::TaggedLogging.include(Lumberjack::TaggedLogging)
-end