tagged_logger 0.3.1 → 0.3.2

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009, Fedor Kocherga <fkocherga@gmail.com>
+Copyright (c) 2010, Aleksandr Furmanov <aleksandr.furmanov@gmail.com>
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation

data/README.markdown

@@ -12,7 +12,7 @@ day you'll need something more sophisticated, like several log files each servin
 different components and for different audience. 
 
 ## Installation
-    $ sudo gem install tagged_logger --source=http://gemcutter.org
+    $ gem install tagged_logger
 
 ## Usage
 

data/Rakefile

@@ -1,6 +1,5 @@
 require 'rake'
 require 'rake/testtask'
-require 'rake/rdoctask'
 
 Rake::TestTask.new do |t|
   t.libs << "test"
@@ -8,17 +7,6 @@ Rake::TestTask.new do |t|
   t.verbose = true
 end
 
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |s|
-    s.name = "tagged_logger"
-    s.summary = "Detaches _what_ is logged from _how_ it is logged."
-    s.email = "fkocherga@gmail.com"
-    s.homepage = "http://github.com/fkocherga/tagged_logger"
-    s.authors = ["Fedor Kocherga"]
-    s.test_files = ['test/test.rb', 'test/test_examples.rb']
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler not available. Install it with: sudo gem install jeweler"
-end
+task :default => "test"
+
+

data/lib/tagged_logger.rb

@@ -14,7 +14,7 @@ class TaggedLogger
     end
     
     def rules(&block)
-      add_logger_generator_in_Kernel
+      add_logger_generator_in_Object
       instance_eval(&block)
     end
     
@@ -119,9 +119,9 @@ class TaggedLogger
       end
     end
     
-    def add_logger_generator_in_Kernel
-      return if Kernel.respond_to?(:logger, true) #no harm
-      Kernel.class_eval do
+    def add_logger_generator_in_Object
+      return if Object.respond_to?(:logger, true) #no harm
+      Object.class_eval do
         def logger
           klass = self.class == Class ? self : self.class
           result = klass.class_eval do

data/test/test.rb

@@ -24,13 +24,14 @@ class TaggedLoggerTest < Test::Unit::TestCase
     end
     
     teardown do
-      Kernel.class_eval { remove_method :logger }
+      Object.class_eval { remove_method :logger }
     end
     
     should "be able to intialize with minimal effort, without defining any rules" do
       TaggedLogger.init
       dont_allow(@@stub_out).write
-      assert Class.new.methods.include? "logger"
+      logger_method = RUBY_VERSION >= '1.9' ? :logger : "logger"
+      assert Class.new.methods.include? logger_method
       assert_nothing_raised { Class.new.logger }
     end
     

metadata

@@ -1,84 +1,126 @@
 --- !ruby/object:Gem::Specification 
 name: tagged_logger
 version: !ruby/object:Gem::Version 
+  hash: 23
   prerelease: false
   segments: 
   - 0
   - 3
-  - 1
-  version: 0.3.1
+  - 2
+  version: 0.3.2
 platform: ruby
 authors: 
-- Fedor Kocherga
+- Aleksandr Furmanov
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-03-30 00:00:00 -05:00
+date: 2010-09-28 00:00:00 -05:00
 default_executable: 
-dependencies: []
-
-description: 
-email: fkocherga@gmail.com
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: facets
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rr
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: Detaches _what_ is logged from _how_ it is logged
+email: 
+- aleksandr.furmanov@gmail.com
 executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- README.html
-- README.markdown
+extra_rdoc_files: []
+
 files: 
-- .gitignore
 - CHANGES.markdown
 - MIT-LICENSE
-- README.markdown
 - Rakefile
+- README.markdown
 - VERSION
+- lib/tagged_logger.rb
+- test/expected_examples_output.txt
+- test/test.rb
+- test/test_examples.rb
+- test/test_performance.rb
 - examples/changing_format.rb
 - examples/one_log_per_classes.rb
 - examples/one_tag_per_classes.rb
 - examples/per_class_customization.rb
 - examples/rule_with_regex.rb
 - examples/simplest_usage.rb
-- lib/tagged_logger.rb
-- tagged_logger.gemspec
-- tagged_logger.rb
-- test/expected_examples_output.txt
-- test/test.rb
-- test/test_examples.rb
-- test/test_performance.rb
-- todo.txt
-- README.html
 has_rdoc: true
-homepage: http://github.com/fkocherga/tagged_logger
+homepage: http://github.com/afurmanov/tagged_logger
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 23
       segments: 
-      - 0
-      version: "0"
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Detaches _what_ is logged from _how_ it is logged.
-test_files: 
-- test/test.rb
-- test/test_examples.rb
+summary: Detaches _what_ is logged from _how_ it is logged
+test_files: []
+

data/.gitignore

@@ -1,6 +0,0 @@
-pkg
-doc
-Manifest
-README.html
-CHANGES.html
-*.log

data/README.html

@@ -1,130 +0,0 @@
-<?xml version="1.0" encoding="utf-8"?>
-<!DOCTYPE html PUBLIC
-    "-//W3C//DTD XHTML 1.1 plus MathML 2.0 plus SVG 1.1//EN"
-    "http://www.w3.org/2002/04/xhtml-math-svg/xhtml-math-svg.dtd">
-<html xmlns:svg='http://www.w3.org/2000/svg' xml:lang='en' xmlns='http://www.w3.org/1999/xhtml'>
-<head><meta content='application/xhtml+xml;charset=utf-8' http-equiv='Content-type' /><title>TaggedLogger</title></head>
-<body>
-<h1 id='taggedlogger'>TaggedLogger</h1>
-
-<p>Detaches <strong>what</strong> is logged from <strong>how</strong> it is logged.</p>
-
-<h2 id='what_is_it_for'>What is it for?</h2>
-
-<p>Every time you want to log something, simply write:</p>
-
-<pre><code>logger.debug(&quot;verbose debug information&quot;) #warn, #info, #error, #fatal also works</code></pre>
-
-<p>and do not worry about what kind of logger you use and how your code accesses it. You may configure these things later, one day writing to STDOUT works for you, another day you&#8217;ll need something more sophisticated, like several log files each serving different components and for different audience.</p>
-
-<h2 id='installation'>Installation</h2>
-
-<pre><code>$ sudo gem install tagged_logger --source=http://gemcutter.org</code></pre>
-
-<h2 id='usage'>Usage</h2>
-
-<p>After specifying some logging rules:</p>
-
-<pre><code>TaggedLogger.rules do
-  info A, :to =&gt; Logger.new(&quot;log_for_A_class.log&quot;) #1 rule
-  error /.*/, :to =&gt; Logger.new(ERROR)             #2 rule
-  info /.*/, :to =&gt; Logger.new(STDOUT)             #3 rule
-end</code></pre>
-
-<p>the following will happen:</p>
-
-<ol>
-<li>
-<p>The <em>#logger()</em> method becomes available <strong>everywhere</strong>, so it is completely safe to have a code like:</p>
-
-<pre><code> class A
-   def foo
-      logger.info(&quot;Something interesting happened in A#foo&quot;) #goes to STDOUT and to &#39;log_for_A_class.log&#39; file
-      logger.debug(&quot;I want to see some details.&quot;) #goes nowhere
-   end
- end
- logger.error(&quot;#logger is available everywhere&quot;) #goes to STDERR
- class B
-    logger.warn(&quot;#logger is available everywhere&quot;) #goes to STDOUT
- end     </code></pre>
-</li>
-
-<li>
-<p>The A&#8217;s <em>logger.info()</em> output will show up in two destinations:</p>
-
-<ul>
-<li>
-<p>in STDOUT, as defined by rule #3</p>
-</li>
-
-<li>
-<p>in &#8216;log_for_A_class.log&#8217; file, as defined by rule #1</p>
-</li>
-</ul>
-</li>
-
-<li>
-<p>From <strong>wherever</strong> it gets called from:</p>
-
-<pre><code> logger.error(&quot;ERROR&quot;) #will print &#39;ERROR&#39; in standard error
- logger.info(&quot;INFO&quot;)  #will print &#39;INFO&#39; in standard output
- logger.debug(&quot;DEBUG&quot;) #will not print anything, since there is no &#39;debug&#39; rule</code></pre>
-</li>
-</ol>
-
-<p>The <em>#logger()</em> returns some object having methods: <em>#debug(), #info(), #warn(), #error() and #fatal()</em>. These method have generated on first <em>#logger()</em> call and contain only necessary code to meet rules. It means, for example, that if no rules defined all these methods do nothing. It is done for performance reasons, I like to log a lot and I do not want calls like <em>#logger.debug()</em> slowing down production code.</p>
-
-<p>The simplest way to have a <em>#logger()</em> available everywhere without specifying any rules is:</p>
-
-<pre><code>TaggedLogger.init</code></pre>
-
-<p>No rules specified, therefore whenever you call <em>logger.debug()</em> (or alike) you actually paying for just an empty method execution. You may specify rules later, now you may stay focused on code you are writing.</p>
-
-<p>You may define your own formatting:</p>
-
-<pre><code>TaggedLogger.rules do
-  format {|level, tag, message| &quot;#{level}-#{tag}: #{msg}&quot;}
-end</code></pre>
-
-<p>Each <em>#format()</em> call overrides previous format. If you are wondering what the heck the &#8216;tag&#8217; is - the answer is simple. The tag is a class name whose method calls <em>#logger()</em>. This is what allows to specify rules for classes or namespaces and this is what the <em>tagged_logger</em> plugin is named after.</p>
-
-<p>Lets see how you may use it. For example you want to have separate log files for classes <em>Network</em> and <em>Database</em>:</p>
-
-<pre><code>TaggedLogger.rules do
-  debug Network, :to =&gt; Logger.new(&quot;network.log&quot;)
-  debug Database, :to =&gt; Logger.new(&quot;database.log&quot;)
-end</code></pre>
-
-<p>In case you want to define common log for several classes:</p>
-
-<pre><code>TaggedLogger.rules do
-  debug [Ftp, Http, Sockets], :to =&gt; Logger.new(&quot;network.log&quot;)
-end </code></pre>
-
-<p>Or if you want to have all these classes showing up under common tag <em>Network</em> in standard output:</p>
-
-<pre><code>TaggedLogger.rules do
-  info /.*/, :to =&gt; Logger.new(STDOUT)
-  rename [Ftp, Http, Sockets] =&gt; :Network
-end</code></pre>
-
-<p>You may also use regular expressions in your rules:</p>
-
-<pre><code>TaggedLogger.rules do
-  info /Active::/, :to =&gt; Logger.new(&quot;active.log&quot;)
-end</code></pre>
-
-<h2 id='license'>License</h2>
-
-<p><em>TaggedLogger</em> is released under the MIT license.</p>
-
-<h2 id='shortcomings'>Shortcomings</h2>
-
-<p>The <em>#info(), #debug(), #warn(), #error(), #fatal()</em> rules when have form like <em>:to =&gt; logger</em>, the <em>logger</em> <strong>has</strong> to be an object of standard library <em>Logger</em> class. If you need to use different sort of logger the more general rules form could is:</p>
-
-<pre><code>TaggedLogger.rules do
-  info /Whatever/ do |level, tag, message|
-    #do your special logging here
-  end      
-end</code></pre>
-</body></html>

data/tagged_logger.gemspec

@@ -1,60 +0,0 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
-# -*- encoding: utf-8 -*-
-
-Gem::Specification.new do |s|
-  s.name = %q{tagged_logger}
-  s.version = "0.3.1"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Fedor Kocherga"]
-  s.date = %q{2010-03-30}
-  s.email = %q{fkocherga@gmail.com}
-  s.extra_rdoc_files = [
-    "README.html",
-     "README.markdown"
-  ]
-  s.files = [
-    ".gitignore",
-     "CHANGES.markdown",
-     "MIT-LICENSE",
-     "README.markdown",
-     "Rakefile",
-     "VERSION",
-     "examples/changing_format.rb",
-     "examples/one_log_per_classes.rb",
-     "examples/one_tag_per_classes.rb",
-     "examples/per_class_customization.rb",
-     "examples/rule_with_regex.rb",
-     "examples/simplest_usage.rb",
-     "lib/tagged_logger.rb",
-     "tagged_logger.gemspec",
-     "tagged_logger.rb",
-     "test/expected_examples_output.txt",
-     "test/test.rb",
-     "test/test_examples.rb",
-     "test/test_performance.rb",
-     "todo.txt"
-  ]
-  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.6}
-  s.summary = %q{Detaches _what_ is logged from _how_ it is logged.}
-  s.test_files = [
-    "test/test.rb",
-     "test/test_examples.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

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

data/todo.txt

@@ -1,34 +0,0 @@
-* figure out how profiling info could be displayed on New Relic
-  May be:
-
-  instrument object, :method
-
-   monkey patchs method with
-
-   logger.debug("MethodName()/started")
-   ...
-   logger.debug("MethodName()/stopped")
-
-                            
-  create special logger for instrumentation:
-  StatisticsLogger
-
-  so somebody may write:
-  
-  instrument object, :method, :to => StatisticsLogger.new( file, :interval => 100 )
-  #may be not a file, but mongodb connection
-
-  instrument object, :method, :to => NewRelicLogger.new
-
-  The StatisticsLogger is for monitoring/troubleshouting, it supposed to help answer questions like:
-  - how my app behaves in average
-  
-  The NewRelicLogger simply redirects all sampling to newrelic_rpm
-
-- logger.debug method (and alike) should accept block for performance reason
-- writing messages in any encoding
-- test against 'logging' framework
-- test agains 1.9.1
-- test agains 1.8.6 (really?)
-- test with Rails
-- when logger specified in :to => ... then lib must complain unless formatting and logging code to that specific logger class was not defined