teelogger 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 269cc8e131a866bd9a63206c5e20f33c02c3c3a9
+  data.tar.gz: 4aa61d289eebf2f4696ca5629be0a147c318f788
+SHA512:
+  metadata.gz: 5182be9dadb8218c3cefd5507ade52d58a431507ef8f179bc743dff1486fc7f71d62284610f09505315e63f1693a32d7152ed03ce3275558baf63ea47906b8ac
+  data.tar.gz: 9401f09297f125f6aecc8bfa07eeb657e22a269af817a6afa32fe2bee3e6dab7a801f0f3cfde02ab00b9dcacca0bd05ad43b9c50dec284f2ce5426fd0fbc4eed

data/.gitignore

@@ -0,0 +1,24 @@
+*.gem
+*.rbc
+.*.sw*
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.ruby-version

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,30 @@
+Copyright spriteCloud B.V. (http://www.spritecloud.com/) and other teelogger
+contributors. All rights not covered below are reserved.
+
+MIT +no-false-attribs 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.
+
+Distributions of all or part of the Software intended to be used by the
+recipients as they would use the unmodified Software, containing modifications
+that substantially alter, remove, or disable functionality of the Software,
+outside of the documented configuration mechanisms provided by the Software,
+shall be modified such that the Original Author's bug reporting email addresses
+and urls are either replaced with the contact information of the parties
+responsible for the changes, or removed entirely.
+
+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,29 @@
+# Teelogger
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'teelogger'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install teelogger
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/teelogger/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,2 @@
+require "bundler/gem_tasks"
+

data/features/logger.feature

@@ -0,0 +1,42 @@
+@logger
+Feature: Logger
+  As a user of the teelogger gem
+  When I use the TeeLogger class
+  I expect it to work as documented.
+
+  @logger_01
+  Scenario Outline: Default parameters
+    Given I create a TeeLogger with default parameters
+    And I set the log level to "<level>"
+    And I write a log message at log level "<level>"
+    Then I expect the log level "<level>" to have taken hold
+    And I expect the log message to appear on the screen
+
+    Examples:
+      | level |
+      | DEBUG |
+      | INFO  |
+      | WARN  |
+      | ERROR |
+      | FATAL |
+
+  @logger_02
+  Scenario Outline: I/O object
+    Given I create a TeeLogger with an IO object
+    And I set the log level to "<level>"
+    And I write a log message at log level "<level>"
+    Then I expect the log level "<level>" to have taken hold
+    And I expect the log message to appear in the IO object
+
+    Examples:
+      | level |
+      | DEBUG |
+      | INFO  |
+      | WARN  |
+      | ERROR |
+      | FATAL |
+
+  @logger_03
+  Scenario: multiple loggers
+    Given I create a TeeLogger with multiple loggers
+    Then I expect the class to let me access all loggers like a hash

data/features/step_definitions/steps.rb

@@ -0,0 +1,55 @@
+require 'test/unit/assertions'
+
+message = "test message"
+io = nil
+logger = nil
+
+Given(/^I create a TeeLogger with default parameters$/) do
+  logger = TeeLogger::TeeLogger.new
+end
+
+Given(/^I set the log level to "(.*?)"$/) do |level|
+  logger.level = level
+end
+
+Given(/^I write a log message at log level "(.*?)"$/) do |level|
+  meth = level.downcase.to_sym
+  res = logger.send(meth, message)
+end
+
+Then(/^I expect the log message to appear on the screen$/) do
+  puts "Can't test this; please check manually"
+end
+
+Then(/^I expect the log level "(.*?)" to have taken hold$/) do |level|
+  meth = "#{level.downcase}?".to_sym
+  res = logger.send(meth)
+
+  assert res, "Log level not active!"
+end
+
+
+Given(/^I create a TeeLogger with an IO object$/) do
+  io = StringIO.new
+  logger = TeeLogger::TeeLogger.new io
+end
+
+Then(/^I expect the log message to appear in the IO object$/) do
+  assert io.string.include?(message), "Test message '#{message}' not included in output."
+end
+
+Given(/^I create a TeeLogger with multiple loggers$/) do
+  args = []
+  3.times do
+    args << StringIO.new
+  end
+  logger = TeeLogger::TeeLogger.new *args
+end
+
+Then(/^I expect the class to let me access all loggers like a hash$/) do
+  assert (3 == logger.length), "Expected 3 loggers, got #{logger.length}"
+  logger.each do |key, logger|
+    assert logger.is_a?(Logger), "Found a non-Logger object."
+  end
+end
+

data/features/support/env.rb

@@ -0,0 +1 @@
+require "teelogger"

data/lib/teelogger.rb

@@ -0,0 +1,199 @@
+#
+# TeeLogger
+# https://github.com/spriteCloud/teelogger
+#
+# Copyright (c) 2014 spriteCloud B.V. and other TeeLogger contributors.
+# All rights reserved.
+#
+require "teelogger/version"
+
+require "logger"
+
+module TeeLogger
+  ##
+  # Logger that writes to multiple outputs. Behaves just like Ruby's Logger,
+  # and like a hash of String => Logger.
+  #
+  # A typical use might be to log to STDOUT, but also to a file:
+  #   log = TeeLogger.new(STDOUT, "filename.log")
+  #   log.level = Logger::WARN # applies to all outputs
+  #   log.level = "INFO"       # convenience shortcut
+  #
+  # By using the instance as a hash, you can also set individual log levels
+  # for individual loggers:
+  #   log = TeeLogger.new(STDOUT, "filename.log")
+  #   log.each do |name, logger|
+  #     if name.include?("filename.log")
+  #       logger.level = "WARN"
+  #     else
+  #       logger.level = "DEBUG"
+  #     end
+  #   end
+  class TeeLogger
+    @default_level = Logger::Severity::INFO
+    @loggers
+
+
+    ##
+    # Add a logger to the current loggers.
+    def add_logger(arg)
+      key = nil
+      logger = nil
+      if arg.is_a? String
+        # We have a filename
+        key = File.basename(arg)
+
+        # Try to create the logger.
+        file = File.new(arg, File::WRONLY | File::APPEND | File::CREAT)
+        logger = Logger.new(file)
+
+        # Initialize logger
+        logger.unknown "Logging to '#{arg}' initialized with level #{string_level(@default_level)}."
+        logger.level = convert_level(@default_level)
+      else
+        # We have some other object - let's hope it's an IO object
+        key = arg.to_s
+
+        # Try to create the logger.
+        logger = Logger.new(arg)
+
+        # Initialize logger
+        logger.unknown "Logging to #{key} initialized with level #{string_level(@default_level)}."
+        logger.level = convert_level(@default_level)
+      end
+
+      if not key.nil? and not logger.nil?
+        @loggers[key] = logger
+      end
+    end
+
+
+    ##
+    # Start with any amount of IO objects or filenames; defaults to STDOUT
+    def initialize(*args)
+      # Handle default
+      if args.empty?
+        args = [STDOUT]
+      end
+
+      # Initialization
+      @loggers = {}
+
+      # Create logs for all arguments
+      args.each do |arg|
+        add_logger(arg)
+      end
+    end
+
+    ##
+    # Convert a log level to its string name
+    def string_level(level)
+      if level.is_a? String
+        return level
+      end
+
+      Logger::Severity.constants.each do |const|
+        if level == Logger.const_get(const)
+          return const
+        end
+      end
+
+      return nil
+    end
+
+    ##
+    # Convert a string log level to its constant value
+    def convert_level(val)
+      if val.is_a? String
+        begin
+          val = Logger.const_get(val)
+        rescue NameError
+          val = Logger::Severity::WARN
+        end
+      end
+
+      return val
+    end
+
+
+    ##
+    # Set log level; override this to also accept strings
+    def level=(val)
+      # Convert strings to the constant value
+      val = convert_level(val)
+
+      # Update the default log level
+      @default_level = val
+
+      # Set all loggers' log levels
+      @loggers.each do |key, logger|
+        logger.level = val
+      end
+    end
+
+
+    ##
+    # Log an exception
+    def exception(message, ex)
+      error("#{message} got #{ex.message}:\n#{ex.backtrace.join("\n")}")
+    end
+
+
+    ##
+    # Every function this class doesn't have should be mapped to the original
+    # logger
+    def respond_to?(meth)
+      if @loggers.nil? or @loggers.empty?
+        raise "No loggers created, can't do anything."
+      end
+
+      meth_name = meth.to_s
+
+      # All loggers are the same, so we need to check only one of them.
+      @loggers.each do |key, logger|
+        if logger.respond_to? meth_name
+          return true
+        end
+        break
+      end
+
+      # If this didn't work, we're also emulating a hash
+      return @loggers.respond_to? meth_name
+    end
+
+    def method_missing(meth, *args, &block)
+      meth_name = meth.to_s
+
+      if @loggers.nil? or @loggers.empty?
+        raise "No loggers created, can't do anything."
+      end
+
+      # Compose message
+      message = ""
+      args.each do |arg|
+        message += arg.inspect
+      end
+
+      # Try to write the message to all loggers.
+      ret = []
+      @loggers.each do |key, logger|
+        if logger.respond_to? meth_name
+          if args.length > 0
+            ret << logger.send(meth_name, "[#{key}] #{message}", &block)
+          else
+            ret << logger.send(meth_name, *args, &block)
+          end
+        end
+      end
+
+      # Some double checking on the return value(s).
+      if not ret.empty?
+        return ret
+      end
+
+      # If the method wasn't from the loggers, we'll try to send it to the
+      # hash.
+      return @loggers.send(meth_name, *args, &block)
+    end
+  end
+end

data/lib/teelogger/version.rb

@@ -0,0 +1,10 @@
+#
+# TeeLogger
+# https://github.com/spriteCloud/teelogger
+#
+# Copyright (c) 2014 spriteCloud B.V. and other TeeLogger contributors.
+# All rights reserved.
+#
+module TeeLogger
+  VERSION = "0.1.0"
+end

data/teelogger.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'teelogger/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "teelogger"
+  spec.version       = TeeLogger::VERSION
+  spec.authors       = ["Jens Finkhaeuser"]
+  spec.email         = ["foss@spritecloud.com"]
+  spec.summary       = %q{Mini wrapper around Ruby Logger for logging to multiple destinations.}
+  spec.description   = %q{Mini wrapper around Ruby Logger for logging to multiple destinations.}
+  spec.homepage      = "https://github.com/spriteCloud/teelogger"
+  spec.license       = "MITNFA"
+
+  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.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "cucumber"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: teelogger
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jens Finkhaeuser
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Mini wrapper around Ruby Logger for logging to multiple destinations.
+email:
+- foss@spritecloud.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- features/logger.feature
+- features/step_definitions/steps.rb
+- features/support/env.rb
+- lib/teelogger.rb
+- lib/teelogger/version.rb
+- teelogger.gemspec
+homepage: https://github.com/spriteCloud/teelogger
+licenses:
+- MITNFA
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Mini wrapper around Ruby Logger for logging to multiple destinations.
+test_files:
+- features/logger.feature
+- features/step_definitions/steps.rb
+- features/support/env.rb