lockit 0.0.0

data/.document

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

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.1"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,20 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.5.1)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    rcov (0.9.9)
+    shoulda (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.1)
+  rcov
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Chris Beer
+
+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,19 @@
+= lockit
+
+A ruby implementation of LockIt: A Simple File-based Convention for Resource Locking
+
+== Contributing to lockit
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2010 Chris Beer. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "lockit"
+  gem.homepage = "http://github.com/cbeer/lockit"
+  gem.license = "MIT"
+  gem.summary = "A ruby implementation of LockIt: A Simple File-based Convention for Resource Locking"
+  gem.email = "chris@cbeer.info"
+  gem.authors = ["Chris Beer"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "lockit #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/TODO

@@ -0,0 +1,3 @@
+- Can a process obtain a lock within a locked file system hierarchy?
+
+- "Once the lock release time has expired, that is, the current time is later than the release time, the lock file is considered stale." .. How should the library distinguish between stale + non-stale lock files? TRUE/FALSE/STALE?

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/bin/lockit

@@ -0,0 +1,27 @@
+#!/usr/bin/ruby
+require 'optparse'
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'lockit'
+
+options = {}
+
+optparse = OptionParser.new do |opts|
+   opts.banner = "Usage: lockit [options] [dir]"
+
+   # This displays the help screen, all programs are
+   # assumed to have this option.
+   opts.on( '-h', '--help', 'Display this screen' ) do
+     puts opts
+     exit
+   end
+end
+
+optparse.parse!
+
+options[:dir] = ARGV.shift
+options[:dir] ||= Dir.pwd
+
+response = LockIt::Dir.new(options[:dir]).lock
+
+exit 1 unless response

data/bin/unlockit

@@ -0,0 +1,27 @@
+#!/usr/bin/ruby
+require 'optparse'
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'lockit'
+
+options = {}
+
+optparse = OptionParser.new do |opts|
+   opts.banner = "Usage: unlock [options] [dir]"
+
+   # This displays the help screen, all programs are
+   # assumed to have this option.
+   opts.on( '-h', '--help', 'Display this screen' ) do
+     puts opts
+     exit
+   end
+end
+
+optparse.parse!
+
+options[:dir] = ARGV.shift
+options[:dir] ||= Dir.pwd
+
+response = LockIt::Dir.new(options[:dir]).unlock
+
+exit 1 unless response

data/lib/lockit.rb

@@ -0,0 +1,87 @@
+require 'fileutils'
+module LockIt
+  FILENAME='lock.txt'
+
+  module Mixin
+    def lock args = {}
+      return false if locked?
+      write_lock args
+      self
+    end
+
+    def revise_lock args
+      return false unless locked?
+      # xxx is it my lock to revise?
+      write_lock args
+      self
+    end
+
+    def try_lock args = {}
+      return false if locked?
+      lock args
+    end
+
+    def locked?
+      return true if closest_lock_file
+      false
+    end
+
+    def unlock
+      unlock!
+    end
+
+    def unlock!
+      FileUtils.rm lock_file
+    end
+
+    def lock_info
+      f = closest_lock_file
+      header, obtained, id, release = open(f).read.split("\n").first.split(" ")
+      info = {}
+      info[:file] = f
+      info[:obtained] = obtained
+      info[:id] = id
+      info[:release] = release if release
+
+      info
+    end
+
+    private
+    def closest_lock_file
+      d = []
+      last = nil
+      while pwd = File.expand_path(File.join([self.path, d].flatten)) and pwd != last
+        f =  File.join(pwd, LockIt::FILENAME)
+	return f if File.exists? f
+	d << '..'
+        last = pwd
+      end
+      return false 
+    end
+
+    def lock_file
+      File.join(self.path, LockIt::FILENAME)
+    end
+    def write_lock args
+      File.open(lock_file, 'w') do |f|
+        f.write(lock_content(args))
+      end
+    end
+
+    def lock_content args
+      s = "Lock: #{Time.now.utc.strftime("%Y-%m-%dT%H:%M:%S+00:00")} #{uniqid}"
+      s += " #{args[:release].utc.strftime("%Y-%m-%dT%H:%M:%S+00:00")}" if args[:release] and args[:release].respond_to? :utc
+      s
+    end
+
+    def uniqid
+      Process.pid
+    end
+
+  end
+
+
+  class Dir < ::Dir
+    include LockIt::Mixin
+  end
+end

data/lockit.gemspec

@@ -0,0 +1,68 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{lockit}
+  s.version = "0.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Chris Beer"]
+  s.date = %q{2010-11-26}
+  s.email = %q{chris@cbeer.info}
+  s.executables = ["lockit", "unlockit"]
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc",
+    "TODO"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "TODO",
+    "VERSION",
+    "bin/lockit",
+    "bin/unlockit",
+    "lib/lockit.rb",
+    "lockit.gemspec",
+    "test/helper.rb",
+    "test/test_lockit.rb"
+  ]
+  s.homepage = %q{http://github.com/cbeer/lockit}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{A ruby implementation of LockIt: A Simple File-based Convention for Resource Locking}
+  s.test_files = [
+    "test/helper.rb",
+    "test/test_lockit.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.1"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'lockit'
+
+class Test::Unit::TestCase
+end

data/test/test_lockit.rb

@@ -0,0 +1,33 @@
+require 'helper'
+
+class MockLockitDir
+  include LockIt::Mixin
+
+  def path
+    '.'
+  end
+
+  def test_lock_content args = {}
+    lock_content args
+  end
+  def test_lock_file
+    lock_file
+  end
+
+
+end
+class TestLockit < Test::Unit::TestCase
+  def test_lock_name
+    d = MockLockitDir.new
+
+    assert_equal(d.test_lock_file, './lock.txt')
+  end
+  def test_lock_content
+    d = MockLockitDir.new
+
+    str = d.test_lock_content
+
+    assert_match /[^ ]+ \d+/, str
+
+  end
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification 
+name: lockit
+version: !ruby/object:Gem::Version 
+  hash: 31
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 0
+  version: 0.0.0
+platform: ruby
+authors: 
+- Chris Beer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-26 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: shoulda
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: bundler
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: jeweler
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 1
+        - 5
+        - 1
+        version: 1.5.1
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  type: :development
+  prerelease: false
+  name: rcov
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id004
+description: 
+email: chris@cbeer.info
+executables: 
+- lockit
+- unlockit
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+- TODO
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- TODO
+- VERSION
+- bin/lockit
+- bin/unlockit
+- lib/lockit.rb
+- lockit.gemspec
+- test/helper.rb
+- test/test_lockit.rb
+has_rdoc: true
+homepage: http://github.com/cbeer/lockit
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: "A ruby implementation of LockIt: A Simple File-based Convention for Resource Locking"
+test_files: 
+- test/helper.rb
+- test/test_lockit.rb