mongo_mapper_versioned 0.1

data/README.rdoc

@@ -0,0 +1 @@
+WORK IN PROGRESS

data/lib/mongo_mapper/plugins/models/version.rb

@@ -0,0 +1,20 @@
+module MongoMapper
+  module Plugins
+    module Versioned
+      class Version
+
+        include MongoMapper::Document
+        
+        # stores id of versioned document
+        key :versioned_id, ObjectId
+        
+        # stores version number
+        key :version_number, Integer
+        
+        # stores versioned attributes
+        key :data, Hash
+
+      end
+    end
+  end
+end

data/lib/mongo_mapper/plugins/version.rb

@@ -0,0 +1,8 @@
+# encoding: UTF-8
+module MongoMapper
+  module Plugins
+    module Versioned
+      Version = '0.1'
+    end
+  end
+end

data/lib/mongo_mapper/plugins/versioned.rb

@@ -0,0 +1,60 @@
+module MongoMapper
+  module Plugins
+    module Versioned
+
+      module ClassMethods
+        def versioned(options={})
+          configuration = { :ignored_keys => %w(_id version_number created_at updated_at creator_id updater_id) }
+          configuration.update(options) if options.is_a?(Hash)
+          
+          key   :version_number, Integer, :default => 1, :index => true
+          many  :versions, :class => MongoMapper::Plugins::Versioned::Version, :foreign_key => :versioned_id, :dependent => :destroy, :order => :version_number.asc
+
+          after_create  :create_version
+          before_update :create_version, :if => Proc.new{ |doc| doc.should_create_version? }
+          
+          define_method "ignored_keys" do
+            configuration[:ignored_keys]
+          end
+        end
+      end
+      
+      
+      
+      module InstanceMethods
+        
+        def create_version
+          self.version_number = version_count + 1 if (version_count > 0)
+          self.versions << current_version
+        end
+        
+        def revert_to(target_version_number)
+          if target_version = version_at(target_version_number)
+            self.attributes = target_version.data
+            self.version_number = target_version.version_number
+          end
+        end
+
+        def version_count
+          self.versions.count
+        end
+
+        def current_version
+          Version.new(:data => self.attributes.slice!(*ignored_keys), :versioned_id => self.id, :version_number => self.version_number)
+        end
+    
+        def version_at(target_version_number)
+          versions.where(:version_number => target_version_number).first
+        end
+     
+        # this method might be overwritten
+        # by something more sophisticated (esp. in case of EmbeddedDocuments)
+        def should_create_version?
+          changes.slice!(*ignored_keys).size > 0
+        end
+    
+      end
+    
+    end
+  end
+end

data/test/mongo_mapper_versioned_test.rb

@@ -0,0 +1,152 @@
+require 'test_helper'
+
+
+
+# CLASS SETUP
+
+class VersionedDoc
+  include MongoMapper::Document
+  plugin MongoMapper::Plugins::Versioned
+  
+  key :title, String
+  key :body, String
+  
+  versioned :ignored_keys => ['body']
+end
+
+
+# TESTS
+
+class VersionedTest < ActiveSupport::TestCase
+  
+  context "by default" do
+    setup do
+      @doc = VersionedDoc.new
+    end
+    should "be on version 1" do
+      assert_equal 1, @doc.version_number
+    end
+    should "have 0 versions" do
+      assert_equal 0, @doc.version_count
+    end
+  end
+  
+  context "when created" do
+    setup do
+      @doc = VersionedDoc.create(:title => "Famfula")
+    end
+    should "be on version 1" do
+      assert_equal 1, @doc.version_number
+    end
+    should "have 1 (initial) version" do
+      assert_equal 1, @doc.version_count
+    end
+    
+    context "when saved with no changes" do
+      setup do
+        @version_count = @doc.version_count
+        @version_number = @doc.version_number
+        @doc.save
+      end
+      should "still be at version 1" do
+        assert_equal @version_number, @doc.version_number
+      end
+      should "not create new version" do
+        assert_equal @version_count, @doc.version_count
+      end
+    end
+    
+    context "after a change" do
+      setup do
+        @version_count = @doc.version_count
+        @version_number = @doc.version_number
+        @title = @doc.title
+        @doc.update_attributes(:title => "Krabaty")
+      end
+      should "increase number of versions" do
+        assert_equal @version_count+1, @doc.version_count
+      end
+      should "increase version number" do
+        assert_equal @version_number+1, @doc.version_number
+      end
+    end
+    
+  end
+  
+  context "when reverting" do
+    setup do
+      @doc = VersionedDoc.create(:title => "Vaclav", :body => "Kroupa")
+      @doc.update_attributes(:title => "Slavoj", :body => "Zizek")
+      @doc.update_attributes(:title => "Karel", :body => "Martens")
+      @doc.update_attributes(:title => "Keren", :body => "Cytter")
+      @doc.update_attributes(:title => "Jon", :body => "Arnett")
+    end
+    
+    context "to first version" do
+      setup do
+        @doc.revert_to(1)
+      end
+      should "be at version 1" do
+        assert_equal 1, @doc.version_number
+      end
+      should "have correct attributes" do
+        assert_equal "Vaclav", @doc.title
+      end
+      should "not revert ignored attributes" do
+        assert_equal "Arnett", @doc.body
+      end
+      should "not create new version" do
+        assert_equal 5, @doc.version_count
+      end
+    end
+    
+    context "to version 2" do
+      setup do
+        @doc.revert_to(2)
+      end
+      should "be at version 2" do
+        assert_equal 2, @doc.version_number
+      end
+      should "have correct attributes" do
+        assert_equal "Slavoj", @doc.title
+      end
+      should "not revert ignored attributes" do
+        assert_equal "Arnett", @doc.body
+      end
+      should "not create new version" do
+        assert_equal 5, @doc.version_count
+      end
+      context "after save" do
+        setup do
+          @doc.save
+        end
+        should "be at version 6" do
+          assert_equal 6, @doc.version_number
+        end
+        should "have 6 versions" do
+          assert_equal 6, @doc.version_count
+        end
+      end
+      
+    end
+    
+    context "to version 5" do
+      setup do
+        @doc.revert_to(5)
+      end
+      should "be at version 5" do
+        assert_equal 5, @doc.version_number
+      end
+      should "have correct attributes" do
+        assert_equal "Jon", @doc.title
+      end
+      should "not revert ignored attributes" do
+        assert_equal "Arnett", @doc.body
+      end
+      should "not create new version" do
+        assert_equal 5, @doc.version_count
+      end
+    end
+    
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,34 @@
+require 'rubygems'
+$:.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
+
+require 'mongo_mapper'
+require 'mongo_mapper/plugins/versioned'
+require 'mongo_mapper/plugins/models/version'
+require 'test/unit'
+require 'shoulda'
+require 'ruby-debug'
+
+
+
+class ActiveSupport::TestCase
+  
+  # Drop all collections after each test case.
+  def teardown
+    MongoMapper.database.collections.each { |coll| coll.remove }
+  end
+
+  # Make sure that each test case has a teardown
+  # method to clear the db after each test.
+  def inherited(base)
+    base.define_method teardown do 
+      super
+    end
+  end
+
+end
+
+
+
+MongoMapper.connection = Mongo::Connection.new('127.0.0.1', 27017)
+MongoMapper.database = "mongo_mapper_versioned"
+MongoMapper.database.collections.each { |c| c.drop_indexes }

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification 
+name: mongo_mapper_versioned
+version: !ruby/object:Gem::Version 
+  hash: 9
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  version: "0.1"
+platform: ruby
+authors: 
+- Tomas Celizna
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-22 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id001
+  name: mongo_mapper
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id002
+  name: rake
+  type: :development
+description: 
+email: 
+- tomas.celizna@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/mongo_mapper/plugins/models/version.rb
+- lib/mongo_mapper/plugins/version.rb
+- lib/mongo_mapper/plugins/versioned.rb
+- test/mongo_mapper_versioned_test.rb
+- test/test_helper.rb
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/tomasc/mongo_mapper_versioned
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Versioned plugin for MongoMapper
+test_files: []
+