hodel_3000_compliant_logger 0.1.0

data/README.rdoc

@@ -0,0 +1,52 @@
+== Hodel 3000 Compliant Logger
+
+The Hodel 3000 Compliant Logger outputs like SyslogLogger (http://seattlerb.rubyforge.org/SyslogLogger/), except it doesn't need a syslog daemon running, such that your log come out exactly like syslog logs.
+
+Mostly, this is intended to let you use tools that assume your log are in this syslog format, including:
+
+* Rails Analyzer Tools: http://rails-analyzer.rubyforge.org/
+* oink: http://github.com/noahd1/oink
+
+See initial announcement here: http://nubyonrails.com/articles/a-hodel-3000-compliant-logger-for-the-rest-of-us
+
+=== Installation and congiguration
+
+  gem install hodel_3000_compliant_logger
+
+The main thing hodel_3000_complaint_logger provides is the Hodel3000ComplaintLogger class. It's a subclass of Logger (http://ruby-doc.org/core/classes/Logger.html), so you can use it as you would any Logger, really, except it outputs slightly different.
+
+  require 'hodel_3000_compliant_logger'
+  log = Hodel3000ComplaintLogger.new(STDOUT)
+  log.level = Logger::WARN
+
+  log.debug("Created logger")
+  log.info("Program started")
+  log.warn("Nothing to do!")
+
+Most likely, you'll want to use it to replace the builtin Rails logger, by updating config/environment.rb:
+
+Rails::Initializer.run do |config|
+  config.gem 'hodel_3000_compliant_logger'
+  begin
+    require 'hodel_3000_compliant_logger'
+    config.logger = Hodel3000CompliantLogger.new(config.log_path)
+  rescue
+    $stderr.puts "Hodel3000CompliantLogger unavailable, oink will be disabled"
+  end
+end
+
+Note, the block inside Rails::Initializer runs before you environment is fully loaded, so you need this in a begin/rescue block so `rake gems:install` doesn't fall on its face.
+
+=== NOTE
+
+If you are using FastCGI, you may need to hard-code the hostname instead of using Socket.gethostname
+
+== Author
+
+Geoffrey Grosenbach, with help from Eric Hodel
+
+http://topfunky.com
+
+== Changes
+
+* Nov 29, 2007: Improvements and spec from Chris Bernard [http://logicleaf.com/]

data/Rakefile

@@ -0,0 +1,27 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "hodel_3000_compliant_logger"
+    gem.version = "0.1.0"
+    gem.summary = %Q{Alternate logger for Rails that emits syslog-style output. For use with pl_analyze gem.}
+    gem.description = %Q{Alternate logger for Rails that emits syslog-style output. For use with pl_analyze gem.}
+    gem.email = "boss@topfunky.com"
+    gem.homepage = "http://github.com/topfunky/hodel_3000_compliant_logger"
+    gem.authors = ["Geoffrey Grosenbach"]
+    gem.add_development_dependency "rspec", "~> 1.3.0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+task :default => :spec

data/hodel_3000_compliant_logger.gemspec

@@ -0,0 +1,47 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{hodel_3000_compliant_logger}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Geoffrey Grosenbach"]
+  s.date = %q{2010-09-30}
+  s.description = %q{Alternate logger for Rails that emits syslog-style output. For use with pl_analyze gem.}
+  s.email = %q{boss@topfunky.com}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    "README.rdoc",
+     "Rakefile",
+     "hodel_3000_compliant_logger.gemspec",
+     "lib/hodel_3000_compliant_logger.rb",
+     "spec/hodel_3000_compliant_logger_spec.rb"
+  ]
+  s.homepage = %q{http://github.com/topfunky/hodel_3000_compliant_logger}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Alternate logger for Rails that emits syslog-style output. For use with pl_analyze gem.}
+  s.test_files = [
+    "spec/hodel_3000_compliant_logger_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, ["~> 1.3.0"])
+    else
+      s.add_dependency(%q<rspec>, ["~> 1.3.0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, ["~> 1.3.0"])
+  end
+end
+

data/lib/hodel_3000_compliant_logger.rb

@@ -0,0 +1,31 @@
+require 'logger'
+require 'English'
+
+# A logger for use with pl_analyze and other tools that expect syslog-style log output.
+class Hodel3000CompliantLogger < Logger
+
+  ##
+  # Note: If you are using FastCGI you may need to hard-code the hostname here instead of using Socket.gethostname
+  def format_message(severity, timestamp, progname, msg)
+    "#{timestamp.strftime("%b %d %H:%M:%S")} #{hostname} rails[#{$PID}]: #{msg2str(msg).gsub(/\n/, '').lstrip}\n"
+  end
+
+  private
+
+  def hostname
+    @parsed_hostname ||= Socket.gethostname.split('.').first
+  end
+
+  def msg2str(msg)
+    case msg
+    when ::String
+      msg
+    when ::Exception
+      "#{ msg.message } (#{ msg.class }): " <<
+      (msg.backtrace || []).join(" | ")
+    else
+      msg.inspect
+    end
+  end
+
+end

data/spec/hodel_3000_compliant_logger_spec.rb

@@ -0,0 +1,39 @@
+$: << File.dirname(__FILE__) + "/../lib"
+
+require 'rubygems'
+require 'spec'
+require 'hodel_3000_compliant_logger'
+
+describe Hodel3000CompliantLogger do 
+
+	before :each do
+		@out = StringIO.new
+		@log = Hodel3000CompliantLogger.new(@out)
+    Socket.stub(:gethostname).and_return('hostname.domain')
+	end
+
+	it "should log stuff in a syslog-like format so that Eric Hodel's Rails Analyzer Tools can parse it" do
+		msg = "Yo ho hello there!"
+		@log.info(msg)
+		@out.string.should match(/^\w{3} \d{2} \d{2}:\d{2}:\d{2} hostname rails\[\d+\]: #{msg}\n$/)
+	end
+	
+	it "should handle an Exception object used as an argument in Logger#error, rather than blow chunks" do
+		@log.error(Exception.new)
+		@out.string.should match(/Exception/)
+	end
+
+	it "should display a semi-readable stack trace (albiet on one line) when Logger#error(SomeException) was called" do
+		@log.error(toss_runtime_error)
+		@out.string.should match(/.*? \| .*? \| .*? \|/) # pipe separated stack frames
+		@out.string.should match(/\n$/)
+		@out.string.count("\n").should == 1 
+	end
+	
+	def toss_runtime_error
+		raise "Catastrophic Failure"
+	rescue => e
+		return e
+	end
+end
+	 

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: hodel_3000_compliant_logger
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Geoffrey Grosenbach
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-30 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :development
+  version_requirements: *id001
+description: Alternate logger for Rails that emits syslog-style output. For use with pl_analyze gem.
+email: boss@topfunky.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- Rakefile
+- hodel_3000_compliant_logger.gemspec
+- lib/hodel_3000_compliant_logger.rb
+- spec/hodel_3000_compliant_logger_spec.rb
+has_rdoc: true
+homepage: http://github.com/topfunky/hodel_3000_compliant_logger
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Alternate logger for Rails that emits syslog-style output. For use with pl_analyze gem.
+test_files: 
+- spec/hodel_3000_compliant_logger_spec.rb