itslog 0.3.2 → 0.5.0

data/README.md

@@ -3,11 +3,15 @@ itslog
 
 `itslog` is a log formatter designed to aid rails development.
 
-The formatting will prepend all log statements with a colored header and additional information about the statement.
+The formatting will prepend all log statements with a colored header and additional information about the statement. The information and structure of the new statements is customizable through configuration.
 
 [timestamp] [rails namespace] [log message], example:
 
-    15:16:32 action_view Rendered layouts/_head.haml (8.5ms)
+![](http://cdn.lts.cr/files/bf23b77669a77fb444b6/itslog_example1.jpg)
+
+Errors and warnings will also stand out, example:
+
+![](http://cdn.lts.cr/files/bf23b77669a77fb444b6/itslog_example2.jpg)
 
 In addition to more readable logs, you can tail and grep specific parts of your application. example:
 
@@ -20,9 +24,11 @@ Install
 
 Add to your Gemfile in Rails:
 
-    group :development, :test do
-      gem 'itslog'
-    end
+``` ruby
+group :development, :test do
+  gem 'itslog'
+end
+```
 
 Configure
 -----------
@@ -31,14 +37,17 @@ Itslog does not need to be configured unless you want to customize the output st
 
 Example:
 
-    Itslog.configure do |config|
-      config.namespace_colors = {
-        'action_controller' => "\e[32m",
-        'active_record'     => "\e[94m",
-        'action_view'       => "\e[36m"
-      }
-      config.format = "Its log log log || %t [ %n ] %m \n by blamo"
-    end
+``` ruby
+Itslog.configure do |config|
+    config.namespace_colors = {
+      'action_controller' => "\e[32m",
+      'active_record'     => "\e[94m",
+      'mongo'             => "\e[94m",
+      'action_view'       => "\e[36m"
+    }
+    config.format = "%t [%n]: %m"
+end
+```
 
 Configure format by building a string anyway you'd like and using the following variables:
 
@@ -48,11 +57,13 @@ Configure format by building a string anyway you'd like and using the following
 
 I don't recommend coloring by severity because it's not very useful. To color by severity instead of the default of namespace:
 
-    Itslog.configure do |config|
-      config.color_by :severity
-      config.severity_colors = ["\e[36m","\e[32m","\e[33m","\e[31m","\e[31m","\e[37m"]
-                                 # debug, info, warning, error, fatal, unknown
-    end
+``` ruby
+Itslog.configure do |config|
+  config.color_by :severity
+  # debug, info, warning, error, fatal, unknown
+  config.severity_colors = ["\e[36m","\e[32m","\e[33m","\e[31m","\e[31m","\e[37m"]
+end
+```
 
 Place the configuration in an initializer:
 

data/Rakefile

@@ -1,2 +1,11 @@
 require 'bundler'
+require 'rake/testtask'
 Bundler::GemHelper.install_tasks
+
+task :default => :test
+Rake::TestTask.new do |t|
+  t.libs << 'lib'
+  t.ruby_opts << '-rubygems'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end

data/lib/itslog/configure.rb

@@ -8,13 +8,14 @@ module Itslog
     end
 
     def format
-      @format ||= '%t %n %m'
+      @format ||= '%t %n_%m'
     end
 
     def namespace_colors
       @namespace_colors ||= {
         'action_controller' => "\e[32m",
         'active_record'     => "\e[94m",
+        'mongo'             => "\e[94m",
         'action_view'       => "\e[36m"}
     end
 
@@ -35,5 +36,19 @@ module Itslog
     def configure
       yield self
     end
+
+    def reset
+      configure do |config|
+        config.color_by = :namespace
+        config.format   = '%t %n_%m'
+        config.namespace_colors = {
+          'action_controller' => "\e[32m",
+          'active_record'     => "\e[94m",
+          'mongo'             => "\e[94m",
+          'action_view'       => "\e[36m"}
+        config.severity_colors = [
+          "\e[36m","\e[32m","\e[33m","\e[31m","\e[31m","\e[37m"]
+      end
+    end
   end
 end

data/lib/itslog/extension.rb

@@ -9,17 +9,24 @@ module Itslog
     end
 
     def add_with_format(severity, message = nil, progname = nil, &block)
-      return if @level > severity
+      return if @level > severity || message.nil?
 
       time    = Time.now.to_s(:db).split.last
       message = "\e[37m" + message.to_s.strip
-      msg     = ''
+      msg     = namespace.present? ? '' : "\n"
       msg     << Itslog::Configure.color(namespace, severity)
       msg     << Itslog::Configure.format.dup
-      {'%t' => time, '%n' => namespace, '%m' => message}.each do |k,v|
-        msg.gsub! k, v if v.present?
+
+      { '%t'  => time,
+        '%n_' => namespace.present? ? namespace + ' ' : namespace,
+        '%n'  => namespace,
+        '%m'  => message
+      }.each do |k,v|
+        msg.gsub! k,v
       end
 
+      @namespace = ''
+
       add_without_format severity, msg, progname, &block
     end
 
@@ -44,3 +51,18 @@ module Itslog
     end
   end
 end
+
+if defined? Mongoid::Logger
+  class Mongoid::Logger
+    delegate :namespace=, :to => :logger, :allow_nil => true
+  end
+
+  class Mongo::Connection
+    def log_operation_with_namespace(name, payload)
+      @logger.namespace = 'mongo' if @logger
+      log_operation_without_namespace(name, payload)
+    end
+
+    alias_method_chain :log_operation, :namespace
+  end
+end

data/lib/itslog/railtie.rb

@@ -1,7 +1,15 @@
-class Railtie < Rails::Railtie
-  config.before_initialize do
-    ActiveSupport::BufferedLogger.send(:include, Itslog::BufferedLoggerExtension)
-    ActiveSupport::LogSubscriber.send(:include, Itslog::LogSubscriberExtension)
-    ActiveSupport::LogSubscriber.colorize_logging = false
+module Itslog
+  class Railtie < Rails::Railtie
+    config.before_initialize do
+      Itslog::Railtie.insert
+      ActiveSupport::LogSubscriber.colorize_logging = false
+    end
+  end
+
+  class Railtie
+    def self.insert
+      ActiveSupport::BufferedLogger.send(:include, Itslog::BufferedLoggerExtension)
+      ActiveSupport::LogSubscriber.send(:include, Itslog::LogSubscriberExtension)
+    end
   end
 end

data/lib/itslog/version.rb

@@ -1,3 +1,3 @@
 module Itslog
-  VERSION = '0.3.2'
+  VERSION = '0.5.0'
 end

data/test/fixtures/article.rb

@@ -0,0 +1,3 @@
+class Article < ActiveRecord::Base
+  validates_presence_of :name
+end

data/test/fixtures/log.txt

@@ -0,0 +1,2 @@
+
+01:01:01 test

data/test/fixtures/schema.rb

@@ -0,0 +1,6 @@
+ActiveRecord::Schema.define do
+  self.verbose = false
+  create_table :articles, :force => true do |t|
+    t.string :name
+  end
+end

data/test/helper.rb

@@ -0,0 +1,28 @@
+require 'active_record'
+require 'active_support'
+require 'test/unit'
+require 'timecop'
+require 'redgreen'
+require 'itslog'
+
+ActiveRecord::Base.establish_connection \
+  :adapter => 'sqlite3',
+  :database => File.dirname(__FILE__) + '/fixtures/itslog.sqlite3'
+load File.dirname(__FILE__) + '/fixtures/schema.rb'
+load File.dirname(__FILE__) + '/fixtures/article.rb'
+
+Itslog::Railtie.insert
+
+def assert_log(log, msg, severity=0, namespace=nil)
+  level = [:debug, :info, :warn, :error, :fatal, :unknown]
+  Timecop.freeze(Time.parse('01:01:01'))
+  file_name    = File.dirname(__FILE__) + '/fixtures/log.txt'
+  File.delete(file_name)
+  Rails.logger = ActiveSupport::BufferedLogger.new(file_name)
+  Rails.logger.namespace = namespace if namespace.present?
+  Rails.logger.send(level[severity], msg)
+  assert_equal log, File.read(file_name)
+  Timecop.return
+end
+
+class Test::Unit::TestCase; end

data/test/itslog_test.rb

@@ -0,0 +1,60 @@
+$LOAD_PATH.unshift File.dirname(__FILE__)
+require 'helper'
+
+class ItslogTest < Test::Unit::TestCase
+
+  def test_default_severity_color
+    Itslog::Configure.reset
+    assert_log "\n\e[37m01:01:01 \e[37mtest\n", 'test', 0
+    assert_log "\n\e[37m01:01:01 \e[37mtest\n", 'test', 1
+    assert_log "\n\e[33m01:01:01 \e[37mtest\n", 'test', 2
+    assert_log "\n\e[31m01:01:01 \e[37mtest\n", 'test', 3
+    assert_log "\n\e[31m01:01:01 \e[37mtest\n", 'test', 4
+    assert_log "\n\e[37m01:01:01 \e[37mtest\n", 'test', 5
+  end
+
+  def test_custom_severity_color
+    Itslog::Configure.reset
+    Itslog.configure do |config|
+      config.severity_colors = ['red', 'orange', 'yellow', 'green', 'blue', 'indigo']
+      config.color_by = :severity
+    end
+    assert_log "\nred01:01:01 \e[37mtest\n"   , 'test', 0
+    assert_log "\norange01:01:01 \e[37mtest\n", 'test', 1
+    assert_log "\nyellow01:01:01 \e[37mtest\n", 'test', 2
+    assert_log "\ngreen01:01:01 \e[37mtest\n" , 'test', 3
+    assert_log "\nblue01:01:01 \e[37mtest\n"  , 'test', 4
+    assert_log "\nindigo01:01:01 \e[37mtest\n", 'test', 5
+  end
+
+  def test_default_namespaces
+    Itslog::Configure.reset
+    assert_log "\e[32m01:01:01 action_controller \e[37mtest\n", 'test', 0, 'action_controller'
+    assert_log "\e[36m01:01:01 action_view \e[37mtest\n"      , 'test', 0, 'action_view'
+    assert_log "\e[94m01:01:01 active_record \e[37mtest\n"    , 'test', 0, 'active_record'
+    assert_log "\e[94m01:01:01 mongo \e[37mtest\n"            , 'test', 0, 'mongo'
+  end
+
+  def test_custom_namespace_color
+    Itslog::Configure.reset
+    Itslog.configure do |config|
+      config.format = '%n %m'
+      config.namespace_colors = {
+        'action_controller' => 'red',
+        'action_view'       => 'orange',
+        'active_record'     => 'yellow',
+        'mongo'             => 'green'}
+    end
+    assert_log "redaction_controller \e[37mtest\n", 'test', 0, 'action_controller'
+    assert_log "orangeaction_view \e[37mtest\n"   , 'test', 0, 'action_view'
+    assert_log "yellowactive_record \e[37mtest\n" , 'test', 0, 'active_record'
+    assert_log "greenmongo \e[37mtest\n"          , 'test', 0, 'mongo'
+  end
+
+  def test_custom_format
+    Itslog::Configure.reset
+    Itslog.configure { |config| config.format = '[%n] %m' }
+    assert_log "\n\e[37m[] \e[37mtest\n", 'test', 0
+    assert_log "\e[32m[action_controller] \e[37mtest\n", 'test', 0, 'action_controller'
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: itslog
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 11
   prerelease: false
   segments: 
   - 0
-  - 3
-  - 2
-  version: 0.3.2
+  - 5
+  - 0
+  version: 0.5.0
 platform: ruby
 authors: 
 - John Thomas Marino
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-24 00:00:00 -04:00
+date: 2011-06-28 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -36,6 +36,12 @@ files:
 - lib/itslog/railtie.rb
 - lib/itslog/version.rb
 - lib/itslog.rb
+- test/fixtures/article.rb
+- test/fixtures/itslog.sqlite3
+- test/fixtures/log.txt
+- test/fixtures/schema.rb
+- test/helper.rb
+- test/itslog_test.rb
 has_rdoc: true
 homepage: http://github.com/johmas/itslog
 licenses: []