birling 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8a220611de2cd83e6b1a287c224613765b8ee134
-  data.tar.gz: 276014a8f6f9ab3d286ec16184379c459fa42dc2
+  metadata.gz: 5cc4db8e400e00db03c995a74cd74c00fa417399
+  data.tar.gz: a5fbb6997f34142f5c8663b47732fde5ce5ca2fd
 SHA512:
-  metadata.gz: 3be82ad9a9bbeacfbde7cd6ce127992cc2270894bd8e7567cf8ecc39c5f8a3d1d966b52c9b19b2d79d6f03022422faa0c54c6f0e091e8903805b1fed2e3cd93f
-  data.tar.gz: 90ad6b767bccc672dd58365ef6c3592f725e737c6c0cbc0445b9968093fa16fba7f1ef8e3a8d8a0e1145a4e95760691571c213cdaffcd7c8403f59d6fe800839
+  metadata.gz: 644c8a35cd87f0d707a319430e8b1d5662366e5166ac38e0b6acc2ebda83a069926926002abf56aae8ea3d501ab1437475f25669564ccd66eafcedb169556858
+  data.tar.gz: 2d12cd6c9fd88753e4a219475cda6b772c2267a437b63769aabd578c8585cc8cf13fcd79305c1e054c8d804cc4c95bd0654d25276ef0aa87a6d12b82e5ef3435

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.5
+  - 2.2.0
+  - 2.3.3
+  - 2.4.2
+before_install:
+- export TZ=EST5EDT

data/Gemfile

@@ -1,6 +1,7 @@
-source "https://rubygems.org/"
+source 'https://rubygems.org/'
 
 group :development do
-  gem "bundler"
-  gem "jeweler"
+  gem 'bundler'
+  gem 'test-unit'
+  gem 'jeweler'
 end

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Scott Tadman, The Working Group.
+Copyright (c) 2012-2017 Scott Tadman, PostageApp, The Working Group.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -34,8 +34,8 @@ of ten hourly logs:
 ```ruby
 logger = Birling.open(
   'test.log',
-  :period => :hourly,
-  :retain_count => 10
+  period: :hourly,
+  retain_count: 10
 )
 ```
 
@@ -46,8 +46,8 @@ that period will be removed:
 ```ruby
 logger = Birling.open(
   'test.log',
-  :period => :hourly,
-  :retain_period => 10 * 3600
+  period: :hourly,
+  retain_period: 10 * 3600
 )
 ```
 
@@ -60,7 +60,7 @@ Example:
 ```ruby
 logger = Birling.open(
   'test.log',
-  :formatter => lambda { |severity, time, program, message| "#{time}> #{message}\n" }
+  formatter: -> (severity, time, program, message) { "#{time}> #{message}\n" }
 )
 ```
 
@@ -76,4 +76,4 @@ using `STDOUT` the logger will not rotate.
 
 ## Copyright
 
-Copyright (c) 2011-2012 Scott Tadman, The Working Group Inc.
+Copyright (c) 2011-2017 Scott Tadman, PostageApp, The Working Group Inc.

data/Rakefile

@@ -14,7 +14,7 @@ require 'jeweler'
 
 Jeweler::Tasks.new do |gem|
   gem.name = "birling"
-  gem.homepage = "http://github.com/twg/birling"
+  gem.homepage = "http://github.com/postageapp/birling"
   gem.license = "MIT"
   gem.summary = %Q{Logger with simple log rotation system}
   gem.description = %Q{Mostly drop-in replacement for Logger with a more robust log rotation facility}

data/VERSION

@@ -1 +1 @@
-0.1.3
+0.2.0

data/birling.gemspec

@@ -2,24 +2,25 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: birling 0.1.3 ruby lib
+# stub: birling 0.2.0 ruby lib
 
 Gem::Specification.new do |s|
-  s.name = "birling"
-  s.version = "0.1.3"
+  s.name = "birling".freeze
+  s.version = "0.2.0"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.require_paths = ["lib"]
-  s.authors = ["Scott Tadman"]
-  s.date = "2015-01-31"
-  s.description = "Mostly drop-in replacement for Logger with a more robust log rotation facility"
-  s.email = "github@tadman.ca"
+  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 = "2017-12-13"
+  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 = [
     "LICENSE.txt",
     "README.md"
   ]
   s.files = [
     ".document",
+    ".travis.yml",
     "Gemfile",
     "LICENSE.txt",
     "README.md",
@@ -35,24 +36,27 @@ Gem::Specification.new do |s|
     "test/test_birling_logger.rb",
     "test/test_birling_support.rb"
   ]
-  s.homepage = "http://github.com/twg/birling"
-  s.licenses = ["MIT"]
-  s.rubygems_version = "2.2.2"
-  s.summary = "Logger with simple log rotation system"
+  s.homepage = "http://github.com/postageapp/birling".freeze
+  s.licenses = ["MIT".freeze]
+  s.rubygems_version = "2.6.13".freeze
+  s.summary = "Logger with simple log rotation system".freeze
 
   if s.respond_to? :specification_version then
     s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<bundler>, [">= 0"])
-      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<bundler>.freeze, [">= 0"])
+      s.add_development_dependency(%q<test-unit>.freeze, [">= 0"])
+      s.add_development_dependency(%q<jeweler>.freeze, [">= 0"])
     else
-      s.add_dependency(%q<bundler>, [">= 0"])
-      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<bundler>.freeze, [">= 0"])
+      s.add_dependency(%q<test-unit>.freeze, [">= 0"])
+      s.add_dependency(%q<jeweler>.freeze, [">= 0"])
     end
   else
-    s.add_dependency(%q<bundler>, [">= 0"])
-    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<bundler>.freeze, [">= 0"])
+    s.add_dependency(%q<test-unit>.freeze, [">= 0"])
+    s.add_dependency(%q<jeweler>.freeze, [">= 0"])
   end
 end
 

data/lib/birling.rb

@@ -7,6 +7,15 @@ class Birling
   
   # == Module Methods =======================================================
   
+  # Opens a new log file at the given path with options:
+  # * encoding: The encoding of the file (default: 'UTF8')
+  # * period: The rotation period to use (optional)
+  # * retain_count: How many log files to retain when rotating (optional)
+  # * retain_period: How long rotated log files are retained for (optional)
+  # * formatter: Custom log formatter (optional)
+  # * program: Name of program being logged (optional)
+  # * time_source: Source of time to use (optional)
+  # * path_format: The strftime-compatible format for the path (optional)
   def self.open(path, options = nil)
     Birling::Logger.new(path, options)
   end

data/lib/birling/formatter.rb

@@ -1,3 +1,5 @@
+require 'time'
+
 module Birling::Formatter
   # == Constants ============================================================
 
@@ -5,6 +7,12 @@ module Birling::Formatter
 
   # == Module Methods =======================================================
 
+  # Default time formatter method.
+  def self.time_format(time)
+    (time || Time.now).strftime(TIME_FORMAT_DEFAULT)
+  end
+
+  # Implementation for a plug-in Logger formatter.
   def self.call(severity, time, program, message)
     if (program)
       "[#{time.strftime(TIME_FORMAT_DEFAULT)}] <#{program}> #{message}\n"

data/lib/birling/logger.rb

@@ -3,15 +3,15 @@ class Birling::Logger
   
   # These level constants are the same as the syslog system utility
   SEVERITY = {
-    :emergency => EMERGENCY = 0,
-    :alert => ALERT = 1,
-    :critical => CRITICAL = 2,
-    :error => ERROR = 3,
-    :warning => WARNING = 4,
-    :notice => NOTICE = 5,
-    :info => INFO = 6,
-    :debug => DEBUG = 7,
-    :unknown => UNKNOWN = 999
+    emergency: EMERGENCY = 0,
+    alert: ALERT = 1,
+    critical: CRITICAL = 2,
+    error: ERROR = 3,
+    warning: WARNING = 4,
+    notice: NOTICE = 5,
+    info: INFO = 6,
+    debug: DEBUG = 7,
+    unknown: UNKNOWN = 999
   }.freeze
   
   DEFAULT_SEVERITY = UNKNOWN
@@ -19,9 +19,9 @@ class Birling::Logger
   SEVERITY_LABEL = SEVERITY.invert.freeze
   
   PATH_TIME_DEFAULT = {
-    :hourly => '%Y%m%d%H'.freeze,
-    :daily => '%Y%m%d'.freeze,
-    :default => '%s'.freeze
+    hourly: '%Y%m%d%H'.freeze,
+    daily: '%Y%m%d'.freeze,
+    default: '%s'.freeze
   }.freeze
   
   # == Properties ===========================================================
@@ -47,7 +47,7 @@ class Birling::Logger
       SEVERITY[value] or DEFAULT_SEVERITY
     when String
       SEVERITY[value.to_sym] or DEFAULT_SEVERITY
-    when Fixnum
+    when Integer
       SEVERITY_LABEL[value] and value or DEFAULT_SEVERITY
     else
       DEFAULT_SEVERITY
@@ -56,6 +56,7 @@ class Birling::Logger
   
   # == Instance Methods =====================================================
 
+  # Use Birling.open(...) to create new instances.
   def initialize(log, options = nil)
     @encoding = (options and options[:encoding])
     @period = (options and options[:period])
@@ -69,6 +70,10 @@ class Birling::Logger
 
     @file_open_options = { }
 
+    @rotation_time = nil
+    @path = nil
+    @log = nil
+
     if (@encoding)
       @file_open_options[:encoding] = @encoding
     end
@@ -98,18 +103,21 @@ class Birling::Logger
     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
   
-  def size
-    @log and @log.respond_to
-  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
     
@@ -120,6 +128,24 @@ class Birling::Logger
     @retain_period
   end
   
+  # An IO compatible method for writing a message to the file. Only non-empty
+  # messages are actually logged.
+  def write(message)
+    return unless (message.match(/\S/))
+
+    self.log(:debug, message.chomp)
+  end
+
+  def sync=(sync)
+    # Auto-sync is always turned on, so this operation is ignored.
+  end
+
+  def flush
+    # Auto-sync is always turned on, so this operation is ignored.
+  end
+
+  # Log the message for the (optional) program at the given log level. No
+  # data will be written if the current log level is not sufficiently high.
   def log(level, message = nil, program = nil)
     return unless (@log)
     
@@ -132,6 +158,7 @@ class Birling::Logger
   end
   alias_method :add, :log
 
+  # Writes to the log file regardless of log level.
   def <<(message)
     return unless (@log)
     
@@ -140,6 +167,11 @@ class Birling::Logger
     @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.
+  # * debug(message, program = nil) - Used to log a message with an optional
+  #                                   program name.
   SEVERITY.each do |name, level|
     define_method(:"#{name}?") do
       @severity >= level
@@ -160,6 +192,7 @@ class Birling::Logger
     end
   end
 
+  # Closes the log.
   def close
     return unless (@log)
     
@@ -167,30 +200,35 @@ class Birling::Logger
     @log = nil
   end
   
+  # Returns true if the log is opened, false otherwise.
   def opened?
     !!@log
   end
 
+  # Returns true if the log is closed, false otherwise.
   def closed?
     !@log
   end
 
+  # Returns the creation time of the log if opened, nil otherwise.
   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)
-    (relative_to || @time_source.now) - @log.ctime
+    @log and (relative_to || @time_source.now) - @log.ctime
   end
   
 protected
   def next_rotation_time
     case (@period)
-    when Fixnum, Float
+    when Integer, Float
       @time_source.now + @period
     when :daily
       Birling::Support.next_day(@time_source.now)
@@ -250,7 +288,7 @@ protected
       @log = File.open(@current_path, 'a', @file_open_options)
       @log.sync = true
       
-      if (File.exist?(@path) and File.symlink?(@path))
+      if (File.symlink?(@path))
         File.unlink(@path)
       end
 

data/lib/birling/support.rb

@@ -1,4 +1,7 @@
 module Birling::Support
+  # == Module + Mixin Methods ===============================================
+
+  # Computes the beginning of the next day.
   def next_day(time, time_source = nil)
     (time_source || Time).local(
       time.year,
@@ -10,6 +13,7 @@ module Birling::Support
     ) + 1
   end
   
+  # Computes the beginning of the next hour.
   def next_hour(time, time_source = nil)
     seconds_left = time.to_i % 3600
     

data/test/helper.rb

@@ -54,9 +54,9 @@ class Test::Unit::TestCase
       name = "#{name}.log"
     end
     
-    @temp_path ||= File.expand_path('../tmp', File.dirname(__FILE__))
+    temp_path ||= File.expand_path('../tmp', File.dirname(__FILE__))
     
-    full_path = File.expand_path(name, @temp_path)
+    full_path = File.expand_path(name, temp_path)
     
     FileUtils::mkdir_p(File.dirname(full_path))
     
@@ -64,7 +64,7 @@ class Test::Unit::TestCase
       begin
         yield(full_path)
       ensure
-        remove_spec = File.expand_path('*', @temp_path)
+        remove_spec = File.expand_path('*', temp_path)
         
         FileUtils.rm_f(Dir.glob(remove_spec))
       end

data/test/test_birling.rb

@@ -35,17 +35,4 @@ class TestBirling < Test::Unit::TestCase
     
     assert !File.exist?(_path)
   end
-  
-  def test_time_warped
-    _now = Time.now
-    
-    Time::Warped.now = _now
-
-    assert_not_equal Time.now, Time.now
-    assert_equal _now, Time::Warped.now
-    
-    Time::Warped.now = nil
-    
-    assert_not_equal _now, Time::Warped.now
-  end
 end

data/test/test_birling_logger.rb

@@ -27,6 +27,35 @@ class TestBirlingLogger < Test::Unit::TestCase
     
     assert_equal 0, log.size
   end
+
+  def test_io_compatible
+    stdout = $stdout
+
+    buffer = StringIO.new
+
+    log = Birling::Logger.new(buffer, time_source: Time::Warped)
+    
+    assert log.opened?
+    
+    assert_equal 0, log.size
+
+    $stdout = log
+
+    start = Time.parse('2017-10-10 12:00:00')
+
+    Time::Warped.now = start
+
+    puts "Test"
+
+    log.close
+
+    expected = "[2017-10-10 12:00:00] Test\n"
+
+    assert_equal expected, buffer.string.to_s
+
+  ensure
+    $stdout = stdout
+  end
   
   def test_formatter
     formatter_called = false
@@ -36,7 +65,7 @@ class TestBirlingLogger < Test::Unit::TestCase
     end
     
     output = StringIO.new
-    log = Birling::Logger.new(output, :formatter => formatter)
+    log = Birling::Logger.new(output, formatter: formatter)
     
     log.debug("Test")
     
@@ -72,8 +101,7 @@ class TestBirlingLogger < Test::Unit::TestCase
     
     log << "TEST"
     
-    output.rewind
-    assert_equal "TEST", output.read
+    assert_equal "TEST", output.string
   end
   
   def test_level_filter
@@ -81,8 +109,8 @@ class TestBirlingLogger < Test::Unit::TestCase
   
     log = Birling::Logger.new(
       output,
-      :formatter => lambda { |s, t, p, m| "#{m}\n" },
-      :severity => :info
+      formatter: lambda { |s, t, p, m| "#{m}\n" },
+      severity: :info
     )
     
     log.debug("DEBUG")
@@ -120,7 +148,7 @@ class TestBirlingLogger < Test::Unit::TestCase
       frozen_time = Time.now
       Time::Warped.now = frozen_time
       
-      logger = Birling::Logger.new(path, :time_source => Time::Warped)
+      logger = Birling::Logger.new(path, time_source: Time::Warped)
       
       assert_equal frozen_time, logger.time_source.now
     end
@@ -130,7 +158,7 @@ class TestBirlingLogger < Test::Unit::TestCase
     temp_path(:cycle) do |path|
       start = Time.now
       Time::Warped.now = start
-      logger = Birling::Logger.new(path, :period => 1, :time_source => Time::Warped)
+      logger = Birling::Logger.new(path, period: 1, time_source: Time::Warped)
       
       assert_equal 1, logger.period
       
@@ -164,14 +192,16 @@ class TestBirlingLogger < Test::Unit::TestCase
 
       logger = Birling::Logger.new(
         path,
-        :period => 1,
-        :time_source => Time::Warped,
-        :retain_count => retain_count
+        period: 1,
+        time_source: Time::Warped,
+        retain_count: retain_count
       )
 
       (retain_count + 5).times do |n|
         logger.debug("Test")
+
         Time::Warped.now += 1
+
         logger.debug("Test")
       end
       
@@ -201,8 +231,8 @@ class TestBirlingLogger < Test::Unit::TestCase
       
       logger = Birling::Logger.new(
         path,
-        :period => 1,
-        :retain_period => retain_period
+        period: 1,
+        retain_period: retain_period
       )
       
       assert_equal true, File.exist?(path)

data/test/test_birling_support.rb

@@ -4,6 +4,8 @@ class TestBirlingSupport < Test::Unit::TestCase
   def test_next_day_on_dst_flip
     in_time_zone('EST5EDT') do
       time = Time.new(2012, 11, 4)
+
+      assert_equal 'EDT', time.zone
       
       assert_equal time.day, (time + 86400).day
       
@@ -21,6 +23,8 @@ class TestBirlingSupport < Test::Unit::TestCase
   def test_hour_day_on_dst_flip
     in_time_zone('EST5EDT') do
       time = Time.new(2012, 11, 4, 0, 59, 59) + 1
+
+      assert_equal 'EDT', time.zone
       
       assert_equal time.hour, (time + 3600).hour
       
@@ -40,6 +44,8 @@ class TestBirlingSupport < Test::Unit::TestCase
   def test_next_day_at_year_end
     in_time_zone('EST5EDT') do
       time = Time.new(2012, 12, 31)
+
+      assert_equal 'EST', time.zone
       
       next_day = Birling::Support.next_day(time)
       

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: birling
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Scott Tadman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-31 00:00:00.000000000 Z
+date: 2017-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: jeweler
   requirement: !ruby/object:Gem::Requirement
@@ -48,6 +62,7 @@ extra_rdoc_files:
 - README.md
 files:
 - ".document"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -62,7 +77,7 @@ files:
 - test/test_birling.rb
 - test/test_birling_logger.rb
 - test/test_birling_support.rb
-homepage: http://github.com/twg/birling
+homepage: http://github.com/postageapp/birling
 licenses:
 - MIT
 metadata: {}
@@ -82,7 +97,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Logger with simple log rotation system