rubysl-logger 1.0.0

data/lib/rubysl/logger/version.rb

@@ -0,0 +1,5 @@
+module RubySL
+  module Logger
+    VERSION = "1.0.0"
+  end
+end

data/rubysl-logger.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+require './lib/rubysl/logger/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rubysl-logger"
+  spec.version       = RubySL::Logger::VERSION
+  spec.authors       = ["Brian Shirai"]
+  spec.email         = ["brixen@gmail.com"]
+  spec.description   = %q{Ruby standard library logger.}
+  spec.summary       = %q{Ruby standard library logger.}
+  spec.homepage      = "https://github.com/rubysl/rubysl-logger"
+  spec.license       = "BSD"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "mspec", "~> 1.5"
+  spec.add_development_dependency "rubysl-prettyprint", "~> 1.0"
+end

data/spec/application/level_spec.rb

@@ -0,0 +1,38 @@
+require File.expand_path('../../fixtures/common', __FILE__)
+
+describe "Logger::Application#level=" do
+  before :each do
+    @file_path = tmp("test_log.log")
+    @log_file = File.open(@file_path, "w+")
+    @app = LoggerSpecs::TestApp.new("TestApp", @log_file)
+
+  end
+
+  after :each do
+    @log_file.close unless @log_file.closed?
+    rm_r @file_path
+  end
+
+  it "sets the logging threshold" do
+    @app.level = Logger::ERROR
+    @app.start
+    @app.log(Logger::WARN, "Don't show me")
+    @app.log(Logger::ERROR, "Show me")
+    @log_file.rewind
+    messages = @log_file.readlines
+    messages.length.should == 1
+    LoggerSpecs::strip_date(messages.first).should == "ERROR -- TestApp: Show me\n"
+  end
+
+  it "can set the threshold to unknown values" do
+    @app.level = 10
+    @app.start
+    @app.log(Logger::INFO,  "Info message")
+    @app.log(Logger::DEBUG, "Debug message")
+    @app.log(Logger::WARN,  "Warn message")
+    @app.log(Logger::ERROR, "Error message")
+    @app.log(Logger::FATAL, "Fatal message")
+    @log_file.rewind
+    @log_file.readlines.should be_empty
+  end
+end

data/spec/application/log_spec.rb

@@ -0,0 +1,72 @@
+require File.expand_path('../../fixtures/common', __FILE__)
+
+describe "Logger::Application#log" do
+  before :each do
+    @file_path = tmp("test_log.log")
+    @log_file = File.open(@file_path, "w+")
+    @app = LoggerSpecs::TestApp.new("TestApp", @log_file)
+    @app.start
+  end
+
+  after :each do
+    @log_file.close unless @log_file.closed?
+    rm_r @file_path
+  end
+
+  it "logs a message" do
+    @app.log(Logger::WARN, "Test message")
+    @log_file.rewind
+    message = @log_file.readlines.last
+    LoggerSpecs::strip_date(message).should == "WARN -- TestApp: Test message\n"
+  end
+
+  it "receives a severity" do
+    @app.log(Logger::INFO,  "Info message")
+    @app.log(Logger::DEBUG, "Debug message")
+    @app.log(Logger::WARN,  "Warn message")
+    @app.log(Logger::ERROR, "Error message")
+    @app.log(Logger::FATAL, "Fatal message")
+    @log_file.rewind
+    messages = @log_file.readlines[3..-1] # remove default messages
+
+    LoggerSpecs::strip_date(messages[0]).should == "INFO -- TestApp: Info message\n"
+    LoggerSpecs::strip_date(messages[1]).should == "DEBUG -- TestApp: Debug message\n"
+    LoggerSpecs::strip_date(messages[2]).should == "WARN -- TestApp: Warn message\n"
+    LoggerSpecs::strip_date(messages[3]).should == "ERROR -- TestApp: Error message\n"
+    LoggerSpecs::strip_date(messages[4]).should == "FATAL -- TestApp: Fatal message\n"
+  end
+
+  it "uses app name for Application Name" do
+    @app.log(Logger::INFO,  "Info message")
+    @log_file.rewind
+    test_message = @log_file.readlines.last
+    Regexp.new(/TestApp/).should =~ LoggerSpecs::strip_date(test_message)
+  end
+
+  it "receives a block and calls it if message is nil" do
+    temp = 0
+    @app.log(Logger::INFO, nil) { temp = 1 }
+    temp.should == 1
+  end
+end
+
+describe "Logger::Application#log=" do
+  before :each do
+    @file_path = tmp("test_log.log")
+    @log_file = File.open(@file_path, "w+")
+    @app = LoggerSpecs::TestApp.new("TestApp", @log_file)
+    @app.start
+  end
+
+  after :all do
+    @log_file.close
+    rm_r @file_path
+  end
+
+  it "sets the log device" do
+    regex = /STDERR Message/
+    @app.log = STDERR
+    lambda { @app.log(Logger::WARN, "STDERR Message") }.should output_to_fd(regex, STDERR)
+  end
+end
+

data/spec/application/new_spec.rb

@@ -0,0 +1,39 @@
+require File.expand_path('../../fixtures/common', __FILE__)
+
+describe "Logger::Application.new" do
+  before :each do
+    @file_path = tmp("test_log.log")
+    @log_file = File.open(@file_path, "w+")
+  end
+
+  after :each do
+    @log_file.close unless @log_file.closed?
+    rm_r @file_path
+  end
+
+  it "starts the logger on a new application" do
+    LoggerSpecs::TestApp.new("TestApp", @log_file).start
+    @log_file.rewind            # go back to the beginning to read the contents
+
+    first, second, third = @log_file.readlines
+    LoggerSpecs::strip_date(first).should  == "INFO -- TestApp: Start of TestApp.\n"
+    LoggerSpecs::strip_date(second).should == "WARN -- TestApp: Test log message\n"
+    LoggerSpecs::strip_date(third).should  == "INFO -- TestApp: End of TestApp. (status: true)\n"
+  end
+
+  it "defaults application name to ''" do
+    LoggerSpecs::TestApp.new(nil, @log_file).start
+    @log_file.rewind
+
+    first, second, third =  @log_file.readlines
+    LoggerSpecs::strip_date(first).should  == "INFO -- : Start of .\n"
+    LoggerSpecs::strip_date(second).should == "WARN -- : Test log message\n"
+    LoggerSpecs::strip_date(third).should  == "INFO -- : End of . (status: true)\n"
+  end
+
+  it "defaults logs to STDERR" do
+    regex = /INFO.*WARN.*INFO.*/m
+    lambda { LoggerSpecs::TestApp.new(nil, nil).start }.should output_to_fd(regex, STDERR)
+    @log_file.rewind
+  end
+end

data/spec/application/set_log_spec.rb

@@ -0,0 +1,20 @@
+require File.expand_path('../../fixtures/common', __FILE__)
+
+describe "Logger::Application#set_log"do
+  before :each do
+    @file_path = tmp("test_log.log")
+    @log_file = File.open(@file_path, "w+")
+    @app = LoggerSpecs::TestApp.new("TestApp", @log_file)
+  end
+
+  after :each do
+    @log_file.close unless @log_file.closed?
+    rm_r @file_path
+  end
+
+  it "sets the log device for the logger" do
+    regex = /STDERR Message/
+    @app.set_log(STDERR)
+    lambda { @app.log(Logger::WARN, "STDERR Message") }.should output_to_fd(regex, STDERR)
+  end
+end

data/spec/application/start_spec.rb

@@ -0,0 +1,32 @@
+require File.expand_path('../../fixtures/common', __FILE__)
+
+describe "Logger::Application#start" do
+  before :each do
+    @file_path = tmp("test_log.log")
+    @log_file = File.open(@file_path, "w+")
+    @app = LoggerSpecs::TestApp.new("TestApp", @log_file)
+  end
+
+  after :each do
+    @log_file.close unless @log_file.closed?
+    rm_r @file_path
+  end
+
+
+  it "starts the application logging start/end messages" do
+    @app.start
+    @log_file.rewind
+    app_start, discard, app_end  = @log_file.readlines
+    LoggerSpecs::strip_date(app_start).should == "INFO -- TestApp: Start of TestApp.\n"
+    LoggerSpecs::strip_date(app_end).should   == "INFO -- TestApp: End of TestApp. (status: true)\n"
+  end
+
+  it "returns the status code" do
+    code = @app.start
+    @log_file.rewind
+    app_end  = @log_file.readlines.last
+    /true/.should =~ LoggerSpecs::strip_date(app_end)
+    code.should == true
+  end
+
+end

data/spec/device/close_spec.rb

@@ -0,0 +1,36 @@
+require File.expand_path('../../fixtures/common', __FILE__)
+
+describe "Logger::LogDevice#close" do
+  before :each do
+    @file_path = tmp("test_log.log")
+    @log_file = File.open(@file_path, "w+")
+
+    # Avoid testing this with STDERR, we don't want to be closing that.
+    @device = Logger::LogDevice.new(@log_file)
+  end
+
+  after :each do
+    @log_file.close unless @log_file.closed?
+    rm_r @file_path
+  end
+
+  ruby_version_is "" ... "1.9" do
+    it "closes the LogDevice's stream" do
+      @device.close
+      lambda { @device.write("Test") }.should raise_error
+    end
+
+    it "raises an error if it's already closed" do
+      @device.close
+      lambda { @device.close }.should raise_error
+    end
+  end
+
+  ruby_version_is "1.9" do
+    it "closes the LogDevice's stream" do
+      @device.close
+      lambda { @device.write("Test") }.should complain(/\Alog writing failed\./)
+    end
+  end
+
+end

data/spec/device/new_spec.rb

@@ -0,0 +1,46 @@
+require File.expand_path('../../fixtures/common', __FILE__)
+
+describe "Logger::LogDevice#new" do
+  before :each do
+    @file_path = tmp("test_log.log")
+    @log_file = File.open(@file_path, "w+")
+  end
+
+  after :each do
+    @log_file.close unless @log_file.closed?
+    rm_r @file_path
+  end
+
+  it "creates a new log device" do
+    l = Logger::LogDevice.new(@log_file)
+    l.dev.should be_kind_of(File)
+  end
+
+  it "receives an IO object to log there as first argument" do
+    @log_file.should be_kind_of(IO)
+    l = Logger::LogDevice.new(@log_file)
+    l.write("foo")
+    @log_file.rewind
+    @log_file.readlines.first.should == "foo"
+  end
+
+  it "creates a File if the IO object does not exist" do
+    path = tmp("test_logger_file")
+    l = Logger::LogDevice.new(path)
+    l.write("Test message")
+    l.close
+
+    File.exist?(path).should be_true
+    File.open(path) do |f|
+      f.readlines.should_not be_empty
+    end
+
+    rm_r path
+  end
+
+  it "receives options via a hash as second argument" do
+    lambda { Logger::LogDevice.new(STDERR,
+                                   { :shift_age => 8, :shift_size => 10
+                                   })}.should_not raise_error
+  end
+end

data/spec/device/write_spec.rb

@@ -0,0 +1,50 @@
+require File.expand_path('../../fixtures/common', __FILE__)
+
+describe "Logger::LogDevice#write" do
+  before  :each do
+    @file_path = tmp("test_log.log")
+    @log_file = File.open(@file_path, "w+")
+    # Avoid testing this with STDERR, we don't want to be closing that.
+    @device = Logger::LogDevice.new(@log_file)
+  end
+
+  after :each do
+    @log_file.close unless @log_file.closed?
+    rm_r @file_path
+  end
+
+  it "writes a message to the device" do
+    @device.write "This is a test message"
+    @log_file.rewind
+    @log_file.readlines.first.should == "This is a test message"
+  end
+
+  it "can create a file and writes empty message" do
+    path = tmp("you_should_not_see_me")
+    logdevice = Logger::LogDevice.new(path)
+    logdevice.write("")
+    logdevice.close
+
+    File.open(path) do |f|
+      messages = f.readlines
+      messages.size.should == 1
+      messages.first.should =~ /#.*/    # only a comment
+    end
+
+    rm_r path
+  end
+
+  ruby_version_is "" ... "1.9" do
+    it "fails if the device is already closed" do
+      @device.close
+      lambda { @device.write "foo" }.should raise_error
+    end
+  end
+
+  ruby_version_is "1.9" do
+    it "fails if the device is already closed" do
+      @device.close
+      lambda { @device.write "foo" }.should complain(/\Alog writing failed\./)
+    end
+  end
+end

data/spec/fixtures/common.rb

@@ -0,0 +1,18 @@
+require 'logger'
+
+module LoggerSpecs
+
+  def self.strip_date(str)
+    str.gsub(/[A-Z].*\[.*\]/, "").lstrip
+  end
+  class TestApp < Logger::Application
+    def initialize(appname, log_file=nil)
+      super(appname)
+      self.set_log(log_file) if log_file
+    end
+
+    def run
+      log(WARN, "Test log message")
+    end
+  end
+end

data/spec/logger/add_spec.rb

@@ -0,0 +1,80 @@
+require File.expand_path('../../fixtures/common', __FILE__)
+
+describe "Logger#add" do
+  before :each do
+    @path = tmp("test_log.log")
+    @log_file = File.open(@path, "w+")
+    @logger = Logger.new(@path)
+  end
+
+  after :each do
+    @logger.close
+    @log_file.close unless @log_file.closed?
+    rm_r @path
+  end
+
+  it "writes a new message to the logger" do
+    @logger.add(Logger::WARN, "Test")
+    @log_file.rewind
+    message = @log_file.readlines.last
+    LoggerSpecs::strip_date(message).should == "WARN -- : Test\n"
+  end
+
+  it "receives a severity" do
+    @logger.log(Logger::INFO,  "Info message")
+    @logger.log(Logger::DEBUG, "Debug message")
+    @logger.log(Logger::WARN,  "Warn message")
+    @logger.log(Logger::ERROR, "Error message")
+    @logger.log(Logger::FATAL, "Fatal message")
+
+    @log_file.rewind
+
+    info, debug, warn, error, fatal = @log_file.readlines
+
+    LoggerSpecs::strip_date(info).should == "INFO -- : Info message\n"
+    LoggerSpecs::strip_date(debug).should == "DEBUG -- : Debug message\n"
+    LoggerSpecs::strip_date(warn).should == "WARN -- : Warn message\n"
+    LoggerSpecs::strip_date(error).should == "ERROR -- : Error message\n"
+    LoggerSpecs::strip_date(fatal).should == "FATAL -- : Fatal message\n"
+  end
+
+  it "receives a message" do
+    @logger.log(nil, "test")
+    @log_file.rewind
+    LoggerSpecs::strip_date(@log_file.readline).should == "ANY -- : test\n"
+  end
+
+  it "receives a program name" do
+    @logger.log(nil, "test", "TestApp")
+    @log_file.rewind
+    LoggerSpecs::strip_date(@log_file.readline).should == "ANY -- TestApp: test\n"
+  end
+
+  it "receives a block" do
+    lambda {
+      @logger.log(nil, "test", "TestApp") do
+        1+1
+      end
+    }.should_not raise_error
+  end
+
+  it "calls the block if message is nil" do
+    temp = 0
+    lambda {
+      @logger.log(nil, nil, "TestApp") do
+        temp = 1+1
+      end
+    }.should_not raise_error
+    temp.should == 2
+  end
+
+  it "ignores the block if the message is not nil" do
+    temp = 0
+    lambda {
+      @logger.log(nil, "not nil", "TestApp") do
+        temp = 1+1
+      end
+    }.should_not raise_error
+    temp.should == 0
+  end
+end