little_log_friend 0.2.0

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+
+# RubyMine
+.idea

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in test.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2009 - 2011 Rudolf Schmidt
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,77 @@
+= LittleLogFriend
+
+LittleLogFriend sets your standard logger to a more readable format, like so:
+
+logger = Logger.new STDOUT
+logger.info 'hello world'
+# => 2009-01-14 10:10:10 [ INFO] 15356 : hello world
+
+The format is: DATE TIME [ LOG LEVEL ] PID : MESSAGE
+
+
+== Installation
+=== The Gem Version
+
+  gem install little_log_friend
+
+Or in your Gemfile:
+
+  gem 'little_log_friend'
+
+You should create an initializer file in order to get LittleLogFriend to work for you, like so:
+  # config/initializers/little_log_friend.rb (create it if not present)
+  require 'little_log_friend
+
+
+=== The Plugin Version
+
+  script/plugin install git://github.com/rudionrails/little_log_friend.git
+
+You don't need to specifically require little_log_friend, the init.rb of the plugin will take care of it.
+
+  
+== Usage
+
+LittleLogFriend will automatically enhance your standard logger with a nicer 
+log formatting - nothing more. Instead of the regular format, you will see 
+every log message starting with a nice timestamp and a better formatted message 
+altogether. This will help you to trace your logs much easier in case something 
+goes happens. Moreover, if you are using monitoring tools to 
+detect errors in you logs so that they send out notifications to your sysadmin, 
+a unified logging format will significantly ease this process.
+
+Additionally to that, you can add this to your environment.rb: 
+
+LittleLogFriend.colorize!
+
+This will enable colorized log output (under Unix). Every log level will appear
+in a different color to ease log interpretation. Here are the colors for each
+severity:
+
+debug => green
+info  => white
+warn  => yello
+error => red
+fatal => purple
+unknown => white
+default => default of the console / none
+
+
+Also, you can override the default color settings, like so: 
+
+LittleLogFriend.colorize!( :info => "\033[01;36m" ) # cyan for Unix
+
+Specify the keys as explained above for the default severity colors.
+
+
+== Additional Notes
+
+LittleLogFriend is not meant to be a fully featured log solution, but it's
+supposed to help in the smaller scale and especially when developing.
+
+Also, you probably don't want to use colorized logging in production mode, as it
+will be very difficult to read the log file on a remote server with all the color
+information in it.
+
+
+Copyright (c) 2009 - 2011 Rudolf Schmidt, released under the MIT license

data/Rakefile

@@ -0,0 +1,26 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the little_log_friend plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the little_log_friend plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'LittleLogFriend'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/init.rb

@@ -0,0 +1 @@
+require 'little_log_friend'

data/lib/little_log_friend/formatter.rb

@@ -0,0 +1,42 @@
+module LittleLogFriend
+
+  class Formatter < Logger::Formatter
+
+    @@colorize = false
+
+    Format = "%s [%5s] %d %s: %s"
+
+    @@colors = {
+      'DEBUG'   => "\e[1;32;1m", # green
+      'INFO'    => "\e[0;1m",    # white
+      'WARN'    => "\e[1;33;1m", # yello
+      'ERROR'   => "\e[1;31;1m", # red
+      'FATAL'   => "\e[1;35;1m", # punk, yes PUNK!
+      'UNKNOWN' => "\e[0;1m",    # white
+      'DEFAULT' => "\e[0m"       # NONE
+    }
+
+    def initialize
+      super
+      @datetime_format = "%Y-%m-%d %H:%M:%S"
+    end
+
+    def self.colorize!( options = {} )
+      @@colorize = true
+      options.each { |key, value| @@colors[key.to_s.upcase] = value }
+    end
+
+    # This method is invoked when a log event occurs
+    def call ( severity, time, progname, msg )
+      msg = Format % [format_datetime(time), severity, $$, progname, msg2str(msg)]
+      msg = @@colors[severity] + msg + @@colors['DEFAULT'] if @@colorize
+      msg << "\n"
+    end
+
+    def number_to_severity ( n )
+      severities = [:debug, :info, :warn, :error, :fatal, :unknown]
+      severities[n]
+    end
+  end
+
+end

data/lib/little_log_friend/version.rb

@@ -0,0 +1,5 @@
+module LittleLogFriend
+
+  VERSION = "0.2.0"
+
+end

data/lib/little_log_friend.rb

@@ -0,0 +1,61 @@
+require 'logger'
+
+module LittleLogFriend
+
+  autoload :Formatter, File.dirname(__FILE__) + '/little_log_friend/formatter'
+
+  
+  def self.colorize!( *args )
+    Formatter.colorize!( *args )
+  end
+  
+end
+
+# Overload the default logger class 
+class Logger  
+  
+  alias :old_formatter :formatter if method_defined?(:formatter)
+  
+  def formatter
+    @formatter ||= LittleLogFriend::Formatter.new
+  end
+  
+  
+  private
+
+  alias :old_format_message :format_message if method_defined?(:format_message)
+
+  def format_message(severity, datetime, progname, msg)
+    (formatter || @default_formatter).call(severity, datetime, progname, msg)
+  end
+  
+end
+
+# Overload the BufferedLogger in Rails
+module ActiveSupport
+  class BufferedLogger    
+    
+    alias :old_formatter :formatter if method_defined?(:formatter)
+    
+    def formatter
+      @formatter ||= LittleLogFriend::Formatter.new
+    end
+    
+    
+    alias :old_add :add if method_defined?(:add)
+    
+    # We need to overload the add method. Basibally it is the same as the 
+    # original one, but we add our own log format to it.
+    def add(severity, message = nil, progname = nil, &block)
+      return if @level > severity
+      message = (message || (block && block.call) || progname).to_s
+      message = formatter.call(formatter.number_to_severity(severity), Time.now.utc, progname, message)
+      message = "#{message}\n" unless message[-1] == ?\n
+      buffer << message
+      auto_flush
+      message
+    end
+    
+  end
+end
+

data/little_log_friend.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "little_log_friend/version"
+
+Gem::Specification.new do |s|
+  s.name        = "little_log_friend"
+  s.version     = LittleLogFriend::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Rudolf Schmidt"]
+  
+  s.homepage    = "http://github.com/rudionrails/little_log_friend"
+  
+  s.summary     = %q{An easy way to set your Ruby standard logger to a more readable format}
+  s.description = %q{LittleLogFriend sets your standard logger to the format: "DATE TIME [ LEVEL ] PID : MESSAGE"}
+
+  s.rubyforge_project = "little_log_friend"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  
+  s.add_development_dependency "rake"
+  s.add_development_dependency "activesupport", "~> 2.x"
+end

data/test/little_log_friend_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class LittleLogFriendTest < ActiveSupport::TestCase
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'active_support'
+require 'active_support/test_case'

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification 
+name: little_log_friend
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- Rudolf Schmidt
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-23 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 121
+        segments: 
+        - 2
+        - x
+        version: 2.x
+  type: :development
+  version_requirements: *id002
+description: "LittleLogFriend sets your standard logger to the format: \"DATE TIME [ LEVEL ] PID : MESSAGE\""
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- init.rb
+- lib/little_log_friend.rb
+- lib/little_log_friend/formatter.rb
+- lib/little_log_friend/version.rb
+- little_log_friend.gemspec
+- test/little_log_friend_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/rudionrails/little_log_friend
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: little_log_friend
+rubygems_version: 1.5.0
+signing_key: 
+specification_version: 3
+summary: An easy way to set your Ruby standard logger to a more readable format
+test_files: []
+