lumberjack 1.0.9 → 1.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b07995cff9cade3e5246b7559cf25a34f0df5611
-  data.tar.gz: de7054b468dfd8ea8cdbcf65b2bb1594e4299f10
+  metadata.gz: 9a62ab302df8141afb410a4c50c4caf6209ec5c5
+  data.tar.gz: 36e54fd44f8af8a3970a34f2dc3c3bfb011a6ff8
 SHA512:
-  metadata.gz: b988d1886a98a118dab20bc4457ad6b210f72ee6640237235b12bd63d1c969b32eeae5db944ee04c731df3df29fefef6c0db634df1ee48e6b6a0ac33c10154ea
-  data.tar.gz: 9391faa754aa454f0e3f9295cadbb81aa2b7336859fd063b212c7dc160988febe1792a4718b09536e6018246686e9ee7bffc053d0204d97bb792efc4cc513ebc
+  metadata.gz: 6ac3c76a1e33bab723ff97a9a667d36a630f07541571518786f175b01f0a3ee49ac0ace70ecadd3a7ecb8db38d109b7967aa7abf7e85b123d7cb73de505c6d93
+  data.tar.gz: 6f67110bc4ee430122fab313bdd730c5c079060a4430377bc8c68651b5292e4b0452e4dbf15415902c69775ca2a88aab35fc4eb4e6b06bad4871604ed18a8f0f

data/VERSION

@@ -1 +1 @@
-1.0.9
+1.0.10

data/lib/lumberjack.rb

@@ -1,18 +1,18 @@
 require 'rbconfig'
 require 'time'
 require 'thread'
+require 'securerandom'
 
 module Lumberjack
   LINE_SEPARATOR = (RbConfig::CONFIG['host_os'].match(/mswin/i) ? "\r\n" : "\n")
 
-  load File.expand_path("../lumberjack/severity.rb", __FILE__)
-  load File.expand_path("../lumberjack/log_entry.rb", __FILE__)
-  load File.expand_path("../lumberjack/formatter.rb", __FILE__)
-  load File.expand_path("../lumberjack/device.rb", __FILE__)
-  load File.expand_path("../lumberjack/logger.rb", __FILE__)
-  load File.expand_path("../lumberjack/template.rb", __FILE__)
-
-  autoload :Rack, File.expand_path("../lumberjack/rack.rb", __FILE__)
+  require File.expand_path("../lumberjack/severity.rb", __FILE__)
+  require File.expand_path("../lumberjack/log_entry.rb", __FILE__)
+  require File.expand_path("../lumberjack/formatter.rb", __FILE__)
+  require File.expand_path("../lumberjack/device.rb", __FILE__)
+  require File.expand_path("../lumberjack/logger.rb", __FILE__)
+  require File.expand_path("../lumberjack/template.rb", __FILE__)
+  require File.expand_path("../lumberjack/rack.rb", __FILE__)
   
   class << self
     # Define a unit of work within a block. Within the block supplied to this
@@ -26,7 +26,7 @@ module Lumberjack
     # Lumberjack::Rack::UnitOfWork class.
     def unit_of_work(id = nil)
       save_val = Thread.current[:lumberjack_logger_unit_of_work_id]
-      id ||= rand(0xFFFFFFFFFFFF).to_s(16).rjust(12, '0').upcase
+      id ||= SecureRandom.hex(6)
       Thread.current[:lumberjack_logger_unit_of_work_id] = id
       begin
         return yield

data/lib/lumberjack/device.rb

@@ -2,12 +2,12 @@ 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.
   class Device
-    load File.expand_path("../device/writer.rb", __FILE__)
-    load File.expand_path("../device/log_file.rb", __FILE__)
-    load File.expand_path("../device/rolling_log_file.rb", __FILE__)
-    load File.expand_path("../device/date_rolling_log_file.rb", __FILE__)
-    load File.expand_path("../device/size_rolling_log_file.rb", __FILE__)
-    load File.expand_path("../device/null.rb", __FILE__)
+    require File.expand_path("../device/writer.rb", __FILE__)
+    require File.expand_path("../device/log_file.rb", __FILE__)
+    require File.expand_path("../device/rolling_log_file.rb", __FILE__)
+    require File.expand_path("../device/date_rolling_log_file.rb", __FILE__)
+    require File.expand_path("../device/size_rolling_log_file.rb", __FILE__)
+    require File.expand_path("../device/null.rb", __FILE__)
 
     # Subclasses must implement this method to write a LogEntry.
     def write(entry)

data/lib/lumberjack/device/date_rolling_log_file.rb

@@ -12,6 +12,7 @@ module Lumberjack
       # with the <tt>:roll</tt> option which may contain a value of <tt>:daily</tt>, <tt>:weekly</tt>,
       # or <tt>:monthly</tt>.
       def initialize(path, options = {})
+        @manual = options[:manual]
         @file_date = Date.today
         if options[:roll] && options[:roll].to_s.match(/(daily)|(weekly)|(monthly)/i)
           @roll_period = $~[0].downcase.to_sym
@@ -34,17 +35,21 @@ module Lumberjack
       end
 
       def roll_file?
-        date = Date.today
-        if date.year > @file_date.year
-          true
-        elsif @roll_period == :daily && date.yday > @file_date.yday
-          true
-        elsif @roll_period == :weekly && date.cweek > @file_date.cweek
-          true
-        elsif @roll_period == :monthly && date.month > @file_date.month
+        if @manual
           true
         else
-          false
+          date = Date.today
+          if date.year > @file_date.year
+            true
+          elsif @roll_period == :daily && date.yday > @file_date.yday
+            true
+          elsif @roll_period == :weekly && date.cweek != @file_date.cweek
+            true
+          elsif @roll_period == :monthly && date.month > @file_date.month
+            true
+          else
+            false
+          end
         end
       end
       

data/lib/lumberjack/device/log_file.rb

@@ -4,6 +4,8 @@ module Lumberjack
   class Device
     # This is a logging device that appends log entries to a file.
     class LogFile < Writer
+      EXTERNAL_ENCODING = "ascii-8bit"
+
       # The absolute path of the file being logged to.
       attr_reader :path
       
@@ -11,7 +13,7 @@ module Lumberjack
       def initialize(path, options = {})
         @path = File.expand_path(path)
         FileUtils.mkdir_p(File.dirname(@path))
-        super(File.new(@path, 'a', :encoding => "ascii-8bit"), options)
+        super(File.new(@path, 'a', :encoding => EXTERNAL_ENCODING), options)
       end
     end
   end

data/lib/lumberjack/device/rolling_log_file.rb

@@ -29,6 +29,28 @@ module Lumberjack
         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:
+        do_once(stream) do
+          archive_file = "#{path}.#{archive_file_suffix}"
+          stream.flush
+          current_inode = File.stat(path).ino rescue nil
+          if @file_inode && current_inode == @file_inode && !File.exist?(archive_file) && File.exist?(path)
+            begin
+              File.rename(path, archive_file)
+              after_roll
+              cleanup_files!
+            rescue SystemCallError
+              # Ignore rename errors since it indicates the file was already rolled
+            end
+          end
+          reopen_file
+        end
+      rescue => e
+        STDERR.write("Failed to roll file #{path}: #{e.inspect}\n#{e.backtrace.join("\n")}\n")
+      end
+
       protected
       
       # This method will be called after a file has been rolled. Subclasses can
@@ -46,38 +68,16 @@ module Lumberjack
           roll_file! if roll_file?
         end
       end
-
+      
       private
 
       def reopen_file
         old_stream = stream
-        self.stream = File.open(path, 'a')
+        self.stream = File.open(path, 'a', encoding: EXTERNAL_ENCODING)
         stream.sync = true
         @file_inode = stream.lstat.ino rescue nil
         old_stream.close
       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:
-        do_once(stream) do
-          archive_file = "#{path}.#{archive_file_suffix}"
-          stream.flush
-          current_inode = File.stat(path).ino rescue nil
-          if @file_inode && current_inode == @file_inode && !File.exist?(archive_file) && File.exist?(path)
-            begin
-              File.rename(path, archive_file)
-              after_roll
-              cleanup_files!
-            rescue SystemCallError
-              # Ignore rename errors since it indicates the file was already rolled
-            end
-          end
-          reopen_file
-        end
-      rescue => e
-        STDERR.write("Failed to roll file #{path}: #{e.inspect}\n#{e.backtrace.join("\n")}\n")
-      end
     end
     
     def cleanup_files!

data/lib/lumberjack/device/size_rolling_log_file.rb

@@ -10,6 +10,7 @@ module Lumberjack
       # Create an new log device to the specified file. The maximum size of the log file is specified with
       # the <tt>:max_size</tt> option. The unit can also be specified: "32K", "100M", "2G" are all valid.
       def initialize(path, options = {})
+        @manual = options[:manual]
         @max_size = options[:max_size]
         if @max_size.is_a?(String)
           if @max_size.match(/^(\d+(\.\d+)?)([KMG])?$/i)
@@ -37,8 +38,8 @@ module Lumberjack
       end
 
       def roll_file?
-        stream.stat.size > @max_size
-      rescue SystemCallError => e
+        @manual || stream.stat.size > @max_size
+      rescue SystemCallError
         false
       end
       

data/lib/lumberjack/device/writer.rb

@@ -19,7 +19,7 @@ module Lumberjack
         end
         
         def <<(string)
-          @values << string
+          @values << string.encode("UTF-8".freeze, invalid: :replace, undef: :replace)
           @size += string.size
         end
         

data/lib/lumberjack/formatter.rb

@@ -8,10 +8,10 @@ module Lumberjack
   # By default, all object will be converted to strings using their inspect method except for Strings
   # and Exceptions. Strings are not converted and Exceptions are converted using the ExceptionFormatter.
   class Formatter
-    load File.expand_path("../formatter/exception_formatter.rb", __FILE__)
-    load File.expand_path("../formatter/inspect_formatter.rb", __FILE__)
-    load File.expand_path("../formatter/pretty_print_formatter.rb", __FILE__)
-    load File.expand_path("../formatter/string_formatter.rb", __FILE__)
+    require File.expand_path("../formatter/exception_formatter.rb", __FILE__)
+    require File.expand_path("../formatter/inspect_formatter.rb", __FILE__)
+    require File.expand_path("../formatter/pretty_print_formatter.rb", __FILE__)
+    require File.expand_path("../formatter/string_formatter.rb", __FILE__)
     
     def initialize
       @class_formatters = {}

data/lib/lumberjack/rack.rb

@@ -1,5 +1,5 @@
 module Lumberjack
   module Rack
-    autoload :UnitOfWork, File.expand_path("../rack/unit_of_work.rb", __FILE__)
+    require File.expand_path("../rack/unit_of_work.rb", __FILE__)
   end
 end

data/spec/device/date_rolling_log_file_spec.rb

@@ -13,53 +13,56 @@ describe Lumberjack::Device::DateRollingLogFile do
   let(:one_day){ 60 * 60 * 24 }
   
   it "should roll the file daily" do
-    today = Date.today
     now = Time.now
     log_file = File.join(tmp_dir, "a#{rand(1000000000)}.log")
     device = Lumberjack::Device::DateRollingLogFile.new(log_file, :roll => :daily, :template => ":message")
     logger = Lumberjack::Logger.new(device, :buffer_size => 2)
-    logger.error("test day one")
-    logger.flush
-    Time.stub(:now => now + one_day)
-    Date.stub(:today => today + 1)
-    logger.error("test day two")
-    logger.close
-    
-    File.read("#{log_file}.#{today.strftime('%Y-%m-%d')}").should == "test day one#{Lumberjack::LINE_SEPARATOR}"
+    Timecop.travel(now) do
+      logger.error("test day one")
+      logger.flush
+    end
+    Timecop.travel(now + one_day) do
+      logger.error("test day two")
+      logger.close
+    end
+  
+    File.read("#{log_file}.#{now.to_date.strftime('%Y-%m-%d')}").should == "test day one#{Lumberjack::LINE_SEPARATOR}"
     File.read(log_file).should == "test day two#{Lumberjack::LINE_SEPARATOR}"
   end
 
   it "should roll the file weekly" do
-    today = Date.today
     now = Time.now
     log_file = File.join(tmp_dir, "b#{rand(1000000000)}.log")
     device = Lumberjack::Device::DateRollingLogFile.new(log_file, :roll => :weekly, :template => ":message")
     logger = Lumberjack::Logger.new(device, :buffer_size => 2)
-    logger.error("test week one")
-    logger.flush
-    Time.stub(:now => now + (7 * one_day))
-    Date.stub(:today => today + 7)
-    logger.error("test week two")
-    logger.close
+    Timecop.freeze(now) do
+      logger.error("test week one")
+      logger.flush
+    end
+    Timecop.freeze(now + (7 * one_day)) do
+      logger.error("test week two")
+      logger.close
+    end
     
-    File.read("#{log_file}.#{today.strftime('week-of-%Y-%m-%d')}").should == "test week one#{Lumberjack::LINE_SEPARATOR}"
+    File.read("#{log_file}.#{now.to_date.strftime('week-of-%Y-%m-%d')}").should == "test week one#{Lumberjack::LINE_SEPARATOR}"
     File.read(log_file).should == "test week two#{Lumberjack::LINE_SEPARATOR}"
   end
 
   it "should roll the file monthly" do
-    today = Date.today
     now = Time.now
     log_file = File.join(tmp_dir, "c#{rand(1000000000)}.log")
     device = Lumberjack::Device::DateRollingLogFile.new(log_file, :roll => :monthly, :template => ":message")
     logger = Lumberjack::Logger.new(device, :buffer_size => 2)
-    logger.error("test month one")
-    logger.flush
-    Time.stub(:now => now + (31 * one_day))
-    Date.stub(:today => today + 31)
-    logger.error("test month two")
-    logger.close
-    
-    File.read("#{log_file}.#{today.strftime('%Y-%m')}").should == "test month one#{Lumberjack::LINE_SEPARATOR}"
+    Timecop.freeze(now) do
+      logger.error("test month one")
+      logger.flush
+    end
+    Timecop.freeze(now + (31 * one_day)) do
+      logger.error("test month two")
+      logger.close
+    end
+  
+    File.read("#{log_file}.#{now.to_date.strftime('%Y-%m')}").should == "test month one#{Lumberjack::LINE_SEPARATOR}"
     File.read(log_file).should == "test month two#{Lumberjack::LINE_SEPARATOR}"
   end
 

data/spec/device/log_file_spec.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 require 'spec_helper'
 
 describe Lumberjack::Device::LogFile do
@@ -23,4 +24,21 @@ describe Lumberjack::Device::LogFile do
     File.read(log_file).should == "Existing contents\nNew log entry#{Lumberjack::LINE_SEPARATOR}"
   end
 
+  it "properly handles messages with broken UTF-8 characters" do
+    log_file = File.join(tmp_dir, "test_6.log")
+    device = Lumberjack::Device::LogFile.new(log_file,
+      :keep => 2, :buffer_size => 32767)
+
+    message = [0xC4, 0x90, 0xE1, 0xBB].pack("c*").force_encoding "ASCII-8BIT"
+    entry = Lumberjack::LogEntry.new(Time.now, 1, message, nil, $$, nil)
+    device.write entry
+
+    message = "проверка"
+    entry = Lumberjack::LogEntry.new(Time.now, 1, message, nil, $$, nil)
+    device.write entry
+
+    expect do
+      device.flush
+    end.to_not raise_error
+  end
 end

data/spec/device/rolling_log_file_spec.rb

@@ -16,7 +16,7 @@ describe Lumberjack::Device::RollingLogFile do
   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.write(entry)
-    device.should_receive(:roll_file?).twice.and_return(false)
+    expect(device).to receive(:roll_file?).twice.and_return(false)
     device.flush
     device.close
   end
@@ -24,8 +24,8 @@ 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.should_receive(:roll_file?).and_return(false, true)
-    device.should_receive(:after_roll)
+    expect(device).to receive(:roll_file?).and_return(false, true)
+    expect(device).to receive(:after_roll)
     device.stub(:archive_file_suffix => "rolled")
     device.write(entry)
     device.flush
@@ -108,12 +108,12 @@ describe Lumberjack::Device::RollingLogFile do
   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.should_receive(:roll_file?).and_return(false, true, true, true)
-    device.should_receive(:archive_file_suffix).and_return("delete", "another", "keep")
+    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
-    File.should_receive(:ctime).with("#{log_file}.delete").at_least(1).times.and_return(t + 1)
-    File.should_receive(:ctime).with("#{log_file}.another").at_least(1).times.and_return(t + 2)
-    File.should_receive(:ctime).with("#{log_file}.keep").at_least(1).times.and_return(t + 3)
+    expect(File).to receive(:ctime).with("#{log_file}.delete").at_least(1).times.and_return(t + 1)
+    expect(File).to receive(:ctime).with("#{log_file}.another").at_least(1).times.and_return(t + 2)
+    expect(File).to receive(:ctime).with("#{log_file}.keep").at_least(1).times.and_return(t + 3)
     device.write(entry)
     device.flush
     device.write(entry)
@@ -125,4 +125,26 @@ describe Lumberjack::Device::RollingLogFile do
     Dir.glob("#{log_file}*").sort.should == [log_file, "#{log_file}.another", "#{log_file}.keep"]
   end
 
+  context "when file is rolled" 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.stub(:roll_file?).and_return(true)
+      device.stub(:archive_file_suffix => "rolled")
+      device
+    end
+
+    before do
+      device.write(entry)
+      device.flush
+    end
+
+    it "reopens file with proper encoding" do
+      encoding = device.send(:stream).external_encoding
+      expect(encoding).to_not be_nil
+      expect(encoding.name).to eq "ASCII-8BIT"
+    end
+  end
+
 end

data/spec/lumberjack_spec.rb

@@ -7,10 +7,10 @@ describe Lumberjack do
       Lumberjack.unit_of_work_id.should == nil
       Lumberjack.unit_of_work do
         id_1 = Lumberjack.unit_of_work_id
-        id_1.should match(/^[0-9A-F]{12}$/)
+        id_1.should match(/^[0-9a-f]{12}$/)
         Lumberjack.unit_of_work do
           id_2 = Lumberjack.unit_of_work_id
-          id_2.should match(/^[0-9A-F]{12}$/)
+          id_2.should match(/^[0-9a-f]{12}$/)
           id_2.should_not == id_1
         end
         id_1.should == Lumberjack.unit_of_work_id

data/spec/spec_helper.rb

@@ -1,6 +1,16 @@
 require File.expand_path("../../lib/lumberjack.rb", __FILE__)
 require 'stringio'
 require 'fileutils'
+require 'timecop'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = [:should, :expect]
+  end
+  config.mock_with :rspec do |c|
+    c.syntax = [:should, :expect]
+  end
+end
 
 def tmp_dir
   File.expand_path("../tmp", __FILE__)

metadata

@@ -1,21 +1,49 @@
 --- !ruby/object:Gem::Specification
 name: lumberjack
 version: !ruby/object:Gem::Version
-  version: 1.0.9
+  version: 1.0.10
 platform: ruby
 authors:
 - Brian Durand
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-25 00:00:00.000000000 Z
-dependencies: []
+date: 2016-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.0
 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.
 email:
-- bdurand@embellishedvisions.com
+- bbdurand@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
@@ -85,7 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.3.0
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: A simple, powerful, and very fast logging utility that can be a drop in replacement