mongoid-history 0.0.9 → 0.1.0

data/README.rdoc

@@ -42,6 +42,7 @@ Here is a quick example on how to use this plugin. For more details, please look
                     :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_destroy  =>  false,    # Do you want to track document destruction? Default is false
   end
 
   class Comment
@@ -56,8 +57,8 @@ Here is a quick example on how to use this plugin. For more details, please look
     embedded_in       :post, :inverse_of => :comments
     
     # Track title and body for all comments, scope it to post (the parent)
-    # Also track creation
-    track_history     :on => [:title, :body], :scope => :post, :track_create => true
+    # 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 
@@ -96,6 +97,12 @@ Here is a quick example on how to use this plugin. For more details, please look
   
   # redo last 3 versions
   comment.redo! @user, :last => 3
+  
+  # delete post
+  post.destroy
+  
+  # undelete post
+  post.undo! @user
 
 == Contributing to mongoid-history
  

data/VERSION

@@ -1 +1 @@
-0.0.9
+0.1.0

data/lib/mongoid/history/trackable.rb

@@ -11,7 +11,8 @@ module Mongoid::History
           :modifier_field =>  :modifier,
           :version_field  =>  :version,
           :scope          =>  model_name,
-          :track_create   =>  false
+          :track_create   =>  false,
+          :track_destroy  =>  false,
         }
 
         options = default_options.merge(options)
@@ -42,6 +43,7 @@ module Mongoid::History
 
         before_update :track_update
         before_create :track_create if options[:track_create]
+        after_destroy :track_destroy if options[:track_destroy]
 
         Mongoid::History.trackable_classes ||= []
         Mongoid::History.trackable_classes << self
@@ -146,7 +148,15 @@ module Mongoid::History
         end
       end
 
-      def history_tracker_attributes
+      def modified_attributes_for_destroy
+        @modified_attributes_for_destroy ||= attributes.inject({}) do |h, pair|
+          k,v =  pair
+          h[k] = [nil, v]
+          h
+        end
+      end
+
+      def history_tracker_attributes(method)
         return @history_tracker_attributes if @history_tracker_attributes
 
         @history_tracker_attributes = {
@@ -155,7 +165,12 @@ module Mongoid::History
           :modifier        => send(history_trackable_options[:modifier_field])
         }
 
-        original, modified = transform_changes((new_record? ? modified_attributes_for_create : modified_attributes_for_update))
+        original, modified = transform_changes(case method
+          when :destroy then modified_attributes_for_destroy
+          when :create then modified_attributes_for_create
+          else modified_attributes_for_update
+        end)
+        
         @history_tracker_attributes[:original] = original
         @history_tracker_attributes[:modified] = modified
         @history_tracker_attributes
@@ -165,7 +180,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.merge(:version => current_version))
+        Mongoid::History.tracker_class.create!(history_tracker_attributes(:update).merge(:version => current_version, :action => "update"))
         clear_memoization
       end
 
@@ -173,7 +188,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.merge(:version => current_version))
+        Mongoid::History.tracker_class.create!(history_tracker_attributes(:create).merge(:version => current_version, :action => "create"))
+        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"))
         clear_memoization
       end
 
@@ -205,4 +227,4 @@ module Mongoid::History
     end
 
   end
-end
+end

data/lib/mongoid/history/tracker.rb

@@ -10,6 +10,7 @@ module Mongoid::History
       field       :modified,                :type => Hash
       field       :original,                :type => Hash
       field       :version,                 :type => Integer
+      field       :action,                  :type => String
       field       :scope,                   :type => String
       referenced_in :modifier,              :class_name => Mongoid::History.modifer_class_name
 
@@ -21,11 +22,21 @@ module Mongoid::History
     end
     
     def undo!(modifier)
-      trackable.update_attributes!(undo_attr(modifier))
+      if action.to_sym == :destroy
+        class_name = association_chain[0]["name"]
+        restored = class_name.constantize.new(modified)
+        restored.save!
+      else
+        trackable.update_attributes!(undo_attr(modifier))
+      end
     end
     
     def redo!(modifier)
-      trackable.update_attributes!(redo_attr(modifier))
+      if action.to_sym == :destroy
+        trackable.destroy
+      else
+        trackable.update_attributes!(redo_attr(modifier))
+      end
     end
     
     def undo_attr(modifier)
@@ -57,15 +68,16 @@ module Mongoid::History
     end
     
     def affected
-      @affected ||= (modified.keys | original.keys).inject({}){ |h,k| h[k] = trackable.attributes[k]; h}
+      @affected ||= (modified.keys | original.keys).inject({}){ |h,k| h[k] = 
+        trackable ? trackable.attributes[k] : modified[k]; h}
     end
     
 private
     def trackable_parents_and_trackable
-      @trackable_parents_and_trackable ||= triverse_association_chain
+      @trackable_parents_and_trackable ||= traverse_association_chain
     end
 
-    def triverse_association_chain
+    def traverse_association_chain
       chain = association_chain.dup
       doc = nil
       documents = []
@@ -80,4 +92,4 @@ private
     end
     
   end
-end
+end

data/mongoid-history.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mongoid-history}
-  s.version = "0.0.9"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Aaron Qian", "Justin Grimes"]
-  s.date = %q{2011-04-05}
+  s.date = %q{2011-05-13}
   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.}
@@ -40,7 +40,7 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/aq1018/mongoid-history}
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.5.2}
+  s.rubygems_version = %q{1.5.3}
   s.summary = %q{history tracking, auditing, undo, redo for mongoid}
   s.test_files = [
     "spec/integration/integration_spec.rb",

data/spec/integration/integration_spec.rb

@@ -16,7 +16,7 @@ describe Mongoid::History do
       field           :rating
 
       embeds_many     :comments
-      track_history   :on => [:title, :body]
+      track_history   :on => [:title, :body], :track_destroy => true
     end
 
     class Comment
@@ -37,7 +37,7 @@ describe Mongoid::History do
 
       field             :email
       field             :name
-      track_history    :except => [:email]
+      track_history     :except => [:email]
     end
   end
   
@@ -62,7 +62,6 @@ describe Mongoid::History do
         @comment.history_tracks.first.original.should == {}
       end
       
-      
       it "should assign modifier" do
         @comment.history_tracks.first.modifier.should == @user
       end
@@ -74,12 +73,35 @@ describe Mongoid::History do
       it "should assign scope" do
         @comment.history_tracks.first.scope == "Post"
       end
+
+      it "should assign method" do
+        @comment.history_tracks.first.action == "create"
+      end
       
       it "should assign association_chain" do
         @comment.history_tracks.first.association_chain = [{:id => @post.id, :name => "Post"}, {:id => @comment.id, :name => "Comment"}]
       end
     end
     
+    describe "on destruction" do
+      it "should have two history track records in post" do
+        lambda {
+          @post.destroy
+        }.should change(HistoryTracker, :count).by(1)
+      end
+      
+      it "should assign destroy on track record" do
+        @post.destroy
+        @post.history_tracks.last.action == "destroy"
+      end
+
+      it "should return affected attributes from track record" do
+        @post.destroy
+        @post.history_tracks.last.affected["title"] == "Test"
+      end
+
+    end
+    
     describe "on update non-embedded" do
       it "should create a history track if changed attributes match tracked attributes" do
         lambda {
@@ -99,6 +121,11 @@ describe Mongoid::History do
           "title" => "Another Test"
         }
       end
+
+      it "should assign method field" do
+        @post.update_attributes(:title => "Another Test")
+        @post.history_tracks.first.action.should == "update"
+      end
       
       it "should assign original fields" do
         @post.update_attributes(:title => "Another Test")
@@ -221,6 +248,12 @@ describe Mongoid::History do
         @post.reload
         @post.title.should == "Test"
       end
+
+      it "should undo destruction" do
+        @post.destroy
+        @post.history_tracks.where(:version => 1).first.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")
@@ -245,6 +278,15 @@ describe Mongoid::History do
       
         @post.title.should == @post2.title
       end
+      
+      it "should be destroyed after undo and redo" do
+        @post.destroy
+        @track = @post.history_tracks.where(:version => 1).first
+        @track.undo!(@user)
+        @track.redo!(@user)
+        Post.where(:_id => @post.id).first == nil
+      end
+      
     end
     
     describe "embedded" do

data/spec/trackable_spec.rb

@@ -43,7 +43,8 @@ describe Mongoid::History::Trackable do
         :version_field  =>  :version,
         :scope          =>  :my_model,
         :except         =>  ["created_at", "updated_at", "version", "modifier_id", "_id", "id"],
-        :track_create   =>  false
+        :track_create   =>  false,
+        :track_destroy  =>  false,
       }
     end
     
@@ -64,6 +65,10 @@ describe Mongoid::History::Trackable do
       MyModel.new.private_methods.collect(&:to_sym).should include(:track_create)
     end
 
+    it "should define callback function #track_destroy" do
+      MyModel.new.private_methods.collect(&:to_sym).should include(:track_destroy)
+    end
+
     it "should define #history_trackable_options" do
       MyModel.history_trackable_options.should == @expected_option
     end

metadata

@@ -2,7 +2,7 @@
 name: mongoid-history
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.9
+  version: 0.1.0
 platform: ruby
 authors: 
 - Aaron Qian
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-05 00:00:00 -07:00
+date: 2011-05-13 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -170,7 +170,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 2391533013898856093
+      hash: -1260875336228097140
       segments: 
       - 0
       version: "0"
@@ -183,7 +183,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.5.2
+rubygems_version: 1.5.3
 signing_key: 
 specification_version: 3
 summary: history tracking, auditing, undo, redo for mongoid