mixlib-log 1.0.3 → 1.1.0

data/.gitignore

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

data/NOTICE

@@ -0,0 +1,27 @@
+Mixin::Log NOTICE
+=================
+
+Developed at Opscode (http://www.opscode.com).
+
+ * Copyright 2009, Opscode, Inc. <legal@opscode.com>
+
+Mixin::Log incorporates code from Chef.  The Chef notice file follows:
+
+Chef NOTICE
+===========
+
+Developed at Opscode (http://www.opscode.com).
+
+Contributors and Copyright holders:
+
+ * Copyright 2008, Adam Jacob <adam@opscode.com>
+ * Copyright 2008, Arjuna Christensen <aj@hjksolutions.com>
+ * Copyright 2008, Bryan McLellan <btm@loftninjas.org>
+ * Copyright 2008, Ezra Zygmuntowicz <ezra@engineyard.com>
+ * Copyright 2009, Sean Cribbs <seancribbs@gmail.com>
+ * Copyright 2009, Christopher Brown <cb@opscode.com>
+ * Copyright 2009, Thom May <thom@clearairturbulence.org>
+
+Chef incorporates code modified from Open4 (http://www.codeforpeople.com/lib/ruby/open4/), which was written by Ara T. Howard.
+
+Chef incorporates code modified from Merb (http://www.merbivore.com), which is Copyright (c) 2008 Engine Yard.

data/Rakefile

@@ -9,11 +9,12 @@ begin
     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
-  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install gemcutter jeweler (installs jeweler from gemcutter)"
 end
 
 require 'spec/rake/spectask'

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :major: 1
-:minor: 0
-:patch: 3
+:minor: 1 
+:patch: 0 

data/features/log.feature

@@ -0,0 +1,37 @@
+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

@@ -0,0 +1,48 @@
+#
+# 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

@@ -0,0 +1,46 @@
+#
+# 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

@@ -0,0 +1,21 @@
+#
+# 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/lib/mixlib/log.rb

@@ -1,5 +1,6 @@
 #
 # Author:: Adam Jacob (<adam@opscode.com>)
+# Author:: Christopher Brown (<cb@opscode.com>)
 # Copyright:: Copyright (c) 2008 Opscode, Inc.
 # License:: Apache License, Version 2.0
 #
@@ -15,16 +16,15 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'mixlib/log/formatter'
 require 'logger'
+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}
     
-    attr_writer :logger #:nodoc
-
     ##
     # init always returns a configured logger
     # and creates a new one if it doesn't yet exist
@@ -32,6 +32,10 @@ module Mixlib
     def logger
       init
     end
+
+    def logger=(value)
+      @logger=value
+    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
@@ -44,6 +48,7 @@ module Mixlib
       if @logger.nil?
         @logger = (opts.empty? ? Logger.new(STDOUT) : Logger.new(*opts))
         @logger.formatter = Mixlib::Log::Formatter.new()
+        @logger.level = Logger::WARN
       end
       @logger
     end
@@ -57,10 +62,18 @@ module Mixlib
     #  :fatal
     #
     # Throws an ArgumentError if you feed it a bogus log level.
-    def level(loglevel=:warn)
-      level = { :debug=>Logger::DEBUG, :info=>Logger::INFO, :warn=>Logger::WARN, :error=>Logger::ERROR, :fatal=>Logger::FATAL}[loglevel]
-      raise ArgumentError, "Log level must be one of :debug, :info, :warn, :error, or :fatal" if level.nil?
-      logger.level = 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
+    end
+
+    def level(lv=nil)
+      if lv.nil?
+        @@levels.find() {|l| logger.level==l[1]}[0]
+      else
+        self.level=(lv)
+      end
     end
     
     # Passes any other method calls on directly to the underlying Logger object created with init. If

data/spec/mixlib/log_spec.rb

@@ -1,5 +1,6 @@
 #
 # Author:: Adam Jacob (<adam@opscode.com>)
+# Author:: Christopher Brown (<cb@opscode.com>)
 # Copyright:: Copyright (c) 2008 Opscode, Inc.
 # License:: Apache License, Version 2.0
 #
@@ -34,7 +35,22 @@ describe Mixlib::Log do
     lambda { Logit.init(tf) }.should_not raise_error
   end
   
-  it "should set the log level with :debug, :info, :warn, :error, or :fatal" do
+  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 "should set the log level using the method form, with :debug, :info, :warn, :error, or :fatal" do
     levels = {
       :debug => Logger::DEBUG,
       :info  => Logger::INFO,
@@ -48,12 +64,16 @@ describe Mixlib::Log do
     end
   end
   
-  it "should raise an ArgumentError if you try and set the level to something strange" do
+  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.level = :debug
     Logit.should be_debug
     lambda { Logit.debug("Gimme some sugar!") }.should_not raise_error
   end

data/spec/spec.opts

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

data/spec/spec_helper.rb

@@ -1,3 +1,22 @@
+#
+# 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')
 
@@ -5,5 +24,5 @@ require 'mixlib/log'
 require 'mixlib/log/formatter'
 
 class Logit
-  extend(Mixlib::Log)
-end
+  extend Mixlib::Log
+end

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: mixlib-log
 version: !ruby/object:Gem::Version 
-  version: 1.0.3
+  prerelease: false
+  segments: 
+  - 1
+  - 1
+  - 0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Opscode, Inc.
@@ -9,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-12 00:00:00 +12:00
+date: 2010-02-28 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
@@ -23,14 +28,21 @@ 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
 - lib/mixlib/log/formatter.rb
 - spec/mixlib/log/formatter_spec.rb
 - spec/mixlib/log_spec.rb
+- spec/spec.opts
 - spec/spec_helper.rb
 has_rdoc: true
 homepage: http://www.opscode.com
@@ -45,18 +57,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: A gem that provides a simple mixin for log functionality