moser-dm-optlock 0.1.5

data/History.txt

@@ -0,0 +1,12 @@
+== 0.1.3 2009-01-10
+* 1 major enhancement:
+  * replaced 'set_locking_column' by 'add_locking_column' 
+   
+== 0.1.2 2008-10-01
+* 1 major enhancement:
+  * Added class method 'set_locking_column'
+  
+== 0.1.0 2008-09-30
+* 1 major enhancement:
+  * Initial release
+  

data/README.rdoc

@@ -0,0 +1,19 @@
+= dm-optlock
+Adds optimistic locking to Datamapper.
+
+== Usage:
+  class Model
+    include DataMapper::Resource
+    ...
+    add_locking_column :my_version_col
+  end
+
+add_locking_column takes a options hash just like DataMapper’s property method does.
+
+== REQUIREMENTS:
+
+* dm-core >= 0.9.5
+
+== LICENSE:
+GPL v3
+http://www.gnu.de/documents/gpl-3.0.en.html

data/Rakefile

@@ -0,0 +1,21 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/dm-optlock'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('dm-optlock', DataMapper::DmOptlock::VERSION) do |p|
+  p.developer('Martin Vielsmaier', 'martin.vielsmaier@gmail.com')
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.rubyforge_name       = p.name # TODO this is default value
+  p.extra_deps         = [
+     ['dm-core','>= 0.9.5'],
+  ]
+  
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }

data/lib/dm-optlock.rb

@@ -0,0 +1,57 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+  
+require 'rubygems'
+gem 'dm-core', '>=0.9.5'
+require 'dm-core'
+
+module DataMapper
+  class StaleObjectError < StandardError
+  end
+  
+  module DmOptlock
+    VERSION = '0.1.4'
+    DEFAULT_LOCKING_COLUMN = :lock_version
+   
+    def self.included(base) #:nodoc:
+      base.extend ClassMethods
+      base.before :save, :check_lock_version
+    end
+
+    private
+    # Checks if the row has been changed since being loaded from the database.
+    def check_lock_version
+      if !new_record? && dirty? && respond_to?(self.class.locking_column.to_s)
+        if original_values.include?(:id)
+          row = self.class.get(original_values[:id]) 
+        else
+          row = self.class.get(id)
+        end
+        if !row.nil? && row.attribute_get(self.class.locking_column) != attribute_get(self.class.locking_column)
+          attributes = original_values
+          raise DataMapper::StaleObjectError
+        else
+          attribute_set(self.class.locking_column, attribute_get(self.class.locking_column) + 1)
+        end
+      end
+    end
+    
+    module ClassMethods
+        @@lock_column = nil
+        
+        # Set the column to use for optimistic locking. Defaults to lock_version.
+        def add_locking_column(name = DEFAULT_LOCKING_COLUMN, options = {})
+          options.merge!({:default => 0, :writer => :protected})
+          @@lock_column = name
+          property name, Integer, options
+        end
+
+        # The version column used for optimistic locking. Defaults to lock_version.
+        def locking_column
+          return @@lock_column
+        end
+    end
+  end
+  
+  Resource::append_inclusions DmOptlock
+end

data/spec/dm-optlock_spec.rb

@@ -0,0 +1,71 @@
+#:nodoc:
+require 'pathname'
+require Pathname(__FILE__).dirname.expand_path + 'spec_helper'
+
+if HAS_SQLITE3 || HAS_MYSQL || HAS_POSTGRES
+  describe 'DataMapper::DmOptlock' do
+    before :all do
+      class Thing
+        include DataMapper::Resource
+        property :id, Integer, :serial => true
+        property :name, String
+        
+        add_locking_column :row_version
+
+        auto_migrate!(:default)
+      end
+    end
+
+    after do
+     repository(:default).adapter.execute('DELETE from things');
+    end
+
+    it "shouldn't save second" do
+      t = Thing.new(:name => "Banana")
+      t.save
+      tA = Thing.first
+      tB = Thing.first
+      tA.name = 'Apple'
+      tB.name = 'Pineapple'
+      tA.save.should be_true
+      lambda { tB.save.should }.should raise_error(DataMapper::StaleObjectError)
+    end
+    
+    it "should increment lock version" do
+      t = Thing.new(:name => "Dollar")
+      t.save
+      t.row_version.should equal(0)
+      t.name = "Euro"
+      t.save
+      t.row_version.should equal(1)
+    end
+    
+    it "should be aware of ID changes" do
+      t = Thing.new(:name => "abc")
+      t.save
+      tA = Thing.first
+      tB = Thing.first
+      tA.name = 'Apple'
+      tB.id = 122
+      tA.save.should be_true
+      lambda { tB.save.should }.should raise_error(DataMapper::StaleObjectError)
+    end
+    
+    it "'s version column should be not nullable, have default 0 and a protected writer" do
+     class Foo
+        include DataMapper::Resource
+        property :id, Integer, :serial => true
+       
+        add_locking_column :foo_version, :default => 1, :nullable => false
+
+        auto_migrate!(:default)
+      end
+      
+      col = Foo.properties[:foo_version]
+      col.nullable?.should be_false
+      col.default.should be(0)
+      col.writer_visibility.should equal(:protected)
+    end
+
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,34 @@
+#:nodoc:
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'dm-optlock'
+
+def load_driver(name, default_uri)
+  return false if ENV['ADAPTER'] != name.to_s
+
+  lib = "do_#{name}"
+
+  begin
+    gem lib, '>=0.9.5'
+    require lib
+    DataMapper.setup(name, ENV["#{name.to_s.upcase}_SPEC_URI"] || default_uri)
+    DataMapper::Repository.adapters[:default] =  DataMapper::Repository.adapters[name]
+    true
+  rescue Gem::LoadError => e
+    warn "Could not load #{lib}: #{e}"
+    false
+  end
+end
+
+ENV['ADAPTER'] ||= 'sqlite3'
+
+HAS_SQLITE3  = load_driver(:sqlite3,  'sqlite3::memory:')
+HAS_MYSQL    = load_driver(:mysql,    'mysql://localhost/dm_core_test')
+HAS_POSTGRES = load_driver(:postgres, 'postgres://postgres@localhost/dm_core_test')

data/tasks/rspec.rake

@@ -0,0 +1,21 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: moser-dm-optlock
+version: !ruby/object:Gem::Version 
+  version: 0.1.5
+platform: ruby
+authors: 
+- Martin Vielsmaier
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-03 00:00:00 -08: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.9.5
+    version: 
+description: Adds optimistic locking to Datamapper.
+email: tom@mojombo.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- History.txt
+- README.rdoc
+- Rakefile
+- lib/dm-optlock.rb
+- spec/dm-optlock_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- tasks/rspec.rake
+has_rdoc: true
+homepage: http://moserei.de/index.php/tag/dm-optlock
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --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.2.0
+signing_key: 
+specification_version: 2
+summary: Adds optimistic locking to Datamapper.
+test_files: []
+