null_logger 0.0.1

data/README.md

@@ -0,0 +1,49 @@
+# Null Logger
+
+It's nice to be able to inject a Logger into libraries to see what's
+going on, but handling all that logging and providing sane defaults can
+be rather difficult.
+
+If we use a Null Logger - a logger which does nothing but which supports
+the Logger interface - we can pass that responsibility off to those who
+care about logging.
+
+
+## Usage
+
+In your `Gemfile`:
+
+    gem 'null_logger'
+
+In your code you can use the NullLogger instance just like a real
+Logger:
+
+    require 'null_logger'
+    logger = NullLogger.instance
+    logger.debug "Foo"
+    logger.info  "Bar"
+    logger.warn  "Baz"
+    logger.error "Qux"
+    logger.fatal "Quux"
+
+Of course, you'll probably want to allow people the option to pass in a
+logger, otherwise there's not much point, so your classes end up looking
+something like this:
+
+    class Groml
+      attr_accessor :logger
+      private :logger=, :logger
+
+      def initialize logger = nil
+        self.logger = logger || NullLogger.instance
+      end
+
+      def execute
+        logger.debug "Starting execute run..."
+      end
+    end
+
+
+## Authors
+
+Craig R Webster <http://barkingiguana.com/>

data/lib/null_logger.rb

@@ -0,0 +1,12 @@
+require 'null_logger/version'
+require 'null_logger/logger'
+
+module NullLogger
+  def self.instance
+    @instance ||= NullLogger::Logger.new
+  end
+
+  def self.reset!
+    @instance = nil
+  end
+end

data/lib/null_logger/logger.rb

@@ -0,0 +1,13 @@
+module NullLogger
+  class Logger
+    # To get the Logger API you can run this:
+    #   (Logger.instance_methods.sort - Logger.methods).sort
+    [ :<<, :add, :close, :datetime_format,
+      :datetime_format=, :debug, :debug?, :error, :error?, :fatal,
+      :fatal?, :formatter, :formatter=, :info, :info?, :level, :level=,
+      :log, :progname, :progname=, :sev_threshold, :sev_threshold=,
+      :unknown, :warn, :warn? ].each do |method_name|
+      define_method method_name do |*args| end
+    end
+  end
+end

data/lib/null_logger/version.rb

@@ -0,0 +1,3 @@
+module NullLogger
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification 
+name: null_logger
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Craig R Webster
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-10-24 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: Logging is really useful but handling log files and providing sane defaults is hard. Let those that care about the logging configure their own Logger and give it to us, we'll just pass sane messages to that implementation.
+email: 
+- craig@barkingiguana.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/null_logger/logger.rb
+- lib/null_logger/version.rb
+- lib/null_logger.rb
+- README.md
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: An implementation of the Logger API that does nothing.
+test_files: []
+