catamaran 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 070bb5224a0412112c13ca5981859b8d201be22d
-  data.tar.gz: 2192f55d66d64d284a20bc409a1c0a2cc92c795e
+  metadata.gz: c51065cdb4214656604cdb61802d5eb574698f5f
+  data.tar.gz: 7fa689f18bade04142e110bc5693b6370e168034
 SHA512:
-  metadata.gz: b809ca0a2dcf06b23aa5eddb66820781ed28c978da4e16a9d45e4e2d3f0fa250f5074fa4e746405211e3eea7d46599193d7e861769add0b858bdb081fa3cae8e
-  data.tar.gz: 1fc5c6ff9a835959cc43833e0c39fa250c32188c8eba73b89fe5d41738e078c972d10362e0f795b3307604b43f533e575e064e91b9e194c3251818a8850812cc
+  metadata.gz: e6f186c028aa5ce1cd5db49971b723862d7e141f0fc9daf902dee4a1961ec9e4667bb83681b177bde6d6c037ef7e47419379de11fca2576c752a0b32eb431655
+  data.tar.gz: 7b7750e9d5eaaeb882902b0637b0f9ae2b7e3cec5d444093a6e23ddf9e1b6f68239e421e64e9d4876f8340e131a7c5487f684a139fc48651f316a9ca7267f997

data/README.md

@@ -6,7 +6,7 @@ Logging is a powerful and often undervalued tool in software development.  When
 Gemfile
 -------
 
-    gem 'catamaran', '~> 0.9.0'
+    gem 'catamaran', '~> 0.9.1'
 
 Rails-related setup:
 
@@ -129,7 +129,7 @@ I'm looking for a logging utility that:
 * captures from where each log entry was generated
 * works equally well with classes that do and do *not* extend Rails base classes
 * supports the TRACE log level (or other log level less critical than DEBUG). 
-* is capable of capturing logs at different log level thresholds from different parts of the app simultaneously
+* is capable of capturing logs at different severity thresholds from different parts of the app simultaneously
 * readily works with Rails
 * http://stackoverflow.com/questions/462651/rails-logger-format-string-configuration
 * http://stackoverflow.com/questions/3654827/logging-in-rails-app

data/lib/catamaran/log_level.rb

@@ -4,9 +4,10 @@ module Catamaran
     # If that's too verbose, the level can be changed to IO_LESS_CRITICAL_THAN_DEBUG and logger.io messages won't be
     # visible unless the log level is set to TRACE.  
     # See development.rb for an example of this
+    IO_LESS_CRITICAL_THAN_TRACE = 1780
     IO_LESS_CRITICAL_THAN_DEBUG = 2780
     IO_LESS_CRITICAL_THAN_INFO = 3780
-    IO_LESS_CRITICAL_THAN_NOTICE = 4780
+    
 
     ALL = 100
 
@@ -51,12 +52,12 @@ module Catamaran
         'SEVERE'
       when FATAL
         'FATAL'
+      when IO_LESS_CRITICAL_THAN_TRACE
+        'IO'              
       when IO_LESS_CRITICAL_THAN_INFO
         'IO'
       when IO_LESS_CRITICAL_THAN_DEBUG
-        'IO'
-      when IO_LESS_CRITICAL_THAN_NOTICE
-        'IO'        
+        'IO'  
       else
         # Unknown
         ''

data/lib/catamaran/logger.rb

@@ -10,8 +10,8 @@ module Catamaran
     # The getter associated with retrieving the current log level for this logger.
     # Similar is the smart_log_level getter
 
-    def log_level( opts = {} )
-      if instance_variable_defined?( :@log_level ) && @log_level
+    def log_level( opts = nil )
+      if @log_level
         # Implicit return
         @log_level
       elsif self.parent.nil?
@@ -20,11 +20,11 @@ module Catamaran
         # Implicit return
         Catamaran::LogLevel::NOTICE
       else
-        recursive = ( opts[:recursive] == true || opts[:be_populated] == true )
+        recursive = ( opts && ( opts[:recursive] == true || opts[:be_populated] == true ) )
         if recursive == true 
 
           # Remember the log level we found so we don't have to recursively look for it ever time
-          if !instance_variable_defined?( :@memoized_log_level ) || @memoized_log_level.nil?
+          if @memoized_log_level.nil?
             @memoized_log_level = parent.log_level( opts ) if parent
           end
 
@@ -52,7 +52,7 @@ module Catamaran
 
     def log_level=( value )
       @log_level = value
-      remove_instance_variable( :@memoized_log_level ) if instance_variable_defined?( :@memoized_log_level )      
+      @memoized_log_level = nil      
     end
 
 
@@ -67,7 +67,7 @@ module Catamaran
 
 
     def backtrace_log_level( opts = {} )
-      if instance_variable_defined?( :@backtrace_log_level ) && @backtrace_log_level
+      if @backtrace_log_level
         retval = @backtrace_log_level
       elsif self.parent.nil?
         # No parent means this logger(self) is the root logger.  So use the default log level
@@ -77,7 +77,7 @@ module Catamaran
         if recursive == true 
 
           # Remember the log level we found so we don't have to recursively look for it ever time
-          if !instance_variable_defined?( :@memoized_backtrace_log_level ) || @memoized_backtrace_log_level.nil?
+          if @memoized_backtrace_log_level.nil?
             @memoized_backtrace_log_level = parent.backtrace_log_level( opts ) if parent
           end
 
@@ -105,7 +105,7 @@ module Catamaran
 
     def backtrace_log_level=( value )
       @backtrace_log_level = value
-      remove_instance_variable( :@memoized_backtrace_log_level ) if instance_variable_defined?( :@memoized_backtrace_log_level )      
+      @memoized_backtrace_log_level = nil  
     end
 
 
@@ -387,7 +387,9 @@ module Catamaran
     # Forget any cached memoization log levels within this logger or within sub-loggers of this logger
 
     def forget_memoizations
-      remove_instance_variable(:@memoized_log_level) if instance_variable_defined?( :@memoized_log_level )
+      @memoized_log_level = nil
+      @memoized_backtrace_log_level = nil
+
       @sub_loggers.values.each do |logger|
         logger.forget_memoizations()
       end
@@ -412,12 +414,15 @@ module Catamaran
 
     ##
     # I used to delete the root level logger, but now I reset it instead.  
-    # Among other reasons, the CatLogger constant now works
+    # Among other reasons, the CatLogger constant now works.
+    # Unless otherwise specified, a reset() is a soft reset by default.
 
     def reset( opts = {} )
-      remove_instance_variable(:@memoized_log_level) if instance_variable_defined?( :@memoized_log_level )      
-      remove_instance_variable(:@log_level) if instance_variable_defined?( :@log_level ) 
-      remove_instance_variable(:@backtrace_log_level) if instance_variable_defined?( :@backtrace_log_level )      
+
+      @memoized_log_level = nil
+      @log_level = nil 
+      @backtrace_log_level = nil
+      @memoized_backtrace_log_level = nil
 
       self.name = @initialized_name
       self.path = @initialized_path_so_far ? @initialized_path_so_far.dup : []
@@ -576,6 +581,12 @@ module Catamaran
       # Create the hash of sub_loggers as needed
       @sub_loggers ||= {}
 
+      # These will all be set to nil as part of the reset()
+      # @memoized_log_level = nil
+      # @log_level = nil
+      # @backtrace_log_level = nil
+      # @memoized_backtrace_log_level = nil
+
       reset()
 
       Catamaran.debugging( "Catamaran::Logger#initialize() - I am #{self.to_s}" )  if Catamaran.debugging?

data/lib/catamaran/version.rb

@@ -1,4 +1,4 @@
 module Catamaran
-  VERSION = '0.9.0'
+  VERSION = '0.9.1'
 end
 

data/spec/catamaran_spec.rb

@@ -308,6 +308,36 @@ describe Catamaran do
       Catamaran.logger.Company.Product.App.smart_log_level.should == Catamaran::LogLevel::INFO
     end
 
+    it "should memoize the log level of an ancestor as needed" do
+      Catamaran.logger.log_level = Catamaran::LogLevel::ERROR
+      Catamaran.logger.com.mycompany.myrailsproject.app.models.instance_variable_get( :@memoized_log_level ).should be_nil
+      Catamaran.logger.should_receive( :log_level ).once.with( {:recursive=>true} ).and_return Catamaran::LogLevel::ERROR
+      Catamaran.logger.com.mycompany.myrailsproject.app.models.smart_log_level.should == Catamaran::LogLevel::ERROR
+      Catamaran.logger.com.mycompany.myrailsproject.app.models.instance_variable_get( :@memoized_log_level ).should == Catamaran::LogLevel::ERROR
+      Catamaran.logger.com.mycompany.myrailsproject.app.models.smart_log_level.should == Catamaran::LogLevel::ERROR
+      Catamaran.logger.forget_memoizations
+      Catamaran.logger.com.mycompany.myrailsproject.app.models.instance_variable_get( :@memoized_log_level ).should be_nil      
+      Catamaran.logger.should_receive( :log_level ).once.with( {:recursive=>true} ).and_return Catamaran::LogLevel::ERROR
+      Catamaran.logger.com.mycompany.myrailsproject.app.models.smart_log_level.should == Catamaran::LogLevel::ERROR
+      Catamaran.logger.com.mycompany.myrailsproject.app.models.instance_variable_get( :@memoized_log_level ).should == Catamaran::LogLevel::ERROR      
+      Catamaran.logger.com.mycompany.myrailsproject.app.models.smart_log_level.should == Catamaran::LogLevel::ERROR
+    end
+
+    it "should memoize the backtrace log level of an ancestor as needed" do
+      Catamaran.logger.backtrace_log_level = Catamaran::LogLevel::ERROR
+      Catamaran.logger.com.mycompany.myrailsproject.app.models.instance_variable_get( :@memoized_backtrace_log_level ).should be_nil
+      Catamaran.logger.should_receive( :backtrace_log_level ).once.with( {:recursive=>true} ).and_return Catamaran::LogLevel::ERROR
+      Catamaran.logger.com.mycompany.myrailsproject.app.models.smart_backtrace_log_level.should == Catamaran::LogLevel::ERROR
+      Catamaran.logger.com.mycompany.myrailsproject.app.models.instance_variable_get( :@memoized_backtrace_log_level ).should == Catamaran::LogLevel::ERROR
+      Catamaran.logger.com.mycompany.myrailsproject.app.models.smart_backtrace_log_level.should == Catamaran::LogLevel::ERROR
+      Catamaran.logger.forget_memoizations
+      Catamaran.logger.com.mycompany.myrailsproject.app.models.instance_variable_get( :@memoized_backtrace_log_level ).should be_nil      
+      Catamaran.logger.should_receive( :backtrace_log_level ).once.with( {:recursive=>true} ).and_return Catamaran::LogLevel::ERROR
+      Catamaran.logger.com.mycompany.myrailsproject.app.models.smart_backtrace_log_level.should == Catamaran::LogLevel::ERROR
+      Catamaran.logger.com.mycompany.myrailsproject.app.models.instance_variable_get( :@memoized_backtrace_log_level ).should == Catamaran::LogLevel::ERROR      
+      Catamaran.logger.com.mycompany.myrailsproject.app.models.smart_backtrace_log_level.should == Catamaran::LogLevel::ERROR
+    end    
+
     context "when the log level is specified, the default is no longer used" do
       it "should makeuse of the specified log level rather than the inherited one" do
         initial_log_level = Catamaran.logger.smart_log_level
@@ -325,9 +355,9 @@ describe Catamaran do
       end
 
       it "should be able to handle IO log levels" do
+        Catamaran::LogLevel.severity_to_s( Catamaran::LogLevel::IO_LESS_CRITICAL_THAN_TRACE ).should == 'IO'        
         Catamaran::LogLevel.severity_to_s( Catamaran::LogLevel::IO_LESS_CRITICAL_THAN_INFO ).should == 'IO'
         Catamaran::LogLevel.severity_to_s( Catamaran::LogLevel::IO_LESS_CRITICAL_THAN_DEBUG ).should == 'IO'
-        Catamaran::LogLevel.severity_to_s( Catamaran::LogLevel::IO_LESS_CRITICAL_THAN_NOTICE ).should == 'IO'
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: catamaran
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Jeano
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-02 00:00:00.000000000 Z
+date: 2014-01-03 00:00:00.000000000 Z
 dependencies: []
 description: A logging utility
 email: