dm-lock 0.0.1

data/History.md

@@ -0,0 +1,5 @@
+
+0.0.1 / YYYY-MM-DD
+==================
+
+  * Initial release

data/Manifest

@@ -0,0 +1,15 @@
+History.md
+Rakefile
+Readme.md
+lib/dm-lock.rb
+lib/dm-lock/exceptions.rb
+lib/dm-lock/lock.rb
+lib/dm-lock/optimistic.rb
+lib/dm-lock/version.rb
+spec/optimistic_lock_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+tasks/docs.rake
+tasks/gemspec.rake
+tasks/spec.rake
+Manifest

data/Rakefile

@@ -0,0 +1,17 @@
+
+$:.unshift 'lib'
+require 'dm-lock'
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new "dm-lock", DataMapper::Lock::VERSION do |p|
+  p.author = "TJ Holowaychuk"
+  p.email = "tj@vision-media.ca"
+  p.summary = "Locking utilities for DataMapper"
+  p.url = "http://github.com/visionmedia/dm-lock"
+  p.runtime_dependencies = []
+  p.runtime_dependencies << 'dm-core >=0.10.1'
+end
+
+Dir['tasks/**/*.rake'].sort.each { |f| load f }

data/Readme.md

@@ -0,0 +1,69 @@
+
+# DataMapper::Lock
+
+  Locking utilities for DataMapper >= 0.10.1
+  
+## DataMapper::Lock::Optimistic
+
+Optimistic locking provides a relatively high performance
+strategy for preventing race-conditions. This strategy does
+not lock database tables, rows, or records. 
+
+The example below simply creates a propery named :lock_version, 
+which is then incremented every time record is saved. At the time of
+saving or destroying a record, we first check the existing version in the
+database, if it is the same we proceed, otherwise we raise DataMapper::Lock::StaleRecordError
+which then allows you to apply merging, error reporting, or business logic
+to resolve the conflict.
+
+  class Item
+    include DataMapper::Resource
+    lock :optimistic
+    property :id,   Serial
+    property :name, String
+  end
+  
+  // Process or thread 'A'
+  foo = Item.get 1
+  
+  // Process or thread 'B'
+  foo = Item.get 1
+  foo.update :name => 'Baz'
+  
+  // Process or thread 'A'
+  foo.update :name => 'Bar'
+  // => DataMapper::Lock::StaleRecordError: record has been altered 
+  
+## DataMapper::Lock::StaleRecordError
+
+When raised you may access both the #current_record as well as
+the #stale_record for any merging or reporting needs.
+
+## Contribution
+
+  * Feel free to fork and commit, email patches, suggestions or anything else you have in mind  
+
+## License
+
+(The MIT License)
+
+Copyright (c) 2009 TJ Holowaychuk <tj@vision-media.ca>
+
+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, an d/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/dm-lock.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{dm-lock}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["TJ Holowaychuk"]
+  s.date = %q{2009-10-08}
+  s.description = %q{Locking utilities for DataMapper}
+  s.email = %q{tj@vision-media.ca}
+  s.extra_rdoc_files = ["lib/dm-lock.rb", "lib/dm-lock/exceptions.rb", "lib/dm-lock/lock.rb", "lib/dm-lock/optimistic.rb", "lib/dm-lock/version.rb", "tasks/docs.rake", "tasks/gemspec.rake", "tasks/spec.rake"]
+  s.files = ["History.md", "Rakefile", "Readme.md", "lib/dm-lock.rb", "lib/dm-lock/exceptions.rb", "lib/dm-lock/lock.rb", "lib/dm-lock/optimistic.rb", "lib/dm-lock/version.rb", "spec/optimistic_lock_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "tasks/docs.rake", "tasks/gemspec.rake", "tasks/spec.rake", "Manifest", "dm-lock.gemspec"]
+  s.homepage = %q{http://github.com/visionmedia/dm-lock}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Dm-lock", "--main", "Readme.md"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{dm-lock}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Locking utilities for DataMapper}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<dm-core>, [">= 0.10.1"])
+    else
+      s.add_dependency(%q<dm-core>, [">= 0.10.1"])
+    end
+  else
+    s.add_dependency(%q<dm-core>, [">= 0.10.1"])
+  end
+end

data/lib/dm-lock.rb

@@ -0,0 +1,35 @@
+#--
+# Copyright (c) 2009 TJ Holowaychuk <tj@vision-media.ca>
+#
+# 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.
+#++
+
+require 'dm-core'
+require 'dm-lock/version'
+require 'dm-lock/lock'
+require 'dm-lock/exceptions'
+require 'dm-lock/optimistic'
+
+#--
+# DataMapper
+#++
+
+DataMapper::Model.append_inclusions DataMapper::Lock
+DataMapper::Model.append_inclusions DataMapper::Lock::Optimistic

data/lib/dm-lock/exceptions.rb

@@ -0,0 +1,26 @@
+
+module DataMapper
+  module Lock
+    class StaleRecordError < StandardError
+      
+      ##
+      # Record as-is current in the database.
+      
+      attr_reader :current_record
+      
+      ##
+      # Stale record attempted to be destroyed or saved.
+      
+      attr_reader :stale_record 
+      
+      ##
+      # Initialize with _stale_ and _latest_ records.
+      
+      def initialize stale, latest
+        @stale_record, @current_record = stale, latest
+        super 'record has been altered'
+      end
+      
+    end
+  end
+end

data/lib/dm-lock/lock.rb

@@ -0,0 +1,22 @@
+
+module DataMapper
+  module Lock
+    
+    ##
+    # Provide #lock method to _model_.
+    
+    def self.included model
+      model.extend ClassMethods
+    end
+    
+    module ClassMethods
+      
+      ##
+      # Shortcut for calling lock_METHOD.
+      
+      def lock method, *args
+        send :"lock_#{method}", *args 
+      end
+    end
+  end
+end

data/lib/dm-lock/optimistic.rb

@@ -0,0 +1,70 @@
+
+module DataMapper
+  module Lock
+    module Optimistic
+      
+      ##
+      # Validate _model_'s lock_version before attempting
+      # to save or destroy.
+      
+      def self.included model
+        model.extend ClassMethods
+        model.before :destroy, :validate_lock_version
+        model.before :save, :validate_lock_version
+        model.before :save, :increment_lock_version
+      end
+      
+      ##
+      # Validate the lock version.
+      #
+      #  * Lets new records passed
+      #  * Lets un-altered records passed
+      #  * Lets the record pass unless the lock_version has been changed
+      #
+      # === Raises
+      #
+      #   DataMapper::Lock::StaleRecordError
+      #
+      
+      def validate_lock_version
+        if !new? && dirty?
+          if lock_version_altered?
+            raise DataMapper::Lock::StaleRecordError.new(self, @latest_record)
+          end
+        end
+      end
+      
+      ##
+      # Check if the lock_version has been altered and
+      # return the latest record.
+      
+      def lock_version_altered?
+        @latest_record = self.class.get original_attributes[:id] || id
+        @latest_record.lock_version != lock_version
+      end
+      
+      ##
+      # Increment the lock_version.
+      
+      def increment_lock_version
+        self.lock_version += 1
+      end
+      
+      module ClassMethods
+        
+        ##
+        # Provide optimistic locking support.
+        #
+        # This method adds a property named :lock_version
+        # which is used to track alterations made, preventing
+        # multi-thread/process rece conditions while updating or
+        # destroying records.
+        
+        def lock_optimistic options = {}
+          property :lock_version, Integer, :nullable => true, :default => 0
+        end
+        
+      end
+    end
+  end
+end 

data/lib/dm-lock/version.rb

@@ -0,0 +1,6 @@
+
+module DataMapper
+  module Lock
+    VERSION = '0.0.1'
+  end
+end

data/spec/optimistic_lock_spec.rb

@@ -0,0 +1,97 @@
+
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe DataMapper::Lock::Optimistic do
+  
+  class Item
+    include DataMapper::Resource
+    property :id,   Serial
+    property :name, String
+  end
+  
+  before :each do
+    DataMapper.auto_migrate!
+  end
+  
+  describe "#lock" do
+    describe "with arguments" do
+      it "should call #lock_optimistic" do
+        Item.should_receive :lock_optimistic
+        Item.lock :optimistic
+      end
+      
+      it "should pass addition arguments" do
+        Item.should_receive(:lock_optimistic).with({ :foo => 'bar' })
+        Item.lock :optimistic, :foo => 'bar'
+      end
+    end
+  end
+  
+  describe "#lock :optimistic" do
+    it "should add a :lock_version property" do
+      Item.lock :optimistic
+      Item.properties.named?(:lock_version).should be_true
+    end
+    
+    it "should default :lock_version to 0" do
+      Item.new.lock_version.should == 0
+    end
+    
+    describe "when saving a valid record" do
+      it "should increment :lock_version" do
+        foo = Item.new :name => 'foo'
+        foo.save
+        foo.reload.lock_version.should == 1
+        foo.save
+        foo.reload.lock_version.should == 2
+      end
+    end
+    
+    describe "when saving a record which has been altered" do
+      it "should raise DataMapper::Lock::StaleRecordError" do
+        foo = Item.create :name => 'foo'
+        foo2 = Item.first :name => 'foo'
+        foo.name = 'updated foo'
+        foo2.update :name => 'bar'
+        lambda { foo.save }.should raise_error(DataMapper::Lock::StaleRecordError, /altered/)
+      end
+      
+      it "should provide the records in the raised exception" do
+        foo = Item.create :name => 'foo'
+        foo2 = Item.first :name => 'foo'
+        foo.name = 'updated foo'
+        foo2.update :name => 'bar'
+        begin
+          foo.save
+        rescue DataMapper::Lock::StaleRecordError => e
+          e.stale_record.name.should == 'updated foo'
+          e.current_record.name.should == 'bar'
+        end
+      end
+    end
+    
+    describe "when destroying a record which has been altered" do
+      it "should raise DataMapper::Lock::StaleRecordError" do
+        foo = Item.create :name => 'foo'
+        foo2 = Item.first :name => 'foo'
+        foo.name = 'updated foo'
+        foo2.save
+        lambda { foo.destroy }.should raise_error(DataMapper::Lock::StaleRecordError, /altered/)
+      end
+      
+      it "should provide the records in the raised exception" do
+        foo = Item.create :name => 'foo'
+        foo2 = Item.first :name => 'foo'
+        foo.name = 'updated foo'
+        foo2.save
+        begin
+          foo.destroy
+        rescue DataMapper::Lock::StaleRecordError => e
+          e.stale_record.name.should == 'updated foo'
+          e.current_record.name.should == 'foo'
+        end
+      end
+    end
+  end
+  
+end

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--color
+--format specdoc

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+
+$:.unshift File.dirname(__FILE__) + '/../lib' 
+require 'rubygems'
+require 'dm-lock'
+
+DataMapper.setup :default, 'sqlite3::memory:'

data/tasks/docs.rake

@@ -0,0 +1,13 @@
+
+namespace :docs do
+  
+  desc 'Remove rdoc products'
+  task :remove => [:clobber_docs]
+  
+  desc 'Build docs, and open in browser for viewing (specify BROWSER)'
+  task :open do
+    browser = ENV["BROWSER"] || "safari"
+    sh "open -a #{browser} doc/index.html"
+  end
+  
+end

data/tasks/gemspec.rake

@@ -0,0 +1,3 @@
+
+desc 'Build gemspec file'
+task :gemspec => [:build_gemspec]

data/tasks/spec.rake

@@ -0,0 +1,25 @@
+
+require 'spec/rake/spectask'
+  
+desc "Run all specifications"
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.libs << "lib"
+  t.spec_opts = ["--color", "--require", "spec/spec_helper.rb"]
+end
+  
+namespace :spec do
+
+  desc "Run all specifications verbosely"
+  Spec::Rake::SpecTask.new(:verbose) do |t|
+    t.libs << "lib"
+    t.spec_opts = ["--color", "--format", "specdoc", "--require", "spec/spec_helper.rb"]
+  end
+  
+  desc "Run specific specification verbosely (specify SPEC)"
+  Spec::Rake::SpecTask.new(:select) do |t|
+    t.libs << "lib"
+    t.spec_files = [ENV["SPEC"]]
+    t.spec_opts = ["--color", "--format", "specdoc", "--require", "spec/spec_helper.rb"]
+  end
+  
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: dm-lock
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- TJ Holowaychuk
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-08 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: dm-core
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.10.1
+    version: 
+description: Locking utilities for DataMapper
+email: tj@vision-media.ca
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- lib/dm-lock.rb
+- lib/dm-lock/exceptions.rb
+- lib/dm-lock/lock.rb
+- lib/dm-lock/optimistic.rb
+- lib/dm-lock/version.rb
+- tasks/docs.rake
+- tasks/gemspec.rake
+- tasks/spec.rake
+files: 
+- History.md
+- Rakefile
+- Readme.md
+- lib/dm-lock.rb
+- lib/dm-lock/exceptions.rb
+- lib/dm-lock/lock.rb
+- lib/dm-lock/optimistic.rb
+- lib/dm-lock/version.rb
+- spec/optimistic_lock_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- tasks/docs.rake
+- tasks/gemspec.rake
+- tasks/spec.rake
+- Manifest
+- dm-lock.gemspec
+has_rdoc: true
+homepage: http://github.com/visionmedia/dm-lock
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Dm-lock
+- --main
+- Readme.md
+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: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: dm-lock
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Locking utilities for DataMapper
+test_files: []
+