single_instance 0.1.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 ICE House AB
+
+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,38 @@
+= SingleInstance
+
+SingleInstance creates a system-wide lock that prevents multiple copies of the
+same code to run at the same time.  We use it to make sure that `cron` jobs
+do not start if an earlier invocation is still running.
+
+    # in Rakefile
+    task :build_models do |t, args|
+      SingleInstance.exclusive_non_blocking(:build_models) do
+        # ...
+      end
+    end
+
+Optionally, the block can be allowed to react to the fact that another process
+is running:
+
+    SingleInstance.exclusive_non_blocking(:build_models) do |blocker|
+      if blocker
+        puts "Cannot run; pid #{blocker.pid} is running since #{blocker.started_at}"
+      else
+        # ...
+      end
+    end
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 ICE House AB. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "single_instance"
+    gem.summary = %Q{Ruby Gem that makes sure that only a single instance of a code block is running.}
+    gem.email = "dev+gemsupport@icehouse.se"
+    gem.homepage = "http://github.com/icehouse/single_instance"
+    gem.authors = ["David Vrensk", "Magnus Enarsson"]
+    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: sudo 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 = "single_instance #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/single_instance.rb

@@ -0,0 +1,30 @@
+require 'tmpdir'
+
+module SingleInstance
+  Blocker = Struct.new :pid, :started_at
+  class << self
+
+    def exclusive_non_blocking(name, &block)
+      lock_file = File.join(Dir::tmpdir, "single_instance_#{name}.pid")
+      File.open(lock_file, "a+") do |file|
+        file.rewind
+        begin
+          if file.flock(File::LOCK_EX|File::LOCK_NB)
+            file.truncate(0)
+            file.puts $$
+            file.puts Time.now.to_i
+            file.flush
+            yield nil
+          elsif block.arity == 1
+            pid = file.readline.to_i
+            started_at = Time.at(file.readline.to_i)
+            yield Blocker.new(pid, started_at)
+          end
+        ensure
+          file.flock(File::LOCK_UN)
+        end
+      end
+    end
+
+  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 'single_instance'
+
+class Test::Unit::TestCase
+end

data/test/test_single_instance.rb

@@ -0,0 +1,47 @@
+require 'helper'
+
+class TestSingleInstance < Test::Unit::TestCase
+
+  context "SingleInstance" do
+    should "only allow one block for each name" do
+      SingleInstance.exclusive_non_blocking(:test) do
+        @block_1 = true
+        SingleInstance.exclusive_non_blocking(:test) do
+          @block_2 = true
+        end
+      end
+      assert @block_1
+      assert @block_2.nil?
+    end
+
+    should "be able to do something intelligent if it didn't get the lock" do
+      SingleInstance.exclusive_non_blocking(:test) do
+        SingleInstance.exclusive_non_blocking(:test) do |blocker|
+          if blocker
+            @no_lock = true
+            @blocker = blocker
+          else
+            @block_2 = true
+          end
+        end
+      end
+      assert @block_2.nil?
+      assert @no_lock
+      assert_equal $$, @blocker.pid
+      assert @blocker.started_at < Time.now
+      assert @blocker.started_at > (Time.now() - 60)
+    end
+
+    should "allow nested blocks with different names" do
+      SingleInstance.exclusive_non_blocking(:test1) do
+        @block_1 = true
+        SingleInstance.exclusive_non_blocking(:test2) do
+          @block_2 = true
+        end
+      end
+      assert @block_1
+      assert @block_2
+    end
+  end
+
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: single_instance
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- David Vrensk
+- Magnus Enarsson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-09 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: dev+gemsupport@icehouse.se
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/single_instance.rb
+- test/helper.rb
+- test/test_single_instance.rb
+has_rdoc: true
+homepage: http://github.com/icehouse/single_instance
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Ruby Gem that makes sure that only a single instance of a code block is running.
+test_files: 
+- test/helper.rb
+- test/test_single_instance.rb