threadedlogger 1.2.1 → 1.3.0

data/History.txt

@@ -1,5 +1,10 @@
 # History for ThreadedLogger
 
+## v1.30
+
+* add a class method initialized? to check if a logging instance for a class
+  has been initialized or not
+
 ## v1.2.1
 
 * autogenerate gemspec; the manual one had a syntax error

data/Manifest.txt

@@ -13,4 +13,5 @@ test/test_methods.rb
 test/test_threadedlogger.rb
 test/test_shutdown.rb
 test/test_clear.rb
+test/test_initialized_flag.rb
 threadedlogger.gemspec

data/README.txt

@@ -57,9 +57,13 @@ 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.
+The constructor 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.
+
+The logging instance should be invoked with arguments only once.  Subsequent
+uses of the instance accessor should pass no args.  Attempting to call the
+instance method twice with arguments will raise an ArgumentError.
 
 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
@@ -68,6 +72,13 @@ 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.
 
+You can tell if the logging instance for a class has been initialized by
+calling the class method initialized?
+
+    ThreadedLogger.initialized? # false
+    logger = ThreadedLogger.instance('test/foo.log', 'daily', 'info')
+    ThreadedLogger.initialized? # true
+
 The catalog of instances can be cleared using the ::clear and ::clear_all
 class methods.  Each takes an optional boolean argument indicating whether
 ::shutdown should be called on any active loggers before clearing them.

data/Rakefile

@@ -1,13 +1,25 @@
 require 'rake/testtask'
 require 'hoe'
 
+Hoe.plugin :gemspec
+Hoe.plugin :bundler
+
 Hoe.spec 'threadedlogger' do
     developer("James FitzGibbon", "james@nadt.net")
     license "MIT"
+    dependency 'hoe', '~> 3.7.1', :dev
+    dependency 'hoe-gemspec', '~> 1.0.0', :dev
+    dependency 'hoe-bundler', '~> 1.2.0', :dev
+    dependency 'simplecov', '~> 0.7.1', :dev
+    dependency 'simplecov-console', '~> 0.1.1', :dev
+    dependency 'minitest', '~> 5.0.8', :dev
+    dependency 'minitest-debugger', '~> 1.0.2', :dev
 end
 
 task :default => [:unit_tests]
 
+task :package => [ 'gem:spec', 'bundler:gemfile' ]
+
 desc "Run basic tests"
 Rake::TestTask.new("unit_tests") { |t|
     t.libs.push 'lib'

data/lib/threadedlogger/core.rb

@@ -27,6 +27,10 @@ class ThreadedLogger
         }
     end
 
+    def self.initialized?
+        ! @@instances[self].nil?
+    end
+
     def self.instance(*args)
         if @@instances[self].nil?
             @@instances[self] = new(*args)

data/lib/threadedlogger/version.rb

@@ -1,5 +1,5 @@
 class ThreadedLogger
 
-    VERSION = '1.2.1'
+    VERSION = '1.3.0'
 
 end

data/test/test_initialized_flag.rb

@@ -0,0 +1,62 @@
+require 'minitest_helper'
+
+class OurLog1 < ThreadedLogger
+end
+
+class OurLog2 < ThreadedLogger
+end
+
+class TestInitializedFlag < ThreadedLoggerTest
+    def test_initialized_base
+        assert_equal false, ThreadedLogger.initialized?, 'instance is not initialized'
+        logger = ThreadedLogger.instance('test/foo.log', 'daily', 'info')
+        assert_instance_of ThreadedLogger, logger, "construct ThreadedLogger"
+        assert_equal true, ThreadedLogger.initialized?, 'instance is initialized'
+    end
+    def test_initialized_subclass
+        assert_equal false, ThreadedLogger.initialized?, 'ThreadedLogger is not initialized'
+        assert_equal false, OurLog1.initialized?, 'OurLog1 is not initialized'
+        assert_equal false, OurLog2.initialized?, 'OurLog2 is not initialized'
+        logger = ThreadedLogger.instance('test/foo.log', 'daily', 'info')
+        assert_instance_of ThreadedLogger, logger, "construct ThreadedLogger"
+        assert_equal true, ThreadedLogger.initialized?, 'ThreadedLogger is initialized'
+        assert_equal false, OurLog1.initialized?, 'OurLog1 is not initialized'
+        assert_equal false, OurLog2.initialized?, 'OurLog2 is not initialized'
+        ourlog1 = OurLog1.instance('test/bar.log', 'daily', 'info')
+        assert_instance_of OurLog1, ourlog1, "construct OurLog1"
+        assert_equal true, ThreadedLogger.initialized?, 'ThreadedLogger is initialized'
+        assert_equal true, OurLog1.initialized?, 'OurLog1 is initialized'
+        assert_equal false, OurLog2.initialized?, 'OurLog2 is not initialized'
+        ourlog2 = OurLog2.instance('test/baz.log', 'daily', 'info')
+        assert_instance_of OurLog2, ourlog2, "construct OurLog2"
+        assert_equal true, ThreadedLogger.initialized?, 'ThreadedLogger is initialized'
+        assert_equal true, OurLog1.initialized?, 'OurLog1 is initialized'
+        assert_equal true, OurLog2.initialized?, 'OurLog2 is initialized'
+    end
+    def test_initialized_clear
+        assert_equal false, ThreadedLogger.initialized?, 'instance is not initialized'
+        logger = ThreadedLogger.instance('test/foo.log', 'daily', 'info')
+        assert_instance_of ThreadedLogger, logger, "construct ThreadedLogger"
+        assert_equal true, ThreadedLogger.initialized?, 'instance is initialized'
+        ThreadedLogger.clear
+        assert_equal false, ThreadedLogger.initialized?, 'instance is not initialized after clear'
+    end
+    def test_initialized_clear_all
+        assert_equal false, ThreadedLogger.initialized?, 'ThreadedLogger is not initialized'
+        assert_equal false, OurLog1.initialized?, 'OurLog1 is not initialized'
+        assert_equal false, OurLog2.initialized?, 'OurLog2 is not initialized'
+        logger = ThreadedLogger.instance('test/foo.log', 'daily', 'info')
+        assert_instance_of ThreadedLogger, logger, "construct ThreadedLogger"
+        ourlog1 = OurLog1.instance('test/bar.log', 'daily', 'info')
+        assert_instance_of OurLog1, ourlog1, "construct OurLog1"
+        ourlog2 = OurLog2.instance('test/baz.log', 'daily', 'info')
+        assert_instance_of OurLog2, ourlog2, "construct OurLog2"
+        assert_equal true, ThreadedLogger.initialized?, 'ThreadedLogger is initialized'
+        assert_equal true, OurLog1.initialized?, 'OurLog1 is initialized'
+        assert_equal true, OurLog2.initialized?, 'OurLog2 is initialized'
+        ThreadedLogger.clear_all
+        assert_equal false, ThreadedLogger.initialized?, 'ThreadedLogger is not initialized after clear_all'
+        assert_equal false, OurLog1.initialized?, 'OurLog1 is not initialized after clear_all'
+        assert_equal false, OurLog2.initialized?, 'OurLog2 is not initialized after clear_all'
+    end
+end

data/threadedlogger.gemspec

@@ -1,14 +1,55 @@
-$:.push File.expand_path("../lib", __FILE__)
-require 'threadedlogger'
+# -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-    s.name          = 'threadedlogger'
-    s.version       = ThreadedLogger::VERSION
-    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)
+  s.name = "threadedlogger"
+  s.version = "1.3.0.20131002091417"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["James FitzGibbon"]
+  s.date = "2013-10-02"
+  s.description = "ThreadedLogger runs a dedicated logging thread around Ruby's Logger library\nto ensure that multiple threads don't step on each other's toes."
+  s.email = ["james@nadt.net"]
+  s.extra_rdoc_files = ["History.txt", "Manifest.txt", "README.txt", "LICENSE.txt"]
+  s.files = ["History.txt", "Manifest.txt", "README.txt", "LICENSE.txt", "Rakefile", "lib/threadedlogger.rb", "lib/threadedlogger/core.rb", "lib/threadedlogger/version.rb", "lib/threadedlogger/logger.rb", "test/minitest_helper.rb", "test/test_logging.rb", "test/test_methods.rb", "test/test_threadedlogger.rb", "test/test_shutdown.rb", "test/test_clear.rb", "test/test_initialized_flag.rb", "threadedlogger.gemspec", "test/test_inheritable.rb", ".gemtest"]
+  s.homepage = "https://github.com/jf647/ThreadedLogger"
+  s.licenses = ["MIT"]
+  s.rdoc_options = ["--main", "README.txt"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = "threadedlogger"
+  s.rubygems_version = "1.8.23"
+  s.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."
+  s.test_files = ["test/test_initialized_flag.rb", "test/test_methods.rb", "test/test_clear.rb", "test/test_inheritable.rb", "test/test_logging.rb", "test/test_shutdown.rb", "test/test_threadedlogger.rb"]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rdoc>, ["~> 4.0"])
+      s.add_development_dependency(%q<hoe>, ["~> 3.7.1"])
+      s.add_development_dependency(%q<hoe-gemspec>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<hoe-bundler>, ["~> 1.2.0"])
+      s.add_development_dependency(%q<simplecov>, ["~> 0.7.1"])
+      s.add_development_dependency(%q<simplecov-console>, ["~> 0.1.1"])
+      s.add_development_dependency(%q<minitest>, ["~> 5.0.8"])
+      s.add_development_dependency(%q<minitest-debugger>, ["~> 1.0.2"])
+    else
+      s.add_dependency(%q<rdoc>, ["~> 4.0"])
+      s.add_dependency(%q<hoe>, ["~> 3.7.1"])
+      s.add_dependency(%q<hoe-gemspec>, ["~> 1.0.0"])
+      s.add_dependency(%q<hoe-bundler>, ["~> 1.2.0"])
+      s.add_dependency(%q<simplecov>, ["~> 0.7.1"])
+      s.add_dependency(%q<simplecov-console>, ["~> 0.1.1"])
+      s.add_dependency(%q<minitest>, ["~> 5.0.8"])
+      s.add_dependency(%q<minitest-debugger>, ["~> 1.0.2"])
+    end
+  else
+    s.add_dependency(%q<rdoc>, ["~> 4.0"])
+    s.add_dependency(%q<hoe>, ["~> 3.7.1"])
+    s.add_dependency(%q<hoe-gemspec>, ["~> 1.0.0"])
+    s.add_dependency(%q<hoe-bundler>, ["~> 1.2.0"])
+    s.add_dependency(%q<simplecov>, ["~> 0.7.1"])
+    s.add_dependency(%q<simplecov-console>, ["~> 0.1.1"])
+    s.add_dependency(%q<minitest>, ["~> 5.0.8"])
+    s.add_dependency(%q<minitest-debugger>, ["~> 1.0.2"])
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: threadedlogger
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-26 00:00:00.000000000 Z
+date: 2013-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -34,7 +34,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: 3.7.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -42,7 +42,103 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: 3.7.1
+- !ruby/object:Gem::Dependency
+  name: hoe-gemspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: hoe-bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+- !ruby/object:Gem::Dependency
+  name: simplecov-console
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 5.0.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 5.0.8
+- !ruby/object:Gem::Dependency
+  name: minitest-debugger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.2
 description: ! 'ThreadedLogger runs a dedicated logging thread around Ruby''s Logger
   library
 
@@ -72,6 +168,7 @@ files:
 - test/test_threadedlogger.rb
 - test/test_shutdown.rb
 - test/test_clear.rb
+- test/test_initialized_flag.rb
 - threadedlogger.gemspec
 - test/test_inheritable.rb
 - .gemtest
@@ -90,12 +187,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -1214133197153868544
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -1214133197153868544
 requirements: []
 rubyforge_project: threadedlogger
 rubygems_version: 1.8.23
@@ -104,9 +207,10 @@ 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_initialized_flag.rb
+- test/test_methods.rb
+- test/test_clear.rb
+- test/test_inheritable.rb
 - test/test_logging.rb
 - test/test_shutdown.rb
-- test/test_inheritable.rb
-- test/test_clear.rb
-- test/test_methods.rb
 - test/test_threadedlogger.rb