tagged_logging 0.1.0 → 0.1.1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    tagged_logging (0.1.0)
+    tagged_logging (0.1.1)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,6 +1,6 @@
-# TaggedLogging
+# TaggedLogging [![Build Status](https://travis-ci.org/ketan/tagged-logging.png?branch=master)](https://travis-ci.org/ketan/tagged-logging)
 
-The rails tagged logger is awesome, but it's only available in rails. This gem makes it available for non-rails applications
+The rails tagged logger is awesome, but it's only available in rails. This gem makes it available for non-rails applications.
 
 ## Installation
 
@@ -19,72 +19,37 @@ Or install it yourself as:
 ## Usage
 
 ```{ruby}
-    class MyApplication
-      include TaggedLogging
-      push_tags(MyApplication, Process.pid)
+    logger = TaggedLogging.new(Logger.new(STDERR))
 
-      def initialize
-        info('Initializing application')
-      end
-
-      def perform
-        tagged("Perform") do
-          info("performing some task")
-        end
-      end
+    logger.tagged('MyApplication', Process.pid) do |l|
+      l.debug 'Initializing application'
 
-      at_exit do
-        info('Exiting application')
+      tagged("Perform") do
+        info("performing some task")
       end
     end
-
-    app = MyApplication.new
-    app.perform
 ```
 
 The above will print the following:
 
     [2012-12-15T14:52:10+05:30] - INFO - [MyApplication] [11321] - Initializing application
     [2012-12-15T14:52:10+05:30] - INFO - [MyApplication] [11321] [Perform] - performing some task
-    [2012-12-15T14:52:10+05:30] - INFO - [MyApplication] [11321] - Exiting application
-
-If you'd rather prefer to not pollute your class with the logger methods:
-```{ruby}
-  class MyApplication
-    class MyLogger
-      include TaggedLogging
-    end
-
-    class <<self
-      attr_accessor :logger
-    end
 
-    def logger
-      self.class.logger
-    end
+You can also push and pop tags as required to the same effect
 
-    self.logger = MyLogger
-    logger.push_tags(MyApplication, Process.pid)
+```{ruby}
+    logger = TaggedLogging.new(Logger.new(STDERR))
 
-    def initialize
-      logger.info('Initializing application')
-    end
+    logger.push_tags('MyApplication', Po)
+      l.debug 'Initializing application'
 
-    def perform
-      logger.tagged("Perform") do
-        logger.info("performing some task")
+      tagged("Perform") do
+        info("performing some task")
       end
     end
-
-    at_exit do
-      logger.info('Exiting application')
-    end
-  end
-
-  app = MyApplication.new
-  app.perform
 ```
 
+
 ## Contributing
 
 1. Fork it

data/lib/tagged_logging/formatter.rb

@@ -1,4 +1,6 @@
 require 'time'
+require 'tagged_logging/blank_ext'
+
 module TaggedLogging
   class Formatter < ::Logger::Formatter
 
@@ -17,6 +19,13 @@ module TaggedLogging
       FORMAT % [format_datetime(time), severity, tags_text, msg]
     end
 
+    def tagged(*tags)
+      new_tags = push_tags(*tags)
+      yield self
+    ensure
+      pop_tags(tags.size)
+    end
+
     def push_tags(*tags)
       tags.flatten.reject(&:blank?).tap do |new_tags|
         current_tags.concat new_tags

data/lib/tagged_logging/logger.rb

@@ -1,61 +1,25 @@
 require 'logger'
+require 'tagged_logging/formatter'
 
 module TaggedLogging
-  def self.included(receiver)
-    receiver.class_eval do
-      extend                ClassMethods
-      include               InstanceMethods
-    end
-  end
-
-  module ClassMethods
-    def tagged(*new_tags, &block)
-      new_tags = push_tags(*new_tags)
-      yield(self)
-    ensure
-      pop_tags(new_tags.size)
-    end
-
-    [:push_tags, :pop_tags, :clear_tags!].each do |method_name|
-      define_method(method_name) do |*args, &block|
-        logger.formatter.send(method_name, *args, &block)
-      end
-    end
-
-    def logger
-      @@logger ||= ::Logger.new(STDOUT).tap do |l|
-        l.level = ::Logger::INFO
-        l.formatter = ::TaggedLogging::Formatter.new
-      end
-    end
 
-    def logger=(logger)
-      @@logger = logger
-    end
-
-    def flush
-      clear_tags!
-      logger.flush if defined?(logger.super)
-    end
+  def self.new(logger)
+    logger.formatter = TaggedLogging::Formatter.new
+    logger.extend(self)
+  end
 
-    [:debug, :info, :warn, :error, :fatal].each do |method_name|
-      define_method(method_name) do |*args, &block|
-        self.logger.send(method_name, *args, &block)
-      end
+  [:push_tags, :pop_tags, :clear_tags!].each do |method_name|
+    define_method(method_name) do |*args, &block|
+      formatter.send(method_name, *args, &block)
     end
   end
 
-  module InstanceMethods
-    [:debug, :info, :warn, :error, :fatal].each do |method_name|
-      define_method(method_name) do |*args, &block|
-        self.class.logger.send(method_name, *args, &block)
-      end
-    end
+  def tagged(*tags)
+    formatter.tagged(*tags) { yield(self) }
+  end
 
-    [:tagged, :flush, :logger, :logger=, :push_tags, :pop_tags, :clear_tags!].each do |method_name|
-      define_method(method_name) do |*args, &block|
-        self.class.send(method_name, *args, &block)
-      end
-    end
+  def flush
+    clear_tags!
+    super if defined?(super)
   end
 end

data/lib/tagged_logging/version.rb

@@ -2,7 +2,7 @@ module TaggedLogging
   module Version
     MAJOR = 0
     MINOR = 1
-    PATCH = 0
+    PATCH = 1
     VERSION = [MAJOR, MINOR, PATCH].compact.join('.')
   end
 end

data/test/logger_test.rb

@@ -4,15 +4,9 @@ require 'tagged_logging/blank_ext'
 
 class LoggerTest < Test::Unit::TestCase
 
-  class MyLogger
-    include TaggedLogging
-  end
-
   setup do
     @output = StringIO.new
-    @logger = MyLogger
-    @logger.logger    = ::Logger.new(@output)
-    @logger.logger.formatter = TaggedLogging::Formatter.new
+    @logger = TaggedLogging.new(::Logger.new(@output))
     @logger.flush
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tagged_logging
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors: