format_logs 0.1.0

data/.document

@@ -0,0 +1,4 @@
+lib/**/*.rb
+README.rdoc
+ChangeLog.rdoc
+LICENSE.txt

data/.loadpath

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<loadpath>
+	<pathentry path="" type="src"/>
+	<pathentry path="org.rubypeople.rdt.launching.RUBY_CONTAINER" type="con"/>
+</loadpath>

data/.project

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+	<name>format_logs</name>
+	<comment></comment>
+	<projects>
+	</projects>
+	<buildSpec>
+		<buildCommand>
+			<name>org.rubypeople.rdt.core.rubybuilder</name>
+			<arguments>
+			</arguments>
+		</buildCommand>
+	</buildSpec>
+	<natures>
+		<nature>org.rubypeople.rdt.core.rubynature</nature>
+	</natures>
+</projectDescription>

data/.rspec

@@ -0,0 +1 @@
+--colour --format documentation

data/ChangeLog.rdoc

@@ -0,0 +1,4 @@
+=== 0.1.0 / 2011-06-01
+
+* Initial release:
+

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Erik Gustavson
+
+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,51 @@
+= format_logs - basic log formatting
+
+* {Homepage}[http://github.com/goosetav/format_logs]
+* {Documentation}[http://rubydoc.info/gems/format_logs/frames]
+
+== Description
+
+Adds some simple formatting to the standard Rails BufferedLogger class.
+
+This solution aims to be something between the default logging which is missing information such as
+timestamps, process IDs and severity levels and a full logging solution like {log4r}[http://log4r.rubyforge.org/]
+
+Gem inspired by Paul Dowman's {better_logging}[https://github.com/pauldowman/better_logging]
+
+== Features
+
+Configurable settings - accepts a hash of options to adjust the output format.
+
+== Examples
+
+These are the defaults
+
+  FormatLogs.settings = {
+    :time_format => '%Y-%m-%d %H:%M:%S %z',
+    :show_pid => true,
+    :show_host => true,
+    :show_time => true
+  }
+
+you can pass any combination of options you want:
+  FormatLogs.setting = {:show_pid => false}
+
+== Requirements
+
+  Rails 3.0+
+
+== Install
+
+add:
+
+  gem require 'format_logs'
+  
+to your Gemfile and then run:
+
+  bundle update format_logs  
+
+== Copyright
+
+Copyright (c) 2011 Erik Gustavson
+
+See LICENSE.txt for details.

data/Rakefile

@@ -0,0 +1,32 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  gem 'ore-tasks', '~> 0.4'
+  require 'ore/tasks'
+
+  Ore::Tasks.new
+rescue LoadError => e
+  STDERR.puts e.message
+  STDERR.puts "Run `gem install ore-tasks` to install 'ore/tasks'."
+end
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  rdoc.title = "format_logs"
+end
+task :doc => :rdoc
+
+begin
+  gem 'rspec', '~> 2.4'
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new
+rescue LoadError => e
+  task :spec do
+    abort "Please run `gem install rspec` to install RSpec."
+  end
+end
+
+task :test => :spec
+task :default => :spec

data/format_logs.gemspec

@@ -0,0 +1,15 @@
+# -*- encoding: utf-8 -*-
+
+begin
+  Ore::Specification.new do |gemspec|
+    # custom logic here
+  end
+rescue NameError
+  begin
+    require 'ore/specification'
+    retry
+  rescue LoadError
+    STDERR.puts "The '#{__FILE__}' file requires Ore."
+    STDERR.puts "Run `gem install ore-core` to install Ore."
+  end
+end

data/gemspec.yml

@@ -0,0 +1,33 @@
+name: format_logs
+version: 0.1.0
+summary: "Adds some basic formatting to the default rails logs"
+description: |
+  Adds some simple formatting to the standard Rails BufferedLogger class.
+
+  This solution aims to be something between the default logging which is missing information such as
+  timestamps, process IDs and severity levels and a full logging solution like log4r
+
+license: MIT
+authors: goosetav
+homepage: http://github.com/goosetav/format_logs
+post_install_message: |
+  *********************************************
+  
+  Add the following to your Gemfile to activate
+  
+    gem "format_logs"
+  
+  Configuration options can be set by:
+  
+  FormatLogs.settings = {...}
+  
+  see README.rdoc for more details
+  
+  *********************************************
+
+dependencies:
+  rails: >= 3.0
+
+development_dependencies:
+  ore-tasks: ~> 0.4
+  rspec: ~> 2.4

data/lib/format_logs/version.rb

@@ -0,0 +1,4 @@
+module FormatLogs
+  # format_logs version
+  VERSION = "0.1.0"
+end

data/lib/format_logs.rb

@@ -0,0 +1,136 @@
+require 'format_logs/version'
+
+module FormatLogs
+  
+  def self.included(base)
+    puts "Adding formatting to #{base.name}"
+    base.send :extend, ClassMethods
+    
+    base.send :include, InstanceMethods
+    base.alias_method_chain :add, :formatting # if base.respond_to? :add
+  end
+  
+  module ClassMethods
+    
+    def settings
+      @settings ||= default_settings
+    end
+    
+    def settings=(new_settings)
+      @settings = default_settings + new_settings
+      flush_attributes!
+    end
+    
+    def flush_cached_settings!
+      [@time_format, @show_time, @show_pid, @show_host, @trim_leading_whitespace].each {|a| a = nil}
+    end
+    
+    def default_settings
+      {
+        :time_format => '%Y-%m-%d %H:%M:%S %z',
+        :show_pid => true,
+        :show_host => true,
+        :show_time => true,
+        :trim_leading_whitespace => true
+      }
+    end
+    
+    def time_format
+      @time_format ||= settings[:time_format]
+    end
+    
+    def show_time?
+      @show_time ||= settings[:show_time]
+    end
+    
+    def use_color?
+      @use_color ||= (Rails.configuration.colorize_logging != false)
+    end
+    
+    def show_pid?
+      @show_pid ||= settings[:show_pid]
+    end
+
+    def trim_leading_whitespace?
+      @trim_leading_whitespace ||= settings[:trim_leading_whitespace]
+    end
+    
+    def show_host?
+      @show_host ||= settings[:show_host]
+    end
+    
+    def timestamp
+      "#{Time.now.utc.strftime(time_format)} - " if show_time?
+    end
+    
+    def pid
+      "#{$$} - " if show_pid?
+    end
+    
+    def hostname
+      @hostname ||= "#{`hostname -s`.strip rescue ''} - " if show_host?
+    end
+    
+    def to_color(severity)
+      return case severity
+        when ActiveSupport::BufferedLogger::INFO  then info_s
+        when ActiveSupport::BufferedLogger::WARN  then warn_s
+        when ActiveSupport::BufferedLogger::ERROR then error_s
+        when ActiveSupport::BufferedLogger::FATAL then fatal_s
+        when ActiveSupport::BufferedLogger::DEBUG then debug_s
+      else unknown_s
+      end
+    end
+    
+    def debug_s
+      "DEBUG "
+    end
+    
+    def unknown_S
+      "UNKNOWN"
+    end
+    
+    def info_s
+      @info_s ||= color("INFO  ", '32m')
+    end
+    
+    def warn_s
+      @warn_s ||= color("WARN  ", '33m')
+    end
+    
+    def error_s
+      @error_s ||= color("ERROR ", '31m')
+    end
+    
+    def fatal_s
+      @fatal_s ||= color("FATAL ", '1;30;41m')
+    end
+    
+    def color(s, color)
+      use_color? ? "\033[#{color}#{s}\033[0m" : s
+    end
+    
+  end
+  
+  module InstanceMethods
+    
+    def add_with_formatting(severity, message = nil, progname = nill, &block)
+      return if @level > severity
+      message = format(severity, (message || (block && block.call) || progname).to_s)
+      add_without_formatting(severity, message, progname)
+    end
+    
+    def format(severity, message)
+      "#{self.class.pid}#{self.class.hostname}#{self.class.timestamp}#{self.class.to_color(severity)} - #{trim_leading_whitespace(message)}"
+    end
+
+    def trim_leading_whitespace(m)
+      self.class.trim_leading_whitespace? ? m.gsub(/^\s*/,'') : m
+    end
+   
+  end
+  
+
+end
+
+ActiveSupport::BufferedLogger.send :include, FormatLogs

data/spec/format_logs_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+require 'format_logs'
+
+describe FormatLogs do
+  it "should have a VERSION constant" do
+    subject.const_get('VERSION').should_not be_empty
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+gem 'rspec', '~> 2.4'
+require 'rspec'
+require 'format_logs/version'
+
+include FormatLogs

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification 
+name: format_logs
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- goosetav
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-03 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: ore-tasks
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        - 4
+        version: "0.4"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 2
+        - 4
+        version: "2.4"
+  type: :development
+  version_requirements: *id003
+description: |
+  Adds some simple formatting to the standard Rails BufferedLogger class.
+  
+  This solution aims to be something between the default logging which is missing information such as
+  timestamps, process IDs and severity levels and a full logging solution like log4r
+
+email: []
+
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- spec/spec_helper.rb
+- gemspec.yml
+- ChangeLog.rdoc
+- .rspec
+- lib/format_logs/version.rb
+- .loadpath
+- .project
+- Rakefile
+- LICENSE.txt
+- README.rdoc
+- spec/format_logs_spec.rb
+- .document
+- lib/format_logs.rb
+- format_logs.gemspec
+homepage: http://github.com/goosetav/format_logs
+licenses: 
+- MIT
+post_install_message: |
+  *********************************************
+  
+  Add the following to your Gemfile to activate
+  
+    gem "format_logs"
+  
+  Configuration options can be set by:
+  
+  FormatLogs.settings = {...}
+  
+  see README.rdoc for more details
+  
+  *********************************************
+
+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: format_logs
+rubygems_version: 1.8.5
+signing_key: 
+specification_version: 3
+summary: Adds some basic formatting to the default rails logs
+test_files: 
+- spec/format_logs_spec.rb