flock_mutex 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 888a6f198752055fc6bc7c46e885ebfcc21ac349
+  data.tar.gz: 333e3670b48a3017c70e5930d1a15c32addd6fc6
+SHA512:
+  metadata.gz: 27a764e5620944c9caae5c6ca482c923553c52fbeff737758f5ea84c3438ace2712ea11e91aed21da76d09550349ccc712a938b185a3829528caa88e99fcdb79
+  data.tar.gz: a17a64fd1772525f96f64ef497e7e999b7d5695b3f5138dfec103026fd513d7588de730c5f225bd3e9de6b102b91f7de5f5301f399e684db6ffba16a5eede121

data/.gitignore

@@ -0,0 +1,2 @@
+.DS_Store
+pkg/

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format=nested
+--backtrace

data/README.md

@@ -0,0 +1,35 @@
+# FlockMutex
+
+A very simple ruby mutex class using file lock.
+
+## Usage
+
+```ruby
+require "flock_mutex"
+
+mutex = FlockMutex.new("/tmp/test.lock")
+mutex.lock
+mutex.unlock
+mutex.locked?
+mutex.synchronize {
+  #...
+}
+```
+
+## Examples
+
+```ruby
+# my_app.rb
+
+mutex = FlockMutex.new("/tmp/my_app.lock")
+
+if mutex.locked?
+  puts "Already running"
+  exit false
+end
+```
+
+## Install
+
+    gem install flock_mutex
+

data/lib/flock_mutex.rb

@@ -0,0 +1,28 @@
+class FlockMutex
+  def initialize(path)
+    @file = File.open(path, 'a')
+  end
+  
+  def lock
+    @file.flock(File::LOCK_EX)
+    self
+  end
+  
+  def unlock
+    @file.flock(File::LOCK_UN)
+    self
+  end
+  
+  def synchronize
+    lock
+    yield
+  ensure
+    unlock
+  end
+  
+  def locked?
+    File.open(@file.path, 'a') do |f|
+      ! f.flock(File::LOCK_EX | File::LOCK_NB)
+    end
+  end
+end

data/spec/flock_mutex_spec.rb

@@ -0,0 +1,46 @@
+require "flock_mutex"
+
+describe FlockMutex do
+  
+  it "test locking" do
+    m1 = FlockMutex.new("test.lock")
+    m2 = FlockMutex.new("test.lock")
+    
+    m1.locked?.should be false
+    m2.locked?.should be false
+    
+    m1.lock
+    
+    m1.locked?.should be true
+    m2.locked?.should be true
+    
+    m1.unlock
+    
+    m1.locked?.should be false
+    m2.locked?.should be false
+    
+    m1.lock
+    
+    my_var = 1
+    
+    thread = Thread.new do
+      my_var = m2.synchronize { 2 }
+    end
+    
+    my_var.should be 1
+    
+    m1.unlock
+    
+    thread.join
+    
+    my_var.should be 2
+    
+    m1.locked?.should be false
+    m2.locked?.should be false
+  end
+  
+  after do
+    File.delete("test.lock") rescue nil
+  end
+  
+end

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: flock_mutex
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- Benoit MARTIN-CHAVE
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-22 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- benoitmartinchave@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- README.md
+- lib/flock_mutex.rb
+- spec/flock_mutex_spec.rb
+homepage: http://github.com/BenoitMC/flock_mutex
+licenses:
+- WTFPL
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A very simple ruby mutex class using file lock.
+test_files: []