pidlock 0.0.2 → 0.1.0

data/lib/pidlock.rb

@@ -1,13 +1,21 @@
+require 'logger'
+
 class Pidlock
 
+  attr_accessor :logger
 
   class FileLockedException < Exception; end
   class ProcessRunning < Exception; end
+  
   def initialize(name)
+    dir = File.dirname(name)
     @name = File.basename(name)
-    @filename = File.join('/', 'var', 'run', @name)
+    @filename = File.expand_path(File.join('/', 'var', 'run', dir, @name))
+    @logger = Logger.new(STDERR)
   end
 
+
+
   def lock
     unless @file
       unless (File.writable?(File.dirname(@filename)))
@@ -18,7 +26,7 @@ class Pidlock
         if (old_process = Sys::ProcTable.ps(old_pid.chomp.to_i))
           raise ProcessRunning if old_process.comm == File.basename(@name, File.extname(@name))
         else
-          STDERR.puts "WARNING: resetting stale lockfile"
+          @logger.warn "WARNING: resetting stale lockfile"
           @file.rewind
         end
       end

data/spec/lib/pidlock_spec.rb

@@ -1,6 +1,7 @@
 require 'spec_helper'
 
 describe Pidlock do
+  let(:logger) { mock(Logger) }
   before(:each) do
     @file = stub(File)
     @file.stub(:flock)
@@ -10,38 +11,46 @@ describe Pidlock do
     @file.stub(:gets)
     File.stub(:open).with('/var/run/my.pid', 'w+').and_return(@file)
     File.stub(:writable?).with('/var/run').and_return(true)
+    Logger.stub!(:new => logger)
   end
-  it "should create a file with the given name in /var/run" do
+  it "creates a file with the given name in /var/run" do
     Pidlock.new('my.pid').lock
   end
   context "filehandling" do
     before(:each) do
       Process.stub(:pid).and_return(666)
+      logger.stub!(:warn)
     end
-    it "should write the current pid to the file" do
+    it "writes the current pid to the file" do
       @file.should_receive(:write).with(666)
       Pidlock.new('my.pid').lock
     end
+    it "uses a directory under /var/run if given" do
+      File.should_receive(:open).with("/var/run/my/my.pid", 'w+').and_return(@file)
+      File.should_receive(:writable?).with("/var/run/my").and_return(true)
+      @file.should_receive(:write).with(666)
+      Pidlock.new('my/my.pid').lock
+    end
 
-    it "should try to lock the file" do
+    it "tries to lock the file" do
       @file.should_receive(:flock).with( File::LOCK_EX | File::LOCK_NB).and_return(0)
       Pidlock.new('my.pid').lock
     end
 
-    it "should raise if the lock does not succeed" do
+    it "raises if the lock does not succeed" do
       @file.should_receive(:flock).with( File::LOCK_EX | File::LOCK_NB).and_return(false)
       lambda {
         Pidlock.new('my.pid').lock
       }.should raise_error Pidlock::FileLockedException
     end
 
-    it "should check if the program name matches the id" do
+    it "checks if the program name matches the id" do
       @file.should_receive(:gets).and_return('666')
       ps = stub("ProcTableStruct", :comm => 'test')
       ::Sys::ProcTable.should_receive(:ps).with(666).and_return(ps)
       Pidlock.new('my.pid').lock
     end
-    it "should raise if the program name does match the pid" do
+    it "raises if the program name does match the pid" do
       @file.should_receive(:gets).and_return('666')
       ps = stub("ProcTableStruct", :comm => 'my')
       ::Sys::ProcTable.should_receive(:ps).with(666).and_return(ps)
@@ -50,21 +59,32 @@ describe Pidlock do
       }.should raise_error Pidlock::ProcessRunning
     end
 
-    it "should use /tmp if /var/run is not writeable" do
+    it "uses /tmp if /var/run is not writeable" do
       File.should_receive(:writable?).with('/var/run').and_return(false)
       File.should_receive(:open).with('/tmp/my.pid', 'w+').and_return(@file)
       Pidlock.new('my.pid').lock
-
     end
-    it "should warn but continue if the file exists but the process name does not" do
+    it "warns but continue if the file exists but the process name does not" do
       @file.should_receive(:gets).and_return('667')
       ps = stub("ProcTableStruct", :comm => 'test')
       ::Sys::ProcTable.should_receive(:ps).with(667).and_return(nil)
-      STDERR.should_receive(:puts).with('WARNING: resetting stale lockfile')
+      logger.should_receive(:warn).with('WARNING: resetting stale lockfile')
       @file.should_receive(:rewind)
       @file.should_receive(:write).with(666)
       Pidlock.new('my.pid').lock
-
+    end
+    it "should use a logger if injected" do
+      logger2 = mock(Logger)
+      @file.should_receive(:gets).and_return('667')
+      ps = stub("ProcTableStruct", :comm => 'test')
+      ::Sys::ProcTable.should_receive(:ps).with(667).and_return(nil)
+      logger.should_not_receive(:warn).with('WARNING: resetting stale lockfile')
+      logger2.should_receive(:warn).with('WARNING: resetting stale lockfile')
+      @file.should_receive(:rewind)
+      @file.should_receive(:write).with(666)
+      pidlock = Pidlock.new('my.pid')
+      pidlock.logger = logger2
+      pidlock.lock
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pidlock
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,19 +9,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-28 00:00:00.000000000Z
+date: 2012-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sys-proctable
-  requirement: &16613480 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: 0.9.2
   type: :runtime
   prerelease: false
-  version_requirements: *16613480
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
 description: Used for locking processes via PID and file (daemon style).
 email: anton.bangratz@gmail.com
 executables: []
@@ -53,8 +58,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Using PID/file locking for daemons and long running tasks made easy.
 test_files: []
+has_rdoc: