tagged_logger 0.1.1

data/MIT-LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2009, Fedor Kocherga <fkocherga@gmail.com>
+
+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.rdoc

@@ -0,0 +1,63 @@
+= TaggedLogger
+  Split your logging by using tags-based rules (tags are generated automatically)
+
+== What is it for?
+When you need to use logging for different code in different ways, 
+here is help for you: create tags-based rules for logging. Tags are 
+class names by default, so you do not have to specify them in 
++logger.info+, +logger.warn+ and similar calls. Rules are just code blocks, 
+so any logging facility could be used underneath:  standard library 
++Logger+, +log4r+, writing to +STDOUT+ or something else. 
+
+
+== Installation
+
+  $ sudo gem install tagged_logger --source=http://gemcutter.org
+
+== Usage
+
+    require 'rubygems'
+    require 'tagged_logger'
+    require 'logger'
+
+    #for class A the tag 'A' is used implicitly, no need to specify it
+    class A
+      def foo; logger.info("#{self.class}...".downcase); end
+    end
+
+    file_logger = Logger.new('my_log.log')
+    file_logger.formatter = lambda {|severity, datetime, progname, msg| "#{msg}"}
+
+    #If we want to have #logger in every class doing whatever we need
+    TaggedLogger.use_in_every_class do |level, tag, what|
+      file_logger.send(level, "#{tag}: #{what}\n")
+    end
+    A.new.foo #'A: a...' printed in 'my_log.log'
+
+    #Adding special logging for class A (or everything with tag 'A')
+    TaggedLogger.for_tag A do |level, tag, what|
+      STDOUT << "#{level}---#{tag}---#{what}\n"
+    end
+    A.new.foo #'A: a...' printed in 'my_log.log', 'info---A---a...' - in STDOUT
+    B = Class.new(A)
+    B.new.foo #'B: b...' printed in 'my_log.log', but not in STDOUT
+
+    #Rule for A and B says: logging within these classes happens with tag 'COMBINED':
+    TaggedLogger.replace_tags [A, B], :with => :COMBINED 
+    A.new.foo #'COMBINED: a...' printed in 'my_log.log', but nothing in STDOUT
+    B.new.foo #'COMBINED: b...' printed in 'my_log.log'
+
+    #Adding special rule for 'COMBINED' tag 
+    TaggedLogger.for_tag :COMBINED do |level, tag, what|
+      STDERR << "Oh my gosh!!! #{what}\n"
+    end
+    A.new.foo #'Oh my gosh!!! a...' printed in 'my_log.log' and in STDERR
+    B.new.foo #'Oh my gosh!!! b...' printed in 'my_log.log' and in STDERR
+
+    #Hope you've got the idea, do not hesitate to ask/fix me something...
+
+== License
+TaggedLogger is released under the MIT license.
+
+= Shortcumings
+Was not tested with log4r

data/Rakefile

@@ -0,0 +1,33 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/test.rb']
+  t.verbose = true
+end
+
+begin
+  require 'jeweler'
+  gemspec = Gem::Specification.new do |s|
+
+    s.name = "tagged_logger"
+    s.summary = "Split your logging by using tags-based rules (tags are generated automatically)"
+    s.email = "fkocherga@gmail.com"
+    s.homepage = "http://github.com/fkocherga/tagged_logger"
+    s.description = <<END
+When you need to use logging for different code in different ways, 
+here is help for you: create tags-based rules for logging. Tags are 
+class names by default, so you do not have to specify them in 
+logger's #info, #warn and similar calls. Rules are just code blocks, 
+so any logging facility could be used underneath:  standard library 
+Logger, log4r, writing to STDOUT or something else.
+END
+    s.authors = ["Fedor Kocherga"]
+    s.test_files = ['test/test.rb']
+  end
+  Jeweler::Tasks.new gemspec
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.2

data/lib/tagged_logger.rb

@@ -0,0 +1,98 @@
+require 'delegate'
+
+class TaggedLogger
+
+  attr_reader :tags_map
+  def initialize()
+    @tags_map = {}
+  end
+
+  @@tagged_logger = self.new
+  
+  def log(level, tag, msg)
+    remapped_tag = remap(tag)
+    find_blocks(remapped_tag).each { |b| b.call(level, remapped_tag, msg) }
+  end
+  
+  def for_tag(*args, &block)
+    case args.first
+    when Regexp then rules[args.first] = block
+    when Class then rules[Regexp.new("^#{args.first.to_s}$")] = block
+    when Array then args.first.each {|e| for_tag(args.first, block)}
+    when Symbol then rules[Regexp.new("^#{args.first.to_s}$")] = block
+    end
+  end
+  
+  
+  class << self
+    
+    def replace_tags(tags, with)
+      with_tag = with[:with] 
+      raise ArgumentError.new(":with => <tag> has to be specified") unless with_tag
+      @@tagged_logger.instance_eval do
+        tags.each {|t| @tags_map[t.to_s] = with_tag}
+      end
+    end
+    
+    def reset
+      @@tagged_logger.instance_eval do
+        @rules = {}
+        @tags_map = {}
+      end
+    end
+  
+    def use_in_every_class
+      #Object#logger when called generates <self.class>#logger (only once)
+      #returning logger knowing what tags to use for self.class and passing them to delegator which is
+      #instance (singleton) of TaggedLogger
+      Object.send(:define_method, "logger") do
+        self.class.class_eval do
+          attr_reader :class_logger
+          @class_logger = nil
+          def logger
+            return class_logger if class_logger
+            @class_logger = SimpleDelegator.new(@@tagged_logger)
+            class_logging_tag = self.class == Class ?  self.to_s : self.class.to_s 
+            [:debug, :warn, :info, :error, :fatal].each do |method|
+              (class << @class_logger;self;end).instance_eval do
+                define_method method do |msg|
+                  __getobj__.log(method, class_logging_tag, msg)
+                end
+               end
+            end
+            @class_logger
+          end
+        end
+        logger
+      end
+      if block_given?
+        @@tagged_logger.for_tag /.*/ do |level, tag, what|
+          yield(level, tag, what)
+        end
+      end
+    end
+    
+    def for_tag(*args, &block)
+      @@tagged_logger.for_tag(*args, &block)
+    end
+  end # class methods
+
+  private
+  def rules
+    @rules ||= {}
+  end
+  
+  def find_blocks(tag)
+    compare_with = tag.to_s
+    result = []
+    rules.each do |rule, block|
+      result << block if compare_with =~ rule
+    end
+    result
+  end
+  
+  def remap(tag)
+    return tag unless @tags_map.key? tag
+    @tags_map[tag]
+  end
+end

data/tagged_logger.gemspec

@@ -0,0 +1,49 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{tagged_logger}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Fedor Kocherga"]
+  s.date = %q{2009-10-09}
+  s.description = %q{When you need to use logging for different code in different ways, 
+here is help for you: create tags-based rules for logging. Tags are 
+class names by default, so you do not have to specify them in 
+logger's #info, #warn and similar calls. Rules are just code blocks, 
+so any logging facility could be used underneath:  standard library 
+Logger, log4r, writing to STDOUT or something else.
+}
+  s.email = %q{fkocherga@gmail.com}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    "MIT-LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/tagged_logger.rb",
+     "tagged_logger.gemspec",
+     "tagged_logger.rb",
+     "test/test.rb"
+  ]
+  s.homepage = %q{http://github.com/fkocherga/tagged_logger}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Split your logging by using tags-based rules (tags are generated automatically)}
+  s.test_files = [
+    "test/test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/tagged_logger.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + '/lib/tagged_logger.rb'

data/test/test.rb

@@ -0,0 +1,114 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'logger'
+
+require File.dirname(__FILE__) + '/../tagged_logger'
+
+class TestLogDevice
+  attr_reader :last
+  def write(msg); @last = msg; end
+  def close; end;  
+  def to_s; @last || ""; end
+  def inspect; to_s; end
+  def clear; write(""); end
+end
+
+class TaggedLoggerTest < Test::Unit::TestCase
+  
+  context "#logger() generated for every class, logging goes to String @out;" do
+    setup do 
+      @out = TestLogDevice.new
+      @standard_logger = Logger.new(@out)
+      @formatter = lambda {|severity, datetime, progname, msg| "#{msg}"}
+      @standard_logger.formatter = @formatter
+      TaggedLogger.reset
+      TaggedLogger.use_in_every_class do |level, tag, what|
+        @standard_logger.send(level, "#{tag}: #{what}")
+      end
+    end
+    
+    should "include #logger in every class" do
+      assert Class.new.methods.include? "logger"
+    end
+
+    should "do logging with different levels" do
+      NewClass = Class.new
+      obj = NewClass.new
+      %w[debug info warn error fatal].each do |method|
+        assert obj.logger.methods.include? method
+        obj.logger.send(method.intern, method)
+        assert_equal "#{obj.class}: #{method}", @out.to_s
+      end
+    end
+
+    context "class A and class B with logging;" do
+      setup do
+        module Foo
+          def foo
+            logger.info("foo")
+          end
+        end
+        class A;include Foo; end
+        class B;include Foo; end
+        @a = A.new
+        @b = B.new
+      end
+      
+      should "be possible to replace tags for A, B classes with single tag TEST making rules for A and B obsolete" do
+        TaggedLogger.replace_tags [A, B], :with => :TEST
+        @a.foo
+        assert_equal "TEST: foo", @out.to_s
+        @b.foo
+        assert_equal "TEST: foo", @out.to_s
+      end
+
+      context "specialized logging" do
+        setup do 
+          @out2 = TestLogDevice.new
+          @logger2 = Logger.new(@out2)
+          @logger2.formatter = @formatter
+        end
+        
+        should "be possible to speialize logging for tag A" do
+          TaggedLogger.for_tag A do |level, tag, what|
+            @logger2.send(level, "#{level}---#{tag}---#{what}")
+          end
+          @a.foo
+          assert_equal "#{self.class}::A: foo", @out.to_s
+          assert_equal "info---#{self.class}::A---foo", @out2.to_s
+          @out2.clear
+          @b.foo
+          assert_equal "#{self.class}::B: foo", @out.to_s
+          assert_equal "", @out2.to_s
+        end
+        
+        should "be possible to replace tags for A, B classes with single tag TEST and specialize logging for it" do
+          TaggedLogger.replace_tags [A, B], :with => :TEST 
+          TaggedLogger.for_tag :TEST do |level, tag, what|
+            @logger2.send(level, "#{level}---#{tag}---#{what}")
+          end
+          @a.foo
+          assert_equal "TEST: foo", @out.to_s
+          assert_equal "info---TEST---foo", @out2.to_s
+          @out.clear
+          @out2.clear
+          @b.foo
+          assert_equal "TEST: foo", @out.to_s
+          assert_equal "info---TEST---foo", @out2.to_s
+        end
+        
+        should "use default tag equal to class name for class methods" do
+          def A.bar
+            logger.info "bar"
+          end
+          A.bar
+          assert_equal "#{self.class}::A: bar", @out.to_s
+        end
+      end
+      
+    end
+  end
+  
+end
+

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: tagged_logger
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Fedor Kocherga
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-09 00:00:00 +04:00
+default_executable: 
+dependencies: []
+
+description: |
+  When you need to use logging for different code in different ways, 
+  here is help for you: create tags-based rules for logging. Tags are 
+  class names by default, so you do not have to specify them in 
+  logger's #info, #warn and similar calls. Rules are just code blocks, 
+  so any logging facility could be used underneath:  standard library 
+  Logger, log4r, writing to STDOUT or something else.
+
+email: fkocherga@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/tagged_logger.rb
+- tagged_logger.gemspec
+- tagged_logger.rb
+- test/test.rb
+has_rdoc: true
+homepage: http://github.com/fkocherga/tagged_logger
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Split your logging by using tags-based rules (tags are generated automatically)
+test_files: 
+- test/test.rb