lumberjack 1.2.7 → 1.2.9

data/lib/lumberjack/template.rb

@@ -14,7 +14,7 @@ module Lumberjack
   # If your tag name contains characters other than alpha numerics and the underscore, you must surround it
   # with curly brackets: `:{http.request-id}`.
   class Template
-    TEMPLATE_ARGUMENT_ORDER = %w(:time :severity :progname :pid :message :tags).freeze
+    TEMPLATE_ARGUMENT_ORDER = %w[:time :severity :progname :pid :message :tags].freeze
     MILLISECOND_TIME_FORMAT = "%Y-%m-%dT%H:%M:%S.%3N"
     MICROSECOND_TIME_FORMAT = "%Y-%m-%dT%H:%M:%S.%6N"
     PLACEHOLDER_PATTERN = /:(([a-z0-9_]+)|({[^}]+}))/i.freeze
@@ -30,6 +30,9 @@ module Lumberjack
     # specified precision.
     #
     # Messages will have white space stripped from both ends.
+    #
+    # @param [String] first_line The template to use to format the first line of a message.
+    # @param [Hash] options The options for the template.
     def initialize(first_line, options = {})
       @first_line_template, @first_line_tags = compile(first_line)
       additional_lines = options[:additional_lines] || "#{Lumberjack::LINE_SEPARATOR}:message"
@@ -39,6 +42,9 @@ module Lumberjack
       self.datetime_format = (options[:time_format] || :milliseconds)
     end
 
+    # Set the format used to format the time.
+    #
+    # @param [String] format The format to use to format the time.
     def datetime_format=(format)
       if format == :milliseconds
         format = MILLISECOND_TIME_FORMAT
@@ -48,11 +54,17 @@ module Lumberjack
       @time_formatter = Formatter::DateTimeFormatter.new(format)
     end
 
+    # Get the format used to format the time.
+    #
+    # @return [String]
     def datetime_format
       @time_formatter.format
     end
 
     # Convert an entry into a string using the template.
+    #
+    # @param [Lumberjack::LogEntry] entry The entry to convert to a string.
+    # @return [String] The entry converted to a string.
     def call(entry)
       return entry unless entry.is_a?(LogEntry)
 
@@ -86,7 +98,7 @@ module Lumberjack
     def tag_args(tags, tag_vars)
       return [nil] * (tag_vars.size + 1) if tags.nil? || tags.size == 0
 
-      tags_string = String.new
+      tags_string = ""
       tags.each do |name, value|
         unless value.nil? || tag_vars.include?(name)
           value = value.to_s
@@ -103,7 +115,7 @@ module Lumberjack
     end
 
     # Compile the template string into a value that can be used with sprintf.
-    def compile(template) #:nodoc:
+    def compile(template) # :nodoc:
       tag_vars = []
       template = template.gsub(PLACEHOLDER_PATTERN) do |match|
         var_name = match.sub("{", "").sub("}", "")

data/lib/lumberjack.rb

@@ -1,27 +1,26 @@
 # frozen_string_literals: true
 
-require 'rbconfig'
-require 'time'
-require 'thread'
-require 'securerandom'
-require 'logger'
+require "rbconfig"
+require "time"
+require "securerandom"
+require "logger"
 
 module Lumberjack
-  LINE_SEPARATOR = (RbConfig::CONFIG['host_os'].match(/mswin/i) ? "\r\n" : "\n")
+  LINE_SEPARATOR = ((RbConfig::CONFIG["host_os"] =~ /mswin/i) ? "\r\n" : "\n")
 
-  require_relative "lumberjack/severity.rb"
-  require_relative "lumberjack/formatter.rb"
+  require_relative "lumberjack/severity"
+  require_relative "lumberjack/formatter"
 
-  require_relative "lumberjack/context.rb"
-  require_relative "lumberjack/log_entry.rb"
-  require_relative "lumberjack/device.rb"
-  require_relative "lumberjack/logger.rb"
-  require_relative "lumberjack/tags.rb"
-  require_relative "lumberjack/tag_formatter.rb"
-  require_relative "lumberjack/tagged_logger_support.rb"
-  require_relative "lumberjack/tagged_logging.rb"
-  require_relative "lumberjack/template.rb"
-  require_relative "lumberjack/rack.rb"
+  require_relative "lumberjack/context"
+  require_relative "lumberjack/log_entry"
+  require_relative "lumberjack/device"
+  require_relative "lumberjack/logger"
+  require_relative "lumberjack/tags"
+  require_relative "lumberjack/tag_formatter"
+  require_relative "lumberjack/tagged_logger_support"
+  require_relative "lumberjack/tagged_logging"
+  require_relative "lumberjack/template"
+  require_relative "lumberjack/rack"
 
   class << self
     # Define a unit of work within a block. Within the block supplied to this
@@ -33,6 +32,9 @@ module Lumberjack
     #
     # For the common use case of treating a single web request as a unit of work, see the
     # Lumberjack::Rack::UnitOfWork class.
+    #
+    # @param [String] id The id for the unit of work.
+    # @return [void]
     def unit_of_work(id = nil)
       id ||= SecureRandom.hex(6)
       context do
@@ -42,6 +44,8 @@ module Lumberjack
     end
 
     # Get the UniqueIdentifier for the current unit of work.
+    #
+    # @return [String, nil] The id for the current unit of work.
     def unit_of_work_id
       context[:unit_of_work_id]
     end
@@ -54,36 +58,53 @@ module Lumberjack
     #
     # Otherwise, it will return the current context. If one doesn't exist, it will return a new one
     # but that context will not be in any scope.
-    def context
+    #
+    # @return [Lumberjack::Context] The current context if called without a block.
+    def context(&block)
       current_context = Thread.current[:lumberjack_context]
-      if block_given?
-        Thread.current[:lumberjack_context] = Context.new(current_context)
-        begin
-          yield
-        ensure
-          Thread.current[:lumberjack_context] = current_context
-        end
+      if block
+        use_context(Context.new(current_context), &block)
       else
         current_context || Context.new
       end
     end
-    
+
+    # Set the context to use within a block.
+    #
+    # @param [Lumberjack::Context] context The context to use within the block.
+    # @return [Object] The result of the block.
+    def use_context(context, &block)
+      current_context = Thread.current[:lumberjack_context]
+      begin
+        Thread.current[:lumberjack_context] = (context || Context.new)
+        yield
+      ensure
+        Thread.current[:lumberjack_context] = current_context
+      end
+    end
+
     # Return true if inside a context block.
+    #
+    # @return [Boolean]
     def context?
       !!Thread.current[:lumberjack_context]
     end
 
     # Return the tags from the current context or nil if there are no tags.
+    #
+    # @return [Hash, nil]
     def context_tags
       context = Thread.current[:lumberjack_context]
-      context.tags if context
+      context&.tags
     end
 
     # Set tags on the current context
+    #
+    # @param [Hash] tags The tags to set.
+    # @return [void]
     def tag(tags)
       context = Thread.current[:lumberjack_context]
-      context.tag(tags) if context
+      context&.tag(tags)
     end
-
   end
 end

data/lumberjack.gemspec

@@ -1,8 +1,8 @@
 Gem::Specification.new do |spec|
-  spec.name = 'lumberjack'
-  spec.version = File.read(File.expand_path("../VERSION", __FILE__)).strip
-  spec.authors = ['Brian Durand']
-  spec.email = ['bbdurand@gmail.com']
+  spec.name = "lumberjack"
+  spec.version = File.read(File.join(__dir__, "VERSION")).strip
+  spec.authors = ["Brian Durand"]
+  spec.email = ["bbdurand@gmail.com"]
 
   spec.summary = "A simple, powerful, and very fast logging utility that can be a drop in replacement for Logger or ActiveSupport::BufferedLogger."
   spec.homepage = "https://github.com/bdurand/lumberjack"
@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  ignore_files = %w(
+  ignore_files = %w[
     .
     Appraisals
     Gemfile
@@ -18,17 +18,14 @@ Gem::Specification.new do |spec|
     Rakefile
     gemfiles/
     spec/
-  )
-  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject{ |f| ignore_files.any?{ |path| f.start_with?(path) } }
+  ]
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject { |f| ignore_files.any? { |path| f.start_with?(path) } }
   end
 
-  spec.require_paths = ['lib']
+  spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = '>= 2.3.0'
+  spec.required_ruby_version = ">= 2.3.0"
 
-  spec.add_development_dependency("rspec", ["~> 3.0"])
-  spec.add_development_dependency("timecop")
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "appraisal"
+  spec.add_development_dependency "bundler"
 end

metadata

@@ -1,59 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: lumberjack
 version: !ruby/object:Gem::Version
-  version: 1.2.7
+  version: 1.2.9
 platform: ruby
 authors:
 - Brian Durand
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-30 00:00:00.000000000 Z
+date: 2023-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: timecop
-  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: appraisal
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -66,7 +24,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - bbdurand@gmail.com
 executables: []
@@ -97,6 +55,7 @@ files:
 - lib/lumberjack/formatter/string_formatter.rb
 - lib/lumberjack/formatter/strip_formatter.rb
 - lib/lumberjack/formatter/structured_formatter.rb
+- lib/lumberjack/formatter/truncate_formatter.rb
 - lib/lumberjack/log_entry.rb
 - lib/lumberjack/logger.rb
 - lib/lumberjack/rack.rb
@@ -114,7 +73,7 @@ homepage: https://github.com/bdurand/lumberjack
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -129,8 +88,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.4.12
+signing_key:
 specification_version: 4
 summary: A simple, powerful, and very fast logging utility that can be a drop in replacement
   for Logger or ActiveSupport::BufferedLogger.