lumberjack 1.2.7 → 1.2.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ba28430c423311445a80559e0bd6fdfbfdfed90edcd4dda89d9e5d635d75ec9
-  data.tar.gz: 5507d016ad2b7dcf13e38616496e2b9e5c18e456eb1ad6bdfeceb66386eae403
+  metadata.gz: 9d05405664f1f85b1a68eb24c21a89d3b57ea8caf09513a348a138d53f1870b0
+  data.tar.gz: 1ccc42fdd657ab4acf89bab8bfd7fb5e7d69d3825367483c49ee10c5c6e037d1
 SHA512:
-  metadata.gz: 7bf2c9640012487f994d8e4eaabf85e9b4a3fbae828d0a0bccab71cfa7af8820da199b72d04764db4b6d9e7439ac620f49578b0a20b8c77c01f4ea496616ff4c
-  data.tar.gz: fb7d9b44ca1bbbd1a2727252c5b9f8885f8a374cd24e0fa34f38b9fca2cfa0444d603d15ccdec743c247251c0622d9153ecbe1b0d9c609da24b38511957ba190
+  metadata.gz: b48a0035d1adf22768071e6025692f001a8d13b931314ab0b6ea9131696bcb38d321db5fc1246bf2c49623cad26770bfdb32fe0e8e169ae455322e2693dad8e8
+  data.tar.gz: f80ae18348c1a3e5261aa27051d4cf3e087550e0d57d3a13459da6f7641e0ea270382478108127f03f6b7596faab27d8d3f92488fbbb2cb0c50c4d247ac61910

data/CHANGELOG.md

@@ -1,124 +1,182 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## 1.2.9
+
+### Added
+- Allow passing in formatters as class names when adding them.
+- Allow passing in formatters initialization arguments when adding them.
+- Add truncate formatter for capping the length of log messages.
+
+## 1.2.8
+
+### Added
+- Add `Logger#untagged` to remove previously set logging tags from a block.
+- Return result of the block when a block is passed to `Logger#tag`.
+
 ## 1.2.7
 
-* Allow passing frozen hashes to `Logger.tag`. Tags passed to this method are now duplicated so the logger maintains it's own copy of the hash.
+### Fixed
+- Allow passing frozen hashes to `Logger#tag`. Tags passed to this method are now duplicated so the logger maintains it's own copy of the hash.
 
 ## 1.2.6
 
-* Fix Logger#tag so it only ads to the current block's logger tags instead of the global tags if called inside a `Logger#tag` block.
-* Add Logger#remove_tag
+### Added
+- Add Logger#remove_tag
+
+### Fixed
+- Fix `Logger#tag` so it only ads to the current block's logger tags instead of the global tags if called inside a `Logger#tag` block.
+
 
 ## 1.2.5
 
-* Fix logic with recursive reference guard in StructuredFormatter so it only suppresses Enumerable references.
-* Add support for bang methods (error!) for setting the log level.
+### Added
+- Add support for bang methods (error!) for setting the log level.
+
+### Fixed
+- Fixed logic with recursive reference guard in StructuredFormatter so it only suppresses Enumerable references.
 
 ## 1.2.4
 
-* Enhance ActiveSupport::TaggedLogging support so code that Lumberjack loggers can be wrapped with a tagged logger.
+### Added
+- Enhance `ActiveSupport::TaggedLogging` support so code that Lumberjack loggers can be wrapped with a tagged logger.
 
 ## 1.2.3
 
-* Fix structured formatter so no-recursive, duplicate references are allowed.
+### Fixed
+- Fix structured formatter so no-recursive, duplicate references are allowed.
 
 ## 1.2.2
 
-* Prevent infinite loops in the structured formatter where objects have backreferences to each other.
+### Fixed
+- Prevent infinite loops in the structured formatter where objects have backreferences to each other.
 
 ## 1.2.1
 
-* Prevent infinite loops where logging a statement triggers the logger.
+### Fixed
+- Prevent infinite loops where logging a statement triggers the logger.
 
 ## 1.2.0
 
-* Enable compatibility with ActiveSupport::TaggedLogger by calling `tagged_logger!` on a logger.
-* Add `tag_formatter` to logger to specify formatting of tags for output.
-* Allow adding and removing classes by name to formatters.
-* Allow adding and removing multiple classes in a single call to a formatter.
-* Allow using symbols and strings as log level for silencing a logger.
-* Ensure flusher thread gets stopped when logger is closed.
-* Add writer for logger device attribute.
-* Handle passing an array of devices to a multi device.
-* Helper method to get a tag with a specified name.
-* Add strip formatter to strip whitespace from strings.
-* Support non-alpha numeric characters in template variables.
-* Add backtrace cleaner to ExceptionFormatter.
+### Added
+- Enable compatibility with `ActiveSupport::TaggedLogger` by calling `tagged_logger!` on a logger.
+- Add `tag_formatter` to logger to specify formatting of tags for output.
+- Allow adding and removing classes by name to formatters.
+- Allow adding and removing multiple classes in a single call to a formatter.
+- Allow using symbols and strings as log level for silencing a logger.
+- Ensure flusher thread gets stopped when logger is closed.
+- Add writer for logger device attribute.
+- Handle passing an array of devices to a multi device.
+- Helper method to get a tag with a specified name.
+- Add strip formatter to strip whitespace from strings.
+- Support non-alpha numeric characters in template variables.
+- Add backtrace cleaner to ExceptionFormatter.
 
 ## 1.1.1
 
-* Replace Procs in tag values with the value of calling the Proc in log entries.
+### Added
+- Replace Procs in tag values with the value of calling the Proc in log entries.
 
 ## 1.1.0
 
-* Change Lumberjack::Logger to inherit from ::Logger
-* Add support for tags on log messages
-* Add global tag context for all loggers
-* Add per logger tags and tag contexts
-* Reimplement unit of work id as a tag on log entries
-* Add support for setting datetime format on log devices
-* Performance optimizations
-* Add Multi device to output to multiple devices
-* Add DateTimeFormatter, IdFormatter, ObjectFormatter, and StructuredFormatter
-* Add rack Context middleware for setting thread global context
-* End support for ruby versions < 2.3
-* Add support for modules in formatters
+### Added
+- Change `Lumberjack::Logger` to inherit from ::Logger
+- Add support for tags on log messages
+- Add global tag context for all loggers
+- Add per logger tags and tag contexts
+- Reimplement unit of work id as a tag on log entries
+- Add support for setting datetime format on log devices
+- Performance optimizations
+- Add Multi device to output to multiple devices
+- Add `DateTimeFormatter`, `IdFormatter`, `ObjectFormatter`, and `StructuredFormatter`
+- Add rack `Context` middleware for setting thread global context
+- Add support for modules in formatters
+
+### Removed
+- End support for ruby versions < 2.3
 
 ## 1.0.13
 
-* Reduce amount of code executed inside a mutex lock when writing to the logger stream.
-* Added `:min_roll_check` option to `Lumberjack::Device::RollingLogFile` to reduce file system checks. Default is now to only check if a file needs to be rolled at most once per second.
-* Force immutable strings for Ruby versions that support them.
+### Added
+- Added `:min_roll_check` option to `Lumberjack::Device::RollingLogFile` to reduce file system checks. Default is now to only check if a file needs to be rolled at most once per second.
+- Force immutable strings for Ruby versions that support them.
+
+### Changed
+- Reduce amount of code executed inside a mutex lock when writing to the logger stream.
 
 ## 1.0.12
 
-* Add support for ActionDispatch request id for better Rails compatibility.
+### Added
+- Add support for `ActionDispatch` request id for better Rails compatibility.
 
 ## 1.0.11
 
-* Fix Ruby 2.4 deprecation warning on Fixnum (thanks koic).
-* Fix gemspec files to be flat array (thanks e2).
+### Fixed
+- Fix Ruby 2.4 deprecation warning on Fixnum (thanks koic).
+- Fix gemspec files to be flat array (thanks e2).
 
 ## 1.0.10
 
-* Expose option to manually roll log files.
-* Minor code cleanup.
+### Added
+- Expose option to manually roll log files.
+
+### Changed
+- Minor code cleanup.
 
 ## 1.0.9
 
-* Add method so Formatter is compatible with ActiveSupport logging extensions.
+### Added
+- Add method so Formatter is compatible with `ActiveSupport` logging extensions.
 
 ## 1.0.8
 
-* Fix another internal variable name conflict with ActiveSupport logging extensions.
+### Fixed
+- Fix another internal variable name conflict with `ActiveSupport` logging extensions.
 
 ## 1.0.7
 
-* Fix broken formatter attribute method.
+### Fixed
+- Fix broken formatter attribute method.
 
 ## 1.0.6
 
-* Fix internal variable name conflict with ActiveSupport logging extensions.
+### Fixed
+- Fix internal variable name conflict with `ActiveSupport` logging extensions.
 
 ## 1.0.5
 
-* Update docs.
-* Remove autoload calls to make thread safe.
-* Make compatible with Ruby 2.1.1 Pathname.
-* Make compatible with standard library Logger's use of progname as default message.
+### Changed
+- Update docs.
+- Remove autoload calls to make thread safe.
+- Make compatible with Ruby 2.1.1 Pathname.
+- Make compatible with standard library Logger's use of progname as default message.
 
 ## 1.0.4
 
-* Add ability to supply a unit of work id for a block instead of having one generated every time.
+### Added
+- Add ability to supply a unit of work id for a block instead of having one generated every time.
 
 ## 1.0.3
 
-* Change log file output format to binary to avoid encoding warnings.
-* Fixed bug in log file rolling that left the file locked.
+### Fixed
+- Change log file output format to binary to avoid encoding warnings.
+- Fixed bug in log file rolling that left the file locked.
 
 ## 1.0.2
 
-* Remove deprecation warnings under ruby 1.9.3.
-* Add more error checking around file rolling.
+### Fixed
+- Remove deprecation warnings under ruby 1.9.3.
+- Add more error checking around file rolling.
 
 ## 1.0.1
 
-* Writes are no longer buffered by default.
+### Fixed
+- Writes are no longer buffered by default.
+
+## 1.0.0
+
+### Added
+- Initial release

data/README.md

@@ -1,13 +1,14 @@
-# Lumberjack
-
-[![Build Status](https://travis-ci.org/bdurand/lumberjack.svg?branch=master)](https://travis-ci.org/bdurand/lumberjack)
+![Continuous Integration](https://github.com/bdurand/lumberjack/workflows/Continuous%20Integration/badge.svg)
 [![Maintainability](https://api.codeclimate.com/v1/badges/a0abc03721fff9b0cde1/maintainability)](https://codeclimate.com/github/bdurand/lumberjack/maintainability)
+[![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/testdouble/standard)
+
+# Lumberjack
 
 Lumberjack is a simple, powerful, and fast logging implementation in Ruby. It uses nearly the same API as the Logger class in the Ruby standard library and as ActiveSupport::BufferedLogger in Rails.
 
 ## Usage
 
-This code aims to be extremely simple to use. The core interface it the Lumberjack::Logger which is used to log messages (which can be any object) with a specified Severity. Each logger has a level associated with it and messages are only written if their severity is greater than or equal to the level.
+This code aims to be extremely simple to use. The core interface is the Lumberjack::Logger which is used to log messages (which can be any object) with a specified Severity. Each logger has a level associated with it and messages are only written if their severity is greater than or equal to the level.
 
 ```ruby
   logger = Lumberjack::Logger.new("logs/application.log")  # Open a new log file with INFO level
@@ -40,7 +41,7 @@ The following information is recorded for each message:
 
 ### Tags
 
-You can use tags to provide additional meta data about a log message or the context that the log message is being made in. Using tags can keep you log messages clean. You can avoid string interoplation to add additional meta data.
+You can use tags to provide additional meta data about a log message or the context that the log message is being made in. Using tags can keep your log messages clean. You can avoid string interpolation to add additional meta data.
 
 Each of the logger methods includes an additional argument that can be used to specify tags on a messsage:
 

data/VERSION

@@ -1 +1 @@
-1.2.7
+1.2.9

data/lib/lumberjack/context.rb

@@ -5,12 +5,16 @@ module Lumberjack
   class Context
     attr_reader :tags
 
+    # @param [Context] parent_context A parent context to inherit tags from.
     def initialize(parent_context = nil)
       @tags = {}
       @tags.merge!(parent_context.tags) if parent_context
     end
 
     # Set tags on the context.
+    #
+    # @param [Hash] tags The tags to set.
+    # @return [void]
     def tag(tags)
       tags.each do |key, value|
         @tags[key.to_s] = value
@@ -18,16 +22,25 @@ module Lumberjack
     end
 
     # Get a context tag.
+    #
+    # @param [String, Symbol] key The tag key.
+    # @return [Object] The tag value.
     def [](key)
       @tags[key.to_s]
     end
 
     # Set a context tag.
+    #
+    # @param [String, Symbol] key The tag key.
+    # @param [Object] value The tag value.
+    # @return [void]
     def []=(key, value)
       @tags[key.to_s] = value
     end
 
     # Clear all the context data.
+    #
+    # @return [void]
     def reset
       @tags.clear
     end

data/lib/lumberjack/device/date_rolling_log_file.rb

@@ -1,6 +1,6 @@
 # frozen_string_literals: true
 
-require 'date'
+require "date"
 
 module Lumberjack
   class Device
@@ -13,10 +13,13 @@ module Lumberjack
       # Create a new logging device to the specified file. The period to roll the file is specified
       # with the :roll option which may contain a value of :daily, :weekly,
       # or :monthly.
+      #
+      # @param [String, Pathname] path The path to the log file.
+      # @param [Hash] options The options for the device.
       def initialize(path, options = {})
         @manual = options[:manual]
         @file_date = Date.today
-        if options[:roll] && options[:roll].to_s.match(/(daily)|(weekly)|(monthly)/i)
+        if options[:roll]&.to_s&.match(/(daily)|(weekly)|(monthly)/i)
           @roll_period = $~[0].downcase.to_sym
           options.delete(:roll)
         else
@@ -25,17 +28,23 @@ module Lumberjack
         super
       end
 
+      # The date based suffix for file.
+      #
+      # @return [String]
       def archive_file_suffix
         case @roll_period
         when :weekly
-          "#{@file_date.strftime('week-of-%Y-%m-%d')}"
+          @file_date.strftime("week-of-%Y-%m-%d").to_s
         when :monthly
-          "#{@file_date.strftime('%Y-%m')}"
+          @file_date.strftime("%Y-%m").to_s
         else
-          "#{@file_date.strftime('%Y-%m-%d')}"
+          @file_date.strftime("%Y-%m-%d").to_s
         end
       end
 
+      # Check if the file should be rolled.
+      #
+      # @return [Boolean]
       def roll_file?
         if @manual
           true
@@ -54,9 +63,9 @@ module Lumberjack
           end
         end
       end
-      
+
       protected
-      
+
       def after_roll
         @file_date = Date.today
       end

data/lib/lumberjack/device/log_file.rb

@@ -1,6 +1,6 @@
 # frozen_string_literals: true
 
-require 'fileutils'
+require "fileutils"
 
 module Lumberjack
   class Device
@@ -10,23 +10,30 @@ module Lumberjack
 
       # The absolute path of the file being logged to.
       attr_reader :path
-      
+
       # Create a logger to the file at +path+. Options are passed through to the Writer constructor.
+      #
+      # @param [String, Pathname] path The path to the log file.
+      # @param [Hash] options The options for the device.
       def initialize(path, options = {})
         @path = File.expand_path(path)
         FileUtils.mkdir_p(File.dirname(@path))
         super(file_stream, options)
       end
-      
+
+      # Reopen the log file.
+      #
+      # @param [Object] logdev not used
+      # @return [void]
       def reopen(logdev = nil)
         close
         @stream = file_stream
       end
-      
+
       private
-      
+
       def file_stream
-        File.new(@path, 'a', :encoding => EXTERNAL_ENCODING)
+        File.new(@path, "a", encoding: EXTERNAL_ENCODING)
       end
     end
   end

data/lib/lumberjack/device/multi.rb

@@ -4,38 +4,39 @@ module Lumberjack
   class Device
     # This is a logging device that forward log entries to multiple other devices.
     class Multi < Device
+      # @param [Array<Lumberjack::Device>] devices The devices to write to.
       def initialize(*devices)
         @devices = devices.flatten
       end
-      
+
       def write(entry)
         @devices.each do |device|
           device.write(entry)
         end
       end
-      
+
       def flush
         @devices.each do |device|
           device.flush
         end
       end
-      
+
       def close
         @devices.each do |device|
           device.close
         end
       end
-      
+
       def reopen(logdev = nil)
         @devices.each do |device|
           device.reopen(logdev = nil)
         end
       end
-      
+
       def datetime_format
         @devices.detect(&:datetime_format).datetime_format
       end
-      
+
       def datetime_format=(format)
         @devices.each do |device|
           device.datetime_format = format

data/lib/lumberjack/device/null.rb

@@ -7,7 +7,7 @@ module Lumberjack
     class Null < Device
       def initialize(*args)
       end
-      
+
       def write(entry)
       end
     end

data/lib/lumberjack/device/rolling_log_file.rb

@@ -14,35 +14,43 @@ module Lumberjack
     class RollingLogFile < LogFile
       attr_reader :path
       attr_accessor :keep
-      
+
       def initialize(path, options = {})
         @path = File.expand_path(path)
         @keep = options[:keep]
         super(path, options)
-        @file_inode = stream.lstat.ino rescue nil
+        @file_inode = begin
+          stream.lstat.ino
+        rescue
+          nil
+        end
         @@rolls = []
         @next_stat_check = Time.now.to_f
         @min_roll_check = (options[:min_roll_check] || 1.0).to_f
       end
-      
+
       # Returns a suffix that will be appended to the file name when it is archived.. The suffix should
       # change after it is time to roll the file. The log file will be renamed when it is rolled.
       def archive_file_suffix
         raise NotImplementedError
       end
-      
+
       # Return +true+ if the file should be rolled.
       def roll_file?
         raise NotImplementedError
       end
-      
+
       # Roll the log file by renaming it to the archive file name and then re-opening a stream to the log
       # file path. Rolling a file is safe in multi-threaded or multi-process environments.
-      def roll_file! #:nodoc:
+      def roll_file! # :nodoc:
         do_once(stream) do
           archive_file = "#{path}.#{archive_file_suffix}"
           stream.flush
-          current_inode = File.stat(path).ino rescue nil
+          current_inode = begin
+            File.stat(path).ino
+          rescue
+            nil
+          end
           if @file_inode && current_inode == @file_inode && !File.exist?(archive_file) && File.exist?(path)
             begin
               File.rename(path, archive_file)
@@ -59,41 +67,49 @@ module Lumberjack
       end
 
       protected
-      
+
       # This method will be called after a file has been rolled. Subclasses can
       # implement code to reset the state of the device. This method is thread safe.
       def after_roll
       end
-      
+
       # Handle rolling the file before flushing.
       def before_flush # :nodoc:
         if @min_roll_check <= 0.0 || Time.now.to_f >= @next_stat_check
           @next_stat_check += @min_roll_check
-          path_inode = File.lstat(path).ino rescue nil
+          path_inode = begin
+            File.lstat(path).ino
+          rescue
+            nil
+          end
           if path_inode != @file_inode
             @file_inode = path_inode
             reopen_file
-          else
-            roll_file! if roll_file?
+          elsif roll_file?
+            roll_file!
           end
         end
       end
-      
+
       private
 
       def reopen_file
         old_stream = stream
-        new_stream = File.open(path, 'a', encoding: EXTERNAL_ENCODING)
+        new_stream = File.open(path, "a", encoding: EXTERNAL_ENCODING)
         new_stream.sync = true if buffer_size > 0
-        @file_inode = new_stream.lstat.ino rescue nil
+        @file_inode = begin
+          new_stream.lstat.ino
+        rescue
+          nil
+        end
         self.stream = new_stream
         old_stream.close
       end
     end
-    
+
     def cleanup_files!
       if keep
-        files = Dir.glob("#{path}.*").collect{|f| [f, File.ctime(f)]}.sort{|a,b| b.last <=> a.last}.collect{|a| a.first}
+        files = Dir.glob("#{path}.*").collect { |f| [f, File.ctime(f)] }.sort { |a, b| b.last <=> a.last }.collect { |a| a.first }
         if files.size > keep
           files[keep, files.length].each do |f|
             File.delete(f)
@@ -101,7 +117,7 @@ module Lumberjack
         end
       end
     end
-    
+
     def do_once(file)
       begin
         file.flock(File::LOCK_EX)
@@ -110,11 +126,19 @@ module Lumberjack
         return
       end
       begin
-        verify = file.lstat rescue nil
+        verify = begin
+          file.lstat
+        rescue
+          nil
+        end
         # Execute only if the file we locked is still the same one that needed to be rolled
         yield if verify && verify.ino == @file_inode && verify.size > 0
       ensure
-        file.flock(File::LOCK_UN) rescue nil
+        begin
+          file.flock(File::LOCK_UN)
+        rescue
+          nil
+        end
       end
     end
   end