yell 1.3.0 → 1.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f9ecfe3dde614dc7aaa4d58f6617323dfd22aa6b
+  data.tar.gz: a16b4a0ed5c83a1d722570a7d4e92eb0886856ff
+SHA512:
+  metadata.gz: dbfd34addbe7e79d5a0264f927f64bd9808a1cc09dbe4e56fda1b09677e66cdcb20c527e86a75cbb0954bc9f9f3cfd4ef5b67b052c1d19527888fe856d43f116
+  data.tar.gz: 438d38c8cdd63f08eb32d991eacb04eb1aa1b3bd7020a017d44b954d80bc268c69132ddcc36bdd967c809a57804abfe14656d90912ab2833d878808302e936aa

data/.gitignore

@@ -8,4 +8,6 @@ Gemfile.lock
 
 # vim
 *.swp
-**/*.swp
+
+# coverage
+/coverage

data/.travis.yml

@@ -4,9 +4,8 @@ script: "rspec"
 
 rvm:
   - 1.8.7
-  - 1.9.2
   - 1.9.3
-  - ruby-head
+  - 2.0.0
   - jruby-18mode
   - jruby-19mode
   - rbx-18mode

data/Gemfile

@@ -6,8 +6,12 @@ gemspec
 group :development, :test do
   gem "rake"
 
-  gem "rspec"
+  gem 'rspec-core'
+  gem 'rspec-expectations'
   gem "rr"
   gem "timecop"
+
+  gem 'simplecov', :require => false, :platform => :ruby_20
+  gem 'coveralls', :require => false, :platform => :ruby_20
 end
 

data/README.md

@@ -1,11 +1,12 @@
-**Yell - Your Extensible Logging Library**
+# Yell [![Gem Version](https://badge.fury.io/rb/yell.png)](http://badge.fury.io/rb/yell) [![Build Status](https://travis-ci.org/rudionrails/yell.png?branch=master)](https://travis-ci.org/rudionrails/yell) [![Code Climate](https://codeclimate.com/github/rudionrails/yell.png)](https://codeclimate.com/github/rudionrails/yell) [![Coverage Status](https://coveralls.io/repos/rudionrails/yell/badge.png?branch=master)](https://coveralls.io/r/rudionrails/yell)
 
-[![Build Status](https://secure.travis-ci.org/rudionrails/yell.png?branch=master)](http://travis-ci.org/rudionrails/yell) 
-[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/rudionrails/yell)
 
-Yell works and is tested with ruby 1.8.7, 1.9.x, jruby 1.8 and 1.9 mode, rubinius 1.8 and 1.9 as well as ree.
+**Yell - Your Extensible Logging Library** is a comprehensive logging replacement for Ruby.
+
+Yell works and is tested with ruby 1.8.7, 1.9.x, 2.0.0, jruby 1.8 and 1.9 mode, rubinius 1.8 and 1.9 as well as ree.
+
+If you want to conveniently use Yell with Rails, then head over to [yell-rails](https://github.com/rudionrails/yell-rails). You'll find all the documentation in this repository, though.
 
-**If you want to use Yell with Rails, then head over to [yell-rails](https://github.com/rudionrails/yell-rails).**
 
 ## Installation
 
@@ -55,8 +56,8 @@ Here are some short examples on how to combine them:
 
 ```ruby
 logger = Yell.new do |l|
-  l.adapter STDOUT, :level => [:debug, :info, :warn]
-  l.adapter STDERR, :level => [:error, :fatal]
+  l.adapter STDOUT, level: [:debug, :info, :warn]
+  l.adapter STDERR, level: [:error, :fatal]
 end
 ```
 
@@ -68,10 +69,25 @@ into the 'error.log'.
 
 ```ruby
 logger = Yell.new do |l|
-  l.level = :info # will only pass :info and above to the adapters
+  l.level = 'gte.info' # will only pass :info and above to the adapters
 
-  l.adapter :datefile, 'production.log', :level => Yell.level.lte(:warn)
-  l.adapter :datefile, 'error.log', :level => Yell.level.gte(:error)
+  l.adapter :datefile, 'production.log', level: 'lte.warn' # anything lower or equal to :warn
+  l.adapter :datefile, 'error.log', level: 'gte.error' # anything greater or equal to :error
+end
+```
+
+##### Example: Typical production Logger for Heroku
+
+When deploying to Heroku, the "rails_log_stdout" gem gets injected to your Rails project.
+Yell does not need that when properly configured (see [yell-rails](https://github.com/rudionrails/yell-rails)
+for a more convenient integration with Rails).
+
+```ruby
+logger = Yell.new do |l|
+  l.level = 'gte.info'
+
+  l.adapter :stdout, level: 'lte.warn'
+  l.adapter :stderr, level: 'gte.error'
 end
 ```
 
@@ -98,7 +114,7 @@ With Yell you can do the same thing with less:
 require 'yell'
 
 # create a logger named 'mylog' that logs to stdout
-Yell.new :stdout, :name => 'mylog'
+Yell.new :stdout, name: 'mylog'
 
 # later in the code, you can get the logger back
 Yell['mylog']
@@ -107,7 +123,7 @@ Yell['mylog']
 There is no need to define outputters separately and you don't have to taint 
 you global namespace with Yell's subclasses.
 
-### You want any class to have a logger?
+### Adding a logger to an existing class
 
 Yell comes with a simple module: +Yell::Loggable+. Simply include this in a class and 
 you are good to go.
@@ -115,13 +131,14 @@ you are good to go.
 ```ruby
 # Before you can use it, you will need to define a logger and 
 # provide it with the `:name` of your class.
-Yell.new :stdout, :name => 'Foo'
+Yell.new :stdout, name: 'Foo'
 
 class Foo
   include Yell::Loggable
 end
 
 # Now you can log
+Foo.logger.info "Hello World"
 Foo.new.logger.info "Hello World"
 ```
 
@@ -133,9 +150,45 @@ class Bar < Foo
 end
 
 # The logger will fallback to the Foo superclass
+Bar.logger.info "Hello World"
 Bar.new.logger.info "Hello World"
 ```
 
+### Adding a logger to all classes at once (global logger)
+
+Derived from the example above, simply do the following.
+
+```ruby
+# Define a logger and pass `Object` as name. Internally, Yell adds this
+# logger to the repository where you can access it later on.
+Yell.new :stdout, name: Object
+
+# Enable logging for the class that (almost) every Ruby class inherits from
+Object.send :include, Yell::Loggable
+
+# now you are good to go... from wherever you are
+logger.info "Hello from anything"
+Integer.logger.info "Hello from Integer"
+```
+
+### Suppress log messages with silencers
+
+In case you woul like to suppress certain log messages, you may define
+silencers with Yell. Use this to get control of a noisy log environment. For
+instance, you can suppress logging messages that contain secure information or
+more simply, to skip information about serving your Rails assets. Provide a
+string or a regular expression of the message patterns you would like to exclude.
+
+```ruby
+logger = Yell.new do |l|
+  l.silence /^Started GET "\/assets/
+  l.silence /^Served asset/
+end
+
+logger.debug 'Started GET "/assets/logo.png" for 127.0.0.1 at 2013-06-20 10:18:38 +0200'
+logger.debug 'Served asset /logo.png - 304 Not Modified (0ms)'
+```
+
 
 ## Further Readings
 
@@ -159,5 +212,5 @@ You can find further examples and additional adapters in the [wiki](https://gith
 or have a look into the examples folder.
 
 
-Copyright &copy; 2011-2012 Rudolf Schmidt, released under the MIT license
+Copyright &copy; 2011-2013 Rudolf Schmidt, released under the MIT license
 

data/examples/004.1-colorizing-the-log-output.rb

@@ -8,8 +8,8 @@ You may colorize the log output on your io-based loggers loke so:
 
 logger = Yell.new STDOUT, :colors => true
 
-[:debug, :info, :warn, :error, :fatal, :unknown].each do |level|
-  logger.send level, level
+Yell::Severities.each do |level|
+  logger.send level.downcase, level
 end
 
 EOS
@@ -17,7 +17,7 @@ EOS
 puts "=== actuale example ==="
 logger = Yell.new STDOUT, :colors => true
 
-[:debug, :info, :warn, :error, :fatal, :unknown].each do |level|
-  logger.send level, level
+Yell::Severities.each do |level|
+  logger.send level.downcase, level
 end
 

data/lib/yell.rb

@@ -24,7 +24,7 @@
 module Yell #:nodoc:
 
   # Holds all Yell severities
-  Severities = [ 'DEBUG', 'INFO', 'WARN', 'ERROR', 'FATAL', 'UNKNOWN' ]
+  Severities = ['DEBUG', 'INFO', 'WARN', 'ERROR', 'FATAL', 'UNKNOWN'].freeze
 
   class << self
     # Creates a new logger instance.
@@ -33,35 +33,35 @@ module Yell #:nodoc:
     #
     # @return [Yell::Logger] The logger instance
     def new( *args, &block )
-      Yell::Logger.new( *args, &block )
+      Yell::Logger.new(*args, &block)
     end
 
     # Shortcut to Yell::Level.new
     #
     # @return [Yell::Level] The level instance
     def level( val = nil )
-      Yell::Level.new( val )
+      Yell::Level.new(val)
     end
 
     # Shortcut to Yell::Repository[]
     #
     # @return [Yell::Logger] The logger instance
     def []( name )
-      Yell::Repository[ name ]
+      Yell::Repository[name]
     end
 
     # Shortcut to Yell::Repository[]=
     #
     # @return [Yell::Logger] The logger instance
     def []=( name, logger )
-      Yell::Repository[ name ] = logger
+      Yell::Repository[name] = logger
     end
 
     # Shortcut to Yell::Fomatter.new
     #
     # @return [Yell::Formatter] A Yell::Formatter instance
     def format( pattern, date_pattern = nil )
-      Yell::Formatter.new( pattern, date_pattern )
+      Yell::Formatter.new(pattern, date_pattern)
     end
 
     # Loads a config from a YAML file
@@ -77,7 +77,7 @@ module Yell #:nodoc:
       return ENV['RACK_ENV']  if ENV.key? 'RACK_ENV'
       return ENV['RAILS_ENV'] if ENV.key? 'RAILS_ENV'
 
-      if defined?( Rails )
+      if defined?(Rails)
         Rails.env
       else
         'development'
@@ -90,25 +90,34 @@ module Yell #:nodoc:
       messages << "  before: #{options[:before]}" if options[:before]
       messages << "  after:  #{options[:after]}" if options[:after]
 
-      _warn( *messages )
+      _warn(*messages)
     end
 
     # @private
     def _warn( *messages )
-      $stderr.puts "[Yell] " + messages.join( "\n" )
-    rescue Exception
+      $stderr.puts "[Yell] " + messages.join("\n")
+    rescue Exception => e
       # do nothing
     end
   end
 
 end
 
+# helpers
+require File.dirname(__FILE__) + '/yell/helpers/base'
+require File.dirname(__FILE__) + '/yell/helpers/adapters'
+require File.dirname(__FILE__) + '/yell/helpers/formatter'
+require File.dirname(__FILE__) + '/yell/helpers/level'
+require File.dirname(__FILE__) + '/yell/helpers/tracer'
+require File.dirname(__FILE__) + '/yell/helpers/silencer'
+
 # classes
 require File.dirname(__FILE__) + '/yell/configuration'
 require File.dirname(__FILE__) + '/yell/repository'
 require File.dirname(__FILE__) + '/yell/event'
 require File.dirname(__FILE__) + '/yell/level'
 require File.dirname(__FILE__) + '/yell/formatter'
+require File.dirname(__FILE__) + '/yell/silencer'
 require File.dirname(__FILE__) + '/yell/adapters'
 require File.dirname(__FILE__) + '/yell/logger'
 

data/lib/yell/adapters.rb

@@ -1,5 +1,4 @@
 # encoding: utf-8
-
 module Yell #:nodoc:
 
   # AdapterNotFound is raised whenever you want to instantiate an 
@@ -10,36 +9,34 @@ module Yell #:nodoc:
   # the logger. You should not have to call the corresponding classes
   # directly.
   module Adapters
-    @@adapters = {}
-
-    class << self
-
-      # Register your own adapter here
-      #
-      # @example
-      #   Yell::Adapters.register( :myadapter, MyAdapter )
-      def register( name, klass )
-        @@adapters[name] = klass
-      end
 
-      # Returns an instance of the given processor type.
-      #
-      # @example A simple file adapter
-      #   Yell::Adapters.new( :file )
-      def new( name, options = {}, &block )
-        return name if name.is_a?( Yell::Adapters::Base )
+    # holds the list of known adapters
+    @adapters = {}
 
-        adapter = case name
-          when STDOUT then @@adapters[:stdout]
-          when STDERR then @@adapters[:stderr]
-          else @@adapters[name]
-        end
-
-        raise AdapterNotFound.new( name ) unless adapter
+    # Register your own adapter here
+    #
+    # @example
+    #   Yell::Adapters.register( :myadapter, MyAdapter )
+    def self.register( name, klass )
+      @adapters[name] = klass
+    end
 
-        adapter.new( options, &block )
+    # Returns an instance of the given processor type.
+    #
+    # @example A simple file adapter
+    #   Yell::Adapters.new( :file )
+    def self.new( name, options = {}, &block )
+      return name if name.is_a?(Yell::Adapters::Base)
+
+      adapter = case name
+      when STDOUT then @adapters[:stdout]
+      when STDERR then @adapters[:stderr]
+      else @adapters[name]
       end
 
+      raise AdapterNotFound.new(name) if adapter.nil?
+
+      adapter.new(options, &block)
     end
 
   end

data/lib/yell/adapters/base.rb

@@ -41,7 +41,8 @@ module Yell #:nodoc:
     #   logger = Yell.new :puts
     #   logger.info "Hello World!"
     class Base < Monitor
-      include Yell::Level::Helpers
+      include Yell::Helpers::Base
+      include Yell::Helpers::Level
 
       class << self
         # Setup your adapter with this helper method.
@@ -137,6 +138,7 @@ module Yell #:nodoc:
       def initialize( options = {}, &block )
         super() # init the monitor superclass
 
+        reset!
         setup!(options)
 
         # eval the given block
@@ -166,12 +168,16 @@ module Yell #:nodoc:
 
       # Get a pretty string representation of the adapter, including
       def inspect
-        inspection = inspectables.inject( [] ) { |r, c| r << "#{c}: #{send(c).inspect}" }
+        inspection = inspectables.map { |m| "#{m}: #{send(m).inspect}" }
         "#<#{self.class.name} #{inspection * ', '}>"
       end
 
       private
 
+      # def reset!
+      #   super()
+      # end
+
       # Setup the adapter instance.
       #
       # Adapter classes should provide their own implementation 

data/lib/yell/adapters/datefile.rb

@@ -14,46 +14,6 @@ module Yell #:nodoc:
       Header = lambda { |date, pattern| "# -*- #{date.iso8601} (#{date.to_f}) [#{pattern}] -*-" }
       HeaderRegexp = /^# -\*- (.+) \((\d+\.\d+)\) \[(.+)\] -\*-$/
 
-
-      setup do |options|
-        @date, @date_strftime = nil, nil # default; do not override --R
-
-        # check whether to write the log header (default true)
-        self.header = options.fetch(:header, true)
-
-        # check the date pattern on the filename (default "%Y%m%d")
-        self.date_pattern = options.fetch(:date_pattern, DefaultDatePattern)
-
-        # check whether to cleanup old files of the same pattern (default false)
-        self.keep = options.fetch(:keep, false)
-
-        # check whether to symlink the otiginal filename (default true)
-        self.symlink = options.fetch(:symlink, true)
-
-        @original_filename  = ::File.expand_path options.fetch(:filename, default_filename)
-        options[:filename]  = @original_filename
-      end
-
-      write do |event|
-        # do nothing when not closing
-        return unless close?
-        close
-
-        # exit when file ready present
-        return if ::File.exist?( @filename )
-
-        # write the header if applicable
-        stream.puts( Header.call(@date, date_pattern) ) if header?
-
-        symlink! if symlink?
-        cleanup! if cleanup?
-      end
-
-      close do
-        @filename = filename_for( @date )
-      end
-
-
       # The pattern to be used for the files
       #
       # @example
@@ -92,6 +52,44 @@ module Yell #:nodoc:
 
       private
 
+      # @overload setup!( options )
+      def setup!( options )
+        @date, @date_strftime = nil, nil # default; do not override --R
+
+        self.header = options.fetch(:header, true)
+        self.date_pattern = options.fetch(:date_pattern, DefaultDatePattern)
+        self.keep = options.fetch(:keep, false)
+        self.symlink = options.fetch(:symlink, true)
+
+        @original_filename  = ::File.expand_path options.fetch(:filename, default_filename)
+        options[:filename]  = @original_filename
+
+        super
+      end
+
+      # @overload write!( event )
+      def write!( event )
+        # do nothing when not closing
+        return super unless close?
+        close
+
+        # exit when file ready present
+        return super if ::File.exist?(@filename)
+
+        header! if header?
+        symlink! if symlink?
+        cleanup! if cleanup?
+
+        super
+      end
+
+      # @overload close!
+      def close!
+        @filename = filename_for( @date )
+
+        super
+      end
+
       # Determine whether to close the file handle or not.
       #
       # It is based on the `:date_pattern` (can be passed as option upon initialize). 
@@ -119,7 +117,7 @@ module Yell #:nodoc:
       # in false cleanups).
       def cleanup!
         files = Dir[ @original_filename.sub( /(\.\w+)?$/, ".*\\1" ) ].sort.select do |file|
-          created, pattern = header_from(file)
+          _, pattern = header_from(file)
 
           # Select if the date pattern is nil (no header info available within the file) or
           # when the pattern matches.
@@ -150,6 +148,11 @@ module Yell #:nodoc:
       # @return [Boolean] true or false
       def symlink?; !!symlink; end
 
+      # Write the header information into the file
+      def header!
+        stream.puts( Header.call(@date, date_pattern) )
+      end
+
       # Write header into the file?
       #
       # @return [Boolean] true or false
@@ -174,7 +177,7 @@ module Yell #:nodoc:
         end
       end
 
-      # @override
+      # @overload inspectables
       def inspectables
         super.concat [:date_pattern, :header, :keep, :symlink ]
       end