threadedlogger 1.1.0

data/History.txt

@@ -0,0 +1,11 @@
+# History for ThreadedLogger
+
+## v1.1.0
+
+* Dynamically generate logging methods
+* Enhance test suite
+
+## v1.0.0
+
+* Initial Release
+

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2012, 2013 James FitzGibbon <james@nadt.net>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to
+deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+sell copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+IN THE SOFTWARE.

data/Manifest.txt

@@ -0,0 +1,11 @@
+History.txt
+Manifest.txt
+README.txt
+LICENSE.txt
+Rakefile
+lib/threadedlogger.rb
+test/minitest_helper.rb
+test/test_logging.rb
+test/test_methods.rb
+test/test_threadedlogger.rb
+threadedlogger.gemspec

data/README.txt

@@ -0,0 +1,84 @@
+# ThreadedLogger
+
+home :: https://github.com/jf647/ThreadedLogger
+
+## SUMMARY:
+
+Simple ruby logging library with a dedicated logging thread.
+
+## DESCRIPTION:
+
+ThreadedLogger runs a dedicated logging thread around Ruby's Logger library
+to ensure that multiple threads don't step on each other's toes.
+
+## SYNOPSIS:
+
+```ruby
+require 'threadedlogger'
+
+log = ThreadedLogger.instance(logfname, 'daily', 'debug')
+log.info('START')
+...
+log.debug('super important stuff')
+...
+log.info("STOP")
+log.shutdown
+
+log2 = ThreadedLogger.instance(logfname, 'daily', 'debug', proc { |l| "prefix: #{l}" })
+```
+
+ThreadedLogger has one and only one instance, accessed via the ::instance
+class method.  You can only provide arguments the first time - trying to
+'re-construct' the object will throw an ArgumentError.
+
+Under the covers, the dedicated thread uses the standard Ruby Logger
+library.  Refer to [Logger](http://www.ruby-doc.org/stdlib-1.9.3/libdoc/logger/rdoc/Logger.html)
+for further detail.
+
+The arguments are: the filename, the rotation period (defaults to 'daily'),
+the loglevel (defaults to 'info') and an optional formatter proc that will
+be used instead of the one that comes with Logger.
+
+When you invoke one of the logging methods, the text is enqueued.  The
+background thread constantly pops messages off this queue and logs them.  To
+ensure that all queued messages have been written out, call the .shutdown
+instance method before your program exits.  On a clean shutdown this should
+happen automatically, but if you exit in a funky way it might not capture
+the last message.
+
+This library also overrides Logger.LogDevice.add_log_header to prevent it
+from putting a header line at the top of a logfile when it is first opened.
+
+## LICENSE:
+
+The MIT License (MIT)
+
+Copyright (c) 2012, 2013 James FitzGibbon <james@nadt.net>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to
+deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+sell copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+IN THE SOFTWARE.
+
+## Contributing to ThreadedLogger
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the version or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

data/Rakefile

@@ -0,0 +1,18 @@
+require 'rake/testtask'
+require 'hoe'
+
+Hoe.spec 'threadedlogger' do
+    developer("James FitzGibbon", "james@nadt.net")
+    license "MIT"
+end
+
+task :default => [:unit_tests]
+
+desc "Run basic tests"
+Rake::TestTask.new("unit_tests") { |t|
+    t.libs.push 'lib'
+    t.libs.push 'test'
+    t.pattern = 'test/test_*.rb'
+    t.verbose = true
+    t.warning = true
+}

data/lib/threadedlogger.rb

@@ -0,0 +1,133 @@
+require 'thread'
+require 'logger'
+
+class ThreadedLogger
+
+    VERSION = '1.1.0'
+    
+    @@instance = nil
+
+    LOGLEVELS = {
+        'debug' => Logger::DEBUG,
+        'info' => Logger::INFO,
+        'warn' => Logger::WARN,
+        'error' => Logger::ERROR,
+        'fatal' => Logger::FATAL,
+    }
+
+    private_class_method :new
+
+    # create the logging methods
+    LOGLEVELS.each do |k,v|
+        log_method = k.to_sym
+        test_method = "#{k}?".to_sym
+        define_method(log_method) { |msg=nil|
+            enqueue(v, msg)
+        }
+        define_method(test_method) {
+            @log.send(test_method)
+        }
+    end
+
+    def ThreadedLogger.instance(*args)
+
+        if @@instance.nil?
+            @@instance = new(*args)
+        else
+            if ! args.empty?
+                raise ArgumentError, "instance already constructed"
+            end
+        end
+
+        return @@instance
+
+    end
+
+    def initialize(file, rotation = 'daily', level = 'info', formatter = nil)
+
+        if file.nil?
+            raise ArgumentError, "log file name is required"
+        end
+
+        # create a logger
+        @log = Logger.new(file, rotation)
+
+        # set the min threshold
+        send(:level=, level)
+
+        # apply a formatter if one was given
+        if ! formatter.nil?
+            @log.formatter = formatter
+        end
+
+        # set up a queue and spawn a thread to do the logging
+        @queue = Queue.new
+        @shutdown = nil
+        @t = Thread.new { runlogger }
+      
+    end
+    
+    def level=(level)
+        if LOGLEVELS.has_key?(level)
+            @log.level = LOGLEVELS[level]
+        else
+            raise ArgumentError, "invalid log level #{level}"
+        end
+    end
+    
+    def shutdown
+
+        # stops new messages from being enqueued and tells thread
+        # to drain what's in the queue
+        @shutdown = true
+        @t.join
+
+    end
+
+    def enqueue(severity, msg=nil)
+
+        # don't enqueue if we're in shutdown
+        if( @shutdown )
+            return
+        end
+
+        # put the message on the queue
+        @queue.push( [severity, msg] )
+
+    end
+
+    private
+
+    def runlogger
+
+        # do blocking pops off the queue until the shutdown flag is set
+        while @shutdown.nil?
+            msg = @queue.pop(false)
+            @log.add(msg[0], msg[1])
+        end
+
+        # pop anything left on the queue off
+        while ! @queue.empty?
+            msg = @queue.pop(true)
+            @log.add(msg[0], msg[1])
+        end
+
+    end
+
+end
+
+# supress the "Logfile created at" header line that logger.rb provides
+class Logger
+
+    private
+
+    class LogDevice
+
+        private
+
+        def add_log_header(file)
+        end
+
+    end
+
+end

data/test/minitest_helper.rb

@@ -0,0 +1,5 @@
+require 'simplecov'
+SimpleCov.start do
+    add_filter '/vendor/'
+    add_filter '/test/'
+end

data/test/test_logging.rb

@@ -0,0 +1,25 @@
+require 'minitest_helper'
+require 'minitest/autorun'
+require 'threadedlogger'
+require 'fakefs'
+
+class ThreadedLogger
+    def ThreadedLogger.clear
+        if ! @@instance.nil?
+            @@instance.shutdown
+            @@instance = nil
+        end
+    end
+end
+
+class TestLogging < Minitest::Test
+    def setup
+        ThreadedLogger.clear
+    end
+    def test_logging
+        logger = ThreadedLogger.instance('foo.log', 'daily')
+        logger.info 'foo'
+        File.exists?('foo.log')
+        logger.shutdown
+    end
+end

data/test/test_methods.rb

@@ -0,0 +1,46 @@
+require 'minitest_helper'
+require 'minitest/autorun'
+require 'threadedlogger'
+require 'fakefs'
+
+class ThreadedLogger
+    def ThreadedLogger.clear
+        if ! @@instance.nil?
+            @@instance.shutdown
+            @@instance = nil
+        end
+    end
+end
+
+class TestMethods < Minitest::Test
+    def setup
+        ThreadedLogger.clear
+    end
+    def test_levels
+        logger = ThreadedLogger.instance('test/example.log', 'daily')
+        assert_instance_of ThreadedLogger, logger, "constructor works with 2 args"
+        %w(debug info warn error fatal).each do |level|
+            assert_respond_to(logger, level.to_sym, "logger responds to level #{level}")
+        end
+        assert_raises(ArgumentError) {
+            logger.level = 'foo'
+        }
+    end
+    def test_level_predicates
+        logger = ThreadedLogger.instance('test/example.log', 'daily', 'info')
+        assert_instance_of ThreadedLogger, logger, "constructor works with 3 args"
+        %w(debug info warn error fatal).each do |level|
+            assert_respond_to(logger, "#{level}?".to_sym, "logger responds to predicate #{level}?")
+        end
+    end
+    def test_setlevel
+        logger = ThreadedLogger.instance('test/example.log', 'daily', 'info')
+        assert_instance_of ThreadedLogger, logger, "constructor works with 3 args"
+        assert_equal(false, logger.debug?, 'debug is not on when contstructed at level info')
+        logger.level = 'debug'
+        assert_equal(true, logger.debug?, 'debug is on after explicitly setting level')
+    end
+    def test_nil_filename
+        assert_raises(ArgumentError) {  ThreadedLogger.instance(nil) }
+    end
+end

data/test/test_threadedlogger.rb

@@ -0,0 +1,47 @@
+require 'minitest_helper'
+require 'minitest/autorun'
+require 'threadedlogger'
+require 'fakefs'
+
+class ThreadedLogger
+    def ThreadedLogger.clear
+        if ! @@instance.nil?
+            @@instance.shutdown
+            @@instance = nil
+        end
+    end
+end
+
+class TestThreadedLogger < Minitest::Test
+    def setup
+        ThreadedLogger.clear
+    end
+    def test_constructor
+        logger = ThreadedLogger.instance('test/example.log', 'daily')
+        assert_instance_of ThreadedLogger, logger, "constructor works with 2 args"
+    end
+    def test_constructor_with_level
+        logger = ThreadedLogger.instance('test/example.log', 'daily', 'info')
+        assert_instance_of ThreadedLogger, logger, "constructor works with 3 args"
+    end
+    def test_constructor_with_level_and_formatter
+        logger = ThreadedLogger.instance('test/example.log', 'daily', 'info', proc { |l| l } )
+        assert_instance_of ThreadedLogger, logger, "constructor works with 4 args"
+    end
+    def test_constructor_noargs
+        assert_raises ArgumentError, "cannot call with no args" do
+            ThreadedLogger.instance
+        end
+    end
+    def test_singleton
+        loggera = ThreadedLogger.instance('test/example.log')
+        loggerb = ThreadedLogger.instance
+        assert_same loggera, loggerb, "two instances are the same object"
+    end
+    def test_construct_twice
+        assert_raises ArgumentError, "cannot call instance a second time with args" do
+            ThreadedLogger.instance('test/example.log')
+            ThreadedLogger.instance('test/example2.log')
+        end
+    end
+end

data/threadedlogger.gemspec

@@ -0,0 +1,15 @@
+$:.push File.expand_path("../lib", __FILE__)
+require 'threadedlogger'
+
+Gem::Specification.new do |s|
+    s.name          = 'threadedlogger'
+    s.version       = ThreadedLogger::VERSION
+    s.date          = '2013-03-23'
+    s.summary       = 'Simple logging library with a dedicated logging thread'
+    s.homepage      = 'https://github.com/jf647/ThreadedLogger'
+    s.authors       = ['James FitzGibbon']
+    s.email         = ['james@nadt.net']
+    s.files         = `git ls-files`.split("\n")
+    s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+    s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f)
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: threadedlogger
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+  prerelease: 
+platform: ruby
+authors:
+- James FitzGibbon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.7'
+description: ! 'ThreadedLogger runs a dedicated logging thread around Ruby''s Logger
+  library
+
+  to ensure that multiple threads don''t step on each other''s toes.'
+email:
+- james@nadt.net
+executables: []
+extensions: []
+extra_rdoc_files:
+- History.txt
+- Manifest.txt
+- README.txt
+- LICENSE.txt
+files:
+- History.txt
+- Manifest.txt
+- README.txt
+- LICENSE.txt
+- Rakefile
+- lib/threadedlogger.rb
+- test/minitest_helper.rb
+- test/test_logging.rb
+- test/test_methods.rb
+- test/test_threadedlogger.rb
+- threadedlogger.gemspec
+- .gemtest
+homepage: https://github.com/jf647/ThreadedLogger
+licenses:
+- MIT
+post_install_message: 
+rdoc_options:
+- --main
+- README.txt
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1670757235924190297
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1670757235924190297
+requirements: []
+rubyforge_project: threadedlogger
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: ThreadedLogger runs a dedicated logging thread around Ruby's Logger library
+  to ensure that multiple threads don't step on each other's toes.
+test_files:
+- test/test_logging.rb
+- test/test_methods.rb
+- test/test_threadedlogger.rb