mongoid-history 0.0.7 → 0.0.8

data/Rakefile

@@ -19,8 +19,8 @@ Jeweler::Tasks.new do |gem|
   gem.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.}
-  gem.email = "aqian@attinteractive.com"
-  gem.authors = ["Aaron Qian"]
+  gem.email = "aq1018@gmail.com"
+  gem.authors = ["Aaron Qian", "Justin Grimes"]
 end
 Jeweler::RubygemsDotOrgTasks.new
 

data/VERSION

@@ -1 +1 @@
-0.0.7
+0.0.8

data/lib/mongoid/history/trackable.rb

@@ -1,7 +1,7 @@
 module Mongoid::History
   module Trackable
     extend ActiveSupport::Concern
-    
+
     module ClassMethods
       def track_history(options={})
         model_name = self.name.tableize.singularize.to_sym
@@ -15,7 +15,7 @@ module Mongoid::History
         }
 
         options = default_options.merge(options)
-        
+
         # normalize except fields
         # manually ensure _id, id, version will not be tracked in history
         options[:except] = [options[:except]] unless options[:except].is_a? Array
@@ -24,48 +24,48 @@ module Mongoid::History
         options[:except] += [:_id, :id]
         options[:except] = options[:except].map(&:to_s).flatten.compact.uniq
         options[:except].map(&:to_s)
-        
+
         # normalize fields to track to either :all or an array of strings
         if options[:on] != :all
           options[:on] = [options[:on]] unless options[:on].is_a? Array
           options[:on] = options[:on].map(&:to_s).flatten.uniq
         end
-        
+
         field options[:version_field].to_sym, :type => Integer
         referenced_in options[:modifier_field].to_sym, :class_name => Mongoid::History.modifer_class_name
-        
+
         include InstanceMethods
         extend SingletonMethods
-        
+
         delegate :history_trackable_options, :to => 'self.class'
         delegate :track_history?, :to => 'self.class'
 
         before_update :track_update
         before_create :track_create if options[:track_create]
-        
+
         Mongoid::History.trackable_classes ||= []
         Mongoid::History.trackable_classes << self
         Mongoid::History.trackable_class_options ||= {}
         Mongoid::History.trackable_class_options[model_name] = options
         Thread.current[:mongoid_history_trackable_enabled] = true
       end
-      
+
       def track_history?
         !!Thread.current[:mongoid_history_trackable_enabled]
       end
-      
+
       def disable_tracking(&block)
         Thread.current[:mongoid_history_trackable_enabled] = false
         yield
         Thread.current[:mongoid_history_trackable_enabled] = true
       end
     end
-    
+
     module InstanceMethods
       def history_tracks
         @history_tracks ||= Mongoid::History.tracker_class.where(:scope => history_trackable_options[:scope], :association_chain => triverse_association_chain)
       end
-      
+
       #  undo :from => 1, :to => 5
       #  undo 4
       #  undo :last => 10
@@ -79,7 +79,7 @@ module Mongoid::History
         end
         save!
       end
-      
+
       def redo!(modifier, options_or_version=nil)
         versions = get_versions_criteria(options_or_version).to_a
         versions.sort!{|v1, v2| v1.version <=> v2.version}
@@ -90,7 +90,7 @@ module Mongoid::History
         end
         save!
       end
-      
+
     private
       def get_versions_criteria(options_or_version)
         if options_or_version.is_a? Hash
@@ -112,29 +112,30 @@ module Mongoid::History
         end
         versions.desc(:version)
       end
-      
+
       def should_track_update?
         track_history? && !modified_attributes_for_update.blank?
       end
-      
+
       def triverse_association_chain(node=self)
         list = node._parent ? triverse_association_chain(node._parent) : []
         list << { 'name' => node.class.name, 'id' => node.id }
         list
       end
-      
+
       def modified_attributes_for_update
         @modified_attributes_for_update ||= if history_trackable_options[:on] == :all
-          changes
+          changes.reject do |k, v|
+            history_trackable_options[:except].include?(k)
+          end
         else
           changes.reject do |k, v|
             !history_trackable_options[:on].include?(k)
-          end.reject do |k, v|
-            history_trackable_options[:except].include?(k)
           end
+
         end
       end
-      
+
       def modified_attributes_for_create
         @modified_attributes_for_create ||= attributes.inject({}) do |h, pair|
           k,v =  pair
@@ -147,19 +148,19 @@ module Mongoid::History
 
       def history_tracker_attributes
         return @history_tracker_attributes if @history_tracker_attributes
-        
+
         @history_tracker_attributes = {
           :association_chain  => triverse_association_chain,
           :scope              => history_trackable_options[:scope],
           :modifier        => send(history_trackable_options[:modifier_field])
         }
-        
+
         original, modified = transform_changes((new_record? ? modified_attributes_for_create : modified_attributes_for_update))
         @history_tracker_attributes[:original] = original
         @history_tracker_attributes[:modified] = modified
         @history_tracker_attributes
       end
-      
+
       def track_update
         return unless should_track_update?
         current_version = (self.send(history_trackable_options[:version_field]) || 0 ) + 1
@@ -167,7 +168,7 @@ module Mongoid::History
         Mongoid::History.tracker_class.create!(history_tracker_attributes.merge(:version => current_version))
         clear_memoization
       end
-      
+
       def track_create
         return unless track_history?
         current_version = (self.send(history_trackable_options[:version_field]) || 0 ) + 1
@@ -175,14 +176,14 @@ module Mongoid::History
         Mongoid::History.tracker_class.create!(history_tracker_attributes.merge(:version => current_version))
         clear_memoization
       end
-      
+
       def clear_memoization
         @history_tracker_attributes =  nil
         @modified_attributes_for_create = nil
         @modified_attributes_for_update = nil
         @history_tracks = nil
       end
-      
+
       def transform_changes(changes)
         original = {}
         modified = {}
@@ -191,17 +192,17 @@ module Mongoid::History
           original[k] = o if o
           modified[k] = m if m
         end
-        
+
         return original.easy_diff modified
       end
-      
+
     end
-    
+
     module SingletonMethods
       def history_trackable_options
         @history_trackable_options ||= Mongoid::History.trackable_class_options[self.name.tableize.singularize.to_sym]
       end
     end
-    
+
   end
 end

data/mongoid-history.gemspec

@@ -5,15 +5,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mongoid-history}
-  s.version = "0.0.7"
+  s.version = "0.0.8"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Aaron Qian"]
-  s.date = %q{2011-03-16}
+  s.authors = ["Aaron Qian", "Justin Grimes"]
+  s.date = %q{2011-04-02}
   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{aqian@attinteractive.com}
+  s.email = %q{aq1018@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE.txt",
     "README.rdoc"
@@ -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.6.0}
+  s.rubygems_version = %q{1.5.2}
   s.summary = %q{history tracking, auditing, undo, redo for mongoid}
   s.test_files = [
     "spec/integration/integration_spec.rb",

data/spec/integration/integration_spec.rb

@@ -14,6 +14,7 @@ describe Mongoid::History do
       field           :title
       field           :body
       field           :rating
+
       embeds_many     :comments
       track_history   :on => [:title, :body]
     end
@@ -32,15 +33,18 @@ describe Mongoid::History do
     class User
       include Mongoid::Document
       include Mongoid::Timestamps
+      include Mongoid::History::Trackable
 
+      field             :email
       field             :name
+      track_history    :except => [:email]
     end
   end
   
   before :each do
-    @user = User.create(:name => "Aaron")
-    @another_user = User.create(:name => "Another Guy")
-    @post = Post.create(:title => "Test", :body => "Post", :modifier => @user)
+    @user = User.create(:name => "Aaron", :email => "aaron@randomemail.com")
+    @another_user = User.create(:name => "Another Guy", :email => "anotherguy@randomemail.com")
+    @post = Post.create(:title => "Test", :body => "Post", :modifier => @user, :views => 100)
     @comment = @post.comments.create(:title => "test", :body => "comment", :modifier => @user)
   end
   
@@ -63,15 +67,15 @@ describe Mongoid::History do
         @comment.history_tracks.first.modifier.should == @user
       end
       
-      it "should assigin version" do
+      it "should assign version" do
         @comment.history_tracks.first.version.should == 1
       end
       
-      it "should assigin scope" do
+      it "should assign scope" do
         @comment.history_tracks.first.scope == "Post"
       end
       
-      it "should assigin association_chain" do
+      it "should assign association_chain" do
         @comment.history_tracks.first.association_chain = [{:id => @post.id, :name => "Post"}, {:id => @comment.id, :name => "Comment"}]
       end
     end
@@ -108,29 +112,36 @@ describe Mongoid::History do
         @post.history_tracks.first.modifier.should == @user
       end
 
-      it "should assigin version on history tracks" do
+      it "should assign version on history tracks" do
         @post.update_attributes(:title => "Another Test")
         @post.history_tracks.first.version.should == 1
       end
       
-      it "should assigin version on post" do
+      it "should assign version on post" do
         @post.update_attributes(:title => "Another Test")
         @post.version.should == 1
       end
 
-      it "should assigin scope" do
+      it "should assign scope" do
         @post.update_attributes(:title => "Another Test")
         @post.history_tracks.first.scope == "Post"
       end
 
-      it "should assigin association_chain" do
+      it "should assign association_chain" do
         @post.update_attributes(:title => "Another Test")
         @post.history_tracks.first.association_chain = [{:id => @post.id, :name => "Post"}]
       end
+
+      it "should exclude defined options" do
+        @user.update_attributes(:name => "Aaron2", :email => "aaronsnewemail@randomemail.com")
+        @user.history_tracks.first.modified.should == {
+            "name" => "Aaron2"
+        }
+      end
     end
     
     describe "on update non-embedded twice" do
-      it "should assigin version on post" do
+      it "should assign version on post" do
         @post.update_attributes(:title => "Test2")
         @post.update_attributes(:title => "Test3")
         @post.version.should == 2
@@ -173,7 +184,7 @@ describe Mongoid::History do
     end
     
     describe "on update embedded" do
-      it "should assigin version on comment" do
+      it "should assign version on comment" do
         @comment.update_attributes(:title => "Test2")
         @comment.version.should == 2 # first track generated on creation
       end

metadata

@@ -2,15 +2,16 @@
 name: mongoid-history
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors: 
 - Aaron Qian
+- Justin Grimes
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2011-03-16 00:00:00 -07:00
+date: 2011-04-02 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -127,7 +128,7 @@ 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.
   
     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.
-email: aqian@attinteractive.com
+email: aq1018@gmail.com
 executables: []
 
 extensions: []
@@ -167,7 +168,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -460469172984094198
+      hash: 143233499188101224
       segments: 
       - 0
       version: "0"
@@ -180,7 +181,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.6.0
+rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
 summary: history tracking, auditing, undo, redo for mongoid