mongoid-history 0.3.2 → 0.3.3

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+0.3.3 (1/4/2013)
+----------------
+
+* [#42](https://github.com/aq1018/mongoid-history/issues/42) Fix: corrected creation of association chain when using nested embedded documents - [@matekb](https://github.com/matekb).
+* [#56](https://github.com/aq1018/mongoid-history/issues/56) Fix: now possible to undo setting (creating) attributes that was previously unset - [@matekb](https://github.com/matekb).
+* [#49](https://github.com/aq1018/mongoid-history/issues/49) Fix: now correctly undo/redo localized fields - [@edejong](https://github.com/edejong).
+
+
 0.3.2 (1/24/2013)
 -----------------
 

data/VERSION

@@ -1 +1 @@
-0.3.2
+0.3.3

data/lib/mongoid/history/trackable.rb

@@ -140,7 +140,7 @@ module Mongoid::History
         # we're assured, through the object creation, it'll exist. Whereas we're not guarenteed
         # the child to parent (embedded_in, belongs_to) relation will be defined
         if node._parent
-          meta = _parent.relations.values.select do |relation|
+          meta = node._parent.relations.values.select do |relation|
             relation.class_name == node.class.to_s
           end.first
         end

data/lib/mongoid/history/tracker.rb

@@ -52,7 +52,10 @@ module Mongoid::History
       undo_hash.easy_merge!(original)
       modifier_field = trackable.history_trackable_options[:modifier_field]
       undo_hash[modifier_field] = modifier
-      undo_hash
+      (modified.keys - undo_hash.keys).each do |k|
+        undo_hash[k] = nil
+      end
+      localize_keys(undo_hash)
     end
 
     def redo_attr(modifier)
@@ -60,7 +63,7 @@ module Mongoid::History
       redo_hash.easy_merge!(modified)
       modifier_field = trackable.history_trackable_options[:modifier_field]
       redo_hash[modifier_field] = modifier
-      redo_hash
+      localize_keys(redo_hash)
     end
 
     def trackable_root
@@ -97,7 +100,7 @@ private
 
     def create_standalone
       class_name = association_chain.first["name"]
-      restored = class_name.constantize.new(modified)
+      restored = class_name.constantize.new(localize_keys(modified))
       restored.id = modified["_id"]
       restored.save!
     end
@@ -105,9 +108,9 @@ private
     def create_on_parent
       name = association_chain.last["name"]
       if embeds_one?(trackable_parent, name)
-        trackable_parent.send("create_#{name}!", modified)
+        trackable_parent.send("create_#{name}!", localize_keys(modified))
       elsif embeds_many?(trackable_parent, name)
-         trackable_parent.send(name).create!(modified)
+         trackable_parent.send(name).create!(localize_keys(modified))
       else
         raise "This should never happen. Please report bug!"
       end
@@ -155,5 +158,13 @@ private
       documents
     end
 
+    def localize_keys(hash)
+      klass = association_chain.first["name"].constantize
+      klass.localized_fields.keys.each do |name|
+        hash["#{name}_translations"] = hash.delete(name) if hash[name].present?
+      end if klass.respond_to?(:localized_fields)
+      hash
+    end
+
   end
 end

data/mongoid-history.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "mongoid-history"
-  s.version = "0.3.2"
+  s.version = "0.3.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Aaron Qian", "Justin Grimes"]
-  s.date = "2013-01-24"
+  s.date = "2013-04-01"
   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 = [
@@ -35,6 +35,7 @@ Gem::Specification.new do |s|
     "mongoid-history.gemspec",
     "spec/integration/integration_spec.rb",
     "spec/integration/multi_relation_spec.rb",
+    "spec/integration/nested_embedded_documents_spec.rb",
     "spec/spec_helper.rb",
     "spec/support/database_cleaner.rb",
     "spec/support/mongoid.rb",
@@ -45,7 +46,7 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/aq1018/mongoid-history"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.24"
+  s.rubygems_version = "1.8.25"
   s.summary = "history tracking, auditing, undo, redo for mongoid"
 
   if s.respond_to? :specification_version then

data/spec/integration/integration_spec.rb

@@ -199,6 +199,15 @@ describe Mongoid::History do
         @user.reload.name.should == name
       end
 
+      it "should undo non-existing field changes" do
+        post = Post.create(:modifier => @user, :views => 100)
+        post.reload.title.should == nil
+        post.update_attributes(:title => "Aaron2")
+        post.reload.title.should == "Aaron2"
+        post.history_tracks.first.undo! nil
+        post.reload.title.should == nil
+      end
+
       it "should track array changes" do
         aliases = @user.aliases
         @user.update_attributes(:aliases => [ 'bob', 'joe' ])
@@ -536,6 +545,7 @@ describe Mongoid::History do
           @comment.undo! @user, :last => 2
           @comment.title.should == "Test2"
         end
+
       end
 
       describe "redo" do
@@ -565,5 +575,36 @@ describe Mongoid::History do
 
       end
     end
+
+    describe "localized fields" do
+      before :each do
+        class Sausage
+          include Mongoid::Document
+          include Mongoid::History::Trackable
+
+          field           :flavour, localize: true
+          track_history   :on => [:flavour], :track_destroy => true
+        end
+      end
+      it "should correctly undo and redo" do
+        if Sausage.respond_to?(:localized_fields)
+          sausage = Sausage.create(flavour_translations: { 'en' => "Apple", 'nl' => 'Appel' } )
+          sausage.update_attributes(:flavour => "Guinness")
+
+          track = sausage.history_tracks.last
+
+          track.undo! @user
+          sausage.reload.flavour.should == "Apple"
+
+          track.redo! @user
+          sausage.reload.flavour.should == "Guinness"
+
+          sausage.destroy
+          sausage.history_tracks.last.action.should == "destroy"
+          sausage.history_tracks.last.undo! @user
+          sausage.reload.flavour.should == "Guinness"
+        end
+      end
+    end
   end
 end

data/spec/integration/nested_embedded_documents_spec.rb

@@ -0,0 +1,75 @@
+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
+      embeds_many :embones
+
+      track_history   :on => :all,       # 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
+                  :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 Embone
+      include Mongoid::Document
+      include Mongoid::History::Trackable
+      
+      field :name
+      embeds_many :embtwos
+      embedded_in :model
+      
+      track_history   :on => :all,       # 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
+                  :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
+                  :scope => :model
+    end
+    
+    class Embtwo
+      include Mongoid::Document
+      include Mongoid::History::Trackable
+      
+      field :name
+      embedded_in :embone
+      
+      track_history   :on => :all,       # 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
+                  :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
+                  :scope => :model
+    end
+    
+    class User
+      include Mongoid::Document
+      has_many :models, :dependent => :destroy, inverse_of: :user
+    end
+  end
+
+  it "should be able to track history for nested embedded documents" do
+    user = User.new
+    user.save
+    
+    model = Model.new({name: "m1name"})
+    model.user = user
+    model.save!
+    embedded1 = model.embones.create({name: "e1name"})
+    embedded2 = embedded1.embtwos.create({name: "e2name"})
+
+    embedded2.name = "a new name"
+    embedded2.save
+    
+    model.history_tracks.first.undo! user 
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongoid-history
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-24 00:00:00.000000000 Z
+date: 2013-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: easy_diff
@@ -97,6 +97,7 @@ files:
 - mongoid-history.gemspec
 - spec/integration/integration_spec.rb
 - spec/integration/multi_relation_spec.rb
+- spec/integration/nested_embedded_documents_spec.rb
 - spec/spec_helper.rb
 - spec/support/database_cleaner.rb
 - spec/support/mongoid.rb
@@ -118,7 +119,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3042283399996028740
+      hash: 1291370256221815219
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -127,7 +128,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: history tracking, auditing, undo, redo for mongoid