simple_lockfile 1.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Josh Nesbitt <josh@josh-nesbitt.net>
+
+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/lib/lockfile/lockfile.rb

@@ -0,0 +1,69 @@
+class LockFile
+  attr_accessor :path, :filename
+
+  def initialize(path="/tmp", filename="lockfile.lock")
+    @path, @filename = path, filename
+  end
+  
+  def qualified_path
+    File.join(@path, @filename)
+  end
+  
+  def process_id
+    locked? ? read_lockfile(self.qualified_path).strip.to_i : nil
+  end
+
+  def lock!
+    locked? ? false : create_lockfile(self.qualified_path)
+  end
+
+  def unlock!
+    unlocked? ? false : destroy_lockfile(self.qualified_path)
+  end
+
+  def locked?
+    lockfile_exists?(self.qualified_path)
+  end
+
+  def unlocked?
+    !lockfile_exists?(self.qualified_path)
+  end
+
+  protected
+  def lockfile_exists?(file)
+    File.exists?(file)
+  end
+
+  def create_lockfile(lockfile)
+    begin
+      File.open(lockfile, "w") { |f| f.write(Process.pid) }
+    rescue
+      raise LockFileExists
+    end
+  end
+
+  def read_lockfile(lockfile)
+    begin
+      File.open(lockfile, "r").gets
+    rescue
+      raise LockFileMissing
+    end
+  end
+
+  def destroy_lockfile(lockfile)
+    begin
+      File.delete(lockfile)
+    rescue
+      raise LockFileMissing
+    end
+  end
+
+  public
+  class LockFileError < StandardError
+  end
+  class LockFileExists < LockFileError
+  end  
+  class LockFileMissing < LockFileError
+  end  
+
+end

data/lib/lockfile.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), 'lockfile', 'lockfile')

data/spec/lib/lockfile.rb

@@ -0,0 +1,57 @@
+describe LockFile do
+  
+  before do
+    @lockfile_args = [File.expand_path(File.join(File.dirname(__FILE__), "..", "tmp")), "example.lock"]
+    
+    File.delete(@lockfile_args.join("/")) if File.exists?(@lockfile_args.join("/"))
+  end
+  
+  it "should return a qualified pathname" do
+    @lockfile = LockFile.new(*@lockfile_args)
+    
+    @lockfile.path.should =~ /tmp/
+    @lockfile.filename.should == "example.lock"
+    @lockfile.qualified_path.should =~ /tmp\/example.lock/
+  end
+  
+  it "should have the correct error classes present" do
+    LockFile::LockFileError.ancestors.should include(StandardError)
+    LockFile::LockFileExists.ancestors.should include(StandardError)
+    LockFile::LockFileMissing.ancestors.should include(StandardError)
+  end
+  
+  it "should not initially be locked" do
+    @lockfile = LockFile.new(*@lockfile_args)
+    
+    @lockfile.locked?.should be_false
+  end
+  
+  it "should be able to lock" do
+    @lockfile = LockFile.new(*@lockfile_args)
+    
+    @lockfile.lock!.should be_true
+    @lockfile.locked?.should be_true
+    @lockfile.unlocked?.should be_false
+  end
+  
+  it "should be able to unlock" do
+    @lockfile = LockFile.new(*@lockfile_args)
+    
+    @lockfile.lock!.should be_true
+    @lockfile.locked?.should be_true
+    @lockfile.unlocked?.should be_false
+    @lockfile.unlock!.should be_true
+    @lockfile.locked?.should be_false
+    @lockfile.unlocked?.should be_true
+  end
+  
+  it "should return the process ID of the lockfile if it exists" do
+    @lockfile = LockFile.new(*@lockfile_args)
+    
+    @lockfile.process_id.should be_nil
+    @lockfile.lock!
+    @lockfile.process_id.should_not be_nil
+    @lockfile.process_id.class.should == Fixnum
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require File.join(File.expand_path(File.join(File.dirname(__FILE__), '..')), 'lib', 'lockfile.rb')

data/spec/watch.rb

@@ -0,0 +1,30 @@
+# A simple alternative to autotest that isnt as painful
+puts ">> Watching spec folder for changes..."
+
+options = {
+  :options => "--require 'spec/spec_helper' --format nested --color",
+  :binary => "spec"
+}
+
+watch("lib/(.*)\.rb") do |match|
+  puts %x[ clear ]
+  
+  file   = match[match.size - 1]
+  opts   = options[:options]
+  binary = options[:binary]
+  files  = []
+  
+  %w{ lib }.each do |dir|
+    ["spec/#{dir}/*/*.rb", "spec/#{dir}/*.rb"].each do |glob|
+      Dir.glob(glob).each { |f| files << f }
+    end
+  end
+  
+  puts "Found:"
+  files.each { |f| puts "+ #{f}" }
+  puts ""
+  command = "#{binary} #{files.collect! { |f| File.expand_path(f) }.join(" ")} #{opts}"
+  
+  system(command)
+  
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification 
+name: simple_lockfile
+version: !ruby/object:Gem::Version 
+  version: 1.1.0
+platform: ruby
+authors: 
+- Josh Nesbitt
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-16 00:00:00 +00:00
+default_executable: 
+dependencies: []
+
+description: A simple Lock File implementation.
+email: josh@josh-nesbitt.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+files: 
+- lib/lockfile.rb
+- lib/lockfile/lockfile.rb
+- LICENSE
+has_rdoc: true
+homepage: http://github.com/joshnesbitt/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 
+      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: A simple Lock File implementation.
+test_files: 
+- spec/lib/lockfile.rb
+- spec/spec_helper.rb
+- spec/watch.rb