RubyGems - mongo_mapper_acts_as_versioned - Versions diffs - 0.1.0 → 0.3.1 - Mend

mongo_mapper_acts_as_versioned 0.1.0 → 0.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (6) hide show

checksums.yaml +7 -0
data/README.md +13 -10
data/lib/acts_as_versioned.rb +115 -91
data/spec/acts_as_versioned_spec.rb +17 -17
data/spec/spec_helper.rb +1 -1
metadata +77 -43

checksums.yaml ADDED

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c49bf4f793bea61d5a8867b53f06bbb9a2da305e
+  data.tar.gz: 22854f1a7dad3d65dc35bb97ceecab1234c18041
+SHA512:
+  metadata.gz: 3f1066c0eedbb1eb1c3b1feb3d276c4cd0a30b69d37d7424812707aaf997413025824733e8a1be03948af062e5c686d9399a4a22dffc9f103ca275ba9360486c
+  data.tar.gz: f6c2ec523dfcf6caa2ae7b3d35c520937ffc104009395c3bfbc82ddf2dd7903d8a2736234149b70454579f01e3039600a800eff79e79e7be09fa5449a28a4370

data/README.md CHANGED

@@ -1,8 +1,8 @@
-# ActsAsVersioned for [MongoMapper](http://github.com/jnunemaker/mongomapper)
+# ActsAsVersioned for [MongoMapper](http://github.com/mongomapper/mongomapper)
-Basic MongoMapper port of technoweenie's [acts_as_versioned](http://github.com/technoweenie/acts_as_versioned). Stores changed attributes in a Hash key inside an Embedded Document instead of copying all keys from the original model.
+Basic MongoMapper port of technoweenie's [acts_as_versioned](http://github.com/technoweenie/acts_as_versioned).
+Stores changed attributes in a single collection using a general Hash key.
-*Note:* This plugin is intended for MongoMapper 0.8.6. The plugin architecture must be slightly changed for it to work on 0.9+.
 ## Usage
@@ -51,17 +51,20 @@ Default ignored keys are:
 ### Ignoring additional keys
-Simply add `self.non_versioned_keys << 'new_skipped_key'` somewhere in your model.
+Simply add `do_not_version 'new_skipped_key', 'another_skipped_key'` somewhere in your model.
 ## Tested with
-* MongoMapper 0.8.3
-* Ruby 1.9.2
+* MongoMapper 0.11.1, 0.13.1, 0.14.0
+* Ruby 1.9.2 up to 2.4.0
-## TODO
+## Older MongoMapper versions
-* Add loads more options
-* Properly document those options
+* For MongoMapper <= 0.8.6, see the master branch of this repository.
+## Older embedded document versions
+* See the next branch of this repository.
 ## Bundler note
@@ -69,4 +72,4 @@ Make sure to specify `:require => 'acts_as_versioned'` in your Gemfile.
 ## Copyright
-Copyright (c) 2010 Gigamo &lt;gigamo@gmail.com&gt;. See LICENSE for details.
+See LICENSE.

data/lib/acts_as_versioned.rb CHANGED

@@ -1,133 +1,157 @@
+require 'active_support/concern'
+require "active_model"
+if ActiveSupport.version >= Gem::Version.new("5.0.0")
+  begin
+    require "activemodel-serializers-xml"
+  rescue LoadError
+    warn "Couldn't load AM serializers. Things might break."
+  end
+end
+require "mongo_mapper"
 module MongoMapper
   module Acts
     module Versioned
-      VERSION   = '0.1.0'
-      CALLBACKS = [:save_version, :clear_old_versions]
+      class DocumentVersion
+        include MongoMapper::Document
-      def self.configure(model)
-        model.class_eval do
-          cattr_accessor :versioned_class_name,
-            :non_versioned_keys, :max_version_limit
+        set_collection_name "document_versions"
-          self.versioned_class_name = :Version
-          self.max_version_limit    = 0
-          self.non_versioned_keys   = %w[
-            _id _type created_at updated_at
-            creator_id updater_id version
-          ]
+        key :modified,    Hash
+        key :version,     Integer
+        key :entity_id,   ObjectId
+        key :entity_type, String
+        timestamps!
-          const_set(versioned_class_name, Class.new).class_eval do
-            include MongoMapper::EmbeddedDocument
+        belongs_to :entity, polymorphic: true
+      end
-            key :version,  Integer
-            key :modified, Hash
-          end
+      extend ActiveSupport::Concern
-          class_name = "#{self}::#{versioned_class_name}"
-          many :versions, :class => class_name.constantize do
-            def [](version)
-              detect { |doc| doc.version.to_s == version.to_s }
-            end
-          end
+      VERSION   = '0.3.1'
+      CALLBACKS = [:save_version, :clear_old_versions]
-          key :version, Integer
-          before_save :save_version
-          before_save :clear_old_versions
-        end
-      end
+      included do
+        class_attribute :non_versioned_keys, :max_version_limit
-      module InstanceMethods
-        def save_version
-          if new_record? || save_version?
-            self.version = next_version
+        self.max_version_limit    = 0
+        self.non_versioned_keys   = %w(
+          _id _type created_at updated_at
+          creator_id updater_id version
+        )
-            rev = self.class.versioned_class.new
-            clone_attributes(self, rev)
-            rev.version = version
+        key :version, Integer
+        before_save :save_version
+        before_save :clear_old_versions
+      end
-            self.versions << rev
-          end
-        end
+      def versions
+        MongoMapper::Acts::Versioned::DocumentVersion.where(
+          entity_type: self.class.name, entity_id: self.id
+        )
+      end
-        def clear_old_versions
-          return if self.class.max_version_limit == 0
-          excess_bagage = version.to_i - self.class.max_version_limit
+      def document_version(given_version)
+        versions.where(version: given_version).first
+      end
-          if excess_bagage > 0
-            versions.reject! { |v| v.version.to_i <= excess_bagage }
-          end
-        end
+      def current_document_version
+        document_version(version)
+      end
-        def revert_to(rev)
-          if rev.is_a?(self.class.versioned_class)
-            return false if rev.new_record?
-          else
-            return false unless rev = versions[rev]
-          end
+      def save_version
+        if new_record? || save_version?
+          self.version = next_version
-          clone_attributes(rev, self)
-          self.version = rev.version
+          rev = MongoMapper::Acts::Versioned::DocumentVersion.new
+          rev.entity_type = self.class.name
+          rev.entity_id = id
+          rev.version = version
-          true
-        end
+          clone_attributes(self, rev)
-        def revert_to!(rev)
-          revert_to(rev) and save_without_revision or false
+          rev.save
         end
+      end
+      def clear_old_versions
+        return if self.class.max_version_limit == 0
+        excess_bagage = version.to_i - self.class.max_version_limit
-        def save_without_revision
-          save_without_revision!
-          true
-        rescue
-          false
+        if excess_bagage > 0
+          versions.select { |v| v.version.to_i <= excess_bagage }.map(&:delete)
         end
+      end
-        def save_without_revision!
-          without_revision { save! }
+      def revert_to(rev)
+        if rev.is_a?(MongoMapper::Acts::Versioned::DocumentVersion)
+          return false if rev.new_record?
+        else
+          return false unless rev = document_version(rev)
         end
-        def clone_attributes(orig_model, new_model)
-          if orig_model.is_a?(self.class.versioned_class)
-            orig_model = orig_model.modified
-          elsif new_model.is_a?(self.class.versioned_class)
-            new_model = new_model.modified
-          end
+        clone_attributes(rev, self)
+        self.version = rev.version
-          self.class.versioned_keys.each do |attribute|
-            new_model[attribute] = orig_model[attribute]
-          end
-        end
+        true
+      end
-        def save_version?
-          (self.class.versioned_keys & changed).any?
-        end
+      def revert_to!(rev)
+        revert_to(rev) and save_without_revision or false
+      end
-        def without_revision(&block)
-          self.class.without_revision(&block)
+      def save_without_revision
+        save_without_revision!
+        true
+      rescue
+        false
+      end
+      def save_without_revision!
+        without_revision { save! }
+      end
+      def clone_attributes(orig_model, new_model)
+        if orig_model.is_a?(MongoMapper::Acts::Versioned::DocumentVersion)
+          orig_model = orig_model.modified
+        elsif new_model.is_a?(MongoMapper::Acts::Versioned::DocumentVersion)
+          new_model = new_model.modified
         end
-        def empty_callback
+        self.class.versioned_keys.each do |attribute|
+          new_model[attribute] = orig_model[attribute]
         end
+      end
+      def save_version?
+        (self.class.versioned_keys & changed).any?
+      end
-      protected
+      def without_revision(&block)
+        self.class.without_revision(&block)
+      end
-        def next_version
-          new_record? || versions.empty? ?
-            1 : versions.map(&:version).max.next
-        end
-      end # InstanceMethods
+      def empty_callback
+      end
-      module ClassMethods
-        def versioned_class
-          const_get versioned_class_name
-        end
+    protected
+      def next_version
+        new_record? || versions.count == 0 ?
+          1 : versions.fields(:version).map(&:version).max.next
+      end
+      module ClassMethods
         def versioned_keys
           keys.keys - non_versioned_keys
         end
         def do_not_version(*args)
-          self.non_versioned_keys = non_versioned_keys | args
+          self.non_versioned_keys |= args
+        end
+        def max_versions(amount)
+          self.max_version_limit = amount
         end
         def without_revision

data/spec/acts_as_versioned_spec.rb CHANGED

@@ -19,17 +19,12 @@ describe MongoMapper::Acts::Versioned do
       end
     end
-    it 'should set the correct properties on the version class' do
-      Landmark.versioned_class.should == Landmark::Version
-      Sublandmark.versioned_class.should == Landmark::Version
-    end
     it 'should save a versioned copy' do
       l = Landmark.create(:title => 'title')
-      l.new_record?.should be_false
+      l.new_record?.should be_falsy
       l.versions.size.should == 1
       l.version.should == 1
-      l.versions.first.should be_a(Landmark.versioned_class)
+      l.versions.first.should be_a(MongoMapper::Acts::Versioned::DocumentVersion)
     end
     it 'should clear old versions when a limit is set' do
@@ -80,7 +75,7 @@ describe MongoMapper::Acts::Versioned do
       l.versions.size.should == 10
       l.title.should == 'title10'
-      l.revert_to!(7).should be_true
+      l.revert_to!(7).should be_truthy
       l = l.reload
       l.version.should == 7
       l.versions.size.should == 10
@@ -99,7 +94,7 @@ describe MongoMapper::Acts::Versioned do
       l.versions.size.should == 10
       l.title.should == 'title10'
-      l.revert_to!(l.versions[7]).should be_true
+      l.revert_to!(l.document_version(7)).should be_truthy
       l = l.reload
       l.version.should == 7
       l.versions.size.should == 10
@@ -114,7 +109,7 @@ describe MongoMapper::Acts::Versioned do
       end
       l_version = l.reload.versions.last
-      l_version._root_document.should == l.reload
+      l_version.entity.should == l.reload
     end
     it 'should not create new versions for skipped keys' do
@@ -157,20 +152,25 @@ describe MongoMapper::Acts::Versioned do
     it 'should store changes in a hash' do
       l = Landmark.create(:title => 'title')
-      l.versions[1].modified.should == {'title' => 'title'}
+      l.document_version(1).modified.should == {'title' => 'title'}
       l.update_attributes(:title => 'changed title', :depth => 1)
-      l.reload.versions[2].modified.should == {'title' => 'changed title'}
+      l.reload.document_version(2).modified.should == {'title' => 'changed title'}
+    end
+    it 'should save when a version was created' do
+      l = Landmark.create(:title => 'title')
+      l.document_version(1).created_at.should be_instance_of(Time)
     end
     it 'should save a versioned class with sci' do
       s = Sublandmark.create!(:title => 'first title')
-      s.new_record?.should be_false
+      s.new_record?.should be_falsy
       s.version.should == 1
       s.versions.size.should == 1
-      s.versions.first.should be_a(Landmark.versioned_class)
-      s.versions.first._root_document.should == s
+      s.versions.first.should be_a(MongoMapper::Acts::Versioned::DocumentVersion)
+      s.versions.first.entity_type.should == "Sublandmark"
     end
     it 'should rollback with sci' do
@@ -184,7 +184,7 @@ describe MongoMapper::Acts::Versioned do
       l.version.should == 5
       l.versions.size.should == 5
       l.title.should == 'other title5'
-      l.revert_to!(3).should be_true
+      l.revert_to!(3).should be_truthy
       l = l.reload
       l.version.should == 3
       l.versions.size.should == 5
@@ -201,7 +201,7 @@ describe MongoMapper::Acts::Versioned do
       s.version.should == 5
       s.versions.size.should == 5
       s.title.should == 'title5'
-      s.revert_to!(3).should be_true
+      s.revert_to!(3).should be_truthy
       s = s.reload
       s.version.should == 3
       s.versions.size.should == 5

data/spec/spec_helper.rb CHANGED

@@ -8,7 +8,7 @@ MongoMapper.connection = Mongo::Connection.new('127.0.0.1', 27017)
 MongoMapper.database = 'test'
 MongoMapper.database.collections.each {|c| c.drop_indexes }
-Rspec.configure do |config|
+RSpec.configure do |config|
   config.after :each do
     MongoMapper.database.collections.each do |collection|
       collection.remove unless collection.name =~ /(.*\.)?system\..*/

metadata CHANGED

@@ -1,71 +1,105 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification
 name: mongo_mapper_acts_as_versioned
-version: !ruby/object:Gem::Version
-  prerelease:
-  version: 0.1.0
+version: !ruby/object:Gem::Version
+  version: 0.3.1
 platform: ruby
-authors:
+authors:
 - Gigamo
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2011-10-28 00:00:00 +02:00
-default_executable:
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: rspec
+date: 2017-05-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mongo_mapper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version
-        version: "0"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id001
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Basic MongoMapper port of technoweenie's acts_as_versioned
-email:
-- gigamo@gmail.com
+email:
+- kdwinter@protonmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
-files:
+files:
+- LICENSE
+- README.md
 - lib/acts_as_versioned.rb
 - spec/acts_as_versioned_spec.rb
 - spec/spec_helper.rb
-- LICENSE
-- README.md
-has_rdoc: true
 homepage: http://github.com/gigamo/mongo_mapper_acts_as_versioned
-licenses: []
+licenses:
+- MIT
+metadata: {}
 post_install_message:
 rdoc_options: []
-require_paths:
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
-  requirements:
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
-  requirements:
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version
+    - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
 rubyforge_project: mongo_mapper_acts_as_versioned
-rubygems_version: 1.5.0
+rubygems_version: 2.6.11
 signing_key:
-specification_version: 3
+specification_version: 4
 summary: Basic MongoMapper port of technoweenie's acts_as_versioned
 test_files: []