yell 0.7.0 → 0.8.0

data/lib/yell/adapters/base.rb

@@ -1,14 +1,10 @@
 # encoding: utf-8
 
-require 'monitor'
+require 'thread'
 
 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}.
@@ -117,10 +113,9 @@ module Yell #:nodoc:
       #
       # You should not overload the constructor, use #setup instead.
       def initialize( options = {}, &block )
-        @mutex = Yell::Adapters::Mutex.new
+        @mutex = Mutex.new
 
         setup!(options)
-
         block.call(self) if block
       end
 

data/lib/yell/adapters/io.rb

@@ -10,13 +10,13 @@ module Yell #:nodoc:
 
       # The possible unix log colors
       Colors = {
-        'DEBUG'   => "\e[32;1m",  # green;bold
-        # 'INFO'    => "\e[0m",     # white
-        'WARN'    => "\e[33;1m",  # yello;bold
-        'ERROR'   => "\e[31;1m",  # red;bold
-        'FATAL'   => "\e[35;1m",  # magenta;bold
-        'UNKNOWN' => "\e[36m",    # cyan
-        'DEFAULT' => "\e[0m"      # NONE
+        0   => "\e[32;1m",  # green;bold
+        # 1   => "\e[0m",     # white
+        2   => "\e[33;1m",  # yello;bold
+        3   => "\e[31;1m",  # red;bold
+        4   => "\e[35;1m",  # magenta;bold
+        5   => "\e[36m",    # cyan
+        -1  => "\e[0m"      # NONE
       }
 
       setup do |options|
@@ -31,7 +31,7 @@ module Yell #:nodoc:
 
         # colorize if applicable
         if colors and color = Colors[event.level]
-          message = color + message + Colors['DEFAULT']
+          message = color + message + Colors[-1]
         end
 
         message << "\n" unless message[-1] == ?\n # add new line if there is none

data/lib/yell/event.rb

@@ -1,9 +1,23 @@
 # encoding: utf-8
 
+require 'time'
+require 'socket'
+
 module Yell #:nodoc:
 
   class Event
-    CallerRegexp = /^(.+?):(\d+)(?::in `(.+)')?/
+    # regex to fetch caller attributes
+    @@caller_regexp = /^(.+?):(\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
+    end
+
+    # Prefetch those values (no need to do that on every new instance)
+    @@hostname  = Socket.gethostname rescue nil
+    @@pid       = Process.pid
 
     # Accessor to the log level
     attr_reader :level
@@ -14,21 +28,6 @@ module Yell #:nodoc:
     # Accessor to the time the log event occured
     attr_reader :time
 
-    # Accessor to filename the log event occured
-    attr_reader :file
-
-    # Accessor to the line the log event occured
-    attr_reader :line
-
-    # 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
-
     # Accessor to the current tread_id
     attr_reader :thread_id
 
@@ -38,18 +37,47 @@ module Yell #:nodoc:
       @level    = level
       @message  = block ? block.call : message
 
-      @hostname   = Socket.gethostname rescue nil
-      @pid        = Process.pid
       @thread_id  = Thread.current.object_id
 
-      _initialize_caller
+      @caller = caller[@@caller_index].to_s
+      @file   = nil
+      @line   = nil
+      @method = nil
+    end
+
+    # Accessor to the pid
+    def hostname
+      @@hostname
+    end
+
+    # Accessor to the hostname
+    def pid
+      @@pid
+    end
+
+    # Accessor to filename the log event occured
+    def file
+      _caller! if @file.nil?
+      @file
+    end
+
+    # Accessor to the line the log event occured
+    def line
+      _caller! if @line.nil?
+      @line
+    end
+
+    # Accessor to the method the log event occured
+    def method
+      _caller! if @method.nil?
+      @method
     end
 
 
     private
 
-    def _initialize_caller
-      if m = CallerRegexp.match( caller(4).first )
+    def _caller!
+      if m = @@caller_regexp.match( @caller )
         @file, @line, @method = m[1..-1]
       else
         @file, @line, @method = ['', '', '']

data/lib/yell/formatter.rb

@@ -1,5 +1,7 @@
 # encoding: utf-8
 
+require 'time'
+
 module Yell #:nodoc:
 
   # No format on the log message
@@ -59,9 +61,9 @@ module Yell #:nodoc:
     end
 
     PatternTable = {
-      "m" => "event.message",              # Message
-      "l" => "event.level[0,1]",           # Level (short), e.g.'I', 'W'
-      "L" => "event.level",                # Level, e.g. 'INFO', 'WARN'
+      "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
       "h" => "event.hostname",             # Hostname
       "p" => "event.pid",                  # PID
@@ -100,7 +102,7 @@ module Yell #:nodoc:
         buff << match[1] unless match[1].empty?
         break if match[2].nil?
 
-        buff << match[2] + 's' # '%s'
+        buff << match[2] + 's'
         args << PatternTable[ match[3] ]
 
         _pattern = match[4]
@@ -113,6 +115,19 @@ module Yell #:nodoc:
       -
     end
 
+    def message( event )
+      return event.message unless event.message.is_a? Exception
+
+      exception = event.message
+      backtrace = exception.backtrace ? "\n\t#{exception.backtrace.join("\n\t")}" : ""
+
+      "%s: %s%s" % [exception.class, exception.message, backtrace]
+    end
+
+    def level( event )
+      Yell::Severities[ event.level ]
+    end
+
     def date( event )
       @date_pattern ? event.time.strftime( @date_pattern ) : event.time.iso8601
     end

data/lib/yell/logger.rb

@@ -49,8 +49,8 @@ module Yell #:nodoc:
       self.adapter args.pop if args.any?
 
       # eval the given block
-      block.call(self) if block
-      # _call( &block ) if block
+      # block.call(self) if block
+      _call( &block ) if block
 
       # default adapter when none defined
       adapter :file if @adapters.empty?
@@ -118,15 +118,15 @@ module Yell #:nodoc:
       name = s.downcase
 
       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 )
-          return unless #{name}?                  #   return unless info?
-                                                  #
-          write Yell::Event.new( '#{s}', m, &b )  #   write Yell::Event.new( "INFO", m, &b )
-                                                  #
-          true                                    #   true
-        end                                       # end
+        def #{name}?; @level.at?(#{index}); end     # def info?; @level.at?(1); end
+                                                    #
+        def #{name}( m = nil, &b )                  # def info( m = nil, &b )
+          return unless #{name}?                    #   return unless info?
+                                                    #
+          write Yell::Event.new( #{index}, m, &b )  #   write Yell::Event.new( 1, m, &b )
+                                                    #
+          true                                      #   true
+        end                                         # end
       EOS
     end
 

data/lib/yell/version.rb

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

data/lib/yell.rb

@@ -21,9 +21,6 @@
 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
-require 'time'
-require 'socket'
-
 module Yell #:nodoc:
   Severities = [ 'DEBUG', 'INFO', 'WARN', 'ERROR', 'FATAL', 'UNKNOWN' ]
 

data/spec/yell/adapters/base_spec.rb

@@ -39,7 +39,7 @@ describe Yell::Adapters::Base do
     subject { Yell::Adapters::Base.new :level => :info }
 
     it "should delegate :event to :write!" do
-      event = Yell::Event.new( "INFO", "Hello World!" )
+      event = Yell::Event.new( 1, "Hello World!" )
 
       mock( subject ).write!( event )
 
@@ -47,7 +47,7 @@ describe Yell::Adapters::Base do
     end
 
     it "should not write when event does not have the right level" do
-      event = Yell::Event.new( "DEBUG", "Hello World!" )
+      event = Yell::Event.new( 0, "Hello World!" )
 
       dont_allow( subject ).write!( event )
 

data/spec/yell/adapters/datefile_spec.rb

@@ -4,7 +4,7 @@ describe Yell::Adapters::Datefile do
   let( :time ) { Time.now }
   let( :filename ) { 'filename.log' }
 
-  let( :event ) { Yell::Event.new("INFO", "Hello World") }
+  let( :event ) { Yell::Event.new(1, "Hello World") }
 
   describe :filename do
     let( :adapter ) { Yell::Adapters::Datefile.new(:filename => filename) }

data/spec/yell/adapters/file_spec.rb

@@ -16,7 +16,7 @@ describe Yell::Adapters::File do
   end
 
   context :write do
-    let( :event ) { Yell::Event.new("INFO", "Hello World") }
+    let( :event ) { Yell::Event.new(1, "Hello World") }
 
     context "default filename" do
       let( :filename ) { "#{Yell.env}.log" }

data/spec/yell/adapters/io_spec.rb

@@ -47,7 +47,7 @@ describe Yell::Adapters::Io do
   end
 
   context :write do
-    let( :event ) { Yell::Event.new("INFO", "Hello World") }
+    let( :event ) { Yell::Event.new(1, "Hello World") }
     let( :adapter ) { Yell::Adapters::Io.new }
     let( :stream ) { File.new('/dev/null', 'w') }
 

data/spec/yell/event_spec.rb

@@ -1,11 +1,46 @@
 require 'spec_helper'
 
+# Since Yell::Event.new is not called directly, but through
+# the logger methods, we need to divert here in order to get 
+# the correct caller.
+class EventFactory
+  def self.event( level, message )
+    self._event( level, message )
+  end
+
+  private
+
+  def self._event( level, message )
+    Yell::Event.new level, message
+  end
+
+end
+
 describe Yell::Event do
-  let(:event) { Yell::Event.new 'INFO', 'Hello World!' }
+  context :caller do
+    let( :event ) { EventFactory.event 1, "Hello World" }
+
+    context :file do
+      subject { event.file }
+      it  { should == __FILE__ }
+    end
+
+    context :line do
+      subject { event.line }
+      it { should == "8" }
+    end
+
+    context :method do
+      subject { event.method }
+      it { should == 'event' }
+    end
+  end
+
+  let(:event) { Yell::Event.new 1, 'Hello World!' }
 
   context :level do
     subject { event.level }
-    it { should == 'INFO' }
+    it { should == 1 }
   end
 
   context :message do
@@ -35,31 +70,4 @@ describe Yell::Event do
     it { should == Process.pid }
   end
 
-  context :caller do
-    let(:file) { "event.rb" }
-    let(:line) { "123" }
-    let(:method) { "test_method" }
-
-    before do
-      any_instance_of( Yell::Event ) do |e|
-        mock( e ).caller(4) { ["#{file}:#{line}:in `#{method}'"] }
-      end
-    end
-
-    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
-
 end

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 'INFO', 'Hello World!' }
+  let( :event ) { Yell::Event.new 1, 'Hello World!' }
   let( :time ) { Time.now }
 
   let( :format ) { formatter.format(event) }
@@ -48,11 +48,13 @@ describe Yell::Formatter do
   end
 
   context "caller" do
-    let( :_caller ) { ["/path/to/file.rb:123:in `test_method'"] }
+    let( :_caller ) { [nil, nil, "/path/to/file.rb:123:in `test_method'"] }
 
     before do
       any_instance_of( Yell::Event ) do |e|
-        mock(e).caller(4) { _caller }
+        stub(e).file { "/path/to/file.rb" }
+        stub(e).line { "123" }
+        stub(e).method { "test_method" }
       end
     end
 
@@ -92,4 +94,17 @@ describe Yell::Formatter do
     it { format.should == "#{time.iso8601} [ INFO] #{$$} #{Socket.gethostname} : Hello World!" }
   end
 
+  context "Exceptions" do
+    let( :exception ) { StandardError.new( "message" ) }
+    let( :event ) { Yell::Event.new( 1, exception ) }
+
+    subject { "%m" }
+
+    before do
+      mock( exception ).backtrace.times(any_times) { ["backtrace"] }
+    end
+
+    it { format.should == "#{exception.class}: #{exception.message}\n\tbacktrace" }
+  end
+
 end

data/spec/yell/logger_spec.rb

@@ -1,5 +1,17 @@
 require 'spec_helper'
 
+class LoggerFactory
+  attr_accessor :logger
+
+  def foo
+    logger.info :foo
+  end
+
+  def bar
+    logger.info :bar
+  end
+end
+
 describe Yell::Logger do
 
   context "a Logger instance" do
@@ -35,7 +47,7 @@ describe Yell::Logger do
     end
   end
 
-  context "a Logger instance with a given :filename" do
+  context "initialize with a :filename" do
     it "should call adapter with :file" do
       mock.proxy( Yell::Adapters::File ).new( :filename => 'test.log' )
 
@@ -43,7 +55,7 @@ describe Yell::Logger do
     end
   end
 
-  context "a Logger instance with a given :stdout adapter" do
+  context "initialize with a :stdout adapter" do
     before do
       mock.proxy( Yell::Adapters::Stdout ).new( anything )
     end
@@ -57,7 +69,7 @@ describe Yell::Logger do
     end
   end
 
-  context "a Logger instance with a given :stderr adapter" do
+  context "initialize with a :stderr adapter" do
     before do
       mock.proxy( Yell::Adapters::Stderr ).new( anything )
     end
@@ -71,7 +83,7 @@ describe Yell::Logger do
     end
   end
 
-  context "a Logger instance with a given block" do
+  context "initialize with a block" do
     let( :level ) { Yell::Level.new :error }
     let( :adapter ) { Yell::Adapters::Stdout.new }
 
@@ -94,5 +106,20 @@ describe Yell::Logger do
     end
   end
 
+  context "caller's :file, :line and :method" do
+    let( :adapter ) { Yell::Adapters::Stdout.new :format => "%F, %n: %M" }
+    let( :logger ) { Yell::Logger.new { |l| l.adapter adapter } }
+
+    it "should write correctly" do
+      factory = LoggerFactory.new
+      factory.logger = logger
+
+      mock( adapter.send(:stream) ).write( "#{__FILE__}, 7: foo\n" )
+      mock( adapter.send(:stream) ).write( "#{__FILE__}, 11: bar\n" )
+
+      factory.foo
+      factory.bar
+    end
+  end
 end
 

metadata

@@ -1,56 +1,67 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: yell
-version: !ruby/object:Gem::Version
-  version: 0.7.0
-  prerelease: 
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 8
+  - 0
+  version: 0.8.0
 platform: ruby
-authors:
+authors: 
 - Rudolf Schmidt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-21 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2012-04-24 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: rspec
-  requirement: &70348235288880 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
   prerelease: false
-  version_requirements: *70348235288880
-- !ruby/object:Gem::Dependency
-  name: rr
-  requirement: &70348235288440 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
   type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rr
   prerelease: false
-  version_requirements: *70348235288440
-- !ruby/object:Gem::Dependency
-  name: timecop
-  requirement: &70348235288020 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
   type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: timecop
   prerelease: false
-  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
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+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: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
 - .travis.yml
 - Gemfile
@@ -91,31 +102,37 @@ files:
 - spec/yell/logger_spec.rb
 - spec/yell_spec.rb
 - yell.gemspec
+has_rdoc: true
 homepage: http://rudionrails.github.com/yell
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+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
-  none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: yell
-rubygems_version: 1.8.17
+rubygems_version: 1.3.6
 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
@@ -128,4 +145,3 @@ test_files:
 - spec/yell/level_spec.rb
 - spec/yell/logger_spec.rb
 - spec/yell_spec.rb
-has_rdoc: