mixlib-log 1.2.0 → 1.3.0

data/lib/mixlib/log/version.rb

@@ -0,0 +1,5 @@
+module Mixlib
+  module Log
+    VERSION = "1.3.0"
+  end
+end

data/lib/mixlib/log.rb

@@ -7,9 +7,9 @@
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
-# 
+#
 #     http://www.apache.org/licenses/LICENSE-2.0
-# 
+#
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS,
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -17,14 +17,28 @@
 # limitations under the License.
 
 require 'logger'
+require 'mixlib/log/version'
 require 'mixlib/log/formatter'
 
 module Mixlib
   module Log
-  
-    @logger = nil
-    @@levels = { :debug=>Logger::DEBUG, :info=>Logger::INFO, :warn=>Logger::WARN, :error=>Logger::ERROR, :fatal=>Logger::FATAL}
-    
+
+    @logger, @loggers = nil
+
+    LEVELS = { :debug=>Logger::DEBUG, :info=>Logger::INFO, :warn=>Logger::WARN, :error=>Logger::ERROR, :fatal=>Logger::FATAL}.freeze
+    LEVEL_NAMES = LEVELS.invert.freeze
+
+
+    def reset!
+      @logger, @loggers = nil, nil
+    end
+
+    # An Array of log devices that will be logged to. Defaults to just the default
+    # @logger log device, but you can push to this array to add more devices.
+    def loggers
+      @loggers ||= [logger]
+    end
+
     ##
     # init always returns a configured logger
     # and creates a new one if it doesn't yet exist
@@ -33,10 +47,27 @@ module Mixlib
       @logger || init
     end
 
-    def logger=(value)
-      @logger=value
+    # Sets the log device to +new_log_device+. Any additional loggers
+    # that had been added to the +loggers+ array will be cleared.
+    def logger=(new_log_device)
+      reset!
+      @logger=new_log_device
+    end
+
+    def use_log_devices(other)
+      if other.respond_to?(:loggers) && other.respond_to?(:logger)
+        @loggers = other.loggers
+        @logger = other.logger
+      elsif other.kind_of?(Array)
+        @loggers = other
+        @logger = other.first
+      else
+        msg = "#use_log_devices takes a Mixlib::Log object or array of log devices. " <<
+              "You gave: #{other.inspect}"
+        raise ArgumentError, msg
+      end
     end
-      
+
     # Use Mixlib::Log.init when you want to set up the logger manually.  Arguments to this method
     # get passed directly to Logger.new, so check out the documentation for the standard Logger class
     # to understand what to do here.
@@ -45,12 +76,13 @@ module Mixlib
     #
     # It also configures the Logger instance it creates to use the custom Mixlib::Log::Formatter class.
     def init(*opts)
-      @logger = (opts.empty? ? Logger.new(STDOUT) : Logger.new(*opts))
-      @logger.formatter = Mixlib::Log::Formatter.new()
+      reset!
+      @logger = logger_for(*opts)
+      @logger.formatter = Mixlib::Log::Formatter.new() if @logger.respond_to?(:formatter=)
       @logger.level = Logger::WARN
       @logger
     end
-    
+
     # Sets the level for the Logger object by symbol.  Valid arguments are:
     #
     #  :debug
@@ -60,26 +92,70 @@ module Mixlib
     #  :fatal
     #
     # Throws an ArgumentError if you feed it a bogus log level.
-    def level=(l)
-      lv = @@levels[l]
-      raise ArgumentError, "Log level must be one of :debug, :info, :warn, :error, or :fatal" if lv.nil?
-      logger.level = lv
+    def level=(new_level)
+      level_int = LEVEL_NAMES.key?(new_level) ? new_level : LEVELS[new_level]
+      raise ArgumentError, "Log level must be one of :debug, :info, :warn, :error, or :fatal" if level_int.nil?
+      loggers.each {|l| l.level = level_int }
     end
 
-    def level(lv=nil)
-      if lv.nil?
-        @@levels.find() {|l| logger.level==l[1]}[0]
+    def level(new_level=nil)
+      if new_level.nil?
+        LEVEL_NAMES[logger.level]
       else
-        self.level=(lv)
+        self.level=(new_level)
       end
     end
-    
+
+    # Define the standard logger methods on this class programmatically.
+    # No need to incur method_missing overhead on every log call.
+    [:debug, :info, :warn, :error, :fatal].each do |method_name|
+      class_eval(<<-METHOD_DEFN, __FILE__, __LINE__)
+        def #{method_name}(msg=nil, &block)
+          loggers.each {|l| l.#{method_name}(msg, &block) }
+        end
+      METHOD_DEFN
+    end
+
+    # Define the methods to interrogate the logger for the current log level.
+    # Note that we *only* query the default logger (@logger) and not any other
+    # loggers that may have been added, even though it is possible to configure
+    # two (or more) loggers at different log levels.
+    [:debug?, :info?, :warn?, :error?, :fatal?].each do |method_name|
+      class_eval(<<-METHOD_DEFN, __FILE__, __LINE__)
+        def #{method_name}
+          logger.#{method_name}
+        end
+      METHOD_DEFN
+    end
+
+    def <<(msg)
+      loggers.each {|l| l << msg }
+    end
+
+    def add(severity, message = nil, progname = nil, &block)
+      loggers.each {|l| l.add(severity, message = nil, progname = nil, &block) }
+    end
+
+    alias :log :add
+
     # Passes any other method calls on directly to the underlying Logger object created with init. If
-    # this method gets hit before a call to Mixlib::Logger.init has been made, it will call 
+    # this method gets hit before a call to Mixlib::Logger.init has been made, it will call
     # Mixlib::Logger.init() with no arguments.
     def method_missing(method_symbol, *args, &block)
-      logger.send(method_symbol, *args, &block)
+      loggers.each {|l| l.send(method_symbol, *args, &block) }
+    end
+
+    private
+
+    def logger_for(*opts)
+      if opts.empty?
+        Logger.new(STDOUT)
+      elsif LEVELS.keys.inject(true) {|quacks, level| quacks && opts.first.respond_to?(level)}
+        opts.first
+      else
+        Logger.new(*opts)
+      end
     end
-    
+
   end
 end

metadata

@@ -1,12 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: mixlib-log
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 1
-  - 2
-  - 0
-  version: 1.2.0
+  prerelease: 
+  version: 1.3.0
 platform: ruby
 authors: 
 - Opscode, Inc.
@@ -14,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-19 00:00:00 -07:00
+date: 2011-03-23 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -25,32 +21,23 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- LICENSE
 - README.rdoc
-files: 
-- .gitignore
 - LICENSE
 - NOTICE
-- README.rdoc
-- Rakefile
-- VERSION.yml
-- features/log.feature
-- features/steps/log.rb
-- features/support/env.rb
-- features/support/logit.rb
-- lib/mixlib/log.rb
+files: 
 - lib/mixlib/log/formatter.rb
-- spec/mixlib/log/formatter_spec.rb
-- spec/mixlib/log_spec.rb
-- spec/spec.opts
-- spec/spec_helper.rb
+- lib/mixlib/log/version.rb
+- lib/mixlib/log.rb
+- README.rdoc
+- LICENSE
+- NOTICE
 has_rdoc: true
 homepage: http://www.opscode.com
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -58,25 +45,19 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: A gem that provides a simple mixin for log functionality
-test_files: 
-- spec/mixlib/log/formatter_spec.rb
-- spec/mixlib/log_spec.rb
-- spec/spec_helper.rb
+test_files: []
+

data/.gitignore

@@ -1,5 +0,0 @@
-*.sw?
-.DS_Store
-coverage
-rdoc
-pkg

data/Rakefile

@@ -1,69 +0,0 @@
-require 'rubygems'
-require 'rake'
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "mixlib-log"
-    gem.summary = "A gem that provides a simple mixin for log functionality"
-    gem.email = "info@opscode.com"
-    gem.homepage = "http://www.opscode.com"
-    gem.authors = ["Opscode, Inc."]
-    gem.files.include %w{ bin/* lib/**/* }
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  STDERR.puts
-  STDERR.puts "Jeweler is not installed. (sudo) gem install jeweler to use gem packaging tasks"
-  STDERR.puts
-end
-
-begin
-  require 'spec/rake/spectask'
-  Spec::Rake::SpecTask.new(:spec) do |spec|
-    spec.libs << 'lib' << 'spec'
-    spec.spec_opts = ['--options', "\"#{File.dirname(__FILE__)}/spec/spec.opts\""]
-    spec.spec_files = FileList['spec/**/*_spec.rb']
-  end
-
-  Spec::Rake::SpecTask.new(:rcov) do |spec|
-    spec.libs << 'lib' << 'spec'
-    spec.pattern = 'spec/**/*_spec.rb'
-    spec.rcov = true
-  end
-rescue LoadError
-  task :spec do
-    abort "Rspec is not available. (sudo) gem install rspec to run unit tests"
-  end
-end
-
-
-begin
-  require 'cucumber/rake/task'
-  Cucumber::Rake::Task.new(:features)
-rescue LoadError
-  task :features do
-    abort "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
-  end
-end
-
-task :default => :spec
-
-require 'rake/rdoctask'
-require 'yaml'
-
-Rake::RDocTask.new do |rdoc|
-  if File.exist?('VERSION.yml')
-    config = YAML.load(File.read('VERSION.yml'))
-    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
-  else
-    version = ""
-  end
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "mixlib-log #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-

data/VERSION.yml

@@ -1,5 +0,0 @@
---- 
-:major: 1
-:minor: 2
-:patch: 0
-:build: 

data/features/log.feature

@@ -1,37 +0,0 @@
-Feature: Log output
-  In order to keep a record of application specific information
-  As a developer
-  I want to publish information through a configurable log interface
-
-  Scenario: Log a message at the debug level
-    Given a base log level of 'debug'
-     When the message 'this goes out' is sent at the 'debug' level
-     Then the regex '\[.+\] DEBUG: this goes out' should be logged
-
-  Scenario: Log a message at the info level
-    Given a base log level of 'info'
-     When the message 'this goes out' is sent at the 'info' level
-     Then the regex '\[.+\] INFO: this goes out' should be logged
-     
-  Scenario: Log a message at the warn level
-   Given a base log level of 'warn'
-    When the message 'this goes out' is sent at the 'warn' level
-    Then the regex '\[.+\] WARN: this goes out' should be logged
-
-  Scenario: Log a message at the error level
-   Given a base log level of 'error'
-    When the message 'this goes out' is sent at the 'error' level
-    Then the regex '\[.+\] ERROR: this goes out' should be logged
-    
-  Scenario: Log a message at the fatal level
-   Given a base log level of 'fatal'
-    When the message 'this goes out' is sent at the 'fatal' level
-    Then the regex '\[.+\] FATAL: this goes out' should be logged
-    
-  Scenario: Log messages below the current threshold should not appear
-   Given a base log level of 'fatal'
-    When the message 'this goes out' is sent at the 'error' level
-     And the message 'this goes out' is sent at the 'warn' level
-     And the message 'this goes out' is sent at the 'info' level
-     And the message 'this goes out' is sent at the 'debug' level
-    Then nothing should be logged

data/features/steps/log.rb

@@ -1,48 +0,0 @@
-#
-# Author:: Adam Jacob (<adam@opscode.com>)
-# Copyright:: Copyright (c) 2008 Opscode, Inc.
-# License:: Apache License, Version 2.0
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-# 
-#     http://www.apache.org/licenses/LICENSE-2.0
-# 
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
-
-Given /^a base log level of '(.+)'$/ do |level|
-  Logit.level = level.to_sym
-end
-
-When /^the message '(.+)' is sent at the '(.+)' level$/ do |message, level|
-  case level.to_sym
-  when :debug
-    Logit.debug(message)
-  when :info
-    Logit.info(message)
-  when :warn
-    Logit.warn(message)
-  when :error
-    Logit.error(message)
-  when :fatal
-    Logit.fatal(message)
-  else
-    raise ArgumentError, "Level is not one of debug, info, warn, error, or fatal"
-  end
-end
-
-Then /^the regex '(.+)' should be logged$/ do |regex_string|  
-  regex = Regexp.new(regex_string, Regexp::MULTILINE)
-  regex.match(@output).should_not == nil
-end
-
-Then /^nothing should be logged$/ do 
-  @output.should == ""
-end
-

data/features/support/env.rb

@@ -1,46 +0,0 @@
-#
-# Author:: Adam Jacob (<adam@opscode.com>)
-# Copyright:: Copyright (c) 2008 Opscode, Inc.
-# License:: Apache License, Version 2.0
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-# 
-#     http://www.apache.org/licenses/LICENSE-2.0
-# 
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
-
-$: << File.join(File.dirname(__FILE__), '..', '..', 'lib')
-
-require 'spec/expectations'
-require 'mixlib/log'
-require 'tmpdir'
-require 'stringio'
-
-class MyWorld
-  def initialize
-    @tmpdir = File.join(Dir.tmpdir, "mixlib_log")
-    @output = ''
-    @output_io = StringIO.new(@output)
-    Logit.init(@output_io)
-  end
-end
-
-World do
-  MyWorld.new
-end
-
-Before do
-  system("mkdir -p #{@tmpdir}")
-end
-
-After do
-  system("rm -rf #{@tmpdir}")
-end
-

data/features/support/logit.rb

@@ -1,21 +0,0 @@
-#
-# Author:: Adam Jacob (<adam@opscode.com>)
-# Copyright:: Copyright (c) 2008 Opscode, Inc.
-# License:: Apache License, Version 2.0
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-# 
-#     http://www.apache.org/licenses/LICENSE-2.0
-# 
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
-
-class Logit
-  extend Mixlib::Log
-end

data/spec/mixlib/log/formatter_spec.rb

@@ -1,51 +0,0 @@
-#
-# Author:: Adam Jacob (<adam@opscode.com>)
-# Copyright:: Copyright (c) 2008 Opscode, Inc.
-# License:: Apache License, Version 2.0
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-# 
-#     http://www.apache.org/licenses/LICENSE-2.0
-# 
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
-
-require 'time'
-require File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "spec_helper"))
-
-describe Mixlib::Log::Formatter do
-  before(:each) do
-    @formatter = Mixlib::Log::Formatter.new
-  end
-  
-  it "should print raw strings with msg2str(string)" do
-    @formatter.msg2str("nuthin new").should == "nuthin new"
-  end
-  
-  it "should format exceptions properly with msg2str(e)" do
-    e = IOError.new("legendary roots crew")
-    @formatter.msg2str(e).should == "legendary roots crew (IOError)\n"
-  end
-  
-  it "should format random objects via inspect with msg2str(Object)" do
-    @formatter.msg2str([ "black thought", "?uestlove" ]).should == '["black thought", "?uestlove"]'
-  end
-  
-  it "should return a formatted string with call" do
-    time = Time.new
-    Mixlib::Log::Formatter.show_time = true
-    @formatter.call("monkey", time, "test", "mos def").should == "[#{time.rfc2822}] monkey: mos def\n"
-  end
-  
-  it "should allow you to turn the time on and off in the output" do
-    Mixlib::Log::Formatter.show_time = false
-    @formatter.call("monkey", Time.new, "test", "mos def").should == "monkey: mos def\n"
-  end
-  
-end

data/spec/mixlib/log_spec.rb

@@ -1,107 +0,0 @@
-#
-# Author:: Adam Jacob (<adam@opscode.com>)
-# Author:: Christopher Brown (<cb@opscode.com>)
-# Copyright:: Copyright (c) 2008 Opscode, Inc.
-# License:: Apache License, Version 2.0
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-# 
-#     http://www.apache.org/licenses/LICENSE-2.0
-# 
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
-
-require 'tempfile'
-require File.expand_path(File.join(File.dirname(__FILE__), "..", "spec_helper"))
-
-describe Mixlib::Log do
-
-  # Since we are testing class behaviour for an instance variable
-  # that gets set once, we need to reset it prior to each example [cb]
-  before(:each) do
-    Logit.instance_variable_set("@logger",nil)
-  end
-  
-  it "should accept regular options to Logger.new via init" do
-    Tempfile.open("chef-test-log") do |tf|
-      lambda { Logit.init(STDOUT) }.should_not raise_error
-      lambda { Logit.init(tf) }.should_not raise_error
-    end
-  end
-
-  it "should re-initialize the logger if init is called again" do
-    first_logdev, second_logdev = StringIO.new, StringIO.new
-    Logit.init(first_logdev)
-    Logit.fatal "FIRST"
-    first_logdev.string.should match(/FIRST/)
-    Logit.init(second_logdev)
-    Logit.fatal "SECOND"
-    first_logdev.string.should_not match(/SECOND/)
-    second_logdev.string.should match(/SECOND/)
-  end
-  
-  it "should set the log level using the binding form,  with :debug, :info, :warn, :error, or :fatal" do
-    levels = {
-      :debug => Logger::DEBUG,
-      :info  => Logger::INFO,
-      :warn  => Logger::WARN,
-      :error => Logger::ERROR,
-      :fatal => Logger::FATAL
-    }
-    levels.each do |symbol, constant|
-      Logit.level = symbol
-      Logit.logger.level.should == constant
-      Logit.level.should == symbol
-    end
-  end
-
-  it "passes blocks to the underlying logger object" do
-    logdev = StringIO.new
-    Logit.init(logdev)
-    Logit.fatal { "the_message" }
-    logdev.string.should match(/the_message/)
-  end
-
-
-  it "should set the log level using the method form, with :debug, :info, :warn, :error, or :fatal" do
-    levels = {
-      :debug => Logger::DEBUG,
-      :info  => Logger::INFO,
-      :warn  => Logger::WARN,
-      :error => Logger::ERROR,
-      :fatal => Logger::FATAL
-    }
-    levels.each do |symbol, constant|
-      Logit.level(symbol)
-      Logit.logger.level.should == constant
-    end
-  end
-  
-  it "should raise an ArgumentError if you try and set the level to something strange using the binding form" do
-    lambda { Logit.level = :the_roots }.should raise_error(ArgumentError)
-  end
-  
-  it "should raise an ArgumentError if you try and set the level to something strange using the method form" do
-    lambda { Logit.level(:the_roots) }.should raise_error(ArgumentError)
-  end
-  
-  it "should pass other method calls directly to logger" do
-    Logit.level = :debug
-    Logit.should be_debug
-    lambda { Logit.debug("Gimme some sugar!") }.should_not raise_error
-  end
-  
-  it "should default to STDOUT if init is called with no arguments" do
-    logger_mock = mock(Logger, :null_object => true)
-    Logger.stub!(:new).and_return(logger_mock)
-    Logger.should_receive(:new).with(STDOUT).and_return(logger_mock)
-    Logit.init
-  end
-  
-end

data/spec/spec.opts

@@ -1,4 +0,0 @@
---colour
---format specdoc
---loadby mtime
---reverse

data/spec/spec_helper.rb

@@ -1,28 +0,0 @@
-#
-# Author:: Adam Jacob (<adam@opscode.com>)
-# Author:: Christopher Brown (<cb@opscode.com>)
-# Copyright:: Copyright (c) 2008 Opscode, Inc.
-# License:: Apache License, Version 2.0
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-# 
-#     http://www.apache.org/licenses/LICENSE-2.0
-# 
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
-
-$TESTING=true
-$:.push File.join(File.dirname(__FILE__), '..', 'lib')
-
-require 'mixlib/log'
-require 'mixlib/log/formatter'
-
-class Logit
-  extend Mixlib::Log
-end