process_lock 0.0.1 → 0.1.0

data/.gitignore

@@ -37,7 +37,7 @@ tmtags
 *~
 
 ## PROJECT::SPECIFIC
-tmp/example*
+tmp/pids/example*
 ,*
 
 # Local ruby version config

data/README.md

@@ -33,6 +33,7 @@ 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
 
 To acquire a lock, do some work and then release it:
 

data/lib/process_lock/version.rb

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

data/lib/process_lock.rb

@@ -13,6 +13,12 @@ class ProcessLock
 
   def initialize(filename)
     @filename = filename
+    if defined?(Rails) and Rails.root and (File.basename(filename) == @filename)
+      @filename = File.join(Rails.root, 'tmp', 'pids', filename)
+      unless filename =~ /\./
+        @filename << '.pid'
+      end
+    end
     FileUtils.touch(@filename)
   end
   

data/spec/process_lock_spec.rb

@@ -5,14 +5,14 @@ require 'fileutils'
 describe 'ProcessLock' do
 
   before(:all) do
-    FileUtils.mkdir_p('tmp')
-    FileUtils.rm_f Dir.glob('tmp/example*.tmp')
+    FileUtils.mkdir_p('tmp/pids')
+    FileUtils.rm_f Dir.glob('tmp/pids/example*.tmp')
   end
 
   describe '#acquire' do
 
     it 'should acquire a lock when called without a block' do
-      p = ProcessLock.new('tmp/example1.txt')
+      p = ProcessLock.new('tmp/pids/example1.txt')
       p.should_not be_owner
       p.acquire.should be_true
       p.should be_owner
@@ -23,7 +23,7 @@ describe 'ProcessLock' do
     end
 
     it 'should acquire a lock when called with a block and then release it' do
-      p = ProcessLock.new('tmp/example2.txt')
+      p = ProcessLock.new('tmp/pids/example2.txt')
       p.should_not be_owner
       did_something = false
       p.acquire do
@@ -47,7 +47,7 @@ describe 'ProcessLock' do
     end
 
     it 'should acquire a lock when called with a block containing a return and then release it' do
-      p = ProcessLock.new('tmp/example3.txt')
+      p = ProcessLock.new('tmp/pids/example3.txt')
       p.should_not be_owner
       acquire_and_then_return_block_value(p) do
         'value returned by block'
@@ -57,7 +57,7 @@ describe 'ProcessLock' do
     end
 
     it 'should not acquire a lock if some other process has the lock' do
-      fn = 'tmp/example4.txt'
+      fn = 'tmp/pids/example4.txt'
       system('bash spec/other_process.sh "%s" 100' % fn)
       p = ProcessLock.new(fn)
       200.times do |i|
@@ -87,7 +87,7 @@ describe 'ProcessLock' do
     end
 
     it 'should acquire a lock if an completed process has the lock' do
-      fn = 'tmp/example5.txt'
+      fn = 'tmp/pids/example5.txt'
       system('bash spec/other_process.sh "%s" 0' % fn)
       p = ProcessLock.new(fn)
       200.times do |i|
@@ -107,7 +107,7 @@ describe 'ProcessLock' do
 
     it 'should allow multiple sequential locked sections' do
       3.times do
-        p = ProcessLock.new('tmp/example6.txt')
+        p = ProcessLock.new('tmp/pids/example6.txt')
         p.should_not be_owner
         did_something = false
         p.acquire do
@@ -122,7 +122,7 @@ describe 'ProcessLock' do
     end
 
     it 'should allow multiple parallel but differently named locked sections' do
-      ps = 3.times.collect { |i| ProcessLock.new('tmp/example7-%d.txt' % i) }
+      ps = 3.times.collect { |i| ProcessLock.new('tmp/pids/example7-%d.txt' % i) }
       did_something = 0
       ps.each do |p|
         p.should_not be_owner
@@ -144,19 +144,19 @@ describe 'ProcessLock' do
   describe '#acquire!' do
 
     it 'should call acquire and expect true' do
-      p = ProcessLock.new('tmp/example8.txt')
+      p = ProcessLock.new('tmp/pids/example8.txt')
       p.stub(:acquire_without_block).and_return(true)
       p.acquire!.should be_true
     end
 
     it 'throw an error if acquire returns false' do
-      p = ProcessLock.new('tmp/example9.txt')
+      p = ProcessLock.new('tmp/pids/example9.txt')
       p.stub(:acquire_without_block).and_return(false)
       expect { p.acquire! }.to raise_error(ProcessLock::AlreadyLocked)
     end
 
     it 'should acquire a lock when called with a block and then release it' do
-      p = ProcessLock.new('tmp/example2.txt')
+      p = ProcessLock.new('tmp/pids/example2.txt')
       p.should_not be_owner
       did_something = false
       p.acquire! do
@@ -175,13 +175,13 @@ describe 'ProcessLock' do
   describe '#release!' do
 
     it 'should call release and expect true' do
-      p = ProcessLock.new('tmp/example10.txt')
+      p = ProcessLock.new('tmp/pids/example10.txt')
       p.stub(:release).and_return(true)
       p.release!.should be_true
     end
 
     it 'throw an error if release returns false' do
-      p = ProcessLock.new('tmp/example11.txt')
+      p = ProcessLock.new('tmp/pids/example11.txt')
       p.stub(:release).and_return(false)
       expect { p.release! }.to raise_error(ProcessLock::NotLocked)
     end
@@ -191,7 +191,7 @@ describe 'ProcessLock' do
   describe '#read' do
 
     it 'should return the current PID if the lock was acquired' do
-      p = ProcessLock.new('tmp/example12.txt')
+      p = ProcessLock.new('tmp/pids/example12.txt')
       p.acquire do
         p.read.should == Process.pid
         p.should be_alive
@@ -200,7 +200,7 @@ describe 'ProcessLock' do
     end
 
     it 'should return whatever number is in the file' do
-      p = ProcessLock.new('tmp/example13.txt')
+      p = ProcessLock.new('tmp/pids/example13.txt')
       File.open(p.filename, 'w') do |f|
         f.puts('314152653')
       end
@@ -211,15 +211,35 @@ describe 'ProcessLock' do
 
   describe '#filename' do
 
-    it 'should return the filename' do
-      fn = 'tmp/example14.txt'
+    class Rails
+      def self.root
+        '.'
+      end
+    end
+
+    it 'should return the path' do
+      fn = 'tmp/pids/example14'
       p = ProcessLock.new(fn)
       p.filename.should == fn
     end
+
+    it 'should return tmp/pids/exampleN.pid for a simple name if Rails.root is set' do
+      fn = 'example14b'
+      Rails.root.should == '.'
+      p = ProcessLock.new(fn)
+      p.filename.should == "./tmp/pids/%s.pid" % fn
+    end
+
+    it 'should return tmp/pids/NAME.ext for NAME.ext if Rails.root is set' do
+      fn = 'example14c.ext'
+      p = ProcessLock.new(fn)
+      p.filename.should == "./tmp/pids/%s" % fn
+    end
+
   end
 
   it 'should use a string for the current PID in filename' do
-    p = ProcessLock.new('tmp/example15.txt')
+    p = ProcessLock.new('tmp/pids/example15.txt')
     p.acquire do
       File.open(p.filename, 'r') do |f|
         contents = f.read

metadata

@@ -1,78 +1,81 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: process_lock
-version: !ruby/object:Gem::Version
-  version: 0.0.1
+version: !ruby/object:Gem::Version 
+  hash: 27
   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.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2014-02-14 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    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
-        version: '0'
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 1
+        - 3
+        version: "1.3"
   type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    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
-        version: '2.0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    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:
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 0
+        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: 
 - ian@heggie.biz
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
 - .rspec
 - .travis.yml
 - Gemfile
-- Gemfile.lock
 - README.md
 - Rakefile
 - lib/process_lock.rb
@@ -83,32 +86,39 @@ files:
 - spec/run_example.sh
 - spec/spec_helper.rb
 homepage: https://github.com/ianheggie/ruby-process-lock
-licenses:
+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
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.6
 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

data/Gemfile.lock

@@ -1,27 +0,0 @@
-PATH
-  remote: .
-  specs:
-    process_lock (0.0.1)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    diff-lcs (1.2.5)
-    rake (10.1.1)
-    rspec (2.14.1)
-      rspec-core (~> 2.14.0)
-      rspec-expectations (~> 2.14.0)
-      rspec-mocks (~> 2.14.0)
-    rspec-core (2.14.7)
-    rspec-expectations (2.14.4)
-      diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.14.4)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.3)
-  process_lock!
-  rake
-  rspec (~> 2.0)