process_lock 0.1.0 → 0.1.1

data/README.md

@@ -1,8 +1,9 @@
 # ProcessLock
 
 A simple class to acquire and check process-id file based locks on a unix filesystem.
+Can also be used to see if a process is already running or designate a master process when running concurrent applications.
 
-[![Build Status](https://travis-ci.org/ianheggie/ruby-process-lock.png?branch=master)](https://travis-ci.org/ianheggie/ruby-process-lock)
+[![Build Status](https://travis-ci.org/ianheggie/process_lock.png?branch=master)](https://travis-ci.org/ianheggie/process_lock)
 
 ## Installation
 
@@ -21,7 +22,7 @@ Or install it yourself as:
 ## Usage
 
 Create an instance of ProcessLock with a filename as the lock.
-You may have more than one lock per process.
+You may have more than one lock (with different names) per process.
 
 Methods:
 * acquire - Acquires a lock if it can. Returns true (or value of block if block is passed) if a lock was acquired, otherwise false.
@@ -33,11 +34,11 @@ Methods:
 
 Note:
 * locks don't stack - if we have already acquired the lock subsequent calls will reacquire the lock. releasing an already released lock will fail.
-* If Rails.root is defined then lock files will be put in tmp/pids, and have .pid appended if no extension is specified
+* If Rails.root is defined then lock files without path separators (/) will be put in tmp/pids. If no extension is specified then .pid will be appended.
 
 To acquire a lock, do some work and then release it:
 
-    pl = ProcessLock.new('tmp/name_of_lock.pid')
+    pl = ProcessLock.new('tmp/name_of_lock.lock')
 
     acquired = pl.acquire do
       puts "Do some work!"
@@ -53,74 +54,23 @@ To acquire a lock, do some work and then release it:
     puts "Do some work!"
     pl.release
 
+To allow many worker processes to self organise and identify a leader process. (Simon and my implementation have diverged).
 
-Example:
-
-irb - run first
-
-    >> require 'process_lock'
-    => true
-    >> Process.pid
-    => 16568
-    >> p = ProcessLock.new('tmp/example.tmp')
-    => #<ProcessLock:0x00000001489c10 @filename="tmp/example.tmp">
-    >> p.alive?
-    => false
-    >> p.owner?
-    => false
-    >> p.read
-    => 0
-
-    >> p.acquire!
+    IRB 1>>
+    pl = ProcessLock.new('example.tmp')
+    pl.acquire
     => true
+    pl.read
+    => "2435"
 
-    >> p.alive?
-    => true
-    >> p.owner?
-    => true
-    >> p.read
-    => 16568
-    >> sleep(10)
-    => 10
-    >> p.release!
-    => true
-    >> p.alive?
-    => false
-    >> p.owner?
-    => false
-    >> p.read
-    => 0
-
-2nd irb, run after first has acquired the lock
-
-    >> require 'process_lock'
-    => true
-    >> Process.pid
-    => 16569
-    >> q = ProcessLock.new('tmp/example.tmp')
-    => #<ProcessLock:0x000000026e4090 @filename="tmp/example.tmp">
-    >> q.alive?
-    => true
-    >> q.owner?
-    => false
-    >> q.read
-    => 16568
-
-    >> q.acquire!
-    ProcessLock::AlreadyLocked: Unable to acquire lock
-            from /home/ianh/Projects/Github/ruby-process-lock/lib/process_lock.rb:28:in `acquire!'
-            from (irb):7
-            from /home/ianh/.rbenv/versions/1.9.3-p484/bin/irb:12:in `<main>'
-
-    >> q.alive?
-    => true
-    >> q.owner?
+    IRB 2>>
+    pl = ProcessLock.new('example.tmp')
+    pl.acquire
     => false
-    >> q.read
-    => 16568
-    >>
+    pl.read
+    => "2435"
 
-example.tmp will contain the pid of the running process
+example.tmp will contain the pid of the leader process
 
 ## Contributing
 
@@ -132,7 +82,7 @@ example.tmp will contain the pid of the running process
 
 ## License and contributions
 
-* Based on work Copyright (c) 2008 Simon Engledew, released under the MIT license.
-* Subsequent work by Ian Heggie: packaged into a gem, added tests and acquire method, fixed acquire so it didn't overwrite locks by other processes.
+* Copyright (c) 2008 Simon Engledew, released under the MIT license: https://github.com/simon-engledew/ruby-process-lock .
+* Subsequent work by Ian Heggie: packaged into a gem, added tests and acquire method, fixed some bugs.
 * See git log for other contributers
 

data/lib/process_lock/version.rb

@@ -1,3 +1,3 @@
 class ProcessLock
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/process_lock.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["ian@heggie.biz"]
   spec.description   = %q{A simple class to aquire and check process-id file based locks on a unix filesystem.}
   spec.summary       = %q{Use process lock to see if a process is already running or designate a master process when running concurrent applications.}
-  spec.homepage      = "https://github.com/ianheggie/ruby-process-lock"
+  spec.homepage      = "https://github.com/ianheggie/process_lock"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)

metadata

@@ -1,77 +1,73 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: process_lock
-version: !ruby/object:Gem::Version 
-  hash: 27
+version: !ruby/object:Gem::Version
+  version: 0.1.1
   prerelease: 
-  segments: 
-  - 0
-  - 1
-  - 0
-  version: 0.1.0
 platform: ruby
-authors: 
+authors:
 - Simon Engledew
 - Ian Heggie
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2014-02-14 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2014-02-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: bundler
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 9
-        segments: 
-        - 1
-        - 3
-        version: "1.3"
+      - !ruby/object:Gem::Version
+        version: '1.3'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 2
-        - 0
-        version: "2.0"
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :development
-  version_requirements: *id003
-description: A simple class to aquire and check process-id file based locks on a unix filesystem.
-email: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: A simple class to aquire and check process-id file based locks on a unix
+  filesystem.
+email:
 - ian@heggie.biz
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .rspec
 - .travis.yml
@@ -85,40 +81,33 @@ files:
 - spec/process_lock_spec.rb
 - spec/run_example.sh
 - spec/spec_helper.rb
-homepage: https://github.com/ianheggie/ruby-process-lock
-licenses: 
+homepage: https://github.com/ianheggie/process_lock
+licenses:
 - MIT
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.6
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: Use process lock to see if a process is already running or designate a master process when running concurrent applications.
-test_files: 
+summary: Use process lock to see if a process is already running or designate a master
+  process when running concurrent applications.
+test_files:
 - spec/other_process.sh
 - spec/process_lock_spec.rb
 - spec/run_example.sh