formatted_rails_logger 0.1.0 → 0.2.0

data/README.markdown

@@ -2,11 +2,13 @@
 
 Monkey-patches Rails BufferedLogger (the standard Rails logger) to accept a formatter just like ruby Logger does. Provides a formatter that includes timestamp and severity in logs, while taking account of Rails habit of making space in the logfile by adding newlines to the beginning of log message. 
 
-It's only 80 lines of verbose code.  I'd think a bazillion people would have done this before, but I didn't see any other gems to do it simply and flexibly, sorry for any duplication. 
+It's only 80 lines of verbose code. (yes, this readme is longer than the source) I'd think a bazillion people would have done this before, but I didn't see any other gems to do it simply and flexibly, sorry for any duplication. 
 
 ## How to use
 
-Should work for both Rails2 and Rails3. 
+Version 0.1.0 should work for both Rails2 and Rails 3.0.x - 3.1.x
+
+Version 0.2.0 for Rails 3.2.0 -- will future versions of Rails 3.2.x again change internal logger implementation to break this? Who knows! Why doesn't Rails just support #formatter for us? Who knows! At least 3.2.0 made it a lot easier to patch in, with an internal stdlib Logger at the bottom of things. 
 
 Include the formatted_rails_logger gem in your project as appropriate for your Rails version. 
 
@@ -45,9 +47,9 @@ I did use a regexp to look for newlines at the very beginning of a log message,
 
 * Why has Rails always thought it better to exclude timestamps and severity from logfiles? Me, I need to be able to grep logfiles for "ERROR" or "FATAL" or "WARN" to see how my app's doing, and I need to be able to have timestamps to correlate human observed problems to the logs. Am I really alone here? 
 
-* Why does Rails BufferedLogger not provide the same formatter functionality a usual ruby Logger, either by sub-classing Logger, or duck-typing the formatter functionality too?  
+* Why does Rails BufferedLogger not provide the same #formatter functionality as ruby Logger, either by sub-classing Logger, or duck-typing the formatter functionality too?  (But, hey, it's better than Rails <=2.2, where Rails monkey patched ruby Logger to ignore it's #formatter, huh?)
 
-* Why does ruby 1.8.7 Time.strftime not accept an %L formatting string, even though the [documentation](http://www.ruby-doc.org/core/classes/Time.html#M000392) says it should? Did they fix this in 1.9? I don't know. 
+* Why does ruby 1.8.7 Time.strftime not accept an %L formatting string, even though the [documentation](http://www.ruby-doc.org/core/classes/Time.html#M000392) says it should? Did they fix this in 1.9? I don't know. For that matter, why does ruby Time give you a method to get microseconds, but a not method to get miliseconds?
 
 ## Things I didn't do
 

data/formatted_rails_logger.gemspec

@@ -11,6 +11,8 @@ Gem::Specification.new do |s|
   s.summary     = %q{Formatting capabilities for Rails BufferedLogger}  
 
   s.rubyforge_project = "formatted_rails_logger"
+  
+  s.add_dependency "rails", "~> 3.2.0"
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/lib/formatted_rails_logger/buffered_logger_inject.rb

@@ -2,50 +2,29 @@
 # doing this rather than declaring Rails a dependency. 
 ActiveSupport::BufferedLogger.class 
 
+# Rails 3.2 BufferedLogger has an internal @logger with a stdlib rails
+# logger, but it doesn't expose ability to set a formatter. We've just
+# got to do that, no problem. 
 class ActiveSupport::BufferedLogger
   attr_accessor :formatter
   # use pure ruby class method, Rails provides ones with
   # better semantics for inheritance, but they keep changing
   # version to version, so nope. 
   class << self ; attr_accessor :default_formatter ; end
-        
-
-    
-  
-  # Have to over-ride/replace BufferedLogger's usual #add
-  # to use formatter
-  def add(severity, message = nil, progname = nil, &block)
-    return if @level > severity
-    message = (message || (block && block.call) || progname).to_s
-    
-    # our custom formatting
-    message = format_message(format_severity(severity), Time.now, progname, message)
-    
-    # If a newline is necessary then create a new message ending with a newline.
-    # Ensures that the original message is not mutated.
-    message = "#{message}\n" unless message[-1] == ?\n
-    buffer << message
-    auto_flush
-    message
+     
+  def initialize(*args)
+    super(*args)
+    @log.formatter = self.class.default_formatter if self.class.default_formatter
   end
     
-  protected
-  
-  # why does BufferedLogger not give us a way to translate from integer
-  # constant to actual severity lable? argh. copied from Logger
-  # Severity label for logging. (max 5 char)
-  SEV_LABEL = %w(DEBUG INFO WARN ERROR FATAL UNKNOWN)
-  def format_severity(severity)
-    SEV_LABEL[severity] || 'UNKNOWN'
+  def formatter=(formatter)
+    @log.formatter = formatter
   end
   
-  def format_message(severity, datetime, progname, msg)
-    if formatter = (@formatter || self.class.default_formatter)
-      formatter.call(severity, datetime, progname, msg)
-    else
-      msg
-    end
+  def formatter
+    @log.formatter
   end
+    
   
 end
 

data/lib/formatted_rails_logger/formatter.rb

@@ -7,7 +7,11 @@ class FormattedRailsLogger::Formatter
   @@format_str = "[%s] %5s  %s"
   @@datetime_format = nil 
   
-  def call(severity, time, progname, msg)        
+  def call(severity, time, progname, msg)   
+    # Rails 3.2 seems to automatically add a newline, for consistency
+    # we will too. 
+    msg += "\n"
+    
     # see no need for micro-seconds like in Logger, milis suffices. 
     # No idea why documented %L and other such useful things
     # do not work in strftime. 

data/lib/formatted_rails_logger/version.rb

@@ -1,3 +1,3 @@
 module FormattedRailsLogger
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,34 +1,34 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: formatted_rails_logger
-version: !ruby/object:Gem::Version 
-  hash: 27
+version: !ruby/object:Gem::Version
+  version: 0.2.0
   prerelease: 
-  segments: 
-  - 0
-  - 1
-  - 0
-  version: 0.1.0
 platform: ruby
-authors: 
+authors:
 - Jonathan Rochkind
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-08-04 00:00:00 -04:00
-default_executable: 
-dependencies: []
-
+date: 2012-01-25 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &244305560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *244305560
 description: 
-email: 
+email:
 - jonathan@dnil.net
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
 - README.markdown
@@ -38,39 +38,28 @@ files:
 - lib/formatted_rails_logger/buffered_logger_inject.rb
 - lib/formatted_rails_logger/formatter.rb
 - lib/formatted_rails_logger/version.rb
-has_rdoc: true
 homepage: https://github.com/jrochkind/formatted_rails_logger
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+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 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: formatted_rails_logger
-rubygems_version: 1.6.2
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Formatting capabilities for Rails BufferedLogger
 test_files: []
-