dm-optlock 0.1.2 → 0.1.3

data/History.txt

@@ -5,5 +5,10 @@
   
 == 0.1.2 2008-10-01
 
-* 1 minor enhancement:
+* 1 major enhancement:
   * Added class method 'set_locking_column'
+  
+== 0.1.3 2009-01-10
+
+* 1 major enhancement:
+  * replaced 'set_locking_column' by 'add_locking_column'

data/Manifest.txt

@@ -1,14 +1,12 @@
 History.txt
 Manifest.txt
+README.rdoc
 Rakefile
-config/hoe.rb
-config/requirements.rb
 lib/dm-optlock.rb
-lib/dm-optlock/version.rb
-setup.rb
-tasks/deployment.rake
-tasks/environment.rake
-tasks/spec.rake
+script/console
+script/destroy
+script/generate
+spec/dm-optlock_spec.rb
 spec/spec.opts
 spec/spec_helper.rb
-spec/integration/optlock_spec.rb
+tasks/rspec.rake

data/README.rdoc

@@ -0,0 +1,48 @@
+= dm-optlock
+
+* FIX (url)
+
+== DESCRIPTION:
+
+FIX (describe your package)
+
+== FEATURES/PROBLEMS:
+
+* FIX (list of features or problems)
+
+== SYNOPSIS:
+
+  FIX (code sample of usage)
+
+== REQUIREMENTS:
+
+* FIX (list of requirements)
+
+== INSTALL:
+
+* FIX (sudo gem install, anything else)
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 FIXME full name
+
+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/Rakefile

@@ -1,4 +1,21 @@
-require 'config/requirements'
-require 'config/hoe' # setup Hoe + all gem configuration
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/dm-optlock'
 
-Dir['tasks/**/*.rake'].each { |rake| load rake }
+# 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('FIXME full name', 'FIXME email')
+  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

@@ -1,19 +1,19 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+  
 require 'rubygems'
-
-gem 'dm-core', '=0.9.5'
+gem 'dm-core', '>=0.9.5'
 require 'dm-core'
 
 module DataMapper
-  # Raised when the row represented by the object which is to be saved was updated in meantime.
   class StaleObjectError < StandardError
   end
   
-  # Enables optimistic row locking in DM.
-  module OptLock
+  module DmOptlock
+    VERSION = '0.1.3'
     DEFAULT_LOCKING_COLUMN = :lock_version
    
-    # hmm...
-    def self.included(base)
+    def self.included(base) #:nodoc:
       base.extend ClassMethods
       base.before :save, :check_lock_version
     end
@@ -21,33 +21,37 @@ module DataMapper
     private
     # Checks if the row has been changed since being loaded from the database.
     def check_lock_version
-      if self.respond_to?(self.class.locking_column.to_s) && !self.new_record? && self.dirty?
-        id = self.id
-        id = self.original_values[:id] if self.original_values.include?(:id)
-        if self.original_values.include?(self.class.locking_column) || self.class.first(:id => id, self.class.locking_column => self.attributes[self.class.locking_column]).nil?
+      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
-          self.attributes = {self.class.locking_column => self.attributes[self.class.locking_column] + 1}
+          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 set_locking_column(name = nil)
+        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 DEFAULT_LOCKING_COLUMN unless @@lock_column
           return @@lock_column
         end
     end
   end
-
-  Resource::append_inclusions OptLock
+  
+  Resource::append_inclusions DmOptlock
 end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/dm-optlock.rb'}"
+puts "Loading dm-optlock gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

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

@@ -1,2 +1 @@
---format specdoc
---colour
+--colour

data/spec/spec_helper.rb

@@ -1,8 +1,14 @@
-require 'rubygems'
-gem 'rspec', '>=1.1.3'
-require 'spec'
-require 'pathname'
-require Pathname(__FILE__).dirname.parent.expand_path + 'lib/dm-optlock'
+#: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
@@ -10,7 +16,7 @@ def load_driver(name, default_uri)
   lib = "do_#{name}"
 
   begin
-    gem lib, '=0.9.5'
+    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]

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

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification 
 name: dm-optlock
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors: 
-- Martin Vielsmaier
+- FIXME full name
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2008-10-02 00:00:00 +02:00
+date: 2009-01-10 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -30,11 +30,11 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.7.0
+        version: 1.8.0
     version: 
-description: Optimistic locking for Datamapper
+description: FIX (describe your package)
 email: 
-- martin.vielsmaier@gmail.com
+- FIXME email
 executables: []
 
 extensions: []
@@ -42,27 +42,26 @@ extensions: []
 extra_rdoc_files: 
 - History.txt
 - Manifest.txt
+- README.rdoc
 files: 
 - History.txt
 - Manifest.txt
+- README.rdoc
 - Rakefile
-- config/hoe.rb
-- config/requirements.rb
 - lib/dm-optlock.rb
-- lib/dm-optlock/version.rb
-- setup.rb
-- tasks/deployment.rake
-- tasks/environment.rake
-- tasks/spec.rake
+- script/console
+- script/destroy
+- script/generate
+- spec/dm-optlock_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
-- spec/integration/optlock_spec.rb
+- tasks/rspec.rake
 has_rdoc: true
-homepage: http://moserei.de/?p=27
-post_install_message: ""
+homepage: FIX (url)
+post_install_message: 
 rdoc_options: 
 - --main
-- README.txt
+- README.rdoc
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -80,9 +79,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: dm-optlock
-rubygems_version: 1.2.0
+rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2
-summary: Optimistic locking for Datamapper
+summary: FIX (describe your package)
 test_files: []
 

data/config/hoe.rb

@@ -1,73 +0,0 @@
-require 'dm-optlock/version'
-
-AUTHOR = 'Martin Vielsmaier'  # can also be an array of Authors
-EMAIL = "martin.vielsmaier@gmail.com"
-DESCRIPTION = "Optimistic locking for Datamapper"
-GEM_NAME = 'dm-optlock' # what ppl will type to install your gem
-RUBYFORGE_PROJECT = 'dm-optlock' # The unix name for your project
-HOMEPATH = "http://moserei.de/?p=27"
-DOWNLOAD_PATH = "http://moserei.de/?p=27"
-EXTRA_DEPENDENCIES = [
-  ['dm-core', '>= 0.9.5']
-]    # An array of rubygem dependencies [name, version]
-
-@config_file = "~/.rubyforge/user-config.yml"
-@config = nil
-RUBYFORGE_USERNAME = "unknown"
-def rubyforge_username
-  unless @config
-    begin
-      @config = YAML.load(File.read(File.expand_path(@config_file)))
-    rescue
-      puts <<-EOS
-ERROR: No rubyforge config file found: #{@config_file}
-Run 'rubyforge setup' to prepare your env for access to Rubyforge
- - See http://newgem.rubyforge.org/rubyforge.html for more details
-      EOS
-      exit
-    end
-  end
-  RUBYFORGE_USERNAME.replace @config["username"]
-end
-
-
-REV = nil
-# UNCOMMENT IF REQUIRED:
-# REV = YAML.load(`svn info`)['Revision']
-VERS = DataMapper::OptLock::VERSION::STRING + (REV ? ".#{REV}" : "")
-RDOC_OPTS = ['--quiet', '--title', 'dm-optlock documentation',
-    "--opname", "index.html",
-    "--line-numbers",
-    "--main", "README",
-    "--inline-source"]
-
-class Hoe
-  def extra_deps
-    @extra_deps.reject! { |x| Array(x).first == 'hoe' }
-    @extra_deps
-  end
-end
-
-# Generate all the Rake tasks
-# Run 'rake -T' to see list of generated tasks (from gem root directory)
-$hoe = Hoe.new(GEM_NAME, VERS) do |p|
-  p.developer(AUTHOR, EMAIL)
-  p.description = DESCRIPTION
-  p.summary = DESCRIPTION
-  p.url = HOMEPATH
-  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
-  p.test_globs = ["test/**/test_*.rb"]
-  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
-
-  # == Optional
-  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
-  p.extra_deps = EXTRA_DEPENDENCIES
-
-    #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
-  end
-
-CHANGES = $hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
-PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
-$hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
-$hoe.rsync_args = '-av --delete --ignore-errors'
-$hoe.spec.post_install_message = File.open(File.dirname(__FILE__) + "/../PostInstall.txt").read rescue ""