yell 0.4.0 → 0.4.1

data/lib/yell.rb

@@ -22,6 +22,7 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 require 'time'
+require 'socket'
 
 begin
   require 'yell/event'

data/lib/yell/adapters.rb

@@ -45,6 +45,7 @@ module Yell #:nodoc:
   end
 end
 
+# Base for all adapters
 require 'yell/adapters/base'
 
 # IO based adapters

data/lib/yell/adapters/datefile.rb

@@ -18,22 +18,39 @@ module Yell #:nodoc:
 
         @date = nil # default; do not override --R
 
+        keep options[:keep]
+
         super
       end
 
       # @overload Reset the file handle
       def close
-        @filename = new_filename
+        @filename = filename_from( @date )
 
         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 )
-        close if close?
+        if close?
+          close
+
+          unless ::File.exist?( @filename )
+            cleanup if cleanup?
+
+            stream.print( "# -*- #{@date.iso8601} (#{@date.to_f}) [#{@date_pattern}] -*-\n" )
+          end
+        end
 
         super( event )
       end
@@ -44,8 +61,12 @@ 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 )
+        _date = Time.now
+
         if !@stream or _date != @date
           @date = _date
           return true
@@ -54,9 +75,31 @@ 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 new_filename
-        @file_basename.sub( /(\.\w+)?$/, ".#{@date}\\1" )
+      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
@@ -65,3 +108,4 @@ module Yell #:nodoc:
 
   end
 end
+

data/lib/yell/adapters/io.rb

@@ -67,7 +67,7 @@ module Yell
 
         stream.print( message )
         stream.flush
-      rescue => e
+      rescue Exception => e
         close
 
         # re-raise the exception

data/lib/yell/event.rb

@@ -21,6 +21,12 @@ module Yell #:nodoc:
     # Accessor to the method the log event occured
     attr_reader :method
 
+    # Accessor to the hostname
+    attr_reader :hostname
+
+    # Accessor to the pid
+    attr_reader :pid
+
 
     # Initialize a new log event
     def initialize( level, message = nil, &block )
@@ -28,6 +34,16 @@ module Yell #:nodoc:
       @level    = level
       @message  = block ? block.call : message
 
+      @hostname = Socket.gethostname rescue nil
+      @pid      = Process.pid
+
+      _initialize_caller
+    end
+
+
+    private
+
+    def _initialize_caller
       if m = CallerRegexp.match( caller(4).first )
         @file, @line, @method = m[1..-1]
       else

data/lib/yell/formatter.rb

@@ -51,16 +51,16 @@ module Yell #:nodoc:
   class Formatter
 
     PatternTable = {
-      "m" => "event.message",                 # Message
-      "l" => "event.level[0,1]",              # Level (short), e.g.'I', 'W'
-      "L" => "event.level",                   # Level, e.g. 'INFO', 'WARN'
-      "d" => "date(event)",                   # ISO8601 Timestamp
-      "p" => "Process.pid",                   # PID
-      "h" => "hostname",                      # Hostname
-      "F" => "event.file",                    # Path with filename where the logger was called
-      "f" => "File.basename(event.file)",     # Filename where the loger was called
-      "M" => "event.method",                  # Method name where the logger was called
-      "n" => "event.line"                     # Line where the logger was called
+      "m" => "event.message",              # Message
+      "l" => "event.level[0,1]",           # Level (short), e.g.'I', 'W'
+      "L" => "event.level",                # Level, e.g. 'INFO', 'WARN'
+      "d" => "date(event)",                # ISO8601 Timestamp
+      "p" => "event.pid",                  # PID
+      "h" => "event.hostname",             # Hostname
+      "F" => "event.file",                 # Path with filename where the logger was called
+      "f" => "File.basename(event.file)",  # Filename where the loger was called
+      "M" => "event.method",               # Method name where the logger was called
+      "n" => "event.line"                  # Line where the logger was called
     }
 
     PatternRegexp = /([^%]*)(%\d*)?([#{PatternTable.keys.join}])?(.*)/
@@ -107,12 +107,6 @@ module Yell #:nodoc:
       @date_pattern ? event.time.strftime( @date_pattern ) : event.time.iso8601
     end
 
-    def hostname
-      require 'socket' unless defined? Socket
-
-      Socket.gethostname rescue nil
-    end
-
   end
 end
 

data/lib/yell/level.rb

@@ -28,6 +28,8 @@ module Yell #:nodoc:
   #   Yell::Level.new.at(:info)
   class Level
 
+    attr_reader :severities
+
     # Create a new level instance.
     #
     # @example Enable all severities
@@ -47,6 +49,7 @@ module Yell #:nodoc:
       @severities = Yell::Severities.map { true } # all levels allowed by default
 
       case severity
+        when Yell::Level then @severities = severity.severities
         when Array then at( *severity )
         when Range then gte(severity.first).lte(severity.last)
         when Integer, String, Symbol then gte(severity)

data/lib/yell/logger.rb

@@ -34,8 +34,7 @@ module Yell #:nodoc:
       @options = args.last.is_a?(Hash) ? args.pop : {}
 
       # set the log level when given
-      # level @options[:level] if @options[:level]
-      level @options[:level] # default
+      level @options[:level]
 
       # check if filename was given as argument and put it into the @options
       if args.last.is_a?( String )
@@ -45,9 +44,6 @@ module Yell #:nodoc:
       # extract adapter
       adapter args.pop if args.any?
 
-      # set the log level when given
-      level @options[:level] if @options[:level]
-
       # eval the given block
       instance_eval( &block ) if block
 

data/lib/yell/version.rb

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

data/spec/yell/event_spec.rb

@@ -4,14 +4,12 @@ describe Yell::Event do
   let(:event) { Yell::Event.new 'INFO', 'Hello World!' }
 
   context :level do
-    subject { event.level}
-
+    subject { event.level }
     it { should == 'INFO' }
   end
 
   context :message do
     subject { event.message }
-
     it { should == 'Hello World!' }
   end
 
@@ -27,6 +25,16 @@ describe Yell::Event do
     it { should == time }
   end
 
+  context :hostname do
+    subject { event.hostname }
+    it { should == Socket.gethostname }
+  end
+
+  context :pid do
+    subject { event.pid }
+    it { should == Process.pid }
+  end
+
   context :caller do
     let(:file) { "event.rb" }
     let(:line) { "123" }
@@ -40,19 +48,16 @@ describe Yell::Event do
 
     context :file do
       subject { event.file }
-
       it  { should == file }
     end
 
     context :line do
       subject { event.line }
-
       it { should == line }
     end
 
     context :method do
       subject { event.method }
-
       it { should == method }
     end
   end

data/spec/yell/formatter_spec.rb

@@ -14,37 +14,31 @@ describe Yell::Formatter do
 
   context "%m" do
     subject { "%m" }
-
     it { format.should == "Hello World!" }
   end
 
   context "%l" do
     subject { "%l" }
-
     it { format.should == "I" }
   end
 
   context "%L" do
     subject { "%L" }
-
     it { format.should == "INFO" }
   end
 
   context "%d" do
     subject { "%d" }
-
     it { format.should == time.iso8601 }
   end
 
   context "%p" do
     subject { "%p" }
-
     it { format.should == Process.pid.to_s }
   end
 
   context "%h" do
     subject { "%h" }
-
     it { format.should == Socket.gethostname }
   end
 
@@ -59,44 +53,37 @@ describe Yell::Formatter do
 
     context "%F" do
       subject { "%F" }
-
       it { format.should == "/path/to/file.rb" }
     end
 
     context "%f" do
       subject { "%f" }
-
       it { format.should == "file.rb" }
     end
 
     context "%M" do
       subject { "%M" }
-
       it { format.should == "test_method" }
     end
 
     context "%n" do
       subject { "%n" }
-
       it { format.should == "123" }
     end
   end
 
   context "DefaultFormat" do
     subject { Yell::DefaultFormat }
-
     it { format.should == "#{time.iso8601} [ INFO] #{$$} : Hello World!"  }
   end
 
   context "BasicFormat" do
     subject { Yell::BasicFormat }
-
     it { format.should == "I, #{time.iso8601} : Hello World!"  }
   end
 
   context "ExtendedFormat" do
     subject { Yell::ExtendedFormat }
-
     it { format.should == "#{time.iso8601} [ INFO] #{$$} #{Socket.gethostname} : Hello World!" }
   end
 

data/spec/yell/level_spec.rb

@@ -67,9 +67,7 @@ describe Yell::Level do
   end
 
   context "given an Array" do
-    let( :level ) { Yell::Level.new(subject) }
-
-    subject { [:debug, :warn, :fatal] }
+    let( :level ) { Yell::Level.new( [:debug, :warn, :fatal] ) }
 
     it { level.at?(:debug).should be_true }
     it { level.at?(:info).should be_false }
@@ -79,9 +77,7 @@ describe Yell::Level do
   end
 
   context "given a Range" do
-    let( :level ) { Yell::Level.new(subject) }
-
-    subject { (1..3) }
+    let( :level ) { Yell::Level.new( (1..3) ) }
 
     it { level.at?(:debug).should be_false }
     it { level.at?(:info).should be_true }
@@ -90,4 +86,13 @@ describe Yell::Level do
     it { level.at?(:fatal).should be_false }
   end
 
+  context "given a Yell::Level instance" do
+    let( :level ) { Yell::Level.new( :warn ) }
+
+    it { level.at?(:debug).should be_false }
+    it { level.at?(:info).should be_false }
+    it { level.at?(:warn).should be_true }
+    it { level.at?(:error).should be_true }
+    it { level.at?(:fatal).should be_true }
+  end
 end

data/spec/yell/logger_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+
+describe Yell::Logger do
+
+  context "a Logger instance" do
+    let( :logger ) { Yell::Logger.new }
+
+    context "log methods" do
+      subject { logger }
+
+      it { should respond_to :debug }
+      it { should respond_to :debug? }
+
+      it { should respond_to :info }
+      it { should respond_to :info? }
+
+      it { should respond_to :warn }
+      it { should respond_to :warn? }
+
+      it { should respond_to :error }
+      it { should respond_to :error? }
+
+      it { should respond_to :fatal }
+      it { should respond_to :fatal? }
+
+      it { should respond_to :unknown }
+      it { should respond_to :unknown? }
+    end
+
+    context "default adapter" do
+      let( :adapters ) { logger.instance_variable_get :@adapters }
+
+      it { adapters.size.should == 1 }
+      it { adapters.first.should be_kind_of Yell::Adapters::File }
+    end
+  end
+
+  context "a Logger instance with a given :filename" do
+    it "should call adapter with :file" do
+      mock.proxy( Yell::Adapters::File ).new( anything )
+
+      Yell::Logger.new
+    end
+  end
+
+  context "a Logger instance with a given :stdout adapter" do
+    before do
+      mock.proxy( Yell::Adapters::Stdout ).new( anything )
+    end
+
+    it "should call adapter with :stdout" do
+      Yell::Logger.new STDOUT
+    end
+
+    it "should call adapter with :stdout" do
+      Yell::Logger.new :stdout
+    end
+  end
+
+  context "a Logger instance with a given :stderr adapter" do
+    before do
+      mock.proxy( Yell::Adapters::Stderr ).new( anything )
+    end
+
+    it "should call adapter with :stderr" do
+      Yell::Logger.new STDERR
+    end
+
+    it "should call adapter with :stderr" do
+      Yell::Logger.new :stderr
+    end
+  end
+
+end
+

metadata

@@ -1,96 +1,96 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: yell
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.4.1
   prerelease: 
-  version: 0.4.0
 platform: ruby
-authors: 
-  - Rudolf Schmidt
+authors:
+- Rudolf Schmidt
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-03-27 00:00:00 Z
-dependencies: 
-  - !ruby/object:Gem::Dependency 
-    name: rr
-    prerelease: false
-    requirement: &id001 !ruby/object:Gem::Requirement 
-      none: false
-      requirements: 
-        - - ">="
-          - !ruby/object:Gem::Version 
-            version: "0"
-    type: :development
-    version_requirements: *id001
-description: An easy to use logging library to log into files and any other self-defined adapters
+date: 2012-03-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rr
+  requirement: &70163680872100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        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
 email: 
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-  - .gitignore
-  - .travis.yml
-  - Gemfile
-  - LICENSE.txt
-  - README.md
-  - Rakefile
-  - examples/001-basic-usage.rb
-  - examples/002.1-log-level-basics.rb
-  - examples/002.2-log-level-on-certain-severities-only.rb
-  - examples/002.3-log-level-within-range.rb
-  - examples/003.1-formatting-DefaultFormat.rb
-  - examples/003.2-formatting-BasicFormat.rb
-  - examples/003.3-formatting-ExtendedFormat.rb
-  - examples/003.4-formatting-on-your-own.rb
-  - lib/yell.rb
-  - lib/yell/adapters.rb
-  - lib/yell/adapters/base.rb
-  - lib/yell/adapters/datefile.rb
-  - lib/yell/adapters/file.rb
-  - lib/yell/adapters/io.rb
-  - lib/yell/adapters/streams.rb
-  - lib/yell/event.rb
-  - lib/yell/formatter.rb
-  - lib/yell/level.rb
-  - lib/yell/logger.rb
-  - lib/yell/version.rb
-  - spec/spec_helper.rb
-  - spec/yell/event_spec.rb
-  - spec/yell/formatter_spec.rb
-  - spec/yell/level_spec.rb
-  - spec/yell_spec.rb
-  - yell.gemspec
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/001-basic-usage.rb
+- examples/002.1-log-level-basics.rb
+- examples/002.2-log-level-on-certain-severities-only.rb
+- examples/002.3-log-level-within-range.rb
+- examples/003.1-formatting-DefaultFormat.rb
+- examples/003.2-formatting-BasicFormat.rb
+- examples/003.3-formatting-ExtendedFormat.rb
+- examples/003.4-formatting-on-your-own.rb
+- lib/yell.rb
+- lib/yell/adapters.rb
+- lib/yell/adapters/base.rb
+- lib/yell/adapters/datefile.rb
+- lib/yell/adapters/file.rb
+- lib/yell/adapters/io.rb
+- lib/yell/adapters/streams.rb
+- lib/yell/event.rb
+- lib/yell/formatter.rb
+- lib/yell/level.rb
+- lib/yell/logger.rb
+- lib/yell/version.rb
+- spec/spec_helper.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
+- yell.gemspec
 homepage: http://rubygems.org/gems/yell
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
-  - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: yell
-rubygems_version: 1.8.9
+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/event_spec.rb
+- spec/yell/formatter_spec.rb
+- spec/yell/level_spec.rb
+- spec/yell/logger_spec.rb
+- spec/yell_spec.rb
 has_rdoc: