tagged_logger 0.4.5 → 0.4.6

data/Rakefile

@@ -3,7 +3,7 @@ require 'rake/testtask'
 
 Rake::TestTask.new do |t|
   t.libs << "test"
-  t.test_files = FileList['test/test.rb', 'test/test_rails.rb', 'test/test_examples.rb']
+  t.test_files = FileList['test/test.rb', 'test/test_rails.rb', 'test/test_examples.rb', 'test/test_performance.rb']
   t.verbose = true
 end
 

data/TODO.markdown

@@ -0,0 +1,72 @@
+### The *level* param in rule below appears to be obsolete:
+
+    debug /something/ do |level, tag, msg| 
+    end
+
+We specify *debug* rule, so what the need to pass it as a param? May be:
+
+    any_level /something/ do |level, tag, msg| 
+    end
+
+and
+  
+    debug /something/ do |tag, msg|
+    end
+
+
+
+### Integration with Rails instrumenation, may be somewhat like:
+
+    debug 'sql.active_record' do |msg| do
+      # custom handling for Rails 'sql.active_record' instrumentation
+    end
+
+### Documentation
+
+### Ability to accept blocks as arguments for #debug, #info, and alike, i.e.:
+
+    logger.info { "That message takes some time to build' }
+   
+   so message is evaluated only when actual logging happens, and no-op otherwise
+
+
+### Writing messages in any encoding (tests)
+
+### Tests against 'logging' framework: http://github.com/TwP/logging
+
+### When logger specified in :to => ... then lib must complain if it cannot find standard logger methods there (and formatting setter)
+
+### :fsync convenience option, so instead:
+
+    log = open(File.join(log_path, 'log.log'),"w")
+    debug GData::Cacher, :to => Logger.new(log) do
+      log.fsync
+    end
+
+one could write:
+
+    debug GData::Cacher, :to => Logger.new('log.log'), :fsync => true
+
+### Non-intrusive instrumentation, for example:
+
+    instrument "SomeClass#method", :debug
+ 
+which in turn wraps *SomeClass#method* with before call:
+
+    logger.debug("SomeClass#method/started [timestamp]")
+
+and after call:
+
+    logger.debug("SomeClass#method/stopped [timestamp]")
+
+so instrumentation is defined just as a special case for logging and 
+it is regulated by same rules mechanism, i.e. it could be turned on by rule: 
+
+    debugger SomeClass do |level, info, msg| do
+    end
+
+sometimes we want to know an average information across many method call, so may be:
+
+    instrument "SomeClass#method", :debug, :average_for => 100
+                            
+It is needed for better profiling

data/examples/changing_format.rb

@@ -1,6 +1,4 @@
-require 'rubygems'
-require 'tagged_logger'
-require 'logger'
+require File.join(File.dirname(__FILE__), '/examples_helper')
 
 puts "\n<<<#{File.basename(__FILE__, ".rb")}>>> \n".upcase
 

data/examples/examples_helper.rb

@@ -0,0 +1,5 @@
+dir = File.dirname(__FILE__) + '/../lib'
+$LOAD_PATH.unshift dir unless $LOAD_PATH.include? dir
+require 'rubygems'
+require 'tagged_logger'
+require 'logger'

data/examples/one_log_per_classes.rb

@@ -1,6 +1,4 @@
-require 'rubygems'
-require 'tagged_logger'
-require 'logger'
+require File.join(File.dirname(__FILE__), '/examples_helper')
 
 puts "\n<<<#{File.basename(__FILE__, ".rb")}>>> \n".upcase
 

data/examples/one_tag_per_classes.rb

@@ -1,6 +1,4 @@
-require 'rubygems'
-require 'tagged_logger'
-require 'logger'
+require File.join(File.dirname(__FILE__), '/examples_helper')
 
 puts "\n<<<#{File.basename(__FILE__, ".rb")}>>> \n".upcase
 

data/examples/per_class_customization.rb

@@ -1,6 +1,4 @@
-require 'rubygems'
-require 'tagged_logger'
-require 'logger'
+require File.join(File.dirname(__FILE__), '/examples_helper')
 
 puts "\n<<<#{File.basename(__FILE__, ".rb")}>>> \n".upcase
 

data/examples/rule_with_regex.rb

@@ -1,6 +1,4 @@
-require 'rubygems'
-require 'tagged_logger'
-require 'logger'
+require File.join(File.dirname(__FILE__), '/examples_helper')
 
 puts "\n<<<#{File.basename(__FILE__, ".rb")}>>> \n".upcase
 

data/examples/simplest_usage.rb

@@ -1,6 +1,4 @@
-require 'rubygems'
-require 'tagged_logger'
-require 'logger'
+require File.join(File.dirname(__FILE__), '/examples_helper')
 
 puts "\n<<<#{File.basename(__FILE__, ".rb")}>>> \n".upcase
 

data/lib/tagged_logger/tagged_logger.rb

@@ -57,6 +57,11 @@ module TaggedLogger
     def warn(what, where = {}, &block) output(:warn, what, where, &block) end
     def error(what, where = {}, &block) output(:error, what, where, &block) end
     def fatal(what, where = {}, &block) output(:fatal, what, where, &block) end
+    def any_level(what, where = {}, &block)
+      [:debug, :info, :warn, :error, :fatal].each do |level|
+        output(level, what, where, &block)
+        end
+    end
     
     def format(&block)
       @formatter = block

data/test/test.rb

@@ -1,6 +1,4 @@
-$LOAD_PATH.unshift File.dirname(__FILE__)
-require 'test_helper'
-
+require File.join(File.dirname(__FILE__), '/test_helper')
 
 class TaggedLoggerTest < Test::Unit::TestCase
   include RR::Adapters::TestUnit

data/test/test_examples.rb

@@ -1,3 +1,4 @@
+
 root_dir = File.dirname(File.expand_path(__FILE__)) + '/../'
 examples_output = `find -s #{root_dir}examples -iname '*.rb' -exec ruby {} \\;`
 expected_output = File.read("#{root_dir}test/expected_examples_output.txt")

data/test/test_helper.rb

@@ -1,8 +1,11 @@
-$LOAD_PATH.unshift File.dirname(__FILE__) + '/../'
+lib_dir = File.dirname(__FILE__) + '/../lib'
+$LOAD_PATH.unshift lib_dir unless $LOAD_PATH.include? lib_dir
+
 require 'rubygems'
-require 'tagged_logger'
+require "#{lib_dir}/tagged_logger"
+require "#{lib_dir}/../test/test_log_device"
+require 'logger'
 require 'test/unit'
 require 'shoulda'
-require 'logger'
 require 'rr'
-require 'test_log_device'
+

data/test/test_performance.rb

@@ -1,8 +1,6 @@
-require 'rubygems'
-require File.dirname(__FILE__) + '/../tagged_logger'
-require 'logger'
+require File.join(File.dirname(__FILE__), '/test_helper')
 
-class TestLogDevice
+class DummyTestLogDevice
   def write(msg); end
   def close; end  
   def clear; end
@@ -11,15 +9,18 @@ end
 def measure_debug_time(a_logger, name)
   start_time = Time.now
   10_000.times { a_logger.debug("DEBUG")}
-  puts "DEBUG: %s: %5.4f\n" % [name, (Time.now - start_time)]
+  diff = Time.now - start_time
+  puts "Performance(10,000 logger.debug calls) for %s: %5.4f sec\n" % [name, diff]
+  diff
 end
 
-std_logger = Logger.new(TestLogDevice.new)
+std_logger = Logger.new(DummyTestLogDevice.new)
 std_logger.level = Logger::INFO
 
 TaggedLogger.rules do
   info /.*/, :to => std_logger
 end
 
-measure_debug_time(std_logger, "Standard Logger")
-measure_debug_time(logger, "Tagged Logger")
+std_logger_time = measure_debug_time(std_logger, "Standard Logger")
+tagged_logger_time = measure_debug_time(logger, "Tagged Logger")
+puts "Tagger/Standard Logger speed = %2.2f" % (tagged_logger_time/std_logger_time)

data/test/test_rails.rb

@@ -1,5 +1,4 @@
-$LOAD_PATH.unshift File.dirname(__FILE__)
-require 'test_helper'
+require File.join(File.dirname(__FILE__), '/test_helper')
 require 'rails/all'
 
 module Test

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: tagged_logger
 version: !ruby/object:Gem::Version 
-  hash: 5
+  hash: 3
   prerelease: false
   segments: 
   - 0
   - 4
-  - 5
-  version: 0.4.5
+  - 6
+  version: 0.4.6
 platform: ruby
 authors: 
 - Aleksandr Furmanov
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-21 00:00:00 -05:00
+date: 2010-10-23 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -90,6 +90,7 @@ files:
 - MIT-LICENSE
 - Rakefile
 - README.markdown
+- TODO.markdown
 - lib/tagged_logger/railtie.rb
 - lib/tagged_logger/tagged_logger.rb
 - lib/tagged_logger.rb
@@ -101,6 +102,7 @@ files:
 - test/test_performance.rb
 - test/test_rails.rb
 - examples/changing_format.rb
+- examples/examples_helper.rb
 - examples/one_log_per_classes.rb
 - examples/one_tag_per_classes.rb
 - examples/per_class_customization.rb