mongo_mapper_acts_as_versioned 0.0.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Gigamo <gigamo@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,45 @@
+= MongoMapper::ActsAsVersioned
+
+Basic MongoMapper port of technoweenie's [acts_as_versioned](http://github.com/technoweenie/acts_as_versioned).
+
+== Basic Usage
+
+    class Page
+      include MongoMapper::Document
+
+      plugin ActsAsVersioned
+
+      key :title,   String
+    end
+
+    page = Page.create(:title => 'title')
+    page.version              # => 1
+    page.versions.size        # => 1
+
+    page.title = 'new title'
+    page.save
+
+    page = page.reload
+    page.version              # => 2
+    page.versions.size        # => 2
+    page.title                # => 'new title'
+
+    page.revert_to!(1)
+    page = page.reload
+    page.version              # => 1
+    page.versions.size        # => 2
+    page.title                # => 'title'
+
+== Tested with
+
+* MongoMapper 0.8.3
+* Ruby 1.9.2
+
+== TODO
+
+* Add loads more options
+* Properly document those options
+
+== Copyright
+
+Copyright (c) 2010 Gigamo @lt;gigamo@gmail.com>. See LICENSE for details.

data/lib/acts_as_versioned.rb

@@ -0,0 +1,178 @@
+module ActsAsVersioned
+  CALLBACKS = [:set_new_version, :save_version, :save_version?]
+
+  def self.configure(model)
+    model.class_eval do
+      const_set(:Version, Class.new).class_eval do
+        include MongoMapper::Document
+
+        key :version,            Integer
+        key :changed_attributes, Hash
+
+        def self.before(version)
+          where(
+            super_foreign_key => version[super_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
+          ).sort(:version.asc).first
+        end
+
+        def previous
+          self.class.before(self)
+        end
+
+        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.belongs_to self.to_s.demodulize.underscore.to_sym,
+                                 :class_name  => "::#{self}",
+                                 :foreign_key => self.to_s.foreign_key
+    end
+
+    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
+
+      def latest
+        query.sort(:version.desc).first
+      end
+    end
+    model.before_save :set_new_version
+    model.after_save  :save_version
+  end
+
+  module InstanceMethods
+    def save_version
+      if @saving_version
+        @saving_version = nil
+
+        rev = self.class.versioned_class.new
+        clone_versioned_model(self, rev)
+        rev.version = version
+        rev[self.class.to_s.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?
+      else
+        return false unless version = versions.where(:version => version).first
+      end
+
+      clone_versioned_model(version, self)
+      self.version = version.version
+
+      true
+    end
+
+    def revert_to!(version)
+      revert_to(version) ? save_without_revision : false
+    end
+
+    def save_without_revision
+      save_without_revision!
+      true
+    rescue
+      false
+    end
+
+    def save_without_revision!
+      without_revision do
+        save!
+      end
+    end
+
+    def clone_versioned_model(orig_model, new_model)
+      if orig_model.is_a?(self.class.versioned_class)
+        orig_model = orig_model.changed_attributes
+      end
+
+      if new_model.is_a?(self.class.versioned_class)
+        new_model = new_model.changed_attributes 
+      end
+
+      self.class.versioned_keys.each do |col|
+        new_model[col] = orig_model[col]
+      end
+    end
+
+    def save_version?
+      (self.class.versioned_keys & changed).any?
+    end
+
+    def without_revision(&block)
+      self.class.without_revision(&block)
+    end
+
+    def empty_callback
+    end
+
+  protected
+
+    def set_new_version
+      @saving_version = new_record? || save_version?
+      self.version = next_version if @saving_version
+    end
+
+    def next_version
+      (new_record? ? 0 : versions.map(&:version).max) + 1
+    end
+  end
+
+  module ClassMethods
+    def versioned_class
+      const_get(:Version)
+    end
+
+    def versioned_keys
+      keys.keys - skipped_keys
+    end
+
+    def without_revision
+      class_eval do
+        CALLBACKS.each do |attr_name|
+          alias_method :"orig_#{attr_name}", attr_name
+          alias_method attr_name, :empty_callback
+        end
+      end
+      yield
+    ensure
+      class_eval do
+        CALLBACKS.each do |attr_name|
+          alias_method attr_name, :"orig_#{attr_name}"
+        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

data/lib/acts_as_versioned/version.rb

@@ -0,0 +1,3 @@
+module ActsAsVersioned
+  VERSION = '0.0.1'
+end

data/spec/acts_as_versioned_spec.rb

@@ -0,0 +1,174 @@
+require 'spec_helper'
+
+describe ActsAsVersioned do
+  before :all do
+    class Landmark
+      include MongoMapper::Document
+
+      plugin ActsAsVersioned
+
+      self.skipped_keys << 'depth'
+
+      key :title, String
+      key :depth, Integer
+      timestamps!
+    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
+  end
+
+  it 'should save a versioned copy' do
+    l = Landmark.create(:title => 'title')
+    l.new_record?.should be_false
+    l.versions.size.should == 1
+    l.version.should == 1
+    l.versions.first.should be_a(Landmark.versioned_class)
+  end
+
+  it 'should save without revision' do
+    l = Landmark.create(:title => 'title')
+    l.version.should == 1
+
+    l.update_attributes(:title => 'changed')
+    l = l.reload
+    l.version.should == 2
+
+    old_versions = l.versions.size
+
+    l.save_without_revision
+
+    l.without_revision do
+      l.update_attributes :title => 'changed again'
+    end
+
+    l.reload.versions.size.should == old_versions
+  end
+
+  it 'should rollback with version number' do
+    l = Landmark.create(:title => 'title')
+    (2..10).each do |i|
+      l = Landmark.first
+      l.update_attributes(:title => "title#{i}")
+      l.version.should == i
+    end
+
+    l = l.reload
+    l.version.should == 10
+    l.versions.size.should == 10
+    l.title.should == 'title10'
+
+    l.revert_to!(7).should be_true
+    l = l.reload
+    l.version.should == 7
+    l.versions.size.should == 10
+    l.title.should == 'title7'
+  end
+
+  it 'should rollback with version class' do
+    l = Landmark.create(:title => 'title')
+    (2..10).each do |i|
+      l = Landmark.first
+      l.update_attributes(:title => "title#{i}")
+      l.version.should == i
+    end
+
+    l = l.reload
+    l.version.should == 10
+    l.versions.size.should == 10
+    l.title.should == 'title10'
+
+    l.revert_to!(l.versions.find_by_version(7)).should be_true
+    l = l.reload
+    l.version.should == 7
+    l.versions.size.should == 10
+    l.title.should == 'title7'
+  end
+
+  it 'should have versioned records belong to its parent' do
+    l = Landmark.create(:title => 'title')
+    (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
+    l_version.landmark.should == l.reload
+  end
+
+  it 'should not create new versions for skipped keys' do
+    l = Landmark.create(:title => 'title')
+    l.update_attributes(:depth => 1)
+    l = l.reload
+    l.version.should == 1
+    l.versions.size.should == 1
+  end
+
+  it 'should create a new version even if a skipped key is added' do
+    l = Landmark.create(:title => 'title')
+    l.update_attributes(:title => 'new title', :depth => 1)
+    l = l.reload
+    l.version.should == 2
+    l.versions.size.should == 2
+  end
+
+  it 'should remember skipped keys through versions' do
+    l = Landmark.create(:title => 'title')
+    l.update_attributes(:title => 'new title')
+    l = l.reload
+    l.version.should == 2
+    l.versions.size.should == 2
+
+    l.update_attributes(:depth => 1)
+    l = l.reload
+    l.version.should == 2
+    l.versions.size.should == 2
+    l.depth.should == 1
+    l.title.should == 'new title'
+
+    l.revert_to!(1)
+    l = l.reload
+    l.version.should == 1
+    l.versions.size.should == 2
+    l.depth.should == 1
+    l.title.should == 'title'
+  end
+
+  it 'should store changes in a hash' do
+    l = Landmark.create(:title => 'title')
+    l.versions[0].changed_attributes.should == {'title' => 'title'}
+
+    l.update_attributes(:title => 'changed title', :depth => 1)
+    l.reload.versions[1].changed_attributes.should == {'title' => 'changed title'}
+  end
+
+  context 'finders' do
+    before :each do
+      @l = Landmark.create(:title => 'title')
+      (2..5).each do |i|
+        Landmark.first.update_attributes(:title => "title#{i}")
+      end
+      @l = @l.reload
+    end
+
+    it 'should find the earliest version' do
+      @l.versions.earliest.should == @l.versions.find_by_version(1)
+    end
+
+    it 'should find the latest version' do
+      @l.versions.latest.should == @l.versions.find_by_version(5)
+    end
+
+    it 'should find the previous version' do
+      @l.versions[1].previous.should == @l.versions[0]
+    end
+
+    it 'should find the next version' do
+      @l.versions[0].next.should == @l.versions[1]
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'mongo_mapper'
+require 'rspec'
+require File.expand_path('../../lib/acts_as_versioned', __FILE__)
+
+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|
+  config.after :each do
+    MongoMapper.database.collections.each do |collection|
+      collection.remove unless collection.name =~ /(.*\.)?system\..*/
+      collection.drop_indexes
+    end
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification 
+name: mongo_mapper_acts_as_versioned
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Gigamo
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-27 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mongo_mapper
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: Basic MongoMapper port of technoweenie's acts_as_versioned
+email: 
+- gigamo@gmail.com
+executables: []
+
+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
+- LICENSE
+- README.md
+has_rdoc: true
+homepage: http://github.com/gigamo/mongo_mapper_acts_as_versioned
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: mongo_mapper_acts_as_versioned
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Basic MongoMapper port of technoweenie's acts_as_versioned
+test_files: []
+