admit_one 0.1.0 → 0.2.2

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2011 Jonathan S. Garvin (http://www.5valleys.com)
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,7 +1,7 @@
 AdmitOne
 ========
 
-A Ruby lock file manager that is immune to race conditions.
+A Ruby lock file manager that is highly resistant, if not outright immune, to race conditions.
 
 Usage
 -----
@@ -11,7 +11,7 @@ Usage
         # code that needs to run with confidence
         # that the same code isn't also running
         # at the same time in another process
-      rescue AdmitOne::LockFileAlreadyExists
+      rescue AdmitOne::LockFailure
         # gracefully recover if the lock could not
         # be established
       end
@@ -55,19 +55,18 @@ append mode. If the file doesn't already exist, it creates it and then opens
 it. Otherwise it just opens it. Then, any writes to the file are appended
 to the end. Two processes can open and write to the file at the same time.
 
-AdmitOne writes the process id to the file, closes the file and then reopens
-it, this time in read mode, to compare it's process id with the one on the
-first line in the file. In the event of a race condition, two process ids
-will be written to the file (remember, append mode), but *only one* can
-possibly be on the first line.
-
-The first process will reopen the lock file in read mode, compare it's process
-id with the one on the first line, see that they match, and only then
-execute your block of code that needed a lock. The second process also opens
-the file, but it will see that the process id on the first line does *not*
-match it's own, and instead of executing the code block, will raise an
-exception for your application to catch and handle gracefully according to
-your preferences (such as trying again later, or triggering a missile launch).   
+AdmitOne appends the process id to the end of file, then reads the first
+line in file to compare it's process id with the one on the first line.
+In the event of a race condition, two process ids will be written to the
+file (remember, append mode), but *only one* can possibly be on the first
+line.
+
+The first process will confirm that it's process id is on the first line,
+and only then execute your block of code that needed a lock. The second
+process will see that the process id on the first line does *not* match
+it's own, and instead of executing the code block, will raise an exception
+for your application to catch and handle gracefully according to your
+preferences (such as trying again later, or triggering a missile launch).
 
 Contributions
 -------------

data/admit_one.gemspec

@@ -7,8 +7,8 @@ Gem::Specification.new do |s|
   s.authors     = ["Jonathan S. Garvin"]
   s.email       = ["jon@5valleys.com"]
   s.homepage    = "https://github.com/jsgarvin/admit_one"
-  s.summary     = %q{Lock file manager.}
-  s.description = %q{Lock file manager that is immune to race conditions.}
+  s.summary     = %q{Race resistant lock file manager.}
+  s.description = %q{Ruby lock file manager that is highly resistant, if not outright immune, to race conditions.}
 
   s.rubyforge_project = "admit_one"
 

data/lib/admit_one/lock_file.rb

@@ -1,42 +1,52 @@
 module AdmitOne
-    
+  
   class LockFile
     require 'tempfile'
     
-    attr_accessor :filename
+    attr_accessor :name, :lock_file
     
     def initialize(name,&block)
-      @filename = "#{name}.lock"
-      begin
-        lock!
-        yield
-      ensure
-        unlock!
+      @name = name
+      if lock! then
+        begin
+          yield
+        ensure
+          unlock!
+        end
       end
     end
     
+    #######
+    private
+    #######
+    
     def full_path
-      "#{Dir.tmpdir}/#{filename}"
+      "#{Dir.tmpdir}/#{name}.lock"
     end
     
     def lock!
-      File.open(full_path, "a") { |file| file.write("#{Process.pid}\n") }
-      raise LockFileAlreadyExists unless lock_file_acquired?
+      @lock_file = File.open(full_path, "a+")
+      lock_file.write("#{Process.pid}\n")
+      lock_file.flush
+      lock_file.rewind
+      raise(LockFailure,'already locked by other process') unless lock_file.gets.to_i == Process.pid
+      return true
     end
     
     def unlock!
+      lock_file.close
       begin
-        File.delete(full_path) if lock_file_acquired? 
+        File.delete(full_path)
       rescue
-        raise LockFileMissing
+        # This should never happen. It would indicate that another process deleted
+        # a lock file that it didn't rightfully own, or that a user deleted it manually
+        # before this process completed. 
+        raise LockFileMissing, 'Lockfile unexpectedly vanished! This should probably be investigated!'
       end
     end
     
-    def lock_file_acquired?
-      File.open(full_path, "r") { |file| file.gets.to_i == Process.pid }
-    end
   end
   
-  class LockFileAlreadyExists < StandardError; end
+  class LockFailure < StandardError; end
   class LockFileMissing < StandardError; end
 end

data/lib/admit_one/version.rb

@@ -1,3 +1,3 @@
 module AdmitOne
-  VERSION = '0.1.0'
+  VERSION = '0.2.2'
 end

data/test/unit/lock_file_test.rb

@@ -8,15 +8,18 @@ class LockFileTest < Test::Unit::TestCase
   end
   
   def test_should_create_and_remove_lockfile
+    block_executed = false
     AdmitOne::LockFile.new(:admit_one_lock_file_unit_test) do
+      block_executed = true
       assert(File.exist?(lock_file_path))
     end
+    assert(block_executed)
     assert(!File.exist?(lock_file_path))
   end
   
   def test_should_not_clobber_another_lock_file
     File.open(lock_file_path, "a") { |file| file.write("1\n") }
-    assert_raise(AdmitOne::LockFileAlreadyExists) do
+    assert_raise(AdmitOne::LockFailure) do
       AdmitOne::LockFile.new(:admit_one_lock_file_unit_test) do
         assert false #should never run
       end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 0
-  version: 0.1.0
+  - 2
+  - 2
+  version: 0.2.2
 platform: ruby
 authors: 
 - Jonathan S. Garvin
@@ -14,11 +14,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-19 00:00:00 -06:00
+date: 2011-05-21 00:00:00 -06:00
 default_executable: 
 dependencies: []
 
-description: Lock file manager that is immune to race conditions.
+description: Ruby lock file manager that is highly resistant, if not outright immune, to race conditions.
 email: 
 - jon@5valleys.com
 executables: []
@@ -29,6 +29,7 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
+- LICENSE
 - README.md
 - Rakefile
 - admit_one.gemspec
@@ -46,7 +47,6 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
@@ -54,7 +54,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
@@ -64,9 +63,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: admit_one
-rubygems_version: 1.3.7
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
-summary: Lock file manager.
+summary: Race resistant lock file manager.
 test_files: 
 - test/unit/lock_file_test.rb