lumberjack 1.0.13 → 1.2.8

data/lumberjack.gemspec

@@ -0,0 +1,31 @@
+Gem::Specification.new do |spec|
+  spec.name = "lumberjack"
+  spec.version = File.read(File.join(__dir__, "VERSION")).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[
+    .
+    Appraisals
+    Gemfile
+    Gemfile.lock
+    Rakefile
+    gemfiles/
+    spec/
+  ]
+  spec.files = Dir.chdir(__dir__) 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 "bundler"
+end

metadata

@@ -1,103 +1,77 @@
 --- !ruby/object:Gem::Specification
 name: lumberjack
 version: !ruby/object:Gem::Version
-  version: 1.0.13
+  version: 1.2.8
 platform: ruby
 authors:
 - Brian Durand
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-29 00:00:00.000000000 Z
+date: 2020-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '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'
-  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'
+description: 
 email:
 - bbdurand@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- MIT_LICENSE
+- CHANGELOG.md
+- MIT_LICENSE.txt
 - 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/strip_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/tag_formatter.rb
+- lib/lumberjack/tagged_logger_support.rb
+- lib/lumberjack/tagged_logging.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 +80,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

data/Rakefile

@@ -1,40 +0,0 @@
-require 'rubygems'
-require 'rake'
-require 'rubygems/package_task'
-
-desc 'Default: run unit tests.'
-task :default => :test
-
-desc 'RVM likes to call it tests'
-task :tests => :test
-
-begin
-  require 'rspec'
-  require 'rspec/core/rake_task'
-  desc 'Run the unit tests'
-  RSpec::Core::RakeTask.new(:test)
-rescue LoadError
-  task :test do
-    STDERR.puts "You must have rspec 2.0 installed to run the tests"
-  end
-end
-
-namespace :rbx do
-  desc "Cleanup *.rbc files in lib directory"
-  task :delete_rbc_files do
-    FileList["**/*.rbc"].each do |rbc_file|
-      File.delete(rbc_file)
-    end
-    nil
-  end
-end
-
-spec_file = File.expand_path('../lumberjack.gemspec', __FILE__)
-if File.exist?(spec_file)
-  spec = eval(File.read(spec_file))
-
-  Gem::PackageTask.new(spec) do |p|
-    p.gem_spec = spec
-  end
-  Rake.application["package"].prerequisites.unshift("rbx:delete_rbc_files")
-end

data/spec/device/date_rolling_log_file_spec.rb

@@ -1,73 +0,0 @@
-require 'spec_helper'
-
-describe Lumberjack::Device::DateRollingLogFile do
-
-  before :all do
-    create_tmp_dir
-  end
-  
-  after :all 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", :min_roll_check => 0)
-    logger = Lumberjack::Logger.new(device, :buffer_size => 2)
-    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
-    now = Time.now
-    log_file = File.join(tmp_dir, "b#{rand(1000000000)}.log")
-    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")
-      logger.flush
-    end
-    Timecop.freeze(now + (7 * one_day)) do
-      logger.error("test week two")
-      logger.close
-    end
-    
-    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
-    now = Time.now
-    log_file = File.join(tmp_dir, "c#{rand(1000000000)}.log")
-    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")
-      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
-
-end

data/spec/device/log_file_spec.rb

@@ -1,48 +0,0 @@
-# -*- coding: utf-8 -*-
-require 'spec_helper'
-
-describe Lumberjack::Device::LogFile do
-
-  before :all do
-    create_tmp_dir
-  end
-  
-  after :all 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|
-      f.puts("Existing contents")
-    end
-    
-    device = Lumberjack::Device::LogFile.new(log_file, :template => ":message")
-    device.write(Lumberjack::LogEntry.new(Time.now, 1, "New log entry", nil, $$, nil))
-    device.close
-    
-    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/null_spec.rb

@@ -1,12 +0,0 @@
-require 'spec_helper'
-
-describe Lumberjack::Device::Null do
-
-  it "should not generate any output" do
-    device = Lumberjack::Device::Null.new
-    device.write(Lumberjack::LogEntry.new(Time.now, 1, "New log entry", nil, $$, nil))
-    device.flush
-    device.close
-  end
-
-end

data/spec/device/rolling_log_file_spec.rb

@@ -1,151 +0,0 @@
-require 'spec_helper'
-
-describe Lumberjack::Device::RollingLogFile do
-
-  before :all do
-    Lumberjack::Device::SizeRollingLogFile #needed by jruby
-    create_tmp_dir
-  end
-  
-  after :all 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, :min_roll_check => 0)
-    device.write(entry)
-    expect(device).to receive(:roll_file?).twice.and_return(false)
-    device.flush
-    device.close
-  end
-  
-  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, :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")
-    device.write(entry)
-    device.flush
-    device.write(Lumberjack::LogEntry.new(Time.now, 1, "Another log entry", nil, $$, nil))
-    device.close
-    File.read("#{log_file}.rolled").should == "New log entry#{Lumberjack::LINE_SEPARATOR}"
-    File.read(log_file).should == "Another log entry#{Lumberjack::LINE_SEPARATOR}"
-  end
-  
-  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", :min_roll_check => 0)
-    device.stub(:roll_file? => false)
-    device.write(entry)
-    device.flush
-    File.rename(log_file, "#{log_file}.rolled")
-    device.flush
-    device.write(Lumberjack::LogEntry.new(Time.now, 1, "Another log entry", nil, $$, nil))
-    device.close
-    File.read("#{log_file}.rolled").should == "New log entry#{Lumberjack::LINE_SEPARATOR}"
-    File.read(log_file).should == "Another log entry#{Lumberjack::LINE_SEPARATOR}"
-  end
-  
-  it "should roll the file properly with multiple thread and processes using it" do
-    log_file = File.join(tmp_dir, "test_4.log")
-    process_count = 8
-    thread_count = 4
-    entry_count = 400
-    max_size = 128
-    severity = Lumberjack::Severity::INFO
-    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, :min_roll_check => 0)
-      threads = []
-      thread_count.times do
-        threads << Thread.new do
-          entry_count.times do |i|
-            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.value}
-      device.close
-    end
-    
-    # Process.fork is unavailable on jruby so we need to use the java threads instead.
-    if RUBY_PLATFORM.match(/java/)
-      outer_threads = []
-      process_count.times do
-        outer_threads << Thread.new(&logger_test)
-      end
-      outer_threads.each{|thread| thread.value}
-    else
-      process_count.times do
-        Process.fork(&logger_test)
-      end
-      Process.waitall
-    end
-    
-    line_count = 0
-    file_count = 0
-    Dir.glob("#{log_file}*").each do |file|
-      file_count += 1
-      lines = File.read(file).split(Lumberjack::LINE_SEPARATOR)
-      line_count += lines.size
-      lines.each do |line|
-        line.should == message
-      end
-    end
-    
-    file_count.should > 3
-  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, :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
-    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)
-    device.flush
-    device.write(entry)
-    device.flush
-    device.write(entry)
-    device.close
-    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, :min_roll_check => 0)
-      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