spindance-syslogger 1.2.7

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Cyril Rohr, INRIA Rennes-Bretagne Atlantique
+
+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,50 @@
+= syslogger
+
+A drop-in replacement for the standard Logger Ruby library, that logs to the syslog instead of a log file.
+Contrary to the SyslogLogger library, you can specify the facility and the syslog options.
+
+This fork takes care of log messages spanning across multiple lines. Like in a Rails backtrace.
+
+== Installation
+  $ gem install syslogger
+
+== Usage
+  require 'syslogger'
+  
+  # Will send all messages to the local0 facility, adding the process id in the message
+  logger = Syslogger.new("app_name", Syslog::LOG_PID, Syslog::LOG_LOCAL0)
+  
+  # Send messages that are at least of the Logger::INFO level
+  logger.level = Logger::INFO # use Logger levels
+  
+  logger.debug "will not appear"
+  logger.info "will appear"
+  logger.warn "will appear"
+
+Documentation available at <http://rdoc.info/github/crohr/syslogger/master/file/README.rdoc>.
+
+== Development
+* Install +bundler+:
+
+    $ gem install bundler
+
+* Install development dependencies:
+
+    $ bundle install
+
+* Run tests:
+
+    $ bundle exec rake
+
+* Package (do not forget to increment <tt>Syslogger:VERSION</tt>):
+
+    $ gem build syslogger.gemspec
+
+== Contributions
+* crhym3
+* theflow
+* smulube
+
+== Copyright
+
+Copyright (c) 2010 Cyril, INRIA Rennes-Bretagne Atlantique. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,25 @@
+require 'spec/rake/spectask'
+require 'rake/rdoctask'
+
+$LOAD_PATH.unshift(File.expand_path('../lib', __FILE__))
+
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+Rake::RDocTask.new do |rdoc|
+  require 'syslogger'
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "syslogger #{Syslogger::VERSION}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+task :default => :spec

data/lib/syslogger.rb

@@ -0,0 +1,95 @@
+require 'syslog'
+require 'logger'
+
+class Syslogger
+
+  VERSION = "1.2.7"
+
+  attr_reader :level, :ident, :options, :facility
+
+  MAPPING = {
+    Logger::DEBUG => Syslog::LOG_DEBUG,
+    Logger::INFO => Syslog::LOG_INFO,
+    Logger::WARN => Syslog::LOG_NOTICE,
+    Logger::ERROR => Syslog::LOG_WARNING,
+    Logger::FATAL => Syslog::LOG_ERR,
+    Logger::UNKNOWN => Syslog::LOG_ALERT
+  }
+
+  #
+  # Initializes default options for the logger
+  # <tt>ident</tt>:: the name of your program [default=$0].
+  # <tt>options</tt>::  syslog options [default=<tt>Syslog::LOG_PID | Syslog::LOG_CONS</tt>].
+  #                     Correct values are:
+  #                       LOG_CONS    : writes the message on the console if an error occurs when sending the message;
+  #                       LOG_NDELAY  : no delay before sending the message;
+  #                       LOG_PERROR  : messages will also be written on STDERR;
+  #                       LOG_PID     : adds the process number to the message (just after the program name)
+  # <tt>facility</tt>:: the syslog facility [default=nil] Correct values include:
+  #                       Syslog::LOG_DAEMON
+  #                       Syslog::LOG_USER
+  #                       Syslog::LOG_SYSLOG
+  #                       Syslog::LOG_LOCAL2
+  #                       Syslog::LOG_NEWS
+  #                       etc.
+  #
+  # Usage:
+  #   logger = Syslogger.new("my_app", Syslog::LOG_PID | Syslog::LOG_CONS, Syslog::LOG_LOCAL0)
+  #   logger.level = Logger::INFO # use Logger levels
+  #   logger.warn "warning message"
+  #   logger.debug "debug message"
+  #
+  def initialize(ident = $0, options = Syslog::LOG_PID | Syslog::LOG_CONS, facility = nil)
+    @ident = ident
+    @options = options || (Syslog::LOG_PID | Syslog::LOG_CONS)
+    @facility = facility
+    @level = Logger::INFO
+  end
+
+  %w{debug info warn error fatal unknown}.each do |logger_method|
+    define_method logger_method.to_sym do |message|
+      add(Logger.const_get(logger_method.upcase), message)
+    end
+
+    unless logger_method == 'unknown'
+      define_method "#{logger_method}?".to_sym do
+        @level <= Logger.const_get(logger_method.upcase)
+      end
+    end
+  end
+
+  # Logs a message at the Logger::INFO level.
+  def <<(msg)
+    add(Logger::INFO, msg)
+  end
+
+  # Low level method to add a message.
+  # +severity+::  the level of the message. One of Logger::DEBUG, Logger::INFO, Logger::WARN, Logger::ERROR, Logger::FATAL, Logger::UNKNOWN
+  # +message+:: the message string. 
+  #             If nil, the method will call the block and use the result as the message string. 
+  #             If both are nil or no block is given, it will use the progname as per the behaviour of both the standard Ruby logger, and the Rails BufferedLogger.
+  # +progname+:: optionally, overwrite the program name that appears in the log message.
+  def add(severity, message = nil, progname = nil, &block)
+    progname ||= @ident
+    Syslog.open(progname, @options, @facility) { |s|
+      s.mask = Syslog::LOG_UPTO(MAPPING[@level])
+      s.log(
+        MAPPING[severity], 
+        clean(message || (block && block.call) || progname)
+      )
+    }
+  end
+
+  # Sets the minimum level for messages to be written in the log.
+  # +level+:: one of <tt>Logger::DEBUG</tt>, <tt>Logger::INFO</tt>, <tt>Logger::WARN</tt>, <tt>Logger::ERROR</tt>, <tt>Logger::FATAL</tt>, <tt>Logger::UNKNOWN</tt>
+  def level=(level)
+    @level = level
+  end
+
+  protected
+
+  # Borrowed from SyslogLogger.
+  def clean(message)
+    message.to_s.each_line.map(&:strip).join(' >> ').gsub(/%/, '%%').gsub(/\e\[[^m]*m/, '')
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'spec'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'syslogger'

data/spec/syslogger_spec.rb

@@ -0,0 +1,166 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Syslogger" do
+  it "should log to the default syslog facility, with the default options" do
+    logger = Syslogger.new
+    Syslog.should_receive(:open).with($0, Syslog::LOG_PID | Syslog::LOG_CONS, nil).and_yield(syslog=mock("syslog", :mask= => true))
+    syslog.should_receive(:log).with(Syslog::LOG_NOTICE, "Some message")
+    logger.warn "Some message"
+  end
+
+  it "should log to the user facility, with specific options" do
+    logger = Syslogger.new("my_app", Syslog::LOG_PID, Syslog::LOG_USER)
+    Syslog.should_receive(:open).with("my_app", Syslog::LOG_PID, Syslog::LOG_USER).and_yield(syslog=mock("syslog", :mask= => true))
+    syslog.should_receive(:log).with(Syslog::LOG_NOTICE, "Some message")
+    logger.warn "Some message"
+  end
+
+  %w{debug info warn error fatal unknown}.each do |logger_method|
+    it "should respond to the #{logger_method.inspect} method" do
+      Syslogger.new.should respond_to logger_method.to_sym
+    end
+  end
+
+  it "should respond to <<" do
+    logger = Syslogger.new("my_app", Syslog::LOG_PID, Syslog::LOG_USER)
+    logger.should respond_to(:<<)
+    Syslog.should_receive(:open).with("my_app", Syslog::LOG_PID, Syslog::LOG_USER).and_yield(syslog=mock("syslog", :mask= => true))
+    syslog.should_receive(:log).with(Syslog::LOG_INFO, "yop")
+    logger << "yop"
+  end
+
+  describe "add" do
+    before do
+      @logger = Syslogger.new("my_app", Syslog::LOG_PID, Syslog::LOG_USER)
+    end
+    it "should respond to add" do
+      @logger.should respond_to(:add)
+    end
+    it "should correctly log" do
+      Syslog.should_receive(:open).with("my_app", Syslog::LOG_PID, Syslog::LOG_USER).and_yield(syslog=mock("syslog", :mask= => true))
+      syslog.should_receive(:log).with(Syslog::LOG_INFO, "message")
+      @logger.add(Logger::INFO, "message")
+    end
+    it "should take the message from the block if :message is nil" do
+      Syslog.should_receive(:open).with("my_app", Syslog::LOG_PID, Syslog::LOG_USER).and_yield(syslog=mock("syslog", :mask= => true))
+      syslog.should_receive(:log).with(Syslog::LOG_INFO, "my message")
+      @logger.add(Logger::INFO) { "my message" }
+    end
+    it "should use the given progname" do
+      Syslog.should_receive(:open).with("progname", Syslog::LOG_PID, Syslog::LOG_USER).and_yield(syslog=mock("syslog", :mask= => true))
+      syslog.should_receive(:log).with(Syslog::LOG_INFO, "message")
+      @logger.add(Logger::INFO, "message", "progname") { "my message" }
+    end
+    
+    it "should not raise exception if asked to log with a nil message and body" do
+      Syslog.should_receive(:open).
+        with("my_app", Syslog::LOG_PID, Syslog::LOG_USER).
+        and_yield(syslog=mock("syslog", :mask= => true))
+      syslog.should_receive(:log).with(Syslog::LOG_INFO, "my_app")
+      lambda {
+        @logger.add(Logger::INFO, nil)
+      }.should_not raise_error
+    end
+
+    it "should use given progname as the message if the message and block are nil" do
+      Syslog.should_receive(:open).
+        with("my_app", Syslog::LOG_PID, Syslog::LOG_USER).
+        and_yield(syslog=mock("syslog", :mask= => true))
+      syslog.should_receive(:log).with(Syslog::LOG_INFO, "my_app")
+      @logger.add(Logger::INFO, nil)
+    end
+
+    context "message cleaner" do
+      it "should substitute '%' for '%%' before adding the :message" do
+        Syslog.stub(:open).and_yield(syslog=mock("syslog", :mask= => true))
+        syslog.should_receive(:log).with(Syslog::LOG_INFO, "%%me%%ssage%%")
+        @logger.add(Logger::INFO, "%me%ssage%")
+      end
+
+      it "should strip the :message" do
+        Syslog.stub(:open).and_yield(syslog=mock("syslog", :mask= => true))
+        syslog.should_receive(:log).with(Syslog::LOG_INFO, "message")
+        @logger.add(Logger::INFO, "  message  ")
+      end
+
+      it "should glue together all newlines before adding the :message" do
+        backtrace = <<-EM
+          A FooException has been raised
+            And here
+            is your
+            really long
+              backtrace...
+        EM
+        Syslog.stub(:open).and_yield(syslog=mock("syslog", :mask= => true))
+        syslog.should_receive(:log).with(Syslog::LOG_INFO, "A FooException has been raised >> And here >> is your >> really long >> backtrace...")
+        @logger.add(Logger::INFO, backtrace)
+      end
+
+      it "should stringify if an Exception is received" do
+        Syslog.stub(:open).and_yield(syslog=mock("syslog", :mask= => true))
+        syslog.should_receive(:log).with(Syslog::LOG_INFO, "Invalidity!")
+        @logger.add(Logger::INFO, Exception.new("Invalidity!"))
+      end
+    end
+  end # describe "add"
+
+  describe ":level? methods" do
+    before(:each) do
+      @logger = Syslogger.new("my_app", Syslog::LOG_PID, Syslog::LOG_USER)
+    end
+
+    %w{debug info warn error fatal}.each do |logger_method|
+      it "should respond to the #{logger_method}? method" do
+        @logger.should respond_to "#{logger_method}?".to_sym
+      end
+    end
+
+    it "should not have unknown? method" do
+      @logger.should_not respond_to :unknown?
+    end
+
+    it "should return true for all methods" do
+      @logger.level = Logger::DEBUG
+      %w{debug info warn error fatal}.each do |logger_method|
+        @logger.send("#{logger_method}?").should be_true
+      end
+    end
+
+    it "should return true for all except debug?" do
+      @logger.level = Logger::INFO
+      %w{info warn error fatal}.each do |logger_method|
+        @logger.send("#{logger_method}?").should be_true
+      end
+      @logger.debug?.should be_false
+    end
+
+    it "should return true for warn?, error? and fatal? when WARN" do
+      @logger.level = Logger::WARN
+      %w{warn error fatal}.each do |logger_method|
+        @logger.send("#{logger_method}?").should be_true
+      end
+      %w{debug info}.each do |logger_method|
+        @logger.send("#{logger_method}?").should be_false
+      end
+    end
+
+    it "should return true for error? and fatal? when ERROR" do
+      @logger.level = Logger::ERROR
+      %w{error fatal}.each do |logger_method|
+        @logger.send("#{logger_method}?").should be_true
+      end
+      %w{warn debug info}.each do |logger_method|
+        @logger.send("#{logger_method}?").should be_false
+      end
+    end
+
+    it "should return true only for fatal? when FATAL" do
+      @logger.level = Logger::FATAL
+      @logger.fatal?.should be_true
+      %w{error warn debug info}.each do |logger_method|
+        @logger.send("#{logger_method}?").should be_false
+      end
+    end
+  end # describe ":level? methods"
+
+end # describe "Syslogger"

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification 
+name: spindance-syslogger
+version: !ruby/object:Gem::Version 
+  hash: 17
+  prerelease: 
+  segments: 
+  - 1
+  - 2
+  - 7
+  version: 1.2.7
+platform: ruby
+authors: 
+- Cyril Rohr
+- SpinDance, Inc.
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-06-21 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 0
+        - 8
+        version: "0.8"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 1
+        - 3
+        version: "1.3"
+  type: :development
+  version_requirements: *id002
+description: Same as SyslogLogger, but without the ridiculous number of dependencies and with the possibility to specify the syslog facility
+email: 
+- rubygems@spindance.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/syslogger.rb
+- spec/spec_helper.rb
+- spec/syslogger_spec.rb
+- Rakefile
+- LICENSE
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/dvangeest/syslogger
+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: 31
+      segments: 
+      - 1
+      - 8
+      version: "1.8"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 9
+      segments: 
+      - 1
+      - 3
+      version: "1.3"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.4.2
+signing_key: 
+specification_version: 3
+summary: Dead simple Ruby Syslog logger
+test_files: 
+- spec/spec_helper.rb
+- spec/syslogger_spec.rb