expirable_locking 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) 2009 Eric Chapweske
+
+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,34 @@
+= expirable_locking
+
+Usage:
+Provides expirable locking for concurrent processing.
+
+  class MyModel < ActiveRecord::Base
+    extend ExpirableLocking
+  end
+
+  Process A: record.lock_with_expirey
+  Process A: => true
+  Process B: record.lock_with_expirey
+  Process B: => false
+  Process A: record.unlock
+  Process A: => true
+  Process B: record.lock_with_expirey
+  Process B: => true
+
+By default the lock expires after 10 mintutes, this can be changed by overriding the lock_duration class method.
+
+== 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 Eric Chapweske. See LICENSE for details.
+

data/Rakefile

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "expirable_locking"
+    gem.summary = %Q{A tiny ActiveRecord extension for expirable locking.}
+    gem.description = %Q{A tiny ActiveRecord extension for expirable locking.}
+    gem.email = "eac@zendesk.com"
+    gem.homepage = "http://github.com/eac/expirable_locking"
+    gem.authors = ["Eric Chapweske"]
+    # 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: 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 = "expirable_locking #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/lib/expirable_locking.rb

@@ -0,0 +1,49 @@
+module ExpirableLocking
+
+  def self.extended(base)
+    base.named_scope :unlocked, lambda {
+      { :conditions => [ "locked_at IS NULL OR locked_at < ?", base.lock_duration.ago ] }
+    }
+    base.send(:include, InstanceMethods)
+  end
+
+  module InstanceMethods
+
+    def lock_with_expirey
+      self.class.lock(self)
+    end
+
+    def unlock
+      self.class.unlock(self)
+    end
+
+  end
+
+  def lock_duration
+    10.minutes
+  end
+
+  def lock(record)
+    1 == unlocked.touch_lock(record)
+  end
+
+  def unlock(record)
+    return true if record.destroyed?
+
+    1 == update_all({ :locked_at => nil }, { :id => record, :locked_at => record.locked_at })
+  end
+
+  # Updates lock timestamp without triggering validations/callbacks.
+  def touch_lock(record)
+    locked_at = default_timezone == :utc ? Time.now.utc : Time.now
+    result    = update_all({ :locked_at => locked_at }, { :id => record })
+
+    if result == 1
+      record.write_attribute_without_dirty(:locked_at, locked_at)
+    end
+
+    result
+  end
+
+end
+

data/test/expirable_locking_test.rb

@@ -0,0 +1,105 @@
+require 'helper'
+
+class ExpirableLockingTest < ActiveRecord::TestCase
+
+  class LockableEmail < ActiveRecord::Base
+    extend ExpirableLocking
+  end
+
+  context "Expirable locks" do
+    setup do
+      @model  = LockableEmail
+      @record = @model.create!
+    end
+
+    should "have a lock duration of 10 minutes by default" do
+      assert_equal 10.minutes, @model.lock_duration
+    end
+
+    context "unlocked scope" do
+
+      should "include records that have never been locked" do
+        assert @model.unlocked.include?(@record)
+      end
+
+      should "include records with an expired lock" do
+        Timecop.freeze(@model.lock_duration.ago - 1.second) do
+          @model.touch_lock(@record)
+        end
+
+        assert @model.unlocked.include?(@record)
+      end
+
+      should "not include records with a lock that isn't expired" do
+        Timecop.freeze(@model.lock_duration.ago + 1.second) do
+          @model.touch_lock(@record)
+        end
+
+        assert_equal false, @model.unlocked.include?(@record)
+      end
+    end
+
+    context "locking" do
+
+      should "fail for locked records" do
+        @model.touch_lock(@record)
+        assert_equal false, @record.lock_with_expirey
+      end
+
+      should "succeed for unlocked records" do
+        assert @model.unlocked.include?(@record)
+        assert_equal true, @record.lock_with_expirey
+      end
+
+    end
+
+    context "unlocking" do
+
+      should "succeed without querying the database for deleted records" do
+        @record.lock_with_expirey
+        @record.destroy
+
+        @record.class.connection.expects(:update).never
+        assert_equal true, @record.unlock
+      end
+
+      should "succeed when the lock hasn't expired" do
+        @record.lock_with_expirey
+        assert_equal true, @record.unlock
+      end
+
+      should "fail when the lock expired and was re-aqcuired by another process" do
+        Timecop.freeze(@model.lock_duration.ago - 1.second) do
+          @record.lock_with_expirey
+        end
+        @model.find(@record).lock_with_expirey # Oh hi, other process
+
+        assert_equal false, @record.unlock
+      end
+
+      should "remove the record's lock" do
+        @model.touch_lock(@record)
+        @record.unlock
+
+        assert @model.unlocked.include?(@record)
+      end
+
+    end
+
+    context "touching the lock" do
+
+      should "update the record's lock timestamp" do
+        Timecop.freeze(Time.now) do
+          @model.touch_lock(@record)
+
+          assert_equal Time.current.to_i, @record.locked_at.to_i
+          assert_equal Time.current.to_i, @record.reload.locked_at.to_i
+        end
+      end
+
+    end
+
+  end
+
+end
+

data/test/helper.rb

@@ -0,0 +1,30 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'activerecord'
+require 'mocha'
+require 'timecop'
+require 'activesupport'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'expirable_locking'
+
+class Test::Unit::TestCase
+end
+
+ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => '/tmp/expirable_locking.sqlite')
+
+ActiveRecord::Schema.define do
+
+  create_table :lockable_emails, :force => true do |table|
+    table.string :from
+    table.string :to
+    table.text   :mail
+    table.timestamps
+
+    table.datetime :locked_at
+  end
+
+end
+

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: expirable_locking
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Eric Chapweske
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-26 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: A tiny ActiveRecord extension for expirable locking.
+email: eac@zendesk.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/expirable_locking.rb
+- test/expirable_locking_test.rb
+- test/helper.rb
+has_rdoc: true
+homepage: http://github.com/eac/expirable_locking
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A tiny ActiveRecord extension for expirable locking.
+test_files: 
+- test/expirable_locking_test.rb
+- test/helper.rb