lockit 0.0.0 → 0.1.1

data/.gitignore

@@ -0,0 +1,16 @@
+# rcov generated
+coverage
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+# jeweler generated
+pkg
+Gemfile.lock

data/.rvmrc

@@ -0,0 +1 @@
+rvm use ree@lockit --create

data/Gemfile

@@ -1,13 +1,3 @@
 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
+gemspec

data/Gemfile.lock

@@ -1,20 +1,31 @@
+PATH
+  remote: .
+  specs:
+    lockit (0.1.1)
+
 GEM
   remote: http://rubygems.org/
   specs:
-    git (1.2.5)
-    jeweler (1.5.1)
-      bundler (~> 1.0.0)
-      git (>= 1.2.5)
-      rake
+    diff-lcs (1.1.2)
     rake (0.8.7)
     rcov (0.9.9)
-    shoulda (2.11.3)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    yard (0.7.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.0.0)
-  jeweler (~> 1.5.1)
+  bundler
+  lockit!
+  rake
   rcov
-  shoulda
+  rspec
+  yard

data/LICENSE.txt

@@ -1,20 +1,12 @@
-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.
+###########################################################################
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.

data/Rakefile

@@ -8,45 +8,40 @@ rescue Bundler::BundlerError => e
   exit e.status_code
 end
 require 'rake'
+require 'rspec'
+require 'rspec/core/rake_task'
 
-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'
+RSpec::Core::RakeTask.new() do |t|
+  t.pattern = "./spec/*_spec.rb" # don't need this, it's default.
+  t.rcov = true
+  t.rcov_opts = ['--exclude', 'spec', '--exclude', 'gems']
 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
+desc "Generate code coverage"
+RSpec::Core::RakeTask.new(:rcov) do |t|
+  t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
+  t.rcov = true
+  t.rcov_opts = ['--exclude', 'spec', '--exclude', 'gems']
 end
 
-require 'rcov/rcovtask'
-Rcov::RcovTask.new do |test|
-  test.libs << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-end
-
-task :default => :test
+task :default => :rcov
+task :hudson => [:rcov, :doc]
 
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+# Use yard to build docs
+begin
+  require 'yard'
+  require 'yard/rake/yardoc_task'
+  project_root = File.expand_path(File.dirname(__FILE__))
+  doc_destination = File.join(project_root, 'doc')
 
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "lockit #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+  YARD::Rake::YardocTask.new(:doc) do |yt|
+    yt.files   = Dir.glob(File.join(project_root, 'lib', '**', '*.rb')) + 
+                 [ File.join(project_root, 'README.textile') ]
+    yt.options = ['--output-dir', doc_destination, '--readme', 'README.rdoc']
+  end
+rescue LoadError
+  desc "Generate YARD Documentation"
+  task :doc do
+    abort "Please install the YARD gem to generate rdoc."
+  end
+end

data/lib/lockit/version.rb

@@ -0,0 +1,3 @@
+module LockIt
+  VERSION = "0.1.1"
+end

data/lib/lockit.rb

@@ -3,12 +3,15 @@ module LockIt
   FILENAME='lock.txt'
 
   module Mixin
+    
+    # Lock the directory
     def lock args = {}
       return false if locked?
       write_lock args
       self
     end
 
+    # @param DateTime :release When will this lock likely be released? 
     def revise_lock args
       return false unless locked?
       # xxx is it my lock to revise?
@@ -16,6 +19,8 @@ module LockIt
       self
     end
 
+    # If the directory is locked already, return false
+    # Otherwise, lock the directory
     def try_lock args = {}
       return false if locked?
       lock args
@@ -47,6 +52,8 @@ module LockIt
     end
 
     private
+    
+    # return the path to the closest lock file in this directory
     def closest_lock_file
       d = []
       last = nil
@@ -62,6 +69,7 @@ module LockIt
     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))

data/lockit.gemspec

@@ -1,68 +1,28 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "lockit/version"
 
 Gem::Specification.new do |s|
-  s.name = %q{lockit}
-  s.version = "0.0.0"
+  s.name        = %q{lockit}
+  s.version     = LockIt::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Chris Beer", "Bess Sadler"]
+  s.email       = %q{chris@cbeer.info}
+  s.homepage    = "https://github.com/microservices/lockit"
+  s.summary     = %q{A ruby implementation of LockIt: A Simple File-based Convention for Resource Locking}
+  s.description = %q{A ruby implementation of LockIt: A Simple File-based Convention for Resource Locking}
 
-  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.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   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
+  
+  
+  # Bundler will install these gems too if you've checked this out from source from git and run 'bundle install'
+  # It will not add these as dependencies if you require lyber-core for other projects
+  s.add_development_dependency "rake"
+  s.add_development_dependency "bundler"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency 'rcov'
+  s.add_development_dependency 'yard'
 end
-

data/spec/lockit_spec.rb

@@ -0,0 +1,104 @@
+require File.join(File.dirname(__FILE__), "..", "lib", "lockit.rb")
+require 'tmpdir'
+require 'rspec'
+
+describe LockIt::Dir do
+  
+  describe "locking and unlocking" do
+    
+    it "is unlocked by default" do
+      Dir.mktmpdir do |d|
+        lockit_dir = LockIt::Dir.new(d)
+        lockit_dir.locked?.should eql(false)
+      end
+    end
+
+    it "can be locked and unlocked" do
+      Dir.mktmpdir do |d|      
+        lockit_dir = LockIt::Dir.new(d)
+        lockit_dir.lock
+        lockit_dir.locked?.should eql(true)
+        lockit_dir.unlock
+        lockit_dir.locked?.should eql(false)
+      end
+    end
+    
+  end
+  
+  describe "#try_lock" do
+        
+    it "tries the lock & returns false if it is already locked" do
+      Dir.mktmpdir do |d|      
+        lockit_dir = LockIt::Dir.new(d)
+        lockit_dir.lock
+        lockit_dir.try_lock.should eql(false)
+      end
+    end
+    
+    it "tries the lock & unlocks the dir if it isn't yet locked" do
+      Dir.mktmpdir do |d|      
+        lockit_dir = LockIt::Dir.new(d)
+        lockit_dir.try_lock
+        lockit_dir.locked?.should eql(true)
+      end
+    end
+    
+  end
+  
+  describe "#lock_info" do
+    
+    it "knows the location of the lockfile" do
+      Dir.mktmpdir do |d|      
+        lockit_dir = LockIt::Dir.new(d)
+        lockit_dir.try_lock
+        info = lockit_dir.lock_info
+        info[:file].should eql("#{d}/#{LockIt::FILENAME}")
+      end
+    end
+    
+    it "knows when it was created" do
+      Dir.mktmpdir do |d|      
+        lockit_dir = LockIt::Dir.new(d)
+        lockit_dir.try_lock
+        info = lockit_dir.lock_info
+        obtained = DateTime.parse(info[:obtained])
+        obtained.should be_instance_of(DateTime)
+      end
+    end
+    
+  end
+  
+  describe "#revise_lock" do
+    
+    it "returns false if called on an unlocked directory" do
+      Dir.mktmpdir do |d|      
+        lockit_dir = LockIt::Dir.new(d)
+        lockit_dir.locked?.should eql(false)
+        release_time = Time.now + 60
+        lockit_dir.revise_lock(:release => release_time).should eql(false)
+      end
+    end
+    
+    it "adds a release time to a locked directory" do
+      Dir.mktmpdir do |d|      
+        lockit_dir = LockIt::Dir.new(d)
+        lockit_dir.lock
+        lockit_dir.locked?.should eql(true)
+        release_time = Time.now + 60
+        lockit_dir.revise_lock(:release => release_time)
+        @info = lockit_dir.lock_info
+        DateTime.parse(@info[:release]).should be_instance_of(DateTime)
+      end
+    end
+    
+    it "reports its release time" do
+      @pending
+    end
+    
+    it "reports if no release time has been set" do
+      @pending
+    end
+    
+  end
+
+end

metadata

@@ -1,28 +1,28 @@
 --- !ruby/object:Gem::Specification 
 name: lockit
 version: !ruby/object:Gem::Version 
-  hash: 31
-  prerelease: false
+  hash: 25
+  prerelease: 
   segments: 
   - 0
-  - 0
-  - 0
-  version: 0.0.0
+  - 1
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Chris Beer
+- Bess Sadler
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-11-26 00:00:00 -05:00
+date: 2011-06-09 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  type: :development
+  name: rake
   prerelease: false
-  name: shoulda
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -31,44 +31,54 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  requirement: *id001
-- !ruby/object:Gem::Dependency 
   type: :development
-  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   name: bundler
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
-        hash: 23
+        hash: 3
         segments: 
-        - 1
         - 0
-        - 0
-        version: 1.0.0
-  requirement: *id002
-- !ruby/object:Gem::Dependency 
+        version: "0"
   type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
   prerelease: false
-  name: jeweler
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
-        hash: 1
+        hash: 3
         segments: 
-        - 1
-        - 5
-        - 1
-        version: 1.5.1
-  requirement: *id003
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
+  name: rcov
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: yard
   prerelease: false
-  name: rcov
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -77,37 +87,37 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  requirement: *id004
-description: 
+  type: :development
+  version_requirements: *id005
+description: "A ruby implementation of LockIt: A Simple File-based Convention for Resource Locking"
 email: chris@cbeer.info
 executables: 
 - lockit
 - unlockit
 extensions: []
 
-extra_rdoc_files: 
-- LICENSE.txt
-- README.rdoc
-- TODO
+extra_rdoc_files: []
+
 files: 
 - .document
+- .gitignore
+- .rvmrc
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
 - README.rdoc
 - Rakefile
 - TODO
-- VERSION
 - bin/lockit
 - bin/unlockit
 - lib/lockit.rb
+- lib/lockit/version.rb
 - lockit.gemspec
-- test/helper.rb
-- test/test_lockit.rb
+- spec/lockit_spec.rb
 has_rdoc: true
-homepage: http://github.com/cbeer/lockit
-licenses: 
-- MIT
+homepage: https://github.com/microservices/lockit
+licenses: []
+
 post_install_message: 
 rdoc_options: []
 
@@ -134,10 +144,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.6.2
 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
+- spec/lockit_spec.rb

data/VERSION

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

data/test/helper.rb

@@ -1,18 +0,0 @@
-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

@@ -1,33 +0,0 @@
-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