slogger 0.0.2 → 0.0.3

data/README.rdoc

@@ -2,6 +2,12 @@
 
 Slogger is a Ruby library to help work with standard Ruby Syslog library.
 
+== Install
+
+Slogger is hosted on RubyGems (https://rubygems.org/gems/slogger), so to install it is really easy.
+  
+  $ gem install slogger
+
 == Features
 
 === Slogger::Logger
@@ -10,14 +16,27 @@ A more friendly wrapper on Ruby's Syslog.
     
 Sample: simple message log
     
-  slogger = Slogger::Logger.new "sample_app", :debug, :local0 
+  require "slogger"
+  
+  # So in this sample:
+  #
+  # "sample_name": application name
+  # :info        : severity level
+  # :local0      : facility
+  
+  slogger = Slogger::Logger.new "sample_app", :info, :local0 
   slogger.info "A good info"
-  slogger.debug "A deep info"
+  slogger.debug "A deep info (oops!)"  # it'll not be logged
+  
+  slogger.severity = :debug
+  slogger.debug "A deep info (yay!)"   # now it'll be logged
   
   # and after, look at the syslog file of your SO  ;)
 
 Sample: message log preceded by spent time
 
+  require "slogger"
+  
   slogger = Slogger::Logger.new "sample_app", :debug, :local0 
   slogger.info "A really good info preceded by spent time" do
     # do something
@@ -31,12 +50,14 @@ A Rack middleware to log incoming requests.
 
 Sample:
 
-    configure do
-      slogger = Slogger::Logger.new "sample_app", :debug, :local0
-      use Slogger::Rack::RequestLogger, slogger
-    end
+  require "slogger"
+  
+  configure do
+    slogger = Slogger::Logger.new "sample_app", :debug, :local0
+    use Slogger::Rack::RequestLogger, slogger
+  end
 
-    # and after, look at the syslog file of your SO  ;)
+  # and after, look at the syslog file of your SO  ;)
     
 == Future
 
@@ -46,4 +67,4 @@ For now is it.
 
 == Copyright
 
-Copyright (c) 2011 Leandro Silva (CodeZone). Blog: http://leandrosilva.com.br.
+Copyright (c) 2011 Leandro Silva (CodeZone).

data/VERSION

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

data/lib/slogger/logger.rb

@@ -3,7 +3,7 @@ module Slogger
   # The wrapper for standard Ruby Syslog library.
   #
   class Logger
-    LEVEL = {
+    SEVERITY = {
       :crit    => 0,
       :emerg   => 1,
       :alert   => 2,
@@ -36,43 +36,53 @@ module Slogger
       :local7   => Syslog::LOG_LOCAL7
     }
     
-    attr_reader :app_name, :level, :facility
+    attr_reader :app_name, :severity, :facility
 
     #
     # To build a Slogger::Logger instance.
     #
     # +app_name+::  The appliaction name to be logged
-    # +level+::     The log level: :crit, :emerg, :alert, :err, :warning, :notice,
-    #                 :info, or :debug.
+    # +severity+::  The log severity: :crit, :emerg, :alert, :err, :warning, :notice,
+    #                 :info, or :debug. It can be changed at anytime.
     # +facility+::  A typical syslog facility: :user, :mail, :daemon, :auth,
     #                 :syslog, :lpr, :news, :uucp, :cron, :authpriv, :ftp,
     #                 :local0, :local1, :local2, :local3, :local4, :local5,
     #                 :local6, or :local7
     #
-    # Raises an ArgumentError if app_name, level, or facility is nil.
+    # Raises an ArgumentError if app_name, severity, or facility is nil.
     #
-    def initialize(app_name, level, facility)
-      raise ArgumentError, "The 'app_name' parameter is required" unless app_name
-      raise ArgumentError, "The 'level' parameter is required" unless level
-      raise ArgumentError, "The 'facility' parameter is required" unless facility
+    def initialize(app_name, severity, facility)
+      raise_argument_error_to_required_parameter "app_name" unless app_name
+      raise_argument_error_to_required_parameter "severity" unless severity
+      raise_argument_error_to_required_parameter "facility" unless facility
+
+      raise_argument_error_to_invalid_parameter "severity", "SEVERITY" unless SEVERITY[severity]
+      raise_argument_error_to_invalid_parameter "facility", "FACILITY" unless FACILITY[facility]
       
       @app_name = app_name
-      @level = level
-      @level_as_int = LEVEL[level]
+      @severity = severity
+      @severity_as_int = SEVERITY[severity]
       @facility = facility
       @facility_as_int = FACILITY[facility]
     end
     
-    LEVEL.each_key do |level|
-      define_method level do |message, &block|
-        log(level, message, &block)
+    SEVERITY.each_key do |severity|
+      define_method severity do |message, &block|
+        log(severity, message, &block)
       end
     end
     
+    def severity=(value)
+      raise_argument_error_to_invalid_parameter "severity", "SEVERITY" unless SEVERITY[value]
+      
+      @severity = value
+      @severity_as_int = SEVERITY[value]
+    end
+    
     private
     
-    def log(level, message, &block)
-      return if LEVEL[level] > @level_as_int
+    def log(severity, message, &block)
+      return if SEVERITY[severity] > @severity_as_int
 
       if block_given?
         began_at = Time.now
@@ -84,7 +94,15 @@ module Slogger
         message = "[#{end_at}s] #{message}"
       end
       
-      Syslog.open(@app_name, Syslog::LOG_PID, @facility_as_int) { |s| s.send level, message }
+      Syslog.open(@app_name, Syslog::LOG_PID, @facility_as_int) { |s| s.send severity, message }
+    end
+    
+    def raise_argument_error_to_required_parameter(param)
+      raise ArgumentError, "The '#{param}' parameter is required."
+    end
+
+    def raise_argument_error_to_invalid_parameter(param, options)
+      raise ArgumentError, "The '#{param}' parameter is invalid. Inspect the #{options} constant to know the options."
     end
   end
 end

data/spec/slogger/logger_spec.rb

@@ -1,52 +1,93 @@
 require File.join(File.dirname(__FILE__), "..", "/spec_helper")
 
 describe Slogger::Logger do
-  describe "valid state" do
-    subject { Slogger::Logger.new "test_app", :debug, :local0 }
+  subject { Slogger::Logger.new "test_app", :debug, :local0 }
 
-    its(:app_name) { should == "test_app" }
-    its(:level) { should == :debug }
-    its(:facility) { should == :local0 }
+  describe "valid state" do
+    it "should have an app_name attribute" do
+      subject.app_name.should == "test_app"
+    end
+    
+    it "should have a severity attribute" do
+      subject.severity.should == :debug
+    end
+    
+    it "should have a facility attribute" do
+      subject.facility.should == :local0
+    end
   end
   
   describe "invalid state" do
-    it "should raise ArgumentError if doen't have app_name" do
+    it "should raise ArgumentError if doesn't have app_name" do
       lambda { Slogger::Logger.new nil, :debug, :local0 }.should raise_error
     end
 
-    it "should raise ArgumentError if doen't have level" do
+    it "should raise ArgumentError if doesn't have severity" do
       lambda { Slogger::Logger.new "test_app", nil, :local0 }.should raise_error
     end
 
-    it "should raise ArgumentError if doen't have facility" do
+    it "should raise ArgumentError if doesn't have facility" do
       lambda { Slogger::Logger.new "test_app", :debug, nil }.should raise_error
     end
+    
+    it "should raise ArgumentError if severity level is invalid" do
+      lambda { Slogger::Logger.new "test_app", :junk, :local0 }.should raise_error
+    end
+    
+    it "should raise ArgumentError if facility is invalid" do
+      lambda { Slogger::Logger.new "test_app", :describe, :junk }.should raise_error
+    end
+  end
+
+  describe "severity setup" do
+    it "should be possible to change severity attribute" do
+      subject.severity.should be :debug
+      subject.severity = :warning
+      subject.severity.should be :warning
+      subject.severity = :info
+      subject.severity.should be :info
+    end
+      
+    it "should raise ArgumentError if try to change severity attribute to a invalid one" do
+      lambda { subject.severity = :junk }.should raise_error
+    end
   end
   
-  describe "when in warning level" do
-    subject { Slogger::Logger.new "test_app", :warning, :local0 }
+  describe "logging" do
+    describe "when is in WARNING severity" do
+      subject { Slogger::Logger.new "test_app", :warning, :local0 }
 
-    it "should log WARNING messages" do
-      Syslog.stub!(:warning).with(anything).and_return(Syslog)
-      Syslog.should_receive(:warning).and_return(Syslog)
+      it "should log WARNING messages" do
+        Syslog.stub!(:warning).with(anything).and_return(Syslog)
+        Syslog.should_receive(:warning).and_return(Syslog)
 
-      subject.warning "WARNING message"
-    end
+        subject.warning "WARNING message"
+      end
     
-    it "shouldn't log INFO messages" do
-      Syslog.stub!(:info).with(anything).and_return(Syslog)
-      Syslog.should_not_receive(:info).and_return(Syslog)
+      it "shouldn't log INFO messages" do
+        Syslog.stub!(:info).with(anything).and_return(Syslog)
+        Syslog.should_not_receive(:info).and_return(Syslog)
+
+        subject.info "INFO message"
+      end
+      
+      describe "but when severity is changed to INFO" do
+        it "should log INFO messages" do
+          subject.severity = :info
 
-      subject.info "INFO message"
+          Syslog.stub!(:info).with(anything).and_return(Syslog)
+          Syslog.should_receive(:info).and_return(Syslog)
+          
+          subject.info "INFO message"
+        end
+      end
     end
-  end
-    
-  describe "when a block is passed to log method" do
-    subject { Slogger::Logger.new "test_app", :debug, :local0 }
-    
-    it "it should add spent time to the message" do
-      subject.info "a block wrapped by log" do
-        sleep(10)
+
+    describe "when a block is passed to log method" do
+      it "should add spent time to the message" do
+        subject.info "a block wrapped by log" do
+          sleep(2)
+        end
       end
     end
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: slogger
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Leandro Silva
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-18 00:00:00 -02:00
+date: 2011-02-21 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency