mm-versionable 0.2

data/README.md

@@ -0,0 +1,28 @@
+MongoMapper Versioning
+======================
+A MongoMapper plugin which enables document versioning.
+
+Install
+-------
+$ gem install mm-versionable
+
+Note on Patches/Pull Requests
+-----------------------------
+*Fork the project
+*Make your feature addition or bug fix.
+*Add tests for it. This is critical so that things dont break unintentionally.
+*Commit, do not make any changes in the rakefile, version, or history. (If you want to have your own version, that is fine but bump the version in a commit by itself so I can ignore it when I pull)
+*Send me a pull requests.
+
+Development
+-----------
+
+Problems or Questions?
+----------------------
+Hit up on the mongomapper google group: http://groups.google.com/group/mongomapper
+Hop on IRC: irc://chat.freenode.net/#mongomapper
+I am available on IRC with the name dhruvasagar, you could alternatively also contact me directly on dhruva.sagar@gmail.com
+
+Copyright
+---------
+See LICENCE for details.

data/Rakefile

@@ -0,0 +1,39 @@
+require 'rubygems'
+require 'rake'
+require 'jeweler'
+
+require File.join(File.dirname(__FILE__), '/lib/versionable/version')
+
+require 'rake/testtask'
+namespace :test do
+  Rake::TestTask.new(:units) do |test|
+    test.libs << 'test'
+    test.ruby_opts << '-rubygems'
+    test.pattern = 'test/unit/**/test_*.rb'
+    test.verbose = true 
+  end
+
+  Rake::TestTask.new(:performance) do |test|
+    test.libs << 'test'
+    test.ruby_opts << '-rubygems'
+    test.pattern = 'test/performance/**/*.rb'
+    test.verbose = true 
+  end
+end
+
+task :default => 'test:units'
+
+Jeweler::Tasks.new do |gem|
+  gem.name          = 'mm-versionable'
+  gem.summary       = 'A MongoMapper extension for document versioning'
+  gem.description   = 'A MongoMapper extension that enables document versionable'
+  gem.email         = 'dhruva.sagar@gmail.com'
+  gem.homepage      = 'https://github.com/artha42/mm-versionable/'
+  gem.authors       = ['Dhruva Sagar']
+  gem.version       = Versionable::Version
+
+  gem.add_dependency('differ')
+  gem.add_dependency('mongo_mapper')
+end
+
+Jeweler::GemcutterTasks.new

data/config.ru

@@ -0,0 +1,11 @@
+$LOAD_PATH.unshift(".") unless $LOAD_PATH.include?(".") 
+
+require 'pp'
+require 'rubygems'
+
+$:.unshift(::File.join(::File.expand_path('.'), '/lib'))
+require 'versionable.rb'
+
+require 'test/config/config'
+require 'test/models/post'
+require 'test/models/user'

data/lib/versionable/models/version.rb

@@ -0,0 +1,19 @@
+class Version
+  include MongoMapper::Document
+
+  key :data, Hash
+  key :date, Time
+  key :pos, Integer
+  key :doc_id, String
+  key :message, String
+  key :updater_id, String
+
+  def content(key)
+    cdata = self.data[key]
+    if cdata.respond_to?(:join)
+      cdata.join(" ")
+    else
+      cdata
+    end
+  end  
+end

data/lib/versionable/plugins/versionable.rb

@@ -0,0 +1,111 @@
+require 'versionable/models/version'
+
+module Versionable
+  def self.configure(model)
+    model.enable_versioning
+  end
+
+  module InstanceMethods
+    def save(options={})
+      save_version(options[:updater_id]) if self.respond_to?(:rolling_back) && !rolling_back
+      super
+    end
+
+    private
+      def save_version(updater_id=nil)
+        if self.respond_to?(:versions)
+          version = self.current_version
+          version.message = self.version_message
+          if self.versions.empty?
+            version.pos = 0
+          else
+            version.pos = self.versions.last.pos + 1
+          end
+          version.updater_id = updater_id
+          version.save
+
+          self.versions.shift
+          self.versions << version
+
+          @versions_count = @versions_count.to_i + 1
+        end
+      end
+  end
+
+  module ClassMethods
+    def enable_versioning(opts={})
+      attr_accessor :rolling_back
+
+      key :version_message, String
+      key :version_number, Integer
+
+      define_method(:versions_count) do
+        @versions_count ||= Version.count(:doc_id => self._id.to_s)
+      end
+
+      define_method(:versions) do
+        @versions ||= Version.all(:doc_id => self._id.to_s, :order => 'pos desc', :limit => (opts[:limit] || 10)).reverse
+      end
+
+      define_method(:all_versions) do
+        Version.where(:doc_id => self._id.to_s).sort(:pos.desc)
+      end
+
+      define_method(:rollback) do |pos = nil|
+        #The last version is always same as the current version, so -2 instead of -1
+        pos = self.versions.count-2 if pos.nil?
+        version = self.version_at(pos)
+
+        if version
+          self.attributes = version.data
+        end
+
+        self.version_number = version.pos
+        self
+      end
+      
+      define_method(:rollback!) do |pos = nil|
+        self.rollback(pos)
+
+        @rolling_back = true
+        save!
+        @rolling_back = false
+
+        self
+      end
+
+      define_method(:diff) do |key, pos1, pos2, format = :html|
+        version1 = self.version_at(pos1)
+        version2 = self.version_at(pos2)
+
+        Differ.diff_by_word(version1.content(key), version2.content(key)).format_as(format)
+      end
+
+      define_method(:current_version) do
+        Version.new(:data => self.attributes, :date => Time.now, :doc_id => self._id.to_s)
+      end
+
+      define_method(:version_at) do |pos|
+        case pos
+        when :current
+          current_version
+        when :first
+          index = self.versions.index {|v| v.pos == 0}
+          version = self.versions[index] if index
+          version ||= Version.first(:user_id => self._id.to_s, :pos => 0)
+          version
+        when :last
+          #The last version is always same as the current version, so -2 instead of -1
+          self.versions[self.versions.count-2]
+        when :latest
+          self.versions.last
+        else
+          index = self.versions.index {|v| v.pos == pos}
+          version = self.versions[index] if index
+          version ||= Version.first(:user_id => self._id.to_s, :pos => pos)
+          version 
+        end
+      end
+    end
+  end
+end

data/lib/versionable/version.rb

@@ -0,0 +1,3 @@
+module Versionable
+  Version = '0.2'
+end

data/lib/versionable.rb

@@ -0,0 +1,2 @@
+require 'mongo_mapper'
+require 'versionable/plugins/versionable'

data/mm-versionable.gemspec

@@ -0,0 +1,64 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{mm-versionable}
+  s.version = "0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Dhruva Sagar"]
+  s.date = %q{2010-11-26}
+  s.description = %q{A MongoMapper extension that enables document versionable}
+  s.email = %q{dhruva.sagar@gmail.com}
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    "README.md",
+    "Rakefile",
+    "config.ru",
+    "lib/versionable.rb",
+    "lib/versionable/models/version.rb",
+    "lib/versionable/plugins/versionable.rb",
+    "lib/versionable/version.rb",
+    "mm-versionable.gemspec",
+    "test/config/config.rb",
+    "test/config/database.yml",
+    "test/models/post.rb",
+    "test/models/user.rb",
+    "test/performance/read_write.rb",
+    "test/test_helper.rb",
+    "test/unit/test_versioning.rb"
+  ]
+  s.homepage = %q{https://github.com/artha42/mm-versionable/}
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{A MongoMapper extension for document versioning}
+  s.test_files = [
+    "test/config/config.rb",
+    "test/models/post.rb",
+    "test/models/user.rb",
+    "test/performance/read_write.rb",
+    "test/test_helper.rb",
+    "test/unit/test_versioning.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<differ>, [">= 0"])
+      s.add_runtime_dependency(%q<mongo_mapper>, [">= 0"])
+    else
+      s.add_dependency(%q<differ>, [">= 0"])
+      s.add_dependency(%q<mongo_mapper>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<differ>, [">= 0"])
+    s.add_dependency(%q<mongo_mapper>, [">= 0"])
+  end
+end
+

data/test/config/config.rb

@@ -0,0 +1 @@
+MongoMapper.database = YAML.load(File.read('config/database.yml'))[ENV['RACK_ENV']]['database'] rescue 'versionable_test'

data/test/config/database.yml

@@ -0,0 +1,5 @@
+development:
+  database: versionable_dev
+
+test:
+  database: versionable_test

data/test/models/post.rb

@@ -0,0 +1,8 @@
+class Post
+  include MongoMapper::EmbeddedDocument
+  
+  key :date, Time
+  key :body, String
+  key :title, String
+
+end

data/test/models/user.rb

@@ -0,0 +1,11 @@
+class User
+  include MongoMapper::Document
+  plugin Versionable
+
+  key :fname, String
+  key :lname, String
+  key :email, String
+  key :address, String
+
+  many :posts
+end

data/test/performance/read_write.rb

@@ -0,0 +1,29 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../lib/versionable')
+
+require 'benchmark'
+
+MongoMapper.database = 'versionable_performance'
+ 
+class Foo
+  include MongoMapper::Document
+  plugin Versionable
+
+  enable_versioning
+
+  key :approved, Boolean
+  key :count, Integer
+  key :approved_at, Time
+  key :expire_on, Date
+end
+Foo.collection.remove
+
+Benchmark.bm(5) do |x|
+  ids = []
+  hhids = []
+  x.report("write   ") do
+    1000.times { |i| ids << Foo.create(:count => 0, :approved => true, :approved_at => Time.now, :expire_on => Date.today).id }
+  end
+  x.report("read    ") do
+    ids.each { |id| Foo.first(:id => id) }
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,20 @@
+$LOAD_PATH.unshift('.') unless $LOAD_PATH.include?('.')
+
+require File.expand_path(File.dirname(__FILE__) + '/../lib/versionable')
+
+require 'pp'
+require 'shoulda'
+
+require 'test/models/post'
+require 'test/models/user'
+
+require 'config/config'
+
+User.delete_all
+u = User.create(:fname => 'dhruva', :lname => 'sagar', :email => 'dhruva.sagar@gmail.com')
+u.fname = 'Dhruva'
+u.lname = 'Sagar'
+u.save
+
+u.posts << Post.new(:title => 'Dummy title', :body => 'Dummy post body', :date => Time.now)
+u.save

data/test/unit/test_versioning.rb

@@ -0,0 +1,84 @@
+require 'test_helper'
+
+class VersioningTest < Test::Unit::TestCase
+  context 'Versioning enabled' do
+    setup do
+      @user = User.first
+    end
+    should 'respond to method version_message' do
+      assert @user.respond_to?(:version_message)
+    end
+    should 'respond to method version_number' do
+      assert @user.respond_to?(:version_number)
+    end
+    should 'respond to method versions' do
+      assert @user.respond_to?(:versions)
+    end
+    should 'respond to method all_versions' do
+      assert @user.respond_to?(:all_versions)
+    end
+    should 'respond to method rollback' do
+      assert @user.respond_to?(:rollback)
+    end
+    should 'respond to method rollback!' do
+      assert @user.respond_to?(:rollback!)
+    end
+    should 'respond to method diff' do
+      assert @user.respond_to?(:diff)
+    end
+    should 'respond to method current_version' do
+      assert @user.respond_to?(:current_version)
+    end
+    should 'respond to method version_at' do
+      assert @user.respond_to?(:version_at)
+    end
+  end
+
+  context 'Version manipulations' do
+    setup do
+      @user = User.first
+    end
+    should 'return the total versions_count' do
+      assert @user.versions_count
+    end
+    should 'return last 10 or lesser versions' do
+      assert @user.versions
+      assert @user.versions.count <= 10
+    end
+    should 'return the plucky query for all versions' do
+      assert @user.all_versions
+      assert @user.all_versions.is_a?(Plucky::Query)
+    end
+    should 'load first version on rollback :first' do
+      assert @user.rollback(:first).fname == 'dhruva'
+      assert @user.version_number == 0
+    end
+    should 'load last version on rollback :last' do
+      assert @user.rollback(:last).fname == 'Dhruva'
+      assert @user.posts.empty?
+      assert @user.version_number == (@user.versions_count - 2)
+    end
+    should 'load latest version on rollback :latest' do
+      assert @user.rollback(:latest).fname == 'Dhruva'
+      assert !@user.posts.empty?
+      assert @user.version_number == (@user.versions_count - 1)
+    end
+    should 'revert to first version on rollback!' do
+      @user.rollback!(:first)
+      assert @user.fname == 'dhruva'
+      assert @user.version_number == 0
+    end
+    should 'revert to last version on rollback!' do
+      @user.rollback!(:last)
+      assert @user.fname == 'Dhruva'
+      assert @user.posts.empty?
+      assert @user.version_number == (@user.versions_count - 2)
+    end
+    should 'revert to latest version on rollback!' do
+      @user.rollback!(:latest)
+      assert @user.fname == 'Dhruva'
+      assert !@user.posts.empty?
+      assert @user.version_number == (@user.versions_count - 1)
+    end
+  end
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification 
+name: mm-versionable
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  version: "0.2"
+platform: ruby
+authors: 
+- Dhruva Sagar
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-26 00:00:00 +05:30
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: differ
+  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: mongo_mapper
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+description: A MongoMapper extension that enables document versionable
+email: dhruva.sagar@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- README.md
+- Rakefile
+- config.ru
+- lib/versionable.rb
+- lib/versionable/models/version.rb
+- lib/versionable/plugins/versionable.rb
+- lib/versionable/version.rb
+- mm-versionable.gemspec
+- test/config/config.rb
+- test/config/database.yml
+- test/models/post.rb
+- test/models/user.rb
+- test/performance/read_write.rb
+- test/test_helper.rb
+- test/unit/test_versioning.rb
+has_rdoc: true
+homepage: https://github.com/artha42/mm-versionable/
+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: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A MongoMapper extension for document versioning
+test_files: 
+- test/config/config.rb
+- test/models/post.rb
+- test/models/user.rb
+- test/performance/read_write.rb
+- test/test_helper.rb
+- test/unit/test_versioning.rb