just_one_lock 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bd505c4500de6a9d5ac9fca007c2d204bfe2f6a5
+  data.tar.gz: 2817838753a95afe43173d5e867adfb8f9006d8d
+SHA512:
+  metadata.gz: 661c30672498de83b0380075cb0629e9d003ae132c41f906b3a90a171adfb6a0037f95f3fed7720a21fb16a08cddd545701cd26d4a6f4d7aee9046bffbb57439
+  data.tar.gz: ccc5ae6dfde9a056f54d551f2084c7d6796318611ad01ee9c48fc3058ba8decdf4f750c2362128b57829df75ca36b8eec3877d903bb89990baaa066a0ea5f219

data/.bundle/config

@@ -0,0 +1,3 @@
+---
+BUNDLE_PATH: "../gems"
+BUNDLE_DISABLE_SHARED_GEMS: '1'

data/.gitignore

@@ -0,0 +1,2 @@
+*.swp
+tags

data/.rspec

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

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,31 @@
+PATH
+  remote: .
+  specs:
+    just_one_lock (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    rake (10.3.2)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.4)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.4)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  just_one_lock!
+  rake
+  rspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 beorc
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,4 @@
+just_one_lock
+=============
+
+Simple solution to prevent multiple executions using flock

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/just_one_lock.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'just_one_lock/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "just_one_lock"
+  spec.version       = JustOneLock::VERSION
+  spec.authors       = ["Adam Stankiewicz, Yury Kotov"]
+  spec.email         = ["bairkan@gmail.com"]
+  spec.description   = %q{Simple solution to prevent multiple executions using flock}
+  spec.summary       = %q{Simple solution to prevent multiple executions using flock}
+  spec.homepage      = "http://github.com/beorc/just_one_lock"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  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 "rake", '~> 10.3'
+  spec.add_development_dependency "rspec", '~> 3.0'
+end

data/lib/just_one_lock.rb

@@ -0,0 +1,23 @@
+require 'just_one_lock/version'
+require 'timeout'
+
+module JustOneLock
+  def self.filelock(lockname, options = {}, &block)
+    File.open(lockname, File::RDWR|File::CREAT, 0644) do |file|
+      Timeout::timeout(options.fetch(:timeout, 60)) { file.flock(File::LOCK_EX) }
+      yield
+    end
+  end
+
+  def self.prevent_multiple_executions(lock_dir, scope, &block)
+    scope_name = scope.gsub(':', '_')
+    lock_path = File.join(lock_dir, scope_name + '.lock')
+
+    begin
+      return filelock(lock_path, &block)
+    rescue Timeout::Error => e
+      puts "Another process <#{scope}> already is running"
+      exit(1)
+    end
+  end
+end

data/lib/just_one_lock/version.rb

@@ -0,0 +1,3 @@
+module JustOneLock
+  VERSION = "0.0.1"
+end

data/spec/just_one_lock_spec.rb

@@ -0,0 +1,246 @@
+require 'just_one_lock'
+require 'tempfile'
+require 'timeout'
+
+describe JustOneLock do
+
+  # Helper because File.write won't work for older Ruby
+  def write(filename, contents)
+    File.open(filename.to_s, 'w') { |f| f.write(contents) }
+  end
+
+  def parallel(n = 2, templock = nil, &block)
+    Timeout::timeout(5) do
+      templock ||= Tempfile.new(['sample', '.lock'])
+
+      (1..n).map do
+        Thread.new do
+          JustOneLock.filelock(templock, &block)
+        end
+      end.map(&:join)
+    end
+  end
+
+  def parallel_forks(n = 2, templock = nil, &block)
+    Timeout::timeout(5) do
+      templock ||= Tempfile.new(['sample', '.lock'])
+
+      (1..n).map do
+        fork {
+          JustOneLock.filelock(templock, &block)
+        }
+      end.map do |pid|
+        Process.waitpid(pid)
+      end
+    end
+  end
+
+  it 'runs simple ruby block as usual' do
+    Dir.mktmpdir do |dir|
+      lockpath = File.join(dir, 'sample.lock')
+      answer = 0
+
+      JustOneLock.filelock lockpath do
+        answer += 42
+      end
+
+      expect(answer).to eq(42)
+    end
+  end
+
+  it 'returns value returned by block' do
+    Dir.mktmpdir do |dir|
+      lockpath = File.join(dir, 'sample.lock')
+      answer = 0
+
+      answer = JustOneLock.filelock lockpath do
+        42
+      end
+
+      expect(answer).to eq(42)
+    end
+  end
+
+  it 'runs in parallel without race condition' do
+    answer = 0
+
+    parallel(2) do
+      value = answer
+      sleep 0.1
+      answer = value + 21
+    end
+
+    expect(answer).to eq(42)
+  end
+
+  it 'handels high amount of concurrent tasks' do
+    answer = 0
+
+    parallel(100) do
+      value = answer
+      sleep 0.001
+      answer = value + 1
+    end
+
+    expect(answer).to eq(100)
+  end
+
+  it 'creates lock file on disk during block execution' do
+    Dir.mktmpdir do |dir|
+      lockpath = File.join(dir, 'sample.lock')
+      parallel(2, lockpath) do
+        expect(File.exist?(lockpath)).to eq(true)
+      end
+    end
+  end
+
+  it 'runs in parallel without race condition' do
+    Dir.mktmpdir do |dir|
+      lockpath = File.join(dir, 'sample.lock')
+
+      answer = 0
+
+      begin
+        JustOneLock.filelock(lockpath) do
+          raise '42'
+        end
+      rescue RuntimeError
+      end
+
+      JustOneLock.filelock(lockpath) do
+        answer += 42
+      end
+
+      expect(answer).to eq(42)
+    end
+  end
+
+  it 'times out after specified number of seconds' do
+    Dir.mktmpdir do |dir|
+      lockpath = File.join(dir, 'sample.lock')
+
+      answer = 42
+      locked = false
+
+      Thread.new do
+        JustOneLock.filelock lockpath do
+          locked = true
+          sleep 20
+        end
+      end
+
+      Timeout::timeout(1) do
+        while locked == false
+          sleep 0.1
+        end
+      end
+
+      expect do
+        JustOneLock.filelock lockpath, timeout: 0.001 do
+          answer = 0
+        end
+      end.to raise_error(Timeout::Error)
+
+      expect(answer).to eq(42)
+    end
+  end
+
+  # Java doesn't support forking
+  if RUBY_PLATFORM != 'java'
+
+    it 'should work for multiple processes' do
+      write('/tmp/number.txt', '0')
+
+      parallel_forks(6) do
+        number = File.read('/tmp/number.txt').to_i
+        sleep 0.3
+        write('/tmp/number.txt', (number + 7).to_s)
+      end
+
+      number = File.read('/tmp/number.txt').to_i
+
+      expect(number).to eq(42)
+    end
+
+    it 'should handle heavy forking' do
+      write('/tmp/number.txt', '0')
+
+      parallel_forks(100) do
+        number = File.read('/tmp/number.txt').to_i
+        sleep 0.001
+        write('/tmp/number.txt', (number + 1).to_s)
+      end
+
+      number = File.read('/tmp/number.txt').to_i
+
+      expect(number).to eq(100)
+    end
+
+    it 'should unblock files when killing processes' do
+      Dir.mktmpdir do |dir|
+        lockpath = File.join(dir, 'sample.lock')
+
+        Dir.mktmpdir do |dir|
+          pid = fork {
+            JustOneLock.filelock lockpath do
+              sleep 10
+            end
+          }
+
+          sleep 0.5
+
+          answer = 0
+
+          thread = Thread.new {
+            JustOneLock.filelock lockpath do
+              answer += 42
+            end
+          }
+
+          sleep 0.5
+
+          expect(answer).to eq(0)
+          Process.kill(9, pid)
+          thread.join
+
+          expect(answer).to eq(42)
+        end
+      end
+    end
+
+    it 'should handle Pathname as well as string path' do
+      Dir.mktmpdir do |dir|
+        lockpath = Pathname.new(File.join(dir, 'sample.lock'))
+
+        answer = 0
+        JustOneLock.filelock lockpath do
+          answer += 42
+        end
+
+        expect(answer).to eq(42)
+      end
+    end
+
+  end
+
+  # It failed for 1.8.7  (cannot convert to String)
+  it 'works for Tempfile' do
+    answer = 0
+
+    JustOneLock.filelock Tempfile.new(['sample', '.lock']) do
+      answer += 42
+    end
+
+    expect(answer).to eq(42)
+  end
+
+  # If implemented the wrong way lock is created elsewhere
+  it 'creates file with exact path provided' do
+    filename = "/tmp/awesome-lock-#{rand}.lock"
+
+    JustOneLock.filelock filename do
+    end
+
+    expect(File.exist?(filename)).to eq(true)
+  end
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: just_one_lock
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Adam Stankiewicz, Yury Kotov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-28 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
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Simple solution to prevent multiple executions using flock
+email:
+- bairkan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".bundle/config"
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- just_one_lock.gemspec
+- lib/just_one_lock.rb
+- lib/just_one_lock/version.rb
+- spec/just_one_lock_spec.rb
+homepage: http://github.com/beorc/just_one_lock
+licenses:
+- MIT
+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: Simple solution to prevent multiple executions using flock
+test_files:
+- spec/just_one_lock_spec.rb