filelock 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ca5c3766ead1d38142a6a07fff24bb2b84eb1bf8
-  data.tar.gz: 7fa07b19de6de7a852412b07a3425d6992a0fbb2
+  metadata.gz: a4d5bba388f19de54cba97e0af369c8c18764bb5
+  data.tar.gz: 5a42b3b0e31fd1f9b2f02d1f1eef513a9112244e
 SHA512:
-  metadata.gz: cea750b7cf162bb5c7924a442a29acb02cb0ea7a2cd26baa29e3c3227e55a238bcf8ce6cc01bfca1d611f6b43aaa66481a6efeb4b00afea9e5389d62787997d7
-  data.tar.gz: 78f0673ea1fbadc2658c3e455b7d5eadb1eb5b6522313e6944bafc4314ec4d45fbcd5f2633cdefe1a36552d402c7fb06d1dc2a936ed7b4db257ccf22283e5aca
+  metadata.gz: cd10b0613b05bff7c4d9eb70985e9ffe1e3236d9e6a8f84d9d1cc77af3486bc1767c91a0345abfe551924a8d0bce088401c34ce9c0adb681dd663f8f087795d4
+  data.tar.gz: 9d4f60be252ceb0be614e8f6a701493aeff105db1b9e77c3c68c97dfe6d3756a44265985e62f3a3f32d1b593a7ea26afe2a2e73d5901a3eed2ecdfa331b99aec

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+pkg

data/.travis.yml

@@ -1,10 +1,14 @@
+before_install:
+  - gem update bundler
 language: ruby
 script: bundle exec rspec
 rvm:
-  - "1.8.7"
-  - "1.9.3"
-  - "1.9.2"
-  - "2.0.0"
+  - "1.8"
+  - "1.9"
+  - "2.0"
+  - "2.1"
+  - "2.2"
+  - "2.3.0"
   - jruby-19mode
   - jruby-18mode
-  - rbx-19mode
+  - rbx-2

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+# 1.1.0
+
+- Add `:wait` flag for lock-acquiting timeout
+- Add two new timeout exteptions: `FileLock::ExecTimeout` and `FileLock::WaitTimeout`
+
+# 1.0.3
+
+Fix for rubinius
+
+# 1.0.2
+
+Make filelock working for jruby
+
+# 1.0.1
+
+Test and fix more ruby versions

data/README.md

@@ -1,13 +1,15 @@
 # Filelock [![Build Status][travis-img-url]][travis-url]
 
 [travis-img-url]: https://travis-ci.org/sheerun/filelock.png
-[travis-url]: https://travis-ci-org/sheerun/filelock
+[travis-url]: https://travis-ci.org/sheerun/filelock
 
 Heavily tested, but simple filelocking solution using [flock](http://linux.die.net/man/2/flock) command. It guarantees unlocking of files.
 
 It works for sure on MRI 1.8, 1.9, 2.0, JRuby in both 1.8 and 1.9 mode, and Rubinius.
 
-## Usage
+This gem doesn't support NFS. You can use it with [GlusterFS](http://www.gluster.org/), though.
+
+## Basic Usage
 
 ```ruby
 Filelock '/tmp/path/to/lock' do
@@ -15,6 +17,8 @@ Filelock '/tmp/path/to/lock' do
 end
 ```
 
+### Operation Timeout
+
 You can also pass the timeout for blocking operation (default is 60 seconds):
 
 ```ruby
@@ -23,6 +27,20 @@ Filelock '/tmp/path/to/lock', :timeout => 10 do
 end
 ```
 
+You can detect timeout by catching `Filelock::ExecTimeout`.
+
+### Lock Acquiring Timeout
+
+You can also pass a wait timeout for grabbing the lock (default is 1 day):
+
+```ruby
+Filelock '/tmp/path/to/lock', :wait => 3600 do
+  # do blocking operation
+end
+```
+
+You can detect this kind of timeout by catching `Filelock::WaitTimeout`.
+
 Note that lock file directory must already exist, and lock file is not removed after unlock.
 
 ## FAQ
@@ -45,11 +63,9 @@ Lockfile is filelocking solution handling NFS filesystems, based on homemade loc
 
 Cleverua removes lockfile after unlocking it. Thas has been proven fatal both in my tests and in [filelocking advices from the Internet](http://world.std.com/~swmcd/steven/tech/flock.html). You could try find a way to remove lock file without breaking Filelock tests. I will be glad to accept such pull-request.
 
-## Challenge
-
-Please try to break Filelock in some way (note it doesn't support NFS).
+## Contribute
 
-If you show at least one failing test, I'll put your name below:
+Try to break Filelock in some way (note it doesn't support NFS).
 
 ## License
 

data/filelock.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   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 "bundler", "> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
 end

data/lib/filelock.rb

@@ -1,4 +1,6 @@
 require 'filelock/version'
+require 'filelock/exec_timeout'
+require 'filelock/wait_timeout'
 require 'timeout'
 require 'tempfile'
 
@@ -6,16 +8,16 @@ if RUBY_PLATFORM == "java"
   def Filelock(lockname, options = {}, &block)
     lockname = lockname.path if lockname.is_a?(Tempfile)
     File.open(lockname, File::RDWR|File::CREAT, 0644) do |file|
-      Thread.pass until file.flock(File::LOCK_EX)
-      Timeout::timeout(options.fetch(:timeout, 60)) { yield }
+      Thread.pass until Timeout::timeout(options.fetch(:wait, 60*60*24), Filelock::WaitTimeout) { file.flock(File::LOCK_EX) }
+      Timeout::timeout(options.fetch(:timeout, 60), Filelock::ExecTimeout) { yield }
     end
   end
 else
   def Filelock(lockname, options = {}, &block)
     lockname = lockname.path if lockname.is_a?(Tempfile)
     File.open(lockname, File::RDWR|File::CREAT, 0644) do |file|
-      file.flock(File::LOCK_EX)
-      Timeout::timeout(options.fetch(:timeout, 60)) { yield }
+      Timeout::timeout(options.fetch(:wait, 60*60*24), Filelock::WaitTimeout) { file.flock(File::LOCK_EX) }
+      Timeout::timeout(options.fetch(:timeout, 60), Filelock::ExecTimeout) { yield }
     end
   end
 end

data/lib/filelock/exec_timeout.rb

@@ -0,0 +1,7 @@
+module Filelock
+  class ExecTimeout < Timeout::Error
+      def message
+        "Didn't finish executing Filelock block within the timeout specified."
+      end
+  end
+end

data/lib/filelock/version.rb

@@ -1,3 +1,3 @@
 module Filelock
-  VERSION = "1.0.3"
+  VERSION = "1.1.0"
 end

data/lib/filelock/wait_timeout.rb

@@ -0,0 +1,7 @@
+module Filelock
+  class WaitTimeout < Timeout::Error
+      def message
+        "Unable to acquire a file lock within the wait timeout specified."
+      end
+  end
+end

data/spec/filelock_spec.rb

@@ -131,9 +131,53 @@ describe Filelock do
     end
   end
 
+  # Seems like a duplicate but the above test ensures support of the older versions
+  # before Filelock::ExecTimeout existed, while this test is testing the new exception
+  # class.
+  it 'raises Filelock::ExecTimeout exception after specified number of seconds' do
+    Dir.mktmpdir do |dir|
+      lockpath = File.join(dir, 'sample.lock')
+
+      answer = 42
+
+      expect {
+        Filelock lockpath, :timeout => 1 do
+          sleep 2
+          answer = 0
+        end
+      }.to raise_error(Filelock::ExecTimeout)
+
+      expect(answer).to eq(42)
+    end
+  end
+
+
   # Java doesn't support forking
   if RUBY_PLATFORM != 'java'
-    
+
+    it 'times out after lock cannot be acquired within specified number of seconds' do
+      Dir.mktmpdir do |dir|
+        lockpath = File.join(dir, 'sample.lock')
+
+        pid1 = Process.fork do
+          Filelock lockpath do
+            sleep 3
+          end
+        end
+
+        # Give the forked process some time to spin up
+        sleep 1
+
+        expect {
+          Filelock lockpath, :wait => 1 do
+            answer = 0
+          end
+        }.to raise_error(Filelock::WaitTimeout)
+
+        Process.wait
+      end
+    end
+
     it 'should work for multiple processes' do
       write('/tmp/number.txt', '0')
 

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: filelock
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.0
 platform: ruby
 authors:
 - Adam Stankiewicz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-16 00:00:00.000000000 Z
+date: 2016-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>'
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>'
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
@@ -59,15 +59,19 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
 - .rspec
 - .travis.yml
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - filelock.gemspec
 - lib/filelock.rb
+- lib/filelock/exec_timeout.rb
 - lib/filelock/version.rb
+- lib/filelock/wait_timeout.rb
 - spec/filelock_spec.rb
 homepage: http://github.com/sheerun/filelock
 licenses:
@@ -95,4 +99,3 @@ specification_version: 4
 summary: Heavily tested yet simple filelocking solution using flock
 test_files:
 - spec/filelock_spec.rb
-has_rdoc: