syslogger 1.2.0 → 1.2.1

data/README.rdoc

@@ -1,17 +1,44 @@
 = syslogger
 
-Description goes here.
-
-== Note on Patches/Pull Requests
- 
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
+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.
+
+== 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"
+
+== 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
 
 == Copyright
 
-Copyright (c) 2010 Cyril. See LICENSE for details.
+Copyright (c) 2010 Cyril, INRIA Rennes-Bretagne Atlantique. See LICENSE for details.

data/Rakefile

@@ -1,24 +1,8 @@
-require 'rubygems'
-require 'rake'
+require 'spec/rake/spectask'
+require 'rake/rdoctask'
 
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "syslogger"
-    gem.summary = %Q{Dead simple Ruby Syslog logger}
-    gem.description = %Q{Same as SyslogLogger, but without the ridiculous number of dependencies and with the possibility to specify the syslog facility}
-    gem.email = "cyril.rohr@gmail.com"
-    gem.homepage = "http://github.com/crohr/syslogger"
-    gem.authors = ["Cyril Rohr"]
-    gem.add_development_dependency "rspec", ">= 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
+$LOAD_PATH.unshift(File.expand_path('../lib', __FILE__))
 
-require 'spec/rake/spectask'
 Spec::Rake::SpecTask.new(:spec) do |spec|
   spec.libs << 'lib' << 'spec'
   spec.spec_files = FileList['spec/**/*_spec.rb']
@@ -30,16 +14,11 @@ Spec::Rake::SpecTask.new(:rcov) do |spec|
   spec.rcov = true
 end
 
-task :test => :check_dependencies
-
-task :default => :spec
-
-require 'rake/rdoctask'
 Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
   rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "syslogger #{version}"
+  rdoc.title = "syslogger #{Syslogger::VERSION}"
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
+
+task :default => :spec

data/lib/syslogger.rb

@@ -2,8 +2,11 @@ require 'syslog'
 require 'logger'
 
 class Syslogger
+  
+  VERSION = "1.2.1"
+  
   attr_reader :level, :ident, :options, :facility
-
+  
   MAPPING = {
     Logger::DEBUG => Syslog::LOG_DEBUG,
     Logger::INFO => Syslog::LOG_INFO,
@@ -12,13 +15,23 @@ class Syslogger
     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=Syslog::LOG_PID | Syslog::LOG_CONS]
-  # <tt>facility</tt>:: the syslog facility [default=nil]
-  #
-  #                     correct values are Syslog::LOG_DAEMON, Syslog::LOG_USER, Syslog::LOG_SYSLOG, Syslog::LOG_LOCAL2, Syslog::LOG_NEWS, etc.
+  # <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)
@@ -37,21 +50,35 @@ class Syslogger
     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.
+  # +progname+:: optionally, a 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], (message || block.call)) 
+      s.log(MAPPING[severity], (message || block.call).to_s) 
     }
   end
   
-  def level=(logger_level)
-    @level = logger_level
+  # 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
+  
 end

data/spec/syslogger_spec.rb

@@ -51,6 +51,65 @@ describe "Syslogger" do
       syslog.should_receive(:log).with(Syslog::LOG_INFO, "message")
       @logger.add(Logger::INFO, "message", "progname") { "my message" }
     end
-  end
-  # TODO: test logger level
-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

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: syslogger
 version: !ruby/object:Gem::Version 
-  version: 1.2.0
+  prerelease: false
+  segments: 
+  - 1
+  - 2
+  - 1
+  version: 1.2.1
 platform: ruby
 authors: 
 - Cyril Rohr
@@ -9,39 +14,53 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-10 00:00:00 +01:00
+date: 2011-01-05 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: rake
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 8
+        version: "0.8"
   type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        version: "0"
-    version: 
+        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: cyril.rohr@gmail.com
+email: 
+- cyril.rohr@gmail.com
 executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- LICENSE
-- README.rdoc
+extra_rdoc_files: []
+
 files: 
-- .document
-- .gitignore
-- LICENSE
-- README.rdoc
-- Rakefile
-- VERSION
 - lib/syslogger.rb
 - spec/spec_helper.rb
 - spec/syslogger_spec.rb
-- syslogger.gemspec
+- Rakefile
+- LICENSE
+- README.rdoc
 has_rdoc: true
 homepage: http://github.com/crohr/syslogger
 licenses: []
@@ -52,21 +71,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
+      segments: 
+      - 1
+      - 8
+      version: "1.8"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
+      segments: 
+      - 1
+      - 3
+      version: "1.3"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Dead simple Ruby Syslog logger

data/.document

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

data/.gitignore

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

data/VERSION

@@ -1 +0,0 @@
-1.2.0

data/syslogger.gemspec

@@ -1,54 +0,0 @@
-# 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{syslogger}
-  s.version = "1.2.0"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Cyril Rohr"]
-  s.date = %q{2010-03-10}
-  s.description = %q{Same as SyslogLogger, but without the ridiculous number of dependencies and with the possibility to specify the syslog facility}
-  s.email = %q{cyril.rohr@gmail.com}
-  s.extra_rdoc_files = [
-    "LICENSE",
-     "README.rdoc"
-  ]
-  s.files = [
-    ".document",
-     ".gitignore",
-     "LICENSE",
-     "README.rdoc",
-     "Rakefile",
-     "VERSION",
-     "lib/syslogger.rb",
-     "spec/spec_helper.rb",
-     "spec/syslogger_spec.rb",
-     "syslogger.gemspec"
-  ]
-  s.homepage = %q{http://github.com/crohr/syslogger}
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.5}
-  s.summary = %q{Dead simple Ruby Syslog logger}
-  s.test_files = [
-    "spec/spec_helper.rb",
-     "spec/syslogger_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::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<rspec>, [">= 0"])
-    else
-      s.add_dependency(%q<rspec>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<rspec>, [">= 0"])
-  end
-end
-