flock_synchronize 1.0.0

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in flock_synchronize.gemspec
+gemspec

data/README.md

@@ -0,0 +1,41 @@
+# FlockSynchronize
+
+This gem allows synchronization of code across multiple processes on POSIX 
+systems using flock, similar to how Mutexes work for Ruby threads.
+
+Wrapping your code in `FlockSynchronize.flock_synchronize` will create a
+filesystem lock for a given string key. All processes synchronized with the
+same key will wait for each other.
+
+For example:
+
+```
+FlockSynchronize.flock_synchronize("mykey") do
+   some_code_that_needs_to_be_synchronized()
+end
+```
+
+**Note**: This only works with multiple processes, and not with multiple Ruby
+threads. If you want the same behaviour with threads, look at the built-in
+Mutex class.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'flock_synchronize'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install flock_synchronize
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/fishpercolator/flock_synchronize
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "flock_synchronize"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/flock_synchronize.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'flock_synchronize/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "flock_synchronize"
+  spec.version       = FlockSynchronize::VERSION
+  spec.authors       = ["Rich Daley"]
+  spec.email         = ["rich@fishpercolator.co.uk"]
+
+  spec.summary       = %q{Simple synchronization between Ruby processes using flock}
+  spec.description   = %q{Adds a flock_synchronize method that synchronizes code execution between processes, similar to how a Mutex works between threads.}
+  spec.homepage      = "https://github.com/fishpercolator/flock_synchronize"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "parallel"
+end

data/lib/flock_synchronize/version.rb

@@ -0,0 +1,3 @@
+module FlockSynchronize
+  VERSION = "1.0.0"
+end

data/lib/flock_synchronize.rb

@@ -0,0 +1,31 @@
+require "flock_synchronize/version"
+require 'tmpdir'
+
+module FlockSynchronize
+    # flock_synchronize wraps a block with a flock-based mutex.
+    #
+    # Any other process calling flock_synchronize with the same key will
+    # wait for the previous block to exit before executing.
+    #
+    # NOTE: This only works on a per-process basis and is not compatible with
+    # Ruby threads. For that, see the built-in Mutex library
+    #
+    #  FlockSynchronize.flock_synchronize("my operation") do
+    #    some.code_that_needs(synchronizing)
+    #  end
+    #
+    # The optional locking_constant parameter allows you to specify a different
+    # constant than LOCK_EX. See the File.flock documentation for more info.
+    #
+    def self.flock_synchronize(key, locking_constant=File::LOCK_EX)
+        filename = File.join(Dir.tmpdir, "#{key}.flock")
+        begin
+            File.open(filename, 'w') do |f|
+                f.flock(locking_constant)
+                yield
+            end
+        ensure
+            File.unlink filename if File.exists? filename
+        end
+    end
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: flock_synchronize
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Rich Daley
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-10-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: parallel
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Adds a flock_synchronize method that synchronizes code execution between
+  processes, similar to how a Mutex works between threads.
+email:
+- rich@fishpercolator.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- flock_synchronize.gemspec
+- lib/flock_synchronize.rb
+- lib/flock_synchronize/version.rb
+homepage: https://github.com/fishpercolator/flock_synchronize
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Simple synchronization between Ruby processes using flock
+test_files: []