schleyfox-lockfile 1.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 CleverUA
+
+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.rdoc

@@ -0,0 +1,56 @@
+= lockfile
+
+* http://github.com/cleverua/lockfile
+
+== DESCRIPTION:
+
+This ruby gem allows you create a lock file on disk right before it yields given code block. It would not allow to yield the block again while the first one finished (ie while lock file exists). This gem currently works on UNIX operating systems. This gem should not be used on NFS (http://lwn.net/Articles/251004/)
+
+== USAGE EXAMPLE
+
+=== GENERAL USAGE
+
+  include Lockfile
+  
+  with_lock_file(LOCK_FILE_PATH) do
+    ... code that should not be launched simultaneously 
+  end
+
+=== TO FORCE STOP
+  include Lockfile
+  
+  Lockfile.force_stop(LOCK_FILE_PATH)
+
+== REQUIREMENTS:
+
+* a UNIX operating system
+
+== INSTALL:
+
+  sudo gem install cleverua-lockfile
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2010 CleverUA
+
+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/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "cleverua-lockfile"
+    gem.summary = %Q{Helps you to maintain lock files that indicate that some resource is occupied by an other process}
+    gem.description = %Q{This Ruby gem helps to manage processes in your application so that new process won’t start while the previous one is still running. It uses so known 'lock file' approach to figure out whether a process is running or not.}
+    gem.email = "pavlo@cleverua.com"
+    gem.homepage = "http://github.com/cleverua/lockfile"
+    gem.authors = ["pavlo"]
+    #gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "lockfile #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/lockfile.rb

@@ -0,0 +1,37 @@
+require 'fileutils'
+
+module Lockfile
+
+  def self.ensure_no_lock_file_exists(lock_file_name)
+    FileUtils.remove_file(lock_file_name, true)
+  end
+  
+  def with_lock_file(lock_file_path, write_pid = true)
+    return false unless obtain_lock(lock_file_path, write_pid)
+    begin
+      yield
+    ensure 
+      release_lock(lock_file_path)
+    end
+  end
+  
+  private
+  def obtain_lock(lf, write_pid)
+    File.open(lf, File::CREAT | File::EXCL | File::WRONLY) do |o|
+      o.write(Process.pid) if write_pid
+    end  
+    return true
+  rescue
+    return false
+  end
+  
+  def release_lock(lf)
+    FileUtils.rm(lf, :force => true)
+  end
+  
+  def has_lock?(lock_file_path)
+    return File.exist?(lock_file_path)
+  end
+  
+end
+

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'lockfile'
+
+class Test::Unit::TestCase
+end

data/test/test_lockfile.rb

@@ -0,0 +1,55 @@
+require 'helper'
+
+class TestLockfile < Test::Unit::TestCase
+
+  LOCK_FILE =  File.dirname(__FILE__) + 'test.lock'
+
+  class TestProcess 
+    include Lockfile
+
+    def initialize
+      @launched = false
+    end
+
+    def launch
+      @launched = with_lock_file(LOCK_FILE, false) do
+        sleep 2
+      end
+    end
+
+    def launched?
+      @launched
+    end
+  end
+
+  class Lockfile::File < ::File
+    #slow open down once to demonstrate race condition
+    def self.open(*args)
+      unless @no_sleep
+        @no_sleep = true
+        sleep(1)
+      end
+      super
+    end
+  end
+
+
+  should "not allow to launch other processes while the previous one has lock" do
+    Lockfile.ensure_no_lock_file_exists(LOCK_FILE)
+
+    p1 = TestProcess.new
+    p2 = TestProcess.new
+    p3 = TestProcess.new
+
+    t1 = Thread.new { p1.launch }
+    t2 = Thread.new { p2.launch }
+    t3 = Thread.new { p3.launch }
+
+    t1.join
+    t2.join
+    t3.join
+    
+    #only one should launch
+    assert_equal 1, [p1, p2, p3].select{|i| i.launched? }.size
+  end
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: schleyfox-lockfile
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- pavlo
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-28 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: "This Ruby gem helps to manage processes in your application so that new process won\xE2\x80\x99t start while the previous one is still running. It uses so known 'lock file' approach to figure out whether a process is running or not."
+email: pavlo@cleverua.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/lockfile.rb
+- test/helper.rb
+- test/test_lockfile.rb
+has_rdoc: true
+homepage: http://github.com/cleverua/lockfile
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Because everyone needs their own lockfile implementation. Helps you to maintain lock files that indicate that some resource is occupied by an other process
+test_files: 
+- test/helper.rb
+- test/test_lockfile.rb