grizzled-rails-logger 0.1.0

data/lib/grizzled/rails/logger.rb

@@ -0,0 +1,125 @@
+# +Grizzled::Rails::Logger+ is an extension to the stock Rails 3
+# logger, providing additional logging options and capablities.
+#
+# Author::    Brian M. Clapper (mailto:bmc@clapper.org)
+# Copyright:: Copyright (c) 2012 Brian M. Clapper
+# License::   BSD
+
+require 'active_support/buffered_logger'
+require 'term/ansicolor'
+require 'ostruct'
+
+module Grizzled # :nodoc:
+  module Rails # :nodoc:
+
+    # Logger is the public face of this gem.
+    module Logger
+
+      # Configuration constants
+      Configuration = OpenStruct.new(
+          :flatten    => true,
+          :format     => '[%T] (%S) %P %M',
+          :timeformat => '%Y/%m/%d %H:%M:%S',
+          :colorize   => true,
+          :colors     => {
+            :debug => Term::ANSIColor.cyan,
+            :warn  => Term::ANSIColor.yellow + Term::ANSIColor.bold,
+            :fatal => Term::ANSIColor.red + Term::ANSIColor.bold,
+            :error => Term::ANSIColor.red
+          }
+      )
+
+      # Configure the plugin. Use like:
+      #
+      #     Grizzled::Rails::Logger.configure do |cfg|
+      #       cfg.flatten = false
+      #       ...
+      #     end
+      def configure(&block)
+        block.call Configuration
+      end
+
+      module_function :configure
+
+      # The actual logging extension sits in here.
+      module Extension # :nodoc:
+
+        Severity = ActiveSupport::BufferedLogger::Severity
+        SEVERITIES = Severity.constants.sort_by { |c| Severity.const_get(c) }
+
+        ERROR = ActiveSupport::BufferedLogger::ERROR
+        WARN  = ActiveSupport::BufferedLogger::WARN
+        FATAL = ActiveSupport::BufferedLogger::FATAL
+        DEBUG = ActiveSupport::BufferedLogger::DEBUG
+        INFO  = ActiveSupport::BufferedLogger::INFO
+
+        SEVERITY_MAP = {
+          DEBUG => :debug,
+          WARN  => :warn,
+          FATAL => :fatal,
+          ERROR => :error,
+          INFO  => :info
+        }
+
+        def self.included(base)
+          base.class_eval do
+            alias_method_chain :add, :grizzling
+          end
+        end
+
+        def exception(message, ex, progname = nil)
+          ex_message = "#{ex.class} (backtrace):\n#{ex.backtrace.join("\n")}"
+          if message.nil? || (message.length == 0)
+            message = "#{ex_message}"
+          else
+            message << "\n#{ex_message}"
+          end
+
+          do_add(ERROR, message, progname, :flatten => false)
+        end
+
+        def add_with_grizzling(severity, message = nil, progname = nil, &block)
+          do_add(severity, message, progname, &block)
+        end
+
+        private
+
+        def do_add(severity, message, progname, options = {}, &block)
+          return if @level > severity
+
+          if message.nil?
+            if block_given?
+              if severity < @level
+                return true
+              end
+              message = yield
+            end
+          end
+
+          flatten = options.fetch(:flatten, Configuration.flatten)
+          message.gsub!("\n", '') if flatten
+          time = Time.now.strftime(Configuration.timeformat)
+          pid = $$.to_s
+          sev = SEVERITIES[severity].to_s
+
+          message = Configuration.format.gsub("%T", time).
+                                         gsub("%P", pid).
+                                         gsub("%S", sev).
+                                         gsub("%M", message)
+      
+          if Configuration.colorize
+            color = Configuration.colors[SEVERITY_MAP[severity]]
+            message = "#{color}#{message}#{Term::ANSIColor.reset}" if color
+          end
+
+          add_without_grizzling(severity, message, progname, &block)
+        end
+      end
+
+      # Bind it into Rails.
+      class Railtie < ::Rails::Railtie
+        ActiveSupport::BufferedLogger.send(:include, ::Grizzled::Rails::Logger::Extension)
+      end
+    end
+  end
+end

data/rdoc/Grizzled.html

@@ -0,0 +1,138 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <meta content="text/html; charset=UTF-8" http-equiv="Content-Type" />
+
+  <title>Module: Grizzled</title>
+
+  <link rel="stylesheet" href="./rdoc.css" type="text/css" media="screen" />
+
+  <script src="./js/jquery.js" type="text/javascript" charset="utf-8"></script>
+  <script src="./js/thickbox-compressed.js" type="text/javascript" charset="utf-8"></script>
+  <script src="./js/quicksearch.js" type="text/javascript" charset="utf-8"></script>
+  <script src="./js/darkfish.js" type="text/javascript" charset="utf-8"></script>
+
+</head>
+<body id="top" class="module">
+
+  <div id="metadata">
+    <div id="home-metadata">
+      <div id="home-section" class="section">
+        <h3 class="section-header">
+          <a href="./index.html">Home</a>
+          <a href="./index.html#classes">Classes</a>
+          <a href="./index.html#methods">Methods</a>
+        </h3>
+      </div>
+    </div>
+
+    <div id="file-metadata">
+      <div id="file-list-section" class="section">
+        <h3 class="section-header">In Files</h3>
+        <div class="section-body">
+          <ul>
+          
+            <li><a href="./lib/grizzled/rails/logger_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
+              class="thickbox" title="lib/grizzled/rails/logger.rb">lib/grizzled/rails/logger.rb</a></li>
+          
+          </ul>
+        </div>
+      </div>
+
+      
+    </div>
+
+    <div id="class-metadata">
+      
+
+      
+
+      
+      <!-- Namespace Contents -->
+      <div id="namespace-list-section" class="section">
+        <h3 class="section-header">Namespace</h3>
+        <ul class="link-list">
+          
+          <li><span class="type">MODULE</span> <a href="Grizzled/Rails.html">Grizzled::Rails</a></li>
+          
+        </ul>
+      </div>
+      
+
+      
+
+      
+    </div>
+
+    <div id="project-metadata">
+      
+      
+
+      <div id="classindex-section" class="section project-section">
+        <h3 class="section-header">Class/Module Index
+          <span class="search-toggle"><img src="./images/find.png"
+            height="16" width="16" alt="[+]"
+            title="show/hide quicksearch" /></span></h3>
+        <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
+        <fieldset>
+          <legend>Quicksearch</legend>
+          <input type="text" name="quicksearch" value=""
+            class="quicksearch-field" />
+        </fieldset>
+        </form>
+
+        <ul class="link-list">
+        
+          <li><a href="./Grizzled.html">Grizzled</a></li>
+        
+          <li><a href="./Grizzled/Rails.html">Grizzled::Rails</a></li>
+        
+          <li><a href="./Grizzled/Rails/Logger.html">Grizzled::Rails::Logger</a></li>
+        
+          <li><a href="./Grizzled/Rails/Logger/Railtie.html">Grizzled::Rails::Logger::Railtie</a></li>
+        
+        </ul>
+        <div id="no-class-search-results" style="display: none;">No matching classes.</div>
+      </div>
+
+      
+    </div>
+  </div>
+
+  <div id="documentation">
+    <h1 class="module">Grizzled</h1>
+
+    <div id="description" class="description">
+      
+    </div><!-- description -->
+
+    
+    
+    
+    <div id="5Buntitled-5D" class="documentation-section">
+      
+
+      
+
+      
+
+      
+
+      <!-- Methods -->
+      
+    </div><!-- 5Buntitled-5D -->
+  
+
+  </div><!-- documentation -->
+
+  <div id="validator-badges">
+    <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+    <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
+      Rdoc Generator</a> 2</small>.</p>
+  </div>
+
+</body>
+</html>
+

data/rdoc/Grizzled/Rails.html

@@ -0,0 +1,138 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <meta content="text/html; charset=UTF-8" http-equiv="Content-Type" />
+
+  <title>Module: Grizzled::Rails</title>
+
+  <link rel="stylesheet" href="../rdoc.css" type="text/css" media="screen" />
+
+  <script src="../js/jquery.js" type="text/javascript" charset="utf-8"></script>
+  <script src="../js/thickbox-compressed.js" type="text/javascript" charset="utf-8"></script>
+  <script src="../js/quicksearch.js" type="text/javascript" charset="utf-8"></script>
+  <script src="../js/darkfish.js" type="text/javascript" charset="utf-8"></script>
+
+</head>
+<body id="top" class="module">
+
+  <div id="metadata">
+    <div id="home-metadata">
+      <div id="home-section" class="section">
+        <h3 class="section-header">
+          <a href="../index.html">Home</a>
+          <a href="../index.html#classes">Classes</a>
+          <a href="../index.html#methods">Methods</a>
+        </h3>
+      </div>
+    </div>
+
+    <div id="file-metadata">
+      <div id="file-list-section" class="section">
+        <h3 class="section-header">In Files</h3>
+        <div class="section-body">
+          <ul>
+          
+            <li><a href="../lib/grizzled/rails/logger_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
+              class="thickbox" title="lib/grizzled/rails/logger.rb">lib/grizzled/rails/logger.rb</a></li>
+          
+          </ul>
+        </div>
+      </div>
+
+      
+    </div>
+
+    <div id="class-metadata">
+      
+
+      
+
+      
+      <!-- Namespace Contents -->
+      <div id="namespace-list-section" class="section">
+        <h3 class="section-header">Namespace</h3>
+        <ul class="link-list">
+          
+          <li><span class="type">MODULE</span> <a href="Rails/Logger.html">Grizzled::Rails::Logger</a></li>
+          
+        </ul>
+      </div>
+      
+
+      
+
+      
+    </div>
+
+    <div id="project-metadata">
+      
+      
+
+      <div id="classindex-section" class="section project-section">
+        <h3 class="section-header">Class/Module Index
+          <span class="search-toggle"><img src="../images/find.png"
+            height="16" width="16" alt="[+]"
+            title="show/hide quicksearch" /></span></h3>
+        <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
+        <fieldset>
+          <legend>Quicksearch</legend>
+          <input type="text" name="quicksearch" value=""
+            class="quicksearch-field" />
+        </fieldset>
+        </form>
+
+        <ul class="link-list">
+        
+          <li><a href="../Grizzled.html">Grizzled</a></li>
+        
+          <li><a href="../Grizzled/Rails.html">Grizzled::Rails</a></li>
+        
+          <li><a href="../Grizzled/Rails/Logger.html">Grizzled::Rails::Logger</a></li>
+        
+          <li><a href="../Grizzled/Rails/Logger/Railtie.html">Grizzled::Rails::Logger::Railtie</a></li>
+        
+        </ul>
+        <div id="no-class-search-results" style="display: none;">No matching classes.</div>
+      </div>
+
+      
+    </div>
+  </div>
+
+  <div id="documentation">
+    <h1 class="module">Grizzled::Rails</h1>
+
+    <div id="description" class="description">
+      
+    </div><!-- description -->
+
+    
+    
+    
+    <div id="5Buntitled-5D" class="documentation-section">
+      
+
+      
+
+      
+
+      
+
+      <!-- Methods -->
+      
+    </div><!-- 5Buntitled-5D -->
+  
+
+  </div><!-- documentation -->
+
+  <div id="validator-badges">
+    <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+    <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
+      Rdoc Generator</a> 2</small>.</p>
+  </div>
+
+</body>
+</html>
+

data/rdoc/Grizzled/Rails/Logger.html

@@ -0,0 +1,207 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <meta content="text/html; charset=UTF-8" http-equiv="Content-Type" />
+
+  <title>Module: Grizzled::Rails::Logger</title>
+
+  <link rel="stylesheet" href="../../rdoc.css" type="text/css" media="screen" />
+
+  <script src="../../js/jquery.js" type="text/javascript" charset="utf-8"></script>
+  <script src="../../js/thickbox-compressed.js" type="text/javascript" charset="utf-8"></script>
+  <script src="../../js/quicksearch.js" type="text/javascript" charset="utf-8"></script>
+  <script src="../../js/darkfish.js" type="text/javascript" charset="utf-8"></script>
+
+</head>
+<body id="top" class="module">
+
+  <div id="metadata">
+    <div id="home-metadata">
+      <div id="home-section" class="section">
+        <h3 class="section-header">
+          <a href="../../index.html">Home</a>
+          <a href="../../index.html#classes">Classes</a>
+          <a href="../../index.html#methods">Methods</a>
+        </h3>
+      </div>
+    </div>
+
+    <div id="file-metadata">
+      <div id="file-list-section" class="section">
+        <h3 class="section-header">In Files</h3>
+        <div class="section-body">
+          <ul>
+          
+            <li><a href="../../lib/grizzled/rails/logger_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
+              class="thickbox" title="lib/grizzled/rails/logger.rb">lib/grizzled/rails/logger.rb</a></li>
+          
+          </ul>
+        </div>
+      </div>
+
+      
+    </div>
+
+    <div id="class-metadata">
+      
+
+      
+
+      
+      <!-- Namespace Contents -->
+      <div id="namespace-list-section" class="section">
+        <h3 class="section-header">Namespace</h3>
+        <ul class="link-list">
+          
+          <li><span class="type">CLASS</span> <a href="Logger/Railtie.html">Grizzled::Rails::Logger::Railtie</a></li>
+          
+        </ul>
+      </div>
+      
+
+      
+      <!-- Method Quickref -->
+      <div id="method-list-section" class="section">
+        <h3 class="section-header">Methods</h3>
+        <ul class="link-list">
+          
+          <li><a href="#method-c-configure">::configure</a></li>
+          
+        </ul>
+      </div>
+      
+
+      
+    </div>
+
+    <div id="project-metadata">
+      
+      
+
+      <div id="classindex-section" class="section project-section">
+        <h3 class="section-header">Class/Module Index
+          <span class="search-toggle"><img src="../../images/find.png"
+            height="16" width="16" alt="[+]"
+            title="show/hide quicksearch" /></span></h3>
+        <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
+        <fieldset>
+          <legend>Quicksearch</legend>
+          <input type="text" name="quicksearch" value=""
+            class="quicksearch-field" />
+        </fieldset>
+        </form>
+
+        <ul class="link-list">
+        
+          <li><a href="../../Grizzled.html">Grizzled</a></li>
+        
+          <li><a href="../../Grizzled/Rails.html">Grizzled::Rails</a></li>
+        
+          <li><a href="../../Grizzled/Rails/Logger.html">Grizzled::Rails::Logger</a></li>
+        
+          <li><a href="../../Grizzled/Rails/Logger/Railtie.html">Grizzled::Rails::Logger::Railtie</a></li>
+        
+        </ul>
+        <div id="no-class-search-results" style="display: none;">No matching classes.</div>
+      </div>
+
+      
+    </div>
+  </div>
+
+  <div id="documentation">
+    <h1 class="module">Grizzled::Rails::Logger</h1>
+
+    <div id="description" class="description">
+      
+<p><a href="Logger.html">Logger</a> is the public face of this gem.</p>
+
+    </div><!-- description -->
+
+    
+    
+    
+    <div id="5Buntitled-5D" class="documentation-section">
+      
+
+      
+
+      
+      <!-- Constants -->
+      <div id="constants-list" class="section">
+        <h3 class="section-header">Constants</h3>
+        <dl>
+        
+          <dt><a name="Configuration">Configuration</a></dt>
+          
+          <dd class="description"><p><a href="Logger.html#Configuration">Configuration</a> constants</p></dd>
+          
+        
+        </dl>
+      </div>
+      
+
+      
+
+      <!-- Methods -->
+      
+      <div id="public-class-method-details" class="method-section section">
+        <h3 class="section-header">Public Class Methods</h3>
+
+      
+        <div id="configure-method" class="method-detail ">
+          <a name="method-c-configure"></a>
+
+          
+          <div class="method-heading">
+            <span class="method-name">configure</span><span
+              class="method-args">(&block)</span>
+            <span class="method-click-advice">click to toggle source</span>
+          </div>
+          
+
+          <div class="method-description">
+            
+            <p>Configure the plugin. Use like:</p>
+
+<pre>Grizzled::Rails::Logger.configure do |cfg|
+  cfg.flatten = false
+  ...
+end</pre>
+            
+
+            
+            <div class="method-source-code" id="configure-source">
+<pre>
+<span class="ruby-comment"># File lib/grizzled/rails/logger.rb, line 38</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">configure</span>(&amp;<span class="ruby-identifier">block</span>)
+  <span class="ruby-identifier">block</span>.<span class="ruby-identifier">call</span> <span class="ruby-constant">Configuration</span>
+<span class="ruby-keyword">end</span></pre>
+            </div><!-- configure-source -->
+            
+          </div>
+
+          
+
+          
+        </div><!-- configure-method -->
+
+      
+      </div><!-- public-class-method-details -->
+    
+    </div><!-- 5Buntitled-5D -->
+  
+
+  </div><!-- documentation -->
+
+  <div id="validator-badges">
+    <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+    <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
+      Rdoc Generator</a> 2</small>.</p>
+  </div>
+
+</body>
+</html>
+