logging-remote-syslog 0.0.2 → 0.0.3

data/README.md

@@ -19,6 +19,12 @@ Or install it yourself as:
     $ gem install logging-remote-syslog
     ```
 
+## Options
+:ident - [String] The identity of the sender
+:syslog_server [String] - The syslog server
+:strip_colors [True|False] - Some loggers like shell colors, should we remove them?
+:facility [String] - Something like local6
+
 ## Usage
 
 ```
@@ -41,6 +47,9 @@ logger.info 'MyApp Message'
 rake
 ```
 
+## Change Log
+0.0.3 - Strip ANSI shell codes by default
+
 ## Contributing
 
 1. Fork it

data/lib/logging/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.3

data/lib/logging/appenders/remote-syslog.rb

@@ -79,6 +79,8 @@ module Logging::Appenders
       @syslog_server =  opts.getopt(:syslog_server, '127.0.0.1')
       @port = opts.getopt(:port, 514, :as => Integer)
 
+      @strip_colors =  opts.getopt(:strip_colors, true)
+
       facility_name = opts.getopt(:facility, 'user')
 
       @facility = ::SyslogProtocol::FACILITIES[facility_name]
@@ -116,6 +118,13 @@ module Logging::Appenders
       @map = map
     end
 
+    def strip_ansi_colors(message)
+      message.gsub /\\e\[?.*?[\@-~]/, ''
+    end
+
+    def prepare_message(message)
+      @strip_colors ? strip_ansi_colors(message) : message
+    end
 
     private
 
@@ -144,7 +153,7 @@ module Logging::Appenders
         :program => @ident
         )
 
-      udp_sender.write(message)
+      udp_sender.write(prepare_message(message))
 
       self
     end

data/spec/logging/appenders/remote_syslog_spec.rb

@@ -55,4 +55,14 @@ describe Logging::Appenders::RemoteSyslog do
     logger.level = level
     logger.info("Test Message").should == true
   end
+
+  it 'strips shell codes by default' do
+    appender = Logging.appenders.remote_syslog('Test', :syslog_server => '127.0.0.1', :facility => SyslogProtocol::FACILITIES['local6'])
+    appender.prepare_message('\e[KTest Message\e[0m').should ==  'Test Message'
+  end
+
+  it 'should not strip shell code if asked' do
+    appender = Logging.appenders.remote_syslog('Test', :syslog_server => '127.0.0.1', :facility => SyslogProtocol::FACILITIES['local6'], :strip_colors => false)
+    appender.prepare_message('\e[KTest Message\e[0m').should ==  '\e[KTest Message\e[0m'
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: logging-remote-syslog
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-10 00:00:00.000000000 Z
+date: 2012-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logging
@@ -128,7 +128,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -548630293410583462
+      hash: 561701682782871936
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -137,7 +137,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -548630293410583462
+      hash: 561701682782871936
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -147,14 +147,17 @@ summary: ! '# logging/remote-syslog  logging/remote-syslog is a remote syslog ap
   for use with the Logging library. ![Travis CI Status](https://secure.travis-ci.org/BIAINC/logging-remote-syslog.png)  ##
   Installation  Add this line to your application''s Gemfile: ``` gem ''logging-remote-syslog'',
   :require => ''logging/remote-syslog'' ```  And then execute: ``` $ bundle ```  Or
-  install it yourself as: ``` $ gem install logging-remote-syslog ```  ## Usage  ```
-  require ''logging'' require ''logging/remote-syslog''  logger = Logging.logger[''MyApp'']
-  logger.add_appenders( Logging.appenders.remote_syslog(ident, syslog_server: syslog_host,
-  port: syslog_port) )  logger.level = :info logger.info ''MyApp Message''  ```  ##
-  Tests  ``` rake ```  ## Contributing  1. Fork it 2. Create your feature branch (`git
-  checkout -b my-new-feature`) 3. Write code and add _tests_ 4. Commit your changes
-  (`git commit -am ''Added some feature''`) 5. Push to the branch (`git push origin
-  my-new-feature`) 6. Create new Pull Request'
+  install it yourself as: ``` $ gem install logging-remote-syslog ```  ## Options
+  :ident - [String] The identity of the sender :syslog_server [String] - The syslog
+  server :strip_colors [True|False] - Some loggers like shell colors, should we remove
+  them? :facility [String] - Something like local6  ## Usage  ``` require ''logging''
+  require ''logging/remote-syslog''  logger = Logging.logger[''MyApp''] logger.add_appenders(
+  Logging.appenders.remote_syslog(ident, syslog_server: syslog_host, port: syslog_port)
+  )  logger.level = :info logger.info ''MyApp Message''  ```  ## Tests  ``` rake ```  ##
+  Change Log 0.0.3 - Strip ANSI shell codes by default  ## Contributing  1. Fork it
+  2. Create your feature branch (`git checkout -b my-new-feature`) 3. Write code and
+  add _tests_ 4. Commit your changes (`git commit -am ''Added some feature''`) 5.
+  Push to the branch (`git push origin my-new-feature`) 6. Create new Pull Request'
 test_files:
 - spec/logging/appenders/remote_syslog_spec.rb
 - spec/spec_helper.rb