mongoid-history 0.1.7 → 0.2.1

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3

data/Gemfile

@@ -1,16 +1,13 @@
 source "http://rubygems.org"
 
 gem "easy_diff"
-gem "mongoid", "~> 2.0"
+gem "mongoid", ">= 2.0.0"
 
 group :development do
-  gem "bson_ext", ">= 1.3.1"
-  gem "rspec", "~> 2.3.0"
-  gem "yard", "~> 0.6.0"
-  gem "bundler", "~> 1.0.0"
-  gem "jeweler", "~> 1.5.2"
-  gem "rcov", ">= 0"
-  gem "reek", "~> 1.2.8"
-  gem "roodi", "~> 2.1.0"
+  gem "bson_ext"
+  gem "rspec"
+  gem "yard"
+  gem "bundler", ">= 1.0.0"
+  gem "jeweler"
   gem "database_cleaner"
 end

data/README.md

@@ -0,0 +1,202 @@
+mongoid-history
+===============
+
+[![Build Status](https://secure.travis-ci.org/aq1018/mongoid-history.png?branch=master)](http://travis-ci.org/aq1018/mongoid-history) [![Dependency Status](https://gemnasium.com/aq1018/mongoid-history.png?travis)](https://gemnasium.com/aq1018/mongoid-history)
+
+
+In frustration of Mongoid::Versioning, I created this plugin for tracking historical changes for any document, including embedded ones. It achieves this by storing all history tracks in a single collection that you define. (See Usage for more details) Embedded documents are referenced by storing an association path, which is an array of document_name and document_id fields starting from the top most parent document and down to the embedded document that should track history.
+
+This plugin implements multi-user undo, which allows users to undo any history change in any order. Undoing a document also creates a new history track. This is great for auditing and preventing vandalism, but it is probably not suitable for use cases such as a wiki.
+
+Upgrading to mongoid-history-0.2.0
+----------------------------------
+
+If you are upgrade from 0.1.x to version 0.2.x, you need to run the following code **before** you start to use the 0.2.x. This is due to changes in `Mongoid::History::Tracker`'s `association_chain` field.
+
+```ruby
+Mongoid::History.tracker_class.all.each do |tracker|
+  tracker.association_chain[1..-1].each do |node|
+    node['name'] = node['name'].tableize
+  end
+  tracker.save!
+end
+```
+
+Install
+-------
+
+Currently this gem supports ruby 1.9.x only. ruby 1.8.7, ree and rubinus are not working right now.
+
+```
+gem install mongoid-history
+```
+
+Rails 3
+-------
+
+In your Gemfile:
+
+```ruby
+gem 'mongoid-history'
+```
+
+Usage
+-----
+
+Here is a quick example on how to use this plugin. For more details, please look at spec/integration/integration_spec.rb. It offers more detailed examples on how to use `Mongoid::History`.
+
+**Create a History Tracker**
+
+Create a new class to track histories. All histories are stored in this tracker. The name of the class can be anything you like. The only requirement is that it includes `Mongoid::History::Tracker`
+
+```ruby
+# app/models/history_tracker.rb
+class HistoryTracker
+  include Mongoid::History::Tracker
+end
+```
+
+**Set Tracker Class Name**
+
+
+You should manually set the tracker class name to make sure your tracker can be found and loaded properly. You can skip this step if you manually require your tracker before using any trackables. If you don't know what I'm talking about, then you should just follow the example below.
+
+Here is an example of setting the tracker class name using a rails initializer
+
+```ruby
+# config/initializers/mongoid-history.rb
+# initializer for mongoid-history
+# assuming HistoryTracker is your tracker class
+Mongoid::History.tracker_class_name = :history_tracker
+```
+
+**Set `#current_user` method name**
+
+You can set name of method which returns currently logged in user if you don't want to set modifier explicitly on every update.
+
+Here is an example of setting the current_user_method using a rails initializer
+
+```ruby
+# config/initializers/mongoid-history.rb
+# initializer for mongoid-history
+# assuming you're using devise/authlogic
+Mongoid::History.current_user_method = :current_user
+```
+
+When current_user_method is set mongoid-history call this method on each update and set it as modifier
+
+```ruby
+# Assume that current_user return #<User _id: 1>
+post = Post.first
+post.update_attributes(:title => 'New title')
+
+post.history_tracks.last.modifier #=> #<User _id: 1>
+```
+
+***Create Trackable classes and objects***
+
+```ruby
+class Post
+  include Mongoid::Document
+  include Mongoid::Timestamps
+
+  # History tracking all Post Documents
+  # Note: Tracking will not work until #track_history is invoked
+  include Mongoid::History::Trackable
+
+  field           :title
+  field           :body
+  field           :rating
+  embeds_many     :comments
+
+  # Telling Mongoid::History how you want to track
+  track_history   :on => [:title, :body],       # I want to track title and body fields only. Default is :all
+                  :modifier_field => :modifier, # Adds "referened_in :modifier" to track who made the change. Default is :modifier
+                  :version_field => :version,   # Adds "field :version, :type => Integer" to track current version. Default is :version
+                  :track_create   =>  false,    # Do you want to track document creation? Default is false
+                  :track_update   =>  true,     # Do you want to track document updates? Default is true
+                  :track_destroy  =>  false,    # Do you want to track document destruction? Default is false
+end
+
+class Comment
+  include Mongoid::Document
+  include Mongoid::Timestamps
+
+  # Declare that we want to track comments
+  include Mongoid::History::Trackable
+
+  field             :title
+  field             :body
+  embedded_in       :post, :inverse_of => :comments
+
+  # Track title and body for all comments, scope it to post (the parent)
+  # Also track creation and destruction
+  track_history     :on => [:title, :body], :scope => :post, :track_create => true, :track_destroy => true
+end
+
+# The modifier can be specified as well
+class User
+  include Mongoid::Document
+  include Mongoid::Timestamps
+
+  field             :name
+end
+
+user = User.create(:name => "Aaron")
+post = Post.create(:title => "Test", :body => "Post", :modifier => user)
+comment = post.comments.create(:title => "test", :body => "comment", :modifier => user)
+comment.history_tracks.count # should be 1
+
+comment.update_attributes(:title => "Test 2")
+comment.history_tracks.count # should be 2
+
+track = comment.history_tracks.last
+
+track.undo! user # comment title should be "Test"
+
+track.redo! user # comment title should be "Test 2"
+
+# undo last change
+comment.undo! user
+
+# undo versions 1 - 4
+comment.undo! user, :from => 4, :to => 1
+
+# undo last 3 versions
+comment.undo! user, :last => 3
+
+# redo versions 1 - 4
+comment.redo! user, :from => 1, :to => 4
+
+# redo last 3 versions
+comment.redo! user, :last => 3
+
+# delete post
+post.destroy
+
+# undelete post
+post.undo! user
+
+# disable tracking for comments within a block
+Comment.disable_tracking do
+  comment.update_attributes(:title => "Test 3")
+end
+```
+
+Contributing to mongoid-history
+-------------------------------
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+Copyright
+---------
+
+Copyright (c) 2011 Aaron Qian. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -31,25 +31,6 @@ RSpec::Core::RakeTask.new(:spec) do |spec|
   spec.rspec_opts = "--color --format progress"
 end
 
-RSpec::Core::RakeTask.new(:rcov) do |spec|
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
-  spec.rcov_opts = "--exclude ~\/.rvm,spec"
-end
-
-require 'reek/rake/task'
-Reek::Rake::Task.new do |t|
-  t.fail_on_error = true
-  t.verbose = false
-  t.source_files = 'lib/**/*.rb'
-end
-
-require 'roodi'
-require 'roodi_task'
-RoodiTask.new do |t|
-  t.verbose = false
-end
-
 task :default => :spec
 
 require 'yard'

data/VERSION

@@ -1 +1 @@
-0.1.7
+0.2.1

data/lib/mongoid/history/sweeper.rb

@@ -1,28 +1,44 @@
 module Mongoid::History
   class Sweeper < Mongoid::Observer
-    attr_accessor :controller
+    def controller
+      Thread.current[:mongoid_history_sweeper_controller]
+    end
+
+    def controller=(value)
+      Thread.current[:mongoid_history_sweeper_controller] = value
+    end
 
     def self.observed_classes
       [Mongoid::History.tracker_class]
     end
 
+    # Hook to ActionController::Base#around_filter.
+    # Runs before a controller action is run.
+    # It should always return true so controller actions
+    # can continue.
     def before(controller)
       self.controller = controller
-      true # before method from sweeper should always return true
+      true
     end
 
+    # Hook to ActionController::Base#around_filter.
+    # Runs after a controller action is run.
+    # Clean up so that the controller can
+    # be collected after this request
     def after(controller)
-      self.controller = controller
-      # Clean up, so that the controller can be collected after this request
       self.controller = nil
     end
 
     def before_create(track)
-      track.modifier ||= current_user
+      modifier_field = track.trackable.history_trackable_options[:modifier_field]
+      modifier = track.send modifier_field
+      track.send "#{modifier_field}=", current_user unless modifier
     end
 
     def current_user
-      controller.send Mongoid::History.current_user_method if controller.respond_to?(Mongoid::History.current_user_method, true)
+      if controller.respond_to?(Mongoid::History.current_user_method, true)
+        controller.send Mongoid::History.current_user_method
+      end
     end
   end
 end

data/lib/mongoid/history/trackable.rb

@@ -36,7 +36,7 @@ module Mongoid::History
         field options[:version_field].to_sym, :type => Integer
         referenced_in options[:modifier_field].to_sym, :class_name => Mongoid::History.modifier_class_name
 
-        include InstanceMethods
+        include MyInstanceMethods
         extend SingletonMethods
 
         delegate :history_trackable_options, :to => 'self.class'
@@ -69,11 +69,11 @@ module Mongoid::History
       end
     end
 
-    module InstanceMethods
+    module MyInstanceMethods
       def history_tracks
-        @history_tracks ||= Mongoid::History.tracker_class.where(:scope => history_trackable_options[:scope], :association_chain => traverse_association_chain)
+        @history_tracks ||= Mongoid::History.tracker_class.where(:scope => history_trackable_options[:scope], :association_chain => association_hash)
       end
-
+      
       #  undo :from => 1, :to => 5
       #  undo 4
       #  undo :last => 10
@@ -128,10 +128,27 @@ module Mongoid::History
 
       def traverse_association_chain(node=self)
         list = node._parent ? traverse_association_chain(node._parent) : []
-        list << { 'name' => node.class.name, 'id' => node.id }
+        list << association_hash(node)
         list
       end
 
+      def association_hash(node=self)
+        # get all reflections of embedded_in association metadata
+        # and find the first association that matches _parent.
+        if node._parent
+          meta = node.reflect_on_all_associations(:embedded_in).find do |meta|
+            node._parent == node.send(meta.key)
+          end
+
+          inverse = node._parent.reflect_on_association(meta.inverse)
+        end
+
+        # if root node has no meta, and should use class name instead
+        name = meta ? meta.inverse.to_s : node.class.name
+
+        { 'name' => name, 'id' => node.id}
+      end
+
       def modified_attributes_for_update
         @modified_attributes_for_update ||= if history_trackable_options[:on] == :all
           changes.reject do |k, v|
@@ -187,7 +204,7 @@ module Mongoid::History
         return unless should_track_update?
         current_version = (self.send(history_trackable_options[:version_field]) || 0 ) + 1
         self.send("#{history_trackable_options[:version_field]}=", current_version)
-        Mongoid::History.tracker_class.create!(history_tracker_attributes(:update).merge(:version => current_version, :action => "update"))
+        Mongoid::History.tracker_class.create!(history_tracker_attributes(:update).merge(:version => current_version, :action => "update", :trackable => self))
         clear_memoization
       end
 
@@ -195,14 +212,14 @@ module Mongoid::History
         return unless track_history?
         current_version = (self.send(history_trackable_options[:version_field]) || 0 ) + 1
         self.send("#{history_trackable_options[:version_field]}=", current_version)
-        Mongoid::History.tracker_class.create!(history_tracker_attributes(:create).merge(:version => current_version, :action => "create"))
+        Mongoid::History.tracker_class.create!(history_tracker_attributes(:create).merge(:version => current_version, :action => "create", :trackable => self))
         clear_memoization
       end
 
       def track_destroy
         return unless track_history?
         current_version = (self.send(history_trackable_options[:version_field]) || 0 ) + 1
-        Mongoid::History.tracker_class.create!(history_tracker_attributes(:destroy).merge(:version => current_version, :action => "destroy"))
+        Mongoid::History.tracker_class.create!(history_tracker_attributes(:destroy).merge(:version => current_version, :action => "destroy", :trackable => self))
         clear_memoization
       end
 

data/lib/mongoid/history/tracker.rb

@@ -5,6 +5,7 @@ module Mongoid::History
     included do
       include Mongoid::Document
       include Mongoid::Timestamps
+      attr_writer :trackable
 
       field       :association_chain,       :type => Array,     :default => []
       field       :modified,                :type => Hash
@@ -25,9 +26,9 @@ module Mongoid::History
 
     def undo!(modifier)
       if action.to_sym == :destroy
-        class_name = association_chain[0]["name"]
-        restored = class_name.constantize.new(modified)
-        restored.save!
+        re_create
+      elsif action.to_sym == :create
+        re_destroy
       else
         trackable.update_attributes!(undo_attr(modifier))
       end
@@ -35,7 +36,9 @@ module Mongoid::History
 
     def redo!(modifier)
       if action.to_sym == :destroy
-        trackable.destroy
+        re_destroy
+      elsif action.to_sym == :create
+        re_create
       else
         trackable.update_attributes!(redo_attr(modifier))
       end
@@ -69,25 +72,80 @@ module Mongoid::History
       @trackable_parents ||= trackable_parents_and_trackable[0, -1]
     end
 
+    def trackable_parent
+      @trackable_parent ||= trackable_parents_and_trackable[-2]
+    end
+
+
     def affected
-      @affected ||= (modified.keys | original.keys).inject({}){ |h,k| h[k] = 
+      @affected ||= (modified.keys | original.keys).inject({}){ |h,k| h[k] =
         trackable ? trackable.attributes[k] : modified[k]; h}
     end
 
 private
+
+    def re_create
+      association_chain.length > 1 ? create_on_parent : create_standalone
+    end
+
+    def re_destroy
+      trackable.destroy
+    end
+
+    def create_standalone
+      class_name = association_chain.first["name"]
+      restored = class_name.constantize.new(modified)
+      restored.save!
+    end
+
+    def create_on_parent
+      name = association_chain.last["name"]
+      if embeds_one?(trackable_parent, name)
+        trackable_parent.send("create_#{name}!", modified)
+      elsif embeds_many?(trackable_parent, name)
+         trackable_parent.send(name).create!(modified)
+      else
+        raise "This should never happen. Please report bug!"
+      end
+    end
+
     def trackable_parents_and_trackable
       @trackable_parents_and_trackable ||= traverse_association_chain
     end
 
+    def relation_of(doc, name)
+      meta = doc.reflect_on_association(name)
+      meta ? meta.relation : nil
+    end
+
+    def embeds_one?(doc, name)
+      relation_of(doc, name) == Mongoid::Relations::Embedded::One
+    end
+
+    def embeds_many?(doc, name)
+      relation_of(doc, name) == Mongoid::Relations::Embedded::Many
+    end
+
     def traverse_association_chain
       chain = association_chain.dup
       doc = nil
       documents = []
+
       begin
         node = chain.shift
         name = node['name']
-        col  = doc.nil? ? name.classify.constantize : doc.send(name.tableize)
-        doc  = col.where(:_id => node['id']).first
+
+        doc = if doc.nil?
+          # root association. First element of the association chain
+          klass = name.classify.constantize
+          klass.where(:_id => node['id']).first
+        elsif embeds_one?(doc, name)
+          doc.send(name)
+        elsif embeds_many?(doc, name)
+          doc.send(name).where(:_id => node['id']).first
+        else
+          raise "This should never happen. Please report bug."
+        end
         documents << doc
       end while( !chain.empty? )
       documents

data/mongoid-history.gemspec

@@ -4,27 +4,25 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{mongoid-history}
-  s.version = "0.1.7"
+  s.name = "mongoid-history"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = [%q{Aaron Qian}, %q{Justin Grimes}]
-  s.date = %q{2011-12-09}
-  s.description = %q{In frustration of Mongoid::Versioning, I created this plugin for tracking historical changes for any document, including embedded ones. It achieves this by storing all history tracks in a single collection that you define. (See Usage for more details) Embedded documents are referenced by storing an association path, which is an array of document_name and document_id fields starting from the top most parent document and down to the embedded document that should track history.
-
-  This plugin implements multi-user undo, which allows users to undo any history change in any order. Undoing a document also creates a new history track. This is great for auditing and preventing vandalism, but it is probably not suitable for use cases such as a wiki.}
-  s.email = [%q{aq1018@gmail.com}, %q{justin.mgrimes@gmail.com}]
+  s.authors = ["Aaron Qian", "Justin Grimes"]
+  s.date = "2012-03-19"
+  s.description = "In frustration of Mongoid::Versioning, I created this plugin for tracking historical changes for any document, including embedded ones. It achieves this by storing all history tracks in a single collection that you define. (See Usage for more details) Embedded documents are referenced by storing an association path, which is an array of document_name and document_id fields starting from the top most parent document and down to the embedded document that should track history.\n\n  This plugin implements multi-user undo, which allows users to undo any history change in any order. Undoing a document also creates a new history track. This is great for auditing and preventing vandalism, but it is probably not suitable for use cases such as a wiki."
+  s.email = ["aq1018@gmail.com", "justin.mgrimes@gmail.com"]
   s.extra_rdoc_files = [
     "LICENSE.txt",
-    "README.rdoc"
+    "README.md"
   ]
   s.files = [
     ".document",
     ".rspec",
-    ".rvmrc",
+    ".travis.yml",
     "Gemfile",
     "LICENSE.txt",
-    "README.rdoc",
+    "README.md",
     "Rakefile",
     "VERSION",
     "lib/mongoid-history.rb",
@@ -38,57 +36,42 @@ Gem::Specification.new do |s|
     "spec/trackable_spec.rb",
     "spec/tracker_spec.rb"
   ]
-  s.homepage = %q{http://github.com/aq1018/mongoid-history}
-  s.licenses = [%q{MIT}]
-  s.require_paths = [%q{lib}]
-  s.rubygems_version = %q{1.8.6}
-  s.summary = %q{history tracking, auditing, undo, redo for mongoid}
-  s.test_files = [
-    "spec/integration/integration_spec.rb",
-    "spec/spec_helper.rb",
-    "spec/trackable_spec.rb",
-    "spec/tracker_spec.rb"
-  ]
+  s.homepage = "http://github.com/aq1018/mongoid-history"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.10"
+  s.summary = "history tracking, auditing, undo, redo for mongoid"
 
   if s.respond_to? :specification_version then
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<easy_diff>, [">= 0"])
-      s.add_runtime_dependency(%q<mongoid>, ["~> 2.0"])
-      s.add_development_dependency(%q<bson_ext>, [">= 1.3.1"])
-      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
-      s.add_development_dependency(%q<yard>, ["~> 0.6.0"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
-      s.add_development_dependency(%q<rcov>, [">= 0"])
-      s.add_development_dependency(%q<reek>, ["~> 1.2.8"])
-      s.add_development_dependency(%q<roodi>, ["~> 2.1.0"])
+      s.add_runtime_dependency(%q<mongoid>, [">= 2.0.0"])
+      s.add_development_dependency(%q<bson_ext>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, [">= 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
       s.add_development_dependency(%q<database_cleaner>, [">= 0"])
     else
       s.add_dependency(%q<easy_diff>, [">= 0"])
-      s.add_dependency(%q<mongoid>, ["~> 2.0"])
-      s.add_dependency(%q<bson_ext>, [">= 1.3.1"])
-      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
-      s.add_dependency(%q<yard>, ["~> 0.6.0"])
-      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
-      s.add_dependency(%q<rcov>, [">= 0"])
-      s.add_dependency(%q<reek>, ["~> 1.2.8"])
-      s.add_dependency(%q<roodi>, ["~> 2.1.0"])
+      s.add_dependency(%q<mongoid>, [">= 2.0.0"])
+      s.add_dependency(%q<bson_ext>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<yard>, [">= 0"])
+      s.add_dependency(%q<bundler>, [">= 1.0.0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
       s.add_dependency(%q<database_cleaner>, [">= 0"])
     end
   else
     s.add_dependency(%q<easy_diff>, [">= 0"])
-    s.add_dependency(%q<mongoid>, ["~> 2.0"])
-    s.add_dependency(%q<bson_ext>, [">= 1.3.1"])
-    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
-    s.add_dependency(%q<yard>, ["~> 0.6.0"])
-    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
-    s.add_dependency(%q<rcov>, [">= 0"])
-    s.add_dependency(%q<reek>, ["~> 1.2.8"])
-    s.add_dependency(%q<roodi>, ["~> 2.1.0"])
+    s.add_dependency(%q<mongoid>, [">= 2.0.0"])
+    s.add_dependency(%q<bson_ext>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<yard>, [">= 0"])
+    s.add_dependency(%q<bundler>, [">= 1.0.0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
     s.add_dependency(%q<database_cleaner>, [">= 0"])
   end
 end

data/spec/integration/integration_spec.rb

@@ -16,6 +16,7 @@ describe Mongoid::History do
       field           :rating
 
       embeds_many     :comments
+      embeds_one      :section
       track_history   :on => [:title, :body], :track_destroy => true
     end
 
@@ -26,8 +27,18 @@ describe Mongoid::History do
 
       field             :title
       field             :body
-      embedded_in       :post, :inverse_of => :comments
-      track_history     :on => [:title, :body], :scope => :post, :track_create => true
+      embedded_in       :post
+      track_history     :on => [:title, :body], :scope => :post, :track_create => true, :track_destroy => true
+    end
+
+    class Section
+      include Mongoid::Document
+      include Mongoid::Timestamps
+      include Mongoid::History::Trackable
+
+      field             :title
+      embedded_in       :post
+      track_history     :on => [:title], :scope => :post, :track_create => true, :track_destroy => true
     end
 
     class User
@@ -79,7 +90,11 @@ describe Mongoid::History do
       end
 
       it "should assign association_chain" do
-        @comment.history_tracks.first.association_chain.should == [{'id' => @post.id, 'name' => "Post"}, {'id' => @comment.id, 'name' => "Comment"}]
+        expected = [
+          {'id' => @post.id, 'name' => "Post"},
+          {'id' => @comment.id, 'name' => "comments"}
+        ]
+        @comment.history_tracks.first.association_chain.should == expected
       end
     end
 
@@ -117,19 +132,19 @@ describe Mongoid::History do
 
       it "should assign modified fields" do
         @post.update_attributes(:title => "Another Test")
-        @post.history_tracks.first.modified.should == {
+        @post.history_tracks.last.modified.should == {
           "title" => "Another Test"
         }
       end
 
       it "should assign method field" do
         @post.update_attributes(:title => "Another Test")
-        @post.history_tracks.first.action.should == "update"
+        @post.history_tracks.last.action.should == "update"
       end
 
       it "should assign original fields" do
         @post.update_attributes(:title => "Another Test")
-        @post.history_tracks.first.original.should == {
+        @post.history_tracks.last.original.should == {
           "title" => "Test"
         }
       end
@@ -156,7 +171,7 @@ describe Mongoid::History do
 
       it "should assign association_chain" do
         @post.update_attributes(:title => "Another Test")
-        @post.history_tracks.first.association_chain.should == [{'id' => @post.id, 'name' => "Post"}]
+        @post.history_tracks.last.association_chain.should == [{'id' => @post.id, 'name' => "Post"}]
       end
 
       it "should exclude defined options" do
@@ -206,11 +221,11 @@ describe Mongoid::History do
 
       it "should assign modifier" do
         @post.update_attributes(:title => "Another Test", :modifier => @another_user)
-        @post.history_tracks.first.modifier.should == @another_user
+        @post.history_tracks.last.modifier.should == @another_user
       end
     end
 
-    describe "on update embedded" do
+    describe "on update embedded 1..N (embeds_many)" do
       it "should assign version on comment" do
         @comment.update_attributes(:title => "Test2")
         @comment.version.should == 2 # first track generated on creation
@@ -235,43 +250,133 @@ describe Mongoid::History do
         }
       end
 
+      it "should be possible to undo from parent" do
+        @comment.update_attributes(:title => "Test 2")
+        @post.history_tracks.last.undo!(@user)
+        @comment.reload
+        @comment.title.should == "test"
+      end
+
       it "should assign modifier" do
         @post.update_attributes(:title => "Another Test", :modifier => @another_user)
-        @post.history_tracks.first.modifier.should == @another_user
+        @post.history_tracks.last.modifier.should == @another_user
+      end
+    end
+
+    describe "on update embedded 1..1 (embeds_one)" do
+      before(:each) do
+        @section = Section.new(:title => 'Technology')
+        @post.section = @section
+        @post.save!
+        @post.reload
+        @section = @post.section
+      end
+
+      it "should assign version on create section" do
+        @section.version.should == 1
+      end
+
+      it "should assign version on section" do
+        @section.update_attributes(:title => 'Technology 2')
+        @section.version.should == 2 # first track generated on creation
+      end
+
+      it "should create a history track of version 2" do
+        @section.update_attributes(:title => 'Technology 2')
+        @section.history_tracks.where(:version => 2).first.should_not be_nil
+      end
+
+      it "should assign modified fields" do
+        @section.update_attributes(:title => 'Technology 2')
+        @section.history_tracks.where(:version => 2).first.modified.should == {
+          "title" => "Technology 2"
+        }
+      end
+
+      it "should assign original fields" do
+        @section.update_attributes(:title => 'Technology 2')
+        @section.history_tracks.where(:version => 2).first.original.should == {
+          "title" => "Technology"
+        }
+      end
+
+      it "should be possible to undo from parent" do
+        @section.update_attributes(:title => 'Technology 2')
+        @post.history_tracks.last.undo!(@user)
+        @section.reload
+        @section.title.should == "Technology"
+      end
+
+      it "should assign modifier" do
+        @section.update_attributes(:title => "Business", :modifier => @another_user)
+        @post.history_tracks.last.modifier.should == @another_user
+      end
+    end
+
+    describe "on destroy embedded" do
+      it "should be possible to re-create destroyed embedded" do
+        @comment.destroy
+        @comment.history_tracks.last.undo!(@user)
+        @post.reload
+        @post.comments.first.title.should == "test"
+      end
+
+      it "should be possible to re-create destroyed embedded from parent" do
+        @comment.destroy
+        @post.history_tracks.last.undo!(@user)
+        @post.reload
+        @post.comments.first.title.should == "test"
+      end
+
+      it "should be possible to destroy after re-create embedded from parent" do
+        @comment.destroy
+        @post.history_tracks.last.undo!(@user)
+        @post.history_tracks.last.undo!(@user)
+        @post.reload
+        @post.comments.count.should == 0
+      end
+
+      it "should be possible to create with redo after undo create embedded from parent" do
+        @post.comments.create!(:title => "The second one")
+        @track = @post.history_tracks.last
+        @track.undo!(@user)
+        @track.redo!(@user)
+        @post.reload
+        @post.comments.count.should == 2
       end
     end
 
     describe "non-embedded" do
       it "should undo changes" do
         @post.update_attributes(:title => "Test2")
-        @post.history_tracks.where(:version => 1).first.undo!(@user)
+        @post.history_tracks.where(:version => 1).last.undo!(@user)
         @post.reload
         @post.title.should == "Test"
       end
 
       it "should undo destruction" do
         @post.destroy
-        @post.history_tracks.where(:version => 1).first.undo!(@user)
+        @post.history_tracks.where(:version => 1).last.undo!(@user)
         Post.find(@post.id).title.should == "Test"
       end
 
       it "should create a new history track after undo" do
         @post.update_attributes(:title => "Test2")
-        @post.history_tracks.where(:version => 1).first.undo!(@user)
+        @post.history_tracks.last.undo!(@user)
         @post.reload
-        @post.history_tracks.count.should == 2
+        @post.history_tracks.count.should == 3
       end
 
       it "should assign @user as the modifier of the newly created history track" do
         @post.update_attributes(:title => "Test2")
-        @post.history_tracks.where(:version => 1).first.undo!(@user)
+        @post.history_tracks.where(:version => 1).last.undo!(@user)
         @post.reload
-        @post.history_tracks.where(:version => 2).first.modifier.should == @user
+        @post.history_tracks.where(:version => 2).last.modifier.should == @user
       end
 
       it "should stay the same after undo and redo" do
         @post.update_attributes(:title => "Test2")
-        @track = @post.history_tracks.where(:version => 1).first
+        @track = @post.history_tracks.last
         @track.undo!(@user)
         @track.redo!(@user)
         @post2 = Post.where(:_id => @post.id).first
@@ -281,7 +386,7 @@ describe Mongoid::History do
 
       it "should be destroyed after undo and redo" do
         @post.destroy
-        @track = @post.history_tracks.where(:version => 1).first
+        @track = @post.history_tracks.where(:version => 1).last
         @track.undo!(@user)
         @track.redo!(@user)
         Post.where(:_id => @post.id).first.should == nil

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongoid-history
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-09 00:00:00.000000000Z
+date: 2012-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: easy_diff
-  requirement: &19710360 !ruby/object:Gem::Requirement
+  requirement: &10925040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,76 +22,65 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *19710360
+  version_requirements: *10925040
 - !ruby/object:Gem::Dependency
   name: mongoid
-  requirement: &19709840 !ruby/object:Gem::Requirement
+  requirement: &10924060 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 2.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *19709840
+  version_requirements: *10924060
 - !ruby/object:Gem::Dependency
   name: bson_ext
-  requirement: &19709320 !ruby/object:Gem::Requirement
+  requirement: &10923100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.3.1
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *19709320
+  version_requirements: *10923100
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &19708820 !ruby/object:Gem::Requirement
+  requirement: &10922320 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 2.3.0
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *19708820
+  version_requirements: *10922320
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &19708260 !ruby/object:Gem::Requirement
+  requirement: &10921560 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *19708260
+  version_requirements: *10921560
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &19707720 !ruby/object:Gem::Requirement
+  requirement: &10920720 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *19707720
+  version_requirements: *10920720
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &19707120 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.5.2
-  type: :development
-  prerelease: false
-  version_requirements: *19707120
-- !ruby/object:Gem::Dependency
-  name: rcov
-  requirement: &19706560 !ruby/object:Gem::Requirement
+  requirement: &10935520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -99,32 +88,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *19706560
-- !ruby/object:Gem::Dependency
-  name: reek
-  requirement: &19705940 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.2.8
-  type: :development
-  prerelease: false
-  version_requirements: *19705940
-- !ruby/object:Gem::Dependency
-  name: roodi
-  requirement: &19705280 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.1.0
-  type: :development
-  prerelease: false
-  version_requirements: *19705280
+  version_requirements: *10935520
 - !ruby/object:Gem::Dependency
   name: database_cleaner
-  requirement: &19704680 !ruby/object:Gem::Requirement
+  requirement: &10934420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -132,7 +99,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *19704680
+  version_requirements: *10934420
 description: ! "In frustration of Mongoid::Versioning, I created this plugin for tracking
   historical changes for any document, including embedded ones. It achieves this by
   storing all history tracks in a single collection that you define. (See Usage for
@@ -150,14 +117,14 @@ executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
-- README.rdoc
+- README.md
 files:
 - .document
 - .rspec
-- .rvmrc
+- .travis.yml
 - Gemfile
 - LICENSE.txt
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION
 - lib/mongoid-history.rb
@@ -185,7 +152,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2112048329123492134
+      hash: -4147881344335982311
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -194,12 +161,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.6
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: history tracking, auditing, undo, redo for mongoid
-test_files:
-- spec/integration/integration_spec.rb
-- spec/spec_helper.rb
-- spec/trackable_spec.rb
-- spec/tracker_spec.rb
+test_files: []

data/.rvmrc

@@ -1 +0,0 @@
-rvm 1.9.2@

data/README.rdoc

@@ -1,144 +0,0 @@
-= mongoid-history
-
-In frustration of Mongoid::Versioning, I created this plugin for tracking historical changes for any document, including embedded ones. It achieves this by storing all history tracks in a single collection that you define. (See Usage for more details) Embedded documents are referenced by storing an association path, which is an array of document_name and document_id fields starting from the top most parent document and down to the embedded document that should track history.
-
-This plugin implements multi-user undo, which allows users to undo any history change in any order. Undoing a document also creates a new history track. This is great for auditing and preventing vandalism, but it is probably not suitable for use cases such as a wiki.
-
-== Install
-
-  gem install mongoid-history
-
-== Rails 3
-
-In your Gemfile:
-
-  gem 'mongoid-history'
-
-== Usage
-
-Here is a quick example on how to use this plugin. For more details, please look at spec/integration/integration_spec.rb. It offers more detailed examples on how to use Mongoid::History.
-
-=== Create a History Tracker
-
-Create a new class to track histories. All histories are stored in this tracker. The name of the class can be anything you like. The only requirement is that it includes `Mongoid::History::Tracker`
-
-  # app/models/history_tracker.rb
-  class HistoryTracker
-    include Mongoid::History::Tracker
-  end
-
-=== Set Tracker Class Name
-
-You should manually set the tracker class name to make sure your tracker can be found and loaded properly. You can skip this step if you manually require your tracker before using any trackables. If you don't know what I'm talking about, then you should just follow the example below.
-
-Here is an example of setting the tracker class name using a rails initializer
-
-  # config/initializers/mongoid-history.rb
-  # initializer for mongoid-history
-  # assuming HistoryTracker is your tracker class
-  Mongoid::History.tracker_class_name = :history_tracker
-
-
-=== Create Trackable classes and objects
-
-  class Post
-    include Mongoid::Document
-    include Mongoid::Timestamps
-
-    # History tracking all Post Documents
-    # Note: Tracking will not work until #track_history is invoked
-    include Mongoid::History::Trackable
-
-    field           :title
-    field           :body
-    field           :rating
-    embeds_many     :comments
-
-    # Telling Mongoid::History how you want to track
-    track_history   :on => [:title, :body],       # I want to track title and body fields only. Default is :all
-                    :modifier_field => :modifier, # Adds "referened_in :modifier" to track who made the change. Default is :modifier
-                    :version_field => :version,   # Adds "field :version, :type => Integer" to track current version. Default is :version
-                    :track_create   =>  false,    # Do you want to track document creation? Default is false
-                    :track_update   =>  true,     # Do you want to track document updates? Default is true
-                    :track_destroy  =>  false,    # Do you want to track document destruction? Default is false
-  end
-
-  class Comment
-    include Mongoid::Document
-    include Mongoid::Timestamps
-
-    # Declare that we want to track comments
-    include Mongoid::History::Trackable
-
-    field             :title
-    field             :body
-    embedded_in       :post, :inverse_of => :comments
-
-    # Track title and body for all comments, scope it to post (the parent)
-    # Also track creation and destruction
-    track_history     :on => [:title, :body], :scope => :post, :track_create => true, :track_destroy => true
-  end
-
-  # The modifier can be specified as well
-  class User
-    include Mongoid::Document
-    include Mongoid::Timestamps
-
-    field             :name
-  end
-
-  user = User.create(:name => "Aaron")
-  post = Post.create(:title => "Test", :body => "Post", :modifier => user)
-  comment = post.comments.create(:title => "test", :body => "comment", :modifier => user)
-  comment.history_tracks.count # should be 1
-
-  comment.update_attributes(:title => "Test 2")
-  comment.history_tracks.count # should be 2
-
-  track = comment.history_tracks.last
-
-  track.undo! user # comment title should be "Test"
-
-  track.redo! user # comment title should be "Test 2"
-
-  # undo last change
-  comment.undo! user
-
-  # undo versions 1 - 4
-  comment.undo! user, :from => 4, :to => 1
-
-  # undo last 3 versions
-  comment.undo! user, :last => 3
-
-  # redo versions 1 - 4
-  comment.redo! user, :from => 1, :to => 4
-
-  # redo last 3 versions
-  comment.redo! user, :last => 3
-
-  # delete post
-  post.destroy
-
-  # undelete post
-  post.undo! user
-
-  # disable tracking for comments within a block
-  Comment.disable_tracking do
-    comment.update_attributes(:title => "Test 3")
-  end
-
-== Contributing to mongoid-history
-
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
-* Fork the project
-* Start a feature/bugfix branch
-* Commit and push until you are happy with your contribution
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-
-== Copyright
-
-Copyright (c) 2011 Aaron Qian. See LICENSE.txt for
-further details.
-