yell 1.4.0 → 2.2.2

data/lib/yell/helpers/level.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 module Yell #:nodoc:
   module Helpers #:nodoc:
     module Level
@@ -10,18 +9,22 @@ module Yell #:nodoc:
       #
       # @param [String, Symbol, Integer] severity The minimum log level
       def level=( severity )
-        @level.set(severity)
+        @__level__ = case severity
+        when Yell::Level then severity
+        else Yell::Level.new(severity)
+        end
       end
 
       # @private
       def level
-        @level
+        @__level__
       end
 
+
       private
 
       def reset!
-        @level = Yell::Level.new
+        @__level__ = Yell::Level.new
 
         super
       end

data/lib/yell/helpers/silencer.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 module Yell #:nodoc:
   module Helpers #:nodoc:
     module Silencer
@@ -8,22 +7,21 @@ module Yell #:nodoc:
         silencer.add(*patterns)
       end
 
-      # @private
       def silencer
-        @silencer
+        @__silencer__
       end
 
 
       private
 
       def reset!
-        @silencer = Yell::Silencer.new
+        @__silencer__ = Yell::Silencer.new
 
         super
       end
 
       def silence!( *messages )
-        silencer.silence!(*messages) if silencer.silence?
+        @__silencer__.silence!(*messages) if silencer.silence?
       end
 
     end

data/lib/yell/helpers/tracer.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 module Yell #:nodoc:
   module Helpers #:nodoc:
     module Tracer #:nodoc:
@@ -18,22 +17,22 @@ module Yell #:nodoc:
       #
       # @return [Yell::Level] a level representation of the tracer
       def trace=( severity )
-        case severity
-        when false then @tracer.set("gt.#{Yell::Severities.last}")
-        else @tracer.set(severity)
+        @__trace__ = case severity
+        when Yell::Level then severity
+        when false then Yell::Level.new("gt.#{Yell::Severities.last}")
+        else Yell::Level.new(severity)
         end
       end
 
-      # @private
       def trace
-        @tracer
+        @__trace__
       end
 
 
       private
 
       def reset!
-        @tracer = Yell::Level.new
+        @__trace__ = Yell::Level.new('gte.error')
 
         super
       end

data/lib/yell/level.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 module Yell #:nodoc:
 
   # The +Level+ class handles the severities for you in order to determine 
@@ -23,6 +21,7 @@ module Yell #:nodoc:
   # @example Set at :info only
   #   Yell::Level.new.at(:info)
   class Level
+    include Comparable
 
     InterpretRegexp = /(at|gt|gte|lt|lte)?\.?(#{Yell::Severities.join('|')})/i
 
@@ -42,7 +41,8 @@ module Yell #:nodoc:
     #
     # @param [Integer,String,Symbol,Array,Range,nil] severity The severity for the level.
     def initialize( *severities )
-      set( *severities )
+      @tainted = false
+      set(*severities)
     end
 
     # Set the severity to the given format
@@ -51,10 +51,10 @@ module Yell #:nodoc:
       severity = severities.length > 1 ? severities : severities.first
 
       case severity
-      when Array then at( *severity )
-      when Range then gte( severity.first ).lte( severity.last )
-      when Integer, Symbol then gte( severity )
-      when String then interpret( severity )
+      when Array then at(*severity)
+      when Range then gte(severity.first).lte(severity.last)
+      when String then interpret(severity)
+      when Integer, Symbol then gte(severity)
       when Yell::Level then @severities = severity.severities
       end
     end
@@ -67,7 +67,7 @@ module Yell #:nodoc:
     #
     # @return [Boolean] tru or false
     def at?( severity )
-      index = index_from( severity )
+      index = index_from(severity)
 
       index.nil? ? false : @severities[index]
     end
@@ -146,8 +146,12 @@ module Yell #:nodoc:
 
     # @private
     def ==(other)
-      return super unless other.respond_to?(:severities)
-      severities == other.severities
+      other.respond_to?(:severities) ? severities == other.severities : super
+    end
+
+    # @private
+    def <=>( other )
+      other.is_a?(Numeric) ? to_i <=> other : super
     end
 
 
@@ -162,7 +166,7 @@ module Yell #:nodoc:
     end
 
     def calculate!( modifier, severity )
-      index = index_from( severity )
+      index = index_from(severity)
       return if index.nil?
 
       case modifier
@@ -173,14 +177,13 @@ module Yell #:nodoc:
       else set!( index ) # :==
       end
 
-      taint unless tainted?
+      @tainted = true unless @tainted
     end
 
     def index_from( severity )
       case severity
-      when Integer        then severity
-      when String, Symbol then Yell::Severities.index( severity.to_s.upcase )
-      else nil
+      when String, Symbol then Yell::Severities.index(severity.to_s.upcase)
+      else Integer(severity)
       end
     end
 
@@ -201,7 +204,7 @@ module Yell #:nodoc:
     end
 
     def set!( index, val = true )
-      @severities.map! { false } unless tainted?
+      @severities.map! { false } unless @tainted
 
       @severities[index] = val
     end

data/lib/yell/loggable.rb

@@ -1,7 +1,4 @@
-# encoding: utf-8
-
 module Yell #:nodoc:
-
   # Include this module to add a logger to any class.
   #
   # When including this module, your class will have a :logger instance method 
@@ -9,7 +6,7 @@ module Yell #:nodoc:
   # provide it with the name of your class.
   #
   # @example
-  #   Yell.new :stdout, :name => 'Foo'
+  #   Yell.new :stdout, name: 'Foo'
   #
   #   class Foo
   #     include Yell::Loggable
@@ -17,11 +14,18 @@ module Yell #:nodoc:
   #
   #   Foo.new.logger.info "Hello World"
   module Loggable
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
 
-    def logger
-      Yell[ self.class ]
+    module ClassMethods
+      def logger
+        Yell[self]
+      end
     end
 
+    def logger
+      self.class.logger
+    end
   end
 end
-

data/lib/yell/logger.rb

@@ -1,44 +1,15 @@
-# encoding: utf-8
-
 require 'pathname'
 
-# TODO: DSL improvements
-#
-# Initlalize an empty logger
-#   logger = Yell.new(adapters: false)
-#   logger.adapters.add :stdout
-#
-# Or shorthand for adapters.add
-#   logger.add :stdout
-#
-# Or with a block
-#   logger = Yell.new do |l|
-#     l.add :stdout
-#     l.add :stderr
-#   end
-#
-#  logger = Yell.new do |l|
-#    l.adapters.add :stdout
-#    l.adapters.add :stderr
-#  end
-#
-#
-# Define Silencers
-#   logger = Yell.new do |l|
-#     l.silence /password/
-#   end
-#
 module Yell #:nodoc:
-
   # The +Yell::Logger+ is your entrypoint. Anything onwards is derived from here.
   #
-  # A +Yell::Logger+ instance holds all your adapters and sends the log events 
+  # 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.
   class Logger
     include Yell::Helpers::Base
     include Yell::Helpers::Level
     include Yell::Helpers::Formatter
-    include Yell::Helpers::Adapters
+    include Yell::Helpers::Adapter
     include Yell::Helpers::Tracer
     include Yell::Helpers::Silencer
 
@@ -55,38 +26,40 @@ module Yell #:nodoc:
     #   Yell::Logger.new :datefile, 'development.log'
     #
     # @example Setting the log level
-    #   Yell::Logger.new :level => :warn
+    #   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 'development.log', level: :warn
     #
     #   Yell::Logger.new :datefile, 'development.log' do |l|
     #     l.level = :info
     #   end
     def initialize( *args, &block )
-      reset!
-
       # extract options
       @options = args.last.is_a?(Hash) ? args.pop : {}
 
-      # adapters may be passed in the options
-      extract!(@options)
-
       # check if filename was given as argument and put it into the @options
       if [String, Pathname].include?(args.last.class)
         @options[:filename] = args.pop unless @options[:filename]
       end
 
-      self.level = @options.fetch(:level, 0) # debug by defauly
-      self.name = @options.fetch(:name, nil) # no name by default
-      self.trace = @options.fetch(:trace, :error) # trace from :error level onwards
+      reset!
+
+      # FIXME: :format is deprecated in future versions --R
+      self.formatter = Yell.__fetch__(@options, :format, :formatter)
+      self.level = Yell.__fetch__(@options, :level, :default => 0)
+      self.name = Yell.__fetch__(@options, :name)
+      self.trace = Yell.__fetch__(@options, :trace, default: :error)
 
       # silencer
-      self.silence(*@options[:silence])
+      self.silence(*Yell.__fetch__(@options, :silence, default: []))
+
+      # adapters may be passed in the options
+      extract!(*Yell.__fetch__(@options, :adapters, default: []))
 
       # extract adapter
       self.adapter(args.pop) if args.any?
@@ -104,12 +77,25 @@ module Yell #:nodoc:
     #
     # @return [String] The logger's name
     def name=( val )
-      @name = val
-      Yell::Repository[@name] = self if @name
+      Yell::Repository[val] = self if val
+      @name = val.nil? ? "<#{self.class.name}##{object_id}>": val
 
       @name
     end
 
+    # Somewhat backwards compatible method (not fully though)
+    def add( options, *messages, &block )
+      return false unless level.at?(options)
+
+      messages = messages
+      messages << block.call unless block.nil?
+      messages = silencer.call(*messages)
+      return false if messages.empty?
+
+      event = Yell::Event.new(self, options, *messages)
+      write(event)
+    end
+
     # Creates instance methods for every log level:
     #   `debug` and `debug?`
     #   `info` and `info?`
@@ -119,18 +105,12 @@ module Yell #:nodoc:
     Yell::Severities.each_with_index do |s, index|
       name = s.downcase
 
-      class_eval <<-EOS, __FILE__, __LINE__
+      class_eval <<-EOS, __FILE__, __LINE__ + index
         def #{name}?; level.at?(#{index}); end            # def info?; level.at?(1); end
                                                           #
         def #{name}( *m, &b )                             # def info( *m, &b )
-          return false unless #{name}?                    #   return false unless info?
-                                                          #
-          m = silencer.silence(*m) if silencer.silence?   #   m = silencer.silence(*m) if silencer.silence?
-          return false if m.empty?                        #   return false if m.empty?
-                                                          #
-          event = Yell::Event.new(self, #{index}, *m, &b) #   event = Yell::Event.new(self, 1, *m, &b)
-          write(event)                                    #   write(event)
-          true                                            #   true
+          options = Yell::Event::Options.new(#{index}, 1)
+          add(options, *m, &b)                            #   add(Yell::Event::Options.new(1, 1), *m, &b)
         end                                               # end
       EOS
     end
@@ -138,14 +118,18 @@ module Yell #:nodoc:
     # Get a pretty string representation of the logger.
     def inspect
       inspection = inspectables.map { |m| "#{m}: #{send(m).inspect}" }
-      "#<#{self.class.name} #{inspection * ', '}, adapters: #{adapters.map(&:inspect) * ', '}>"
+      "#<#{self.class.name} #{inspection * ', '}>"
     end
 
     # @private
     def close
-      @adapters.each(&:close)
+      adapters.close
     end
 
+    # @private
+    def write( event )
+      adapters.write(event)
+    end
 
     private
 
@@ -153,29 +137,24 @@ module Yell #:nodoc:
     # multiple variations:
     #
     # @example
-    #   options = { :adapters => [:stdout, :stderr] }
+    #   extract!(:stdout, :stderr)
     #
     # @example
-    #   options = { :adapters => [:stdout => {:level => :info}, :stderr => {:level => :error}]
-    def extract!( opts )
-      ( opts.delete(:adapters) || [] ).each do |a|
-        case a
-        when String, Symbol then adapter( a )
-        else a.each { |n, o| adapter( n, o || {} ) }
+    #   extract!(stdout: {level: :info}, stderr: {level: :error})
+    def extract!( *list )
+      list.each do |a|
+        if a.is_a?(Hash)
+          a.each { |t, o| adapter(t, o) }
+        else
+          adapter(a)
         end
       end
     end
 
-    # Cycles all the adapters and writes the message
-    def write( event )
-      adapters.each { |a| a.write(event) }
-    end
-
     # Get an array of inspected attributes for the adapter.
     def inspectables
       [:name] | super
     end
-
   end
 end
 

data/lib/yell/repository.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 require 'monitor'
 require "singleton"
 
@@ -35,7 +33,7 @@ module Yell #:nodoc:
     # @raise [Yell::LoggerNotFound] Raised when repository does not have that key
     # @return [Yell::Logger] The logger instance
     def self.[]( name )
-      synchronize { instance.fetch(name) or raise Yell::LoggerNotFound.new(name) }
+      synchronize { instance.__fetch__(name) or raise Yell::LoggerNotFound.new(name) }
     end
 
     # Get the list of all loggers in the repository
@@ -57,11 +55,11 @@ module Yell #:nodoc:
     # If the logger could not be found and has a superclass, it 
     # will attempt to look there. This is important for the 
     # Yell::Loggable module.
-    def fetch( name )
+    def __fetch__( name )
       logger = loggers[name] || loggers[name.to_s]
 
       if logger.nil? && name.respond_to?(:superclass)
-        return fetch(name.superclass)
+        return __fetch__(name.superclass)
       end
 
       logger

data/lib/yell/silencer.rb

@@ -1,9 +1,17 @@
-# encoding: utf-8
 module Yell #:nodoc:
 
   # The +Yell::Silencer+ is your handly helper for stiping out unwanted log messages.
   class Silencer
 
+    class PresetNotFound < StandardError
+      def message; "Could not find a preset for #{super.inspect}"; end
+    end
+
+    Presets = {
+      :assets => [/\AStarted GET "\/assets/, /\AServed asset/, /\A\s*\z/] # for Rails
+    }
+
+
     def initialize( *patterns )
       @patterns = patterns.dup
     end
@@ -17,27 +25,24 @@ module Yell #:nodoc:
     # @example Add regular expressions
     #   add( /password/ )
     #
-    # @return [Array] All set patterns
+    # @return [self] The silencer instance
     def add( *patterns )
-      @patterns = @patterns | patterns.compact
+      patterns.each { |pattern| add!(pattern) }
+
+      self
     end
 
     # Clears out all the messages that would match any defined pattern
     #
     # @example
-    #   silence('username', 'password')
+    #   call(['username', 'password'])
     #   #=> ['username]
     #
-    # @return [Array<String>] The remaining messages
-    def silence( *messages )
-      messages.reject { |m| matches?(m) }
-    end
+    # @return [Array] The remaining messages
+    def call( *messages )
+      return messages if @patterns.empty?
 
-    # Anything to silence at all?
-    #
-    # @return [Boolean] true or false
-    def silence?
-      @patterns.any?
+      messages.reject { |m| matches?(m) }
     end
 
     # Get a pretty string
@@ -53,6 +58,17 @@ module Yell #:nodoc:
 
     private
 
+    def add!( pattern )
+      @patterns = @patterns | fetch(pattern)
+    end
+
+    def fetch( pattern )
+      case pattern
+      when Symbol then Presets[pattern] or raise PresetNotFound.new(pattern)
+      else [pattern]
+      end
+    end
+
     # Check if the provided message matches any of the defined patterns.
     #
     # @example
@@ -61,7 +77,7 @@ module Yell #:nodoc:
     #
     # @return [Boolean] true or false
     def matches?( message )
-      @patterns.any? { |pattern| message.match(pattern) }
+      @patterns.any? { |pattern| message.respond_to?(:match) && message.match(pattern) }
     end
 
   end

data/lib/yell/version.rb

@@ -1,7 +1,4 @@
-# encoding: utf-8
-
 module Yell #:nodoc:
-  VERSION = "1.4.0"
-
+  VERSION = "2.2.2"
 end
 

data/lib/yell.rb

@@ -1,6 +1,4 @@
-# encoding: utf-8
-
-# Copyright (c) 2011-2013 Rudolf Schmidt
+# Copyright (c) 2011-2014 Rudolf Schmidt
 #
 # Permission is hereby granted, free of charge, to any person obtaining
 # a copy of this software and associated documentation files (the
@@ -22,7 +20,6 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 module Yell #:nodoc:
-
   # Holds all Yell severities
   Severities = ['DEBUG', 'INFO', 'WARN', 'ERROR', 'FATAL', 'UNKNOWN'].freeze
 
@@ -60,8 +57,8 @@ module Yell #:nodoc:
     # Shortcut to Yell::Fomatter.new
     #
     # @return [Yell::Formatter] A Yell::Formatter instance
-    def format( pattern, date_pattern = nil )
-      Yell::Formatter.new(pattern, date_pattern)
+    def format( pattern = nil, date_pattern = nil, &block )
+      Yell::Formatter.new(pattern, date_pattern, &block)
     end
 
     # Loads a config from a YAML file
@@ -71,6 +68,11 @@ module Yell #:nodoc:
       Yell.new Yell::Configuration.load!(file)
     end
 
+    # Shortcut to Yell::Adapters.register
+    def register( name, klass )
+      Yell::Adapters.register(name, klass)
+    end
+
     # @private
     def env
       return ENV['YELL_ENV']  if ENV.key? 'YELL_ENV'
@@ -85,27 +87,34 @@ module Yell #:nodoc:
     end
 
     # @private
-    def _deprecate( version, message, options = {} )
+    def __deprecate__( version, message, options = {} ) #:nodoc:
       messages = ["Deprecation Warning (since v#{version}): #{message}" ]
       messages << "  before: #{options[:before]}" if options[:before]
       messages << "  after:  #{options[:after]}" if options[:after]
 
-      _warn(*messages)
+      __warn__(*messages)
     end
 
     # @private
-    def _warn( *messages )
+    def __warn__( *messages ) #:nodoc:
       $stderr.puts "[Yell] " + messages.join("\n")
     rescue Exception => e
       # do nothing
     end
-  end
 
+    # @private
+    def __fetch__( hash, *args )
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      value = args.map { |key| hash.fetch(key.to_sym, hash[key.to_s]) }.compact.first
+
+      value.nil? ? options[:default] : value
+    end
+  end
 end
 
 # helpers
 require File.dirname(__FILE__) + '/yell/helpers/base'
-require File.dirname(__FILE__) + '/yell/helpers/adapters'
+require File.dirname(__FILE__) + '/yell/helpers/adapter'
 require File.dirname(__FILE__) + '/yell/helpers/formatter'
 require File.dirname(__FILE__) + '/yell/helpers/level'
 require File.dirname(__FILE__) + '/yell/helpers/tracer'
@@ -124,3 +133,12 @@ require File.dirname(__FILE__) + '/yell/logger'
 # modules
 require File.dirname(__FILE__) + '/yell/loggable'
 
+# core extensions
+require File.dirname(__FILE__) + '/core_ext/logger'
+
+# register known adapters
+Yell.register :null, Yell::Adapters::Base # adapter that does nothing (for convenience only)
+Yell.register :file, Yell::Adapters::File
+Yell.register :datefile, Yell::Adapters::Datefile
+Yell.register :stdout, Yell::Adapters::Stdout
+Yell.register :stderr, Yell::Adapters::Stderr