yell 0.2.0 → 0.3.0

data/Gemfile

@@ -7,6 +7,6 @@ gemspec
 group :development do
   gem "rake"
 
-  gem "rspec"
+  gem "rspec", "~> 2"
   gem "timecop"
-end
+end

data/README.md

@@ -23,29 +23,11 @@ message as follows:
 logger = Yell.new STDOUT
 
 logger.info "Hello World"
-"2012-02-29T09:30:00+01:00 [ INFO] 65784 : Hello World"
-#^                         ^       ^       ^
-#ISO8601 Timestamp         Level   Pid     message
+#=> "2012-02-29T09:30:00+01:00 [ INFO] 65784 : Hello World"
+#    ^                         ^       ^       ^
+#    ISO8601 Timestamp         Level   Pid     Message
 ```
 
-You can alternate the formatting, or completely disable it altogether. See the 
-next examples for reference:
-
-```ruby
-# No formatting
-logger = Yell.new STDOUT, :format => false
-logger.info "No formatting"
-"No formatting"
-
-# Alternate formatting
-logger = Yell.new STDOUT, :format => "'%m' at %d"
-logger.info "Alternate formatting"
-"'Alternate format' at 2012-02-29T09:30:00+01:00"
-```
-
-As you can see, it basically is just string interpolation with a few reserved 
-captures. You can see the list at #Yell::Formatter.
-
 When no arguments are given, Yell will check for `ENV['RACK_ENV']` and 
 determine the filename from that.
 
@@ -57,8 +39,11 @@ a filename explicitly.
 Naturally, if you pass a `:filename` to Yell:
 
 ```ruby
-logger = Yell.new 'custom.log'
+logger = Yell.new 'yell.log'
 ```
 
+Please refer to the wiki for further usage examples:  
+https://github.com/rudionrails/yell/wiki/
+
 Copyright © 2011-2012 Rudolf Schmidt, released under the MIT license
 

data/lib/yell.rb

@@ -23,35 +23,35 @@
 
 require 'time'
 
-$: << File.dirname(__FILE__)
+begin
+  require 'yell/event'
+rescue LoadError
+  $: << File.dirname(__FILE__)
+  require 'yell/event'
+end
 
+require 'yell/level'
 require 'yell/formatter'
 require 'yell/adapters'
-require 'yell/level'
 require 'yell/logger'
 
 module Yell #:nodoc:
   # The possible log levels
   Severities = [ 'DEBUG', 'INFO', 'WARN', 'ERROR', 'FATAL', 'UNKNOWN' ]
 
-  extend self
-
-  # Creates a new logger instance.
-  #
-  # Refer to #Yell::Loggger for usage.
-  #
-  # @returns [Yell::Logger] The logger instance
-  def new( *args, &block )
-    Yell::Logger.new( *args, &block )
-  end
-
-
-  def env #:nodoc:
-    ENV['YELL_ENV'] || ENV['RACK_ENV'] || 'development'
-  end
-
-  def level( val = nil ) #:nodoc:
-    Yell::Level.new( val )
+  class << self
+    # Creates a new logger instance.
+    #
+    # Refer to #Yell::Loggger for usage.
+    #
+    # @return [Yell::Logger] The logger instance
+    def new( *args, &block )
+      Yell::Logger.new( *args, &block )
+    end
+
+    def env #:nodoc:
+      ENV['YELL_ENV'] || ENV['RACK_ENV'] || 'development'
+    end
   end
 
 end

data/lib/yell/adapters/base.rb

@@ -14,7 +14,7 @@ module Yell #:nodoc:
       #
       # Adapter classes should provide their own implementation 
       # of this method.
-      def write( level, message )
+      def write( event )
         nil
       end
 

data/lib/yell/adapters/datefile.rb

@@ -21,13 +21,14 @@ module Yell #:nodoc:
         super( options, &block )
       end
 
-      def write( level, message )
+      # @overload Close the file if date is expired
+      def write( event )
         close if close?
 
-        super( level, message )
+        super( event )
       end
 
-      # @override Reset the file handle
+      # @overload Reset the file handle
       def close
         @filename = new_filename
 

data/lib/yell/adapters/file.rb

@@ -13,7 +13,7 @@ module Yell #:nodoc:
         @filename = options.fetch(:filename, default_filename)
       end
 
-      # @override Lazily open the file handle
+      # @overload Lazily open the file handle
       def stream
         @stream ||= ::File.open( @filename, ::File::WRONLY|::File::APPEND|::File::CREAT )
       end
@@ -21,7 +21,7 @@ module Yell #:nodoc:
 
       private
 
-      def default_filename
+      def default_filename #:nodoc:
         ::File.directory?("log") ? "log/#{Yell.env}.log" : "#{Yell.env}.log"
       end
 

data/lib/yell/adapters/io.rb

@@ -36,17 +36,17 @@ module Yell
       #
       # @example
       #   write( 'info', 'Hello World' )
-      def write( level, message )
-        msg = @formatter.format( level, message )
+      def write( event )
+        message = @formatter.format( event )
 
         # colorize if applicable
         if colorize? and color = Colors[level]
-          msg = color + msg + Colors['DEFAULT']
+          message = color + message + Colors['DEFAULT']
         end
 
-        msg << "\n" unless msg[-1] == ?\n # add new line if there is none
+        message << "\n" unless message[-1] == ?\n # add new line if there is none
 
-        write!( msg )
+        write!( message )
       end
 
       # Set the format for your message.

data/lib/yell/event.rb

@@ -0,0 +1,40 @@
+module Yell #:nodoc:
+
+  class Event
+    CallerRegexp = /^(.+?):(\d+)(?::in `(.*)')?/ #:nodoc:
+
+    # Accessor to the log level
+    attr_reader :level
+
+    # Accessor to the log message
+    attr_reader :message
+
+    # 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
+
+
+    # Initialize a new log event
+    def initialize( level, message = nil, &block )
+      @time     = Time.now
+      @level    = level
+      @message  = block ? block.call : message
+
+      if m = CallerRegexp.match( caller(4).first )
+        @file, @line, @method = m[1..-1]
+      else
+        @file, @line, @method = ['', '', '']
+      end
+    end
+
+  end
+end
+

data/lib/yell/formatter.rb

@@ -2,23 +2,74 @@
 
 module Yell #:nodoc:
 
+  # No format on the log message
+  #
+  # @example
+  #   logger = Yell.new STDOUT, :format => false
+  #   logger.info "Hello World!"
+  #   #=> "Hello World!"
+  NoFormat = "%m"
+
+  # Default Format
+  #
+  # @example
+  #   logger = Yell.new STDOUT, :format => Yell::DefaultFormat
+  #   logger.info "Hello World!"
+  #   #=> "2012-02-29T09:30:00+01:00 [ INFO] 65784 : Hello World!"
+  #   #    ^                         ^       ^       ^
+  #   #    ISO8601 Timestamp         Level   Pid     Message
+  DefaultFormat = "%d [%5L] %p : %m"
+
+  # Basic Format
+  #
+  # @example
+  #   logger = Yell.new STDOUT, :format => Yell::BasicFormat
+  #   logger.info "Hello World!"
+  #   #=> "I, 2012-02-29T09:30:00+01:00 : Hello World!"
+  #   #    ^  ^                          ^
+  #   #    ^  ISO8601 Timestamp          Message
+  #   #    Level (short)
+  BasicFormat = "%l, %d : %m"
+
+  # Extended Format
+  #
+  # @example
+  #   logger = Yell.new STDOUT, :format => Yell::ExtendedFormat
+  #   logger.info "Hello World!"
+  #   #=> "2012-02-29T09:30:00+01:00 [ INFO] 65784 localhost : Hello World!"
+  #   #    ^                          ^      ^     ^           ^
+  #   #    ISO8601 Timestamp          Level  Pid   Hostname    Message
+  ExtendedFormat  = "%d [%5L] %p %h : %m"
+
+
+  def format( pattern, date_pattern ) #:nodoc:
+    Yell::Formatter.new( pattern, date_pattern )
+  end
+
+
   # The +Formatter+ provides a handle to configure your log message style.
   class Formatter
 
+    #:nodoc:
     PatternTable = {
-      "m" => "message",
-      "d" => "date",
-      "l" => "level[0]",
-      "L" => "level.upcase",
-      "p" => "$$",
-      "h" => "hostname"
+      "m" => "event.message",                 # Message
+      "l" => "event.level[0]",                # Level (short), e.g.'I', 'W'
+      "L" => "event.level",                   # Level, e.g. 'INFO', 'WARN'
+      "d" => "date(event)",                   # ISO8601 Timestamp
+      "p" => "Process.pid",                   # PID
+      "h" => "Socket.gethostname rescue nil", # 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*)?([dlLphm])?(.*)/
-    DefaultPattern = "%d [%5L] %p %h: %m"
+
+    #:nodoc:
+    PatternRegexp = /([^%]*)(%\d*)?([#{PatternTable.keys.join}])?(.*)/
 
 
     def initialize( pattern = nil, date_pattern = nil )
-      @pattern      = pattern || DefaultPattern
+      @pattern      = pattern || Yell::DefaultFormat
       @date_pattern = date_pattern
 
       define!
@@ -27,6 +78,7 @@ module Yell #:nodoc:
 
     private
 
+    # defines the format method
     def define!
       buff, args, _pattern = "", [], @pattern.dup
 
@@ -43,19 +95,14 @@ module Yell #:nodoc:
       end
 
       instance_eval %-
-        def format( level, message )
+        def format( event )
           sprintf( "#{buff}", #{args.join(',')} )
         end
       -
     end
 
-    def date
-      @date_pattern ? Time.now.strftime( @date_pattern ) : Time.now.iso8601
-    end
-
-    def hostname
-      return @hostname if defined?( @hostname )
-      @hostname = Socket.gethostname rescue nil
+    def date( event )
+      @date_pattern ? event.time.strftime( @date_pattern ) : event.time.iso8601
     end
 
   end

data/lib/yell/level.rb

@@ -2,6 +2,10 @@
 
 module Yell #:nodoc:
 
+  def level( val = nil ) #:nodoc:
+    Yell::Level.new( val )
+  end
+
   # The +Level+ class handles the severities for you in order to determine 
   # if an adapter should log or not.
   #
@@ -12,7 +16,6 @@ module Yell #:nodoc:
   #   lt :warn    # Will set from :info level an below
   #   lte :warn   # Will set from :warn level and below
   #
-  #
   # You are able to combine those modifiers to your convenience.
   #
   # @example Set from :info to :error (including)
@@ -89,7 +92,7 @@ module Yell #:nodoc:
 
     private
 
-    def calculate!( modifier, severity )
+    def calculate!( modifier, severity ) #:nodoc:
       index = index_from( severity )
       return if index.nil?
 
@@ -104,7 +107,7 @@ module Yell #:nodoc:
       taint unless tainted?
     end
 
-    def index_from( severity )
+    def index_from( severity ) #:nodoc:
       case severity
         when Integer        then severity
         when String, Symbol then Yell::Severities.index( severity.to_s.upcase )
@@ -112,7 +115,7 @@ module Yell #:nodoc:
       end
     end
 
-    def ascending!( index )
+    def ascending!( index ) #:nodoc:
       @severities.each_with_index do |s, i|
         next if s == false # skip
 
@@ -120,7 +123,7 @@ module Yell #:nodoc:
       end
     end
 
-    def descending!( index )
+    def descending!( index ) #:nodoc:
       @severities.each_with_index do |s, i|
         next if s == false # skip
 
@@ -128,7 +131,7 @@ module Yell #:nodoc:
       end
     end
 
-    def set!( index )
+    def set!( index ) #:nodoc:
       @severities.map! { false } unless tainted?
 
       @severities[index] = true

data/lib/yell/logger.rb

@@ -117,27 +117,26 @@ module Yell #:nodoc:
     # Creates instance methods for every defined log level (debug, info, ...) depending
     # on whether anything should be logged upon, for instance, #info.
     def define_log_methods!
-      Yell::Severities.each do |l|
-        name = l.downcase
+      Yell::Severities.each do |s|
+        name = s.downcase
 
         instance_eval %-
-          def #{name}?; #{@level.at?(name)}; end  # def info?; true; end
-                                                  #
-          def #{name}( message = nil )            # def info( message = nil )
-            return unless #{name}?                #   return unless info?
-                                                  #
-            message = yield if block_given?       #   message = yield if block_given?
-            write( "#{l}", message )              #   write( "INFO", message )
-                                                  #
-            true                                  #   true
-          end                                     # end
+          def #{name}?; #{@level.at?(name)}; end    # def info?; true; 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
         -
       end
     end
 
     # Cycles all the adapters and writes the message
-    def write( level, message )
-      @adapters.each { |a| a.write(level, message) if a.write?(level) }
+    def write( event )
+      @adapters.each { |a| a.write(event) if a.write?(event.level) }
     end
 
   end

data/lib/yell/version.rb

@@ -1,4 +1,4 @@
-module Yell
-  VERSION = "0.2.0"
+module Yell #:nodoc:
+  VERSION = "0.3.0" #:nodoc:
 
 end

data/spec/spec_helper.rb

@@ -7,5 +7,14 @@ require 'rspec'
 require 'timecop'
 
 RSpec.configure do |config|
+
+  config.before do
+    Yell.config.stub!( :yaml_file ).and_return( File.dirname(__FILE__) + '/config/yell.yml' )
+  end
+
+  config.after do
+    Yell.config.reload! # to not run into caching problems during tests
+  end
+
 end
 

data/spec/yell_spec.rb

@@ -15,4 +15,3 @@ describe Yell do
   end
 
 end
-

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yell
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-17 00:00:00.000000000 Z
+date: 2012-03-22 00:00:00.000000000 Z
 dependencies: []
 description: An easy to use logging library to log into files and any other self-defined
   adapters
@@ -23,7 +23,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- init.rb
 - lib/yell.rb
 - lib/yell/adapters.rb
 - lib/yell/adapters/.file.rb.swp
@@ -31,6 +30,7 @@ files:
 - lib/yell/adapters/datefile.rb
 - lib/yell/adapters/file.rb
 - lib/yell/adapters/io.rb
+- lib/yell/event.rb
 - lib/yell/formatter.rb
 - lib/yell/level.rb
 - lib/yell/logger.rb
@@ -67,3 +67,4 @@ test_files:
 - spec/spec.opts
 - spec/spec_helper.rb
 - spec/yell_spec.rb
+has_rdoc: 

data/init.rb

@@ -1 +0,0 @@
-require 'yell'