catamaran 0.8.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 410f6cab582f4a6bae572cb402f8418de8ba747a
-  data.tar.gz: 0a3d19f6bf7fa91ab2ab2adc975ef9c97383a6c1
+  metadata.gz: 070bb5224a0412112c13ca5981859b8d201be22d
+  data.tar.gz: 2192f55d66d64d284a20bc409a1c0a2cc92c795e
 SHA512:
-  metadata.gz: 6f0404c71937b1c5a498dec0c08046a650f1aa12f5463e6394935bced82fb16304d7470c8c1816b74b07740dd6d6dd44f103c5cbdf78be8dc2e959f37d608718
-  data.tar.gz: 530fe5faf02e4ff3d6b411ddbb9b1a420e4589e92529f03f8c0762141d84337e7e92af444be26b13b677e79ce7c5f2a32ee8d3b0f3243d7f1738ab14620082aa
+  metadata.gz: b809ca0a2dcf06b23aa5eddb66820781ed28c978da4e16a9d45e4e2d3f0fa250f5074fa4e746405211e3eea7d46599193d7e861769add0b858bdb081fa3cae8e
+  data.tar.gz: 1fc5c6ff9a835959cc43833e0c39fa250c32188c8eba73b89fe5d41738e078c972d10362e0f795b3307604b43f533e575e064e91b9e194c3251818a8850812cc

data/README.md

@@ -6,7 +6,7 @@ Logging is a powerful and often undervalued tool in software development.  When
 Gemfile
 -------
 
-    gem 'catamaran', '~> 0.8.1'
+    gem 'catamaran', '~> 0.9.0'
 
 Rails-related setup:
 
@@ -20,14 +20,21 @@ Ruby Quickstart
 require 'catamaran'
 
 class FirstRubyDemo
-  LOGGER = Catamaran.logger( "FirstRubyDemo" )
+  LOGGER = Catamaran.logger( "com.mytld.FirstRubyDemo" )
   # or equivalently: 
-  # LOGGER = Catamaran.logger.FirstRubyDemo
+  # LOGGER = Catamaran.logger.com.mytld.FirstRubyDemo
 
   def run
-    LOGGER.notice( "Note that NOTICE messages are captured by default" ) if LOGGER.notice?
-    LOGGER.info( "Note that INFO messages are NOT captured by default" ) if LOGGER.info?
-    LOGGER.debug( "Note that DEBUG messages are NOT captured by default" ) if LOGGER.debug?
+    # Disabled by default
+    LOGGER.trace( "TRACE logs are NOT captured by default" ) if LOGGER.trace?    
+    LOGGER.debug( "DEBUG logs are NOT captured by default" ) if LOGGER.debug?
+    LOGGER.info( "INFO logs are NOT captured by default" ) if LOGGER.info?
+
+    # Enabled by default
+    LOGGER.notice( "NOTICE logs are captured by default" )
+    LOGGER.warn( "WARN logs are captured by default" )
+    LOGGER.error( "ERROR logs are captured by default" )
+    LOGGER.severe( "SEVERE logs are captured by default" )
   end
 end
 
@@ -36,7 +43,12 @@ FirstRubyDemo.new.run
 
 And the output
 
-    NOTICE pid-2729 [2013-12-23 19:35:35:732]                                   FirstRubyDemo - Note that NOTICE messages are getting captured by default
+```
+NOTICE pid-23773 [2014-01-01 13:09:47:551]                     com.mytld.FirstRubyDemo - NOTICE logs are captured by default
+  WARN pid-23773 [2014-01-01 13:09:47:551]                     com.mytld.FirstRubyDemo - WARN logs are captured by default
+ ERROR pid-23773 [2014-01-01 13:09:47:551]                     com.mytld.FirstRubyDemo - ERROR logs are captured by default
+SEVERE pid-23773 [2014-01-01 13:09:47:551]                     com.mytld.FirstRubyDemo - SEVERE logs are captured by default
+```
 
 
 Rails Quickstart
@@ -44,7 +56,7 @@ Rails Quickstart
 
 ```ruby
 class PagesController < ApplicationController
-  LOGGER = Catamaran.logger.com.mycompany.myrailsapp.app.controllers.PagesController
+  LOGGER = Catamaran.logger.com.mytld.myrailsapp.app.controllers.PagesController
 
   def index
     LOGGER.debug "Entering with params = #{params}" if LOGGER.debug?       
@@ -55,7 +67,8 @@ end
 Load the `index` page and check out your `development.log` file
 
 ### Sample log entry (in your development.log file)
-    DEBUG pid-86000 [2013-12-17 17:26:39:176] pany.myrailsapp.app.controllers.PagesController - Entering with params = {"controller"=>"pages", "action"=>"index"} (`/myrailsapp/app/controllers/pages_controller.rb:7`:in `index`)
+
+    DEBUG pid-86000 [2013-12-17 17:26:39:176] ytld.myrailsapp.app.controllers.PagesController - Entering with params = {"controller"=>"pages", "action"=>"index"} (`/myrailsapp/app/controllers/pages_controller.rb:7`:in `index`)
 
 Log Levels
 ----------
@@ -82,7 +95,7 @@ class SecondRubyDemo
 end 
 
 class ThirdRubyDemo
-  LOGGER = Catamaran.logger( "com.mycompany.ThirdRubyDemo", { :class => name(), :file => __FILE__ } )
+  LOGGER = Catamaran.logger( "com.mytld.ThirdRubyDemo", { :class => name(), :file => __FILE__ } )
 
   def run
     LOGGER.warn( "Sample WARN statement", { :line => __LINE__, :method => 'run' } )
@@ -98,9 +111,9 @@ ThirdRubyDemo.new.run
 And the output
 
       INFO pid-5973 [2013-12-27 17:18:09:115]                                                 - Sample INFO statement (catamaran_ruby_demos.rb:12:in `SecondRubyDemo.run')
-      WARN pid-5973 [2013-12-27 17:18:09:115]                     com.mycompany.ThirdRubyDemo - Sample WARN statement (catamaran_ruby_demos.rb:20:in `ThirdRubyDemo.run')
-      WARN pid-5973 [2013-12-27 17:18:09:115]                     com.mycompany.ThirdRubyDemo - Sample WARN statement with backtrace option (catamaran_ruby_demos.rb:21:in `ThirdRubyDemo.run')
-     ERROR pid-5973 [2013-12-27 17:18:09:115]                     com.mycompany.ThirdRubyDemo - Sample ERROR statement with backtrace option (catamaran_ruby_demos.rb:22:in `ThirdRubyDemo.run') from:
+      WARN pid-5973 [2013-12-27 17:18:09:115]                     com.mytld.ThirdRubyDemo - Sample WARN statement (catamaran_ruby_demos.rb:20:in `ThirdRubyDemo.run')
+      WARN pid-5973 [2013-12-27 17:18:09:115]                     com.mytld.ThirdRubyDemo - Sample WARN statement with backtrace option (catamaran_ruby_demos.rb:21:in `ThirdRubyDemo.run')
+     ERROR pid-5973 [2013-12-27 17:18:09:115]                     com.mytld.ThirdRubyDemo - Sample ERROR statement with backtrace option (catamaran_ruby_demos.rb:22:in `ThirdRubyDemo.run') from:
     catamaran_ruby_demos.rb:22:in `run'
     catamaran_ruby_demos.rb:27:in `<main>'
 

data/lib/catamaran/log_level.rb

@@ -55,8 +55,11 @@ module Catamaran
         'IO'
       when IO_LESS_CRITICAL_THAN_DEBUG
         'IO'
+      when IO_LESS_CRITICAL_THAN_NOTICE
+        'IO'        
       else
-        'UNKNOWN'
+        # Unknown
+        ''
       end
     end   
 

data/lib/catamaran/logger.rb

@@ -12,12 +12,15 @@ module Catamaran
 
     def log_level( opts = {} )
       if instance_variable_defined?( :@log_level ) && @log_level
-        retval = @log_level
+        # Implicit return
+        @log_level
       elsif self.parent.nil?
         # No parent means this logger(self) is the root logger.  So use the default log level
-        retval = Catamaran::LogLevel::NOTICE
+        
+        # Implicit return
+        Catamaran::LogLevel::NOTICE
       else
-        recursive = opts[:recursive]
+        recursive = ( 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
@@ -25,15 +28,15 @@ module Catamaran
             @memoized_log_level = parent.log_level( opts ) if parent
           end
 
-          retval = @memoized_log_level
+          # Implicit return
+          @memoized_log_level
         else
           Catamaran.debugging( "Catamaran::Logger#log_level() - non-recrusive request for log level.  And log level is nil.  This shouldn't happen too often." ) if Catamaran.debugging?        
-          retval = nil
+          
+          # Implicit return
+          nil
         end
       end
-
-      # Implicit return
-      retval
     end
 
     ## 
@@ -137,7 +140,7 @@ module Catamaran
     # Is trace-level logging currently enabled?
 
     def trace?
-      if self.smart_log_level() <= LogLevel::TRACE
+      if self.log_level( { :be_populated => true } ) <= LogLevel::TRACE
         true
       else
         false
@@ -145,7 +148,8 @@ module Catamaran
     end
 
     def trace( msg, opts = nil )
-      if trace?
+      # Duplicated the logic from trace? for performance considerations          
+      if self.log_level( { :be_populated => true } ) <= LogLevel::TRACE
         log( LogLevel::TRACE, msg, opts )
       end
     end
@@ -154,7 +158,7 @@ module Catamaran
     # Is debug-level logging currently enabled?
 
     def debug?
-      if self.smart_log_level() <= LogLevel::DEBUG
+      if self.log_level( { :be_populated => true } ) <= LogLevel::DEBUG
         true
       else
         false
@@ -162,7 +166,8 @@ module Catamaran
     end
 
     def debug( msg, opts = nil )
-      if debug?
+       # Duplicated the logic from debug? for performance considerations            
+      if self.log_level( { :be_populated => true } ) <= LogLevel::DEBUG
         log( LogLevel::DEBUG, msg, opts )
       end
     end
@@ -172,7 +177,7 @@ module Catamaran
     # Is io-level logging currently enabled?
 
     def io?
-      if self.smart_log_level() <= LogLevel::IO
+      if self.log_level( { :be_populated => true } ) <= LogLevel::IO
         true
       else
         false
@@ -180,7 +185,8 @@ module Catamaran
     end
 
     def io( msg, opts = nil )
-      if io?
+       # Duplicated the logic from io? for performance considerations      
+      if self.log_level( { :be_populated => true } ) <= LogLevel::IO
         log( LogLevel::IO, msg, opts )
       end
     end
@@ -189,7 +195,7 @@ module Catamaran
     # Is info-level logging currently enabled?
 
     def info?
-      if self.smart_log_level() <= LogLevel::INFO
+      if self.log_level( { :be_populated => true } ) <= LogLevel::INFO
         true
       else
         false
@@ -197,7 +203,8 @@ module Catamaran
     end
 
     def info( msg, opts = nil )
-      if info?
+       # Duplicated the logic from info? for performance considerations
+      if self.log_level( { :be_populated => true } ) <= LogLevel::INFO
         log( LogLevel::INFO, msg, opts )
       end
     end 
@@ -206,7 +213,7 @@ module Catamaran
     # Is notice-level logging currently enabled?
 
     def notice?
-      if self.smart_log_level() <= LogLevel::NOTICE
+      if self.log_level( { :be_populated => true } ) <= LogLevel::NOTICE
         true
       else
         false
@@ -214,7 +221,8 @@ module Catamaran
     end
 
     def notice( msg, opts = nil )
-      if notice?
+      # Duplicated the logic from notice? for performance considerations
+      if self.log_level( { :be_populated => true } ) <= LogLevel::NOTICE
         log( LogLevel::NOTICE, msg, opts )
       end
     end    
@@ -223,7 +231,7 @@ module Catamaran
     # Is warn-level logging currently enabled?
 
     def warn?
-      if self.smart_log_level() <= LogLevel::WARN
+      if self.log_level( { :be_populated => true } ) <= LogLevel::WARN
         true
       else
         false
@@ -231,7 +239,8 @@ module Catamaran
     end
 
     def warn( msg, opts = nil )
-      if warn?
+      # Duplicated the logic from warn? for performance considerations
+      if self.log_level( { :be_populated => true } ) <= LogLevel::WARN
         log( LogLevel::WARN, msg, opts )
       end
     end     
@@ -240,7 +249,7 @@ module Catamaran
     # Is error-level logging currently enabled?
 
     def error?
-      if self.smart_log_level() <= LogLevel::ERROR
+      if self.log_level( { :be_populated => true } ) <= LogLevel::ERROR
         true
       else
         false
@@ -248,7 +257,8 @@ module Catamaran
     end
 
     def error( msg, opts = nil )
-      if error?
+      # Duplicated the logic from error? for performance considerations
+      if self.log_level( { :be_populated => true } ) <= LogLevel::ERROR
         log( LogLevel::ERROR, msg, opts )
       end
     end 
@@ -257,7 +267,7 @@ module Catamaran
     # Is severe-level logging currently enabled?
 
     def severe?
-      if self.smart_log_level() <= LogLevel::SEVERE
+      if self.log_level( { :be_populated => true } ) <= LogLevel::SEVERE
         true
       else
         false
@@ -265,7 +275,8 @@ module Catamaran
     end
 
     def severe( msg, opts = nil )
-      if severe?
+      # Duplicated the logic from severe? for performance considerations      
+      if self.log_level( { :be_populated => true } ) <= LogLevel::SEVERE
         log( LogLevel::SEVERE, msg, opts )
       end
     end   

data/lib/catamaran/version.rb

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

data/spec/catamaran_spec.rb

@@ -327,6 +327,7 @@ describe Catamaran do
       it "should be able to handle IO log levels" do
         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.8.1
+  version: 0.9.0
 platform: ruby
 authors:
 - Jeano
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-01 00:00:00.000000000 Z
+date: 2014-01-02 00:00:00.000000000 Z
 dependencies: []
 description: A logging utility
 email: