mrkurt-versioned 0.1.0 → 0.1.1

data/.gitignore

@@ -0,0 +1 @@
+pkg

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/lib/version.rb

@@ -17,4 +17,20 @@ class Version
   def <=>(other)
     number <=> other.number
   end
+
+  def previous
+    find_related(:first, :number => {:$lt => number}, :order => 'number.desc')
+  end
+
+  def next
+    find_related(:first, :number => {:$gt => number}, :order => 'number.asc')
+  end
+
+  protected
+
+  def find_related(*args)
+    options = args.extract_options!
+    params = options.merge(:versioned_id => versioned_id, :versioned_type => versioned_type)
+    self.class.find(args.first, params)
+  end
 end

data/lib/versioned.rb

@@ -1,6 +1,7 @@
 require 'version'
 
 module Versioned
+  class StaleDocumentError < MongoMapper::MongoMapperError; end
   def self.included(base)
     base.extend ClassMethods
     base.class_eval do
@@ -8,7 +9,58 @@ module Versioned
     end
   end
 
+  module LockingInstanceMethods
+    private
+      #new? isn't working
+      def is_new_document?
+        (read_attribute(self.version_lock_key).blank? && changes[self.version_lock_key.to_s].blank?) ||
+        (changes[self.version_lock_key.to_s] && changes[self.version_lock_key.to_s].first.blank?)
+      end
+      def prep_lock_version
+        old = read_attribute(self.version_lock_key)
+        if !is_new_document? || old.blank?
+          v = (Time.now.to_f * 1000).ceil.to_s
+          write_attribute self.version_lock_key, v
+        end
+
+        old
+      end
+
+      def save_to_collection(options = {})
+        current_version = prep_lock_version
+        if is_new_document?
+          collection.insert(to_mongo, :safe => true)
+        else
+          selector = { :_id => read_attribute(:_id), self.version_lock_key => current_version }
+          #can't upsert, safe must be true for this to work
+          result = collection.update(selector, to_mongo, :upsert => false, :safe => true)
+
+          if result.is_a?(Array) && result[0][0]['updatedExisting'] == false
+            write_attribute self.version_lock_key, current_version
+            raise StaleDocumentError.new
+          elsif !result.is_a?(Array)
+            #wtf?
+            write_attribute self.version_lock_key, current_version
+            raise "Unexpected result from mongo"
+          end
+
+          selector[:_id]
+        end
+      end
+  end
   module ClassMethods
+    def locking!(options = {})
+      include(LockingInstanceMethods)
+      class_inheritable_accessor :version_lock_key
+      self.version_lock_key = options[:key] || :lock_version
+      key self.version_lock_key, Integer
+
+      if self.respond_to?(:version_use_key)
+        self.version_use_key = self.version_lock_key
+        (self.version_except_columns ||= []) << self.version_lock_key.to_s #don't version the lock key 
+      end
+    end
+
     def versioned(options = {})
       class_inheritable_accessor :version_only_columns
       self.version_only_columns = Array(options[:only]).map(&:to_s).uniq if options[:only]
@@ -59,6 +111,7 @@ module Versioned
       include InstanceMethods
       alias_method_chain :reload, :versions
     end
+
   end
 
   module InstanceMethods
@@ -137,7 +190,7 @@ module Versioned
       end
       
       def revert
-        revert_to self.version -1
+        revert_to self.versions.at(self.version).previous
       end
       
       def retrieve_version n
@@ -165,7 +218,7 @@ module Versioned
       end
 
       def latest_changes
-        return {} if version.nil? || version == 1
+        return {} if version.nil?
         versions.at(version).changes
       end
   end

data/mrkurt-versioned.gemspec

@@ -0,0 +1,67 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{mrkurt-versioned}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["twoism", "toastyapps", "jacqui", "mrkurt"]
+  s.date = %q{2010-01-16}
+  s.description = %q{Versioning for MongoMapper}
+  s.email = %q{mrkurt@gmail.com}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/version.rb",
+     "lib/versioned.rb",
+     "mrkurt-versioned.gemspec",
+     "pkg/versioned-0.1.0.gem",
+     "test/between_test.rb",
+     "test/changes_test.rb",
+     "test/comparable_test.rb",
+     "test/creation_test.rb",
+     "test/latest_changes_test.rb",
+     "test/lock_test.rb",
+     "test/revert_test.rb",
+     "test/schema.rb",
+     "test/specified_version_key_test.rb",
+     "test/test_helper.rb",
+     "versioned.gemspec"
+  ]
+  s.homepage = %q{http://github.com/mrkurt/versioned}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Versioning for MongoMapper}
+  s.test_files = [
+    "test/test_helper.rb",
+     "test/between_test.rb",
+     "test/comparable_test.rb",
+     "test/revert_test.rb",
+     "test/creation_test.rb",
+     "test/latest_changes_test.rb",
+     "test/specified_version_key_test.rb",
+     "test/schema.rb",
+     "test/lock_test.rb",
+     "test/changes_test.rb"
+  ]
+
+  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
+    else
+    end
+  else
+  end
+end
+

data/test/lock_test.rb

@@ -0,0 +1,91 @@
+require 'test_helper'
+
+class LockTest < Test::Unit::TestCase
+  context 'An unversioned model with locks' do
+    setup do
+      @user = UnversionedLockableUser.create(:name => 'Kurt')
+    end
+
+    should 'have a lock_version field' do
+      assert_not_nil @user.lock_version
+    end
+
+    should 'save just fine when no conflicts' do
+      @user.name = 'Bob'
+      assert @user.save
+    end
+
+    should 'save just fine when given the proper lock version' do
+      u = UnversionedLockableUser.find(@user.id)
+      @user.update_attributes(:name => 'Bill')
+
+      assert u.update_attributes(:name => 'Jose', :lock_version => @user.lock_version)
+    end
+
+    should 'not save when given the wrong version' do
+      assert_raise Versioned::StaleDocumentError do
+        @user.update_attributes(:name => 'Bob', :lock_version => 1111)
+      end
+
+      # lock_version should match what we passed in
+      assert_equal 1111, @user.lock_version
+    end
+  end
+  context 'A versioned model with locks' do
+    setup do
+      @user = LockableUser.create(:name => 'Kurt', :required_field => 'woo!')
+    end
+
+    should 'have a lock_version field' do
+      assert_not_nil @user.lock_version
+      assert_equal @user.version, @user.lock_version
+    end
+
+    should 'save just fine when no conflicts' do
+      @user.name = 'Bob'
+      assert @user.save
+    end
+
+    should 'save just fine when given the proper lock version' do
+      u = LockableUser.find(@user.id)
+      @user.update_attributes(:name => 'Bill')
+
+      assert u.update_attributes(:name => 'Jose', :lock_version => @user.lock_version)
+    end
+
+    should 'not save when given the wrong version' do
+      assert_raise Versioned::StaleDocumentError do
+        @user.update_attributes(:name => 'Bob', :lock_version => 1111)
+      end
+
+      # lock_version should match what we passed in
+      assert_equal 1111, @user.lock_version
+    end
+
+    should 'be revertable with the lock version' do
+      v = @user.lock_version
+      name = @user.name
+      @user.update_attributes(:name => "Schlub")
+
+      assert_not_equal v, @user.lock_version
+
+      @user.revert_to(v)
+
+      assert_equal name, @user.name
+      assert_not_equal v, @user.lock_version #shouldn't have reverted version
+    end
+
+    should 'accept a specified version on create' do
+      u = LockableUser.create(:name => 'Burt', :required_field => 'woo!', :lock_version => 1111)
+      assert_equal 1111, u.lock_version
+    end
+
+    should "have same lock_version when validation fails" do
+      @user.required_field = nil
+      v = @user.lock_version
+      result = @user.save
+      assert !result
+      assert_equal v, @user.lock_version
+    end
+  end
+end

data/test/schema.rb

@@ -32,5 +32,24 @@ class Loser
   end
 end
 
+class LockableUser
+  include MongoMapper::Document
+  include Versioned
+  locking!
+
+  key :name, String
+  key :required_field, String
+  validates_presence_of :required_field
+end
+
+class UnversionedLockableUser
+  include MongoMapper::Document
+  extend Versioned::ClassMethods
+  locking!
+  
+  key :name, String
+end
+
 User.destroy_all
+Loser.destroy_all
 Version.destroy_all

data/test/specified_version_key_test.rb

@@ -1,7 +1,7 @@
 require 'test_helper'
 
 class SpecifiedVersionKey < Test::Unit::TestCase
-  context 'A specified version key' do
+  context 'A model with a specified version key' do
     setup do
       @name = "Blah"
       @loser = Loser.create(:name => @name)
@@ -38,7 +38,8 @@ class SpecifiedVersionKey < Test::Unit::TestCase
       end
       
       should 'revert properly' do
-        @loser.revert_to!(@initial_version)
+        @loser.revert
+        @loser.save!
         assert_equal @initial_name, @loser.name
         assert_equal @count + 1, @loser.versions.count
         assert_not_equal @version, @loser.version

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mrkurt-versioned
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - twoism
@@ -12,7 +12,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-09 00:00:00 -06:00
+date: 2010-01-16 00:00:00 -06:00
 default_executable: 
 dependencies: []
 
@@ -25,17 +25,20 @@ extensions: []
 extra_rdoc_files: 
 - README.rdoc
 files: 
+- .gitignore
 - README.rdoc
 - Rakefile
 - VERSION
 - lib/version.rb
 - lib/versioned.rb
+- mrkurt-versioned.gemspec
 - pkg/versioned-0.1.0.gem
 - test/between_test.rb
 - test/changes_test.rb
 - test/comparable_test.rb
 - test/creation_test.rb
 - test/latest_changes_test.rb
+- test/lock_test.rb
 - test/revert_test.rb
 - test/schema.rb
 - test/specified_version_key_test.rb
@@ -78,4 +81,5 @@ test_files:
 - test/latest_changes_test.rb
 - test/specified_version_key_test.rb
 - test/schema.rb
+- test/lock_test.rb
 - test/changes_test.rb