catamaran 0.9.1 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c51065cdb4214656604cdb61802d5eb574698f5f
-  data.tar.gz: 7fa689f18bade04142e110bc5693b6370e168034
+  metadata.gz: de217e176b2cb0c6ac1dc6e0b99b4bb2297383ea
+  data.tar.gz: d062ac5460294965d8ced97e2431d8c24f039b07
 SHA512:
-  metadata.gz: e6f186c028aa5ce1cd5db49971b723862d7e141f0fc9daf902dee4a1961ec9e4667bb83681b177bde6d6c037ef7e47419379de11fca2576c752a0b32eb431655
-  data.tar.gz: 7b7750e9d5eaaeb882902b0637b0f9ae2b7e3cec5d444093a6e23ddf9e1b6f68239e421e64e9d4876f8340e131a7c5487f684a139fc48651f316a9ca7267f997
+  metadata.gz: cb3e3f5099b0e621064b25d2a55365d3c48557fd991bc11989ea61c0242784825e80c487425cb9fb176fd02c10f294689bfad561918079b760278d33c62bef70
+  data.tar.gz: b975c7e774b21315aa50ea6ff8a1245db8b6df63da987aabe40c7b38dd7ee7cbbd1386a3534a27bdee12b910ca10b5ac47891bc3c69df1d419200941f1f06406

data/README.md

@@ -6,7 +6,7 @@ Logging is a powerful and often undervalued tool in software development.  When
 Gemfile
 -------
 
-    gem 'catamaran', '~> 0.9.1'
+    gem 'catamaran', '~> 0.10.0'
 
 Rails-related setup:
 
@@ -35,6 +35,7 @@ class FirstRubyDemo
     LOGGER.warn( "WARN logs are captured by default" )
     LOGGER.error( "ERROR logs are captured by default" )
     LOGGER.severe( "SEVERE logs are captured by default" )
+    LOGGER.fatal( "FATAL logs are captured by default" )
   end
 end
 
@@ -48,6 +49,7 @@ NOTICE pid-23773 [2014-01-01 13:09:47:551]                     com.mytld.FirstRu
   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
+ FATAL pid-23773 [2014-01-01 13:09:47:551]                     com.mytld.FirstRubyDemo - FATAL logs are captured by default
 ```
 
 
@@ -55,11 +57,11 @@ Rails Quickstart
 ----------------
 
 ```ruby
-class PagesController < ApplicationController
-  LOGGER = Catamaran.logger.com.mytld.myrailsapp.app.controllers.PagesController
+class WidgetsController < ApplicationController
+  LOGGER = Catamaran.logger.com.mytld.myrailsapp.app.controllers.WidgetsController
 
   def index
-    LOGGER.debug "Entering with params = #{params}" if LOGGER.debug?       
+    LOGGER.debug "Handling a Widgets index request with params = #{params}" if LOGGER.debug?       
   end
 end
 ```
@@ -68,7 +70,7 @@ 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] ytld.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] ld.myrailsapp.app.controllers.WidgetsController - "Handling a Widgets index request with params = {"controller"=>"widgets", "action"=>"index"} (`/myrailsapp/app/controllers/widgets_controller.rb:7`:in `index`)
 
 Log Levels
 ----------
@@ -129,12 +131,13 @@ 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 severity thresholds from different parts of the app simultaneously
+* is capable of capturing logs at different severity thresholds from different parts of the app simultaneously (I always liked the Named Hierarchy and Level Inheritance aspects of log4j)
 * readily works with Rails
 * http://stackoverflow.com/questions/462651/rails-logger-format-string-configuration
 * http://stackoverflow.com/questions/3654827/logging-in-rails-app
 * http://stackoverflow.com/questions/11991967/rails-log-too-verbose
 * http://www.ietf.org/rfc/rfc3164.txt
+* http://logging.apache.org/log4j/1.2
 
 Performance Considerations
 --------------------------
@@ -281,3 +284,4 @@ Ideas around what's next
 
 
 
+

data/lib/catamaran/logger.rb

@@ -148,7 +148,7 @@ module Catamaran
     end
 
     def trace( msg, opts = nil )
-      # Duplicated the logic from trace? for performance considerations          
+      # Duplicated the logic from trace?() (rather than calling it directly) for performance considerations          
       if self.log_level( { :be_populated => true } ) <= LogLevel::TRACE
         log( LogLevel::TRACE, msg, opts )
       end
@@ -166,7 +166,7 @@ module Catamaran
     end
 
     def debug( msg, opts = nil )
-       # Duplicated the logic from debug? for performance considerations            
+       # Duplicated the logic from debug?() (rather than calling it directly) for performance considerations            
       if self.log_level( { :be_populated => true } ) <= LogLevel::DEBUG
         log( LogLevel::DEBUG, msg, opts )
       end
@@ -185,7 +185,7 @@ module Catamaran
     end
 
     def io( msg, opts = nil )
-       # Duplicated the logic from io? for performance considerations      
+       # Duplicated the logic from io?() (rather than calling it directly) for performance considerations      
       if self.log_level( { :be_populated => true } ) <= LogLevel::IO
         log( LogLevel::IO, msg, opts )
       end
@@ -203,7 +203,7 @@ module Catamaran
     end
 
     def info( msg, opts = nil )
-       # Duplicated the logic from info? for performance considerations
+       # Duplicated the logic from info?() (rather than calling it directly) for performance considerations
       if self.log_level( { :be_populated => true } ) <= LogLevel::INFO
         log( LogLevel::INFO, msg, opts )
       end
@@ -221,7 +221,7 @@ module Catamaran
     end
 
     def notice( msg, opts = nil )
-      # Duplicated the logic from notice? for performance considerations
+      # Duplicated the logic from notice?() (rather than calling it directly) for performance considerations
       if self.log_level( { :be_populated => true } ) <= LogLevel::NOTICE
         log( LogLevel::NOTICE, msg, opts )
       end
@@ -239,7 +239,7 @@ module Catamaran
     end
 
     def warn( msg, opts = nil )
-      # Duplicated the logic from warn? for performance considerations
+      # Duplicated the logic from warn?() (rather than calling it directly) for performance considerations
       if self.log_level( { :be_populated => true } ) <= LogLevel::WARN
         log( LogLevel::WARN, msg, opts )
       end
@@ -257,7 +257,7 @@ module Catamaran
     end
 
     def error( msg, opts = nil )
-      # Duplicated the logic from error? for performance considerations
+      # Duplicated the logic from error?() (rather than calling it directly) for performance considerations
       if self.log_level( { :be_populated => true } ) <= LogLevel::ERROR
         log( LogLevel::ERROR, msg, opts )
       end
@@ -275,7 +275,7 @@ module Catamaran
     end
 
     def severe( msg, opts = nil )
-      # Duplicated the logic from severe? for performance considerations      
+      # Duplicated the logic from severe?() (rather than calling it directly) for performance considerations      
       if self.log_level( { :be_populated => true } ) <= LogLevel::SEVERE
         log( LogLevel::SEVERE, msg, opts )
       end
@@ -284,19 +284,19 @@ module Catamaran
     ##
     # Is fatal-level logging currently enabled?
 
-    # def fatal?
-    #   if self.smart_log_level() <= LogLevel::FATAL
-    #     true
-    #   else
-    #     false
-    #   end
-    # end
-
-    # def fatal( msg, opts = nil )
-    #   if fatal?
-    #     log( LogLevel::FATAL, msg, opts )
-    #   end
-    # end            
+    def fatal?
+      if self.smart_log_level() <= LogLevel::FATAL
+        true
+      else
+        false
+      end
+    end
+
+    def fatal( msg, opts = nil )
+      if fatal?
+        log( LogLevel::FATAL, msg, opts )
+      end
+    end            
 
 
 

data/lib/catamaran/version.rb

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

data/spec/catamaran_spec.rb

@@ -273,6 +273,28 @@ describe Catamaran do
       Catamaran.logger.whatever.smart_log_level.should_not be_nil
     end    
 
+    it "should support the TRACE log severity and trace()" do
+      Catamaran.logger.log_level = Catamaran::LogLevel::TRACE
+      Catamaran.logger.should_receive( :log ).once
+      Catamaran.logger.trace( "A TRACE log should be received" )
+    end
+
+    it "should support the TRACE log severity and trace?()" do
+      Catamaran.logger.log_level = Catamaran::LogLevel::TRACE      
+      Catamaran.logger.trace?.should be_true
+    end
+
+    it "should support the FATAL log severity and fatal()" do
+      Catamaran.logger.smart_log_level.should < Catamaran::LogLevel::FATAL
+      Catamaran.logger.should_receive( :log ).once
+      Catamaran.logger.fatal( "A FATAL log should be received" )
+    end
+
+    it "should support the FATAL log severity and fatal?()" do
+      Catamaran.logger.smart_log_level.should < Catamaran::LogLevel::FATAL
+      Catamaran.logger.fatal?.should be_true
+    end    
+
     it "should write the log message if the requested log does have sufficient severity" do
       Catamaran.logger.smart_log_level.should <= Catamaran::LogLevel::NOTICE
       Catamaran.logger.should_receive( :log ).once

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: catamaran
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.10.0
 platform: ruby
 authors:
 - Jeano