humorous_log_formatter 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 75017446ad553bc703ef510dc89d9253513c1d58
-  data.tar.gz: 6125691606998008ccac484f28a95b2a4c972dd8
+  metadata.gz: a61d81a7088603de9ecc0371591a2e1420b29b03
+  data.tar.gz: 4d137e11ddc5aabe10e4ac3ef28f47715aa75dbb
 SHA512:
-  metadata.gz: 904b862ab91785b7b70298ea848a5c8670e4e0db4b8526a376a4d4cdd53015de7a4a75697a68fd29eddadf80e56975a29427dc8d53d6cebf0470b168e5b641d3
-  data.tar.gz: 7a6a79620121411e6aada2624978994b6b6b3db4d441d57654ab20addfdaaed7430ca98177f4dc7acbf15867b04142cc82390d06dbfe88545627c1d62439b1b2
+  metadata.gz: 953f58cb2aeee4e482dcfe17bae9ca7798277d4e21e7c90011f2953a58b64d48b0ede82181cbaab085e1f26690b2be534da8cae21b47bb9d76c0255b2b159580
+  data.tar.gz: e5bce548d857cd8b765c06645d6b979cf153af9131dc4450ecd5da6b07ad7e68902eb2b120fef32b3d757c84d735b1ac783c02e892cb383e98426224d419fd0c

data/README.md

@@ -1,13 +1,17 @@
 # HumorousLogFormatter
 
-You want Humorous Log Levels and Color (in Rails development)?  Can chickens turtle all the way down?  Of course!
+You want Humorous Log Levels and Color?  Can chickens turtle all the way down?  Of course!
+
+Works with Rails 3 & 4!
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this line to your application's Gemfile in the `:development` group, or wherever else you want awesome logs:
 
 ```ruby
-gem 'humorous_log_formatter'
+group :development do
+  gem 'humorous_log_formatter'
+end
 ```
 
 And then execute:
@@ -20,6 +24,9 @@ Or install it yourself as:
 
 ## Usage
 
+* There is ZERO configuration.  It makes some assumptions.
+* Putting the gem in your Gemfile and restart your app.
+* Now you have beautiful logs.
 * 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.

data/lib/humorous_log_formatter.rb

@@ -10,10 +10,21 @@ require "humorous_log_formatter/version"
 
 module HumorousLogFormatter
   class LogFormatter
-    # TODO: For Rails 4, uncomment the line below
-    #include ActiveSupport::TaggedLogging::Formatter
+
+    # Make it work with Rails 4
+    if defined?(Rails)
+      if ::Rails::VERSION::MAJOR >= 4
+        include ActiveSupport::TaggedLogging::Formatter
+      end
+    end
+
     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'}
+    TIME_FORMAT = "%Y-%m-%d %H:%M:%S."
+    SKIP_TIME = !Rails.env.development? # because heroku already prints the time, override if you use in prod and aren't on Heroku
+    SUPER_TIME_PRECISION = 3
+    SUPER_TIME_PRECISION_STOP_INDEX = SUPER_TIME_PRECISION - 1
+    USE_SUPER_TIME = SUPER_TIME_PRECISION > 0
     USE_HUMOROUS_SEVERITIES = begin
       if ENV['LOG_HUMOR']
         ENV['LOG_HUMOR'] != 'false' # Default to true
@@ -38,20 +49,24 @@ module HumorousLogFormatter
     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"
+                            res = ''
+                            res << "[\033[#{color}m#{formatted_time}\033[0m] " if formatted_time
+                            res << "[\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"
+                            res = ''
+                            res << "[#{formatted_time}]" if formatted_time
+                            res << "[#{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
+      first = "\n#{trace.first}: #{e.message} (#{e.class})"
+      rest = "\t#{trace[1..-1].join("\n\t")}"
+      "#{first}\n#{rest}"
     end
 
     def colorize_exception(line)
@@ -59,13 +74,18 @@ module HumorousLogFormatter
     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)
+      if SKIP_TIME
+        formatted_time = nil
+      else
+        formatted_time = time.strftime(TIME_FORMAT)
+        formatted_time << time.usec.to_s[0..(SUPER_TIME_PRECISION_STOP_INDEX)].rjust(SUPER_TIME_PRECISION) if USE_SUPER_TIME
+      end
       text = if msg.is_a? String
                msg
              elsif msg.is_a? Exception
-               " --> Exception: " + exception_values(msg)
+               "  --> Exception:#{exception_values(msg)}"
              else
-               "!!!!! UNKNOWN TYPE: #{msg.class}" + msg.to_s
+               "!!!!! UNKNOWN TYPE: #{msg.class} #{msg.to_s}"
              end
       FORMATTED_MESSAGE.call(severity, formatted_time, text)
     end

data/lib/humorous_log_formatter/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: humorous_log_formatter
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Peter Boling
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-16 00:00:00.000000000 Z
+date: 2014-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -103,7 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.2
 signing_key: 
 specification_version: 4
 summary: Humorous Log Levels and Color For Rails.