yell 0.10.0 → 0.11.0

data/README.md

@@ -4,6 +4,7 @@
 
 Yell works and is tested with ruby 1.8.7, 1.9.x, jruby 1.8 and 1.9 mode, rubinius 1.8 and 1.9 as well as ree.
 
+**If you want to use Yell with Rails, then head over to [yell-rails](https://github.com/rudionrails/yell-rails).**
 
 ## Installation
 

data/Rakefile

@@ -30,7 +30,7 @@ begin
   desc "Run specs"
   RSpec::Core::RakeTask.new do |t|
     t.rspec_opts = %w(--color --format progress --order random)
-    t.ruby_opts = %w(-w)
+    # t.ruby_opts = %w(-w)
   end
 rescue LoadError
   task :spec do

data/lib/yell/event.rb

@@ -5,14 +5,18 @@ require 'socket'
 
 module Yell #:nodoc:
 
+  #
+  # Yell::Event.new( :info, 'Hello World', { :scope => 'Application' } )
+  # #=> Hello World scope: Application
   class Event
     # regex to fetch caller attributes
-    @@caller_regexp = /^(.+?):(\d+)(?::in `(.+)')?/
+    CallerRegexp = /^(.+?):(\d+)(?::in `(.+)')?/
 
     # jruby and rubinius seemsto have a different caller
-    @@caller_index = 2
     if defined?(RUBY_ENGINE) and ["rbx", "jruby"].include?(RUBY_ENGINE)
-      @@caller_index =1
+      CallerIndex =1
+    else
+      CallerIndex = 2
     end
 
     # Prefetch those values (no need to do that on every new instance)
@@ -25,6 +29,9 @@ module Yell #:nodoc:
     # Accessor to the log message
     attr_reader :message
 
+    # Accessor to additional options
+    attr_reader :options
+
     # Accessor to the time the log event occured
     attr_reader :time
 
@@ -32,14 +39,15 @@ module Yell #:nodoc:
     attr_reader :thread_id
 
 
-    def initialize( level, message = nil, &block )
+    def initialize( level, message = nil, options = {}, &block )
       @time     = Time.now
       @level    = level
       @message  = block ? block.call : message
+      @options  = options
 
       @thread_id  = Thread.current.object_id
 
-      @caller = caller[@@caller_index].to_s
+      @caller = caller[CallerIndex].to_s
       @file   = nil
       @line   = nil
       @method = nil
@@ -77,7 +85,7 @@ module Yell #:nodoc:
     private
 
     def _caller!
-      if m = @@caller_regexp.match( @caller )
+      if m = CallerRegexp.match( @caller )
         @file, @line, @method = m[1..-1]
       else
         @file, @line, @method = ['', '', '']

data/lib/yell/formatter.rb

@@ -61,10 +61,11 @@ module Yell #:nodoc:
     end
 
     PatternTable = {
-      "m" => "message(event)",             # Message
-      "l" => "level(event)[0,1]",          # Level (short), e.g.'I', 'W'
-      "L" => "level(event)",               # Level, e.g. 'INFO', 'WARN'
-      "d" => "date(event)",                # ISO8601 Timestamp
+      "m" => "message(event.message)",     # Message
+      "o" => "message(event.options)",     # Message options
+      "l" => "level(event.level)[0,1]",    # Level (short), e.g.'I', 'W'
+      "L" => "level(event.level)",         # Level, e.g. 'INFO', 'WARN'
+      "d" => "date(event.time)",           # ISO8601 Timestamp
       "h" => "event.hostname",             # Hostname
       "p" => "event.pid",                  # PID
       "t" => "event.thread_id",            # Thread ID
@@ -115,21 +116,24 @@ module Yell #:nodoc:
       -
     end
 
-    def message( event )
-      return event.message unless event.message.is_a? Exception
+    def message( m )
+      case m
+        when Hash
+          m.map { |k,v| "#{k}: #{v}" }.join( ", " )
+        when Exception
+          backtrace = m.backtrace ? "\n\t#{m.backtrace.join("\n\t")}" : ""
 
-      exception = event.message
-      backtrace = exception.backtrace ? "\n\t#{exception.backtrace.join("\n\t")}" : ""
-
-      "%s: %s%s" % [exception.class, exception.message, backtrace]
+          "%s: %s%s" % [m.class, m.message, backtrace]
+        else m
+      end
     end
 
-    def level( event )
-      Yell::Severities[ event.level ]
+    def level( l )
+      Yell::Severities[ l ]
     end
 
-    def date( event )
-      @date_pattern ? event.time.strftime( @date_pattern ) : event.time.iso8601
+    def date( t )
+      @date_pattern ? t.strftime( @date_pattern ) : t.iso8601
     end
 
   end

data/lib/yell/logger.rb

@@ -122,10 +122,9 @@ module Yell #:nodoc:
       class_eval <<-EOS, __FILE__, __LINE__
         def #{name}?; @level.at?(#{index}); end     # def info?; @level.at?(1); end
                                                     #
-        def #{name}( m = nil, &b )                  # def info( m = nil, &b )
+        def #{name}( m = nil, o = {}, &b )          # def info( m = nil, o = {}, &b )
           return unless #{name}?                    #   return unless info?
-                                                    #
-          write Yell::Event.new( #{index}, m, &b )  #   write Yell::Event.new( 1, m, &b )
+          write Yell::Event.new(#{index}, m, o, &b) #   write Yell::Event.new(1, m, o, &b)
                                                     #
           true                                      #   true
         end                                         # end

data/lib/yell/version.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 
 module Yell #:nodoc:
-  VERSION = "0.10.0"
+  VERSION = "0.11.0"
 
 end
 

data/spec/fixtures/yell.yml

@@ -1,4 +1,4 @@
-development:
+test:
   :level: info
 
   :adapters:

data/spec/spec_helper.rb

@@ -1,7 +1,7 @@
 $:.unshift File.expand_path('..', __FILE__)
 $:.unshift File.expand_path('../../lib', __FILE__)
 
-require 'ostruct'
+ENV['YELL_ENV'] = 'test'
 
 require 'yell'
 
@@ -13,7 +13,14 @@ RSpec.configure do |config|
   config.mock_framework = :rr
 
   config.after do
-    Dir[ "*.log" ].each { |f| File.delete f }
+    Dir[ fixture_path + "/*.log" ].each { |f| File.delete f }
   end
+
+  private
+
+  def fixture_path
+    File.expand_path( "fixtures", File.dirname(__FILE__) )
+  end
+
 end
 

data/spec/yell/adapters/datefile_spec.rb

@@ -1,45 +1,68 @@
 require 'spec_helper'
 
 describe Yell::Adapters::Datefile do
-  let( :time ) { Time.now }
-  let( :filename ) { 'filename.log' }
-
+  let( :filename ) { fixture_path + '/test.log' }
   let( :event ) { Yell::Event.new(1, "Hello World") }
 
+  before do
+    Timecop.freeze( Time.now )
+  end
+
   describe :filename do
     let( :adapter ) { Yell::Adapters::Datefile.new(:filename => filename) }
-    let( :date_filename ) { "filename.#{time.strftime(Yell::Adapters::Datefile::DefaultDatePattern)}.log" }
-
-    before do
-      Timecop.freeze( time )
-    end
 
     it "should be replaced with date_pattern" do
       adapter.write( event )
 
-      File.exist?(date_filename).should be_true
+      File.exist?(datefile_filename).should be_true
     end
 
     it "should open file handle only once" do
-      mock( File ).open( date_filename, anything ) { File.new('/dev/null', 'w') }
+      mock( File ).open( datefile_filename, anything ) { File.new('/dev/null', 'w') }
 
       adapter.write( event )
       adapter.write( event )
     end
 
     context "rollover" do
-      let( :tomorrow ) { time + 86400 }
-      let( :tomorrow_date_filename ) { "filename.#{tomorrow.strftime(Yell::Adapters::Datefile::DefaultDatePattern)}.log" }
+      let( :tomorrow ) { Time.now + 86400 }
+      let( :tomorrow_datefile_filename ) { fixture_path + "/test.#{tomorrow.strftime(Yell::Adapters::Datefile::DefaultDatePattern)}.log" }
 
       it "should rollover when date has passed" do
-        mock( File ).open( date_filename, anything ) { File.new('/dev/null', 'w') }
+        mock( File ).open( datefile_filename, anything ) { File.new('/dev/null', 'w') }
         adapter.write( event )
 
-        Timecop.freeze( tomorrow ) # tomorrow
+        Timecop.freeze( tomorrow )
+
+        mock( File ).open( tomorrow_datefile_filename, anything ) { File.new('/dev/null', 'w') }
+        adapter.write( event )
+      end
+    end
+  end
+
+  describe :keep do
+    let( :adapter ) { Yell::Adapters::Datefile.new(:keep => 2, :filename => filename, :date_pattern => "%M" ) }
+
+    it "should keep the specified number or files upon wollover" do
+      adapter.write( event )
+      Dir[ fixture_path + '/*.log' ].size.should == 1
+
+      Timecop.freeze( Time.now + 60 ) do
+        adapter.write( event )
+        Dir[ fixture_path + '/*.log' ].size.should == 2
+      end
 
-        mock( File ).open( tomorrow_date_filename, anything ) { File.new('/dev/null', 'w') }
+      Timecop.freeze( Time.now + 120 ) do
         adapter.write( event )
+        Dir[ fixture_path + '/*.log' ].size.should == 2
       end
     end
   end
+
+
+  private
+
+  def datefile_filename( pattern = Yell::Adapters::Datefile::DefaultDatePattern )
+    fixture_path + "/test.#{Time.now.strftime(pattern)}.log"
+  end
 end

data/spec/yell/configuration_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe Yell::Configuration do
 
   describe ":load!" do
-    let( :file ) { File.dirname(__FILE__) + '/../fixtures/yell.yml' }
+    let( :file ) { fixture_path + '/yell.yml' }
     let( :config ) { Yell::Configuration.load!( file ) }
 
     subject { config }

data/spec/yell/event_spec.rb

@@ -17,6 +17,8 @@ class EventFactory
 end
 
 describe Yell::Event do
+  let(:event) { Yell::Event.new 1, 'Hello World!', :test => :option }
+
   context :caller do
     let( :event ) { EventFactory.event 1, "Hello World" }
 
@@ -36,8 +38,6 @@ describe Yell::Event do
     end
   end
 
-  let(:event) { Yell::Event.new 1, 'Hello World!' }
-
   context :level do
     subject { event.level }
     it { should == 1 }
@@ -48,6 +48,11 @@ describe Yell::Event do
     it { should == 'Hello World!' }
   end
 
+  context :options do
+    subject { event.options }
+    it { should == { :test => :option } }
+  end
+
   context :time do
     subject { event.time }
 

data/spec/yell/formatter_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe Yell::Formatter do
 
   let( :formatter ) { Yell::Formatter.new(subject) }
-  let( :event ) { Yell::Event.new 1, 'Hello World!' }
+  let( :event ) { Yell::Event.new 1, 'Hello World!', :test => :option }
   let( :time ) { Time.now }
 
   let( :format ) { formatter.format(event) }
@@ -17,6 +17,11 @@ describe Yell::Formatter do
     it { format.should == "Hello World!" }
   end
 
+  context "%o" do
+    subject { "%o" }
+    it { format.should == "test: option" }
+  end
+
   context "%l" do
     subject { "%l" }
     it { format.should == "I" }
@@ -95,7 +100,7 @@ describe Yell::Formatter do
   end
 
   context "Exceptions" do
-    let( :exception ) { StandardError.new( "message" ) }
+    let( :exception ) { StandardError.new( "This is an Exception" ) }
     let( :event ) { Yell::Event.new( 1, exception ) }
 
     subject { "%m" }
@@ -104,7 +109,16 @@ describe Yell::Formatter do
       mock( exception ).backtrace.times(any_times) { ["backtrace"] }
     end
 
-    it { format.should == "#{exception.class}: #{exception.message}\n\tbacktrace" }
+    it { format.should == "StandardError: This is an Exception\n\tbacktrace" }
+  end
+
+  context "Hashes" do
+    let( :hash ) { { :test => 'message' } }
+    let( :event ) { Yell::Event.new( 1, hash ) }
+
+    subject { "%m" }
+
+    it { format.should == "test: message" }
   end
 
 end

data/spec/yell/logger_spec.rb

@@ -60,7 +60,7 @@ describe Yell::Logger do
       mock.proxy( Yell::Adapters::Stdout ).new( anything )
     end
 
-    it "should call adapter with :stdout" do
+    it "should call adapter with STDOUT" do
       Yell::Logger.new STDOUT
     end
 
@@ -74,7 +74,7 @@ describe Yell::Logger do
       mock.proxy( Yell::Adapters::Stderr ).new( anything )
     end
 
-    it "should call adapter with :stderr" do
+    it "should call adapter with STDERR" do
       Yell::Logger.new STDERR
     end
 
@@ -144,5 +144,6 @@ describe Yell::Logger do
       factory.bar
     end
   end
+
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yell
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-12 00:00:00.000000000 Z
+date: 2012-05-21 00:00:00.000000000 Z
 dependencies: []
 description: Yell - Your Extensible Logging Library. Define multiple adapters, various
   log level combinations or message formatting options like you've never done before
@@ -100,3 +100,4 @@ test_files:
 - spec/yell/level_spec.rb
 - spec/yell/logger_spec.rb
 - spec/yell_spec.rb
+has_rdoc: