teelogger 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d9c8a99263a3785628fce130b7a1557eb0cc89dd
-  data.tar.gz: 8816398916355794b10a4c5a0bb47a0c710bd5cf
+  metadata.gz: 895f6e899d661222b23023e1ad0ebc7a57578b6a
+  data.tar.gz: 7ebdb6eeb7aee0fa333638951b6b8cff677b8f37
 SHA512:
-  metadata.gz: 78d098f5fb1393b842b5356f2eb4629ccaaf6d332e0c5976200f410e385a6498116e217e2f36aebc289977be130202295365d5aa271d781177766e2481933ce6
-  data.tar.gz: 57f4f91f1a68473af37473c968e2b4f221db3b5a901566e6f2ee0f184606af332ba52e3d5480df8aee277ab38ac138352b87e3eb5c1c0dc2a52e71077896f626
+  metadata.gz: 4da6b7652981ab639c5a3e728c3dce879a2db89ec4b81c4a5d8be960132cb047eee34d3c9765b4e55f6e847321f333d8690c222ddefbb03dd1dd9f2dae774aa2
+  data.tar.gz: befc09d315e3e342b7af707c10ec72f8b52a5b8ed8fced762b4ac905b2ae4578dc78f694b0c971d30794394f68b5e8a8e443a9b1ab4e77ea5d94497ebabeabb0

data/.travis.yml

@@ -5,6 +5,11 @@ script:
 os:
   - linux
   - osx
+language: ruby
 rvm:
   - 1.9.3  
   - 2.0.0
+notifications:
+  email:
+    recipients:
+      - foss@spritecloud.com

data/README.md

@@ -56,3 +56,8 @@ end
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
+
+
+## Shameless Plug
+
+Need software testing services? Contact [spriteCloud](http://www.spritecloud.com)

data/features/logger.feature

@@ -56,3 +56,20 @@ Feature: Logger
       | ERROR | have      |
       | FATAL | have      |
 
+  @logger_05
+  Scenario Outline: Flushing after each invocation
+    Given I create a TeeLogger with default parameters
+    And I set the flush_interval to "1"
+    And I set the log level to "<level>"
+    And I write a log message at log level "<level>"
+    Then I expect the log level "<level>" to have taken hold
+    And I expect the log message to appear on the screen
+
+    Examples:
+      | level |
+      | DEBUG |
+      | INFO  |
+      | WARN  |
+      | ERROR |
+      | FATAL |
+

data/features/step_definitions/steps.rb

@@ -10,8 +10,16 @@ logger = nil
 
 Given(/^I create a TeeLogger with default parameters$/) do
   logger = TeeLogger::TeeLogger.new
+  assert [TeeLogger::DEFAULT_FLUSH_INTERVAL] == logger.flush_interval, "Flush interval is not default: #{logger.flush_interval}"
 end
 
+Given(/^I set the flush_interval to "([^"]*)"$/) do |interval|
+  i = interval.to_i
+  logger.flush_interval = i
+  assert [i] == logger.flush_interval, "Setting flush interval did not take: #{logger.flush_interval}"
+end
+
+
 Given(/^I set the log level to "(.*?)"$/) do |level|
   logger.level = level
 end
@@ -28,6 +36,7 @@ end
 Then(/^I expect the log level "(.*?)" to (.*?) taken hold$/) do |level, condition|
   meth = "#{level.downcase}?".to_sym
   res = logger.send(meth)
+  logger.flush
 
   assert res, "Bad results!"
   if 'have' === condition

data/lib/teelogger.rb

@@ -2,7 +2,7 @@
 # TeeLogger
 # https://github.com/spriteCloud/teelogger
 #
-# Copyright (c) 2014 spriteCloud B.V. and other TeeLogger contributors.
+# Copyright (c) 2014-2015 spriteCloud B.V. and other TeeLogger contributors.
 # All rights reserved.
 #
 require "teelogger/version"
@@ -10,6 +10,49 @@ require "teelogger/version"
 require "logger"
 
 module TeeLogger
+  DEFAULT_FLUSH_INTERVAL = 2000
+
+  ##
+  # Extensions for the ruby logger
+  module LoggerExtensions
+    attr_accessor :teelogger_io
+    attr_accessor :flush_interval
+
+    ##
+    # Flush ruby and OS buffers for this logger
+    def flush
+      if @teelogger_io.nil?
+        raise "TeeLogger logger without IO object, can't do anything"
+      end
+
+      @teelogger_io.flush
+      begin
+        @teelogger_io.fsync
+      rescue NotImplementedError, Errno::EINVAL
+        # pass
+      end
+    end
+
+
+    ##
+    # This function invokes flush if it's been invoked more often than
+    # flush_interval.
+    def auto_flush
+      if @written.nil?
+        @written = 0
+      end
+
+      @written += 1
+
+      if @written >= self.flush_interval
+        self.flush
+        @written = 0
+      end
+    end
+  end # module LoggerExtensions
+
+
+
   ##
   # Logger that writes to multiple outputs. Behaves just like Ruby's Logger,
   # and like a hash of String => Logger.
@@ -32,6 +75,7 @@ module TeeLogger
   class TeeLogger
     @default_level
     @loggers
+    @ios
 
     ##
     # Convert a log level to its string name
@@ -63,38 +107,51 @@ module TeeLogger
       return val
     end
 
+private
+    ##
+    # Define log functions as strings, for internal re-use
+    LOG_FUNCTIONS = Logger::Severity.constants.map { |level| TeeLogger.string_level(level.to_s).downcase }
 
+public
 
     ##
     # Add a logger to the current loggers.
     def add_logger(arg)
       key = nil
       logger = nil
+      io = nil
       if arg.is_a? String
         # We have a filename
         key = File.basename(arg)
 
         # Try to create the logger.
-        file = File.new(arg, File::WRONLY | File::APPEND | File::CREAT)
-        logger = Logger.new(file)
+        io = File.new(arg, File::WRONLY | File::APPEND | File::CREAT)
+        logger = Logger.new(io)
 
         # Initialize logger
-        logger.unknown "Logging to '#{arg}' initialized with level #{TeeLogger.string_level(@default_level)}."
+        io.write "Logging to '#{arg}' initialized with level #{TeeLogger.string_level(@default_level)}.\n"
         logger.level = TeeLogger.convert_level(@default_level)
       else
         # We have some other object - let's hope it's an IO object
         key = arg.to_s
 
         # Try to create the logger.
-        logger = Logger.new(arg)
+        io = arg
+        logger = Logger.new(io)
 
         # Initialize logger
-        logger.unknown "Logging to #{key} initialized with level #{TeeLogger.string_level(@default_level)}."
+        io.write "Logging to #{key} initialized with level #{TeeLogger.string_level(@default_level)}.\n"
         logger.level = TeeLogger.convert_level(@default_level)
       end
 
-      if not key.nil? and not logger.nil?
+      # Extend logger instances with extra functionality
+      logger.extend(LoggerExtensions)
+      logger.teelogger_io = io
+      logger.flush_interval = DEFAULT_FLUSH_INTERVAL
+
+      if not key.nil? and not logger.nil? and not io.nil?
         @loggers[key] = logger
+        @ios[key] = io
       end
     end
 
@@ -110,6 +167,7 @@ module TeeLogger
       # Initialization
       @default_level = Logger::Severity::INFO
       @loggers = {}
+      @ios = {}
 
       # Create logs for all arguments
       args.each do |arg|
@@ -117,6 +175,7 @@ module TeeLogger
       end
     end
 
+
     ##
     # Set log level; override this to also accept strings
     def level=(val)
@@ -142,13 +201,16 @@ module TeeLogger
 
     ##
     # For each log level, define an appropriate logging function
-    Logger::Severity.constants.each do |const|
-      meth = TeeLogger.string_level(const.to_s).downcase
-
+    ["add"] + LOG_FUNCTIONS.each do |meth|
+      # Methods corresponding to severity levels will be auto_flushed
       define_method(meth) { |*args, &block|
-        dispatch(meth, *args, &block)
+        x = dispatch(meth, *args, &block)
+        dispatch("auto_flush")
+        x
       }
-      if "unknown" != meth
+
+      # Query methods for severity levels are defined
+      if not ["unknown", "add"].include? meth
         query = "#{meth}?"
         define_method(query)  { |*args, &block|
           dispatch(query, *args, &block)
@@ -157,6 +219,18 @@ module TeeLogger
     end
 
 
+    ##
+    # Add flush related functions from LoggerExtensions
+    LoggerExtensions.instance_methods(false).each do |method|
+      name = method.to_s
+      if name.start_with?("flush")
+        define_method(name) { |*args, &block|
+          dispatch(name, *args, &block)
+        }
+      end
+    end
+
+
     ##
     # Every function this class doesn't have should be mapped to the original
     # logger
@@ -207,12 +281,12 @@ module TeeLogger
       ret = []
       @loggers.each do |key, logger|
         if logger.respond_to? meth_name
-          if args.length > 0
+          if LOG_FUNCTIONS.include? meth_name
             ret << logger.send(meth_name, key) do
               message
             end
           else
-            ret << logger.send(meth_name, &block)
+            ret << logger.send(meth_name, *args, &block)
           end
         end
       end
@@ -228,4 +302,5 @@ module TeeLogger
     end
 
   end
+
 end

data/lib/teelogger/version.rb

@@ -2,9 +2,9 @@
 # TeeLogger
 # https://github.com/spriteCloud/teelogger
 #
-# Copyright (c) 2014 spriteCloud B.V. and other TeeLogger contributors.
+# Copyright (c) 2014,2015 spriteCloud B.V. and other TeeLogger contributors.
 # All rights reserved.
 #
 module TeeLogger
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: teelogger
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Jens Finkhaeuser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-09 00:00:00.000000000 Z
+date: 2015-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler