yell 0.4.3 → 0.5.0

data/README.md

@@ -22,9 +22,8 @@ gem "yell"
 
 ## Usage
 
-On the basics, Yell works just like any other logging library. However, it 
-tries to make your log mesages  more readable. By default, it will format the given 
-message as follows:
+On the basics, you can use Yell just like any other logging library with a more 
+sophisticated message formatter.
 
 ```ruby
 logger = Yell.new STDOUT
@@ -35,56 +34,10 @@ logger.info "Hello World"
 #    ISO8601 Timestamp         Level   Pid     Message
 ```
 
-When no arguments are given, Yell will check for `ENV['RACK_ENV']` and 
-determine the filename from that.
-
-Alternatively, you may define `ENV['YELL_ENV']` to set the filename. If neither 
-`YELL_ENV` or `RACK_ENV` is defined, *'development'* will be the default. Also, if a 
-`log` directory exists, Yell will place the file there (only if you have not passed
-a filename explicitly.
-
-Naturally, you can pass a `:filename` to Yell:
-
-```ruby
-logger = Yell.new "yell.log"
-```
-
-### Levels
-
-Just like any other logging library, Yell allows you to define from which level 
-onwarns you want to write your log message. here are some examples to show how 
-you can combine those.
-
-##### Example: Write from `:info` onwards
-
-```ruby
-logger = Yell.new STDOUT, :level => :info # write on :info, :warn, :error, :fatal
-```
-
-##### Example: Write on `:info` and `:error` only
-
-```ruby
-logger - Yell.new STDOUT, :level => [:info, :error] # write on :info and :error only
-```
-
-##### Example: Write between :info and :error
-
-```ruby
-logger = Yell.new STDOUT, :level => (:info..:error)
-
-# NOTE: The Range might only work with 1.9 compatible rubies!
-```
-
-There are more ways to set your logging level, please consult the 
-[wiki](https://github.com/rudionrails/yell/wiki) on that.
-
-
-### Adapters
-
-Yell comes with various adapters already build-in. Those are the mainly IO-based 
-adapters for every day use. There are additional ones available as separate gems. Please 
-consult the [wiki](https://github.com/rudionrails/yell/wiki) on that - they are listed 
-there.
+The strength of Yell, however, comes when using multiple adapters. The already built-in 
+ones are IO-based and require no further configuration. Also, there are additional ones 
+available as separate gems. Please consult the [wiki](https://github.com/rudionrails/yell/wiki) 
+on that - they are listed there.
 
 The standard adapters are:
 
@@ -99,33 +52,28 @@ Here are some short examples on how to combine them:
 ##### Example: Notice messages go into `STDOUT` and error messages into `STDERR`
 
 ```ruby
-logger = Yell.new do
-  adapter STDOUT, :level => [:debug, :info, :warn]
-  adapter STDERR, :level => [:error, :fatal]
+logger = Yell.new do |l|
+  l.adapter STDOUT, :level => [:debug, :info, :warn]
+  l.adapter STDERR, :level => [:error, :fatal]
 end
 ```
 
-##### Example: Notice messages to into `application.log` and error messages into `error.log`
+##### Example: Typical production Logger
 
-```ruby
-logger = Yell.new do
-  adapter :file, 'application.log', :level => [:debug, :info, :warn]
-  adapter :file, 'error.log', :level => [:error, :fatal]
-end
-```
-
-##### Example: Every log severity is handled by a separate adapter and we ignore `:debug` and `:info` levels
+We setup a logger that starts passing messages at the `:info` level. Severities 
+below `:error` go into the 'production.log', whereas anything higher is written 
+into the 'error.log'.
 
 ```ruby
-logger = Yell.new do
-  level :warn # only start logging from :warn upwards
+logger = Yell.new do |l|
+  l.level = :info # will only pass :info and above to the adapters
 
-  adapter :stdout, :level => [:warn]
-  adapter :datefile, 'error.log', :level => [:error]
-  adapter :datefile, 'fatal.log', :level => [:fatal]
+  l.adapter :datefile, 'production.log', :level => Yell.level.lte(:warn)
+  l.adapter :datefile, 'error.log', :level => Yell.level.gte(:error)
 end
 ```
 
+
 ## Further Readings
 
 [How To: Setting The Log Level](https://github.com/rudionrails/yell/wiki/101-setting-the-log-level)  

data/examples/001-basic-usage.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
-require File.dirname(__FILE__) + '/../lib/yell'
+require_relative '../lib/yell'
 
 puts <<-EOS
 

data/examples/002.1-log-level-basics.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
-require File.dirname(__FILE__) + '/../lib/yell'
+require_relative '../lib/yell'
 
 puts <<-EOS
 

data/examples/002.2-log-level-on-certain-severities-only.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
-require File.dirname(__FILE__) + '/../lib/yell'
+require_relative '../lib/yell'
 
 puts <<-EOS
 

data/examples/002.3-log-level-within-range.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
-require File.dirname(__FILE__) + '/../lib/yell'
+require_relative '../lib/yell'
 
 puts <<-EOS
 

data/examples/003.1-formatting-DefaultFormat.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
-require File.dirname(__FILE__) + '/../lib/yell'
+require_relative '../lib/yell'
 
 puts <<-EOS
 

data/examples/003.2-formatting-BasicFormat.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
-require File.dirname(__FILE__) + '/../lib/yell'
+require_relative '../lib/yell'
 
 puts <<-EOS
 

data/examples/003.3-formatting-ExtendedFormat.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
-require File.dirname(__FILE__) + '/../lib/yell'
+require_relative '../lib/yell'
 
 puts <<-EOS
 

data/examples/003.4-formatting-on-your-own.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
-require File.dirname(__FILE__) + '/../lib/yell'
+require_relative '../lib/yell'
 
 puts <<-EOS
 

data/lib/yell.rb

@@ -24,17 +24,11 @@
 require 'time'
 require 'socket'
 
-begin
-  require 'yell/event'
-rescue LoadError
-  $: << File.dirname(__FILE__)
-  require 'yell/event'
-end
-
-require 'yell/level'
-require 'yell/formatter'
-require 'yell/adapters'
-require 'yell/logger'
+require File.dirname(__FILE__) + '/yell/event'
+require File.dirname(__FILE__) + '/yell/level'
+require File.dirname(__FILE__) + '/yell/formatter'
+require File.dirname(__FILE__) + '/yell/adapters'
+require File.dirname(__FILE__) + '/yell/logger'
 
 module Yell #:nodoc:
   Severities = [ 'DEBUG', 'INFO', 'WARN', 'ERROR', 'FATAL', 'UNKNOWN' ]
@@ -49,18 +43,32 @@ module Yell #:nodoc:
       Yell::Logger.new( *args, &block )
     end
 
+    # Shortcut to Yell::Level.new
+    #
+    # @return [Yell::Level] A Yell::Level instance
     def level( val = nil )
       Yell::Level.new( val )
     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 )
     end
 
-
     def env #:nodoc:
       ENV['YELL_ENV'] || ENV['RACK_ENV'] || 'development'
     end
+
+    def _deprecate( version, message, options = {} )
+      warning = ["Deprecation Warning (since v#{version}): #{message}" ]
+      warning << "  before: #{options[:before]}" if options[:before]
+      warning << "  after:  #{options[:after]}" if options[:after]
+
+      $stderr.puts warning.join( "\n" )
+    end
+
   end
 
 end

data/lib/yell/adapters.rb

@@ -46,11 +46,11 @@ module Yell #:nodoc:
 end
 
 # Base for all adapters
-require 'yell/adapters/base'
+require File.dirname(__FILE__) + '/adapters/base'
 
 # IO based adapters
-require 'yell/adapters/io'
-require 'yell/adapters/streams'
-require 'yell/adapters/file'
-require 'yell/adapters/datefile'
+require File.dirname(__FILE__) + '/adapters/io'
+require File.dirname(__FILE__) + '/adapters/streams'
+require File.dirname(__FILE__) + '/adapters/file'
+require File.dirname(__FILE__) + '/adapters/datefile'
 

data/lib/yell/adapters/base.rb

@@ -10,15 +10,18 @@ module Yell #:nodoc:
     # by the {Yell::Logger}.
     class Base
 
+      # Accessor to the level
+      attr_reader :level
+
       # Accessor to the options
       attr_reader :options
 
       def initialize( options = {}, &block )
         @options = options
 
-        level options[:level]
+        self.level = options[:level]
 
-        instance_eval( &block ) if block
+        block.call(self) if block
       end
 
       # The main method for calling the adapter.
@@ -43,7 +46,7 @@ module Yell #:nodoc:
       #   level :info
       #
       # For more examples, refer to {Yell::Level}.
-      def level( severity = nil )
+      def level=( severity )
         @level = Yell::Level.new( severity )
       end
 

data/lib/yell/adapters/io.rb

@@ -16,12 +16,15 @@ module Yell #:nodoc:
         'DEFAULT' => "\e[0m"      # NONE
       }
 
+      # Accessor to the formatter
+      attr_reader :format
 
       def initialize( options = {}, &block )
-        format options[:format]
         colorize options.fetch(:colorize, false)
 
-        super
+        self.format = options[:format]
+
+        super( options, &block )
       end
 
       # The IO stream
@@ -40,11 +43,11 @@ module Yell #:nodoc:
       end
 
       # Set the format for your message.
-      def format( pattern, date_pattern = nil )
-        @formatter = case pattern
+      def format=( pattern )
+        @format = case pattern
           when Yell::Formatter then pattern
           when false then Yell::Formatter.new( "%m" )
-          else Yell::Formatter.new( pattern, date_pattern )
+          else Yell::Formatter.new( *pattern )
         end
       end
 
@@ -52,6 +55,7 @@ module Yell #:nodoc:
       def colorize( color = true )
         @colorize = color
       end
+      alias :colorize! :colorize
 
 
       private

data/lib/yell/level.rb

@@ -63,6 +63,12 @@ module Yell #:nodoc:
       index.nil? ? false : @severities[index]
     end
 
+    # to_i implements backwards compatibility
+    def to_i
+      @severities.each_with_index { |s,i| return i if s == true }
+    end
+    alias :to_int :to_i
+
     def at( *severities ) #:nodoc:
       severities.each { |severity| calculate! :==, severity }
       self

data/lib/yell/logger.rb

@@ -18,37 +18,41 @@ module Yell #:nodoc:
   # @example Setting the log level
   #   Yell::Logger.new :level => :warn
   #
-  #   Yell::Logger.new do
-  #     level :warn
+  #   Yell::Logger.new do |l|
+  #     l.level = :warn
   #   end
   #
   # @example Combined settings
   #   Yell::Logger.new 'development.log', :level => :warn
   #
-  #   Yell::Logger.new :datefile, 'development.log' do
-  #     level :info
+  #   Yell::Logger.new :datefile, 'development.log' do |l|
+  #     l.level = :info
   #   end
   class Logger
 
+    # Accessor to the log level
+    attr_reader :level
+
     def initialize( *args, &block )
       @adapters = []
 
       # extract options
       @options = args.last.is_a?(Hash) ? args.pop : {}
 
-      # set the log level when given
-      level @options[:level]
-
       # check if filename was given as argument and put it into the @options
       if args.last.is_a?( String )
         @options[:filename] = args.pop unless @options[:filename]
       end
 
+      # set the log level when given
+      self.level = @options[:level]
+
       # extract adapter
-      adapter args.pop if args.any?
+      self.adapter args.pop if args.any?
 
       # eval the given block
-      instance_eval( &block ) if block
+      # block.call(self) if block
+      _call( &block ) if block
 
       define!
     end
@@ -86,23 +90,52 @@ module Yell #:nodoc:
     # Set the minimum log level.
     #
     # @example Set the level to :warn
-    #   level :warn
+    #   level = :warn
     #
     # @param [String, Symbol, Integer] val The minimum log level
+    def level=( severity )
+      @level = Yell::Level.new( severity )
+    end
+
+    # Deprecated: Use attr_reader in future
     def level( val = nil )
-      @level = Yell::Level.new( val )
+      if val.nil?
+        @level
+      else
+        # deprecated, but should still work
+        Yell._deprecate( "0.5.0", "Use :level= for setting the log level",
+          :before => "Yell::Logger.new { level :info }",
+          :after  => "Yell::Logger.new { |l| l.level = :info }"
+        )
+
+        @level = Yell::Level.new( val )
+      end
     end
 
     # Convenience method for resetting all adapters of the Logger.
     #
     # @param [Boolean] now Perform the reset immediately (default false)
-    def close( now = false )
+    def close
       @adapters.each(&:close)
     end
 
 
     private
 
+    def _call( &block )
+      if block.arity == 0
+        Yell._deprecate( "0.5.0", "Yell::Logger.new with block expects argument now",
+          :before => "Yell::Logger.new { adapter STDOUT }",
+          :after  => "Yell::Logger.new { |l| l.adapter STDOUT }"
+        )
+
+        # deprecated, but should still work
+        instance_eval( &block )
+      else
+        block.call(self)
+      end
+    end
+
     # Sets a default adapter if none was given explicitly and defines the log methods on
     # the logger instance.
     def define!
@@ -114,11 +147,11 @@ 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 |s|
+      Yell::Severities.each_with_index do |s, index|
         name = s.downcase
 
         instance_eval %-
-          def #{name}?; #{@level.at?(name)}; end    # def info?; true; 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?

data/lib/yell/version.rb

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

data/spec/yell/adapters/base_spec.rb

@@ -5,7 +5,7 @@ describe Yell::Adapters::Base do
   context "initialize with :level" do
     before do
       any_instance_of( Yell::Adapters::Base ) do |base|
-        mock( base ).level( :info )
+        mock( base ).level= :info
       end
     end
 
@@ -18,7 +18,7 @@ describe Yell::Adapters::Base do
     context :level do
       before do
         any_instance_of( Yell::Adapters::Base ) do |base|
-          mock( base ).level( :info )
+          mock( base ).level= :info
         end
       end
 

data/spec/yell/adapters_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe Yell::Adapters do
+
+  context :new do
+    context "given a Yell::Adapters::Base ancestor" do
+      let( :stdout ) { Yell::Adapters::Stdout.new }
+
+      it "should return the instance" do
+        Yell::Adapters.new( stdout ).should == stdout
+      end
+    end
+
+    context "given STDOUT" do
+      it "should initialize Stdout adapter" do
+        mock.proxy( Yell::Adapters::Stdout ).new( anything )
+
+        Yell::Adapters.new STDOUT
+      end
+    end
+
+    context "given STDERR" do
+      it "should initialize Stderr adapter" do
+        mock.proxy( Yell::Adapters::Stderr ).new( anything )
+
+        Yell::Adapters.new STDERR
+      end
+    end
+
+    context "given an unregistered adapter" do
+      it "should raise NoSuchAdapter" do
+        lambda { Yell::Adapters.new :unknown }.should raise_error Yell::NoSuchAdapter
+      end
+    end
+  end
+
+  context :register do
+    let( :name ) { :test }
+    let( :klass ) { mock }
+
+    before { Yell::Adapters.register( name, klass ) }
+
+    it "should allow to being called from :new" do
+      mock( klass ).new( anything )
+
+      Yell::Adapters.new(name)
+    end
+  end
+
+end

data/spec/yell/level_spec.rb

@@ -95,4 +95,17 @@ describe Yell::Level do
     it { level.at?(:error).should be_true }
     it { level.at?(:fatal).should be_true }
   end
+
+  context "backwards compatibility" do
+    let( :level ) { Yell::Level.new :warn }
+
+    it { level.to_i.should == 2 }
+    it { Integer(level).should == 2 }
+
+    it "should be compatible when passing to array (https://github.com/rudionrails/yell/issues/1)" do
+      severities = %w(FINE INFO WARNING SEVERE SEVERE INFO)
+
+      severities[level].should == "WARNING"
+    end
+  end
 end

data/spec/yell/logger_spec.rb

@@ -37,9 +37,9 @@ describe Yell::Logger do
 
   context "a Logger instance with a given :filename" do
     it "should call adapter with :file" do
-      mock.proxy( Yell::Adapters::File ).new( anything )
+      mock.proxy( Yell::Adapters::File ).new( :filename => 'test.log' )
 
-      Yell::Logger.new
+      Yell::Logger.new 'test.log'
     end
   end
 
@@ -71,5 +71,28 @@ describe Yell::Logger do
     end
   end
 
+  context "a Logger instance with a given block" do
+    let( :level ) { Yell::Level.new :error }
+    let( :adapter ) { Yell::Adapters::Stdout.new }
+
+    let( :logger ) do 
+      Yell::Logger.new do |l| 
+        l.level = level
+        l.adapter adapter
+      end
+    end
+
+    it "should set the level" do
+      logger.level.severities.should == level.severities
+    end
+
+    it "should define adapter" do
+      adapters = logger.instance_variable_get :@adapters
+
+      adapters.size.should == 1
+      adapters.first.should == adapter
+    end
+  end
+
 end
 

data/yell.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Rudolf Schmidt"]
 
-  s.homepage    = "http://rubygems.org/gems/yell"
+  s.homepage    = "http://rudionrails.github.com/yell"
   s.summary     = %q{Yell - Your Extensible Logging Library }
   s.description = %q{Yell - Your Extensible Logging Library. Define multiple adapters, various log level combinations or message formatting options like you've never done before}
 
@@ -19,5 +19,6 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
+  s.add_development_dependency "rspec"
   s.add_development_dependency "rr"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yell
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-31 00:00:00.000000000 Z
+date: 2012-04-03 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70281944125180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70281944125180
 - !ruby/object:Gem::Dependency
   name: rr
-  requirement: &70326139575900 !ruby/object:Gem::Requirement
+  requirement: &70281944124740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +32,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70326139575900
+  version_requirements: *70281944124740
 description: Yell - Your Extensible Logging Library. Define multiple adapters, various
   log level combinations or message formatting options like you've never done before
 email: 
@@ -57,13 +68,14 @@ files:
 - lib/yell/version.rb
 - spec/spec_helper.rb
 - spec/yell/adapters/base_spec.rb
+- spec/yell/adapters_spec.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
+homepage: http://rudionrails.github.com/yell
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -90,6 +102,7 @@ summary: Yell - Your Extensible Logging Library
 test_files:
 - spec/spec_helper.rb
 - spec/yell/adapters/base_spec.rb
+- spec/yell/adapters_spec.rb
 - spec/yell/event_spec.rb
 - spec/yell/formatter_spec.rb
 - spec/yell/level_spec.rb