void_logger 0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NjE1N2IxN2IxM2NjNDM0ZWFlOThiZTYwMGNhZjk0MTE2OGVjMzllMQ==
+  data.tar.gz: !binary |-
+    MTYxYWMzODRiZWJhYjY1YzNkOWRjMTc0ZGI2ODlhM2JhNjM5MTUwNQ==
+SHA512:
+  metadata.gz: !binary |-
+    MGQxNDBhMDljNGE3YTg0ZTAxOWRlMTFiOTRjYzU3M2VhNTUwNDM2MWEyMzY1
+    MTY5MWNjNTMyZTJhZTEyODhiOTIzMmE1NDJjOGY5NzBmNjdhNTkzYzQxMzQx
+    NDAzNGQ3YmRlMTc2ZWIyODM1MTU2YWJkOGZjMGI5ZWVlZTdkOTk=
+  data.tar.gz: !binary |-
+    NjE0OTRiNzQxMWY4OWJlZDBiZDNlNGM4ZjhiNTAxODYwNmMyMjEzNzU5NDEz
+    YzQzOGY1MGZlYjk3NDVkOTM0NDNjZGU5ZWUwZTU5NTVmOWY3ODliYTA4YWU3
+    NWQ1YTUyNzUxYTA4NGYyY2Y3MmIwZTZlODE2MWExMTZjY2Y2MjU=

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rvmrc

@@ -0,0 +1 @@
+rvm --create use 1.9.3@void_logger

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in void_logger.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Denis Jean
+
+MIT License
+
+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/README.md

@@ -0,0 +1,75 @@
+# 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:
+
+```ruby
+gem 'void_logger'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install void_logger
+
+## Usage
+
+Start by requiring the gem:
+
+```ruby
+require 'void_logger'
+```
+
+Then you can use the logger:
+
+```ruby
+logger = VoidLogger.new
+logger.info "TEST" # nothing will be logged
+```
+
+You can also include the mixin in your module/class:
+
+```ruby
+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:
+
+```ruby
+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

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+    t.libs << "test"
+end
+
+task :default => :test

data/lib/void_logger.rb

@@ -0,0 +1,28 @@
+require 'logger'
+
+class VoidLogger < ::Logger
+  VERSION = "0.1"
+
+  def initialize(logdev=nil)
+    super(logdev)
+  end
+
+  def add(severity, message = nil, progname = nil, &block)
+    return true
+  end
+
+  module LoggerMixin
+
+    attr_writer :logger
+    attr_reader :fallback_logger
+
+    def logger
+      @fallback_logger ||= (super rescue nil) || VoidLogger.new
+      @logger || @fallback_logger
+    end
+
+    def reset_fallback_logger
+      @fallback_logger = nil
+    end
+  end
+end

data/test/minitest_helper.rb

@@ -0,0 +1,5 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'void_logger'
+
+gem "minitest"
+require 'minitest/autorun'

data/test/test_void_logger.rb

@@ -0,0 +1,64 @@
+require 'minitest_helper'
+require 'logger'
+
+LOG_FILE_NAME = 'test/logfile.log'
+LOGGER = Logger.new LOG_FILE_NAME
+
+class TestVoidLogger < Minitest::Test
+  def setup
+    @filepath = LOG_FILE_NAME
+  end
+
+  def teardown
+    FileUtils.rm @filepath, force: true
+  end
+
+  def test_nothing_logged
+    logger = VoidLogger.new(@filepath)
+    logger.info "Should not be logged"
+
+    string = File.read(@filepath)
+    assert !string.include?("Should not be logged")
+  end
+
+  def test_logger_mixin
+    b = B.new
+
+    assert b.logger.is_a?(VoidLogger)
+
+    b = B.new(true)
+    assert_equal LOGGER, b.logger
+
+    b.remove_logger
+    b.reset_fallback_logger
+    assert b.logger.is_a?(VoidLogger)
+
+    b.logger = LOGGER
+    assert_equal LOGGER, b.logger
+
+    b.logger = nil
+    assert b.logger.is_a?(VoidLogger)
+  end
+end
+
+class A
+  def initialize(log=false)
+    if log
+      self.class.send(:define_method, :logger) do
+        LOGGER
+      end
+    end
+  end
+
+  def remove_logger
+    self.class.send(:remove_method, :logger)
+  end
+end
+
+class B < A
+  include VoidLogger::LoggerMixin
+
+  def initialize(log=false)
+    super(log)
+  end
+end

data/void_logger.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'void_logger'
+
+Gem::Specification.new do |spec|
+  spec.name          = "void_logger"
+  spec.version       = VoidLogger::VERSION
+  spec.authors       = ["Denis Jean", "Laurent Farcy"]
+  spec.email         = ["denis.jean@ecairn.com", "laurent.farcy@ecairn.com"]
+  spec.summary       = %q{VoidLogger is a Ruby logger that logs into the void.}
+  
+  spec.description   = <<-EOF
+    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.
+  EOF
+  
+  spec.homepage      = "https://github.com/ecairn/void_logger"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.5"
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: void_logger
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Denis Jean
+- Laurent Farcy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.5'
+description: ! "    A VoidLogger instance is useful when you want to log things in\n
+  \   your class or module but do not necessarily want those traces to go somewhere.\n
+  \   Replace the current logger with a VoidLogger instance and nobody will hear your
+  code scream.\n"
+email:
+- denis.jean@ecairn.com
+- laurent.farcy@ecairn.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/void_logger.rb
+- test/minitest_helper.rb
+- test/test_void_logger.rb
+- void_logger.gemspec
+homepage: https://github.com/ecairn/void_logger
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.3
+signing_key: 
+specification_version: 4
+summary: VoidLogger is a Ruby logger that logs into the void.
+test_files:
+- test/minitest_helper.rb
+- test/test_void_logger.rb