transitional_logger 1.0.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Elon Flegenheimer
+
+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,50 @@
+# TransitionalLogger
+
+A singleton logger accessible from ALL objects. It is intended to be used to:
+
+* send logger data to stdout OR
+* log to a file while consuming stdout & stderr data as log input OR
+* destroy stdout, stderr, & log data OR
+* do one of the above until transitioned to another of the above
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'transitional_logger'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install transitional_logger
+
+## Usage
+
+The logger can be altered just like a normal Logger:
+
+	logger.level = Logger::WARN
+
+Example usage:
+
+	TransitionalLogger.stdout
+	logger.info 'this message goes through the logger to stdout'
+	puts 'this works like usual'
+
+	TransitionalLogger.file('/tmp/whatever.log')
+	Object.new.logger.info 'this message goes through the logger to the file above'
+	puts 'this message also goes through the logger above'
+
+	TransitionalLogger.blackhole
+	Object.new.logger.error 'this message disappears'
+	puts 'this message disappears too!'
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.name = "spec"
+  t.libs.push ["lib", "test"]
+  t.test_files = FileList['test/**/*_spec.rb']
+  t.verbose = true
+  t.warning = false
+end

data/lib/transitional_logger.rb

@@ -0,0 +1,106 @@
+require 'logger'
+
+# Author:: Elon Flegenheimer
+# Copyright:: Copyright (c) 2013 Elon Flegenheimer
+# License:: The MIT License (MIT)
+# 
+# A singleton logger accessible from ALL objects. It is intended to be used to:
+# * send logger data to stdout OR
+# * log to a file while consuming stdout & stderr data as log input OR
+# * destroy stdout, stderr, & log data OR
+# * do one of the above until transitioned to another of the above
+#
+# The logger can be altered just like a normal Logger:
+#   logger.level = Logger::WARN
+#
+# Example usage:
+#
+#   TransitionalLogger.stdout
+#   logger.info 'this message goes through the logger to stdout'
+#   puts 'this works like usual'
+#
+#   TransitionalLogger.file('/tmp/whatever.log')
+#   Object.new.logger.info 'this message goes through the logger to the file above'
+#   puts 'this message also goes through the logger above'
+#
+#   TransitionalLogger.blackhole
+#   Object.new.logger.error 'this message disappears'
+#   puts 'this message disappears too!'
+#
+module TransitionalLogger
+
+  VERSION = '1.0.0'
+
+  class << self
+
+    # Creates a logger that is accessible from all objects. The logger points
+    # to stdout. Stdout is otherwise unaffected.
+    def stdout
+      reset if @streams
+      @master_logger = infect_object(Logger.new($stdout))
+    end
+
+    # Creates the specified logger that is accessible from all objects. stdout
+    # and stderr are redirected to this logger.
+    #
+    # Parameters match Logger#new.
+    def file(*args)
+      raise ArgumentError, 'Logger#new params must be specified for #file' if args.size == 0
+      reset if @streams
+      @master_logger = infect_object(Logger.new(*args))
+
+      @streams = [$stdout, $stderr, $stdin]
+      $stdout = CommandeeredOut.new(@master_logger)
+      $stderr = CommandeeredErr.new(@master_logger)
+      @master_logger
+    end
+
+    # Creates a logger that consumes stdout, stderr, and all logger messages.
+    def blackhole
+      file('/dev/null')
+    end
+
+    # Reset the changes that this object has introduced
+    def reset
+      @master_logger = nil
+      Object.send :remove_method, :logger rescue nil
+      if @streams
+        $stdout, $stderr = @streams[0..1]
+        @streams = nil
+      end
+    end
+
+    # Logger accessor - otherwise accessible from any object
+    def logger
+      @master_logger
+    end
+
+    private
+
+    # Define the logger method to return this in all objects
+    def infect_object(logger)
+      Object.send :define_method, :logger, ->{logger}
+      logger
+    end
+
+  end
+
+end
+
+class CommandeeredIO < IO
+  def initialize(logger)
+    @logger = logger
+  end
+end
+
+class CommandeeredOut < CommandeeredIO
+  def write(s)
+    @logger.info(s)
+  end
+end
+
+class CommandeeredErr < CommandeeredIO
+  def write(s)
+    @logger.error(s)
+  end
+end

data/test/transitional_logger_spec.rb

@@ -0,0 +1,49 @@
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'mocha/setup'
+require_relative '../lib/transitional_logger'
+
+describe TransitionalLogger do
+
+  before { TransitionalLogger.reset }
+
+  it '#reset clears #logger from Object' do
+    TransitionalLogger.stdout
+    TransitionalLogger.reset
+    Object.wont_respond_to :logger
+  end
+
+  it 'responds to info' do
+    TransitionalLogger.stdout
+    TransitionalLogger.logger.must_respond_to :info
+  end
+
+  it 'responds to error' do
+    TransitionalLogger.stdout
+    TransitionalLogger.logger.must_respond_to :error
+  end
+
+  it '#infect_object creates Object#logger, which returns param' do
+    TransitionalLogger.send :infect_object, 2
+    Object.new.logger.must_equal 2
+  end
+
+  it 'puts should not normally delegate to logger' do
+    TransitionalLogger.expects(:infect_object).returns(Logger.new('/dev/null'))
+    TransitionalLogger.stdout
+    TransitionalLogger.logger.expects(:info).never
+    puts 'rem: test case sequence varies'
+  end
+
+  it '#file should result in puts delegating to logger' do
+    TransitionalLogger.stdout
+    TransitionalLogger.file('/dev/null')
+    TransitionalLogger.logger.expects(:info).at_least_once
+    puts 'hi'
+  end
+
+  it '#file requires args' do
+    lambda {TransitionalLogger.file}.must_raise ArgumentError
+  end
+
+end

data/transitional_logger.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'transitional_logger'
+
+Gem::Specification.new do |spec|
+  spec.name          = "transitional_logger"
+  spec.version       = TransitionalLogger::VERSION
+  spec.authors       = ["Elon Flegenheimer"]
+  spec.email         = ["elonf@hotmail.com"]
+  spec.description   = "Singleton logger available in all Objects that can transition destinations."
+  spec.summary       = "Singleton logger available in all Objects that can transition destinations."
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "mocha"
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: transitional_logger
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Elon Flegenheimer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Singleton logger available in all Objects that can transition destinations.
+email:
+- elonf@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/transitional_logger.rb
+- test/transitional_logger_spec.rb
+- transitional_logger.gemspec
+homepage: ''
+licenses:
+- MIT
+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.8.25
+signing_key: 
+specification_version: 3
+summary: Singleton logger available in all Objects that can transition destinations.
+test_files:
+- test/transitional_logger_spec.rb