vestal_versions 0.8.3 → 1.0.0

data/rails_generators/vestal_versions/templates/initializer.rb

@@ -0,0 +1,9 @@
+VestalVersions.configure do |config|
+  # Place any global options here. For example, in order to specify your own version model to use
+  # throughout the application, simply specify:
+  #
+  # config.class_name = "MyCustomVersion"
+  #
+  # Any options passed to the "versioned" method in the model itself will override this global
+  # configuration.
+end

data/{generators/vestal_versions_migration → rails_generators/vestal_versions}/templates/migration.rb

@@ -2,14 +2,21 @@ class CreateVestalVersions < ActiveRecord::Migration
   def self.up
     create_table :versions do |t|
       t.belongs_to :versioned, :polymorphic => true
+      t.belongs_to :user, :polymorphic => true
+      t.string :user_name
       t.text :changes
       t.integer :number
-      t.datetime :created_at
+      t.string :tag
+
+      t.timestamps
     end
 
     change_table :versions do |t|
-      t.index [:versioned_type, :versioned_id]
+      t.index [:versioned_id, :versioned_type]
+      t.index [:user_id, :user_type]
+      t.index :user_name
       t.index :number
+      t.index :tag
       t.index :created_at
     end
   end

data/rails_generators/vestal_versions/vestal_versions_generator.rb

@@ -0,0 +1,10 @@
+class VestalVersionsGenerator < Rails::Generator::Base
+  def manifest
+    record do |m|
+      m.migration_template 'migration.rb', File.join('db', 'migrate'), :migration_file_name => 'create_vestal_versions'
+
+      m.directory File.join('config', 'initializers')
+      m.template 'initializer.rb', File.join('config', 'initializers', 'vestal_versions.rb')
+    end
+  end
+end

data/test/changes_test.rb

@@ -1,28 +1,169 @@
-require 'test_helper'
+require File.join(File.dirname(__FILE__), 'test_helper')
 
 class ChangesTest < Test::Unit::TestCase
   context "A version's changes" do
     setup do
       @user = User.create(:name => 'Steve Richert')
+      @user.update_attribute(:last_name, 'Jobs')
+      @changes = @user.versions.last.changes
     end
 
-    should "initially be blank" do
-      assert @user.versions.first.changes.blank?
+    should 'be a hash' do
+      assert_kind_of Hash, @changes
     end
 
-    should 'contain all changed attributes' do
-      @user.name = 'Steve Jobs'
-      changes = @user.changes
-      @user.save
-      assert_equal changes, @user.versions.last.changes.slice(*changes.keys)
+    should 'not be empty' do
+      assert !@changes.empty?
+    end
+
+    should 'have string keys' do
+      @changes.keys.each do |key|
+        assert_kind_of String, key
+      end
+    end
+
+    should 'have array values' do
+      @changes.values.each do |value|
+        assert_kind_of Array, value
+      end
     end
 
-    should 'contain no more than the changed attributes and timestamps' do
-      timestamps = %w(created_at created_on updated_at updated_on)
-      @user.name = 'Steve Jobs'
-      changes = @user.changes
+    should 'have two-element values' do
+      @changes.values.each do |value|
+        assert_equal 2, value.size
+      end
+    end
+
+    should 'have unique-element values' do
+      @changes.values.each do |value|
+        assert_equal value.uniq, value
+      end
+    end
+
+    should "equal the model's changes" do
+      @user.first_name = 'Stephen'
+      model_changes = @user.changes
       @user.save
-      assert_equal changes, @user.versions.last.changes.except(*timestamps)
+      changes = @user.versions.last.changes
+      assert_equal model_changes, changes
+    end
+  end
+
+  context 'A hash of changes' do
+    setup do
+      @changes = {'first_name' => ['Steve', 'Stephen']}
+      @other = {'first_name' => ['Catie', 'Catherine']}
+    end
+
+    should 'properly append other changes' do
+      expected = {'first_name' => ['Steve', 'Catherine']}
+      changes = @changes.append_changes(@other)
+      assert_equal expected, changes
+      @changes.append_changes!(@other)
+      assert_equal expected, @changes
+    end
+
+    should 'properly prepend other changes' do
+      expected = {'first_name' => ['Catie', 'Stephen']}
+      changes = @changes.prepend_changes(@other)
+      assert_equal expected, changes
+      @changes.prepend_changes!(@other)
+      assert_equal expected, @changes
+    end
+
+    should 'be reversible' do
+      expected = {'first_name' => ['Stephen', 'Steve']}
+      changes = @changes.reverse_changes
+      assert_equal expected, changes
+      @changes.reverse_changes!
+      assert_equal expected, @changes
+    end
+  end
+
+  context 'The changes between two versions' do
+    setup do
+      name = 'Steve Richert'
+      @user = User.create(:name => name)              # 1
+      @user.update_attribute(:last_name, 'Jobs')      # 2
+      @user.update_attribute(:first_name, 'Stephen')  # 3
+      @user.update_attribute(:last_name, 'Richert')   # 4
+      @user.update_attribute(:name, name)             # 5
+      @version = @user.version
+    end
+
+    should 'be a hash' do
+      1.upto(@version) do |i|
+        1.upto(@version) do |j|
+          changes = @user.changes_between(i, j)
+          assert_kind_of Hash, changes
+        end
+      end
+    end
+
+    should 'have string keys' do
+      1.upto(@version) do |i|
+        1.upto(@version) do |j|
+          changes = @user.changes_between(i, j)
+          changes.keys.each do |key|
+            assert_kind_of String, key
+          end
+        end
+      end
+    end
+
+    should 'have array values' do
+      1.upto(@version) do |i|
+        1.upto(@version) do |j|
+          changes = @user.changes_between(i, j)
+          changes.values.each do |value|
+            assert_kind_of Array, value
+          end
+        end
+      end
+    end
+
+    should 'have two-element values' do
+      1.upto(@version) do |i|
+        1.upto(@version) do |j|
+          changes = @user.changes_between(i, j)
+          changes.values.each do |value|
+            assert_equal 2, value.size
+          end
+        end
+      end
+    end
+
+    should 'have unique-element values' do
+      1.upto(@version) do |i|
+        1.upto(@version) do |j|
+          changes = @user.changes_between(i, j)
+          changes.values.each do |value|
+            assert_equal value.uniq, value
+          end
+        end
+      end
+    end
+
+    should 'be empty between identical versions' do
+      assert @user.changes_between(1, @version).empty?
+      assert @user.changes_between(@version, 1).empty?
+    end
+
+    should 'be should reverse with direction' do
+      1.upto(@version) do |i|
+        i.upto(@version) do |j|
+          up    = @user.changes_between(i, j)
+          down  = @user.changes_between(j, i)
+          assert_equal up, down.reverse_changes
+        end
+      end
+    end
+
+    should 'be empty with invalid arguments' do
+      1.upto(@version) do |i|
+        assert @user.changes_between(i, nil)
+        assert @user.changes_between(nil, i)
+      end
     end
   end
 end

data/test/conditions_test.rb

@@ -0,0 +1,137 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class ConditionsTest < Test::Unit::TestCase
+  context 'Converted :if conditions' do
+    setup do
+      User.class_eval do
+        def true; true; end
+      end
+    end
+
+    should 'be an array' do
+      assert_kind_of Array, User.vestal_versions_options[:if]
+      User.prepare_versioned_options(:if => :true)
+      assert_kind_of Array, User.vestal_versions_options[:if]
+    end
+
+    should 'have proc values' do
+      User.prepare_versioned_options(:if => :true)
+      assert User.vestal_versions_options[:if].all?{|i| i.is_a?(Proc) }
+    end
+
+    teardown do
+      User.prepare_versioned_options(:if => [])
+    end
+  end
+
+  context 'Converted :unless conditions' do
+    setup do
+      User.class_eval do
+        def true; true; end
+      end
+    end
+
+    should 'be an array' do
+      assert_kind_of Array, User.vestal_versions_options[:unless]
+      User.prepare_versioned_options(:unless => :true)
+      assert_kind_of Array, User.vestal_versions_options[:unless]
+    end
+
+    should 'have proc values' do
+      User.prepare_versioned_options(:unless => :true)
+      assert User.vestal_versions_options[:unless].all?{|i| i.is_a?(Proc) }
+    end
+
+    teardown do
+      User.prepare_versioned_options(:unless => [])
+    end
+  end
+
+  context 'A new version' do
+    setup do
+      User.class_eval do
+        def true; true; end
+        def false; false; end
+      end
+
+      @user = User.create(:name => 'Steve Richert')
+      @count = @user.versions.count
+    end
+
+    context 'with :if conditions' do
+      context 'that pass' do
+        setup do
+          User.prepare_versioned_options(:if => [:true])
+          @user.update_attribute(:last_name, 'Jobs')
+        end
+
+        should 'be created' do
+          assert_equal @count + 1, @user.versions.count
+        end
+      end
+
+      context 'that fail' do
+        setup do
+          User.prepare_versioned_options(:if => [:false])
+          @user.update_attribute(:last_name, 'Jobs')
+        end
+
+        should 'not be created' do
+          assert_equal @count, @user.versions.count
+        end
+      end
+    end
+
+    context 'with :unless conditions' do
+      context 'that pass' do
+        setup do
+          User.prepare_versioned_options(:unless => [:true])
+          @user.update_attribute(:last_name, 'Jobs')
+        end
+
+        should 'not be created' do
+          assert_equal @count, @user.versions.count
+        end
+      end
+
+      context 'that fail' do
+        setup do
+          User.prepare_versioned_options(:unless => [:false])
+          @user.update_attribute(:last_name, 'Jobs')
+        end
+
+        should 'not be created' do
+          assert_equal @count + 1, @user.versions.count
+        end
+      end
+    end
+
+    context 'with :if and :unless conditions' do
+      context 'that pass' do
+        setup do
+          User.prepare_versioned_options(:if => [:true], :unless => [:true])
+          @user.update_attribute(:last_name, 'Jobs')
+        end
+
+        should 'not be created' do
+          assert_equal @count, @user.versions.count
+        end
+      end
+
+      context 'that fail' do
+        setup do
+          User.prepare_versioned_options(:if => [:false], :unless => [:false])
+          @user.update_attribute(:last_name, 'Jobs')
+        end
+
+        should 'not be created' do
+          assert_equal @count, @user.versions.count
+        end
+      end
+    end
+
+    teardown do
+      User.prepare_versioned_options(:if => [], :unless => [])
+    end
+  end
+end

data/test/configuration_test.rb

@@ -0,0 +1,39 @@
+require 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.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_attribute(: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_attribute(:first_name, 'Stephen')
+          @user.update_attribute(:last_name, 'Jobs')
+          @user.update_attribute(: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_attribute(: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_attribute(:first_name, 'Stephen')
+          @user.update_attribute(:last_name, 'Jobs')
+          @user.update_attribute(: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_attribute(: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_attribute(:first_name, 'Stephen')
+            @user.update_attribute(:last_name, 'Jobs')
+            @user.update_attribute(: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_attribute(:last_name, 'Jobs')
+        @user.update_attribute(: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_attribute(: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.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_attribute(:first_name, 'Stephen')
+            @user.update_attribute(:last_name, 'Jobs')
+            @user.update_attribute(: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.last
+          assert_equal @last_version.id, last_version.id
+          assert_not_equal @last_version.attributes, last_version.attributes
+        end
+      end
+    end
+  end
+end