mongo_mapper_acts_as_versioned 0.0.3 → 0.0.4

data/README.md

@@ -43,11 +43,13 @@ Default ignored keys are:
 * "creator\_id"
 * "updater\_id"
 * "version"
-* the versioned class' foreign key
+* "\_type"
+* "\_versioned\_type"
+* versioned\_foreign\_key
 
 ### Ignoring additional keys
 
-Simply add `self.skipped_keys << 'new_skipped_key'` somewhere in your model.
+Simply add `self.non_versioned_keys << 'new_skipped_key'` somewhere in your model.
 
 ## Tested with
 
@@ -58,7 +60,6 @@ Simply add `self.skipped_keys << 'new_skipped_key'` somewhere in your model.
 
 * Add loads more options
 * Properly document those options
-* Support SCI
 
 ## Bundler note
 

data/lib/acts_as_versioned.rb

@@ -1,27 +1,48 @@
 module MongoMapper
   module Acts
     module Versioned
+      VERSION   = '0.0.4'
       CALLBACKS = [:set_new_version, :save_version, :save_version?]
 
       def self.configure(model)
         model.class_eval do
-          const_set(:Version, Class.new).class_eval do
+          cattr_accessor :versioned_class_name, :versioned_foreign_key,
+                         :versioned_collection_name, :non_versioned_keys
+
+          self.versioned_class_name      = :Version
+          self.versioned_foreign_key     = self.to_s.foreign_key
+          self.versioned_collection_name = "#{collection_name.singularize}_versions"
+          self.non_versioned_keys        = [
+            '_id', 'created_at', 'updated_at', 'creator_id',
+            'updater_id', 'version', versioned_foreign_key,
+            '_type', '_version_type'
+          ]
+
+          const_set(versioned_class_name, Class.new).class_eval do
             include MongoMapper::Document
 
+            class << self
+              delegate :versioned_foreign_key, :to => :original_class
+            end
+
             key :version,            Integer
             key :changed_attributes, Hash
 
+            if type_key = keys['_type']
+              key :_version_type, type_key.type, type_key.options
+            end
+
             def self.before(version)
               where(
-                super_foreign_key => version[super_foreign_key],
-                :version.lt       => version.version
+                versioned_foreign_key => version[versioned_foreign_key],
+                :version.lt           => version.version
               ).sort(:version.desc).first
             end
 
             def self.after(version)
               where(
-                super_foreign_key => version[super_foreign_key],
-                :version.gt       => version.version
+                versioned_foreign_key => version[versioned_foreign_key],
+                :version.gt           => version.version
               ).sort(:version.asc).first
             end
 
@@ -32,37 +53,33 @@ module MongoMapper
             def next
               self.class.after(self)
             end
-
-            def self.super_foreign_key
-              original_class.to_s.foreign_key
-            end
-
-            class << self
-              protected :super_foreign_key
-            end
           end
 
           versioned_class.cattr_accessor :original_class
           versioned_class.original_class = self
-          versioned_class.set_collection_name "#{self.collection_name.singularize}_versions"
+          versioned_class.set_collection_name versioned_collection_name
           versioned_class.belongs_to self.to_s.demodulize.underscore.to_sym,
-                                     :class_name  => "::#{self}",
-                                     :foreign_key => self.to_s.foreign_key
-        end
+            :class_name  => self.to_s,
+            :foreign_key => versioned_foreign_key
 
-        model.key :version, Integer
-        model.many :versions, :class_name => "#{model}::Version",
-                   :foreign_key => model.to_s.foreign_key, :dependent => :destroy do
-          def earliest
-            query.sort(:version).first
-          end
+          key :version, Integer
 
-          def latest
-            query.sort(:version.desc).first
+          many :versions,
+            :class_name => "#{self}::#{versioned_class_name}",
+            :foreign_key => versioned_foreign_key,
+            :dependent => :destroy do
+            def earliest
+              query.sort(:version).first
+            end
+
+            def latest
+              query.sort(:version.desc).first
+            end
           end
+
+          before_save :set_new_version
+          after_save  :save_version
         end
-        model.before_save :set_new_version
-        model.after_save  :save_version
       end
 
       module InstanceMethods
@@ -73,14 +90,14 @@ module MongoMapper
             rev = self.class.versioned_class.new
             clone_versioned_model(self, rev)
             rev.version = version
-            rev[self.class.to_s.foreign_key] = id
+            rev[self.class.versioned_foreign_key] = id
             rev.save!
           end
         end
 
         def revert_to(version)
           if version.is_a?(self.class.versioned_class)
-            return false unless version[self.class.to_s.foreign_key] == id and !version.new_record?
+            return false unless version[self.class.versioned_foreign_key] == id and !version.new_record?
           else
             return false unless version = versions.where(:version => version).first
           end
@@ -110,11 +127,11 @@ module MongoMapper
 
         def clone_versioned_model(orig_model, new_model)
           if orig_model.is_a?(self.class.versioned_class)
+            new_model['_type'] = orig_model['_version_type']
             orig_model = orig_model.changed_attributes
-          end
-
-          if new_model.is_a?(self.class.versioned_class)
-            new_model = new_model.changed_attributes 
+          elsif new_model.is_a?(self.class.versioned_class)
+            new_model['_version_type'] = orig_model['_type']
+            new_model = new_model.changed_attributes
           end
 
           self.class.versioned_keys.each do |col|
@@ -141,17 +158,17 @@ module MongoMapper
         end
 
         def next_version
-          (new_record? ? 0 : versions.map(&:version).max) + 1
+          new_record? || versions.empty? ? 1 : versions.map(&:version).max.next
         end
       end
 
       module ClassMethods
         def versioned_class
-          const_get(:Version)
+          const_get versioned_class_name
         end
 
         def versioned_keys
-          keys.keys - skipped_keys
+          keys.keys - non_versioned_keys
         end
 
         def without_revision
@@ -169,13 +186,6 @@ module MongoMapper
             end
           end
         end
-
-        def skipped_keys
-          @skipped_keys ||= [
-            '_id', 'created_at', 'updated_at', 'creator_id',
-            'updater_id', 'version', self.class.to_s.foreign_key
-          ]
-        end
       end
     end
   end

data/spec/acts_as_versioned_spec.rb

@@ -7,18 +7,25 @@ describe MongoMapper::Acts::Versioned do
 
       plugin MongoMapper::Acts::Versioned
 
-      self.skipped_keys << 'depth'
+      self.non_versioned_keys << 'depth'
 
       key :title, String
       key :depth, Integer
       timestamps!
     end
+
+    class Sublandmark < Landmark
+      key :location, String
+    end
   end
 
   it 'should set the correct properties on the version class' do
     Landmark::Version.original_class.should == Landmark
     Landmark::Version.collection_name.should == 'landmark_versions'
     Landmark.versioned_class.should == Landmark::Version
+    Sublandmark::Version.original_class.should == Landmark
+    Sublandmark::Version.collection_name.should == 'landmark_versions'
+    Sublandmark.versioned_class.should == Landmark::Version
   end
 
   it 'should save a versioned copy' do
@@ -53,7 +60,6 @@ describe MongoMapper::Acts::Versioned do
     (2..10).each do |i|
       l = Landmark.first
       l.update_attributes(:title => "title#{i}")
-      l.version.should == i
     end
 
     l = l.reload
@@ -73,7 +79,6 @@ describe MongoMapper::Acts::Versioned do
     (2..10).each do |i|
       l = Landmark.first
       l.update_attributes(:title => "title#{i}")
-      l.version.should == i
     end
 
     l = l.reload
@@ -93,7 +98,6 @@ describe MongoMapper::Acts::Versioned do
     (2..10).each do |i|
       l = Landmark.first
       l.update_attributes(:title => "title#{i}")
-      l.version.should == i
     end
 
     l_version = l.reload.versions.last
@@ -171,4 +175,57 @@ describe MongoMapper::Acts::Versioned do
       @l.versions[0].next.should == @l.versions[1]
     end
   end
+
+  it 'should save a versioned class with sci' do
+    s = Sublandmark.create!(:title => 'first title')
+    s.new_record?.should be_false
+    s.version.should == 1
+
+    s.versions.size.should == 1
+    s.versions.first.should be_a(Landmark.versioned_class)
+    s.versions.first.attributes.keys.should include('_version_type')
+    s.versions.first._version_type.should == 'Sublandmark'
+    s.versions.first.landmark.should == s
+  end
+
+  it 'should rollback with sti' do
+    s = Sublandmark.create(:title => 'title')
+    (2..5).each do |i|
+      s = Sublandmark.first
+      s.update_attributes(:title => "title#{i}")
+    end
+
+    s = s.reload
+    s.version.should == 5
+    s.versions.size.should == 5
+    s.title.should == 'title5'
+    s.revert_to!(3).should be_true
+    s = s.reload
+    s.version.should == 3
+    s.versions.size.should == 5
+    s.title.should == 'title3'
+
+    s.versions.each do |version|
+      version._version_type.should == 'Sublandmark'
+    end
+
+    l = Landmark.create(:title => 'other title')
+    (2..5).each do |i|
+      l = Landmark.first
+      l.update_attributes(:title => "other title#{i}")
+    end
+
+    l = l.reload
+    l.versions.should_not == s.versions
+    l.version.should == 5
+    l.versions.size.should == 5
+    l.title.should == 'other title5'
+    l.revert_to!(3).should be_true
+    l = l.reload
+    l.version.should == 3
+    l.versions.size.should == 5
+    l.title.should == 'other title3'
+
+    Landmark::Version.count.should == 10
+  end
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Gigamo
@@ -40,7 +40,6 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- lib/acts_as_versioned/version.rb
 - lib/acts_as_versioned.rb
 - spec/acts_as_versioned_spec.rb
 - spec/spec_helper.rb

data/lib/acts_as_versioned/version.rb

@@ -1,7 +0,0 @@
-module MongoMapper
-  module Acts
-    module Versioned
-      VERSION = '0.0.3'
-    end
-  end
-end