VoidLogger

VoidLogger is a Ruby logger that logs into nothing, void or still nowhere.

Purpose

A VoidLogger instance is useful when you want to log things in your class or module but do not necessarily want those traces to go somewhere. Replace the current logger with a VoidLogger instance and nobody will hear your code scream.

The VoidLogger::LoggerMixin module comes in support of this approach. Once included in a module or class, it defines a logger attribute initialized to a VoidLogger instance. Later on, you can use a different logger simply by assigning this logger attribute with your own ::Logger variant.

Installation

Add this line to your application's Gemfile:

gem 'void_logger'

And then execute:

$ bundle

Or install it yourself as:

$ gem install void_logger

Usage

Start by requiring the gem:

require 'void_logger'

Then you can use the logger:

logger = VoidLogger.new
logger.info "TEST" # nothing will be logged

You can also include the mixin in your module/class:

require 'void_logger'

class Test
  include VoidLogger::LoggerMixin
  
  def initialize(logger=nil)
    self.logger = logger
  end
end

This mixin brings two members to your module/class:

• logger: It will look up all the ancestors to find a logger method and use it if it finds one or return a VoidLogger.new
• fallback_logger: The logger you can use in the class you mix VoidLogger::LoggerMixin into. Return the fallback logger (as defined above) unless you explicitly set a logger with the logger= method.

You can reset the fallback logger by calling:

t = Test.new
t.reset_fallback_logger

Resetting the fallback logger can be useful when a new logger was defined on one of the ancestors.

Contributing

1. Fork it ( https://github.com/[my-github-username]/void_logger/fork )
2. Create your feature branch (git checkout -b my-new-feature)
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