mixlib-log 1.3.0 → 1.4.0

data/lib/mixlib/log/formatter.rb

@@ -31,7 +31,7 @@ module Mixlib
       # Otherwise, doesn't print the time.
       def call(severity, time, progname, msg)
         if @@show_time
-          sprintf("[%s] %s: %s\n", time.rfc2822(), severity, msg2str(msg))
+          sprintf("[%s] %s: %s\n", time.iso8601(), severity, msg2str(msg))
         else
           sprintf("%s: %s\n", severity, msg2str(msg))
         end
@@ -53,4 +53,4 @@ module Mixlib
       end
     end
   end
-end
+end

data/lib/mixlib/log/version.rb

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

data/lib/mixlib/log.rb

@@ -72,7 +72,7 @@ module Mixlib
     # get passed directly to Logger.new, so check out the documentation for the standard Logger class
     # to understand what to do here.
     #
-    # If this method is called with no arguments, it will log to STDOUT at the :info level.
+    # If this method is called with no arguments, it will log to STDOUT at the :warn level.
     #
     # It also configures the Logger instance it creates to use the custom Mixlib::Log::Formatter class.
     def init(*opts)

data/spec/mixlib/log/formatter_spec.rb

@@ -0,0 +1,51 @@
+#
+# 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.iso8601}] 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

@@ -0,0 +1,147 @@
+#
+# 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 'stringio'
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "spec_helper"))
+
+class LoggerLike
+  attr_accessor :level
+  attr_reader :messages
+  def initialize
+    @messages = ""
+  end
+
+  [:debug, :info, :warn, :error, :fatal].each do |method_name|
+    class_eval(<<-E)
+      def #{method_name}(message)
+        @messages << message
+      end
+    E
+  end
+end
+
+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.reset!
+  end
+
+  it "creates a logger using an IO object" do
+    io = StringIO.new
+    Logit.init(io)
+    Logit << "foo"
+    io.string.should match(/foo/)
+  end
+
+  it "creates a logger with a file name" do
+    Tempfile.open("chef-test-log") do |tempfile|
+      Logit.init(tempfile.path)
+      Logit << "bar"
+      tempfile.rewind
+      tempfile.read.should match(/bar/)
+    end
+  end
+
+  it "uses the logger provided when initialized with a logger like object" do
+    logger = LoggerLike.new
+    Logit.init(logger)
+    Logit.debug "qux"
+    logger.messages.should match(/qux/)
+  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 = Struct.new(:formatter, :level).new
+    Logger.stub!(:new).and_return(logger_mock)
+    Logger.should_receive(:new).with(STDOUT).and_return(logger_mock)
+    Logit.init
+  end
+
+  it "should have by default a base log level of warn" do
+    logger_mock = Struct.new(:formatter, :level).new
+    Logger.stub!(:new).and_return(logger_mock)
+    Logit.init
+    Logit.level.should eql(:warn)
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+#
+# 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 'rspec'
+require 'mixlib/log'
+require 'mixlib/log/formatter'
+
+class Logit
+  extend Mixlib::Log
+end

metadata

@@ -1,63 +1,104 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: mixlib-log
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 1.4.0
   prerelease: 
-  version: 1.3.0
 platform: ruby
-authors: 
+authors:
 - Opscode, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-03-23 00:00:00 -07:00
-default_executable: 
-dependencies: []
-
+date: 2012-06-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
 description: 
 email: info@opscode.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.rdoc
 - LICENSE
 - NOTICE
-files: 
-- lib/mixlib/log/formatter.rb
-- lib/mixlib/log/version.rb
+files:
 - lib/mixlib/log.rb
+- lib/mixlib/log/version.rb
+- lib/mixlib/log/formatter.rb
+- spec/spec_helper.rb
+- spec/mixlib/log_spec.rb
+- spec/mixlib/log/formatter_spec.rb
 - README.rdoc
 - LICENSE
 - NOTICE
-has_rdoc: true
 homepage: http://www.opscode.com
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: A gem that provides a simple mixin for log functionality
 test_files: []
-