lumberjack 1.2.7 → 1.2.9

data/lib/lumberjack/logger.rb

@@ -63,7 +63,10 @@ module Lumberjack
     # * :max_size - If the log device is a file path, it will be a Device::SizeRollingLogFile if this is set.
     #
     # All other options are passed to the device constuctor.
-    def initialize(device = STDOUT, options = {})
+    #
+    # @param [Lumberjack::Device, Object, Symbol, String] device The device to log to.
+    # @param [Hash] options The options for the logger.
+    def initialize(device = $stdout, options = {})
       options = options.dup
       self.level = options.delete(:level) || INFO
       self.progname = options.delete(:progname)
@@ -83,11 +86,16 @@ module Lumberjack
     end
 
     # Get the timestamp format on the device if it has one.
+    #
+    # @return [String, nil] The timestamp format or nil if the device doesn't support it.
     def datetime_format
       device.datetime_format if device.respond_to?(:datetime_format)
     end
 
     # Set the timestamp format on the device if it is supported.
+    #
+    # @param [String] format The timestamp format.
+    # @return [void]
     def datetime_format=(format)
       if device.respond_to?(:datetime_format=)
         device.datetime_format = format
@@ -96,6 +104,8 @@ module Lumberjack
 
     # Get the level of severity of entries that are logged. Entries with a lower
     # severity level will be ignored.
+    #
+    # @return [Integer] The severity level.
     def level
       thread_local_value(:lumberjack_logger_level) || @level
     end
@@ -104,22 +114,30 @@ module Lumberjack
 
     # Set the log level using either an integer level like Logger::INFO or a label like
     # :info or "info"
+    #
+    # @param [Integer, Symbol, String] value The severity level.
+    # @return [void]
     def level=(value)
-      if value.is_a?(Integer)
-        @level = value
+      @level = if value.is_a?(Integer)
+        value
       else
-        @level = Severity::label_to_level(value)
+        Severity.label_to_level(value)
       end
     end
 
     alias_method :sev_threshold=, :level=
 
     # Set the Lumberjack::Formatter used to format objects for logging as messages.
+    #
+    # @param [Lumberjack::Formatter, Object] value The formatter to use.
+    # @return [void]
     def formatter=(value)
       @_formatter = (value.is_a?(TaggedLoggerSupport::Formatter) ? value.__formatter : value)
     end
 
     # Get the Lumberjack::Formatter used to format objects for logging as messages.
+    #
+    # @return [Lumberjack::Formatter] The formatter.
     def formatter
       if respond_to?(:tagged)
         # Wrap in an object that supports ActiveSupport::TaggedLogger API
@@ -136,8 +154,10 @@ module Lumberjack
     # The tags added with this method are just strings so they are stored in the logger tags
     # in an array under the "tagged" tag. So calling `logger.tagged("foo", "bar")` will result
     # in tags `{"tagged" => ["foo", "bar"]}`.
+    #
+    # @return [Lumberjack::Logger] self.
     def tagged_logger!
-      self.extend(TaggedLoggerSupport)
+      extend(TaggedLoggerSupport)
       self
     end
 
@@ -149,7 +169,13 @@ module Lumberjack
     # The severity can be passed in either as one of the Severity constants,
     # or as a Severity label.
     #
-    # === Example
+    # @param [Integer, Symbol, String] severity The severity of the message.
+    # @param [Object] message The message to log.
+    # @param [String] progname The name of the program that is logging the message.
+    # @param [Hash] tags The tags to add to the log entry.
+    # @return [void]
+    #
+    # @example
     #
     #   logger.add_entry(Logger::ERROR, exception)
     #   logger.add_entry(Logger::INFO, "Request completed")
@@ -173,10 +199,10 @@ module Lumberjack
         if current_tags.empty?
           tags = Tags.stringify_keys(tags) unless tags.nil?
         else
-          if tags.nil?
-            tags = current_tags.dup
+          tags = if tags.nil?
+            current_tags.dup
           else
-            tags = current_tags.merge(Tags.stringify_keys(tags))
+            current_tags.merge(Tags.stringify_keys(tags))
           end
         end
         tags = Tags.expand_runtime_values(tags)
@@ -191,6 +217,11 @@ module Lumberjack
     end
 
     # ::Logger compatible method to add a log entry.
+    #
+    # @param [Integer, Symbol, String] severity The severity of the message.
+    # @param [Object] message The message to log.
+    # @param [String] progname The name of the program that is logging the message.
+    # @return [void]
     def add(severity, message = nil, progname = nil, &block)
       if message.nil?
         if block
@@ -206,6 +237,8 @@ module Lumberjack
     alias_method :log, :add
 
     # Flush the logging device. Messages are not guaranteed to be written until this method is called.
+    #
+    # @return [void]
     def flush
       device.flush
       @last_flushed_at = Time.now
@@ -213,102 +246,170 @@ module Lumberjack
     end
 
     # Close the logging device.
+    #
+    # @return [void]
     def close
       flush
       device.close if device.respond_to?(:close)
       @closed = true
     end
 
+    # Returns +true+ if the logging device is closed.
+    #
+    # @return [Boolean] +true+ if the logging device is closed.
     def closed?
       @closed
     end
 
+    # Reopen the logging device.
+    #
+    # @param [Object] logdev passed through to the logging device.
     def reopen(logdev = nil)
       @closed = false
       device.reopen(logdev) if device.respond_to?(:reopen)
     end
 
     # Log a +FATAL+ message. The message can be passed in either the +message+ argument or in a block.
+    #
+    # @param [Object] message_or_progname_or_tags The message to log or progname
+    #   if the message is passed in a block.
+    # @param [String, Hash] progname_or_tags The name of the program that is logging the message or tags
+    #   if the message is passed in a block.
+    # @return [void]
     def fatal(message_or_progname_or_tags = nil, progname_or_tags = nil, &block)
       call_add_entry(FATAL, message_or_progname_or_tags, progname_or_tags, &block)
     end
 
     # Return +true+ if +FATAL+ messages are being logged.
+    #
+    # @return [Boolean]
     def fatal?
       level <= FATAL
     end
 
     # Set the log level to fatal.
+    #
+    # @return [void]
     def fatal!
       self.level = FATAL
     end
 
     # Log an +ERROR+ message. The message can be passed in either the +message+ argument or in a block.
+    #
+    # @param [Object] message_or_progname_or_tags The message to log or progname
+    #   if the message is passed in a block.
+    # @param [String, Hash] progname_or_tags The name of the program that is logging the message or tags
+    #   if the message is passed in a block.
+    # @return [void]
     def error(message_or_progname_or_tags = nil, progname_or_tags = nil, &block)
       call_add_entry(ERROR, message_or_progname_or_tags, progname_or_tags, &block)
     end
 
     # Return +true+ if +ERROR+ messages are being logged.
+    #
+    # @return [Boolean]
     def error?
       level <= ERROR
     end
 
     # Set the log level to error.
+    #
+    # @return [void]
     def error!
       self.level = ERROR
     end
 
     # Log a +WARN+ message. The message can be passed in either the +message+ argument or in a block.
+    #
+    # @param [Object] message_or_progname_or_tags The message to log or progname
+    #   if the message is passed in a block.
+    # @param [String, Hash] progname_or_tags The name of the program that is logging the message or tags
+    #   if the message is passed in a block.
+    # @return [void]
     def warn(message_or_progname_or_tags = nil, progname_or_tags = nil, &block)
       call_add_entry(WARN, message_or_progname_or_tags, progname_or_tags, &block)
     end
 
     # Return +true+ if +WARN+ messages are being logged.
+    #
+    # @return [Boolean]
     def warn?
       level <= WARN
     end
 
     # Set the log level to warn.
+    #
+    # @return [void]
     def warn!
       self.level = WARN
     end
 
     # Log an +INFO+ message. The message can be passed in either the +message+ argument or in a block.
+    #
+    # @param [Object] message_or_progname_or_tags The message to log or progname
+    #   if the message is passed in a block.
+    # @param [String] progname_or_tags The name of the program that is logging the message or tags
+    #   if the message is passed in a block.
+    # @return [void]
     def info(message_or_progname_or_tags = nil, progname_or_tags = nil, &block)
       call_add_entry(INFO, message_or_progname_or_tags, progname_or_tags, &block)
     end
 
     # Return +true+ if +INFO+ messages are being logged.
+    #
+
     def info?
       level <= INFO
     end
 
     # Set the log level to info.
+    #
+    # @return [void]
     def info!
       self.level = INFO
     end
 
     # Log a +DEBUG+ message. The message can be passed in either the +message+ argument or in a block.
+    #
+    # @param [Object] message_or_progname_or_tags The message to log or progname
+    #   if the message is passed in a block.
+    # @param [String, Hash] progname_or_tags The name of the program that is logging the message or tags
+    #   if the message is passed in a block.
+    # @return [void]
     def debug(message_or_progname_or_tags = nil, progname_or_tags = nil, &block)
       call_add_entry(DEBUG, message_or_progname_or_tags, progname_or_tags, &block)
     end
 
     # Return +true+ if +DEBUG+ messages are being logged.
+    #
+    # @return [Boolean]
     def debug?
       level <= DEBUG
     end
 
     # Set the log level to debug.
+    #
+    # @return [void]
     def debug!
       self.level = DEBUG
     end
 
     # Log a message when the severity is not known. Unknown messages will always appear in the log.
     # The message can be passed in either the +message+ argument or in a block.
+    #
+    # @param [Object] message_or_progname_or_tags The message to log or progname
+    #   if the message is passed in a block.
+    # @param [String, Hash] progname_or_tags The name of the program that is logging the message or tags
+    #   if the message is passed in a block.
+    # @return [void]
     def unknown(message_or_progname_or_tags = nil, progname_or_tags = nil, &block)
       call_add_entry(UNKNOWN, message_or_progname_or_tags, progname_or_tags, &block)
     end
 
+    # Add a message when the severity is not known.
+    #
+    # @param [Object] msg The message to log.
+    # @return [void]
     def <<(msg)
       add_entry(UNKNOWN, msg)
     end
@@ -316,7 +417,10 @@ module Lumberjack
     # Silence the logger by setting a new log level inside a block. By default, only +ERROR+ or +FATAL+
     # messages will be logged.
     #
-    # === Example
+    # @param [Integer, String, Symbol] temporary_level The log level to use inside the block.
+    # @return [Object] The result of the block.
+    #
+    # @example
     #
     #   logger.level = Logger::INFO
     #   logger.silence do
@@ -325,7 +429,7 @@ module Lumberjack
     def silence(temporary_level = ERROR, &block)
       if silencer
         unless temporary_level.is_a?(Integer)
-          temporary_level = Severity::label_to_level(temporary_level)
+          temporary_level = Severity.label_to_level(temporary_level)
         end
         push_thread_local_value(:lumberjack_logger_level, temporary_level, &block)
       else
@@ -335,6 +439,9 @@ module Lumberjack
 
     # Set the program name that is associated with log messages. If a block
     # is given, the program name will be valid only within the block.
+    #
+    # @param [String] value The program name to use.
+    # @return [void]
     def set_progname(value, &block)
       if block
         push_thread_local_value(:lumberjack_logger_progname, value, &block)
@@ -344,6 +451,8 @@ module Lumberjack
     end
 
     # Get the program name associated with log messages.
+    #
+    # @return [String]
     def progname
       thread_local_value(:lumberjack_logger_progname) || @progname
     end
@@ -353,6 +462,9 @@ module Lumberjack
     # the tags will only be defined on the tags in that block. When the parent block
     # exits, all the tags will be reverted. If there is no block, then the tags will
     # be defined as global and apply to all log statements.
+    #
+    # @param [Hash] tags The tags to set.
+    # @return [void]
     def tag(tags, &block)
       tags = Tags.stringify_keys(tags)
       thread_tags = thread_local_value(:lumberjack_logger_tags)
@@ -361,15 +473,19 @@ module Lumberjack
         push_thread_local_value(:lumberjack_logger_tags, merged_tags, &block)
       elsif thread_tags
         thread_tags.merge!(tags)
+        nil
       else
         @tags.merge!(tags)
+        nil
       end
-      nil
     end
 
     # Remove a tag from the current tag context. If this is called inside a block to a
     # call to `tag`, the tags will only be removed for the duration of that block. Otherwise
     # they will be removed from the global tags.
+    #
+    # @param [Array<String, Symbol>] tag_names The tags to remove.
+    # @return [void]
     def remove_tag(*tag_names)
       thread_tags = thread_local_value(:lumberjack_logger_tags)
       if thread_tags
@@ -380,21 +496,43 @@ module Lumberjack
     end
 
     # Return all tags in scope on the logger including global tags set on the Lumberjack
-    # context, tags set on the logger, and tags set on the current block for the logger
+    # context, tags set on the logger, and tags set on the current block for the logger.
+    #
+    # @return [Hash]
     def tags
       tags = {}
       context_tags = Lumberjack.context_tags
       tags.merge!(context_tags) if context_tags && !context_tags.empty?
-      tags.merge!(@tags) if !@tags.empty?
+      tags.merge!(@tags) if !@tags.empty? && !thread_local_value(:lumberjack_logger_untagged)
       scope_tags = thread_local_value(:lumberjack_logger_tags)
       tags.merge!(scope_tags) if scope_tags && !scope_tags.empty?
       tags
     end
 
+    # Remove all tags on the current logger and logging context within a block.
+    # You can still set new block scoped tags within theuntagged block and provide
+    # tags on individual log methods.
+    #
+    # @return [void]
+    def untagged(&block)
+      Lumberjack.use_context(nil) do
+        scope_tags = thread_local_value(:lumberjack_logger_tags)
+        untagged = thread_local_value(:lumberjack_logger_untagged)
+        begin
+          set_thread_local_value(:lumberjack_logger_untagged, true)
+          set_thread_local_value(:lumberjack_logger_tags, nil)
+          tag({}, &block)
+        ensure
+          set_thread_local_value(:lumberjack_logger_untagged, untagged)
+          set_thread_local_value(:lumberjack_logger_tags, scope_tags)
+        end
+      end
+    end
+
     private
 
     # Dereference arguments to log calls so we can have methods with compatibility with ::Logger
-    def call_add_entry(severity, message_or_progname_or_tags, progname_or_tags, &block) #:nodoc:
+    def call_add_entry(severity, message_or_progname_or_tags, progname_or_tags, &block) # :nodoc:
       message = nil
       progname = nil
       tags = nil
@@ -419,7 +557,7 @@ module Lumberjack
     end
 
     # Set a local value for a thread tied to this object.
-    def set_thread_local_value(name, value) #:nodoc:
+    def set_thread_local_value(name, value) # :nodoc:
       values = Thread.current[name]
       unless values
         values = {}
@@ -434,13 +572,13 @@ module Lumberjack
     end
 
     # Get a local value for a thread tied to this object.
-    def thread_local_value(name) #:nodoc:
+    def thread_local_value(name) # :nodoc:
       values = Thread.current[name]
       values[self] if values
     end
 
     # Set a local value for a thread tied to this object within a block.
-    def push_thread_local_value(name, value) #:nodoc:
+    def push_thread_local_value(name, value) # :nodoc:
       save_val = thread_local_value(name)
       set_thread_local_value(name, value)
       begin
@@ -451,7 +589,7 @@ module Lumberjack
     end
 
     # Open a logging device.
-    def open_device(device, options) #:nodoc:
+    def open_device(device, options) # :nodoc:
       if device.nil?
         nil
       elsif device.is_a?(Device)
@@ -472,27 +610,27 @@ module Lumberjack
       end
     end
 
-    def write_to_device(entry) #:nodoc:
-      begin
-        device.write(entry)
-      rescue => e
-        $stderr.puts("#{e.class.name}: #{e.message}#{' at ' + e.backtrace.first if e.backtrace}")
-        $stderr.puts(entry.to_s)
-      end
+    def write_to_device(entry) # :nodoc:
+      device.write(entry)
+    rescue => e
+      # rubocop:disable Style/StderrPuts
+      $stderr.puts("#{e.class.name}: #{e.message}#{" at " + e.backtrace.first if e.backtrace}")
+      $stderr.puts(entry.to_s)
+      # rubocop:enable Style/StderrPuts
     end
 
     # Create a thread that will periodically call flush.
-    def create_flusher_thread(flush_seconds) #:nodoc:
+    def create_flusher_thread(flush_seconds) # :nodoc:
       if flush_seconds > 0
         begin
           logger = self
           Thread.new do
-            while !closed?
+            until closed?
               begin
                 sleep(flush_seconds)
                 logger.flush if Time.now - logger.last_flushed_at >= flush_seconds
               rescue => e
-                $stderr.puts("Error flushing log: #{e.inspect}")
+                warn("Error flushing log: #{e.inspect}")
               end
             end
           end

data/lib/lumberjack/rack/request_id.rb

@@ -16,7 +16,7 @@ module Lumberjack
       def call(env)
         request_id = env[REQUEST_ID]
         if request_id && @abbreviated
-          request_id = request_id.split('-', 2).first
+          request_id = request_id.split("-", 2).first
         end
         Lumberjack.unit_of_work(request_id) do
           @app.call(env)

data/lib/lumberjack/rack/unit_of_work.rb

@@ -6,7 +6,7 @@ module Lumberjack
       def initialize(app)
         @app = app
       end
-      
+
       def call(env)
         Lumberjack.unit_of_work do
           @app.call(env)

data/lib/lumberjack/rack.rb

@@ -2,8 +2,8 @@
 
 module Lumberjack
   module Rack
-    require_relative "rack/unit_of_work.rb"
-    require_relative "rack/request_id.rb"
-    require_relative "rack/context.rb"
+    require_relative "rack/unit_of_work"
+    require_relative "rack/request_id"
+    require_relative "rack/context"
   end
 end

data/lib/lumberjack/severity.rb

@@ -11,17 +11,24 @@ module Lumberjack
     FATAL = ::Logger::Severity::FATAL
     UNKNOWN = ::Logger::Severity::UNKNOWN
 
-    SEVERITY_LABELS = %w(DEBUG INFO WARN ERROR FATAL UNKNOWN).freeze
+    SEVERITY_LABELS = %w[DEBUG INFO WARN ERROR FATAL UNKNOWN].freeze
 
     class << self
+      # Convert a severity level to a label.
+      #
+      # @param [Integer] severity The severity level to convert.
+      # @return [String] The severity label.
       def level_to_label(severity)
         SEVERITY_LABELS[severity] || SEVERITY_LABELS.last
       end
 
+      # Convert a severity label to a level.
+      #
+      # @param [String, Symbol] label The severity label to convert.
+      # @return [Integer] The severity level.
       def label_to_level(label)
         SEVERITY_LABELS.index(label.to_s.upcase) || UNKNOWN
       end
     end
-
   end
 end

data/lib/lumberjack/tag_formatter.rb

@@ -9,7 +9,6 @@ module Lumberjack
   # tag_formatter.add(["password", "email"]) { |value| "***" }
   # tag_formatter.add("finished_at", Lumberjack::Formatter::DateTimeFormatter.new("%Y-%m-%dT%H:%m:%S%z"))
   class TagFormatter
-
     def initialize
       @formatters = {}
       @default_formatter = nil
@@ -17,6 +16,10 @@ module Lumberjack
 
     # Add a default formatter applied to all tag values. This can either be a Lumberjack::Formatter
     # or an object that responds to `call` or a block.
+    #
+    # @param [Lumberjack::Formatter, #call, nil] formatter The formatter to use.
+    #    If this is nil, then the block will be used as the formatter.
+    # @return [Lumberjack::TagFormatter] self
     def default(formatter = nil, &block)
       formatter ||= block
       formatter = dereference_formatter(formatter)
@@ -25,6 +28,8 @@ module Lumberjack
     end
 
     # Remove the default formatter.
+    #
+    # @return [Lumberjack::TagFormatter] self
     def remove_default
       @default_formatter = nil
       self
@@ -33,6 +38,11 @@ module Lumberjack
     # Add a formatter for specific tag names. This can either be a Lumberjack::Formatter
     # or an object that responds to `call` or a block. The default formatter will not be
     # applied.
+    #
+    # @param [String, Array<String>] names The tag names to apply the formatter to.
+    # @param [Lumberjack::Formatter, #call, nil] formatter The formatter to use.
+    #    If this is nil, then the block will be used as the formatter.
+    # @return [Lumberjack::TagFormatter] self
     def add(names, formatter = nil, &block)
       formatter ||= block
       formatter = dereference_formatter(formatter)
@@ -47,6 +57,9 @@ module Lumberjack
     end
 
     # Remove formatters for specific tag names. The default formatter will still be applied.
+    #
+    # @param [String, Array<String>] names The tag names to remove the formatter from.
+    # @return [Lumberjack::TagFormatter] self
     def remove(names)
       Array(names).each do |name|
         @formatters.delete(name.to_s)
@@ -55,6 +68,8 @@ module Lumberjack
     end
 
     # Remove all formatters.
+    #
+    # @return [Lumberjack::TagFormatter] self
     def clear
       @default_formatter = nil
       @formatters.clear
@@ -62,6 +77,9 @@ module Lumberjack
     end
 
     # Format a hash of tags using the formatters
+    #
+    # @param [Hash] tags The tags to format.
+    # @return [Hash] The formatted tags.
     def format(tags)
       return nil if tags.nil?
       if @default_formatter.nil? && (@formatters.empty? || (@formatters.keys & tags.keys).empty?)
@@ -87,12 +105,11 @@ module Lumberjack
       if formatter.is_a?(TaggedLoggerSupport::Formatter)
         formatter.__formatter
       elsif formatter.is_a?(Symbol)
-        formatter_class_name = "#{formatter.to_s.gsub(/(^|_)([a-z])/){|m| $~[2].upcase}}Formatter"
+        formatter_class_name = "#{formatter.to_s.gsub(/(^|_)([a-z])/) { |m| $~[2].upcase }}Formatter"
         Formatter.const_get(formatter_class_name).new
       else
         formatter
       end
     end
-
   end
 end

data/lib/lumberjack/tagged_logger_support.rb

@@ -6,7 +6,6 @@ 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!
@@ -56,7 +55,7 @@ module Lumberjack
 
     def pop_tags(size = 1)
       tagged_values = Array(@tags["tagged"])
-      tagged_values = (tagged_values.size > size ? tagged_values[0, tagged_values.size - size] : nil)
+      tagged_values = ((tagged_values.size > size) ? tagged_values[0, tagged_values.size - size] : nil)
       tag("tagged" => tagged_values)
     end
 

data/lib/lumberjack/tagged_logging.rb

@@ -10,7 +10,7 @@ module Lumberjack
         base.singleton_class.send(:prepend, ClassMethods)
       end
     end
-    
+
     module ClassMethods
       def new(logger)
         if logger.is_a?(Lumberjack::Logger)

data/lib/lumberjack/tags.rb

@@ -5,6 +5,9 @@ module Lumberjack
     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.
       def stringify_keys(hash)
         return nil if hash.nil?
         if hash.keys.all? { |key| key.is_a?(String) }
@@ -22,12 +25,15 @@ module Lumberjack
 
       # Ensure keys are strings and expand any values in a hash that are Proc's by calling them and replacing
       # the value with the result. This allows setting global tags with runtime values.
+      #
+      # @param [Hash] hash The hash to transform.
+      # @return [Hash] The hash with string keys and expanded values.
       def expand_runtime_values(hash)
         return nil if hash.nil?
         if hash.all? { |key, value| key.is_a?(String) && !value.is_a?(Proc) }
           return hash
         end
-        
+
         copy = {}
         hash.each do |key, value|
           if value.is_a?(Proc) && (value.arity == 0 || value.arity == -1)