rtiss_acts_as_versioned 0.6.2

data/test/tiss_test.rb

@@ -0,0 +1,331 @@
+# -*- encoding : utf-8 -*-
+
+require File.join(File.dirname(__FILE__), 'fixtures/rolle')
+require File.join(File.dirname(__FILE__), 'fixtures/locked_rolle')
+
+class TissTest < ActiveSupport::TestCase
+  def test_versioning
+    anzahl = Rolle.count
+    
+    oid1 = create_object('test').id
+    oid2 = create_object('tuwien').id
+    oid3 = create_object('ruby').id
+    oid4 = create_object('rails').id
+    oid5 = create_object('times').id
+    
+    assert_equal anzahl+5, Rolle.count
+    
+    2.upto(5) {|index| edit_object(oid1, "test" + index.to_s)}
+    2.upto(7) {|index| edit_object(oid2, "tuwien" + index.to_s)}
+    2.upto(9) {|index| edit_object(oid3, "ruby" + index.to_s)}
+    2.upto(6) {|index| edit_object(oid4, "rails" + index.to_s)}
+    2.upto(3) {|index| edit_object_with_sleep(oid5, "times" + index.to_s)}
+    
+    assert versions_correct?(oid1, 5)
+    assert versions_correct?(oid2, 7)
+    assert versions_correct?(oid3, 9)
+    assert versions_correct?(oid4, 6)
+    
+    assert timestamps?(oid1)
+    assert timestamps?(oid2)
+    assert timestamps?(oid3)
+    assert timestamps?(oid4)
+    assert strong_timestamps?(oid5)
+
+    destroy_record(oid2)
+    assert record_unavailable_in_original_table?(oid2)
+    assert deleted_record_versioned?(oid2, 8)
+    
+    restore_record(oid2)
+    assert restored_record_available_in_original_table?(oid2)
+    assert restored_record_versioned?(oid2, 9)
+    
+    assert save_record_without_changes(oid1)
+  end
+  
+  def test_deleted_in_original_table
+    record = create_object('test deleted_in_orginal_table')
+    version_record = record.versions.find(:first)
+    assert version_record != nil
+
+    assert !version_record.deleted_in_original_table
+    record.destroy
+
+    version_record = record.find_newest_version
+    assert version_record != nil
+    assert version_record.version == 2
+    assert version_record.deleted_in_original_table
+  end
+
+  def test_find_versions
+    o = create_object("karin")
+    v = o.find_versions(:all)
+    assert_equal 1, v.count
+    assert_equal v[0].name, "karin"
+
+    edit_object(o.id, "zak")
+    v = o.find_versions(:all)
+    assert_equal 2, v.count
+    assert_equal v[0].name, "karin"
+    assert_equal v[1].name, "zak"
+
+    v = o.find_versions(:all, :conditions => "name = 'zak'")
+    assert_equal 1, v.count
+    assert_equal v[0].name, "zak"
+
+#    v = o.find_versions(:all, :conditions => ["name = 'zak'"])
+#    assert_equal 1, v.count
+#    assert_equal v[0].name, "zak"
+
+    v = o.find_versions(:first)
+    assert_equal v.name, "karin"
+
+    v = o.find_versions(:last)
+    assert_equal v.name, "zak"
+
+    v = o.find_versions(:all, :order => "name desc")
+    assert_equal 2, v.count
+    assert_equal v[0].name, "zak"
+    assert_equal v[1].name, "karin"
+# mind the missing s
+
+    v = o.find_version(1)
+    assert_equal v.name, "karin"
+
+    v = o.find_version(2)
+    assert_equal v.name, "zak"
+
+    assert_raises(RuntimeError) { o.find_version(3) }
+
+    v = o.find_newest_version
+    assert_equal v.name, "zak"
+  end
+
+  def test_restore
+    o = create_object("lebt")
+    oid = o.id
+    v = o.find_version(1)
+    assert v!=nil
+    
+    assert_raises(RuntimeError) { v.restore }
+    assert !v.deleted_in_original_table
+    assert !v.record_restored, "Record_restored shows that the record was undeleted (should be false) for a newly created record"
+
+    o.destroy
+    v = o.find_newest_version
+    assert v.deleted_in_original_table
+
+    v.restore
+    assert !v.record_restored, "Record_restored shows that the record was undeleted (should be false) for the restored version record (but should be in the newly created record)"
+    o = Rolle.find oid
+    assert v.version == o.version, "Version field not restored correctly"
+
+    v = o.find_newest_version
+    assert !v.deleted_in_original_table, "Deleted_in_original_table doesn't show that the record was undeleted (should be false)"
+    assert v.record_restored, "Record_restored doesn't show that the record was undeleted (should be true) for the version record created upon restore"
+  end
+
+  def test_original_record_exists
+    o = create_object("lebt")
+    oid = o.id
+    v = o.find_version(1)
+    assert v!=nil
+    assert v.original_record_exists?
+
+    o.destroy
+    assert !v.original_record_exists?
+
+    v.restore
+    assert v.original_record_exists?
+  end
+
+  def test_restore_deleted
+    o = create_object("lebt")
+    oid = o.id
+    v = o.find_version(1)
+    assert v!=nil
+    
+    assert_raises(RuntimeError) { restore_record(oid) }
+    assert !v.deleted_in_original_table
+
+    o.destroy
+    v = o.find_version(2)
+    assert v!=nil
+    assert v.deleted_in_original_table
+
+    restore_record(oid)
+    v = o.find_version(3)
+    assert v!=nil
+    assert !v.deleted_in_original_table
+  end
+    
+  def test_restore_deleted_version
+    o = create_object("lebt")
+    oid = o.id
+    v = o.find_version(1)
+    assert v!=nil
+    
+    edit_object(oid, "nicht")
+    x = Rolle.find(oid)
+    assert x.name == "nicht"
+
+    v = o.find_version(2)
+    assert v!=nil
+    o.destroy
+
+    v = o.find_version(3)
+    assert v!=nil
+    assert v.deleted_in_original_table
+
+    Rolle.restore_deleted_version(oid, 1)
+    x = Rolle.find(oid)
+    assert x.name == "lebt"
+  end
+    
+  def test_destroy_unsaved_record
+    o = Rolle.new(:name => "Nicht Speichern")
+    assert_nothing_raised do o.destroy end
+    assert_equal o.highest_version, -1
+  end
+
+  def test_versions_after_save
+    r = Rolle.new(:name => 'karin')
+    assert r.save
+    r.name = 'zak'
+    assert r.save
+    assert_equal 2, r.versions.size 
+    assert_equal 2, r.versions.count
+  end
+
+  def test_restore_without_validations
+    r = Rolle.new(:name => 'karin')
+    assert r.save
+    version = r.find_newest_version
+    r.destroy
+    
+    r = Rolle.new(:name => 'karin')
+    assert r.save
+    
+    assert_raises RuntimeError do version.restore end
+    assert_nothing_raised do version.restore(perform_validations = false) end
+  end
+
+  def test_save_without_revision
+    r = Rolle.new(:name => 'karin')
+    assert_equal true, r.save_without_revision
+    
+    r = Rolle.new(:name => 'karin')
+    assert_equal false, r.save_without_revision
+  end
+
+=begin
+# Wait until experimenting-with-optimistic-locking is merged.
+  def test_locked_rolle
+    r = LockedRolle.new(:name => 'karin')
+    r.save
+    assert_equal 1, r.find_newest_version.version
+    r.name = 'zak'
+    r.save
+    assert_equal 2, r.find_newest_version.version
+  end
+=end
+
+private
+  def create_object(bezeichnung)
+    o = Rolle.new(:name => bezeichnung)
+    o.save
+    return o
+  end
+  
+  def edit_object(id, bezeichnung)
+    Rolle.find(id).update_attributes(:name=>bezeichnung)
+  end
+
+  def edit_object_with_sleep(id, bezeichnung)
+    sleep(2)
+    Rolle.find(id).update_attributes(:name=>bezeichnung)
+  end
+
+  def versions_correct?(id, highest_version)
+    result = Rolle.find(id).versions.find(:all).size == highest_version
+    1.upto(highest_version) do |current_version|
+      current_version_record = Rolle.find(id).versions.find(:first, :conditions => "version = #{current_version}")
+      result = false if current_version_record.nil? || current_version_record.deleted_in_original_table == true
+    end
+    return result
+  end
+ 
+  def timestamps?(id)
+    result = true;
+    highest_version = Rolle.find(id).versions.find(:all).size
+    highest_version.downto(1) do |current_version|
+      if current_version >= 2
+        rolle_current_version = Rolle.find(id).versions.find(:first, :conditions => "version = #{current_version}")
+        rolle_predecessor_version = Rolle.find(id).versions.find(:first, :conditions => "version = #{current_version-1}")
+        toleranz = rolle_current_version.created_at - rolle_predecessor_version.updated_at
+        result = false if toleranz > 1.0
+      end
+    end
+    return result
+  end
+  
+  def strong_timestamps?(id)
+    result = true;
+    highest_version = Rolle.find(id).versions.find(:all).size
+    highest_version.downto(2) do |current_version|
+      rolle_current_version = Rolle.find(id).versions.find(:first, :conditions => "version = #{current_version}")
+      rolle_predecessor_version = Rolle.find(id).versions.find(:first, :conditions => "version = #{current_version-1}")
+      result = false unless rolle_current_version.created_at = rolle_predecessor_version.updated_at
+      result = false unless rolle_current_version.created_at >= rolle_predecessor_version.created_at
+    end
+    return result
+  end
+
+  def destroy_record(id)
+    # Rolle.destroy(id)
+    Rolle.destroy(id)
+  end
+  
+  def record_unavailable_in_original_table?(id)
+    begin
+      Rolle.find(id)
+      return false
+    rescue
+      return true
+    end
+  end
+  
+  def deleted_record_versioned?(id, highest_version)
+    version_of_deleted_record = highest_version
+    rolle_deleted = Rolle::Version.find(:first, :conditions => "version = #{version_of_deleted_record} and rolle_id = #{id}")
+    return rolle_deleted != nil && rolle_deleted.deleted_in_original_table == true
+  end
+  
+  def restore_record(id)
+    Rolle.restore_deleted(id)
+  end
+  
+  def restored_record_available_in_original_table?(id)
+    begin
+      Rolle.find(id)
+      return true
+    rescue
+      return false
+    end
+  end
+  
+  def restored_record_versioned?(id, highest_version)
+    version_of_restored_record = highest_version
+    rolle_restored = Rolle.find(id).versions.find(:first, :conditions => "version = #{version_of_restored_record}")
+    return rolle_restored != nil && rolle_restored.deleted_in_original_table == false
+  end
+  
+  def save_record_without_changes(id)
+    versions_before_save = Rolle.find(id).versions.find(:all).size
+    rolle = Rolle.find(id)
+    rolle.update_attributes(:name=>rolle.name)
+    versions_after_save = Rolle.find(id).versions.find(:all).size
+    return versions_before_save == versions_after_save
+  end
+  
+end

data/test/versioned_test.rb

@@ -0,0 +1,384 @@
+require File.join(File.dirname(__FILE__), 'abstract_unit')
+require File.join(File.dirname(__FILE__), 'fixtures/page')
+require File.join(File.dirname(__FILE__), 'fixtures/widget')
+
+class VersionedTest < ActiveSupport::TestCase
+  fixtures :pages, :pages_h, :locked_pages, :locked_pages_revisions, :authors, :landmarks, :landmark_h
+  set_fixture_class :pages_h => Page::Version
+
+  def test_saves_versioned_copy
+    p = Page.create! :title => 'first title', :body => 'first body'
+    assert !p.new_record?
+    assert_equal 1, p.versions.size
+    assert_equal 1, p.version
+    assert_instance_of Page.versioned_class, p.versions.first
+  end
+
+  def test_saves_without_revision
+    p = pages(:welcome)
+    old_versions = p.versions.count
+
+    p.save_without_revision
+
+    p.without_revision do
+      p.update_attributes :title => 'changed'
+    end
+
+    assert_equal old_versions, p.versions.count
+  end
+
+  def test_rollback_with_version_number
+    p = pages(:welcome)
+    assert_equal 24, p.version
+    assert_equal 'Welcome to the weblog', p.title
+
+    assert p.revert_to!(23), "Couldn't revert to 23"
+    assert_equal 23, p.version
+    assert_equal 'Welcome to the weblg', p.title
+  end
+
+  def test_versioned_class_name
+    assert_equal 'Version', Page.versioned_class_name
+    assert_equal 'LockedPageRevision', LockedPage.versioned_class_name
+  end
+
+  def test_versioned_class
+    assert_equal Page::Version,                  Page.versioned_class
+    assert_equal LockedPage::LockedPageRevision, LockedPage.versioned_class
+  end
+
+  def test_special_methods
+    assert_nothing_raised { pages(:welcome).feeling_good? }
+    assert_nothing_raised { pages(:welcome).versions.first.feeling_good? }
+    assert_nothing_raised { locked_pages(:welcome).hello_world }
+    assert_nothing_raised { locked_pages(:welcome).versions.first.hello_world }
+  end
+
+  def test_rollback_with_version_class
+    p = pages(:welcome)
+    assert_equal 24, p.version
+    assert_equal 'Welcome to the weblog', p.title
+
+    assert p.revert_to!(p.versions.find_by_version(23)), "Couldn't revert to 23"
+    assert_equal 23, p.version
+    assert_equal 'Welcome to the weblg', p.title
+  end
+
+  def test_rollback_fails_with_invalid_revision
+    p = locked_pages(:welcome)
+    assert !p.revert_to!(locked_pages(:thinking))
+  end
+
+  def test_saves_versioned_copy_with_options
+    p = LockedPage.create! :title => 'first title'
+    assert !p.new_record?
+    assert_equal 1, p.versions.size
+    assert_instance_of LockedPage.versioned_class, p.versions.first
+  end
+
+  def test_rollback_with_version_number_with_options
+    p = locked_pages(:welcome)
+    assert_equal 'Welcome to the weblog', p.title
+    assert_equal 'LockedPage', p.versions.first.version_type
+
+    assert p.revert_to!(p.versions.first.lock_version), "Couldn't revert to 23"
+    assert_equal 'Welcome to the weblg', p.title
+    assert_equal 'LockedPage', p.versions.first.version_type
+  end
+
+  def test_rollback_with_version_class_with_options
+    p = locked_pages(:welcome)
+    assert_equal 'Welcome to the weblog', p.title
+    assert_equal 'LockedPage', p.versions.first.version_type
+
+    assert p.revert_to!(p.versions.first), "Couldn't revert to 1"
+    assert_equal 'Welcome to the weblg', p.title
+    assert_equal 'LockedPage', p.versions.first.version_type
+  end
+
+  def test_saves_versioned_copy_with_sti
+    p = SpecialLockedPage.create! :title => 'first title'
+    assert !p.new_record?
+    assert_equal 1, p.versions.size
+    assert_instance_of LockedPage.versioned_class, p.versions.first
+    assert_equal 'SpecialLockedPage', p.versions.first.version_type
+  end
+
+  def test_rollback_with_version_number_with_sti
+    p = locked_pages(:thinking)
+    assert_equal 'So I was thinking', p.title
+
+    assert p.revert_to!(p.versions.first.lock_version), "Couldn't revert to 1"
+    assert_equal 'So I was thinking!!!', p.title
+    assert_equal 'SpecialLockedPage', p.versions.first.version_type
+  end
+
+  def test_lock_version_works_with_versioning
+    p = locked_pages(:thinking)
+    p2 = LockedPage.find(p.id)
+
+    p.title = 'fresh title'
+    p.save
+    assert_equal 2, p.versions.size # limit!
+
+    assert_raises(ActiveRecord::StaleObjectError) do
+      p2.title = 'stale title'
+      p2.save
+    end
+  end
+
+  def test_version_if_condition
+    p = Page.create! :title => "title"
+    assert_equal 1, p.version
+
+    Page.feeling_good = false
+    p.save
+    assert_equal 1, p.version
+    Page.feeling_good = true
+  end
+
+  def test_version_if_condition2
+    # set new if condition
+    Page.class_eval do
+      def new_feeling_good() title[0..0] == 'a'; end
+      alias_method :old_feeling_good, :feeling_good?
+      alias_method :feeling_good?, :new_feeling_good
+    end
+
+    p = Page.create! :title => "title"
+    assert_equal 1, p.version # version does not increment
+    assert_equal 1, p.versions.count
+
+    p.update_attributes(:title => 'new title')
+    assert_equal 1, p.version # version does not increment
+    assert_equal 1, p.versions.count
+
+    p.update_attributes(:title => 'a title')
+    assert_equal 2, p.version
+    assert_equal 2, p.versions.count
+
+    # reset original if condition
+    Page.class_eval { alias_method :feeling_good?, :old_feeling_good }
+  end
+
+  def test_version_if_condition_with_block
+    # set new if condition
+    old_condition = Page.version_condition
+    Page.version_condition = Proc.new { |page| page.title[0..0] == 'b' }
+
+    p = Page.create! :title => "title"
+    assert_equal 1, p.version # version does not increment
+    assert_equal 1, p.versions.count
+
+    p.update_attributes(:title => 'a title')
+    assert_equal 1, p.version # version does not increment
+    assert_equal 1, p.versions.count
+
+    p.update_attributes(:title => 'b title')
+    assert_equal 2, p.version
+    assert_equal 2, p.versions.count
+
+    # reset original if condition
+    Page.version_condition = old_condition
+  end
+
+  def test_version_no_limit
+    p = Page.create! :title => "title", :body => 'first body'
+    p.save
+    p.save
+    5.times do |i|
+      p.title = "title#{i}"
+      p.save
+      assert_equal "title#{i}", p.title
+      assert_equal (i+2), p.version
+    end
+  end
+
+  def test_version_max_limit
+    p = LockedPage.create! :title => "title"
+    p.update_attributes(:title => "title1")
+    p.update_attributes(:title => "title2")
+    5.times do |i|
+      p.title = "title#{i}"
+      p.save
+      assert_equal "title#{i}", p.title
+      assert_equal (i+4), p.lock_version
+      assert p.versions(true).size <= 2, "locked version can only store 2 versions"
+    end
+  end
+
+  def test_track_altered_attributes_default_value
+    assert !Page.track_altered_attributes
+    assert LockedPage.track_altered_attributes
+    assert SpecialLockedPage.track_altered_attributes
+  end
+
+  def test_track_altered_attributes
+    p = LockedPage.create! :title => "title"
+    assert_equal 1, p.lock_version
+    assert_equal 1, p.versions(true).size
+
+    p.body = 'whoa'
+    assert !p.save_version?
+    p.save
+    assert_equal 2, p.lock_version # still increments version because of optimistic locking
+    assert_equal 1, p.versions(true).size
+
+    p.title = 'updated title'
+    assert p.save_version?
+    p.save
+    assert_equal 3, p.lock_version
+    assert_equal 1, p.versions(true).size # version 1 deleted
+
+    p.title = 'updated title!'
+    assert p.save_version?
+    p.save
+    assert_equal 4, p.lock_version
+    assert_equal 2, p.versions(true).size # version 1 deleted
+  end
+
+  def test_find_versions
+    assert_equal 1, locked_pages(:welcome).versions.find(:all, :conditions => ['title LIKE ?', '%weblog%']).size
+  end
+
+  def test_find_version
+    assert_equal pages_h(:welcome_1), pages(:welcome).versions.find_by_version(23)
+  end
+
+  def test_with_sequence
+    assert_equal 'widgets_seq', Widget.versioned_class.sequence_name
+    3.times { Widget.create! :name => 'new widget' }
+    assert_equal 3, Widget.count
+    assert_equal 3, Widget.versioned_class.count
+  end
+
+  def test_has_many_through
+    assert_equal [authors(:caged), authors(:mly)], pages(:welcome).authors
+  end
+
+  def test_has_many_through_with_custom_association
+    assert_equal [authors(:caged), authors(:mly)], pages(:welcome).revisors
+  end
+
+  def test_referential_integrity
+    pages(:welcome).destroy
+    assert_equal 0, Page.count
+    assert_equal 3, Page::Version.count
+  end
+
+  def test_association_options
+    association = Page.reflect_on_association(:versions)
+    options = association.options
+    assert_equal nil, options[:dependent]
+
+    association = Widget.reflect_on_association(:versions)
+    options = association.options
+    assert_equal :nullify, options[:dependent]
+    assert_equal 'version desc', options[:order]
+    assert_equal 'widget_id', options[:foreign_key]
+
+    widget = Widget.create! :name => 'new widget'
+    assert_equal 1, Widget.count
+    assert_equal 1, Widget.versioned_class.count
+    widget.destroy
+    assert_equal 0, Widget.count
+    assert_equal 2, Widget.versioned_class.count
+  end
+
+  def test_versioned_records_should_belong_to_parent
+    page = pages(:welcome)
+    page_version = page.versions.last
+    assert_equal page, page_version.page
+  end
+
+  def test_unaltered_attributes
+    landmarks(:washington).attributes = landmarks(:washington).attributes.except("id")
+    assert !landmarks(:washington).changed?
+  end
+
+  def test_unchanged_string_attributes
+    landmarks(:washington).attributes = landmarks(:washington).attributes.except("id").inject({}) { |params, (key, value)| params.update(key => value.to_s) }
+    assert !landmarks(:washington).changed?
+  end
+
+  def test_should_find_earliest_version
+    assert_equal pages_h(:welcome_1), pages(:welcome).versions.earliest
+  end
+
+  def test_should_find_latest_version
+    assert_equal pages_h(:welcome_2), pages(:welcome).versions.latest
+  end
+
+  def test_should_find_previous_version
+    assert_equal pages_h(:welcome_1), pages_h(:welcome_2).previous
+    assert_equal pages_h(:welcome_1), pages(:welcome).versions.before(pages_h(:welcome_2))
+  end
+
+  def test_should_find_next_version
+    assert_equal pages_h(:welcome_2), pages_h(:welcome_1).next
+    assert_equal pages_h(:welcome_2), pages(:welcome).versions.after(pages_h(:welcome_1))
+  end
+
+  def test_should_find_version_count
+    assert_equal 2, pages(:welcome).versions.size
+  end
+
+  def test_if_changed_creates_version_if_a_listed_column_is_changed
+    landmarks(:washington).name = "Washington"
+    assert landmarks(:washington).changed?
+    assert landmarks(:washington).altered?
+  end
+
+  def test_if_changed_creates_version_if_all_listed_columns_are_changed
+    landmarks(:washington).name = "Washington"
+    landmarks(:washington).latitude = 1.0
+    landmarks(:washington).longitude = 1.0
+    assert landmarks(:washington).changed?
+    assert landmarks(:washington).altered?
+  end
+
+  def test_if_changed_does_not_create_new_version_if_unlisted_column_is_changed
+    landmarks(:washington).doesnt_trigger_version = "This should not trigger version"
+    assert landmarks(:washington).changed?
+    assert !landmarks(:washington).altered?
+  end
+
+  def test_without_locking_temporarily_disables_optimistic_locking
+    enabled1 = false
+    block_called = false
+    
+    ActiveRecord::Base.lock_optimistically = true
+    LockedPage.without_locking do
+      enabled1 = ActiveRecord::Base.lock_optimistically
+      block_called = true
+    end
+    enabled2 = ActiveRecord::Base.lock_optimistically
+    
+    assert block_called
+    assert !enabled1
+    assert enabled2
+  end
+  
+  def test_without_locking_reverts_optimistic_locking_settings_if_block_raises_exception
+    assert_raises(RuntimeError) do
+      LockedPage.without_locking do
+        raise RuntimeError, "oh noes"
+      end
+    end
+    assert ActiveRecord::Base.lock_optimistically
+  end
+
+  def test_deleted_in_original_table
+    record = Page::Version.find 2
+    assert_equal false, record.deleted_in_original_table
+    record.page.title = "Title changed"
+    assert record.page.save
+
+    record = Page::Version.find 3
+    assert_equal false, record.deleted_in_original_table
+
+    record.page.destroy
+    record = Page::Version.find 4
+    assert_equal true, record.deleted_in_original_table
+  end
+end