lumberjack 2.0.4 → 2.1.0

data/lib/lumberjack/template.rb

@@ -101,9 +101,8 @@ module Lumberjack
     MILLISECOND_TIME_FORMAT = "%Y-%m-%dT%H:%M:%S.%3N"
     MICROSECOND_TIME_FORMAT = "%Y-%m-%dT%H:%M:%S.%6N"
     PLACEHOLDER_PATTERN = /{{ *((?:[^}]|}(?!}))*) *}}/i
-    V1_PLACEHOLDER_PATTERN = /:[a-z0-9_.-]+/i
     RESET_CHAR = "\e[0m"
-    private_constant :TEMPLATE_ARGUMENT_ORDER, :MILLISECOND_TIME_FORMAT, :MICROSECOND_TIME_FORMAT, :PLACEHOLDER_PATTERN, :V1_PLACEHOLDER_PATTERN, :RESET_CHAR
+    private_constant :TEMPLATE_ARGUMENT_ORDER, :MILLISECOND_TIME_FORMAT, :MICROSECOND_TIME_FORMAT, :PLACEHOLDER_PATTERN, :RESET_CHAR
 
     class << self
       def colorize_entry(formatted_string, entry)
@@ -133,22 +132,10 @@ module Lumberjack
     def initialize(first_line = nil, additional_lines: nil, time_format: nil, attribute_format: nil, colorize: false)
       first_line ||= DEFAULT_FIRST_LINE_TEMPLATE
       first_line = "#{first_line.chomp}#{Lumberjack::LINE_SEPARATOR}"
-      if !first_line.include?("{{") && first_line.match?(V1_PLACEHOLDER_PATTERN)
-        Utils.deprecated("Template.v1", "Templates now use {{placeholder}} instead of :placeholder and :tags has been replaced with {{attributes}}.") do
-          @first_line_template, @first_line_attributes = compile_v1(first_line)
-        end
-      else
-        @first_line_template, @first_line_attributes = compile(first_line)
-      end
+      @first_line_template, @first_line_attributes = compile(first_line)
 
       additional_lines ||= DEFAULT_ADDITIONAL_LINES_TEMPLATE
-      if !additional_lines.include?("{{") && additional_lines.match?(V1_PLACEHOLDER_PATTERN)
-        Utils.deprecated("Template.v1", "Templates now use {{placeholder}} instead of :placeholder and :tags has been replaced with {{attributes}}.") do
-          @additional_line_template, @additional_line_attributes = compile_v1(additional_lines)
-        end
-      else
-        @additional_line_template, @additional_line_attributes = compile(additional_lines)
-      end
+      @additional_line_template, @additional_line_attributes = compile(additional_lines)
 
       @attribute_template = attribute_format || DEFAULT_ATTRIBUTE_FORMAT
       unless @attribute_template.scan("%s").size == 2
@@ -160,6 +147,7 @@ module Lumberjack
       self.datetime_format = (time_format || :milliseconds)
 
       @colorize = colorize
+      @pid_cache = nil
     end
 
     # Set the datetime format used for timestamp formatting in the template.
@@ -177,6 +165,15 @@ module Lumberjack
         format = MICROSECOND_TIME_FORMAT
       end
       @time_formatter = Formatter::DateTimeFormatter.new(format)
+
+      # Formatted timestamps can only be cached for the built-in formats where the
+      # subsecond precision is known.
+      @time_cache_units, @time_cache_divisor = if format == MILLISECOND_TIME_FORMAT
+        [1_000, 1_000_000]
+      elsif format == MICROSECOND_TIME_FORMAT
+        [1_000_000, 1_000]
+      end
+      @time_cache = nil
     end
 
     # Get the current datetime format string used for timestamp formatting.
@@ -202,7 +199,7 @@ module Lumberjack
         first_line = additional_lines.shift
       end
 
-      formatted_time = @time_formatter.call(entry.time) if @template_include_time
+      formatted_time = cached_formatted_time(entry.time) if @template_include_time
       severity = entry.severity_data
       format_args = [
         formatted_time,
@@ -212,7 +209,7 @@ module Lumberjack
         severity.emoji,
         severity.level,
         entry.progname,
-        entry.pid,
+        cached_pid_string(entry.pid),
         first_line
       ]
       append_attribute_args!(format_args, entry.attributes, @first_line_attributes)
@@ -237,11 +234,61 @@ module Lumberjack
 
       message = Template.colorize_entry(message, entry) if @colorize
 
+      # Normalize the output to end with exactly one line separator and no trailing
+      # whitespace so the writer can send it to the stream without any further processing.
+      message.rstrip!
+      message << Lumberjack::LINE_SEPARATOR
+
       message
     end
 
     private
 
+    # Format a timestamp, reusing the last formatted value when the time falls within
+    # the same subsecond tick as the previous entry. Formatting a time is relatively
+    # expensive, so this saves both CPU and a string allocation for entries logged in
+    # quick succession. The cache is a single frozen array published with one instance
+    # variable write, so concurrent readers see either the old or the new value; the
+    # worst case under contention is a redundant recompute, never an incorrect string.
+    #
+    # @param time [Time] The timestamp to format
+    # @return [String] The formatted timestamp
+    def cached_formatted_time(time)
+      # Only Time exposes the epoch, nanosecond, and offset accessors the cache key needs.
+      # Other timestamp objects (Date, DateTime, etc.) are always formatted directly.
+      return @time_formatter.call(time) unless @time_cache_divisor && time.is_a?(Time)
+
+      # The key is the epoch time in the same units as the format's subsecond precision.
+      # Integer division truncates the same way the strftime %N directive does. The UTC
+      # offset must be part of the key because the formats render wall-clock components.
+      key = (time.to_i * @time_cache_units) + (time.nsec / @time_cache_divisor)
+      offset = time.utc_offset
+      cached = @time_cache
+      return cached[2] if cached && cached[0] == key && cached[1] == offset && cached[2]
+
+      formatted = @time_formatter.call(time).to_s.freeze
+      @time_cache = [key, offset, formatted].freeze
+      formatted
+    end
+
+    # Convert a process id to a string, caching the result since the pid rarely changes.
+    # Passing an Integer to sprintf allocates a new string on every call; reusing the
+    # frozen string avoids that. Uses the same benign-race publication pattern as the
+    # timestamp cache.
+    #
+    # @param pid [Integer, nil] The process id
+    # @return [String, nil] The pid as a string
+    def cached_pid_string(pid)
+      return pid unless pid.is_a?(Integer)
+
+      cached = @pid_cache
+      return cached[1] if cached && cached[0] == pid
+
+      pid_string = pid.to_s.freeze
+      @pid_cache = [pid, pid_string].freeze
+      pid_string
+    end
+
     # Build the arguments array for sprintf formatting by appending attribute values.
     # This method handles both the general :attributes placeholder and specific
     # attribute placeholders defined in the template.
@@ -295,29 +342,5 @@ module Lumberjack
       end
       [template, attribute_vars]
     end
-
-    # Parse and compile a template string into a sprintf-compatible format string
-    # and extract attribute variable names. This method handles placeholder
-    # substitution and escape sequence processing.
-    #
-    # @param template [String] The raw template string with placeholders
-    # @return [Array<String, Array<String>>] A tuple of [compiled_template, attribute_vars]
-    def compile_v1(template) # :nodoc:
-      template = template.gsub(":tags", ":attributes").gsub(/ ?:attributes/, ":attributes")
-      template = template.gsub(/%(?!%)/, "%%")
-
-      attribute_vars = []
-      template = template.gsub(V1_PLACEHOLDER_PATTERN) do |match|
-        var_name = match[1, match.length]
-        position = TEMPLATE_ARGUMENT_ORDER.index(var_name)
-        if position
-          "%#{position + 1}$s"
-        else
-          attribute_vars << var_name
-          "%#{TEMPLATE_ARGUMENT_ORDER.size + attribute_vars.size}$s"
-        end
-      end
-      [template, attribute_vars]
-    end
   end
 end

data/lib/lumberjack/template_registry.rb

@@ -3,6 +3,7 @@
 module Lumberjack
   class TemplateRegistry
     @templates = {}
+    @lock = Mutex.new
 
     class << self
       # Register a log template class with a symbol.
@@ -14,15 +15,15 @@ module Lumberjack
           raise ArgumentError.new("template must be a String, Class, or respond to :call")
         end
 
-        @templates[name.to_sym] = template
+        @lock.synchronize { @templates[name.to_sym] = template }
       end
 
-      # Remove a template from the registry.        raise ArgumentError.new("template must be a String, Class, or respond to :call")
+      # Remove a template from the registry.
       #
       # @param name [Symbol] The name of the template to remove.
       # @return [void]
       def remove(name)
-        @templates.delete(name.to_sym)
+        @lock.synchronize { @templates.delete(name.to_sym) }
       end
 
       # Check if a template is registered.
@@ -30,7 +31,7 @@ module Lumberjack
       # @param name [Symbol] The name of the template.
       # @return [Boolean] True if the template is registered, false otherwise.
       def registered?(name)
-        @templates.include(name.to_sym)
+        @lock.synchronize { @templates.include?(name.to_sym) }
       end
 
       # Get a registered log template class by its symbol.
@@ -38,7 +39,7 @@ module Lumberjack
       # @param name [Symbol] The symbol of the registered log template class.
       # @return [Class, nil] The registered log template class, or nil if not found.
       def template(name, options = {})
-        template = @templates[name.to_sym]
+        template = @lock.synchronize { @templates[name.to_sym] }
         if template.is_a?(Class)
           template.new(options)
         elsif template.is_a?(String)
@@ -53,7 +54,7 @@ module Lumberjack
       #
       # @return [Array<Symbol>] An array of all registered log template symbols.
       def registered_templates
-        @templates.dup
+        @lock.synchronize { @templates.dup }
       end
     end
   end

data/lib/lumberjack/utils.rb

@@ -16,7 +16,7 @@ module Lumberjack
     private_constant :NON_SLUGGABLE_PATTERN
 
     @deprecations = nil
-    @deprecations_lock = nil
+    @deprecations_lock = Mutex.new
     @hostname = UNDEFINED
 
     class << self
@@ -39,7 +39,6 @@ module Lumberjack
       #   end
       def deprecated(method, message)
         if Lumberjack.deprecation_mode != :silent && !@deprecations&.include?(method)
-          @deprecations_lock ||= Mutex.new
           @deprecations_lock.synchronize do
             @deprecations ||= {}
             unless @deprecations.include?(method)
@@ -209,18 +208,6 @@ module Lumberjack
         flatten_hash_recursive(attr_hash)
       end
 
-      # Alias for {.flatten_attributes} to provide compatibility with the 1.x API.
-      # This method will eventually be removed in a future version.
-      #
-      # @param tag_hash [Hash] The hash to flatten.
-      # @return [Hash<String, Object>] The flattened hash.
-      # @deprecated Use {.flatten_attributes} instead.
-      def flatten_tags(tag_hash)
-        Utils.deprecated("Lumberjack::Utils.flatten_tags", "Lumberjack::Utils.flatten_tags is deprecated and will be removed in version 2.1; use flatten_attributes instead.") do
-          flatten_attributes(tag_hash)
-        end
-      end
-
       # Expand a hash containing dot notation keys into a nested hash structure.
       # This is the inverse operation of {.flatten_attributes} and is useful for converting
       # flat attribute structures back into nested hashes.
@@ -248,18 +235,6 @@ module Lumberjack
         expand_dot_notation_hash(attributes)
       end
 
-      # Alias for {.expand_attributes} to provide compatibility with the 1.x API.
-      # This method will eventually be removed in a future version.
-      #
-      # @param tags [Hash] The hash to expand.
-      # @return [Hash] The expanded hash.
-      # @deprecated Use {.expand_attributes} instead.
-      def expand_tags(tags)
-        Utils.deprecated("Lumberjack::Utils.expand_tags", "Lumberjack::Utils.expand_tags is deprecated and will be removed in version 2.1; use expand_attributes instead.") do
-          expand_attributes(tags)
-        end
-      end
-
       private
 
       # Recursively flatten a hash, building dot notation keys for nested structures.

data/lib/lumberjack.rb

@@ -59,19 +59,14 @@ module Lumberjack
   require_relative "lumberjack/template"
   require_relative "lumberjack/utils"
 
-  # Deprecated
-  require_relative "lumberjack/tag_context"
-  require_relative "lumberjack/tag_formatter"
-  require_relative "lumberjack/tags"
-
-  @global_contexts = {}
-  @global_contexts_mutex = Mutex.new
   @deprecation_mode = nil
   @raise_logger_errors = false
   @isolation_level = :fiber
 
   extend ContextLocals
 
+  init_context_locals!
+
   class << self
     # Contexts can be used to store attributes that will be attached to all log entries in the block.
     # The context will apply to all Lumberjack loggers that are used within the block.
@@ -86,7 +81,9 @@ module Lumberjack
     # @return [Object] The result
     #   of the block
     def context(&block)
-      use_context(Context.new(current_context), &block)
+      return current_context || Context.new unless block
+
+      use_context(current_context, &block)
     end
 
     # Ensure that the block of code is wrapped by a global context. If there is not already
@@ -126,12 +123,6 @@ module Lumberjack
       !current_context.nil?
     end
 
-    def context?
-      Utils.deprecated("Lumberjack.context?", "Lumberjack.context? is deprecated and will be removed in version 2.1; use in_context? instead.") do
-        in_context?
-      end
-    end
-
     # Return attributes that will be applied to all Lumberjack loggers.
     #
     # @return [Hash, nil]
@@ -152,17 +143,6 @@ module Lumberjack
     # @return [Symbol] The current isolation level.
     attr_reader :isolation_level
 
-    # Alias for context_attributes to provide API compatibility with version 1.x.
-    # This method will eventually be removed.
-    #
-    # @return [Hash, nil]
-    # @deprecated Use {.context_attributes}
-    def context_tags
-      Utils.deprecated("Lumberjack.context_tags", "Lumberjack.context_tags is deprecated and will be removed in version 2.1; use context_attributes instead.") do
-        context_attributes
-      end
-    end
-
     # Tag all loggers with attributes on the current context.
     #
     # @param attributes [Hash] The attributes to set.

data/lumberjack.gemspec

@@ -34,6 +34,4 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = ">= 2.7"
 
   spec.add_runtime_dependency "logger"
-
-  spec.add_development_dependency "bundler"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lumberjack
 version: !ruby/object:Gem::Version
-  version: 2.0.4
+  version: 2.1.0
 platform: ruby
 authors:
 - Brian Durand
@@ -23,20 +23,6 @@ dependencies:
     - - ">="
       - !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'
 email:
 - bbdurand@gmail.com
 executables: []
@@ -57,12 +43,10 @@ files:
 - 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/size_rolling_log_file.rb
 - lib/lumberjack/device/test.rb
 - lib/lumberjack/device/writer.rb
 - lib/lumberjack/device_registry.rb
@@ -81,7 +65,6 @@ files:
 - lib/lumberjack/formatter/string_formatter.rb
 - 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
@@ -89,6 +72,7 @@ files:
 - lib/lumberjack/local_log_template.rb
 - lib/lumberjack/log_entry.rb
 - lib/lumberjack/log_entry_matcher.rb
+- lib/lumberjack/log_entry_matcher/indifferent_hash.rb
 - lib/lumberjack/log_entry_matcher/score.rb
 - lib/lumberjack/logger.rb
 - lib/lumberjack/message_attributes.rb
@@ -96,9 +80,6 @@ files:
 - lib/lumberjack/rack/context.rb
 - lib/lumberjack/remap_attribute.rb
 - lib/lumberjack/severity.rb
-- lib/lumberjack/tag_context.rb
-- lib/lumberjack/tag_formatter.rb
-- lib/lumberjack/tags.rb
 - lib/lumberjack/template.rb
 - lib/lumberjack/template_registry.rb
 - lib/lumberjack/utils.rb

data/lib/lumberjack/device/date_rolling_log_file.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-require "date"
-
-module Lumberjack
-  # Deprecated device. Use LogFile instead.
-  #
-  # @deprecated Use Lumberjack::Device::LogFile
-  class Device::DateRollingLogFile < Device::LogFile
-    def initialize(path, options = {})
-      Utils.deprecated("Lumberjack::Device::DateRollingLogFile", "Lumberjack::Device::DateRollingLogFile is deprecated and will be removed in version 2.1; use Lumberjack::Device::LogFile instead.")
-
-      unless options[:roll]&.to_s&.match(/(daily)|(weekly)|(monthly)/i)
-        raise ArgumentError.new("illegal value for :roll (#{options[:roll].inspect})")
-      end
-
-      new_options = options.reject { |k, _| k == :roll }.merge(shift_age: options[:roll].to_s.downcase)
-
-      super(path, new_options)
-    end
-  end
-end

data/lib/lumberjack/device/size_rolling_log_file.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-module Lumberjack
-  # Deprecated device. Use LogFile instead.
-  #
-  # @deprecated Use Lumberjack::Device::LogFile
-  class Device::SizeRollingLogFile < Device::LogFile
-    attr_reader :max_size
-
-    # Create an new log device to the specified file. The maximum size of the log file is specified with
-    # the :max_size option. The unit can also be specified: "32K", "100M", "2G" are all valid.
-    def initialize(path, options = {})
-      Utils.deprecated("Lumberjack::Device::SizeRollingLogFile", "Lumberjack::Device::SizeRollingLogFile is deprecated and will be removed in version 2.1; use Lumberjack::Device::LogFile instead.")
-
-      @max_size = options[:max_size]
-      new_options = options.reject { |k, _| k == :max_size }.merge(shift_size: max_size)
-      new_options[:shift_age] = 10 unless options[:shift_age].is_a?(Integer) && options[:shift_age] >= 0
-
-      super(path, new_options)
-    end
-  end
-end

data/lib/lumberjack/formatter/tagged_message.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "../message_attributes"
-
-module Lumberjack
-  # This is a deprecated alias for Lumberjack::MessageAttributes.
-  #
-  # @deprecated Use Lumberjack::MessageAttributes instead.
-  # @see MessageAttributes
-  class Formatter::TaggedMessage < MessageAttributes
-    def initialize(message, attributes)
-      Utils.deprecated("Lumberjack::Formatter::TaggedMessage", "Use Lumberjack::MessageAttributes instead.") do
-        super
-      end
-    end
-  end
-end

data/lib/lumberjack/tag_context.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module Lumberjack
-  # This class was renamed to Lumberjack::AttributesHelper. This class is provided for
-  # backward compatibility with the version 1.x API and will eventually be removed.
-  #
-  # @deprecated Use Lumberjack::AttributesHelper instead.
-  class TagContext < AttributesHelper
-    def initialize
-      Utils.deprecated("Lumberjack::TagContext", "Use Lumberjack::AttributesHelper instead.") do
-        super
-      end
-    end
-  end
-end

data/lib/lumberjack/tag_formatter.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-module Lumberjack
-  # TagFormatter has been renamed to {AttributeFormatter} as part of the transition from
-  # "tags" to "attributes" terminology in Lumberjack 2.0. This class exists solely for
-  # backward compatibility with the 1.x API and will be removed in a future version.
-  #
-  # All functionality has been moved to {AttributeFormatter} with no changes to the API.
-  # Simply replace +TagFormatter+ with +AttributeFormatter+ in your code.
-  #
-  # @deprecated Use {Lumberjack::AttributeFormatter} instead.
-  # @see Lumberjack::AttributeFormatter
-  #
-  # @example Migration
-  #   # Old code (deprecated)
-  #   formatter = Lumberjack::TagFormatter.new
-  #
-  #   # New code
-  #   formatter = Lumberjack::AttributeFormatter.new
-  class TagFormatter < AttributeFormatter
-    # Create a new TagFormatter instance. Issues a deprecation warning and delegates
-    # to {AttributeFormatter}.
-    #
-    # @deprecated Use {Lumberjack::AttributeFormatter.new} instead.
-    def initialize
-      Utils.deprecated("Lumberjack::TagFormatter", "Use Lumberjack::AttributeFormatter instead.") do
-        super
-      end
-    end
-  end
-end

data/lib/lumberjack/tags.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-module Lumberjack
-  class Tags
-    class << self
-      # Transform hash keys to strings. This method exists for optimization and backward compatibility.
-      # If a hash already has string keys, it will be returned as is.
-      #
-      # @param hash [Hash] The hash to transform.
-      # @return [Hash] The hash with string keys.
-      # @deprecated No longer supported
-      def stringify_keys(hash)
-        Utils.deprecated("Lumberjack::Tags.stringify_keys", "Lumberjack::Tags.stringify_keys is no longer supported and will be removed in version 2.1") do
-          return nil if hash.nil?
-
-          if hash.keys.all? { |key| key.is_a?(String) }
-            hash
-          else
-            hash.transform_keys(&:to_s)
-          end
-        end
-      end
-
-      # Alias to AttributesHelper.expand_runtime_values
-      #
-      # @param hash [Hash] The hash to transform.
-      # @return [Hash] The hash with string keys and expanded values.
-      # @deprecated Use {Lumberjack::AttributesHelper.expand_runtime_values} instead.
-      def expand_runtime_values(hash)
-        Utils.deprecated("Lumberjack::Tags.expand_runtime_values", "Lumberjack::Tags.expand_runtime_values is deprecated and will be removed in version 2.1; use Lumberjack::AttributesHelper.expand_runtime_values instead.") do
-          AttributesHelper.expand_runtime_values(hash)
-        end
-      end
-    end
-  end
-end