brianjlandau-vestal_versions 1.3.0

data/test/configuration_test.rb

@@ -0,0 +1,39 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'test_helper'))
+
+class ConfigurationTest < Test::Unit::TestCase
+  context 'Global configuration options' do
+    setup do
+      module Extension; end
+      
+      @options = {
+        'class_name' => 'CustomVersion',
+        :extend => Extension,
+        :as => :parent
+      }
+      
+      VestalVersions.configure do |config|
+        @options.each do |key, value|
+          config.send("#{key}=", value)
+        end
+      end
+
+      @configuration = VestalVersions::Configuration.options
+    end
+
+    should 'should be a hash' do
+      assert_kind_of Hash, @configuration
+    end
+
+    should 'have symbol keys' do
+      assert @configuration.keys.all?{|k| k.is_a?(Symbol) }
+    end
+
+    should 'store values identical to those given' do
+      assert_equal @options.symbolize_keys, @configuration
+    end
+
+    teardown do
+      VestalVersions::Configuration.options.clear
+    end
+  end
+end

data/test/control_test.rb

@@ -0,0 +1,152 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'test_helper'))
+
+class ControlTest < Test::Unit::TestCase
+  context 'Within a skip_version block,' do
+    setup do
+      @user = User.create(:name => 'Steve Richert')
+      @count = @user.versions.count
+    end
+
+    context 'a model update' do
+      setup do
+        @user.skip_version do
+          @user.update_attributes(:last_name => 'Jobs')
+        end
+      end
+
+      should 'not create a version' do
+        assert_equal @count, @user.versions.count
+      end
+    end
+
+    context 'multiple model updates' do
+      setup do
+        @user.skip_version do
+          @user.update_attributes(:first_name => 'Stephen')
+          @user.update_attributes(:last_name => 'Jobs')
+          @user.update_attributes(:first_name => 'Steve')
+        end
+      end
+
+      should 'not create a version' do
+        assert_equal @count, @user.versions.count
+      end
+    end
+  end
+
+  context 'Within a merge_version block,' do
+    setup do
+      @user = User.create(:name => 'Steve Richert')
+      @count = @user.versions.count
+    end
+
+    context 'a model update' do
+      setup do
+        @user.merge_version do
+          @user.update_attributes(:last_name => 'Jobs')
+        end
+      end
+
+      should 'create a version' do
+        assert_equal @count + 1, @user.versions.count
+      end
+    end
+
+    context 'multiple model updates' do
+      setup do
+        @user.merge_version do
+          @user.update_attributes(:first_name => 'Stephen')
+          @user.update_attributes(:last_name => 'Jobs')
+          @user.update_attributes(:first_name => 'Steve')
+        end
+      end
+
+      should 'create a version' do
+        assert_equal @count + 1, @user.versions.count
+      end
+    end
+  end
+
+  context 'Within a append_version block' do
+    context '(when no versions exist),' do
+      setup do
+        @user = User.create(:name => 'Steve Richert')
+        @count = @user.versions.count
+      end
+
+      context 'a model update' do
+        setup do
+          @user.append_version do
+            @user.update_attributes(:last_name => 'Jobs')
+          end
+        end
+
+        should 'create a version' do
+          assert_equal @count + 1, @user.versions.count
+        end
+      end
+
+      context 'multiple model updates' do
+        setup do
+          @user.append_version do
+            @user.update_attributes(:first_name => 'Stephen')
+            @user.update_attributes(:last_name => 'Jobs')
+            @user.update_attributes(:first_name => 'Steve')
+          end
+        end
+
+        should 'create a version' do
+          assert_equal @count + 1, @user.versions.count
+        end
+      end
+    end
+
+    context '(when versions exist),' do
+      setup do
+        @user = User.create(:name => 'Steve Richert')
+        @user.update_attributes(:last_name => 'Jobs')
+        @user.update_attributes(:last_name => 'Richert')
+        @last_version = @user.versions.last
+        @count = @user.versions.count
+      end
+
+      context 'a model update' do
+        setup do
+          @user.append_version do
+            @user.update_attributes(:last_name => 'Jobs')
+          end
+        end
+
+        should 'not create a version' do
+          assert_equal @count, @user.versions.count
+        end
+
+        should 'update the last version' do
+          last_version = @user.versions(true).last
+          assert_equal @last_version.id, last_version.id
+          assert_not_equal @last_version.attributes, last_version.attributes
+        end
+      end
+
+      context 'multiple model updates' do
+        setup do
+          @user.append_version do
+            @user.update_attributes(:first_name => 'Stephen')
+            @user.update_attributes(:last_name => 'Jobs')
+            @user.update_attributes(:first_name => 'Steve')
+          end
+        end
+
+        should 'not create a version' do
+          assert_equal @count, @user.versions.count
+        end
+
+        should 'update the last version' do
+          last_version = @user.versions(true).last
+          assert_equal @last_version.id, last_version.id
+          assert_not_equal @last_version.attributes, last_version.attributes
+        end
+      end
+    end
+  end
+end

data/test/creation_test.rb

@@ -0,0 +1,110 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'test_helper'))
+
+class CreationTest < Test::Unit::TestCase
+  context 'The number of versions' do
+    setup do
+      @name = 'Steve Richert'
+      @user = User.create(:name => @name)
+      @count = @user.versions.count
+    end
+
+    should 'initially equal zero' do
+      assert_equal 0, @count
+    end
+
+    should 'not increase when no changes are made in an update' do
+      @user.update_attributes(:name => @name)
+      assert_equal @count, @user.versions.count
+    end
+
+    should 'not increase when no changes are made before a save' do
+      @user.save
+      assert_equal @count, @user.versions.count
+    end
+
+    context 'after an update' do
+      setup do
+        @user.update_attributes(:last_name => 'Jobs')
+      end
+
+      should 'increase by one' do
+        assert_equal @count + 1, @user.versions.count
+      end
+    end
+
+    context 'after multiple updates' do
+      setup do
+        @user.update_attributes(:last_name => 'Jobs')
+        @user.update_attributes(:last_name => 'Richert')
+      end
+
+      should 'increase multiple times' do
+        assert_operator @count + 1, :<, @user.versions.count
+      end
+    end
+  end
+
+  context "A created version's changes" do
+    setup do
+      @user = User.create(:name => 'Steve Richert')
+      @user.update_attributes(:last_name => 'Jobs')
+    end
+
+    should 'not contain Rails timestamps' do
+      %w(created_at created_on updated_at updated_on).each do |timestamp|
+        assert_does_not_contain @user.versions.last.changes.keys, timestamp
+      end
+    end
+
+    context '(with :only options)' do
+      setup do
+        @only = %w(first_name)
+        User.prepare_versioned_options(:only => @only)
+        @user.update_attributes(:name => 'Steven Tyler')
+      end
+
+      should 'only contain the specified columns' do
+        assert_equal @only, @user.versions.last.changes.keys
+      end
+
+      teardown do
+        User.prepare_versioned_options(:only => nil)
+      end
+    end
+
+    context '(with :except options)' do
+      setup do
+        @except = %w(first_name)
+        User.prepare_versioned_options(:except => @except)
+        @user.update_attributes(:name => 'Steven Tyler')
+      end
+
+      should 'not contain the specified columns' do
+        @except.each do |column|
+          assert_does_not_contain @user.versions.last.changes.keys, column
+        end
+      end
+
+      teardown do
+        User.prepare_versioned_options(:except => nil)
+      end
+    end
+
+    context '(with both :only and :except options)' do
+      setup do
+        @only = %w(first_name)
+        @except = @only
+        User.prepare_versioned_options(:only => @only, :except => @except)
+        @user.update_attributes(:name => 'Steven Tyler')
+      end
+
+      should 'respect only the :only options' do
+        assert_equal @only, @user.versions.last.changes.keys
+      end
+
+      teardown do
+        User.prepare_versioned_options(:only => nil, :except => nil)
+      end
+    end
+  end
+end

data/test/deletion_test.rb

@@ -0,0 +1,121 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'test_helper'))
+
+class DeletionTest < Test::Unit::TestCase
+  # context 'The number of versions' do
+  #   setup do
+  #     @name = 'Steve Richert'
+  #     @user = User.create(:name => @name)
+  #     @count = @user.versions.count
+  #   end
+  # 
+  #   should 'initially equal zero' do
+  #     assert_equal 0, @count
+  #   end
+  # 
+  #   should 'not increase when no changes are made in an update' do
+  #     @user.update_attributes(:name => @name)
+  #     assert_equal @count, @user.versions.count
+  #   end
+  # 
+  #   should 'not increase when no changes are made before a save' do
+  #     @user.save
+  #     assert_equal @count, @user.versions.count
+  #   end
+  # 
+  #   context 'after an update' do
+  #     setup do
+  #       @user.update_attributes(:last_name => 'Jobs')
+  #     end
+  # 
+  #     should 'increase by one' do
+  #       assert_equal @count + 1, @user.versions.count
+  #     end
+  #   end
+  # 
+  #   context 'after multiple updates' do
+  #     setup do
+  #       @user.update_attributes(:last_name => 'Jobs')
+  #       @user.update_attributes(:last_name => 'Richert')
+  #     end
+  # 
+  #     should 'increase multiple times' do
+  #       assert_operator @count + 1, :<, @user.versions.count
+  #     end
+  #   end
+  # end
+
+  context "A deleted version's changes" do
+    setup do
+      @user = DeletedUser.create(:first_name => 'Steve', :last_name => 'Richert')
+      @user.update_attributes(:last_name => 'Jobs')
+      @original_version_count = VestalVersions::Version.count
+      @user.destroy
+      @user_id = @user.id
+    end
+    
+    should "remove the original record" do
+      assert_equal nil, DeletedUser.find_by_id(@user_id)
+    end
+
+    should "create another version record" do
+      assert_equal @original_version_count + 1, VestalVersions::Version.count
+    end
+    
+    should "create a version with a tag 'deleted'" do
+      assert_equal 'deleted', VestalVersions::Version.last.tag
+    end
+
+  end
+  
+  context "restoring a deleted version" do
+    setup do
+      @user = DeletedUser.create(:first_name => 'Steve', :last_name => 'Richert')
+      @user.update_attributes(:last_name => 'Jobs')
+      @user.destroy
+      @last_version = VestalVersions::Version.last
+    end
+    should "be able to restore the user record" do
+      @last_version.restore!
+      assert_equal @user, @last_version.versioned
+    end
+    should "remove the last versioned entry" do
+      old_version_count = VestalVersions::Version.count
+      @last_version.restore!
+      assert_equal old_version_count - 1, VestalVersions::Version.count
+    end
+    should "work properly even if it's not on the proper version" do
+      another_version = VestalVersions::Version.find(:first, :conditions => {:versioned_id => @last_version.versioned_id, :versioned_type => @last_version.versioned_type})
+      assert_not_equal another_version, @last_version
+
+      restored_user = another_version.restore!
+
+      assert_equal @user, restored_user
+    end
+    should "restore even if the schema has changed" do
+      @last_version.update_attributes(:modifications => @last_version.modifications.merge(:old_column => 'old'))
+      user = @last_version.restore
+      assert_equal user, @user
+    end
+  end
+  context "restoring a deleted version without save" do
+    setup do
+      @user = DeletedUser.create(:first_name => 'Steve', :last_name => 'Richert')
+      @user.update_attributes(:last_name => 'Jobs')
+      @user.destroy
+      @last_version = VestalVersions::Version.last
+    end
+    should "not save the DeletedUser when restoring" do
+      user = @last_version.restore
+      assert_equal user.new_record?, true
+    end
+    should "restore the user object properly" do
+      user = @last_version.restore
+      assert_equal user, @user
+    end
+    should "not decrement the versions table" do
+      old_version_count = VestalVersions::Version.count
+      @last_version.restore
+      assert_equal old_version_count, VestalVersions::Version.count
+    end
+  end
+end

data/test/options_test.rb

@@ -0,0 +1,52 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'test_helper'))
+
+class OptionsTest < Test::Unit::TestCase
+  context 'Configuration options' do
+    setup do
+      @options = {:dependent => :destroy}
+      @configuration = {:class_name => 'MyCustomVersion'}
+
+      VestalVersions::Configuration.options.clear
+      @configuration.each{|k,v| VestalVersions::Configuration.send("#{k}=", v) }
+
+      @prepared_options = User.prepare_versioned_options(@options.dup)
+    end
+
+    should 'have symbolized keys' do
+      assert User.vestal_versions_options.keys.all?{|k| k.is_a?(Symbol) }
+    end
+
+    should 'combine class-level and global configuration options' do
+      combined_keys = (@options.keys + @configuration.keys).map(&:to_sym).uniq
+      combined_options = @configuration.symbolize_keys.merge(@options.symbolize_keys)
+      assert_equal @prepared_options.slice(*combined_keys), combined_options
+    end
+
+    teardown do
+      VestalVersions::Configuration.options.clear
+      User.prepare_versioned_options({})
+    end
+  end
+
+  context 'Given no options, configuration options' do
+    setup do
+      @prepared_options = User.prepare_versioned_options({})
+    end
+
+    should 'default to "VestalVersions::Version" for :class_name' do
+      assert_equal 'VestalVersions::Version', @prepared_options[:class_name]
+    end
+
+    should 'default to :delete_all for :dependent' do
+      assert_equal :delete_all, @prepared_options[:dependent]
+    end
+
+    should 'force the :as option value to :versioned' do
+      assert_equal :versioned, @prepared_options[:as]
+    end
+
+    should 'default to [VestalVersions::Versions] for :extend' do
+      assert_equal [VestalVersions::Versions], @prepared_options[:extend]
+    end
+  end
+end