Initial release

Author: pboling

.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

Gemfile

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

LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Peter Boling
+
+MIT License
+
+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.

README.md

@@ -0,0 +1,33 @@
+# HumorousLogFormatter
+
+You want Humorous Log Levels and Color (in Rails development)?  Can chickens turtle all the way down?  Of course!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'humorous_log_formatter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install humorous_log_formatter
+
+## Usage
+
+* Use the source.
+* There are a bunch of CONSTANTS defined in the code, and everything this gem does is driven by them.
+* Override them for magic.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/humorous_log_formatter/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

humorous_log_formatter.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+require File.expand_path('../lib/humorous_log_formatter/version', __FILE__)
+
+Gem::Specification.new do |spec|
+  spec.name          = "humorous_log_formatter"
+  spec.version       = HumorousLogFormatter::VERSION
+  spec.authors       = ["Peter Boling"]
+  spec.email         = ["peter.boling@gmail.com"]
+  spec.summary       = %q{Humorous Log Levels and Color For Rails.}
+  spec.description   = %q{Humorous Log Levels and Color For Rails.  Customizable!}
+  spec.homepage      = "https://github.com/pboling/humorous_log_formatter"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  # Development Dependencies
+  spec.add_development_dependency(%q<rails>, ["> 3"])
+  spec.add_development_dependency(%q<activesupport>, ["> 3"])
+
+end

lib/humorous_log_formatter.rb

@@ -0,0 +1,79 @@
+# Copyright (c) 2014 Peter H. Boling of 9thBit LLC
+# Released under the MIT license
+# For Rails 3+
+# Patterned after this LogFormatter:
+#   https://github.com/QutBioacousticsResearchGroup/bioacoustic-workbench/blob/master/config/initializers/log_formatting.rb
+# And some of this:
+#   http://95.154.230.254/ip-1/encoded/Oi8vcGFzdGViaW4uY29tL1hxRU1keGRT
+# Makes as much as possible constant values to not bog down GC and make it whip fast
+require "humorous_log_formatter/version"
+
+module HumorousLogFormatter
+  class LogFormatter
+    # TODO: For Rails 4, uncomment the line below
+    #include ActiveSupport::TaggedLogging::Formatter
+    SEVERITY_TO_TAG_MAP = {'DEBUG' => 'meh', 'INFO' => 'fyi', 'WARN' => 'hmm', 'ERROR' => 'wtf', 'FATAL' => 'omg', 'UNKNOWN' => '???'}
+    SEVERITY_TO_COLOR_MAP = {'DEBUG' => '0;37', 'INFO' => '32', 'WARN' => '33', 'ERROR' => '31', 'FATAL' => '31', 'UNKNOWN' => '37'}
+    USE_HUMOROUS_SEVERITIES = begin
+      if ENV['LOG_HUMOR']
+        ENV['LOG_HUMOR'] != 'false' # Default to true
+      else
+        Rails.env.development?
+      end
+    end
+    USE_COLOR = begin
+      if ENV['LOG_COLOR']
+        ENV['LOG_COLOR'] != 'false' # Default to true
+      else
+        Rails.env.development?
+      end
+    end
+
+    THIS_FILE_PATH = File.expand_path(".")
+
+    FORMATTED_SEVERITY = USE_HUMOROUS_SEVERITIES ?
+        lambda { |severity| sprintf("%-3s", "#{SEVERITY_TO_TAG_MAP[severity]}") } :
+        lambda { |severity| sprintf("%-5s", "#{severity}") }
+
+    FORMATTED_MESSAGE = if USE_COLOR
+                          lambda { |severity, formatted_time, msg|
+                            color = SEVERITY_TO_COLOR_MAP[severity]
+                            "[\033[#{color}m#{formatted_time}\033[0m] [\033[#{color}m#{FORMATTED_SEVERITY.call(severity)}\033[0m] #{msg.strip}\n"
+                          }
+                        else
+                          lambda { |severity, formatted_time, msg|
+                            "[#{formatted_time}] [#{FORMATTED_SEVERITY.call(severity)}] #{msg.strip}\n"
+                          }
+                        end
+
+    def exception_values(e)
+      trace = e.backtrace.select { |x| !line.starts_with?(THIS_FILE_PATH) }
+      trace = trace.map { |l| colorize_exception(l) } if USE_COLOR
+      first = "\n" + trace.first + ": " + e.message + " (#{e.class})"
+      rest = "\t" + trace[1..-1].join("\n\t")
+      return first + "\n" + rest
+    end
+
+    def colorize_exception(line)
+      "\033[01;32m#{line}\033[0m"
+    end
+
+    def call(severity, time, progname, msg)
+      formatted_time = time.strftime("%Y-%m-%d %H:%M:%S.") << time.usec.to_s[0..2].rjust(3)
+      text = if msg.is_a? String
+               msg
+             elsif msg.is_a? Exception
+               " --> Exception: " + exception_values(msg)
+             else
+               "!!!!! UNKNOWN TYPE: #{msg.class}" + msg.to_s
+             end
+      FORMATTED_MESSAGE.call(severity, formatted_time, text)
+    end
+
+    require "humorous_log_formatter/railtie"
+
+  end
+end
+
+
+

lib/humorous_log_formatter/ext/active_support_buffered_logger.rb

@@ -0,0 +1,11 @@
+# Copyright (c) 2014 Peter H. Boling of 9thBit LLC
+# Released under the MIT license
+# For Rails 3+
+class ActiveSupport::BufferedLogger
+  # At some point after Rails 3 ActiveSupport::BufferedLogger began inheriting from Logger rather than Object.
+  unless method_defined? :formatter=
+    def formatter=(formatter)
+      @log.formatter = formatter
+    end
+  end
+end

lib/humorous_log_formatter/railtie.rb

@@ -0,0 +1,14 @@
+# Copyright (c) 2014 Peter H. Boling of 9thBit LLC
+# Released under the MIT license
+# For Rails 3+
+module HumorousLogFormatter
+  class Railtie < ::Rails::Railtie
+
+    require 'humorous_log_formatter/ext/active_support_buffered_logger'
+
+    config.after_initialize do
+      Rails.logger.formatter = HumorousLogFormatter::LogFormatter.new
+    end
+
+  end
+end

lib/humorous_log_formatter/version.rb

@@ -0,0 +1,3 @@
+module HumorousLogFormatter
+  VERSION = "0.0.1"
+end