lumberjack 1.2.8 → 1.2.9

data/lib/lumberjack/template.rb

@@ -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)
 
@@ -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

@@ -6,7 +6,7 @@ require "securerandom"
 require "logger"
 
 module Lumberjack
-  LINE_SEPARATOR = (RbConfig::CONFIG["host_os"] =~ /mswin/i ? "\r\n" : "\n")
+  LINE_SEPARATOR = ((RbConfig::CONFIG["host_os"] =~ /mswin/i) ? "\r\n" : "\n")
 
   require_relative "lumberjack/severity"
   require_relative "lumberjack/formatter"
@@ -32,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
@@ -41,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
@@ -53,6 +58,8 @@ 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.
+    #
+    # @return [Lumberjack::Context] The current context if called without a block.
     def context(&block)
       current_context = Thread.current[:lumberjack_context]
       if block
@@ -63,6 +70,9 @@ module Lumberjack
     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
@@ -74,17 +84,24 @@ module Lumberjack
     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
     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)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lumberjack
 version: !ruby/object:Gem::Version
-  version: 1.2.8
+  version: 1.2.9
 platform: ruby
 authors:
 - Brian Durand
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-31 00:00:00.000000000 Z
+date: 2023-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,7 +24,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - bbdurand@gmail.com
 executables: []
@@ -55,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
@@ -72,7 +73,7 @@ homepage: https://github.com/bdurand/lumberjack
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -87,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.