with_locking 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.swp

data/.rvmrc

@@ -0,0 +1,48 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 1.9.3" > .rvmrc
+environment_id="ruby-1.9.3-p125@with_locking"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.10.3" # 1.10.1 seams as a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]] &&
+    \. "${rvm_path:-$HOME/.rvm}/hooks/after_use" || true
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi
+
+# If you use bundler, this might be useful to you:
+# if [[ -s Gemfile ]] && {
+#   ! builtin command -v bundle >/dev/null ||
+#   builtin command -v bundle | grep $rvm_path/bin/bundle >/dev/null
+# }
+# then
+#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
+#   gem install bundler
+# fi
+# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
+# then
+#   bundle install | grep -vE '^Using|Your bundle is complete'
+# fi

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Marty Kraft
+
+MIT License
+
+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,44 @@
+# WithLocking
+
+A gem to execute a block of code and ensure that one does not execute other code until the block has completed executing. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'with_locking'
+
+Or install it yourself as:
+
+    $ gem install with_locking
+
+## Usage
+
+A block of code can be executed like so:
+
+    WithLocking.do { puts "While I'm running other code run through WithLocking cannot run!" }
+
+Alternatively, run the block of code with an optional name (recommended), that way multiple WithLocking blocks with different names can be invoked without conflicting:
+
+    WithLocking.do(:name => "sleeper") { sleep 60 }
+    WithLocking.do(:name => "sleeper") { puts "I won't execute and will return false because 'sleeper' is still running the first block." }
+    WithLocking.do(:name => "other_name") { puts "But I will run because 'other_name' isn't running!" }
+    # => "But I will run because 'other_name' isn't running!"
+
+To simply test if a named block is still running without executing a block use the `locked?` method:
+
+    WithLocking.locked?("sleeper")
+    # => true or false
+
+To raise an exception when the block isn't run (rather than simply returning false), use the `do!` method:
+
+    WithLocking.do!(:name => "sleeper") { puts "Blah" }
+    # => raises an error if 'sleeper' block is still running from before
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/with_locking/version.rb

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

data/lib/with_locking.rb

@@ -0,0 +1,38 @@
+require "with_locking/version"
+
+module WithLocking 
+
+  def self.do(options = {}, &block)
+    raise "No block given" unless block_given?
+
+    name = options[:name] || "locking_service_task"
+    pid_file = "tmp/pids/#{name}.pid"
+      
+    return false if File.exists? pid_file
+
+    begin 
+      Dir.mkdir("tmp")
+      Dir.mkdir("tmp/pids")
+    rescue Errno::EEXIST => e
+      # ignore this error
+    end
+      
+    File.open(pid_file, 'w') { |f| f.puts Process.pid }
+      
+    begin
+      block.call
+    ensure
+      File.delete pid_file
+    end
+    return true
+  end
+
+  def self.do!(options = {}, &block)
+    raise "locked process still running" unless self.do(options, &block)
+  end
+
+  def self.locked?(name)
+    File.exists?("tmp/pids/#{name}.pid")
+  end
+
+end

data/spec/with_locking_spec.rb

@@ -0,0 +1,54 @@
+require_relative '../lib/with_locking.rb'
+
+describe WithLocking do
+  let(:path) { 'tmp/pids/rspec_test.pid' }
+  let(:file_name) { 'rspec_test' }
+
+  before :each do
+    File.stub(:open)
+    File.stub(:delete)
+  end
+
+  describe "#do" do
+
+    it "writes a pid file" do
+      File.should_receive(:open).with(path, "w")
+      WithLocking.do(:name => file_name) { }
+    end
+
+    it "executes the given block" do
+      my_test_array = []
+      WithLocking.do { my_test_array << 1 }
+      my_test_array.count.should == 1
+    end
+
+    it "deletes the pid file" do
+      File.should_receive(:delete).with(path)
+      WithLocking.do(:name => file_name) {}
+    end
+
+    it "should not execute the block if the pid file already exists" do
+      File.stub(:exists?).and_return(true)
+      WithLocking.do {}.should == false
+    end
+
+  end
+
+  describe "#do!" do
+
+    it "raises an exception if the pid file already exists" do
+      File.stub(:exists?).and_return(true)
+      lambda { WithLocking.do! {} }.should raise_error(RuntimeError, 'locked process still running')
+    end
+
+  end
+
+  describe "#locked?" do
+
+    it "checks if the file exists" do
+      File.should_receive(:exists?).with(path)
+      WithLocking.locked?(file_name)
+    end
+
+  end
+end

data/with_locking.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/with_locking/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Marty Kraft"]
+  gem.email         = ["marty.kraft@gmail.com"]
+  gem.description   = %q{A gem to execute a block of code and ensure that one does not execute other code until the block has completed executing.}
+  gem.summary       = %q{Writes a file before executing a given block and then deletes the file when the block has executed. If the file is still there then next time a block is invoked through WithLocking then it is assumed that the first block is still running and the new block isn't executed.}
+  gem.homepage      = "https://github.com/mkraft/with_locking"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "with_locking"
+  gem.require_paths = ["lib"]
+  gem.version       = WithLocking::VERSION
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: with_locking
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Marty Kraft
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-13 00:00:00.000000000 Z
+dependencies: []
+description: A gem to execute a block of code and ensure that one does not execute
+  other code until the block has completed executing.
+email:
+- marty.kraft@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/with_locking.rb
+- lib/with_locking/version.rb
+- spec/with_locking_spec.rb
+- with_locking.gemspec
+homepage: https://github.com/mkraft/with_locking
+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.21
+signing_key: 
+specification_version: 3
+summary: Writes a file before executing a given block and then deletes the file when
+  the block has executed. If the file is still there then next time a block is invoked
+  through WithLocking then it is assumed that the first block is still running and
+  the new block isn't executed.
+test_files:
+- spec/with_locking_spec.rb