mongoid-history 0.3.1 → 0.3.2

data/CHANGELOG.md

@@ -1,7 +1,13 @@
-0.3.1
------
+0.3.2 (1/24/2013)
+-----------------
+
+* [#54](https://github.com/aq1018/mongoid-history/pull/54) Use an index instead of the `$elemMatch` selector in `history_tracks` - [@vecio](https://github.com/vecio).
+* [#11](https://github.com/aq1018/mongoid-history/issues/11) Added `:modifier_field_inverse_of` on `track_history` that defines the `:inverse_of` relationship of the modifier class - [@matekb](https://github.com/matekb), [@dblock](https://github.com/dblock).
+
+0.3.1 (11/16/2012)
+------------------
 
-* [#45](https://github.com/aq1018/mongoid-history/pull/45) Fix: intermittent hash ordering issue with history_tracks - [@getaroom](https://github.com/getaroom).
+* [#45](https://github.com/aq1018/mongoid-history/pull/45) Fix: intermittent hash ordering issue with `history_tracks` - [@getaroom](https://github.com/getaroom).
 * [#50](https://github.com/aq1018/mongoid-history/pull/50) Fix: tracking of array changes, undo and redo of field changes on non-embedded objects - [@dblock](https://github.com/dblock).
 
 0.3.0 (8/21/2012)

data/Gemfile

@@ -1,7 +1,8 @@
 source "http://rubygems.org"
 
 gem "easy_diff"
-gem "mongoid", "~> 3.0.4"
+gem "mongoid", "~> 3.0"
+gem "activesupport"
 
 group :test do
   gem "rspec", "~> 2.11.0"

data/README.md

@@ -89,7 +89,8 @@ class Post
 
   # telling Mongoid::History how you want to track changes
   track_history   :on => [:title, :body],       # track title and body fields only, default is :all
-                  :modifier_field => :modifier, # adds "referenced_in :modifier" to track who made the change, default is :modifier
+                  :modifier_field => :modifier, # adds "belongs_to :modifier" to track who made the change, default is :modifier
+                  :modifier_field_inverse_of => :nil, # adds an ":inverse_of" option to the "belongs_to :modifier" relation, default is not set
                   :version_field => :version,   # adds "field :version, :type => Integer" to track current version, default is :version
                   :track_create   =>  false,    # track document creation, default is false
                   :track_update   =>  true,     # track document updates, default is true
@@ -179,5 +180,6 @@ Copyright
 ---------
 
 Copyright (c) 2011-2012 Aaron Qian. MIT License.
+
 See [LICENSE.txt](https://github.com/aq1018/mongoid-history/blob/master/LICENSE.txt) for further details.
 

data/VERSION

@@ -1 +1 @@
-0.3.1
+0.3.2

data/lib/mongoid/history/trackable.rb

@@ -34,7 +34,10 @@ module Mongoid::History
         end
 
         field options[:version_field].to_sym, :type => Integer
-        belongs_to options[:modifier_field].to_sym, :class_name => Mongoid::History.modifier_class_name
+
+        belongs_to_modifier_options = { :class_name => Mongoid::History.modifier_class_name }
+        belongs_to_modifier_options[:inverse_of] = options[:modifier_field_inverse_of] if options.has_key?(:modifier_field_inverse_of)
+        belongs_to options[:modifier_field].to_sym, belongs_to_modifier_options
 
         include MyInstanceMethods
         extend SingletonMethods
@@ -71,7 +74,7 @@ module Mongoid::History
 
     module MyInstanceMethods
       def history_tracks
-        @history_tracks ||= Mongoid::History.tracker_class.where(:scope => history_trackable_options[:scope], :association_chain => { "$elemMatch" => association_hash })
+        @history_tracks ||= Mongoid::History.tracker_class.where(:scope => history_trackable_options[:scope], :association_chain => association_hash)
       end
 
       #  undo :from => 1, :to => 5
@@ -82,7 +85,6 @@ module Mongoid::History
         versions.sort!{|v1, v2| v2.version <=> v1.version}
 
         versions.each do |v|
-          undo_attr = v.undo_attr(modifier)
           self.attributes = v.undo_attr(modifier)
         end
         save!
@@ -146,7 +148,7 @@ module Mongoid::History
         # if root node has no meta, and should use class name instead
         name = meta ? meta.key.to_s : node.class.name
 
-        { 'name' => name, 'id' => node.id}
+        ActiveSupport::OrderedHash['name', name, 'id', node.id]
       end
 
       def modified_attributes_for_update

data/lib/mongoid/history/tracker.rb

@@ -13,7 +13,10 @@ module Mongoid::History
       field       :version,                 :type => Integer
       field       :action,                  :type => String
       field       :scope,                   :type => String
-      belongs_to :modifier,              :class_name => Mongoid::History.modifier_class_name
+      belongs_to  :modifier,                :class_name => Mongoid::History.modifier_class_name
+
+      index(:scope => 1)
+      index(:association_chain => 1)
 
       Mongoid::History.tracker_class_name = self.name.tableize.singularize.to_sym
 

data/mongoid-history.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "mongoid-history"
-  s.version = "0.3.1"
+  s.version = "0.3.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Aaron Qian", "Justin Grimes"]
-  s.date = "2012-11-16"
+  s.date = "2013-01-24"
   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 = [
@@ -34,9 +34,11 @@ Gem::Specification.new do |s|
     "lib/mongoid/history/tracker.rb",
     "mongoid-history.gemspec",
     "spec/integration/integration_spec.rb",
+    "spec/integration/multi_relation_spec.rb",
     "spec/spec_helper.rb",
     "spec/support/database_cleaner.rb",
     "spec/support/mongoid.rb",
+    "spec/support/mongoid_history.rb",
     "spec/trackable_spec.rb",
     "spec/tracker_spec.rb"
   ]
@@ -51,14 +53,17 @@ Gem::Specification.new do |s|
 
     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>, ["~> 3.0.4"])
+      s.add_runtime_dependency(%q<mongoid>, ["~> 3.0"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
     else
       s.add_dependency(%q<easy_diff>, [">= 0"])
-      s.add_dependency(%q<mongoid>, ["~> 3.0.4"])
+      s.add_dependency(%q<mongoid>, ["~> 3.0"])
+      s.add_dependency(%q<activesupport>, [">= 0"])
     end
   else
     s.add_dependency(%q<easy_diff>, [">= 0"])
-    s.add_dependency(%q<mongoid>, ["~> 3.0.4"])
+    s.add_dependency(%q<mongoid>, ["~> 3.0"])
+    s.add_dependency(%q<activesupport>, [">= 0"])
   end
 end
 

data/spec/integration/integration_spec.rb

@@ -1,11 +1,7 @@
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+require 'spec_helper'
 
 describe Mongoid::History do
-  before :all do
-    class HistoryTracker
-      include Mongoid::History::Tracker
-    end
-
+  before :each do
     class Post
       include Mongoid::Document
       include Mongoid::Timestamps
@@ -66,9 +62,7 @@ describe Mongoid::History do
       field             :title
       track_history     :on => [:title], :scope => :post, :track_create => true, :track_destroy => true, :modifier_field => :updated_by
     end
-  end
 
-  before :each do
     @user = User.create(:name => "Aaron", :email => "aaron@randomemail.com", :aliases => [ 'bob' ])
     @another_user = User.create(:name => "Another Guy", :email => "anotherguy@randomemail.com")
     @post = Post.create(:title => "Test", :body => "Post", :modifier => @user, :views => 100)
@@ -118,7 +112,7 @@ describe Mongoid::History do
       it "should have two history track records in post" do
         lambda {
           @post.destroy
-        }.should change(HistoryTracker, :count).by(1)
+        }.should change(Tracker, :count).by(1)
       end
 
       it "should assign destroy on track record" do
@@ -136,13 +130,13 @@ describe Mongoid::History do
       it "should create a history track if changed attributes match tracked attributes" do
         lambda {
           @post.update_attributes(:title => "Another Test")
-        }.should change(HistoryTracker, :count).by(1)
+        }.should change(Tracker, :count).by(1)
       end
 
       it "should not create a history track if changed attributes do not match tracked attributes" do
         lambda {
           @post.update_attributes(:rating => "untracked")
-        }.should change(HistoryTracker, :count).by(0)
+        }.should change(Tracker, :count).by(0)
       end
 
       it "should assign modified fields" do
@@ -232,7 +226,7 @@ describe Mongoid::History do
         lambda {
           @post.update_attributes(:title => "Test2")
           @post.update_attributes(:title => "Test3")
-        }.should change(HistoryTracker, :count).by(2)
+        }.should change(Tracker, :count).by(2)
       end
 
       it "should create a history track of version 2" do
@@ -394,10 +388,6 @@ describe Mongoid::History do
         @tag_bar = @post.tags.create(:title => "bar")
       end
 
-      after(:each) do
-        Thread.current[:mongoid_history_sweeper_controller] = nil
-      end
-
       it "should have cascaded the creation callbacks and set timestamps" do
         @tag_foo.created_at.should_not be_nil
         @tag_foo.updated_at.should_not be_nil

data/spec/integration/multi_relation_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe Mongoid::History::Tracker do
+  before :each do    
+    class Model
+      include Mongoid::Document
+      include Mongoid::History::Trackable
+      
+      field :name, type: String
+      belongs_to :user, inverse_of: :models
+      has_and_belongs_to_many :external_users, class_name: "User", inverse_of: :external_models
+
+      track_history   :on => :name,       # track title and body fields only, default is :all
+                  :modifier_field => :modifier, # adds "referenced_in :modifier" to track who made the change, default is :modifier
+                  :modifier_field_inverse_of => nil, # no inverse modifier relationship
+                  :version_field => :version,   # adds "field :version, :type => Integer" to track current version, default is :version
+                  :track_create   =>  false,    # track document creation, default is false
+                  :track_update   =>  true,     # track document updates, default is true
+                  :track_destroy  =>  false    # track document destruction, default is false
+    end
+    
+    class User
+      include Mongoid::Document
+      has_many :models, :dependent => :destroy, inverse_of: :user
+      has_and_belongs_to_many :external_model, class_name: "Model", inverse_of: :external_users
+    end
+  end
+
+  it "should be possible to undo when having multiple relations to modifier class" do
+    user = User.new
+    user.save
+    
+    model = Model.new
+    model.name = "Foo"
+    model.user = user
+    model.save!
+    
+    model.name = "Bar"
+    model.save!
+    
+    model.undo! user
+  end
+end

data/spec/support/mongoid_history.rb

@@ -0,0 +1,15 @@
+RSpec.configure do |config|
+  config.before :each do    
+    class Tracker
+      include Mongoid::History::Tracker
+    end
+    Mongoid::History.tracker_class_name = "Tracker"
+    Mongoid::History.modifier_class_name = "User"
+  end
+  config.after :each do
+    Mongoid::History.tracker_class_name = nil
+    Mongoid::History.trackable_class_options = nil
+    Thread.current[:mongoid_history_sweeper_controller] = nil
+  end
+end
+

data/spec/trackable_spec.rb

@@ -8,10 +8,6 @@ describe Mongoid::History::Trackable do
     end
   end
 
-  after :each do
-    Mongoid::History.trackable_class_options = nil
-  end
-
   it "should have #track_history" do
     MyModel.should respond_to :track_history
   end
@@ -42,10 +38,6 @@ describe Mongoid::History::Trackable do
       }
     end
 
-    after :each do
-      Mongoid::History.trackable_class_options = nil
-    end
-
     it "should have default options" do
       Mongoid::History.trackable_class_options[:my_model].should == @expected_option
     end

data/spec/tracker_spec.rb

@@ -1,17 +1,10 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe Mongoid::History::Tracker do
-  before :each do
+  it "should set tracker_class_name when included" do
     class MyTracker
       include Mongoid::History::Tracker
     end
-  end
-
-  after :each do
-    Mongoid::History.tracker_class_name = nil
-  end
-
-  it "should set tracker_class_name when included" do
     Mongoid::History.tracker_class_name.should == :my_tracker
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongoid-history
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-16 00:00:00.000000000 Z
+date: 2013-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: easy_diff
@@ -35,7 +35,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.0.4
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -43,7 +43,23 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.0.4
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 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
@@ -80,9 +96,11 @@ files:
 - lib/mongoid/history/tracker.rb
 - mongoid-history.gemspec
 - spec/integration/integration_spec.rb
+- spec/integration/multi_relation_spec.rb
 - spec/spec_helper.rb
 - spec/support/database_cleaner.rb
 - spec/support/mongoid.rb
+- spec/support/mongoid_history.rb
 - spec/trackable_spec.rb
 - spec/tracker_spec.rb
 homepage: http://github.com/aq1018/mongoid-history
@@ -100,7 +118,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3144305441896243530
+      hash: -3042283399996028740
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: