catamaran 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ce160eae2640b8c7d690d9677b5440892b48dae1
-  data.tar.gz: 70e6fe894ef0216d45e5e0f837b94deb9a912b20
+  metadata.gz: 5e6d25e6550c1bcba63f44167d3e53de5950a528
+  data.tar.gz: 76e8decccaa647af4a1ebf5622ecf0594d0b5a49
 SHA512:
-  metadata.gz: a4ce49087602bed11ca7f627291829af5561ec6b21b0c46a1f7effac2b2f59ec8c1e34ad18ecc5e83e973c76e08b47efca2077fd55f2fe6685b9c84ea8a3c8b7
-  data.tar.gz: 3e4a99d0e26290c1be952b84d3acdc7a4847885acc3192184133dd8cff07b269f036a82d137c29f5172fd49b3f94b24dbd1ae3656fd5a07a294af8ac1b41f127
+  metadata.gz: cf04c77d2d57455b5899a232dc364e939da2280301e02891096ec19c5ca254702269e3d80b6c2530ba515c7f423eaa1f4d3f7386b4f2cf796ed07336b7840cec
+  data.tar.gz: d36ab4e2705db71915e064ca6986bc09d3292f929ad557438c28f176513f5469485344fcf28bf4ffeb709dcc41b819166b5ef1bde3551ac38b3a3578205fe8da

data/README.md

@@ -6,7 +6,7 @@ Logging is a powerful and often undervalued tool in software development.  When
 Gemfile
 -------
 
-    gem 'catamaran', '~> 0.4.0'
+    gem 'catamaran', '~> 0.6.0'
 
 Rails-related setup:
 
@@ -64,14 +64,14 @@ Other Ruby Examples
 -------------------
     require 'catamaran'
 
-    Catamaran::LogLevel.default_log_level = Catamaran::LogLevel::DEBUG 
+    Catamaran::LogLevel.default_log_level = Catamaran::LogLevel::TRACE 
     Catamaran::Manager.formatter_class = Catamaran::Formatter::NoCallerFormatter
 
     class SecondRubyDemo
       LOGGER = Catamaran.logger( { :class => name(), :file => __FILE__ } )
 
       def run
-        LOGGER.debug( "Sample DEBUG statement", { :line => __LINE__, :method => 'run'} ) if LOGGER.debug?
+        LOGGER.trace( "Sample TRACE statement", { :line => __LINE__, :method => 'run'} ) if LOGGER.trace?
       end
     end 
 
@@ -79,7 +79,8 @@ Other Ruby Examples
       LOGGER = Catamaran.logger( "com.mycompany.ThirdRubyDemo", { :class => name(), :file => __FILE__ } )
 
       def run
-        LOGGER.debug( "Sample DEBUG statement", { :line => __LINE__, :method => 'run'} ) if LOGGER.debug?
+        LOGGER.debug( "Sample DEBUG statement", { :line => __LINE__, :method => 'run' } ) if LOGGER.debug?
+        LOGGER.debug( "Sample DEBUG statement with backtrace option", { :line => __LINE__, :method => 'run', :backtrace => true } ) if LOGGER.debug?
       end
     end   
 
@@ -88,8 +89,12 @@ Other Ruby Examples
 
 And the output
 
-     DEBUG pid-2729 [2013-12-23 19:35:35:732]                                                 - Sample DEBUG statement (catamaran_ruby_demos.rb:21:in `SecondRubyDemo.run')
-     DEBUG pid-2729 [2013-12-23 19:35:35:732]                     com.mycompany.ThirdRubyDemo - Sample DEBUG statement (catamaran_ruby_demos.rb:29:in `ThirdRubyDemo.run')
+     TRACE pid-4714 [2013-12-26 15:33:05:311]                                                 - Sample TRACE statement (catamaran_ruby_demos.rb:11:in `SecondRubyDemo.run')
+     DEBUG pid-4714 [2013-12-26 15:33:05:311]                     com.mycompany.ThirdRubyDemo - Sample DEBUG statement (catamaran_ruby_demos.rb:19:in `ThirdRubyDemo.run')
+     DEBUG pid-4714 [2013-12-26 15:33:05:311]                     com.mycompany.ThirdRubyDemo - Sample DEBUG statement with backtrace option (catamaran_ruby_demos.rb:20:in `ThirdRubyDemo.run') from:
+    catamaran_ruby_demos.rb:20:in `run'
+    catamaran_ruby_demos.rb:25:in `<main>'
+
 
 
 Inspiration

data/lib/catamaran/formatter/base_formatter.rb

@@ -17,13 +17,24 @@ module Catamaran
         retval = sprintf( "%6s pid-#{Process.pid} [#{Time.now.strftime( "%G-%m-%d %H:%M:%S:%L" )}] %47s - #{msg}", LogLevel.to_s(log_level), updated_path  )
       end
 
+      def self.construct_backtrace_info( opts )
+        if opts && opts[:backtrace] == true
+          msg = " from:\n#{caller(4).take(10).join("\n")}"
+        else
+          msg = ''
+        end
+
+        # Implicit return
+        msg
+      end
+
 
       def self.contruct_suffix_info( opts )
         msg = ''
 
         if opts
           if opts[:file]
-            msg << "(#{opts[:file]}"
+            msg << " (#{opts[:file]}"
 
             if opts[:line]
               msg << ":#{opts[:line]}"

data/lib/catamaran/formatter/caller_formatter.rb

@@ -5,7 +5,7 @@ module Catamaran
 
     class CallerFormatter < BaseFormatter
       def self.construct_formatted_message( log_level, path, msg, opts )
-        "#{base_construct_formatted_message( log_level, path, msg, opts )} (#{caller(3)[0]})"
+        "#{base_construct_formatted_message( log_level, path, msg, opts )} (#{caller(3)[0]})" +  construct_backtrace_info( opts )
       end
     end
   end

data/lib/catamaran/formatter/no_caller_formatter.rb

@@ -5,12 +5,7 @@ module Catamaran
 
     class NoCallerFormatter < BaseFormatter
       def self.construct_formatted_message( log_level, path, msg, opts )        
-        suffix_info = contruct_suffix_info( opts )
-        if suffix_info && suffix_info.length > 0 
-          base_construct_formatted_message( log_level, path, msg, opts ) + ' ' + suffix_info
-        else
-          base_construct_formatted_message( log_level, path, msg, opts )
-        end
+        base_construct_formatted_message( log_level, path, msg, opts ) + contruct_suffix_info( opts ) + construct_backtrace_info( opts )
       end
     end
   end

data/lib/catamaran/log_level.rb

@@ -4,26 +4,36 @@ 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_DEBUG = 1080
-    IO_LESS_CRITICAL_THAN_INFO = 2080
+    IO_LESS_CRITICAL_THAN_DEBUG = 2080
+    IO_LESS_CRITICAL_THAN_INFO = 3080
 
+    BACKTRACE_LESS_CRITICAL_THAN_TRACE = 1070
+    BACKTRACE_LESS_CRITICAL_THAN_DEBUG = 2070
+    BACKTRACE_LESS_CRITICAL_THAN_INFO = 3070
+
+    ALL = 100
+
+    TRACE = 2000 
+    DEBUG = 3000
+    INFO = 4000
+    WARN = 5000
+    ERROR = 6000
+    SEVERE = 7000
+    FATAL = 8000
 
-    TRACE = 1000 
-    DEBUG = 2000
-    INFO = 3000
-    WARN = 4000
-    ERROR = 5000
-    SEVERE = 6000
-    FATAL = 7000
     IO = IO_LESS_CRITICAL_THAN_INFO
+    BACKTRACE = BACKTRACE_LESS_CRITICAL_THAN_INFO
+
 
-    
 
     def self.reset
       @@default_log_level = INFO
 
       self.send( :remove_const, 'IO' ) if self.const_defined?( 'IO' )
       self.const_set( 'IO', IO_LESS_CRITICAL_THAN_INFO )      
+
+      self.send( :remove_const, 'BACKTRACE' ) if self.const_defined?( 'BACKTRACE' )
+      self.const_set( 'BACKTRACE', BACKTRACE_LESS_CRITICAL_THAN_INFO )       
     end
 
     self.reset()
@@ -70,6 +80,15 @@ module Catamaran
 
     def self.log_level_io
       IO
-    end    
+    end 
+
+    def self.log_level_backtrace=( value )
+      self.send( :remove_const, 'BACKTRACE' ) if self.const_defined?( 'BACKTRACE' )
+      self.const_set( 'BACKTRACE', value ) 
+    end
+
+    def self.log_level_backtrace
+      BACKTRACE
+    end        
   end
 end

data/lib/catamaran/logger.rb

@@ -65,7 +65,7 @@ module Catamaran
 
     def trace( msg, opts = nil )
       if trace?
-        _write_to_log( LogLevel::TRACE, msg, opts )
+        _log( LogLevel::TRACE, msg, opts )
       end
     end
 
@@ -82,7 +82,7 @@ module Catamaran
 
     def debug( msg, opts = nil )
       if debug?
-        _write_to_log( LogLevel::DEBUG, msg, opts )
+        _log( LogLevel::DEBUG, msg, opts )
       end
     end
 
@@ -100,7 +100,7 @@ module Catamaran
 
     def io( msg, opts = nil )
       if io?
-        _write_to_log( LogLevel::IO, msg, opts )
+        _log( LogLevel::IO, msg, opts )
       end
     end
 
@@ -117,7 +117,7 @@ module Catamaran
 
     def info( msg, opts = nil )
       if info?
-        _write_to_log( LogLevel::INFO, msg, opts )
+        _log( LogLevel::INFO, msg, opts )
       end
     end 
 
@@ -134,7 +134,7 @@ module Catamaran
 
     def warn( msg, opts = nil )
       if warn?
-        _write_to_log( LogLevel::WARN, msg, opts )
+        _log( LogLevel::WARN, msg, opts )
       end
     end     
 
@@ -151,7 +151,7 @@ module Catamaran
 
     def error( msg, opts = nil )
       if error?
-        _write_to_log( LogLevel::ERROR, msg, opts )
+        _log( LogLevel::ERROR, msg, opts )
       end
     end 
 
@@ -168,7 +168,7 @@ module Catamaran
 
     def severe( msg, opts = nil )
       if severe?
-        _write_to_log( LogLevel::SEVERE, msg, opts )
+        _log( LogLevel::SEVERE, msg, opts )
       end
     end   
 
@@ -185,10 +185,21 @@ module Catamaran
 
     # def fatal( msg, opts = nil )
     #   if fatal?
-    #     _write_to_log( LogLevel::FATAL, msg, opts )
+    #     _log( LogLevel::FATAL, msg, opts )
     #   end
     # end            
 
+    ##
+    # Is backtrace-level logging currently enabled? (Special case)
+
+    def backtrace?
+      if self.smart_log_level() <= LogLevel::BACKTRACE
+        true
+      else
+        false
+      end
+    end
+
     ##
     # Usually get_logger is a reference to self, unless a path has been specified as a parameter
 
@@ -402,15 +413,23 @@ module Catamaran
 
 
     ##
-    # All log statements eventually call _write_to_log
+    # All log statements eventually call _log
 
-    def _write_to_log( log_level, msg, opts )
+    def _log( log_level, msg, opts )
       if self.specified_file || self.specified_class
         opts = {} unless opts
         opts[:file] = self.specified_file if self.specified_file
         opts[:class] = self.specified_class if self.specified_class
       end
 
+      if opts && opts[:backtrace] == true
+        # If backtrace is NOT enabled, then delete it from the options before it gets passed to the formatter
+        if !backtrace?
+          opts = opts.dup
+          opts.delete(:backtrace)
+        end
+      end
+
       formatted_msg = Manager.formatter_class.construct_formatted_message( log_level, self.path_to_s(), msg, opts )
       Outputter.write( formatted_msg )
     end

data/lib/catamaran/version.rb

@@ -1,4 +1,4 @@
 module Catamaran
-  VERSION = '0.5.0'
+  VERSION = '0.6.0'
 end
 

data/spec/catamaran_spec.rb

@@ -83,7 +83,7 @@ describe Catamaran do
       Catamaran::Manager.num_loggers.should == 1
     end
 
-    it "should be that the IO log level is the same as IO_LESS_CRITICAL_THAN_INFO" do
+    it "should have an IO log level that corresponds to IO_LESS_CRITICAL_THAN_INFO" do
       Catamaran::LogLevel::IO.should == Catamaran::LogLevel::IO_LESS_CRITICAL_THAN_INFO
     end
   end
@@ -203,14 +203,14 @@ describe Catamaran do
 
     it "should write the log if the log has sufficient weight" do
       Catamaran.logger.smart_log_level.should == Catamaran::LogLevel::INFO
-      Catamaran.logger.should_receive( :_write_to_log ).once
+      Catamaran.logger.should_receive( :_log ).once
       Catamaran.logger.info( "Testing an INFO log" )
     end
 
     it "should NOT write the log if the log does NOT have sufficient" do
       Catamaran.logger.smart_log_level.should == Catamaran::LogLevel::INFO
       # DEBUG is disabled
-      Catamaran.logger.should_not_receive( :_write_to_log )
+      Catamaran.logger.should_not_receive( :_log )
       Catamaran.logger.debug( "Testing a DEBUG log" )
     end
 

metadata

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