yell 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: f9ecfe3dde614dc7aaa4d58f6617323dfd22aa6b
-  data.tar.gz: a16b4a0ed5c83a1d722570a7d4e92eb0886856ff
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MTI3NDViZDY2MmQ1M2JlNjFiYmIxY2RkOWU0NzQ0MWFmY2RiYmNlZQ==
+  data.tar.gz: !binary |-
+    ZDQxN2VlMjY4Nzc5Nzg3MjZjYmFiYTk3MTg1MjNhODU2ODAzMDE5MQ==
 SHA512:
-  metadata.gz: dbfd34addbe7e79d5a0264f927f64bd9808a1cc09dbe4e56fda1b09677e66cdcb20c527e86a75cbb0954bc9f9f3cfd4ef5b67b052c1d19527888fe856d43f116
-  data.tar.gz: 438d38c8cdd63f08eb32d991eacb04eb1aa1b3bd7020a017d44b954d80bc268c69132ddcc36bdd967c809a57804abfe14656d90912ab2833d878808302e936aa
+  metadata.gz: !binary |-
+    NDczNmE5NGFlN2E5MGZiNmI0OGNmOTRmYTY2ODliNjc1MDBlZDIyZWFkMzU1
+    OTk4NTAwZWFjMDFjMmQzMGU5YTkyNzcwMGE5MTRkODA0ODFiODYwMTM5ZTgy
+    ZWVhNWUxNWMwOTU3MTIyZDc2ZThiNTAwNzE3Njk4NDVmMTg2NmM=
+  data.tar.gz: !binary |-
+    OTNhMGVkY2NmZGQ5NWUwNjU3YmQ1MjY2MGQ4OThhNTFhNTc1MTZhYTA0NGM3
+    YmIxYzY1NjZiOTRiM2UzNzNlYjA2NWYxMzg5Y2ExOWVmNjFiYzgwM2Q4YzZi
+    ODMyNjU1NzMzN2QxZmNjMTQ2YmRlZDhkOTZmZGU4YmFlOGVmYjQ=

data/Gemfile

@@ -9,7 +9,8 @@ group :development, :test do
   gem 'rspec-core'
   gem 'rspec-expectations'
   gem "rr"
-  gem "timecop"
+
+  gem 'timecop', '0.6.1'
 
   gem 'simplecov', :require => false, :platform => :ruby_20
   gem 'coveralls', :require => false, :platform => :ruby_20

data/lib/yell.rb

@@ -60,8 +60,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 +71,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'
@@ -105,7 +110,7 @@ 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 +129,12 @@ require File.dirname(__FILE__) + '/yell/logger'
 # modules
 require File.dirname(__FILE__) + '/yell/loggable'
 
+# 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
+
+
+

data/lib/yell/adapters.rb

@@ -39,6 +39,21 @@ module Yell #:nodoc:
       adapter.new(options, &block)
     end
 
+    # Thanks, railties :-)
+    def self.broadcast( adapter )
+      Module.new do
+        define_method(:write) do |event|
+          adapter.write(event)
+          super(event)
+        end
+
+        define_method(:close) do
+          adapter.close
+          super()
+        end
+      end
+    end
+
   end
 end
 

data/lib/yell/adapters/base.rb

@@ -155,7 +155,7 @@ module Yell #:nodoc:
         # make sure the adapter is closed and re-raise the exception
         synchronize { close }
 
-        raise( e )
+        raise(e)
       end
 
       # Close the adapter (stream, connection, etc).
@@ -172,11 +172,8 @@ module Yell #:nodoc:
         "#<#{self.class.name} #{inspection * ', '}>"
       end
 
-      private
 
-      # def reset!
-      #   super()
-      # end
+      private
 
       # Setup the adapter instance.
       #
@@ -219,7 +216,7 @@ module Yell #:nodoc:
       #
       # @return [Boolean] true or false
       def write?( event )
-        @level.nil? || @level.at?( event.level )
+        @level.nil? || @level.at?(event.level)
       end
 
       # Get an array of inspected attributes for the adapter.

data/lib/yell/adapters/datefile.rb

@@ -184,8 +184,6 @@ module Yell #:nodoc:
 
     end
 
-    register( :datefile, Yell::Adapters::Datefile )
-
   end
 end
 

data/lib/yell/adapters/file.rb

@@ -31,8 +31,6 @@ module Yell #:nodoc:
 
     end
 
-    register( :file, Yell::Adapters::File )
-
   end
 end
 

data/lib/yell/adapters/streams.rb

@@ -27,9 +27,6 @@ module Yell #:nodoc:
 
     end
 
-    register( :stdout, Yell::Adapters::Stdout )
-    register( :stderr, Yell::Adapters::Stderr )
-
   end
 end
 

data/lib/yell/event.rb

@@ -27,10 +27,14 @@ module Yell #:nodoc:
     # Accessor to the time the log event occured
     attr_reader :time
 
+    # Accessor to the logger's name
+    attr_reader :name
+
 
     def initialize(logger, level, *messages, &block)
-      @time     = Time.now
-      @level    = level
+      @time   = Time.now
+      @level  = level
+      @name   = logger.name
 
       @messages = messages
       @messages << block.call if block

data/lib/yell/formatter.rb

@@ -58,7 +58,8 @@ module Yell #:nodoc:
       "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
+      "n" => "event.line",                 # Line where the logger was called
+      "N" => "event.name"                  # Name of the logger
     }
 
     Matcher = /([^%]*)(%\d*)?(#{Table.keys.join('|')})?(.*)/
@@ -66,12 +67,29 @@ module Yell #:nodoc:
 
     # Initializes a new +Yell::Formatter+.
     #
-    # Upon initialization it defines a format method. `format` takes 
-    # a {Yell::Event} instance as agument in order to apply for desired log 
+    # Upon initialization it defines a format method. `format` takes
+    # a {Yell::Event} instance as agument in order to apply for desired log
     # message formatting.
-    def initialize( pattern = nil, date_pattern = nil )
-      @pattern      = pattern || Yell::DefaultFormat
-      @date_pattern = date_pattern || :iso8601
+    #
+    # @example Blank formatter
+    #   Formatter.new
+    #
+    # @example Formatter with a message pattern
+    #   Formatter.new("%d [%5L] %p : %m")
+    #
+    # @example Formatter with a message and date pattern
+    #   Formatter.new("%d [%5L] %p : %m", "%D %H:%M:%S.%L")
+    #
+    # @example Formatter with a message modifier
+    #   Formatter.new do |f|
+    #     f.modify(Hash) { |h| "Hash: #{h.inspect}" }
+    #   end
+    def initialize( *args, &block )
+      builder = Builder.new(*args, &block)
+
+      @pattern = builder.pattern
+      @date_pattern = builder.date_pattern
+      @modifier = builder.modifier
 
       define_date_method!
       define_format_method!
@@ -85,6 +103,51 @@ module Yell #:nodoc:
 
     private
 
+    # Message modifier class to allow different modifiers for different requirements.
+    class Modifier
+      def initialize
+        @repository = {}
+      end
+
+      def set( key, &block )
+        @repository.merge!(key => block)
+      end
+
+      def call( message )
+        case
+        when mod = @repository[message.class] || @repository[message.class.to_s]
+          mod.call(message)
+        when message.is_a?(Hash)
+          message.map { |k,v| "#{k}: #{v}" }.join(", ")
+        when message.is_a?(Exception)
+          backtrace = message.backtrace ? "\n\t#{message.backtrace.join("\n\t")}" : ""
+          sprintf("%s: %s%s", message.class, message.message, backtrace)
+        else
+          message
+        end
+      end
+    end
+
+    # Builder class to allow setters that won't be accessible once
+    # transferred to the Formatter
+    class Builder
+      attr_accessor :pattern, :date_pattern
+      attr_reader :modifier
+
+      def initialize( pattern = nil, date_pattern = nil, &block )
+        @modifier = Modifier.new
+
+        @pattern = pattern || Yell::DefaultFormat
+        @date_pattern = date_pattern || :iso8601
+
+        block.call(self) if block
+      end
+
+      def modify( key, &block )
+        modifier.set(key, &block)
+      end
+    end
+
     def define_date_method!
       buf = case @date_pattern
       when String then "t.strftime(@date_pattern)"
@@ -141,19 +204,7 @@ module Yell #:nodoc:
     end
 
     def message( *messages )
-      messages.map { |m| to_message(m) }.join(" ")
-    end
-
-    def to_message( m )
-      case m
-      when Hash
-        m.map { |k,v| "#{k}: #{v}" }.join( ", " )
-      when Exception
-        backtrace = m.backtrace ? "\n\t#{m.backtrace.join("\n\t")}" : ""
-        sprintf("%s: %s%s", m.class, m.message, backtrace)
-      else
-        m
-      end
+      messages.map { |m| @modifier.call(m) }.join(" ")
     end
 
   end

data/lib/yell/helpers/{adapters.rb → adapter.rb}

@@ -1,7 +1,7 @@
 # encoding: utf-8
 module Yell #:nodoc:
   module Helpers #:nodoc:
-    module Adapters #:nodoc:
+    module Adapter #:nodoc:
 
       # Define an adapter to be used for logging.
       #
@@ -18,29 +18,38 @@ module Yell #:nodoc:
       #   adapter :file, 'development.log', :level => :warn
       #
       # @example Set the adapter directly from an adapter instance
-      #   adapter( Yell::Adapter::File.new )
+      #   adapter Yell::Adapter::File.new
       #
       # @param [Symbol] type The type of the adapter, may be `:file` or `:datefile` (default `:file`)
       # @return [Yell::Adapter] The instance
       # @raise [Yell::NoSuchAdapter] Will be thrown when the adapter is not defined
       def adapter( type = :file, *args, &block )
-        options = [@options, *args].inject( Hash.new ) do |h, c|
+        options = [@options, *args].inject(Hash.new) do |h, c|
           h.merge( [String, Pathname].include?(c.class) ? {:filename => c} : c  )
         end
 
-        @adapters << Yell::Adapters.new(type, options, &block)
+        new_adapter = Yell::Adapters.new(type, options, &block)
+
+        # Also replaces the :null logger of type Yell::Adapters::Base
+        if @_adapter.nil? || @_adapter.instance_of?(Yell::Adapters::Base)
+          @_adapter = new_adapter
+        else
+          @_adapter.extend(Yell::Adapters.broadcast(new_adapter))
+        end
+
+        _adapter
       end
 
       # @private
-      def adapters
-        @adapters
+      def _adapter
+        @_adapter
       end
 
 
       private
 
       def reset!
-        @adapters = []
+        @_adapter = nil
 
         super
       end

data/lib/yell/logger.rb

@@ -38,7 +38,7 @@ module Yell #:nodoc:
     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
 
@@ -74,14 +74,14 @@ module Yell #:nodoc:
       @options = args.last.is_a?(Hash) ? args.pop : {}
 
       # adapters may be passed in the options
-      extract!(@options)
+      extract!(*@options[:adapters]) if @options.key?(:adapters)
 
       # 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.level = @options.fetch(:level, 0) # debug by default
       self.name = @options.fetch(:name, nil) # no name by default
       self.trace = @options.fetch(:trace, :error) # trace from :error level onwards
 
@@ -95,7 +95,7 @@ module Yell #:nodoc:
       block.arity > 0 ? block.call(self) : instance_eval(&block) if block_given?
 
       # default adapter when none defined
-      self.adapter(:file) if adapters.empty?
+      self.adapter(:file) if _adapter.nil?
     end
 
 
@@ -138,12 +138,12 @@ 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)
+      _adapter.close
     end
 
 
@@ -153,22 +153,22 @@ 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|
+    #   extract!(:stdout => {:level => :info}, :stderr => {:level => :error})
+    def extract!( *adapters )
+      adapters.each do |a|
         case a
-        when String, Symbol then adapter( a )
-        else a.each { |n, o| adapter( n, o || {} ) }
+        when Hash then 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) }
+      _adapter.write(event)
     end
 
     # Get an array of inspected attributes for the adapter.

data/lib/yell/version.rb

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

data/spec/threaded/yell_spec.rb

@@ -96,5 +96,6 @@ describe "running Yell multi-threaded" do
   def datefile_pattern_for( time )
     time.strftime(Yell::Adapters::Datefile::DefaultDatePattern)
   end
+
 end
 

data/spec/yell/formatter_spec.rb

@@ -2,20 +2,22 @@ require 'spec_helper'
 
 describe Yell::Formatter do
 
-  let(:logger) { Yell::Logger.new }
-  let(:event) { Yell::Event.new(logger, 1, 'Hello World!') }
-  let(:time) { Time.now }
+  let(:logger) { Yell::Logger.new(:stdout, :name => 'Yell') }
+  let(:message) { "Hello World!" }
+  let(:event) { Yell::Event.new(logger, 1, message) }
 
   let(:pattern) { "%m" }
   let(:formatter) { Yell::Formatter.new(pattern) }
 
+  let(:time) { Time.now }
+
+  subject { formatter.format(event) }
+
   before do
     Timecop.freeze(time)
   end
 
-  describe "#format" do
-    subject { formatter.format(event) }
-
+  describe "patterns" do
     context "%m" do
       let(:pattern) { "%m" }
       it { should eq(event.messages.join(' ')) }
@@ -45,6 +47,7 @@ describe Yell::Formatter do
       let(:pattern) { "%P" }
       it { should eq(event.progname) }
     end
+
     context "%t" do
       let(:pattern) { "%t" }
       it { should eq(event.thread_id.to_s) }
@@ -86,11 +89,14 @@ describe Yell::Formatter do
         it { should eq("123") }
       end
     end
-  end
 
-  describe "#format from presets" do
-    subject { formatter.format(event) }
+    context "%N" do
+      let(:pattern) { "%N" }
+      it { should eq("Yell") }
+    end
+  end
 
+  describe "presets" do
     context "NoFormat" do
       let(:pattern) { Yell::NoFormat }
       it { should eq("Hello World!") }
@@ -112,25 +118,29 @@ describe Yell::Formatter do
     end
   end
 
-  describe "#format from exception" do
-    let(:exception) { StandardError.new( "This is an Exception" ) }
-    let(:event) { Yell::Event.new(logger, 1, exception) }
-    subject { formatter.format(event) }
+  describe "Exception" do
+    let(:message) { StandardError.new("This is an Exception") }
 
     before do
-      mock(exception).backtrace.times(any_times) { ["backtrace"] }
+      stub(message).backtrace { ["backtrace"] }
     end
 
     it { should eq("StandardError: This is an Exception\n\tbacktrace") }
   end
 
-  describe "#format from hash messages" do
-    let(:hash) { { :test => 'message' } }
-    let(:event) { Yell::Event.new(logger, 1, hash) }
-    subject { formatter.format(event) }
+  describe "Hash" do
+    let(:message) { {:test => 'message'} }
 
     it { should eq("test: message") }
   end
 
+  describe "custom message modifiers" do
+    let(:formatter) do
+      Yell::Formatter.new(pattern) { |f| f.modify(String) { |m| "Modified! #{m}" } }
+    end
+
+    it { should eq("Modified! #{message}") }
+  end
+
 end
 

data/spec/yell/logger_spec.rb

@@ -41,11 +41,10 @@ describe Yell::Logger do
       it { should respond_to(:unknown?) }
     end
 
-    context "default #adapters" do
-      subject { logger.adapters }
+    context "default #adapter" do
+      subject { logger._adapter }
 
-      its(:size) { should eq(1) }
-      its(:first) { should be_kind_of(Yell::Adapters::File) }
+      it { should be_kind_of(Yell::Adapters::File) }
     end
 
     context "default #level" do
@@ -67,6 +66,10 @@ describe Yell::Logger do
     let(:name) { 'test' }
     let!(:logger) { Yell.new(:name => name) }
 
+    it "should set the name correctly" do
+      expect(logger.name).to eq(name)
+    end
+
     it "should be added to the repository" do
       expect(Yell::Repository[name]).to eq(logger)
     end
@@ -152,8 +155,7 @@ describe Yell::Logger do
       end
 
       its(:level) { should eq(level) }
-      its('adapters.size') { should eq(1) }
-      its('adapters.first') { should be_instance_of(Yell::Adapters::Stdout) }
+      its(:_adapter) { should be_instance_of(Yell::Adapters::Stdout) }
     end
 
     context "without arity" do
@@ -162,31 +164,18 @@ describe Yell::Logger do
       end
 
       its(:level) { should eq(level) }
-      its('adapters.size') { should eq(1) }
-      its('adapters.first') { should be_instance_of(Yell::Adapters::Stdout) }
+      its(:_adapter) { should be_instance_of(Yell::Adapters::Stdout) }
     end
   end
 
   context "initialize with #adapters option" do
-    let(:logger) do
-      Yell::Logger.new(:adapters => [:stdout, {:stderr => {:level => :error}}])
-    end
-
-    let(:adapters) { logger.instance_variable_get(:@adapters) }
-    let(:stdout) { adapters.first }
-    let(:stderr) { adapters.last }
-
-    it "should define those adapters" do
-      expect(adapters.size).to eq(2)
-
-      expect(stdout).to be_kind_of(Yell::Adapters::Stdout)
-      expect(stderr).to be_kind_of(Yell::Adapters::Stderr)
-    end
+    it "should set adapters in logger correctly" do
+      any_instance_of(Yell::Logger) do |logger|
+        mock.proxy(logger).adapter(:stdout)
+        mock.proxy(logger).adapter(:stderr, :level => :error)
+      end
 
-    it "should pass :level to :stderr adapter" do
-      expect(stderr.level.at?(:warn)).to be_false
-      expect(stderr.level.at?(:error)).to be_true
-      expect(stderr.level.at?(:fatal)).to be_true
+      Yell::Logger.new(:adapters => [:stdout, {:stderr => {:level => :error}}])
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yell
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Rudolf Schmidt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-20 00:00:00.000000000 Z
+date: 2013-10-03 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
@@ -45,7 +45,7 @@ files:
 - lib/yell/configuration.rb
 - lib/yell/event.rb
 - lib/yell/formatter.rb
-- lib/yell/helpers/adapters.rb
+- lib/yell/helpers/adapter.rb
 - lib/yell/helpers/base.rb
 - lib/yell/helpers/formatter.rb
 - lib/yell/helpers/level.rb
@@ -85,17 +85,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: yell
-rubygems_version: 2.0.0
+rubygems_version: 2.1.5
 signing_key: 
 specification_version: 4
 summary: Yell - Your Extensible Logging Library
@@ -118,3 +118,4 @@ test_files:
 - spec/yell/repository_spec.rb
 - spec/yell/silencer_spec.rb
 - spec/yell_spec.rb
+has_rdoc: