dlogger 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage/
+tests/
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,19 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dlogger.gemspec
+gemspec
+
+gem 'eventmachine', '~> 1.0.0.beta'
+gem 'yajl-ruby'
+
+group(:test) do
+  gem 'schmurfy-bacon', '~> 1.2.1'
+  gem 'mocha',          '~> 0.10.0'
+  gem 'simplecov'
+  gem 'schmurfy-em-spec'
+  gem 'guard'
+  gem 'guard-bacon'
+  gem 'rb-fsevent'
+  gem 'growl'
+end
+

data/Guardfile

@@ -0,0 +1,15 @@
+
+require 'erb'
+
+# parameters:
+#  output     => the formatted to use
+#  backtrace  => number of lines, nil =  everything
+guard 'bacon', :output => "BetterOutput", :backtrace => 4 do
+  watch(%r{^lib/dlogger/(.+)\.rb$})     { |m| "specs/lib/#{m[1]}_spec.rb" }
+  watch(%r{specs/.+_spec\.rb$})
+end
+
+guard 'tilt' do
+  watch(%r{README.md.erb})
+  watch(%r{examples/.*\.rb}){ "README.md.erb" }
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Julien Ammous
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,182 @@
+# What is this ?
+
+I was never happy with printf style logs, you rarely know at first what you need to put in them and how to format
+them so you just drop a ruby logger and log anything. Your log messages quickly become a huge mess unless you
+revise all of them when the project matures and this is a real pain...
+
+Since I discovered logstash I started to think about what I would expect from an intelligent ruby logger allowing
+me to embed the actual context of the log message WITH the message and not inside it so the informations can
+easily be extracted without stupid operations like regexp matching.
+
+I first found radar which does something similar but aimed at exception catching then I recently found ruby-cabin,
+after some considerations I decided to try rolling out my own, I opened a text file and in 10min I had a basic
+prototype and here we are !
+
+# Simple example
+
+```ruby
+require 'rubygems'
+require 'bundler/setup'
+
+require 'dlogger'
+
+logger = DLogger::Logger.new
+logger.add_output( DLogger::Output::Stdout.new )
+
+logger.log("yeah it worked")
+
+# => yeah it worked : {}
+```
+
+
+# Features
+
+## Contexts
+
+You can define hash keys and their values, they will be included in any log
+sent within the block.
+
+``` ruby
+require 'rubygems'
+require 'bundler/setup'
+
+require 'dlogger'
+
+logger = DLogger::Logger.new
+logger.add_output( DLogger::Output::Stdout.new )
+
+logger.with_context(:user_id => 32) do
+  logger.log("My context is with me")
+end
+
+logger.log("but not here")
+
+# => My context is with me : {:user_id=>32}
+# => but not here : {}
+
+```
+
+## Nested contexts
+
+You can use nested contexts in this case the inner contexts have a higher priority over
+the ones above if they define the same keys.
+
+``` ruby
+require 'rubygems'
+require 'bundler/setup'
+
+require 'dlogger'
+
+logger = DLogger::Logger.new
+logger.add_output( DLogger::Output::Stdout.new )
+
+class TimeExtension < DLogger::Extension
+  def time
+    Time.now
+  end
+end
+
+logger.with_context(TimeExtension) do
+  logger.with_context(:user_id => 32) do
+    logger.log("My full context is with me")
+  end
+  
+  logger.log("I only get the time here")
+end
+
+logger.log("but still nothing here")
+
+# => My full context is with me : {:time=>2012-01-27 11:46:49 +0100, :user_id=>32}
+# => I only get the time here : {:time=>2012-01-27 11:46:49 +0100}
+# => but still nothing here : {}
+
+```
+
+
+## Dymanic context
+
+In some cases it may be more handy to use a class rather than a static hash, for
+example if use the thread local variables to store the user, session or anything.
+
+``` ruby
+require 'rubygems'
+require 'bundler/setup'
+
+require 'dlogger'
+
+logger = DLogger::Logger.new
+logger.add_output( DLogger::Output::Stdout.new )
+
+# any methods defined in your extension class will become
+# a key in the resulting hash (except initialize).
+class UserExtension < DLogger::Extension
+  def user_id
+    rand(43)
+  end
+end
+
+logger.with_context(UserExtension) do
+  logger.log("My context is with me")
+  logger.log("And will change")
+end
+
+logger.log("but not here")
+
+# => My context is with me : {:user_id=>39}
+# => And will change : {:user_id=>21}
+# => but not here : {}
+
+```
+
+## Threads and Fibers friendly
+
+Whether you use threads or fibers for concurrency you are good to go, the contexts are
+store with Thread.current which is local to the current fiber (thread's root fiber if not using
+Fiber explicitly).
+
+``` ruby
+require 'rubygems'
+require 'bundler/setup'
+
+require 'dlogger'
+
+logger = DLogger::Logger.new
+logger.add_output( DLogger::Output::Stdout.new )
+
+th1 = Thread.new do
+  logger.with_context(:user_id => "alice", :thread_id => 1) do
+    logger.log("I did it !")
+    sleep 0.2
+    logger.log("completed")
+  end
+end
+
+th2 = Thread.new do
+  logger.with_context(:user_id => "bob", :thread_id => 2) do
+    sleep 0.1
+    logger.log("Done !")
+  end
+  
+end
+
+[th1, th2].each(&:join)
+
+# => I did it ! : {:user_id=>"alice", :thread_id=>1}
+# => Done ! : {:user_id=>"bob", :thread_id=>2}
+# => completed : {:user_id=>"alice", :thread_id=>1}
+
+```
+
+
+# Want to contribute ?
+
+Fork and clone the repository then:
+
+``` bash
+$ bundle
+$ bundle exec guard
+``` 
+
+After this any change to a file will automatically run the associated spec file, any change
+to the README.md.erb or any of the examples will trigger a rebuild of the README.md file.
+

data/README.md.erb

@@ -0,0 +1,79 @@
+# What is this ?
+
+I was never happy with printf style logs, you rarely know at first what you need to put in them and how to format
+them so you just drop a ruby logger and log anything. Your log messages quickly become a huge mess unless you
+revise all of them when the project matures and this is a real pain...
+
+Since I discovered logstash I started to think about what I would expect from an intelligent ruby logger allowing
+me to embed the actual context of the log message WITH the message and not inside it so the informations can
+easily be extracted without stupid operations like regexp matching.
+
+I first found radar which does something similar but aimed at exception catching then I recently found ruby-cabin,
+after some considerations I decided to try rolling out my own, I opened a text file and in 10min I had a basic
+prototype and here we are !
+
+# Simple example
+
+```ruby
+<%= File.read('examples/basic.rb') %>
+
+```
+
+
+# Features
+
+## Contexts
+
+You can define hash keys and their values, they will be included in any log
+sent within the block.
+
+``` ruby
+<%= File.read('examples/hash_context.rb') %>
+
+```
+
+## Nested contexts
+
+You can use nested contexts in this case the inner contexts have a higher priority over
+the ones above if they define the same keys.
+
+``` ruby
+<%= File.read('examples/nested_context.rb') %>
+
+```
+
+
+## Dymanic context
+
+In some cases it may be more handy to use a class rather than a static hash, for
+example if use the thread local variables to store the user, session or anything.
+
+``` ruby
+<%= File.read('examples/dynamic_context.rb') %>
+
+```
+
+## Threads and Fibers friendly
+
+Whether you use threads or fibers for concurrency you are good to go, the contexts are
+store with Thread.current which is local to the current fiber (thread's root fiber if not using
+Fiber explicitly).
+
+``` ruby
+<%= File.read('examples/threads.rb') %>
+
+```
+
+
+# Want to contribute ?
+
+Fork and clone the repository then:
+
+``` bash
+$ bundle
+$ bundle exec guard
+``` 
+
+After this any change to a file will automatically run the associated spec file, any change
+to the README.md.erb or any of the examples will trigger a rebuild of the README.md file.
+

data/Rakefile

@@ -0,0 +1,25 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+task :default => :test
+
+task :readme do
+  require 'tilt'
+  require 'erb'
+  
+  Dir.chdir( File.dirname(__FILE__) ) do
+    template = Tilt.new('README.md.erb')
+    File.write('README.md', template.render)
+  end
+  
+end
+
+task :test do
+  require 'bacon'
+  ENV['COVERAGE'] = "1"
+  Dir[File.expand_path('../specs/**/*_spec.rb', __FILE__)].each do |file|
+    load(file)
+  end
+
+end
+

data/dlogger.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/dlogger/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Julien Ammous"]
+  gem.email         = ["schmurfy@gmail.com"]
+  gem.description   = %q{Advanced logger allowing you to include metadata with your messages}
+  gem.summary       = %q{Dynamic logger: add a context to your log messages}
+  gem.homepage      = ""
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "dlogger"
+  gem.require_paths = ["lib"]
+  gem.version       = Dlogger::VERSION
+  
+  gem.add_development_dependency('rake')
+  gem.add_development_dependency('tilt')
+  gem.add_development_dependency('guard-tilt')
+end

data/examples/basic.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'dlogger'
+
+logger = DLogger::Logger.new
+logger.add_output( DLogger::Output::Stdout.new )
+
+logger.log("yeah it worked")
+
+# => yeah it worked : {}

data/examples/dynamic_context.rb

@@ -0,0 +1,26 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'dlogger'
+
+logger = DLogger::Logger.new
+logger.add_output( DLogger::Output::Stdout.new )
+
+# any methods defined in your extension class will become
+# a key in the resulting hash (except initialize).
+class UserExtension < DLogger::Extension
+  def user_id
+    rand(43)
+  end
+end
+
+logger.with_context(UserExtension) do
+  logger.log("My context is with me")
+  logger.log("And will change")
+end
+
+logger.log("but not here")
+
+# => My context is with me : {:user_id=>39}
+# => And will change : {:user_id=>21}
+# => but not here : {}

data/examples/hash_context.rb

@@ -0,0 +1,16 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'dlogger'
+
+logger = DLogger::Logger.new
+logger.add_output( DLogger::Output::Stdout.new )
+
+logger.with_context(:user_id => 32) do
+  logger.log("My context is with me")
+end
+
+logger.log("but not here")
+
+# => My context is with me : {:user_id=>32}
+# => but not here : {}

data/examples/logstash.rb

@@ -0,0 +1,22 @@
+require 'rubygems'
+require 'eventmachine'
+require 'yajl'
+
+require 'bundler/setup'
+
+require 'dlogger'
+require 'dlogger/outputs/em/logstash'
+
+logger = DLogger::Logger.new
+logger.add_output( DLogger::Output::Stdout.new )
+
+EM::run do
+  
+  logger.add_output( DLogger::Output::LogStash.new('127.0.0.1', 10000) )
+  
+  n = 0
+  EM::add_periodic_timer(2) do
+    logger.log("yeah it worked", :n => n+= 1)
+  end
+end
+

data/examples/nested_context.rb

@@ -0,0 +1,27 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'dlogger'
+
+logger = DLogger::Logger.new
+logger.add_output( DLogger::Output::Stdout.new )
+
+class TimeExtension < DLogger::Extension
+  def time
+    Time.now
+  end
+end
+
+logger.with_context(TimeExtension) do
+  logger.with_context(:user_id => 32) do
+    logger.log("My full context is with me")
+  end
+  
+  logger.log("I only get the time here")
+end
+
+logger.log("but still nothing here")
+
+# => My full context is with me : {:time=>2012-01-27 11:46:49 +0100, :user_id=>32}
+# => I only get the time here : {:time=>2012-01-27 11:46:49 +0100}
+# => but still nothing here : {}

data/examples/threads.rb

@@ -0,0 +1,29 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'dlogger'
+
+logger = DLogger::Logger.new
+logger.add_output( DLogger::Output::Stdout.new )
+
+th1 = Thread.new do
+  logger.with_context(:user_id => "alice", :thread_id => 1) do
+    logger.log("I did it !")
+    sleep 0.2
+    logger.log("completed")
+  end
+end
+
+th2 = Thread.new do
+  logger.with_context(:user_id => "bob", :thread_id => 2) do
+    sleep 0.1
+    logger.log("Done !")
+  end
+  
+end
+
+[th1, th2].each(&:join)
+
+# => I did it ! : {:user_id=>"alice", :thread_id=>1}
+# => Done ! : {:user_id=>"bob", :thread_id=>2}
+# => completed : {:user_id=>"alice", :thread_id=>1}

data/lib/dlogger.rb

@@ -0,0 +1,8 @@
+require_relative "dlogger/version"
+require_relative "dlogger/extension"
+require_relative "dlogger/logger"
+
+require_relative "dlogger/outputs/base"
+require_relative "dlogger/outputs/stdout"
+require_relative "dlogger/outputs/stdlib_logger"
+

data/lib/dlogger/extension.rb

@@ -0,0 +1,24 @@
+module DLogger
+  
+  class Extension
+    ##
+    # Class attribute, each child class
+    # with have its own.
+    def self.properties
+      @properties ||= []
+    end
+    
+    ##
+    # Called by ruby each time a new method is added
+    # to this class or any of its children
+    # 
+    # @param [Symbol] m method name
+    # 
+    def self.method_added(m)
+      unless m == :initialize
+        self.properties << m
+      end
+    end
+  end
+  
+end

data/lib/dlogger/logger.rb

@@ -0,0 +1,134 @@
+require 'thread'
+
+module DLogger
+  class Logger
+    def initialize(name = "_default")
+      @name = name
+      @mutex = Mutex.new
+      @outputs = []
+      
+      # initialize context
+      context
+    end
+    
+    ##
+    # Main entry point, log a message with
+    # its metadata.
+    # 
+    # @param [String] msg the message
+    # @param [Hash] metadata Additional data
+    # 
+    def log(msg, metadata = {})
+      @mutex.synchronize do
+        # clearing a small hash is slightly faster than creating a new
+        # one each time.
+        merged_metadata.clear
+      
+        # first load context data
+        context.each do |ctx_data|
+          case ctx_data
+          when Hash
+            merged_metadata.merge!(ctx_data)
+          
+          when Extension
+            ctx_data.class.properties.each do |attr_name|
+              merged_metadata[attr_name] = ctx_data.send(attr_name)
+            end
+          
+          end
+        end
+      
+        # then add our data
+        merged_metadata.merge!(metadata)
+        
+        # and dispatch the result
+        dispatch(msg, merged_metadata)
+      end
+    end
+    
+    # Helper methods to mimic the standard ruby logger interface.
+    %w(debug info error warn).each do |level|
+      define_method(level) do |msg, metadata = {}|
+        log(msg, metadata.merge(:severity => level.to_sym))
+      end
+    end
+    
+    ##
+    # Register a new output, the only requirement is that
+    # the object passed reponds to the "dispatch" method.
+    # 
+    # @param [Object] handler the handler
+    # 
+    def add_output(handler)
+      @outputs << handler
+    end
+    
+    ##
+    # Usually called by #with_context method but you can use
+    # it directly to push a context on the stack, it may be useful
+    # for asynchronous handling or just to push a global context.
+    # 
+    # @param [Hash, Dlogger::Extension] context_data additional informations
+    #   to include in logs
+    # 
+    def push_context(context_data)
+      if context_data.is_a?(Class)
+        context << context_data.new
+      else
+        context << context_data
+      end
+    end
+    
+    ##
+    # The exact opposite of #push_context, if you called it by hand
+    # you can remove the context for the stack by calling this method.
+    def pop_context
+      context.pop
+    end
+    
+    ##
+    # add context data for any log sent within the given block.
+    # 
+    # @param [Hash, Dlogger::Extension] context_data additional informations
+    #   to include in logs
+    # 
+    def with_context(context_data)
+      push_context(context_data)
+      yield
+    ensure
+      # remove context
+      pop_context
+    end
+    
+  
+  private
+    
+    ##
+    # Store the context in fiber local variables, each
+    # Thread/Fiber gets its own.
+    def context
+      Thread.current["#{@name}_dlogger_contexts"] ||= []
+    end
+    
+    ##
+    # Store the temporary hash used to merge contexts.
+    # 
+    def merged_metadata
+      Thread.current["#{@name}_dlogger_merged_metadata"] ||= {}
+    end
+    
+    ##
+    # Dispatch messages to all registered outputs.
+    # 
+    # @param [String] msg the log message
+    # @param [Hash] metadata a hash including all the
+    #   additional informations you want to make available
+    # 
+    def dispatch(msg, metadata)
+      @outputs.each do |out|
+        out.dispatch(msg, metadata)
+      end
+    end
+    
+  end
+end

data/lib/dlogger/outputs/base.rb

@@ -0,0 +1,7 @@
+module DLogger
+  module Output
+    class Base
+      
+    end
+  end
+end

data/lib/dlogger/outputs/em/logstash.rb

@@ -0,0 +1,36 @@
+gem 'eventmachine'; require 'eventmachine'
+gem 'yajl-ruby';    require 'yajl'
+
+module DLogger
+  module Output
+    
+    module LogStashHandler
+      def initialize(master)
+        @master = master
+      end
+      
+      def unbind
+        EM::add_timer(0.2){ @master.connect }
+        @master = nil
+      end
+    end
+    
+    class LogStash < Base
+      def initialize(host, port)
+        @host = host
+        @port = port
+        connect
+      end
+      
+      def connect
+        @socket = EM::connect(@host, @port, LogStashHandler, self)
+      end
+      
+      def dispatch(msg, metadata)
+        metadata = metadata.merge(:message => msg)
+        @socket.send_data( Yajl::Encoder.encode(metadata) + "\n" )
+      end
+    end
+    
+  end
+end

data/lib/dlogger/outputs/stdlib_logger.rb

@@ -0,0 +1,27 @@
+module DLogger
+  module Output
+    
+    ##
+    # Output data to a standard ruby logger.
+    class StdlibLogger < Base
+      
+      ##
+      # @param [Logger] logger a ruby logger
+      # 
+      def initialize(logger, dump_metadata = true)
+        @logger = logger
+        @dump_metadata = dump_metadata
+      end
+      
+      ##
+      # @see Logger::dispatch
+      # 
+      def dispatch(msg, metadata)
+        severity = metadata.delete(:severity) || :debug
+        msg = @dump_metadata ? "#{msg} : #{metadata.inspect}" : msg
+        @logger.send(severity, msg)
+      end
+      
+    end
+  end
+end

data/lib/dlogger/outputs/stdout.rb

@@ -0,0 +1,33 @@
+require 'logger'
+
+module DLogger
+  module Output
+    
+    ##
+    # Outputs data to stdout.
+    # 
+    class Stdout < Base
+      
+      ##
+      # @param [Boolean] dump_metadata if true the output will
+      #   include the metadata dumped with inspect
+      # 
+      def initialize(dump_metadata = true)
+        @dump_metadata = dump_metadata
+      end
+      
+      ##
+      # @see Logger::dispatch
+      #
+      def dispatch(msg, metadata)
+        if @dump_metadata
+          Kernel.puts("#{msg} : #{metadata.inspect}")
+        else
+          Kernel.puts(msg)
+        end
+      end
+      
+    end
+  end
+  
+end

data/lib/dlogger/version.rb

@@ -0,0 +1,3 @@
+module Dlogger
+  VERSION = "0.0.1"
+end

data/specs/common.rb

@@ -0,0 +1,52 @@
+
+require 'rubygems'
+require 'bundler/setup'
+
+if (RUBY_VERSION >= "1.9") && ENV['COVERAGE']
+  require 'simplecov'
+  
+  puts "[[  SimpleCov enabled  ]]"
+  
+  SimpleCov.start do    
+    add_filter '/specs'
+  end
+end
+
+require 'bacon'
+require 'mocha'
+
+$LOAD_PATH.unshift( File.expand_path('../../lib', __FILE__) )
+require 'dlogger'
+
+
+Bacon.summary_at_exit
+
+module Bacon
+  module MochaRequirementsCounter
+    def self.increment
+      Counter[:requirements] += 1
+    end
+  end
+  
+  class Context
+    include Mocha::API
+    
+    alias_method :it_before_mocha, :it
+    
+    def it(description)
+      it_before_mocha(description) do
+        # TODO: find better than that...
+        1.should == 1
+        begin
+          mocha_setup
+          yield
+          mocha_verify(MochaRequirementsCounter)
+        rescue Mocha::ExpectationError => e
+          raise Error.new(:failed, "#{e.message}\n#{e.backtrace[0...10].join("\n")}")
+        ensure
+          mocha_teardown
+        end
+      end
+    end
+  end
+end

data/specs/lib/extension_spec.rb

@@ -0,0 +1,28 @@
+require_relative '../common'
+
+describe 'Extension' do
+  should 'record methods added' do
+    ext_class = Class.new(DLogger::Extension) do
+      def user; "user"; end
+      def var; 34; end
+    end
+    
+    ext_class.properties.should == [:user, :var]
+  end
+  
+  should 'keep separate lists for each subclass' do
+    ext_class1 = Class.new(DLogger::Extension) do
+      def var1; 1; end
+      def var2; 2; end
+    end
+    
+    ext_class2 = Class.new(DLogger::Extension) do
+      def var45; 45; end
+    end
+    
+    ext_class1.properties.should == [:var1, :var2]
+    ext_class2.properties.should == [:var45]
+    
+  end
+  
+end

data/specs/lib/logger_spec.rb

@@ -0,0 +1,76 @@
+require_relative "../common"
+
+describe "Logger" do
+  before do
+    @logger = DLogger::Logger.new
+  end
+  
+  should "dispatch msg with its to registered outputs" do
+    
+    handler = mock('Handler')
+    handler.expects(:dispatch).with("the message", :id => 43, :user => 'bob')
+    
+    @logger.add_output(handler)
+    
+    @logger.log("the message", :id => 43, :user => "bob")
+  end
+  
+  should 'mimic standard ruby logger interface' do
+    @logger.expects(:dispatch).with('the message', :severity => :debug)
+    @logger.debug("the message")
+    
+    @logger.expects(:dispatch).with('the message', :severity => :info)
+    @logger.info("the message")
+    
+    @logger.expects(:dispatch).with('the message', :severity => :warn)
+    @logger.warn("the message")
+    
+    @logger.expects(:dispatch).with('the message', :severity => :error)
+    @logger.error("the message")
+  end
+  
+  describe 'with hash context' do
+    should 'dispatch msg and merged data' do
+      @logger.expects(:dispatch).with('msg', :id => 43, :user => 'bob')
+    
+      @logger.with_context(:user => 'bob') do
+        @logger.log('msg', :id => 43)
+      end
+    end
+    
+  end
+  
+  describe 'with extension context' do
+    should 'dispatch msg and merged data' do
+      ext = Class.new(DLogger::Extension) do
+        def user
+          'alice'
+        end
+      end
+      
+      @logger.expects(:dispatch).with('msg', :id => 56, :user => 'alice')
+    
+      @logger.with_context(ext) do
+        @logger.log('msg', :id => 56)
+      end
+    end
+    
+  end
+  
+  describe 'with multiple contexts' do
+    should 'merge the contexts in defined order (last defined has greater priority)' do
+      @logger.expects(:dispatch).with('msg', :operation => 'destroy', :user => 'billy')
+      
+      @logger.with_context(:user => 'bob') do
+        @logger.with_context(:user => 'billy') do
+          @logger.log('msg', :operation => "destroy")
+        end
+      end
+      
+      @logger.expects(:dispatch).with('some text', {})
+      @logger.log('some text')
+    end
+    
+  end
+  
+end

data/specs/lib/outputs/stdlib_logger_spec.rb

@@ -0,0 +1,25 @@
+require_relative "../../common"
+
+describe "Stdlib Logger" do
+  before do
+    @out = DLogger::Output::StdlibLogger.new( Logger.new($stdout) )
+  end
+  
+  should 'honor severity level' do
+    Logger.any_instance.expects(:info).with('message : {}')
+    @out.dispatch("message", :severity => :info)
+  end
+  
+  should 'use debug as default for severity level' do
+    # default = debug
+    Logger.any_instance.expects(:debug).with('message : {}')
+    @out.dispatch("message", {})
+  end  
+  
+  should 'not log metadata when asked' do
+    out = DLogger::Output::StdlibLogger.new( Logger.new($stdout), false )
+    Logger.any_instance.expects(:debug).with('message')
+    out.dispatch("message", {})
+  end
+  
+end

data/specs/lib/outputs/stdout_spec.rb

@@ -0,0 +1,17 @@
+require_relative "../../common"
+
+describe "Logger" do
+  
+  should 'write messages to stdout' do
+    out = DLogger::Output::Stdout.new
+    Kernel.expects(:puts).with('message : {}')
+    out.dispatch("message", {})
+  end
+  
+  should 'write messages to stdout without metadata' do
+    out = DLogger::Output::Stdout.new(false)
+    Kernel.expects(:puts).with('message')
+    out.dispatch("message", {})
+  end
+  
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: dlogger
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Julien Ammous
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70201269940540 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70201269940540
+- !ruby/object:Gem::Dependency
+  name: tilt
+  requirement: &70201269939560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70201269939560
+- !ruby/object:Gem::Dependency
+  name: guard-tilt
+  requirement: &70201269938640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70201269938640
+description: Advanced logger allowing you to include metadata with your messages
+email:
+- schmurfy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- README.md.erb
+- Rakefile
+- dlogger.gemspec
+- examples/basic.rb
+- examples/dynamic_context.rb
+- examples/hash_context.rb
+- examples/logstash.rb
+- examples/nested_context.rb
+- examples/threads.rb
+- lib/dlogger.rb
+- lib/dlogger/extension.rb
+- lib/dlogger/logger.rb
+- lib/dlogger/outputs/base.rb
+- lib/dlogger/outputs/em/logstash.rb
+- lib/dlogger/outputs/stdlib_logger.rb
+- lib/dlogger/outputs/stdout.rb
+- lib/dlogger/version.rb
+- specs/common.rb
+- specs/lib/extension_spec.rb
+- specs/lib/logger_spec.rb
+- specs/lib/outputs/stdlib_logger_spec.rb
+- specs/lib/outputs/stdout_spec.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1333174357779250362
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1333174357779250362
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: ! 'Dynamic logger: add a context to your log messages'
+test_files: []