yell 0.6.0 → 0.7.0

data/README.md

@@ -83,6 +83,15 @@ end
 [How To: Different Adapters for Different Log Levels](https://github.com/rudionrails/yell/wiki/101-different-adapters-for-different-log-levels)  
 
 
+### Additional Adapters
+[Syslog](https://github.com/rudionrails/yell/wiki/additional-adapters-syslog)  
+[Graylog2 (GELF)](https://github.com/rudionrails/yell/wiki/additional-adapters-gelf)  
+
+
+### Development
+
+[How To: Writing Your Own Adapter](https://github.com/rudionrails/yell/wiki/Writing-your-own-adapter)  
+
 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.
 

data/lib/yell/adapters/base.rb

@@ -1,8 +1,14 @@
 # encoding: utf-8
 
+require 'monitor'
+
 module Yell #:nodoc:
   module Adapters #:nodoc:
 
+    class Mutex
+      include MonitorMixin
+    end
+
     # This class provides the basic interface for all allowed operations on any 
     # adapter implementation. Other adapters should inherit from it for the methods 
     # used by the {Yell::Logger}.
@@ -111,6 +117,8 @@ module Yell #:nodoc:
       #
       # You should not overload the constructor, use #setup instead.
       def initialize( options = {}, &block )
+        @mutex = Yell::Adapters::Mutex.new
+
         setup!(options)
 
         block.call(self) if block
@@ -121,10 +129,10 @@ module Yell #:nodoc:
       # The method receives the log `event` and determines whether to 
       # actually write or not.
       def write( event )
-        write!( event ) if write?( event )
+        synchronize { write!(event) } if write?(event)
       rescue Exception => e
         # make sure the adapter is closed and re-raise the exception
-        close
+        synchronize { close }
 
         raise( e )
       end
@@ -176,6 +184,10 @@ module Yell #:nodoc:
         @level.nil? || @level.at?( event.level )
       end
 
+      def synchronize( &block )
+        @mutex.synchronize( &block )
+      end
+
     end
 
   end

data/lib/yell/adapters/datefile.rb

@@ -11,7 +11,8 @@ module Yell #:nodoc:
       DefaultDatePattern = "%Y%m%d"
 
       setup do |options|
-        @date_pattern = options[:date_pattern] || DefaultDatePattern
+        self.date_pattern = options[:date_pattern] || DefaultDatePattern
+        self.keep         = options[:keep]
 
         @file_basename = options[:filename] || default_filename
         options[:filename] = @file_basename
@@ -20,14 +21,37 @@ module Yell #:nodoc:
       end
 
       write do |event|
-        close if close?
+        if close?
+          close
+
+          unless ::File.exist?( @filename )
+            cleanup if keep > 0
+
+            stream.print( "# -*- #{@date.iso8601} (#{@date.to_f}) [#{date_pattern}] -*-\n" )
+          end
+        end
       end
 
       close do
-        @filename = @file_basename.sub( /(\.\w+)?$/, ".#{@date}\\1" )
+        @filename = filename_from( @date )
       end
 
 
+      # Accesor to the date_pattern
+      attr_accessor :date_pattern
+
+      # Accessor to keep
+      attr_reader :keep
+
+      # Set the amount of logfiles to keep when rolling over
+      #
+      # @example Keep the last 5 logfiles
+      #   keep = 5
+      #   keep = '10'
+      def keep=( val )
+        @keep = val.to_i
+      end
+
       private
 
       # Determines whether to close the file handle or not.
@@ -36,9 +60,13 @@ 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.strftime( @date_pattern )
-        if !@stream or _date != @date
+        _date = Time.now
+
+        if @stream.nil? or _date != @date
           @date = _date
           return true
         end
@@ -46,9 +74,38 @@ module Yell #:nodoc:
         false
       end
 
+      # Cleanup old files
+      def cleanup
+        files = Dir[ @file_basename.sub( /(\.\w+)?$/, ".*\\1" ) ].map do |f|
+          [ f, metadata_from(f).last ]
+        end.select do |(_, 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
+      end
+
     end
 
     register( :datefile, Yell::Adapters::Datefile )
 
   end
 end
+

data/lib/yell/adapters/file.rb

@@ -16,7 +16,14 @@ module Yell #:nodoc:
 
       # @overload Lazily open the file handle
       def stream
-        @stream ||= ::File.open( @filename, ::File::WRONLY|::File::APPEND|::File::CREAT )
+        @stream or open!
+      end
+
+      def open!
+        @stream = ::File.open( @filename, ::File::WRONLY|::File::APPEND|::File::CREAT )
+        @stream.sync = true
+
+        @stream
       end
 
       def default_filename #:nodoc:

data/lib/yell/adapters/io.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require 'monitor'
+
 module Yell #:nodoc:
   module Adapters #:nodoc:
 
@@ -18,6 +20,8 @@ module Yell #:nodoc:
       }
 
       setup do |options|
+        @stream = nil
+
         self.colors = options[:colors]
         self.format = options[:format]
       end
@@ -32,8 +36,7 @@ module Yell #:nodoc:
 
         message << "\n" unless message[-1] == ?\n # add new line if there is none
 
-        stream.print( message )
-        stream.flush
+        stream.write( message )
       end
 
       close do
@@ -57,7 +60,6 @@ module Yell #:nodoc:
       def stream
         raise 'Not implemented'
       end
-
     end
 
   end

data/lib/yell/version.rb

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

data/spec/yell/adapters/io_spec.rb

@@ -63,9 +63,7 @@ describe Yell::Adapters::Io do
 
     it "should print formatted message to stream" do
       formatted = Yell::Formatter.new.format( event )
-
-      mock( stream ).print( formatted << "\n" )
-      mock( stream ).flush
+      mock( stream ).write( formatted << "\n" )
 
       adapter.write( event )
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yell
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-12 00:00:00.000000000 Z
+date: 2012-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &17866520 !ruby/object:Gem::Requirement
+  requirement: &70348235288880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *17866520
+  version_requirements: *70348235288880
 - !ruby/object:Gem::Dependency
   name: rr
-  requirement: &17866000 !ruby/object:Gem::Requirement
+  requirement: &70348235288440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *17866000
+  version_requirements: *70348235288440
 - !ruby/object:Gem::Dependency
   name: timecop
-  requirement: &17865580 !ruby/object:Gem::Requirement
+  requirement: &70348235288020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *17865580
+  version_requirements: *70348235288020
 description: Yell - Your Extensible Logging Library. Define multiple adapters, various
   log level combinations or message formatting options like you've never done before
 email: 
@@ -111,9 +111,21 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: yell
-rubygems_version: 1.8.10
+rubygems_version: 1.8.17
 signing_key: 
 specification_version: 3
 summary: Yell - Your Extensible Logging Library
-test_files: []
+test_files:
+- spec/spec_helper.rb
+- spec/yell/adapters/base_spec.rb
+- spec/yell/adapters/datefile_spec.rb
+- spec/yell/adapters/file_spec.rb
+- spec/yell/adapters/io_spec.rb
+- spec/yell/adapters/streams_spec.rb
+- spec/yell/adapters_spec.rb
+- spec/yell/event_spec.rb
+- spec/yell/formatter_spec.rb
+- spec/yell/level_spec.rb
+- spec/yell/logger_spec.rb
+- spec/yell_spec.rb
 has_rdoc: