lumberjack 1.0.13 → 1.1.0

data/lib/lumberjack/rack.rb

@@ -2,7 +2,8 @@
 
 module Lumberjack
   module Rack
-    require File.expand_path("../rack/unit_of_work.rb", __FILE__)
-    require File.expand_path("../rack/request_id.rb", __FILE__)
+    require_relative "rack/unit_of_work.rb"
+    require_relative "rack/request_id.rb"
+    require_relative "rack/context.rb"
   end
 end

data/lib/lumberjack/rack/context.rb

@@ -0,0 +1,18 @@
+# frozen_string_literals: true
+
+module Lumberjack
+  module Rack
+    # Middleware to create a global context for Lumberjack for the scope of a rack request.
+    class Context
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        Lumberjack.context do
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/lumberjack/rack/request_id.rb

@@ -6,17 +6,17 @@ module Lumberjack
     # The format is expected to be a random UUID and only the first chunk is used for terseness
     # if the abbreviated argument is true.
     class RequestId
-      REQUEST_ID = "action_dispatch.request_id".freeze
-  
+      REQUEST_ID = "action_dispatch.request_id"
+
       def initialize(app, abbreviated = false)
         @app = app
         @abbreviated = abbreviated
       end
-  
+
       def call(env)
         request_id = env[REQUEST_ID]
         if request_id && @abbreviated
-          request_id = request_id.split('-'.freeze, 2).first
+          request_id = request_id.split('-', 2).first
         end
         Lumberjack.unit_of_work(request_id) do
           @app.call(env)

data/lib/lumberjack/severity.rb

@@ -3,23 +3,25 @@
 module Lumberjack
   # The standard severity levels for logging messages.
   module Severity
-    UNKNOWN = 5
-    FATAL = 4
-    ERROR = 3
-    WARN = 2
-    INFO = 1
-    DEBUG = 0
-    
+    # Backward compatibilty with 1.0 API
+    DEBUG = ::Logger::Severity::DEBUG
+    INFO = ::Logger::Severity::INFO
+    WARN = ::Logger::Severity::WARN
+    ERROR = ::Logger::Severity::ERROR
+    FATAL = ::Logger::Severity::FATAL
+    UNKNOWN = ::Logger::Severity::UNKNOWN
+
     SEVERITY_LABELS = %w(DEBUG INFO WARN ERROR FATAL UNKNOWN).freeze
-    
+
     class << self
       def level_to_label(severity)
         SEVERITY_LABELS[severity] || SEVERITY_LABELS.last
       end
-    
+
       def label_to_level(label)
         SEVERITY_LABELS.index(label.to_s.upcase) || UNKNOWN
       end
     end
+
   end
 end

data/lib/lumberjack/tags.rb

@@ -0,0 +1,24 @@
+# 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.
+      def stringify_keys(hash)
+        return nil if hash.nil?
+        if hash.keys.all? { |key| key.is_a?(String) }
+          hash
+        elsif hash.respond_to?(:transform_keys)
+          hash.transform_keys(&:to_s)
+        else
+          copy = {}
+          hash.each do |key, value|
+            copy[key.to_s] = value
+          end
+          copy
+        end
+      end
+    end
+  end
+end

data/lib/lumberjack/template.rb

@@ -4,70 +4,112 @@ module Lumberjack
   # A template converts entries to strings. Templates can contain the following place holders to
   # reference log entry values:
   #
-  # * <tt>:time</tt>
-  # * <tt>:severity</tt>
-  # * <tt>:progname</tt>
-  # * <tt>:unit_of_work_id</tt>
-  # * <tt>:message</tt>
+  # * :time
+  # * :severity
+  # * :progname
+  # * :tags
+  # * :message
+  #
+  # Any other words prefixed with a colon will be substituted with the value of the tag with that name.
   class Template
-    TEMPLATE_ARGUMENT_ORDER = %w(:time :severity :progname :pid :unit_of_work_id :message).freeze
-    DEFAULT_TIME_FORMAT = "%Y-%m-%dT%H:%M:%S."
-    MILLISECOND_FORMAT = "%03d"
-    MICROSECOND_FORMAT = "%06d"
-    
+    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"
+
     # Create a new template from the markup. The +first_line+ argument is used to format only the first
     # line of a message. Additional lines will be added to the message unformatted. If you wish to format
-    # the additional lines, use the <tt>:additional_lines</tt> options to specify a template. Note that you'll need
+    # the additional lines, use the :additional_lines options to specify a template. Note that you'll need
     # to provide the line separator character in this template if you want to keep the message on multiple lines.
     #
     # The time will be formatted as YYYY-MM-DDTHH:MM:SSS.SSS by default. If you wish to change the format, you
-    # can specify the <tt>:time_format</tt> option which can be either a time format template as documented in
+    # can specify the :time_format option which can be either a time format template as documented in
     # +Time#strftime+ or the values +:milliseconds+ or +:microseconds+ to use the standard format with the
     # specified precision.
     #
     # Messages will have white space stripped from both ends.
     def initialize(first_line, options = {})
-      @first_line_template = compile(first_line)
+      @first_line_template, @first_line_tags = compile(first_line)
       additional_lines = options[:additional_lines] || "#{Lumberjack::LINE_SEPARATOR}:message"
-      @additional_line_template = compile(additional_lines)
+      @additional_line_template, @additional_line_tags = compile(additional_lines)
       # Formatting the time is relatively expensive, so only do it if it will be used
       @template_include_time = first_line.include?(":time") || additional_lines.include?(":time")
-      @time_format = options[:time_format] || :milliseconds
+      self.datetime_format = (options[:time_format] || :milliseconds)
+    end
+
+    def datetime_format=(format)
+      if format == :milliseconds
+        format = MILLISECOND_TIME_FORMAT
+      elsif format == :microseconds
+        format = MICROSECOND_TIME_FORMAT
+      end
+      @time_formatter = Formatter::DateTimeFormatter.new(format)
     end
-    
+
+    def datetime_format
+      @time_formatter.format
+    end
+
     # Convert an entry into a string using the template.
     def call(entry)
-      lines = entry.message.strip.split(Lumberjack::LINE_SEPARATOR)
-      formatted_time = format_time(entry.time) if @template_include_time
-      message = @first_line_template % [formatted_time, entry.severity_label, entry.progname, entry.pid, entry.unit_of_work_id, lines.shift]
-      lines.each do |line|
-        message << @additional_line_template % [formatted_time, entry.severity_label, entry.progname, entry.pid, entry.unit_of_work_id, line]
+      return entry unless entry.is_a?(LogEntry)
+
+      first_line = entry.message.to_s
+      additional_lines = nil
+      if first_line.include?(Lumberjack::LINE_SEPARATOR)
+        additional_lines = first_line.split(Lumberjack::LINE_SEPARATOR)
+        first_line = additional_lines.shift
+      end
+
+      formatted_time = @time_formatter.call(entry.time) if @template_include_time
+      format_args = [formatted_time, entry.severity_label, entry.progname, entry.pid, first_line]
+      tag_arguments = tag_args(entry.tags, @first_line_tags)
+      message = (@first_line_template % (format_args + tag_arguments))
+      message.rstrip! if message.end_with?(" ")
+
+      if additional_lines && !additional_lines.empty?
+        tag_arguments = tag_args(entry.tags, @additional_line_tags) unless @additional_line_tags == @first_line_tags
+        additional_lines.each do |line|
+          format_args[format_args.size - 1] = line
+          line_message = (@additional_line_template % (format_args + tag_arguments)).rstrip
+          line_message.rstrip! if line_message.end_with?(" ")
+          message << line_message
+        end
       end
       message
     end
-    
+
     private
 
-    def format_time(time) #:nodoc:
-      if @time_format.is_a?(String)
-        time.strftime(@time_format)
-      elsif @time_format == :milliseconds
-        time.strftime(DEFAULT_TIME_FORMAT) << MILLISECOND_FORMAT % (time.usec / 1000.0).round
-      else
-        time.strftime(DEFAULT_TIME_FORMAT) << MICROSECOND_FORMAT % time.usec
+    def tag_args(tags, tag_vars)
+      return [nil] * (tag_vars.size + 1) if tags.nil? || tags.size == 0
+
+      tags_string = String.new
+      tags.each do |name, value|
+        unless tag_vars.include?(name)
+          tags_string << "[#{name}:#{value.inspect}] "
+        end
+      end
+
+      args = [tags_string.chop]
+      tag_vars.each do |name|
+        args << tags[name]
       end
+      args
     end
-    
+
     # Compile the template string into a value that can be used with sprintf.
     def compile(template) #:nodoc:
-      template.gsub(/:[a-z0-9_]+/) do |match|
+      tag_vars = []
+      template = template.gsub(/:[a-z0-9_]+/) do |match|
         position = TEMPLATE_ARGUMENT_ORDER.index(match)
         if position
           "%#{position + 1}$s"
         else
-          match
+          tag_vars << match[1, match.length]
+          "%#{TEMPLATE_ARGUMENT_ORDER.size + tag_vars.size}$s"
         end
       end
+      [template, tag_vars]
     end
   end
 end

data/lumberjack.gemspec

@@ -0,0 +1,35 @@
+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.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"
+  spec.license = "MIT"
+
+  # 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(
+    .gitignore
+    .travis.yml
+    Appraisals
+    Gemfile
+    Gemfile.lock
+    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) } }
+  end
+
+  spec.require_paths = ['lib']
+
+  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"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lumberjack
 version: !ruby/object:Gem::Version
-  version: 1.0.13
+  version: 1.1.0
 platform: ruby
 authors:
 - Brian Durand
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-29 00:00:00.000000000 Z
+date: 2020-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -28,76 +28,88 @@ dependencies:
   name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.8'
+        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.8'
-description: A simple, powerful, and very fast logging utility that can be a drop
-  in replacement for Logger or ActiveSupport::BufferedLogger. Provides support for
-  automatically rolling log files even with multiple processes writing the same log
-  file.
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  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'
+description: 
 email:
 - bbdurand@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - MIT_LICENSE
 - README.md
-- Rakefile
 - VERSION
 - lib/lumberjack.rb
+- lib/lumberjack/context.rb
 - lib/lumberjack/device.rb
 - lib/lumberjack/device/date_rolling_log_file.rb
 - lib/lumberjack/device/log_file.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/writer.rb
 - lib/lumberjack/formatter.rb
+- lib/lumberjack/formatter/date_time_formatter.rb
 - lib/lumberjack/formatter/exception_formatter.rb
+- lib/lumberjack/formatter/id_formatter.rb
 - lib/lumberjack/formatter/inspect_formatter.rb
+- lib/lumberjack/formatter/object_formatter.rb
 - lib/lumberjack/formatter/pretty_print_formatter.rb
 - lib/lumberjack/formatter/string_formatter.rb
+- lib/lumberjack/formatter/structured_formatter.rb
 - lib/lumberjack/log_entry.rb
 - lib/lumberjack/logger.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/severity.rb
+- lib/lumberjack/tags.rb
 - lib/lumberjack/template.rb
-- spec/device/date_rolling_log_file_spec.rb
-- spec/device/log_file_spec.rb
-- spec/device/null_spec.rb
-- spec/device/rolling_log_file_spec.rb
-- spec/device/size_rolling_log_file_spec.rb
-- spec/device/writer_spec.rb
-- spec/formatter/exception_formatter_spec.rb
-- spec/formatter/inspect_formatter_spec.rb
-- spec/formatter/pretty_print_formatter_spec.rb
-- spec/formatter/string_formatter_spec.rb
-- spec/formatter_spec.rb
-- spec/log_entry_spec.rb
-- spec/logger_spec.rb
-- spec/lumberjack_spec.rb
-- spec/rack/request_id_spec.rb
-- spec/rack/unit_of_work_spec.rb
-- spec/severity_spec.rb
-- spec/spec_helper.rb
-- spec/template_spec.rb
+- lumberjack.gemspec
 homepage: https://github.com/bdurand/lumberjack
 licenses:
 - MIT
-metadata:
-  homepage_uri: https://github.com/bdurand/lumberjack
-  changelog_uri: https://github.com/bdurand/lumberjack/blob/master/CHANGELOG.md
-  source_code_uri: https://github.com/bdurand/lumberjack
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -106,15 +118,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A simple, powerful, and very fast logging utility that can be a drop in replacement