syslogger 1.2.3 → 1.2.4

data/README.rdoc

@@ -19,6 +19,8 @@ Contrary to the SyslogLogger library, you can specify the facility and the syslo
   logger.info "will appear"
   logger.warn "will appear"
 
+Documentation available at <http://rdoc.info/github/crohr/syslogger/master/file/README.rdoc>.
+
 == Development
 * Install +bundler+:
 
@@ -38,6 +40,7 @@ Contrary to the SyslogLogger library, you can specify the facility and the syslo
 
 == Contributions
 * crhym3
+* theflow
 
 == Copyright
 

data/lib/syslogger.rb

@@ -3,7 +3,7 @@ require 'logger'
 
 class Syslogger
 
-  VERSION = "1.2.3"
+  VERSION = "1.2.4"
 
   attr_reader :level, :ident, :options, :facility
 
@@ -65,13 +65,18 @@ class Syslogger
 
   # 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.
-  # +progname+:: optionally, a overwrite the program name that appears in the log message.
+  # +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.call))
+      s.log(
+        MAPPING[severity], 
+        clean(message || (block && block.call) || progname)
+      )
     }
   end
 
@@ -85,7 +90,10 @@ class Syslogger
 
   # Borrowed from SyslogLogger.
   def clean(message)
-    # syslog(3) freaks on % (printf)
-    message.strip.gsub(/%/, '%%')
+    message = message.to_s.dup
+    message.strip!
+    message.gsub!(/%/, '%%') # syslog(3) freaks on % (printf)
+    message.gsub!(/\e\[[^m]*m/, '') # remove useless ansi color codes
+    message
   end
 end

data/spec/syslogger_spec.rb

@@ -7,20 +7,20 @@ describe "Syslogger" do
     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(:<<)
@@ -28,7 +28,7 @@ describe "Syslogger" do
     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)
@@ -51,7 +51,7 @@ describe "Syslogger" do
       syslog.should_receive(:log).with(Syslog::LOG_INFO, "message")
       @logger.add(Logger::INFO, "message", "progname") { "my message" }
     end
-    
+
     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%%")
@@ -63,30 +63,48 @@ describe "Syslogger" do
       syslog.should_receive(:log).with(Syslog::LOG_INFO, "message")
       @logger.add(Logger::INFO, "\n\nmessage  ")
     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
   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|
@@ -94,7 +112,7 @@ describe "Syslogger" do
       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|
@@ -104,7 +122,7 @@ describe "Syslogger" do
         @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|
@@ -114,7 +132,7 @@ describe "Syslogger" do
         @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

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 2
-  - 3
-  version: 1.2.3
+  - 4
+  version: 1.2.4
 platform: ruby
 authors: 
 - Cyril Rohr
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-07 00:00:00 +01:00
+date: 2011-02-08 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency