yell 0.11.0 → 0.12.0

data/lib/yell/adapters/datefile.rb

@@ -10,26 +10,32 @@ module Yell #:nodoc:
       # The default date pattern, e.g. "19820114" (14 Jan 1982)
       DefaultDatePattern = "%Y%m%d"
 
-      setup do |options|
-        self.date_pattern = options[:date_pattern] || DefaultDatePattern
-        self.keep         = options[:keep]
+      # Metadata
+      Metadata = lambda { |date, pattern| "# -*- #{date.iso8601} (#{date.to_f}) [#{pattern}] -*-" }
+      MetadataRegexp = /^# -\*- (.+) \((\d+\.\d+)\) \[(.+)\] -\*-$/
 
-        @file_basename = options[:filename] || default_filename
-        options[:filename] = @file_basename
 
+      setup do |options|
         @date = nil # default; do not override --R
+
+        self.date_pattern = options.fetch( :date_pattern, DefaultDatePattern )
+        self.symlink_original_filename = options.fetch( :symlink_original_filename, false )
+        self.keep = options.fetch( :keep, 0 )
+
+        @original_filename  = options.fetch( :filename, default_filename )
+        options[:filename]  = @original_filename
       end
 
       write do |event|
-        if close?
-          close
+        return unless close? # do nothing when not closing
+        close
 
-          unless ::File.exist?( @filename )
-            cleanup if keep > 0
+        return if ::File.exist?( @filename ) # do nothing when file ready present
 
-            stream.print( "# -*- #{@date.iso8601} (#{@date.to_f}) [#{date_pattern}] -*-\n" )
-          end
-        end
+        cleanup! if cleanup?
+        symlink_original_filename! if symlink_original_filename
+
+        stream.puts( Metadata.call(@date, date_pattern) )
       end
 
       close do
@@ -37,20 +43,32 @@ module Yell #:nodoc:
       end
 
 
-      # Accesor to the date_pattern
+      # The pattern to be used for the files
+      #
+      # @example
+      #   date_pattern = "%Y%m%d"       # default
+      #   date_pattern = "%Y-week-%V"
       attr_accessor :date_pattern
 
-      # Accessor to keep
-      attr_reader :keep
+      # Tell the adapter to create a symlink onto the currently 
+      # active (timestamped) file. Upon rollover, the symlink is 
+      # set to the newly created file, and so on.
+      #
+      # @example
+      #   symlink_original_filename = true
+      attr_accessor :symlink_original_filename
 
-      # Set the amount of logfiles to keep when rolling over
+      # Set the amount of logfiles to keep when rolling over.
+      # By default, no files will be cleaned up.
       #
       # @example Keep the last 5 logfiles
       #   keep = 5
       #   keep = '10'
-      def keep=( val )
-        @keep = val.to_i
-      end
+      #
+      # @example Do not clean up any files
+      #   keep = 0
+      attr_accessor :keep
+
 
       private
 
@@ -60,9 +78,6 @@ 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
 
@@ -75,27 +90,32 @@ module Yell #:nodoc:
       end
 
       # Cleanup old files
-      def cleanup
-        files = Dir[ @file_basename.sub( /(\.\w+)?$/, ".*\\1" ) ].map do |f|
+      def cleanup!
+        files = Dir[ @original_filename.sub( /(\.\w+)?$/, ".*\\1" ) ].map do |f|
           [ f, metadata_from(f).last ]
         end.select do |(_, p)|
-          @date_pattern == p
+          date_pattern == p
         end
 
-        ::File.unlink( *files.map(&:first)[0..-(@keep)] )
+        ::File.unlink( *files.map(&:first)[0..-keep] )
       end
 
       def cleanup?
-       !keep
+        keep.to_i > 0
+      end
+
+      def symlink_original_filename!
+        ::File.unlink( @original_filename ) if ::File.symlink?( @original_filename )
+        ::File.symlink( @filename, @original_filename )
       end
 
       # Sets the filename with the `:date_pattern` appended to it.
       def filename_from( date )
-        @file_basename.sub( /(\.\w+)?$/, ".#{date.strftime(@date_pattern)}\\1" )
+        @original_filename.sub( /(\.\w+)?$/, ".#{date.strftime(date_pattern)}\\1" )
       end
 
       def metadata_from( file )
-        if m = ::File.open( file, &:readline ).match( /^# -\*- (.+) \((\d+\.\d+)\) \[(.+)\] -\*-$/ )
+        if m = ::File.open( file, &:readline ).match( MetadataRegexp )
           [ Time.at( m[2].to_f ), m[3] ]
         else
           [ ::File.mtime( file ), "" ]

data/lib/yell/adapters/file.rb

@@ -8,7 +8,7 @@ module Yell #:nodoc:
     class File < Yell::Adapters::Io
 
       setup do |options|
-        @filename = options.fetch(:filename, default_filename)
+        @filename = options.fetch( :filename, default_filename )
       end
 
 

data/lib/yell/logger.rb

@@ -6,31 +6,31 @@ module Yell #:nodoc:
   #
   # A +Yell::Logger+ instance holds all your adapters and sends the log events 
   # to them if applicable. There are multiple ways of how to create a new logger.
-  #
-  # @example A standard file logger
-  #   Yell::Logger.new
-  #   Yell::Logger.new 'development.log'
-  #
-  # @example A standard datefile logger
-  #   Yell::Logger.new :datefile
-  #   Yell::Logger.new :datefile, 'development.log'
-  #
-  # @example Setting the log level
-  #   Yell::Logger.new :level => :warn
-  #
-  #   Yell::Logger.new do |l|
-  #     l.level = :warn
-  #   end
-  #
-  # @example Combined settings
-  #   Yell::Logger.new 'development.log', :level => :warn
-  #
-  #   Yell::Logger.new :datefile, 'development.log' do |l|
-  #     l.level = :info
-  #   end
   class Logger
     include Yell::Level::Helpers
 
+    # Initialize a new Logger
+    #
+    # @example A standard file logger
+    #   Yell::Logger.new 'development.log'
+    #
+    # @example A standard datefile logger
+    #   Yell::Logger.new :datefile
+    #   Yell::Logger.new :datefile, 'development.log'
+    #
+    # @example Setting the log level
+    #   Yell::Logger.new :level => :warn
+    #
+    #   Yell::Logger.new do |l|
+    #     l.level = :warn
+    #   end
+    #
+    # @example Combined settings
+    #   Yell::Logger.new 'development.log', :level => :warn
+    #
+    #   Yell::Logger.new :datefile, 'development.log' do |l|
+    #     l.level = :info
+    #   end
     def initialize( *args, &block )
       @adapters = []
 

data/lib/yell/version.rb

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

data/spec/yell/adapters/datefile_spec.rb

@@ -28,7 +28,7 @@ describe Yell::Adapters::Datefile do
       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
+      it "should rotate when date has passed" do
         mock( File ).open( datefile_filename, anything ) { File.new('/dev/null', 'w') }
         adapter.write( event )
 
@@ -41,9 +41,9 @@ describe Yell::Adapters::Datefile do
   end
 
   describe :keep do
-    let( :adapter ) { Yell::Adapters::Datefile.new(:keep => 2, :filename => filename, :date_pattern => "%M" ) }
+    let( :adapter ) { Yell::Adapters::Datefile.new(:keep => 2, :filename => filename, :date_pattern => "%M") }
 
-    it "should keep the specified number or files upon wollover" do
+    it "should keep the specified number or files upon rollover" do
       adapter.write( event )
       Dir[ fixture_path + '/*.log' ].size.should == 1
 
@@ -59,6 +59,27 @@ describe Yell::Adapters::Datefile do
     end
   end
 
+  describe :symlink_original_filename do
+    let( :adapter ) { Yell::Adapters::Datefile.new(:symlink_original_filename => true, :filename => filename, :date_pattern => "%M") }
+    let( :time ) { Time.now }
+
+    it "should symlink to the orignal given :filename" do
+      Timecop.freeze( time ) do
+        adapter.write( event )
+
+        File.symlink?( filename ).should be_true
+        File.readlink( filename ).should == datefile_filename( adapter.date_pattern )
+      end
+
+      Timecop.freeze( time + 60 ) do
+        adapter.write( event )
+
+        File.symlink?( filename ).should be_true
+        File.readlink( filename ).should == datefile_filename( adapter.date_pattern )
+      end
+    end
+  end
+
 
   private
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yell
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-21 00:00:00.000000000 Z
+date: 2012-06-29 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