yell 0.4.1 → 0.4.2

data/README.md

@@ -1,6 +1,9 @@
-Yell - Your Extensible Logging Library
+**Yell - Your Extensible Logging Library**
+
+[![Build Status](https://secure.travis-ci.org/rudionrails/yell.png?branch=master)](http://travis-ci.org/rudionrails/yell)
+
+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.
 
-[![Build Status](https://secure.travis-ci.org/rudionrails/yell.png)](http://travis-ci.org/rudionrails/yell)
 
 ## Installation
 
@@ -16,6 +19,7 @@ Or in your Gemfile:
 gem "yell"
 ```
 
+
 ## Usage
 
 On the basics, Yell works just like any other logging library. However, it 
@@ -45,10 +49,94 @@ Naturally, you can pass a `:filename` to Yell:
 logger = Yell.new "yell.log"
 ```
 
-To learn about how to use [log levels](https://github.com/rudionrails/yell/wiki/101-setting-the-log-level), 
-[log formatting](https://github.com/rudionrails/yell/wiki/101-formatting-log-messages), or different 
-[adapters](https://github.com/rudionrails/yell/wiki/101-using-adapters) see the 
-[wiki](https://github.com/rudionrails/yell/wiki) or have a look into the examples folder.
+### Levels
+
+Just like any other logging library, Yell allows you to define from which level 
+onwarns you want to write your log message. here are some examples to show how 
+you can combine those.
+
+##### Example: Write from `:info` onwards
+
+```ruby
+logger = Yell.new STDOUT, :level => :info # write on :info, :warn, :error, :fatal
+```
+
+##### Example: Write on `:info` and `:error` only
+
+```ruby
+logger - Yell.new STDOUT, :level => [:info, :error] # write on :info and :error only
+```
+
+##### Example: Write between :info and :error
+
+```ruby
+logger = Yell.new STDOUT, :level => (:info..:error)
+
+# NOTE: The Range might only work with 1.9 compatible rubies!
+```
+
+There are more ways to set your logging level, please consult the 
+[wiki](https://github.com/rudionrails/yell/wiki) on that.
+
+
+### Adapters
+
+Yell comes with various adapters already build-in. Those are the mainly IO-based 
+adapters for every day use. There are additional ones available as separate gems. Please 
+consult the [wiki](https://github.com/rudionrails/yell/wiki) on that - they are listed 
+there.
+
+The standard adapters are:
+
+**:stdout** or **STDOUT**: Messages will be written to STDOUT  
+**:stderr** or **STDERR**: Messages will be written to STDERR  
+**:file**: Messages will be written to a file  
+**:datefile**: Messages will be written to a timestamped file  
+
+
+Here are some short examples on how to combine them:
+
+##### Example: Notice messages go into `STDOUT` and error messages into `STDERR`
+
+```ruby
+logger = Yell.new do
+  adapter STDOUT, :level => [:debug, :info, :warn]
+  adapter STDERR, :level => [:error, :fatal]
+end
+```
+
+##### Example: Notice messages to into `application.log` and error messages into `error.log`
+
+```ruby
+logger = Yell.new do
+  adapter :file, 'application.log', :level => [:debug, :info, :warn]
+  adapter :file, 'error.log', :level => [:error, :fatal]
+end
+```
+
+##### Example: Every log severity is handled by a separate adapter and we ignore `:debug` and `:info` levels
+
+```ruby
+logger = Yell.new do
+  level :warn # only start logging from :warn upwards
+
+  adapter :stdout, :level => [:warn]
+  adapter :datefile, 'error.log', :level => [:error]
+  adapter :datefile, 'fatal.log', :level => [:fatal]
+end
+```
+
+## Further Readings
+
+[How To: Setting The Log Level](https://github.com/rudionrails/yell/wiki/101-setting-the-log-level)  
+[How To: Formatting Log Messages](https://github.com/rudionrails/yell/wiki/101-formatting-log-messages)  
+[How To: Using Adapters](https://github.com/rudionrails/yell/wiki/101-using-adapters)  
+[How To: The Datefile Adapter](https://github.com/rudionrails/yell/wiki/101-the-datefile-adapter)  
+[How To: Different Adapters for Different Log Levels](https://github.com/rudionrails/yell/wiki/101-different-adapters-for-different-log-levels)  
+
+
+You can find further examples and additional adapters in the [wiki](https://github.com/rudionrails/yell/wiki).
+or have a look into the examples folder.
 
 
 Copyright © 2011-2012 Rudolf Schmidt, released under the MIT license

data/lib/yell/adapters/base.rb

@@ -10,7 +10,12 @@ module Yell #:nodoc:
     # by the {Yell::Logger}.
     class Base
 
+      # Accessor to the options
+      attr_reader :options
+
       def initialize( options = {}, &block )
+        @options = options
+
         level options[:level]
 
         instance_eval( &block ) if block

data/lib/yell/adapters/datefile.rb

@@ -18,39 +18,22 @@ module Yell #:nodoc:
 
         @date = nil # default; do not override --R
 
-        keep options[:keep]
-
         super
       end
 
       # @overload Reset the file handle
       def close
-        @filename = filename_from( @date )
+        @filename = new_filename
 
         super
       end
 
-      # Set the amount of logfiles to keep when rolling over
-      #
-      # @example Keep the last 5 logfiles
-      #   keep 5
-      def keep( n = nil )
-        @keep = n
-      end
 
       private
 
       # @overload Close the file if date is expired
       def write!( event )
-        if close?
-          close
-
-          unless ::File.exist?( @filename )
-            cleanup if cleanup?
-
-            stream.print( "# -*- #{@date.iso8601} (#{@date.to_f}) [#{@date_pattern}] -*-\n" )
-          end
-        end
+        close if close?
 
         super( event )
       end
@@ -61,12 +44,8 @@ module Yell #:nodoc:
       # If the current time hits the pattern, it closes the file stream.
       #
       # @return [Boolean] true or false
-      #
-      # TODO: This method causes the datefile adapter to be twice as slow as the file.
-      # Let's refactor this.
       def close?
-        _date = Time.now
-
+        _date = Time.now.strftime( @date_pattern )
         if !@stream or _date != @date
           @date = _date
           return true
@@ -75,31 +54,9 @@ module Yell #:nodoc:
         false
       end
 
-      def cleanup
-        files = Dir[ @file_basename.sub( /(\.\w+)?$/, ".*\\1" ) ].map do |f|
-          [ f, metadata_from(f).last ]
-        end.select do |(f, p)|
-          @date_pattern == p
-        end
-
-        ::File.unlink( *files.map(&:first)[0..-(@keep)] )
-      end
-
-      def cleanup?
-       !!@keep
-      end
-
       # Sets the filename with the `:date_pattern` appended to it.
-      def filename_from( date )
-        @file_basename.sub( /(\.\w+)?$/, ".#{date.strftime(@date_pattern)}\\1" )
-      end
-
-      def metadata_from( file )
-        if m = ::File.open( file, &:readline ).match( /^# -\*- (.+) \((\d+\.\d+)\) \[(.+)\] -\*-$/ )
-          [ Time.at( m[2].to_f ), m[3] ]
-        else
-          [ ::File.mtime( file ), "" ]
-        end
+      def new_filename
+        @file_basename.sub( /(\.\w+)?$/, ".#{@date}\\1" )
       end
 
     end
@@ -108,4 +65,3 @@ module Yell #:nodoc:
 
   end
 end
-

data/lib/yell/version.rb

@@ -1,4 +1,4 @@
 module Yell #:nodoc:
-  VERSION = "0.4.1"
+  VERSION = "0.4.2"
 
 end

data/spec/yell/adapters/base_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+
+describe Yell::Adapters::Base do
+
+  context "initialize with :level" do
+    before do
+      any_instance_of( Yell::Adapters::Base ) do |base|
+        mock( base ).level( :info )
+      end
+    end
+
+    it "should set the level" do
+      Yell::Adapters::Base.new :level => :info
+    end
+  end
+
+  context "insitialize with :block" do
+    context :level do
+      before do
+        any_instance_of( Yell::Adapters::Base ) do |base|
+          mock( base ).level( :info )
+        end
+      end
+
+      it "should set the level" do
+        Yell::Adapters::Base.new :level => :info
+      end
+    end
+  end
+
+  context :options do
+    let( :options ) { { :my => :options } }
+    let( :adapter ) { Yell::Adapters::Base.new( options ) }
+
+    it { options.should == options }
+  end
+
+  context :write do
+    subject { Yell::Adapters::Base.new :level => :info }
+
+    it "should delegate :event to :write!" do
+      event = Yell::Event.new( "INFO", "Hello World!" )
+
+      mock( subject ).write!( event )
+
+      subject.write( event )
+    end
+
+    it "should not write when event does not have the right level" do
+      event = Yell::Event.new( "DEBUG", "Hello World!" )
+
+      dont_allow( subject ).write!( event )
+
+      subject.write( event )
+    end
+  end
+
+  context :close do
+    subject { Yell::Adapters::Base.new.close }
+
+    it "should raise" do
+      lambda { subject }.should raise_error("Not implemented" )
+    end
+  end
+
+end
+

data/yell.gemspec

@@ -7,10 +7,10 @@ Gem::Specification.new do |s|
   s.version     = Yell::VERSION
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Rudolf Schmidt"]
-  
+
   s.homepage    = "http://rubygems.org/gems/yell"
   s.summary     = %q{Yell - Your Extensible Logging Library }
-  s.description = %q{An easy to use logging library to log into files and any other self-defined adapters}
+  s.description = %q{Yell - Your Extensible Logging Library. Define multiple adapters, various log level combinations or message formatting options like you've never done before}
 
   s.rubyforge_project = "yell"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yell
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-29 00:00:00.000000000 Z
+date: 2012-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rr
-  requirement: &70163680872100 !ruby/object:Gem::Requirement
+  requirement: &70222528328160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,9 +21,9 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70163680872100
-description: An easy to use logging library to log into files and any other self-defined
-  adapters
+  version_requirements: *70222528328160
+description: Yell - Your Extensible Logging Library. Define multiple adapters, various
+  log level combinations or message formatting options like you've never done before
 email: 
 executables: []
 extensions: []
@@ -56,6 +56,7 @@ files:
 - lib/yell/logger.rb
 - lib/yell/version.rb
 - spec/spec_helper.rb
+- spec/yell/adapters/base_spec.rb
 - spec/yell/event_spec.rb
 - spec/yell/formatter_spec.rb
 - spec/yell/level_spec.rb
@@ -88,6 +89,7 @@ specification_version: 3
 summary: Yell - Your Extensible Logging Library
 test_files:
 - spec/spec_helper.rb
+- spec/yell/adapters/base_spec.rb
 - spec/yell/event_spec.rb
 - spec/yell/formatter_spec.rb
 - spec/yell/level_spec.rb