birling 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4dc4f5818efaa56556172c346f84d65003945d4896b54b8a429f9efe04a79bc
-  data.tar.gz: ab4735d6d76d9f00f02f68de2782c530a677f06d58f2e014534f22cfd7a4d5dd
+  metadata.gz: a2d34d601f2ff30378ab9b5e133d806978b9da61a64de3ac878b1ed10b04fd96
+  data.tar.gz: 363723fcff5a1ba4ba67ebfcd89619d4377087e780120c1ad0d37acf8cf28471
 SHA512:
-  metadata.gz: 1dffa664260145c4c5c4c6f4bf0f9e76372f923615647182a131722075f41c9ad09f410344ba2c8f2b95a32ba735886fd06090651d572bbde6187dbddcf7f5f8
-  data.tar.gz: 97c0654adf37b1046b75c896e0b10832a214dde9d9659430bf9eb8a5de2e11eece9d8c5d076db907713b17da7b76e66b9d4aaf2d4aa59160d6390e640979ed5b
+  metadata.gz: 1b5c2cb58a1a7130b66c1dfb67aaa9b48e2a843d72f32abbc95bfdb6c087a0d688a9c080f2ed33d3728d7abe93ac250e490d44019f23f9b3af7964321061d6f0
+  data.tar.gz: 73c01e0ad63f2c53350814b17342f489114255eab32f3f5ea49db0d20f6c5554e173fc21ba99b45624e0390a45200d677f3883dae6cd86821b85f6e992fc5c58

data/.travis.yml

@@ -1,10 +1,9 @@
 language: ruby
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.5
-  - 2.2.0
-  - 2.3.3
-  - 2.4.2
+  - 2.4.10
+  - 2.5.8
+  - 2.6.6
+  - 2.7.2
+  - 3.0.0
 before_install:
 - export TZ=EST5EDT

data/VERSION

@@ -1 +1 @@
-0.2.2
+0.3.0

data/birling.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: birling 0.2.2 ruby lib
+# stub: birling 0.3.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "birling".freeze
-  s.version = "0.2.2"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Scott Tadman".freeze]
-  s.date = "2020-01-28"
+  s.date = "2021-02-17"
   s.description = "Mostly drop-in replacement for Logger with a more robust log rotation facility".freeze
   s.email = "github@tadman.ca".freeze
   s.extra_rdoc_files = [
@@ -38,7 +38,7 @@ Gem::Specification.new do |s|
   ]
   s.homepage = "http://github.com/postageapp/birling".freeze
   s.licenses = ["MIT".freeze]
-  s.rubygems_version = "3.1.2".freeze
+  s.rubygems_version = "3.1.4".freeze
   s.summary = "Logger with simple log rotation system".freeze
 
   if s.respond_to? :specification_version then

data/lib/birling/logger.rb

@@ -1,6 +1,6 @@
 class Birling::Logger
   # == Constants ============================================================
-  
+
   # These level constants are the same as the syslog system utility
   SEVERITY = {
     emergency: EMERGENCY = 0,
@@ -13,17 +13,17 @@ class Birling::Logger
     debug: DEBUG = 7,
     unknown: UNKNOWN = 999
   }.freeze
-  
+
   DEFAULT_SEVERITY = UNKNOWN
 
   SEVERITY_LABEL = SEVERITY.invert.freeze
-  
+
   PATH_TIME_DEFAULT = {
     hourly: '%Y%m%d%H'.freeze,
     daily: '%Y%m%d'.freeze,
     default: '%s'.freeze
   }.freeze
-  
+
   # == Properties ===========================================================
 
   attr_reader :severity
@@ -38,9 +38,9 @@ class Birling::Logger
   attr_reader :retain_period
   attr_reader :period
   attr_reader :rotation_time
-  
+
   # == Class Methods ========================================================
-  
+
   def self.severity(value)
     case (value)
     when Symbol
@@ -53,7 +53,7 @@ class Birling::Logger
       DEFAULT_SEVERITY
     end
   end
-  
+
   # == Instance Methods =====================================================
 
   # Use Birling.open(...) to create new instances.
@@ -84,50 +84,50 @@ class Birling::Logger
     when String
       @path = log
     end
-      
+
     if (@path and @period)
       @rotation_time = self.next_rotation_time
-      
+
       @path_time_format = (PATH_TIME_DEFAULT[@period] or PATH_TIME_DEFAULT[:default])
-      
+
       @path_format ||=
         @path.sub(/\.(\w+)$/) do |s|
           '.' + @path_time_format + '.' + $1
         end
     end
-    
+
     if (@path and !@log)
       self.log_open!
     end
-  
+
     yield(self) if (block_given?)
   end
-  
+
   # Sets the severity filter for logging. Any messages with a lower severity
   # will be ignored. Any invalid severity options will reset the severity
   # filter to defaults.
   def severity=(value)
     @severity = self.class.severity(value)
   end
-  
+
   # Returns true if the log can be rotated, false otherwise.
   def can_rotate?
     !!@path
   end
-  
+
   # Sets the retention interval for log files. Value should respond to to_i
   # and yield an integer value that's a positive number of seconds between
   # rotation operations.
   def retain=(value)
     @retain = value ? value.to_i : nil
-    
+
     if (@retain_period and @retain_period <= 0)
       @retain_period = nil
     end
-    
+
     @retain_period
   end
-  
+
   # An IO compatible method for writing a message to the file. Only non-empty
   # messages are actually logged.
   def write(message)
@@ -148,12 +148,12 @@ class Birling::Logger
   # data will be written if the current log level is not sufficiently high.
   def log(level, message = nil, program = nil)
     return unless (@log)
-    
+
     level = self.class.severity(level)
     program ||= @program
 
     self.check_log_rotation!
-    
+
     @log.write(@formatter.call(level, @time_source.now, program, message))
   end
   alias_method :add, :log
@@ -167,12 +167,12 @@ class Birling::Logger
   # Writes to the log file regardless of log level.
   def <<(message)
     return unless (@log)
-    
+
     self.check_log_rotation!
-    
+
     @log.write(message)
   end
-  
+
   # Each of the severity levels has an associated method name. For example:
   # * debug? - Returns true if the logging level is at least debug, false
   #            otherwise.
@@ -182,14 +182,14 @@ class Birling::Logger
     define_method(:"#{name}?") do
       @severity >= level
     end
-    
-    define_method(name) do |message = nil, program = nil|
+
+    define_method(name) do |message = nil, program = nil, &block|
       return unless (@log and @severity >= level)
-      
+
       program ||= @program
-      
+
       if (!message and block_given?)
-        message = yield
+        message = block.call
       end
 
       self.check_log_rotation!
@@ -201,11 +201,11 @@ class Birling::Logger
   # Closes the log.
   def close
     return unless (@log)
-    
+
     @log.close
     @log = nil
   end
-  
+
   # Returns true if the log is opened, false otherwise.
   def opened?
     !!@log
@@ -220,17 +220,17 @@ class Birling::Logger
   def create_time
     @log and @log.ctime
   end
-  
+
   # Returns size of the log if opened, nil otherwise.
   def size
     @log and @log.size
   end
-   
+
   # Returns the age of the log file in seconds if opened, nil otherwise.
   def age(relative_to = nil)
     @log and (relative_to || @time_source.now) - @log.ctime
   end
-  
+
 protected
   def next_rotation_time
     case (@period)
@@ -244,21 +244,21 @@ protected
       nil
     end
   end
-  
+
   def prune_logs!
     return unless (@path and (@retain_period or @retain_count))
-    
+
     log_spec = @path.sub(/\.(\w+)$/, '*')
-    
+
     logs = (Dir.glob(log_spec) - [ @path ]).collect do |p|
       stat = File.stat(p)
       create_time = (stat and stat.ctime or @time_source.now)
-      
+
       [ p, create_time ]
     end.sort_by do |r|
       r[1] || @time_source.now
     end
-    
+
     if (@retain_period)
       logs.reject! do |r|
         if (Time.now - r[1] > @retain_period)
@@ -266,23 +266,23 @@ protected
         end
       end
     end
-    
+
     if (@retain_count)
       # The logs array is sorted from oldest to newest, so retaining the N
       # newest entries entails stripping them off the end with pop.
 
       logs.pop(@retain_count)
-      
+
       FileUtils.rm_f(logs.collect { |r| r[0] })
     end
   end
-  
+
   def check_log_rotation!
     return unless (@rotation_time)
-    
+
     if (@time_source.now >= @rotation_time)
       self.log_open!
-      
+
       @rotation_time = self.next_rotation_time
     end
   end
@@ -290,10 +290,10 @@ protected
   def log_open!
     if (@path_format)
       @current_path = @time_source.now.strftime(@path_format)
-      
-      @log = File.open(@current_path, 'a', @file_open_options)
+
+      @log = File.open(@current_path, 'a', **@file_open_options)
       @log.sync = true
-      
+
       if (File.symlink?(@path))
         File.unlink(@path)
       end
@@ -301,12 +301,12 @@ protected
       unless (File.exist?(@path))
         File.symlink(@current_path, @path)
       end
-      
+
       self.prune_logs!
     else
       @current_path = @path
-      
-      @log = File.open(@current_path, 'a', @file_open_options)
+
+      @log = File.open(@current_path, 'a', **@file_open_options)
 
       @log.sync = true
     end

data/test/test_birling_logger.rb

@@ -1,30 +1,31 @@
-require File.expand_path('helper', File.dirname(__FILE__))
+require File.expand_path('helper', __dir__)
+require 'stringio'
 
 class TestBirlingLogger < Test::Unit::TestCase
   def test_defaults
     temp_path do |path|
       log = Birling::Logger.new(path)
-    
+
       assert log
 
       assert log.opened?
       assert !log.closed?
       assert_equal 0, log.size
       assert Time.now >= log.create_time
-      
+
       assert_equal Birling::Formatter, log.formatter
       assert_equal Time, log.time_source
       assert_equal nil, log.period
     end
   end
-  
+
   def test_with_handle
     s = StringIO.new
-    
+
     log = Birling::Logger.new(s)
-    
+
     assert log.opened?
-    
+
     assert_equal 0, log.size
   end
 
@@ -34,9 +35,9 @@ class TestBirlingLogger < Test::Unit::TestCase
     buffer = StringIO.new
 
     log = Birling::Logger.new(buffer, time_source: Time::Warped)
-    
+
     assert log.opened?
-    
+
     assert_equal 0, log.size
 
     $stdout = log
@@ -56,21 +57,21 @@ class TestBirlingLogger < Test::Unit::TestCase
   ensure
     $stdout = stdout
   end
-  
+
   def test_formatter
     formatter_called = false
     formatter = lambda do |severity, time, program, message|
       formatter_called = true
       message
     end
-    
+
     output = StringIO.new
     log = Birling::Logger.new(output, formatter: formatter)
-    
+
     log.debug("Test")
-    
+
     assert_equal true, formatter_called
-    
+
     output.rewind
     assert_equal "Test", output.read
   end
@@ -78,44 +79,44 @@ class TestBirlingLogger < Test::Unit::TestCase
   def test_default_level
     temp_path do |path|
       log = Birling::Logger.new(path)
-    
+
       assert log
 
       assert log.opened?
       assert !log.closed?
       assert_equal 0, log.size
-      
+
       assert log.debug?
 
       log.debug("Test")
-      
+
       current_size = log.size
       assert current_size > 0
     end
   end
-  
+
   def test_direct_write
     output = StringIO.new
-  
+
     log = Birling::Logger.new(output)
-    
+
     log << "TEST"
-    
+
     assert_equal "TEST", output.string
   end
-  
+
   def test_level_filter
     output = StringIO.new
-  
+
     log = Birling::Logger.new(
       output,
       formatter: lambda { |s, t, p, m| "#{m}\n" },
       severity: :info
     )
-    
+
     log.debug("DEBUG")
     log.info("INFO")
-    
+
     output.rewind
     assert_equal "INFO\n", output.read
   end
@@ -127,67 +128,67 @@ class TestBirlingLogger < Test::Unit::TestCase
       assert log.debug?
 
       log.debug("Test")
-      
+
       current_size = log.size
       assert current_size > 0
-      
+
       create_time = log.create_time
       assert create_time <= Time.now
-      
+
       log.close
-      
+
       log = Birling::Logger.new(path)
-      
+
       assert_equal current_size, log.size
       assert_equal create_time, log.create_time
     end
   end
-  
+
   def test_time_source
     temp_path do |path|
       frozen_time = Time.now
       Time::Warped.now = frozen_time
-      
+
       logger = Birling::Logger.new(path, time_source: Time::Warped)
-      
+
       assert_equal frozen_time, logger.time_source.now
     end
   end
-  
+
   def test_cycling
     temp_path(:cycle) do |path|
       start = Time.now
       Time::Warped.now = start
       logger = Birling::Logger.new(path, period: 1, time_source: Time::Warped)
-      
+
       assert_equal 1, logger.period
-      
+
       current_path = logger.current_path
       assert_equal '%s', logger.path_time_format
-    
+
       logger.debug("Test")
-      
+
       Time::Warped.now += 1
-      
+
       logger.debug("Test")
 
       assert_not_equal current_path, logger.current_path
-      
+
       current_path = logger.current_path
 
       Time::Warped.now += 1
-      
+
       logger.debug("Test")
-      
+
       assert_not_equal current_path, logger.current_path
     end
   end
-  
+
   def test_retain_count
     temp_path(:cycle) do |path|
       start = Time.now
       Time::Warped.now = start
-      
+
       retain_count = 10
 
       logger = Birling::Logger.new(
@@ -204,23 +205,23 @@ class TestBirlingLogger < Test::Unit::TestCase
 
         logger.debug("Test")
       end
-      
+
       assert_equal retain_count, Dir.glob(logger.path_format % '*').length
     end
   end
-  
+
   def test_default_formatter
     temp_path(:cycle) do |path|
       logger = Birling::Logger.new(path)
-      
+
       lines = 100
-      
+
       lines.times do
         logger.debug("Test")
       end
-      
+
       logger.close
-      
+
       assert_equal lines, File.readlines(path).length
     end
   end
@@ -228,13 +229,13 @@ class TestBirlingLogger < Test::Unit::TestCase
   def test_retain_period
     temp_path(:cycle) do |path|
       retain_period = 3
-      
+
       logger = Birling::Logger.new(
         path,
         period: 1,
         retain_period: retain_period
       )
-      
+
       assert_equal true, File.exist?(path)
       assert_equal true, File.symlink?(path)
 
@@ -245,7 +246,7 @@ class TestBirlingLogger < Test::Unit::TestCase
         Time::Warped.now += 1
         logger.debug("Test")
       end
-      
+
       assert_equal retain_period + 1, Dir.glob(logger.path_format % '*').length
     end
   end
@@ -257,6 +258,6 @@ class TestBirlingLogger < Test::Unit::TestCase
       invalid = (0..255).to_a.pack('C*')
 
       logger.debug(invalid)
-    end    
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: birling
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Scott Tadman
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-01-28 00:00:00.000000000 Z
+date: 2021-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -81,7 +81,7 @@ homepage: http://github.com/postageapp/birling
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -96,8 +96,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Logger with simple log rotation system
 test_files: []