yell 0.13.4 → 1.0.0

data/README.md

@@ -1,6 +1,7 @@
 **Yell - Your Extensible Logging Library**
 
-[![Build Status](https://secure.travis-ci.org/rudionrails/yell.png?branch=master)](http://travis-ci.org/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.
 

data/examples/001-basic-usage.rb

@@ -22,3 +22,4 @@ EOS
 puts "=== actual example ==="
 logger = Yell.new STDOUT
 logger.info "Hello World!"
+

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

@@ -4,7 +4,7 @@ require_relative '../lib/yell'
 
 puts <<-EOS
 
-The extended formatting string looks like: %d [%5L] %p %h : %m.
+# The extended formatting string looks like: %d [%5L] %p %h : %m.
 
 logger = Yell.new STDOUT, :format => "[%f:%n in `%M'] %m"
 logger.info "Hello World!"

data/examples/005.1-repository.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+require_relative '../lib/yell'
+
+puts <<-EOS
+
+# You can add a logger to the global repository.
+#
+# create a logger named 'mylog' that logs to stdout
+Yell.new :stdout, :name => 'mylog'
+
+# Later in the code, you can get your logger back
+Yell['mylog'].info "Hello World!"
+
+
+EOS
+
+puts "=== actuale example ==="
+Yell.new :stdout, :name => 'mylog'
+Yell['mylog'].info "Hello World!"
+

data/examples/006.1-the-loggable-module.rb

@@ -0,0 +1,37 @@
+# encoding: utf-8
+
+require_relative '../lib/yell'
+
+puts <<-EOS
+
+# You can add logging to any class by including the Yell::Loggable module.
+#
+# When including the module, your class will get a :logger method. Before you
+# can use it, though, you will need to define a logger providing the :name of
+# your class.
+
+Yell.new :stdout, :name => 'Foo'
+
+# Define the class
+class Foo
+  include Yell::Loggable
+end
+
+foo = Foo.new
+foo.logger.info "Hello World!"
+#=> "2012-02-29T09:30:00+01:00 [ INFO] 65784 : Hello World!"
+
+
+EOS
+
+puts "=== actual example ==="
+
+Yell.new :stdout, :name => 'Foo'
+
+class Foo
+  include Yell::Loggable
+end
+
+foo = Foo.new
+foo.logger.info "Hello World!"
+

data/lib/yell.rb

@@ -57,13 +57,6 @@ module Yell #:nodoc:
       Yell::Repository[ name ] = logger
     end
 
-    # Shortcut to Yell::Repository.loggers
-    #
-    # @return [Hash] The map of loggers
-    def loggers
-      Yell::Repository.loggers
-    end
-
     # Shortcut to Yell::Fomatter.new
     #
     # @return [Yell::Formatter] A Yell::Formatter instance
@@ -107,6 +100,7 @@ module Yell #:nodoc:
 
 end
 
+# classes
 require File.dirname(__FILE__) + '/yell/configuration'
 require File.dirname(__FILE__) + '/yell/repository'
 require File.dirname(__FILE__) + '/yell/event'
@@ -115,3 +109,6 @@ require File.dirname(__FILE__) + '/yell/formatter'
 require File.dirname(__FILE__) + '/yell/adapters'
 require File.dirname(__FILE__) + '/yell/logger'
 
+# modules
+require File.dirname(__FILE__) + '/yell/loggable'
+

data/lib/yell/adapters.rb

@@ -2,9 +2,9 @@
 
 module Yell #:nodoc:
 
-  # NoSuchAdapter is raised whenever you want to instantiate an 
+  # AdapterNotFound is raised whenever you want to instantiate an 
   # adapter that does not exist.
-  class UnregisteredAdapter < StandardError; end
+  class AdapterNotFound < StandardError; end
 
   # This module provides the interface to attaching adapters to
   # the logger. You should not have to call the corresponding classes
@@ -35,7 +35,7 @@ module Yell #:nodoc:
           else @@adapters[name]
         end
 
-        raise UnregisteredAdapter.new( name ) unless adapter
+        raise AdapterNotFound.new( name ) unless adapter
 
         adapter.new( options, &block )
       end

data/lib/yell/adapters/datefile.rb

@@ -114,7 +114,8 @@ module Yell #:nodoc:
       end
 
       def symlink!
-        return if ::File.symlink?(@original_filename) && ::File.readlink(@original_filename) == @filename # do nothing, because symlink is already correct
+        # do nothing, because symlink is already correct
+        return if ::File.symlink?(@original_filename) && ::File.readlink(@original_filename) == @filename
 
         ::File.unlink( @original_filename ) if ::File.exist?( @original_filename )
         ::File.symlink( @filename, @original_filename )

data/lib/yell/adapters/file.rb

@@ -23,7 +23,6 @@ module Yell #:nodoc:
         @stream = ::File.open( @filename, ::File::WRONLY|::File::APPEND|::File::CREAT )
         @stream.sync = true
 
-
         @stream
       end
 

data/lib/yell/level.rb

@@ -61,18 +61,7 @@ module Yell #:nodoc:
     #
     # @param [Integer,String,Symbol,Array,Range,nil] severity The severity for the level.
     def initialize( severity = nil )
-      reset!
-
-      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 )
-      end
-    end
-
-    def reset!
-      @severities = Yell::Severities.map { true }
+      reset!( severity )
     end
 
     # Returns whether the level is allowed at the given severity
@@ -80,46 +69,89 @@ module Yell #:nodoc:
     # @example
     #   at? :warn
     #   at? 0       # debug
+    #
+    # @return [Boolean] tru or false
     def at?( severity )
       index = index_from( severity )
 
       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:
+    # Set the level at specific severities.
+    #
+    # @example Set at :debug and :error only
+    #   at :debug, :error
+    #
+    # @return [Yell::Level] the instance
+    def at( *severities )
       severities.each { |severity| calculate! :==, severity }
       self
     end
 
-    def gt( severity ) #:nodoc:
+    # Set the level to greater than the given severity
+    #
+    # @example Set to :error and above
+    #   gt :warn
+    #
+    # @return [Yell::Level] the instance
+    def gt( severity )
       calculate! :>, severity
       self
     end
 
-    def gte( severity ) #:nodoc:
+    # Set the level greater or equal to the given severity
+    #
+    # @example Set to :warn and above
+    #   gte :warn
+    #
+    # @return [Yell::Level] the instance
+    def gte( severity )
       calculate! :>=, severity
       self
     end
 
-    def lt( severity ) #:nodoc:
+    # Set the level lower than given severity
+    #
+    # @example Set to lower than :warn
+    #   lt :warn
+    #
+    # @return [Yell::Level] the instance
+    def lt( severity )
       calculate! :<, severity
       self
     end
 
-    def lte( severity ) #:nodoc:
+    # Set the level lower or equal than given severity
+    #
+    # @example Set to lower or equal than :warn
+    #   lte :warn
+    #
+    # @return [Yell::Level] the instance
+    def lte( severity )
       calculate! :<=, severity
       self
     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
+
 
     private
 
+    def reset!( severity )
+      @severities = Yell::Severities.map { true }
+
+      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 )
+      end
+    end
+
     def interpret!( severities )
       severities.split( ' ' ).each do |severity|
         if m = InterpretRegexp.match(severity)
@@ -128,7 +160,7 @@ module Yell #:nodoc:
       end
     end
 
-    def calculate!( modifier, severity ) #:nodoc:
+    def calculate!( modifier, severity )
       index = index_from( severity )
       return if index.nil?
 
@@ -143,7 +175,7 @@ module Yell #:nodoc:
       taint unless tainted?
     end
 
-    def index_from( severity ) #:nodoc:
+    def index_from( severity )
       case severity
         when Integer        then severity
         when String, Symbol then Yell::Severities.index( severity.to_s.upcase )
@@ -151,28 +183,27 @@ module Yell #:nodoc:
       end
     end
 
-    def ascending!( index ) #:nodoc:
-      @severities.each_with_index do |s, i|
-        next if s == false # skip
+    def ascending!( index )
+      each { |s, i| @severities[i] = i < index ? false : true }
+    end
 
-        @severities[i] = i < index ? false : true
-      end
+    def descending!( index )
+      each { |s, i| @severities[i] = index < i ? false : true }
     end
 
-    def descending!( index ) #:nodoc:
+    def each
       @severities.each_with_index do |s, i|
         next if s == false # skip
 
-        @severities[i] = index < i ? false : true
+        yield(s, i)
       end
     end
 
-    def set!( index ) #:nodoc:
+    def set!( index, val = true )
       @severities.map! { false } unless tainted?
 
-      @severities[index] = true
+      @severities[index] = val
     end
 
   end
-
 end

data/lib/yell/loggable.rb

@@ -0,0 +1,27 @@
+# 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 
+  # available. Before you can use it, you will need to define a Yell logger and 
+  # provide it with the name of your class.
+  #
+  # @example
+  #   Yell.new :stdout, :name => 'Foo'
+  #
+  #   class Foo
+  #     include Yell::Loggable
+  #   end
+  #
+  #   Foo.new.logger.info "Hello World"
+  module Loggable
+
+    def logger
+      Yell[ self.class ]
+    end
+
+  end
+end
+

data/lib/yell/logger.rb

@@ -114,8 +114,6 @@ module Yell #:nodoc:
     end
 
     # Convenience method for resetting all adapters of the Logger.
-    #
-    # @param [Boolean] now Perform the reset immediately (default false)
     def close
       @adapters.each(&:close)
     end
@@ -133,7 +131,7 @@ module Yell #:nodoc:
         def #{name}?; @level.at?(#{index}); end     # def info?; @level.at?(1); end
                                                     #
         def #{name}( m = nil, o = {}, &b )          # def info( m = nil, o = {}, &b )
-          return unless #{name}?                    #   return unless info?
+          return false unless #{name}?              #   return false unless info?
           write Yell::Event.new(#{index}, m, o, &b) #   write Yell::Event.new(1, m, o, &b)
                                                     #
           true                                      #   true

data/lib/yell/repository.rb

@@ -4,6 +4,11 @@ require 'monitor'
 require "singleton"
 
 module Yell #:nodoc:
+
+  class LoggerNotFound < StandardError
+    def message; "Could not find a Yell::Logger instance with the name '#{super}'"; end
+  end
+
   class Repository
     extend MonitorMixin
     include Singleton
@@ -29,9 +34,18 @@ module Yell #:nodoc:
     # @example Get the logger
     #   Yell::Repository[ 'development' ]
     #
+    # @raise [Yell::LoggerNotFound] Raised when repository does not have that key
     # @return [Yell::Logger] The logger instance
     def self.[]( name )
-      synchronize { instance.loggers[name] }
+      synchronize do
+        logger = instance.loggers[name] || instance.loggers[name.to_s]
+
+        if logger.nil? && name.respond_to?(:superclass)
+          return Yell::Repository[ name.superclass ]
+        end
+
+        logger or raise Yell::LoggerNotFound.new(name)
+      end
     end
 
     # Get the list of all loggers in the repository
@@ -41,11 +55,6 @@ module Yell #:nodoc:
       synchronize { instance.loggers }
     end
 
-    # Clears all logger instances (handy for testing)
-    def self.clear
-      synchronize { instance.loggers.clear }
-    end
-
   end
 end
 

data/lib/yell/version.rb

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

data/spec/spec_helper.rb

@@ -13,7 +13,7 @@ RSpec.configure do |config|
   config.mock_framework = :rr
 
   config.before do
-    Yell::Repository.clear
+    Yell::Repository.loggers.clear
   end
 
   config.after do

data/spec/threaded/yell_spec.rb

@@ -39,3 +39,4 @@ describe "running Yell multi-threaded" do
   end
 
 end
+

data/spec/yell/adapters_spec.rb

@@ -28,8 +28,8 @@ describe Yell::Adapters do
     end
 
     context "given an unregistered adapter" do
-      it "should raise UnregisteredAdapter" do
-        lambda { Yell::Adapters.new :unknown }.should raise_error Yell::UnregisteredAdapter
+      it "should raise AdapterNotFound" do
+        lambda { Yell::Adapters.new :unknown }.should raise_error Yell::AdapterNotFound
       end
     end
   end

data/spec/yell/level_spec.rb

@@ -72,41 +72,61 @@ describe Yell::Level do
     context "basic string" do
       subject { 'error' }
 
-      it { level.at?(:debug).should be_false }
-      it { level.at?(:info).should be_false }
-      it { level.at?(:warn).should be_false }
-      it { level.at?(:error).should be_true }
-      it { level.at?(:fatal).should be_true }
+      it "should be valid" do
+        level.at?(:debug).should be_false
+        level.at?(:info).should be_false
+        level.at?(:warn).should be_false
+        level.at?(:error).should be_true
+        level.at?(:fatal).should be_true
+      end
     end
 
     context "complex string with outer boundaries" do
       subject { 'gte.info lte.error' }
 
-      it { level.at?(:debug).should be_false }
-      it { level.at?(:info).should be_true }
-      it { level.at?(:warn).should be_true }
-      it { level.at?(:error).should be_true }
-      it { level.at?(:fatal).should be_false }
+      it "should be valid" do
+        level.at?(:debug).should be_false
+        level.at?(:info).should be_true
+        level.at?(:warn).should be_true
+        level.at?(:error).should be_true
+        level.at?(:fatal).should be_false
+      end
     end
 
     context "complex string with inner boundaries" do
       subject { 'gt.info lt.error' }
 
-      it { level.at?(:debug).should be_false }
-      it { level.at?(:info).should be_false }
-      it { level.at?(:warn).should be_true }
-      it { level.at?(:error).should be_false }
-      it { level.at?(:fatal).should be_false }
+      it "should be valid" do
+        level.at?(:debug).should be_false
+        level.at?(:info).should be_false
+        level.at?(:warn).should be_true
+        level.at?(:error).should be_false
+        level.at?(:fatal).should be_false
+      end
     end
 
     context "complex string with precise boundaries" do
       subject { 'at.info at.error' }
 
-      it { level.at?(:debug).should be_false }
-      it { level.at?(:info).should be_true }
-      it { level.at?(:warn).should be_false }
-      it { level.at?(:error).should be_true }
-      it { level.at?(:fatal).should be_false }
+      it "should be valid" do
+        level.at?(:debug).should be_false
+        level.at?(:info).should be_true
+        level.at?(:warn).should be_false
+        level.at?(:error).should be_true
+        level.at?(:fatal).should be_false
+      end
+    end
+
+    context "complex string with combined boundaries" do
+      subject { 'gte.error at.debug' }
+
+      it "should be valid" do
+        level.at?(:debug).should be_true
+        level.at?(:info).should be_false
+        level.at?(:warn).should be_false
+        level.at?(:error).should be_true
+        level.at?(:fatal).should be_true
+      end
     end
   end
 

data/spec/yell/loggable_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+class LoggableFactory
+  include Yell::Loggable
+end
+
+describe Yell::Loggable do
+  subject { LoggableFactory.new }
+
+  it { should respond_to :logger }
+
+  it ":logger should pass class name to the repository" do
+    mock( Yell::Repository )[ LoggableFactory ]
+
+    subject.logger
+  end
+
+end
+

data/spec/yell/repository_spec.rb

@@ -8,16 +8,32 @@ describe Yell::Repository do
 
 
   context ".[]" do
-    context "when not set" do
-      it { should be_nil }
+    it "should raise when not set" do
+      lambda { subject }.should raise_error( Yell::LoggerNotFound )
     end
 
-    context "when assigned" do
+    it "should return the logger when set" do
+      Yell::Repository[ name ] = logger
+
+      subject.should == logger
+    end
+
+    context "given a Class" do
       before do
-        Yell::Repository[ name ] = logger
+        @logger = Yell.new :stdout, :name => "Numeric"
+      end
+
+      it "should raise when not set" do
+        lambda { Yell::Repository[ String ] }.should raise_error( Yell::LoggerNotFound )
+      end
+
+      it "should return the logger" do
+        Yell::Repository[ Numeric ].should == @logger
       end
 
-      it { should == logger }
+      it "should return the logger when superclass has it defined" do
+        Yell::Repository[ Integer ].should == @logger
+      end
     end
   end
 
@@ -63,15 +79,5 @@ describe Yell::Repository do
     it { should == loggers }
   end
 
-  context "clear" do
-    subject { Yell::Repository.loggers }
-
-    before do
-      Yell::Repository[ name ] = logger
-      Yell::Repository.clear
-    end
-
-    it { should be_empty }
-  end
 end
 

data/spec/yell_spec.rb

@@ -7,8 +7,8 @@ describe Yell do
 
   it { should be_kind_of Yell::Logger }
 
-  it "should raise UnregisteredAdapter when adapter cant be loaded" do
-    lambda { Yell.new :unknownadapter }.should raise_error( Yell::UnregisteredAdapter )
+  it "should raise AdapterNotFound when adapter cant be loaded" do
+    lambda { Yell.new :unknownadapter }.should raise_error( Yell::AdapterNotFound )
   end
 
   context :level do
@@ -53,14 +53,6 @@ describe Yell do
     end
   end
 
-  context :loggers do
-    it "should delegate to the repository" do
-      mock.proxy( Yell::Repository ).loggers
-
-      Yell.loggers
-    end
-  end
-
   context :env do
     subject { Yell.env }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yell
 version: !ruby/object:Gem::Version
-  version: 0.13.4
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-14 00:00:00.000000000 Z
+date: 2012-09-17 00:00:00.000000000 Z
 dependencies: []
 description: Yell - Your Extensible Logging Library. Define multiple adapters, various
   log level combinations or message formatting options like you've never done before
@@ -33,6 +33,8 @@ files:
 - examples/003.3-formatting-ExtendedFormat.rb
 - examples/003.4-formatting-on-your-own.rb
 - examples/004.1-colorizing-the-log-output.rb
+- examples/005.1-repository.rb
+- examples/006.1-the-loggable-module.rb
 - lib/yell.rb
 - lib/yell/adapters.rb
 - lib/yell/adapters/base.rb
@@ -44,6 +46,7 @@ files:
 - lib/yell/event.rb
 - lib/yell/formatter.rb
 - lib/yell/level.rb
+- lib/yell/loggable.rb
 - lib/yell/logger.rb
 - lib/yell/repository.rb
 - lib/yell/version.rb
@@ -60,6 +63,7 @@ files:
 - spec/yell/event_spec.rb
 - spec/yell/formatter_spec.rb
 - spec/yell/level_spec.rb
+- spec/yell/loggable_spec.rb
 - spec/yell/logger_spec.rb
 - spec/yell/repository_spec.rb
 - spec/yell_spec.rb
@@ -102,6 +106,7 @@ test_files:
 - spec/yell/event_spec.rb
 - spec/yell/formatter_spec.rb
 - spec/yell/level_spec.rb
+- spec/yell/loggable_spec.rb
 - spec/yell/logger_spec.rb
 - spec/yell/repository_spec.rb
 - spec/yell_spec.rb