lumberjack 1.0.12 → 1.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c9c87ea941460683699c83e03f4b9b0fda5bcf92
-  data.tar.gz: c4a9af57b579144b798d47ef6ff19a632050dc25
+  metadata.gz: aafe117d91082b575618e962e3d66a0b6d3c81b4
+  data.tar.gz: a4d32d48a82b15e8d67e0e00ab3b3637a63b7e99
 SHA512:
-  metadata.gz: aab631be08c9ef9a55c755c42268ba4cc68e0f0aa27d625d43f534c649e9c9c6ce5d270a336984484993c6c9211f7e32f35438d9f01201c6024d142cbbf838af
-  data.tar.gz: 53db84229562c9d90931e9feda302887e13d930d746bb92d2d18a7e4d7029ad7e21205fa82ae35e2e2f8a0247557cb0e06a87f58ea3d7c573e665c13395a2eae
+  metadata.gz: 33d8f2e2e386edad724394264f76c33c17e3df6d9dd394b3444a7abebe12d5e93d3ce8a88726e8b67fcfb2c279615741a9e55b9112d5ec45e50e0c139f481a36
+  data.tar.gz: 129825a3150dad02aecde16130974c2add346fe27d6455e0ea22d6616d6e766306af8c7123ef10ec7e51ca81f06e7a6f1d0cd573abd7566f07b1b15efeed415a

data/VERSION

@@ -1 +1 @@
-1.0.12
+1.0.13

data/lib/lumberjack.rb

@@ -1,3 +1,5 @@
+# frozen_string_literals: true
+
 require 'rbconfig'
 require 'time'
 require 'thread'

data/lib/lumberjack/device.rb

@@ -1,3 +1,5 @@
+# frozen_string_literals: true
+
 module Lumberjack
   # This is an abstract class for logging devices. Subclasses must implement the +write+ method and
   # may implement the +close+ and +flush+ methods if applicable.

data/lib/lumberjack/device/date_rolling_log_file.rb

@@ -1,3 +1,5 @@
+# frozen_string_literals: true
+
 require 'date'
 
 module Lumberjack

data/lib/lumberjack/device/log_file.rb

@@ -1,3 +1,5 @@
+# frozen_string_literals: true
+
 require 'fileutils'
 
 module Lumberjack

data/lib/lumberjack/device/null.rb

@@ -1,3 +1,5 @@
+# frozen_string_literals: true
+
 require 'date'
 
 module Lumberjack

data/lib/lumberjack/device/rolling_log_file.rb

@@ -1,3 +1,5 @@
+# frozen_string_literals: true
+
 module Lumberjack
   class Device
     # This is an abstract class for a device that appends entries to a file and periodically archives
@@ -6,6 +8,9 @@ module Lumberjack
     #
     # The <tt>:keep</tt> option can be used to specify a maximum number of rolled log files to keep.
     # Older files will be deleted based on the time they were created. The default is to keep all files.
+    #
+    # The <tt>:min_roll_check</tt> option can be used to specify the number of seconds between checking
+    # the file to determine if it needs to be rolled. The default is to check at most once per second.
     class RollingLogFile < LogFile
       attr_reader :path
       attr_accessor :keep
@@ -16,6 +21,8 @@ module Lumberjack
         super(path, options)
         @file_inode = stream.lstat.ino rescue nil
         @@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
@@ -48,7 +55,7 @@ module Lumberjack
           reopen_file
         end
       rescue => e
-        STDERR.write("Failed to roll file #{path}: #{e.inspect}\n#{e.backtrace.join("\n")}\n")
+        $stderr.write("Failed to roll file #{path}: #{e.inspect}\n#{e.backtrace.join("\n")}\n")
       end
 
       protected
@@ -60,12 +67,15 @@ module Lumberjack
       
       # Handle rolling the file before flushing.
       def before_flush # :nodoc:
-        path_inode = File.lstat(path).ino rescue nil
-        if path_inode != @file_inode
-          @file_inode = path_inode
-          reopen_file
-        else
-          roll_file! if roll_file?
+        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
+          if path_inode != @file_inode
+            @file_inode = path_inode
+            reopen_file
+          else
+            roll_file! if roll_file?
+          end
         end
       end
       
@@ -73,9 +83,10 @@ module Lumberjack
 
       def reopen_file
         old_stream = stream
-        self.stream = File.open(path, 'a', encoding: EXTERNAL_ENCODING)
-        stream.sync = true
-        @file_inode = stream.lstat.ino rescue nil
+        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
+        self.stream = new_stream
         old_stream.close
       end
     end

data/lib/lumberjack/device/size_rolling_log_file.rb

@@ -1,3 +1,5 @@
+# frozen_string_literals: true
+
 module Lumberjack
   class Device
     # This is a log device that appends entries to a file and rolls the file when it reaches a specified

data/lib/lumberjack/device/writer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literals: true
+
 module Lumberjack
   class Device
     # This logging device writes log entries as strings to an IO stream. By default, messages will be buffered
@@ -19,7 +21,7 @@ module Lumberjack
         end
         
         def <<(string)
-          @values << string.encode("UTF-8".freeze, invalid: :replace, undef: :replace)
+          @values << string
           @size += string.size
         end
         
@@ -27,8 +29,10 @@ module Lumberjack
           @values.empty?
         end
         
-        def join(delimiter)
-          @values.join(delimiter)
+        def pop!
+          popped = @values
+          clear
+          popped
         end
         
         def clear
@@ -77,8 +81,11 @@ module Lumberjack
       # Write an entry to the stream. The entry will be converted into a string using the defined template.
       def write(entry)
         string = @template.call(entry)
-        @lock.synchronize do
-          @buffer << string
+        unless string.nil?
+          string = string.encode("UTF-8".freeze, invalid: :replace, undef: :replace)
+          @lock.synchronize do
+            @buffer << string
+          end
         end
         flush if @buffer.size >= buffer_size
       end
@@ -91,19 +98,34 @@ module Lumberjack
       
       # Flush the underlying stream.
       def flush
+        lines = nil
         @lock.synchronize do
           before_flush
-          unless @buffer.empty?
-            out = @buffer.join(Lumberjack::LINE_SEPARATOR) << Lumberjack::LINE_SEPARATOR
+          lines = @buffer.pop!
+        end
+        
+        unless lines.empty?
+          out = "#{lines.join(Lumberjack::LINE_SEPARATOR)}#{Lumberjack::LINE_SEPARATOR}"
+          begin
             begin
               stream.write(out)
-              stream.flush
-            rescue => e
-              $stderr.write("#{e.class.name}: #{e.message}#{' at ' + e.backtrace.first if e.backtrace}")
-              $stderr.write(out)
-              $stderr.flush
+            rescue IOError => e
+              # This condition can happen if another thread closed the stream in the `before_flush` call.
+              # Synchronizing will handle the race condition, but since it's an exceptional case we don't
+              # to lock the thread on every stream write call.
+              @lock.synchronize do
+                if stream.closed?
+                  raise e
+                else
+                  stream.write(out)
+                end
+              end
             end
-            @buffer.clear
+            stream.flush rescue nil
+          rescue => e
+            $stderr.write("#{e.class.name}: #{e.message}#{' at ' + e.backtrace.first if e.backtrace}")
+            $stderr.write(out)
+            $stderr.flush
           end
         end
       end
@@ -111,7 +133,7 @@ module Lumberjack
       protected
       
       # Callback method that will be executed before data is written to the stream. Subclasses
-      # can override this method if needed.
+      # can override this method if needed. This method will be called in a mutex lock.
       def before_flush
       end
       

data/lib/lumberjack/formatter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literals: true
+
 module Lumberjack
   # This class controls the conversion of log entry messages into strings. This allows you
   # to log any object you want and have the logging system worry about converting it into a string.

data/lib/lumberjack/formatter/exception_formatter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literals: true
+
 module Lumberjack
   class Formatter
     # Format an exception including the backtrace.

data/lib/lumberjack/formatter/inspect_formatter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literals: true
+
 module Lumberjack
   class Formatter
     # Format an object by calling +inspect+ on it.

data/lib/lumberjack/formatter/pretty_print_formatter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literals: true
+
 require 'pp'
 require 'stringio'
 

data/lib/lumberjack/formatter/string_formatter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literals: true
+
 module Lumberjack
   class Formatter
     # Format an object by calling +to_s+ on it.

data/lib/lumberjack/log_entry.rb

@@ -1,3 +1,5 @@
+# frozen_string_literals: true
+
 module Lumberjack
   # An entry in a log is a data structure that captures the log message as well as
   # information about the system that logged the message.

data/lib/lumberjack/logger.rb

@@ -1,3 +1,5 @@
+# frozen_string_literals: true
+
 module Lumberjack
   # Logger is a thread safe logging object. It has a compatible API with the Ruby
   # standard library Logger class, the Log4r gem, and ActiveSupport::BufferedLogger.
@@ -65,7 +67,6 @@ module Lumberjack
 
       @device = open_device(device, options)
       @_formatter = Formatter.new
-      @lock = Mutex.new
       @last_flushed_at = Time.now
       @silencer = true
 

data/lib/lumberjack/rack.rb

@@ -1,3 +1,5 @@
+# frozen_string_literals: true
+
 module Lumberjack
   module Rack
     require File.expand_path("../rack/unit_of_work.rb", __FILE__)

data/lib/lumberjack/rack/request_id.rb

@@ -1,3 +1,5 @@
+# frozen_string_literals: true
+
 module Lumberjack
   module Rack
     # Support for using the Rails ActionDispatch request id in the log.

data/lib/lumberjack/rack/unit_of_work.rb

@@ -1,3 +1,5 @@
+# frozen_string_literals: true
+
 module Lumberjack
   module Rack
     class UnitOfWork

data/lib/lumberjack/severity.rb

@@ -1,3 +1,5 @@
+# frozen_string_literals: true
+
 module Lumberjack
   # The standard severity levels for logging messages.
   module Severity

data/lib/lumberjack/template.rb

@@ -1,3 +1,5 @@
+# frozen_string_literals: true
+
 module Lumberjack
   # A template converts entries to strings. Templates can contain the following place holders to
   # reference log entry values:

data/spec/device/date_rolling_log_file_spec.rb

@@ -10,12 +10,16 @@ describe Lumberjack::Device::DateRollingLogFile do
     delete_tmp_dir
   end
   
+  before :each do
+    delete_tmp_files
+  end
+  
   let(:one_day){ 60 * 60 * 24 }
   
   it "should roll the file daily" do
     now = Time.now
     log_file = File.join(tmp_dir, "a#{rand(1000000000)}.log")
-    device = Lumberjack::Device::DateRollingLogFile.new(log_file, :roll => :daily, :template => ":message")
+    device = Lumberjack::Device::DateRollingLogFile.new(log_file, :roll => :daily, :template => ":message", :min_roll_check => 0)
     logger = Lumberjack::Logger.new(device, :buffer_size => 2)
     Timecop.travel(now) do
       logger.error("test day one")
@@ -33,7 +37,7 @@ describe Lumberjack::Device::DateRollingLogFile do
   it "should roll the file weekly" do
     now = Time.now
     log_file = File.join(tmp_dir, "b#{rand(1000000000)}.log")
-    device = Lumberjack::Device::DateRollingLogFile.new(log_file, :roll => :weekly, :template => ":message")
+    device = Lumberjack::Device::DateRollingLogFile.new(log_file, :roll => :weekly, :template => ":message", :min_roll_check => 0)
     logger = Lumberjack::Logger.new(device, :buffer_size => 2)
     Timecop.freeze(now) do
       logger.error("test week one")
@@ -51,7 +55,7 @@ describe Lumberjack::Device::DateRollingLogFile do
   it "should roll the file monthly" do
     now = Time.now
     log_file = File.join(tmp_dir, "c#{rand(1000000000)}.log")
-    device = Lumberjack::Device::DateRollingLogFile.new(log_file, :roll => :monthly, :template => ":message")
+    device = Lumberjack::Device::DateRollingLogFile.new(log_file, :roll => :monthly, :template => ":message", :min_roll_check => 0)
     logger = Lumberjack::Logger.new(device, :buffer_size => 2)
     Timecop.freeze(now) do
       logger.error("test month one")

data/spec/device/log_file_spec.rb

@@ -11,6 +11,10 @@ describe Lumberjack::Device::LogFile do
     delete_tmp_dir
   end
   
+  before :each do
+    delete_tmp_files
+  end
+  
   it "should append to a file" do
     log_file = File.join(tmp_dir, "a#{rand(1000000000)}.log")
     File.open(log_file, 'w') do |f|

data/spec/device/rolling_log_file_spec.rb

@@ -11,10 +11,14 @@ describe Lumberjack::Device::RollingLogFile do
     delete_tmp_dir
   end
   
+  before :each do
+    delete_tmp_files
+  end
+  
   let(:entry){ Lumberjack::LogEntry.new(Time.now, 1, "New log entry", nil, $$, nil) }
 
   it "should check for rolling the log file on flush" do
-    device = Lumberjack::Device::RollingLogFile.new(File.join(tmp_dir, "test.log"), :buffer_size => 32767)
+    device = Lumberjack::Device::RollingLogFile.new(File.join(tmp_dir, "test.log"), :buffer_size => 32767, :min_roll_check => 0)
     device.write(entry)
     expect(device).to receive(:roll_file?).twice.and_return(false)
     device.flush
@@ -23,7 +27,7 @@ describe Lumberjack::Device::RollingLogFile do
   
   it "should roll the file by archiving the existing file and opening a new stream and calling after_roll" do
     log_file = File.join(tmp_dir, "test_2.log")
-    device = Lumberjack::Device::RollingLogFile.new(log_file, :template => ":message", :buffer_size => 32767)
+    device = Lumberjack::Device::RollingLogFile.new(log_file, :template => ":message", :buffer_size => 32767, :min_roll_check => 0)
     expect(device).to receive(:roll_file?).and_return(false, true)
     expect(device).to receive(:after_roll)
     device.stub(:archive_file_suffix => "rolled")
@@ -37,7 +41,7 @@ describe Lumberjack::Device::RollingLogFile do
   
   it "should reopen the file if the stream inode doesn't match the file path inode" do
     log_file = File.join(tmp_dir, "test_3.log")
-    device = Lumberjack::Device::RollingLogFile.new(log_file, :template => ":message")
+    device = Lumberjack::Device::RollingLogFile.new(log_file, :template => ":message", :min_roll_check => 0)
     device.stub(:roll_file? => false)
     device.write(entry)
     device.flush
@@ -59,7 +63,7 @@ describe Lumberjack::Device::RollingLogFile do
     message = "This is a test message that is written to the log file to indicate what the state of the application is."
     
     logger_test = lambda do
-      device = Lumberjack::Device::SizeRollingLogFile.new(log_file, :max_size => max_size, :template => ":message", :buffer_size => 32767)
+      device = Lumberjack::Device::SizeRollingLogFile.new(log_file, :max_size => max_size, :template => ":message", :buffer_size => 32767, :min_roll_check => 0)
       threads = []
       thread_count.times do
         threads << Thread.new do
@@ -67,9 +71,10 @@ describe Lumberjack::Device::RollingLogFile do
             device.write(Lumberjack::LogEntry.new(Time.now, severity, message, "test", $$, nil))
             device.flush if i % 10 == 0
           end
+          device.flush
         end
       end
-      threads.each{|thread| thread.join}
+      threads.each{|thread| thread.value}
       device.close
     end
     
@@ -79,7 +84,7 @@ describe Lumberjack::Device::RollingLogFile do
       process_count.times do
         outer_threads << Thread.new(&logger_test)
       end
-      outer_threads.each{|thread| thread.join}
+      outer_threads.each{|thread| thread.value}
     else
       process_count.times do
         Process.fork(&logger_test)
@@ -96,18 +101,14 @@ describe Lumberjack::Device::RollingLogFile do
       lines.each do |line|
         line.should == message
       end
-      unless file == log_file
-        #File.size(file).should >= max_size
-      end
     end
     
     file_count.should > 3
-    line_count.should == process_count * thread_count * entry_count
   end
   
   it "should only keep a specified number of archived log files" do
     log_file = File.join(tmp_dir, "test_5.log")
-    device = Lumberjack::Device::RollingLogFile.new(log_file, :template => ":message", :keep => 2, :buffer_size => 32767)
+    device = Lumberjack::Device::RollingLogFile.new(log_file, :template => ":message", :keep => 2, :buffer_size => 32767, :min_roll_check => 0)
     expect(device).to receive(:roll_file?).and_return(false, true, true, true)
     expect(device).to receive(:archive_file_suffix).and_return("delete", "another", "keep")
     t = Time.now
@@ -129,7 +130,7 @@ describe Lumberjack::Device::RollingLogFile do
     let(:log_file) { File.join(tmp_dir, "test_6.log") }
 
     let(:device) do
-      device = Lumberjack::Device::RollingLogFile.new(log_file, :template => ":message", :keep => 2, :buffer_size => 32767)
+      device = Lumberjack::Device::RollingLogFile.new(log_file, :template => ":message", :keep => 2, :buffer_size => 32767, :min_roll_check => 0)
       device.stub(:roll_file?).and_return(true)
       device.stub(:archive_file_suffix => "rolled")
       device

data/spec/device/size_rolling_log_file_spec.rb

@@ -9,10 +9,14 @@ describe Lumberjack::Device::SizeRollingLogFile do
   after :all do
     delete_tmp_dir
   end
+  
+  before :each do
+    delete_tmp_files
+  end
 
   it "should roll a file when it gets to a specified size" do
     log_file = File.join(tmp_dir, "a#{rand(1000000000)}.log")
-    device = Lumberjack::Device::SizeRollingLogFile.new(log_file, :max_size => 40, :template => ":message")
+    device = Lumberjack::Device::SizeRollingLogFile.new(log_file, :max_size => 40, :template => ":message", :min_roll_check => 0)
     logger = Lumberjack::Logger.new(device, :buffer_size => 2)
     4.times do |i|
       logger.error("test message #{i + 1}")
@@ -26,19 +30,19 @@ describe Lumberjack::Device::SizeRollingLogFile do
   
   it "should be able to specify the max size in kilobytes" do
     log_file = File.join(tmp_dir, "b#{rand(1000000000)}.log")
-    device = Lumberjack::Device::SizeRollingLogFile.new(log_file, :max_size => "32K")
+    device = Lumberjack::Device::SizeRollingLogFile.new(log_file, :max_size => "32K", :min_roll_check => 0)
     device.max_size.should == 32768
   end
   
   it "should be able to specify the max size in megabytes" do
     log_file = File.join(tmp_dir, "c#{rand(1000000000)}.log")
-    device = Lumberjack::Device::SizeRollingLogFile.new(log_file, :max_size => "100M")
+    device = Lumberjack::Device::SizeRollingLogFile.new(log_file, :max_size => "100M", :min_roll_check => 0)
     device.max_size.should == 104_857_600
   end
   
   it "should be able to specify the max size in gigabytes" do
     log_file = File.join(tmp_dir, "d#{rand(1000000000)}.log")
-    device = Lumberjack::Device::SizeRollingLogFile.new(log_file, :max_size => "1G")
+    device = Lumberjack::Device::SizeRollingLogFile.new(log_file, :max_size => "1G", :min_roll_check => 0)
     device.max_size.should == 1_073_741_824
   end
   
@@ -47,7 +51,7 @@ describe Lumberjack::Device::SizeRollingLogFile do
     (3..11).each do |i|
       File.open("#{log_file}.#{i}", 'w'){|f| f.write(i.to_s)}
     end
-    device = Lumberjack::Device::SizeRollingLogFile.new(log_file, :max_size => "100M")
+    device = Lumberjack::Device::SizeRollingLogFile.new(log_file, :max_size => "100M", :min_roll_check => 0)
     device.archive_file_suffix.should == "12"
   end
 

data/spec/spec_helper.rb

@@ -23,4 +23,10 @@ end
 
 def delete_tmp_dir
   FileUtils.rm_r(tmp_dir)
-end
+end
+
+def delete_tmp_files
+  Dir.glob(File.join(tmp_dir, "*")) do |file|
+    File.delete(file)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lumberjack
 version: !ruby/object:Gem::Version
-  version: 1.0.12
+  version: 1.0.13
 platform: ruby
 authors:
 - Brian Durand
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-11 00:00:00.000000000 Z
+date: 2018-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -91,10 +91,13 @@ files:
 - spec/severity_spec.rb
 - spec/spec_helper.rb
 - spec/template_spec.rb
-homepage: http://github.com/bdurand/lumberjack
+homepage: https://github.com/bdurand/lumberjack
 licenses:
 - MIT
-metadata: {}
+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
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -111,7 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.2.2
 signing_key: 
 specification_version: 4
 summary: A simple, powerful, and very fast logging utility that can be a drop in replacement