cbrunnkvist-psd_logger 0.1.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2010 Conny Brunnkvist
+
+includes portions (c) 2009 Sean Cashin
+
+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,3 @@
+= psd_logger
+
+An improved Logger replacement that logs to syslog, with custom tweaks added & defaults set. For a generic one please see http://github.com/cpowell/sysloglogger

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "cbrunnkvist-psd_logger"
+    gem.summary = %Q{A Sanger/PSD specific fork of the SyslogLogger gem.}
+    gem.description = %Q{An improved Logger replacement that logs to syslog, with custom tweaks added & defaults set. For a generic one please see http://github.com/cpowell/sysloglogger}
+    gem.email = "cb16@sanger.ac.uk"
+    gem.homepage = "http://github.com/cbrunnkvist/psd_logger"
+    gem.authors = ["Conny Brunnkvist"]
+    gem.add_development_dependency "shoulda"
+    gem.add_development_dependency "mocha"
+    # 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 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "syslog_logger #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/bin/psd_logger

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+require 'getoptlong'
+require 'psd_logger'
+
+opts = GetoptLong.new(
+      [ '--tag', '-t', GetoptLong::OPTIONAL_ARGUMENT ],
+      [ '--prefix', '-p', GetoptLong::OPTIONAL_ARGUMENT ]
+)
+
+tag = 'logger'
+opts.each do |opt_name,opt_value| 
+  if (opt_name == '--tag') && (opt_value != '')
+    tag = opt_value
+  end
+end
+psd_logger = PsdLogger.new(tag)
+
+if ARGV.length == 0
+  begin
+    while line = STDIN.readline
+      psd_logger.error(line)
+    end
+  rescue EOFError
+  end
+else
+  psd_logger.error(msg)
+end

data/cbrunnkvist-psd_logger.gemspec

@@ -0,0 +1,61 @@
+# 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{cbrunnkvist-psd_logger}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Conny Brunnkvist"]
+  s.date = %q{2010-09-06}
+  s.default_executable = %q{psd_logger}
+  s.description = %q{An improved Logger replacement that logs to syslog, with custom tweaks added & defaults set. For a generic one please see http://github.com/cpowell/sysloglogger}
+  s.email = %q{cb16@sanger.ac.uk}
+  s.executables = ["psd_logger"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "bin/psd_logger",
+     "cbrunnkvist-psd_logger.gemspec",
+     "lib/psd_logger.rb",
+     "lib/psd_logger_env_formatting.rb",
+     "test/helper.rb",
+     "test/test_syslog_logger.rb"
+  ]
+  s.homepage = %q{http://github.com/cbrunnkvist/psd_logger}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{A Sanger/PSD specific fork of the SyslogLogger gem.}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_syslog_logger.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<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<mocha>, [">= 0"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<mocha>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<mocha>, [">= 0"])
+  end
+end
+

data/lib/psd_logger.rb

@@ -0,0 +1,142 @@
+require 'syslog'
+require 'logger'
+
+##
+# PsdLogger includes code from SeattleRb's SyslogLogger
+#
+# = Sample usage with Rails
+#
+# == config/environment/production.rb
+#
+# Add the following lines:
+#
+#   require 'psd_logger'
+#   RAILS_DEFAULT_LOGGER = PsdLogger.new
+
+class PsdLogger
+  ##
+  # The version of SyslogLogger you are using.
+  VERSION = '0.0.1'
+  # From 'man syslog.h':
+  # LOG_EMERG   A panic condition was reported to all processes.
+  # LOG_ALERT   A condition that should be corrected immediately.
+  # LOG_CRIT    A critical condition.
+  # LOG_ERR     An error message.
+  # LOG_WARNING A warning message.
+  # LOG_NOTICE  A condition requiring special handling.
+  # LOG_INFO    A general information message.
+  # LOG_DEBUG   A message useful for debugging programs.
+
+  # From logger rdoc:
+  # FATAL:  an unhandleable error that results in a program crash
+  # ERROR:  a handleable error condition
+  # WARN:   a warning
+  # INFO:   generic (useful) information about system operation
+  # DEBUG:  low-level information for developers
+
+  ##
+  # Maps Logger warning types to syslog(3) warning types.
+  LOGGER_MAP = {
+    :unknown => :alert,
+    :fatal   => :alert,
+    :error   => :err,
+    :warn    => :warning,
+    :info    => :info,
+    :debug   => :debug
+  }
+
+  # Maps Logger log levels to their values so we can silence.
+  LOGGER_LEVEL_MAP = {}
+
+  LOGGER_MAP.each_key do |key|
+    LOGGER_LEVEL_MAP[key] = Logger.const_get key.to_s.upcase
+  end
+include Logger::Severity
+  ##
+  # Maps Logger log level values to syslog log levels.
+  LEVEL_LOGGER_MAP = {}
+
+  LOGGER_LEVEL_MAP.invert.each do |level, severity|
+    LEVEL_LOGGER_MAP[level] = LOGGER_MAP[severity]
+  end
+
+  # Builds a methods for level +meth+.
+  for severity in Logger::Severity.constants
+    class_eval <<-EOT, __FILE__, __LINE__
+      def #{severity.downcase}(message = nil, progname = nil, &block)  # def debug(message = nil, progname = nil, &block)
+        add(#{severity}, message, progname, &block)                    #   add(DEBUG, message, progname, &block)
+      end                                                              # end
+                                                                       #
+      def #{severity.downcase}?                                        # def debug?
+        #{severity} >= @level                                          #   DEBUG >= @level
+      end                                                              # end
+    EOT
+  end
+
+  # Log level for Logger compatibility.
+  attr_accessor :level, :filter
+
+  ##
+  # Fills in variables for Logger compatibility.  If this is the first
+  # instance of SyslogLogger, +program_name+ may be set to change the logged
+  # program name and +facility+ may be set to specify a custom facility
+  # with your syslog daemon.
+  #
+  # Due to the way syslog works, program name may be set once only (needs to reopen otherwise).
+  def initialize(tag_suffix = '')
+    return if defined? SYSLOG
+
+    if tag_suffix == ''
+      tag_suffix = 'logger'
+    end
+
+    @level = PsdLogger::INFO
+    self.class.const_set :SYSLOG, Syslog.open("psd_#{tag_suffix}")
+    self.debug("PsdLogger.initialize()")
+  end
+
+  ##
+  # Almost duplicates Logger#add.  +progname+ is prepended to the beginning of a message.
+  def add(severity, message = nil, progname = nil, &block)
+    severity ||= Logger::UNKNOWN
+    if severity >= @level
+      prepend = progname ? "[#{progname}] " : nil
+      prepend ||= @filter ? "[#{@filter}] " : ''
+      message = clean(message || block.call)
+      SYSLOG.send LEVEL_LOGGER_MAP[severity], prepend + clean(message)
+    end
+    true
+  end
+
+  ##
+  # Allows messages of a particular log level to be ignored temporarily.
+  def silence(temporary_level = Logger::ERROR)
+    old_logger_level = @level
+    @level = temporary_level
+    yield
+  ensure
+    @level = old_logger_level
+  end
+
+  # In Logger, this dumps the raw message; the closest equivalent
+  # would be Logger::UNKNOWN
+  def <<(message)
+    add(Logger::UNKNOWN, message)
+  end
+
+  private
+
+  ##
+  # Clean up messages so they're nice and pretty.
+  def clean(message)
+    message = message.to_s.dup
+    message.strip!
+    message.gsub!(/%/, '%%') # syslog(3) freaks on % (printf)
+    message.gsub!(/\e\[[^m]*m/, '') # remove useless ansi color codes
+    if defined?(Rails)
+      message = "#{Rails.env}/#{Rails.root.split.last} #{message}"
+    end
+    return message
+  end
+
+end

data/lib/psd_logger_env_formatting.rb

@@ -0,0 +1,38 @@
+# Adds some default information to syslog messages.
+# If you pass a User or Device object as the first parameter, it will log that user/device's id
+# If you pass a block from a controller, it will automatically log the current user id
+# If you pass a block, the class name of the block's context will be added
+# 
+# Examples
+# logger.debug "O'Doyle Rules!" 
+#     #=> [development] [DEBUG: 2008-01-25 14:16:12.12345] O'Doyle Rules!
+# 
+# #from within a controller...
+# logger.error {"Something is messed up!"}
+#     #=> [development] [ERROR: 2008-01-25 14:16:12.12345] [123] [ClassName] Something is messed up!
+
+class SyslogLogger
+
+    # short names for "DEBUG", "INFO", ...
+    # must be ordered to correspond to severity constants defined in 
+    # ActiveSupport::BufferedLogger::Severity 
+    #@@log_level_names = %w( D I W E F U )
+    #LOG_NAME_FIELD_WIDTH = 1
+
+    @@log_level_names = %w( DEBUG INFO WARN ERROR FATAL UNKNOWN )
+    LOG_NAME_FIELD_WIDTH = 7
+    
+    def add_with_formatting(severity, message = nil, progname = nil, &block)
+      severity ||= Logger::UNKNOWN
+      message = "[#{RAILS_ENV}] [#{@@log_level_names[severity].ljust(LOG_NAME_FIELD_WIDTH)}: #{time.strftime("%Y-%m-%d %H:%M:%S")}.#{time.usec.to_s.rjust(6, '0')}] #{message}"
+
+      if(block)
+        add_without_formatting(severity, message, progname,
+          &Proc.new{g_log_formatter(severity, nil, user, &block)})
+      else
+        add_without_formatting(severity, message, progname)
+      end
+    end
+    alias_method_chain :add, :formatting
+    
+end

data/test/helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'mocha'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'syslog_logger'
+
+class Test::Unit::TestCase
+end

data/test/test_syslog_logger.rb

@@ -0,0 +1,25 @@
+require 'helper'
+
+class TestSyslogLogger < Test::Unit::TestCase
+  context "on first initialization of default SyslogLogger object" do
+    setup do
+      @logger = SyslogLogger.new
+    end
+    should "have level set to DEBUG" do
+      assert_equal @logger.level, Logger::DEBUG
+    end
+  end
+  context "a SyslogLogger object" do
+    setup do
+      @logger = SyslogLogger.new
+    end
+    Logger::Severity.constants.each do |severity|
+      should "respond to method #{severity}" do
+        @logger.send(severity.downcase.to_sym, 'message', 'progname')
+      end
+      should "respond to method #{severity}?" do
+        @logger.send("#{severity.downcase}?".to_sym)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification 
+name: cbrunnkvist-psd_logger
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- Conny Brunnkvist
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-06 00:00:00 +01:00
+default_executable: psd_logger
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: An improved Logger replacement that logs to syslog, with custom tweaks added & defaults set. For a generic one please see http://github.com/cpowell/sysloglogger
+email: cb16@sanger.ac.uk
+executables: 
+- psd_logger
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/psd_logger
+- cbrunnkvist-psd_logger.gemspec
+- lib/psd_logger.rb
+- lib/psd_logger_env_formatting.rb
+- test/helper.rb
+- test/test_syslog_logger.rb
+has_rdoc: true
+homepage: http://github.com/cbrunnkvist/psd_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: A Sanger/PSD specific fork of the SyslogLogger gem.
+test_files: 
+- test/helper.rb
+- test/test_syslog_logger.rb