mongoid-history 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1fd1d2a3abaccb54ecc0c83da09b16dbaa7d8210
-  data.tar.gz: 1126ed19a46d4542a059c2434665436043787424
+  metadata.gz: d92239564a7df075b3a55eb68c9f7f22666e24ef
+  data.tar.gz: 13f5bb15f7102d5b0957b569cb880af4249a0c75
 SHA512:
-  metadata.gz: d83f26cbfe246d76d2659414b7a7feb48b1a27007cafec7bf1c4d957568b688375ce09302f0ed3a15329d31e87a4e15147212c70f3fa4796d6de783e17edfd0d
-  data.tar.gz: 27fce1d91542b620f197f213185b570f057508a929f05abc8b2647cfeeeef543e536850e3127d9b29e567f032bc94a2d587a72c9d8f91facec0254632540b49e
+  metadata.gz: e9b09271720419ebbd843f78954d182430e4a3e5f020cc6b835993154c08fa55e6c8627beaef64f8813632ce15118186057d39771ddb863cf40f28a68c6ce7d3
+  data.tar.gz: 8d337e3008f6468a42b01c0babafa649685237f686e255bd620d380bf8d91bf77d56888445ca20b043ee6f2e7398d4821709fb877bafe11765948fc38ee6ddad

data/.rubocop_todo.yml

@@ -64,6 +64,7 @@ Style/Documentation:
     - 'spec/unit/singleton_methods_spec.rb'
     - 'spec/unit/trackable_spec.rb'
     - 'spec/unit/tracker_spec.rb'
+    - 'spec/unit/attributes/base_spec.rb'
     - 'spec/unit/attributes/create_spec.rb'
     - 'spec/unit/attributes/destroy_spec.rb'
     - 'spec/unit/attributes/update_spec.rb'
@@ -85,3 +86,7 @@ Style/MultilineBlockChain:
   Exclude:
     - 'lib/mongoid/history/trackable.rb'
     - 'lib/mongoid/history/tracker.rb'
+
+Style/ClassLength:
+  Exclude:
+    - 'lib/mongoid/history/options.rb'

data/CHANGELOG.md

@@ -1,57 +1,57 @@
-0.6.0 (2016/09/13)
-------------------
+### 0.6.1 (2017/01/04)
 
-* [#2](https://github.com/mongoid/mongoid-history/pull/2): Froked into the [mongoid](https://github.com/mongoid) organization - [@dblock](https://github.com/dblock).
-* [#1](https://github.com/mongoid/mongoid-history/pull/1): Added Danger, PR linter - [@dblock](https://github.com/dblock).
-* [#166](https://github.com/aq1018/mongoid-history/pull/166): Hash fields should default to an empty Hash - [@johnnyshields](https://github.com/johnnyshields).
-* [#162](https://github.com/aq1018/mongoid-history/pull/162): Do not consider embedded relations as dynamic fields - [@JagdeepSingh](https://github.com/JagdeepSingh).
-* [#144](https://github.com/aq1018/mongoid-history/pull/158): Can modify history tracker insertion on object creation - [@sivagollapalli](https://github.com/sivagollapalli).
-* [#155](https://github.com/aq1018/mongoid-history/pull/155): Add support to whitelist the attributes for tracked embeds_one and embeds_many relations - [@JagdeepSingh](https://github.com/JagdeepSingh).
-* [#154](https://github.com/aq1018/mongoid-history/pull/154): Prevent soft-deleted embedded documents from tracking - [@JagdeepSingh](https://github.com/JagdeepSingh).
-* [#151](https://github.com/aq1018/mongoid-history/pull/151): Added ability to customize tracker class for each trackable; multiple trackers across the app are now possible - [@JagdeepSingh](https://github.com/JagdeepSingh).
-* [#151](https://github.com/aq1018/mongoid-history/pull/151): Added automatic support for `request_store` gem as drop-in replacement for `Thread.current` - [@JagdeepSingh](https://github.com/JagdeepSingh).
-* [#150](https://github.com/aq1018/mongoid-history/pull/150): Added support for keeping embedded objects audit history in parent itself - [@JagdeepSingh](https://github.com/JagdeepSingh).
+* [#182](https://github.com/mongoid/mongoid-history/pull/182): No-op on repeated calls to destroy - [@msaffitz](https://github.com/msaffitz).
+* [#170](https://github.com/mongoid/mongoid-history/pull/170): Parent repo is now [mongoid/mongoid-history](https://github.com/mongoid/mongoid-history) - [@dblock](https://github.com/dblock).
+* [#171](https://github.com/mongoid/mongoid-history/pull/171): Add field formatting - [@jnfeinstein](https://github.com/jnfeinstein).
+* [#172](https://github.com/mongoid/mongoid-history/pull/172): Add config helper to track all embedded relations - [@jnfeinstein](https://github.com/jnfeinstein).
+* [#173](https://github.com/mongoid/mongoid-history/pull/173): Compatible with mongoid 6 - [@sivagollapalli](https://github.com/sivagollapalli).
 
-0.5.0 (2015/09/18)
-------------------
+### 0.6.0 (2016/09/13)
 
-* [#143](https://github.com/aq1018/mongoid-history/pull/143): Added support for Mongoid 5 - [@dblock](https://github.com/dblock).
-* [#133](https://github.com/aq1018/mongoid-history/pull/133): Added dynamic attributes tracking (Mongoid::Attributes::Dynamic) - [@minisai](https://github.com/minisai).
-* [#142](https://github.com/aq1018/mongoid-history/pull/142): Allow non-database fields to be specified in conjunction with a custom changes method - [@kayakyakr](https://github.com/kayakyakr).
+* [#2](https://github.com/dblock/mongoid-history/pull/2): Forked into the [mongoid](https://github.com/mongoid) organization - [@dblock](https://github.com/dblock).
+* [#1](https://github.com/dblock/mongoid-history/pull/1): Added Danger, PR linter - [@dblock](https://github.com/dblock).
+* [#166](https://github.com/mongoid/mongoid-history/pull/166): Hash fields should default to an empty Hash - [@johnnyshields](https://github.com/johnnyshields).
+* [#162](https://github.com/mongoid/mongoid-history/pull/162): Do not consider embedded relations as dynamic fields - [@JagdeepSingh](https://github.com/JagdeepSingh).
+* [#144](https://github.com/mongoid/mongoid-history/pull/158): Can modify history tracker insertion on object creation - [@sivagollapalli](https://github.com/sivagollapalli).
+* [#155](https://github.com/mongoid/mongoid-history/pull/155): Add support to whitelist the attributes for tracked embeds_one and embeds_many relations - [@JagdeepSingh](https://github.com/JagdeepSingh).
+* [#154](https://github.com/mongoid/mongoid-history/pull/154): Prevent soft-deleted embedded documents from tracking - [@JagdeepSingh](https://github.com/JagdeepSingh).
+* [#151](https://github.com/mongoid/mongoid-history/pull/151): Added ability to customize tracker class for each trackable; multiple trackers across the app are now possible - [@JagdeepSingh](https://github.com/JagdeepSingh).
+* [#151](https://github.com/mongoid/mongoid-history/pull/151): Added automatic support for `request_store` gem as drop-in replacement for `Thread.current` - [@JagdeepSingh](https://github.com/JagdeepSingh).
+* [#150](https://github.com/mongoid/mongoid-history/pull/150): Added support for keeping embedded objects audit history in parent itself - [@JagdeepSingh](https://github.com/JagdeepSingh).
 
-0.4.7 (2015/04/06)
-------------------
+### 0.5.0 (2015/09/18)
 
-* [#124](https://github.com/aq1018/mongoid-history/pull/124): You can require both `mongoid-history` and `mongoid/history` - [@dblock](https://github.com/dblock).
+* [#143](https://github.com/mongoid/mongoid-history/pull/143): Added support for Mongoid 5 - [@dblock](https://github.com/dblock).
+* [#133](https://github.com/mongoid/mongoid-history/pull/133): Added dynamic attributes tracking (Mongoid::Attributes::Dynamic) - [@minisai](https://github.com/minisai).
+* [#142](https://github.com/mongoid/mongoid-history/pull/142): Allow non-database fields to be specified in conjunction with a custom changes method - [@kayakyakr](https://github.com/kayakyakr).
 
-0.4.5 (2015/02/09)
-------------------
+### 0.4.7 (2015/04/06)
 
-* [#131](https://github.com/aq1018/mongoid-history/pull/131): Added `undo` method, that helps to get specific version of an object without saving changes - [@alexkravets](https://github.com/alexkravets).
-* [#127](https://github.com/aq1018/mongoid-history/pull/127): Fixed gem naming per [rubygems](http://guides.rubygems.org/name-your-gem/) specs, now you can `require 'mongoid/history'` - [@nofxx](https://github.com/nofxx).
-* [#129](https://github.com/aq1018/mongoid-history/pull/129): Support multiple levels of embedded polimorphic documents - [@BrunoChauvet](https://github.com/BrunoChauvet).
-* [#123](https://github.com/aq1018/mongoid-history/pull/123): Used a method compatible with mongoid-observers to determinine the version of Mongoid - [@zeitnot](https://github.com/zeitnot).
+* [#124](https://github.com/mongoid/mongoid-history/pull/124): You can require both `mongoid-history` and `mongoid/history` - [@dblock](https://github.com/dblock).
 
-0.4.4 (2014/7/29)
------------------
+### 0.4.5 (2015/02/09)
 
-* [#111](https://github.com/aq1018/mongoid-history/pull/111): Fixed compatibility of `undo!` and `redo!` methods with Rails 3.x - [@mrjlynch](https://github.com/mrjlynch).
+* [#131](https://github.com/mongoid/mongoid-history/pull/131): Added `undo` method, that helps to get specific version of an object without saving changes - [@alexkravets](https://github.com/alexkravets).
+* [#127](https://github.com/mongoid/mongoid-history/pull/127): Fixed gem naming per [rubygems](http://guides.rubygems.org/name-your-gem/) specs, now you can `require 'mongoid/history'` - [@nofxx](https://github.com/nofxx).
+* [#129](https://github.com/mongoid/mongoid-history/pull/129): Support multiple levels of embedded polimorphic documents - [@BrunoChauvet](https://github.com/BrunoChauvet).
+* [#123](https://github.com/mongoid/mongoid-history/pull/123): Used a method compatible with mongoid-observers to determinine the version of Mongoid - [@zeitnot](https://github.com/zeitnot).
 
-0.4.3 (2014/07/10)
-------------------
+### 0.4.4 (2014/7/29)
 
-* [#110](https://github.com/aq1018/mongoid-history/pull/110): Fixed scope reference on history tracks criteria - [@adbeelitamar](https://github.com/adbeelitamar).
+* [#111](https://github.com/mongoid/mongoid-history/pull/111): Fixed compatibility of `undo!` and `redo!` methods with Rails 3.x - [@mrjlynch](https://github.com/mrjlynch).
 
-0.4.2 (2014/07/01)
-------------------
+### 0.4.3 (2014/07/10)
 
-* [#106](https://github.com/aq1018/mongoid-history/pull/106): Added support for polymorphic relationship `scope` - [@adbeelitamar](https://github.com/adbeelitamar).
-* [#106](https://github.com/aq1018/mongoid-history/pull/106): Enabled specifying an array of relationships in `scope` - [@adbeelitamar](https://github.com/adbeelitamar).
-* [#83](https://github.com/aq1018/mongoid-history/pull/83): Added support for Mongoid 4.x, which removed `attr_accessible` in favor of protected attributes - [@dblock](https://github.com/dblock).
-* [#103](https://github.com/aq1018/mongoid-history/pull/103): Fixed compatibility with models using `default_scope` - [@mrjlynch](https://github.com/mrjlynch).
+* [#110](https://github.com/mongoid/mongoid-history/pull/110): Fixed scope reference on history tracks criteria - [@adbeelitamar](https://github.com/adbeelitamar).
 
-0.4.1 (2014/01/11)
-------------------
+### 0.4.2 (2014/07/01)
+
+* [#106](https://github.com/mongoid/mongoid-history/pull/106): Added support for polymorphic relationship `scope` - [@adbeelitamar](https://github.com/adbeelitamar).
+* [#106](https://github.com/mongoid/mongoid-history/pull/106): Enabled specifying an array of relationships in `scope` - [@adbeelitamar](https://github.com/adbeelitamar).
+* [#83](https://github.com/mongoid/mongoid-history/pull/83): Added support for Mongoid 4.x, which removed `attr_accessible` in favor of protected attributes - [@dblock](https://github.com/dblock).
+* [#103](https://github.com/mongoid/mongoid-history/pull/103): Fixed compatibility with models using `default_scope` - [@mrjlynch](https://github.com/mrjlynch).
+
+### 0.4.1 (2014/01/11)
 
 * Fixed compatibility with Mongoid 4.x - [@dblock](https://github.com/dblock).
 * `Mongoid::History::Sweeper` has been removed, in accorance with Mongoid 4.x (see [#3108](https://github.com/mongoid/mongoid/issues/3108)) and Rails 4.x observer deprecation - [@dblock](https://github.com/dblock).
@@ -62,8 +62,7 @@
 * Replace Jeweler with Gem-Release - [@johnnyshields](https://github.com/johnnyshields).
 * Track version as a Ruby file - [@johnnyshields](https://github.com/johnnyshields).
 
-0.4.0 (2013/06/12)
-------------------
+### 0.4.0 (2013/06/12)
 
 * Added `Mongoid::History.disable` and `Mongoid::History.enabled?` methods for global tracking disablement - [@johnnyshields](https://github.com/johnnyshields).
 * Added `:changes_method` that optionally overrides which method to call to collect changes - [@joelnordel](https://github.com/joelnordell).
@@ -74,67 +73,58 @@
 * Added `#tracked_changes` and `#tracked_edits` methods to `Tracker` class for nicer change summaries - [@johnnyshields](https://github.com/johnnyshields) and [@tstepp](https://github.com/tstepp).
 * Refactored and exposed `#trackable_parent_class` in `Tracker`, which returns the class of the trackable regardless of whether the trackable itself has been destroyed - [@johnnyshields](https://github.com/johnnyshields).
 * Added class-level `#tracked_field?` and `#tracked_fields` methods; refactor logic to determine whether a field is tracked - [@johnnyshields](https://github.com/johnnyshields).
-* Fixed bug in Trackable#track_update where `return` condition at beginning of method caused a short-circuit where memoization would not be cleared properly. - [@johnnyshields](https://github.com/johnnyshields).
+* Fixed bug in Trackable#track_update where `return` condition at beginning of method caused a short-circuit where memoization would not be cleared properly - [@johnnyshields](https://github.com/johnnyshields).
 * Tests: Added spec for nested embedded documents - [@matekb](https://github.com/matekb).
 * Tests: Test run time cut in half (~2.5s versus ~5s) by using `#let` helper and removing class initialization before each test - [@johnnyshields](https://github.com/johnnyshields).
 * Tests: Remove `database_cleaner` gem in favor of `Mongoid.purge!` - [@johnnyshields](https://github.com/johnnyshields).
 * Tests: Remove dependency on non-committed file `mongoid.yml` and hardcode collection to `mongoid_history_test` - [@johnnyshields](https://github.com/johnnyshields).
 
-0.3.3 (2013/04/01)
-------------------
+### 0.3.3 (2013/04/01)
 
-* [#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).
+* [#42](https://github.com/mongoid/mongoid-history/issues/42): Fix: corrected creation of association chain when using nested embedded documents - [@matekb](https://github.com/matekb).
+* [#56](https://github.com/mongoid/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/mongoid/mongoid-history/issues/49): Fix: now correctly undo/redo localized fields - [@edejong](https://github.com/edejong).
 
 
-0.3.2 (2013/01/24)
-------------------
+### 0.3.2 (2013/01/24)
 
-* [#54](https://github.com/aq1018/mongoid-history/pull/54): Used 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).
+* [#54](https://github.com/mongoid/mongoid-history/pull/54): Used an index instead of the `$elemMatch` selector in `history_tracks` - [@vecio](https://github.com/vecio).
+* [#11](https://github.com/mongoid/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 (2012/11/16)
-------------------
+### 0.3.1 (2012/11/16)
 
-* [#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).
+* [#45](https://github.com/mongoid/mongoid-history/pull/45): Fix: intermittent hash ordering issue with `history_tracks` - [@getaroom](https://github.com/getaroom).
+* [#50](https://github.com/mongoid/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 (2012/08/21)
-------------------
+### 0.3.0 (2012/08/21)
 
-* [#41](https://github.com/aq1018/mongoid-history/pull/41): Mongoid 3.x support - [@zambot](https://github.com/zambot).
+* [#41](https://github.com/mongoid/mongoid-history/pull/41): Mongoid 3.x support - [@zambot](https://github.com/zambot).
 
-0.2.4 (2012/08/21)
-------------------
+### 0.2.4 (2012/08/21)
 
-* [#38](https://github.com/aq1018/mongoid-history/pull/38): Fix: allow sub-models to be tracked by using `collection_name` as the scope - [@acant](https://github.com/acant).
-* [#35](https://github.com/aq1018/mongoid-history/pull/35): Fix: sweeper references record of change, not the record changed - [@dblock](https://github.com/dblock).
+* [#38](https://github.com/mongoid/mongoid-history/pull/38): Fix: allow sub-models to be tracked by using `collection_name` as the scope - [@acant](https://github.com/acant).
+* [#35](https://github.com/mongoid/mongoid-history/pull/35): Fix: sweeper references record of change, not the record changed - [@dblock](https://github.com/dblock).
 
-0.2.3 (2012/04/20)
-------------------
+### 0.2.3 (2012/04/20)
 
-* [#23](https://github.com/aq1018/mongoid-history/pull/34): Updated `Trackable::association_hash` to write through parent - [@tcopple](https://github.com/tcopple).
+* [#23](https://github.com/mongoid/mongoid-history/pull/34): Updated `Trackable::association_hash` to write through parent - [@tcopple](https://github.com/tcopple).
 * Fix: `Trackable::association_hash` nil meta value call - [@tcopple](https://github.com/tcopple).
-* [#27](https://github.com/aq1018/mongoid-history/pull/27): Added support for re-creation of destroyed embedded documents - [@erlingwl](https://github.com/erlingwl).
+* [#27](https://github.com/mongoid/mongoid-history/pull/27): Added support for re-creation of destroyed embedded documents - [@erlingwl](https://github.com/erlingwl).
 
-0.1.7 (2011/12/09)
-------------------
+### 0.1.7 (2011/12/09)
 
 * Fix: tracking `false` values - [@gottfrois](https://github.com/gottfrois).
 * Used a mongoid observer and controller `around_filter` to pick up modifying user from controller - [@bensymonds](https://github.com/bensymonds).
 * More flexible dependency on mongoid - [@sarcilav](https://github.com/sarcilav).
 * Fix: tracking broken in a multithreaded environment - [@dblock](https://github.com/dblock).
 
-0.1.0 (2011/05/13)
-------------------
+### 0.1.0 (2011/05/13)
 
 * Added support for `destroy` - [@dblock](https://github.com/dblock).
 * Added undo and redo - [@aq1018](https://github.com/aq1018).
 * Added support for temporarily disabling history tracking - [@aq1018](https://github.com/aq1018).
 * Record modifier for undo and redo actions - [@aq1018](https://github.com/aq1018).
 
-0.0.1 (2011/03/04)
-------------------
+### 0.0.1 (2011/03/04)
 
 * Intial public release - [@aq1018](https://github.com/aq1018).

data/Gemfile

@@ -2,11 +2,11 @@ source 'https://rubygems.org'
 
 gemspec
 
-case version = ENV['MONGOID_VERSION'] || '~> 6.0.0.rc0'
+case version = ENV['MONGOID_VERSION'] || '~> 6.0.0'
 when 'HEAD'
   gem 'mongoid', github: 'mongodb/mongoid'
 when /6/
-  gem 'mongoid', '~> 6.0.0.rc0'
+  gem 'mongoid', '~> 6.0.0'
 when /5/
   gem 'mongoid', '~> 5.0'
   gem 'mongoid-observers', '~> 0.2.0'
@@ -20,7 +20,7 @@ else
 end
 
 group :development, :test do
-  gem 'rake'
+  gem 'rake', '< 11.0'
   gem 'bundler'
 end
 

data/README.md

@@ -14,7 +14,7 @@ This gem also implements multi-user undo, which allows users to undo any history
 Install
 -------
 
-This gem supports Mongoid 3, 4 and 5 on Ruby 1.9.3 or newer. Add it to your `Gemfile` or run `gem install mongoid-history`.
+This gem supports Mongoid 3, 4, 5 on Ruby 1.9.3 or newer and Mongoid 6 on Ruby 2.2.2+. Add it to your `Gemfile` or run `gem install mongoid-history`.
 
 ```ruby
 gem 'mongoid-history'
@@ -156,6 +156,35 @@ Mongoid::History.disable do
 end
 ```
 
+You may want to track changes on all fields.
+
+```ruby
+class Post
+  include Mongoid::Document
+  include Mongoid::History::Trackable
+
+  field           :title
+  field           :body
+  field           :rating
+
+  track_history   :on => [:fields] # all fields will be tracked
+end
+```
+
+You can also track changes on all embedded relations.
+
+```ruby
+class Post
+  include Mongoid::Document
+  include Mongoid::History::Trackable
+
+  embeds_many :comments
+  embeds_one  :content
+
+  track_history   :on => [:embedded_relations] # all embedded relations will be tracked
+end
+```
+
 **Include embedded objects attributes in parent audit**
 
 Modify above `Post` and `Comment` classes as below:
@@ -279,6 +308,41 @@ end
 
 This will skip the `page` documents with `removed_at` set to a non-blank value from nested tracking
 
+**Formatting fields**
+
+You can opt to use a proc or string interpolation to alter attributes being stored on a history record.
+
+```ruby
+class Post
+  include Mongoid::Document
+  include Mongoid::History::Trackable
+
+  field           :title
+  track_history   on: :title,
+                  format: { title: ->(t){ t[0..3] } }
+```
+
+This also works for fields on an embedded relations.
+
+```ruby
+class Book
+  include Mongoid::Document
+  include Mongoid::History::Trackable
+
+  embeds_many :pages
+  track_history on: :pages,
+                format: { pages: { number: 'pg. %d' } }
+end
+
+class Page
+  include Mongoid::Document
+  include Mongoid::History::Trackable
+
+  field :number, type: Integer
+  embedded_in :book
+end
+```
+
 **Displaying history trackers as an audit trail**
 
 In your Controller:
@@ -341,7 +405,7 @@ Since October 2013 (mongoid-history version 0.4.1 and onwards), Mongoid::History
 instructions above then run the following command:
 
 ```
-MyHistoryTracker.all.each{|ht| ht.rename(:modifier_id, :created_by)
+MyHistoryTracker.all.rename(modifier_id: :created_by)
 ```
 
 **Setting Modifier Class Name**

data/lib/mongoid/history/attributes/base.rb

@@ -25,6 +25,47 @@ module Mongoid
         def changes
           trackable.send(changes_method)
         end
+
+        def format_field(field, value)
+          format_value(value, trackable_class.field_format(field))
+        end
+
+        def format_embeds_one_relation(rel, obj)
+          rel = trackable_class.database_field_name(rel)
+          relation_class = trackable_class.embeds_one_class(rel)
+          permitted_attrs = trackable_class.tracked_embeds_one_attributes(rel)
+          formats = trackable_class.field_format(rel)
+          format_relation(relation_class, obj, permitted_attrs, formats)
+        end
+
+        def format_embeds_many_relation(rel, obj)
+          rel = trackable_class.database_field_name(rel)
+          relation_class = trackable_class.embeds_many_class(rel)
+          permitted_attrs = trackable_class.tracked_embeds_many_attributes(rel)
+          formats = trackable_class.field_format(rel)
+          format_relation(relation_class, obj, permitted_attrs, formats)
+        end
+
+        def format_relation(relation_class, obj, permitted_attrs, formats)
+          obj.inject({}) do |m, field_value|
+            field = relation_class.database_field_name(field_value.first)
+            next m unless permitted_attrs.include?(field)
+
+            value = field_value.last
+            value = format_value(field_value.last, formats[field]) if formats.class == Hash
+            m.merge(field => value)
+          end
+        end
+
+        def format_value(value, format)
+          if format.class == String
+            format % value
+          elsif format.respond_to?(:call)
+            format.call(value)
+          else
+            value
+          end
+        end
       end
     end
   end

data/lib/mongoid/history/attributes/create.rb

@@ -11,7 +11,7 @@ module Mongoid
                        else
                          v
                        end
-            @attributes[k] = [nil, modified]
+            @attributes[k] = [nil, format_field(k, modified)]
           end
           insert_embeds_one_changes
           insert_embeds_many_changes
@@ -25,11 +25,10 @@ module Mongoid
             rel_class = trackable_class.embeds_one_class(rel)
             paranoia_field = Mongoid::History.trackable_class_settings(rel_class)[:paranoia_field]
             paranoia_field = rel_class.aliased_fields.key(paranoia_field) || paranoia_field
-            permitted_attrs = trackable_class.tracked_embeds_one_attributes(rel)
             rel = aliased_fields.key(rel) || rel
             obj = trackable.send(rel)
             next if !obj || (obj.respond_to?(paranoia_field) && obj.public_send(paranoia_field).present?)
-            @attributes[rel] = [nil, obj.attributes.slice(*permitted_attrs)]
+            @attributes[rel] = [nil, format_embeds_one_relation(rel, obj.attributes)]
           end
         end
 
@@ -38,12 +37,11 @@ module Mongoid
             rel_class = trackable_class.embeds_many_class(rel)
             paranoia_field = Mongoid::History.trackable_class_settings(rel_class)[:paranoia_field]
             paranoia_field = rel_class.aliased_fields.key(paranoia_field) || paranoia_field
-            permitted_attrs = trackable_class.tracked_embeds_many_attributes(rel)
             rel = aliased_fields.key(rel) || rel
             @attributes[rel] = [nil,
                                 trackable.send(rel)
                                 .reject { |obj| obj.respond_to?(paranoia_field) && obj.public_send(paranoia_field).present? }
-                                .map { |obj| obj.attributes.slice(*permitted_attrs) }]
+                                .map { |obj| format_embeds_many_relation(rel, obj.attributes) }]
           end
         end
       end

data/lib/mongoid/history/attributes/destroy.rb

@@ -4,7 +4,7 @@ module Mongoid
       class Destroy < ::Mongoid::History::Attributes::Base
         def attributes
           @attributes = {}
-          trackable.attributes.each { |k, v| @attributes[k] = [v, nil] if trackable_class.tracked_field?(k, :destroy) }
+          trackable.attributes.each { |k, v| @attributes[k] = [format_field(k, v), nil] if trackable_class.tracked_field?(k, :destroy) }
           insert_embeds_one_changes
           insert_embeds_many_changes
           @attributes
@@ -16,9 +16,8 @@ module Mongoid
           trackable_class.tracked_embeds_one
             .map { |rel| aliased_fields.key(rel) || rel }
             .each do |rel|
-              permitted_attrs = trackable_class.tracked_embeds_one_attributes(rel)
               obj = trackable.send(rel)
-              @attributes[rel] = [obj.attributes.slice(*permitted_attrs), nil] if obj
+              @attributes[rel] = [format_embeds_one_relation(rel, obj.attributes), nil] if obj
             end
         end
 
@@ -26,8 +25,7 @@ module Mongoid
           trackable_class.tracked_embeds_many
             .map { |rel| aliased_fields.key(rel) || rel }
             .each do |rel|
-              permitted_attrs = trackable_class.tracked_embeds_many_attributes(rel)
-              @attributes[rel] = [trackable.send(rel).map { |obj| obj.attributes.slice(*permitted_attrs) }, nil]
+              @attributes[rel] = [trackable.send(rel).map { |obj| format_embeds_many_relation(rel, obj.attributes) }, nil]
             end
         end
       end

data/lib/mongoid/history/attributes/update.rb

@@ -10,7 +10,7 @@ module Mongoid
             elsif trackable_class.tracked_embeds_many?(k)
               insert_embeds_many_changes(k, v)
             elsif trackable_class.tracked?(k, :update)
-              @attributes[k] = v
+              @attributes[k] = format_field(k, v)
             end
           end
           @attributes
@@ -20,22 +20,22 @@ module Mongoid
 
         def insert_embeds_one_changes(relation, value)
           relation = trackable_class.database_field_name(relation)
-          permitted_attrs = trackable_class.tracked_embeds_one_attributes(relation)
           relation_class = trackable_class.embeds_one_class(relation)
           paranoia_field = Mongoid::History.trackable_class_settings(relation_class)[:paranoia_field]
           @attributes[relation] = []
-          @attributes[relation][0] = value[0][paranoia_field].present? ? {} : value[0].slice(*permitted_attrs)
-          @attributes[relation][1] = value[1][paranoia_field].present? ? {} : value[1].slice(*permitted_attrs)
+          @attributes[relation][0] = value[0][paranoia_field].present? ? {} : format_embeds_one_relation(relation, value[0])
+          @attributes[relation][1] = value[1][paranoia_field].present? ? {} : format_embeds_one_relation(relation, value[1])
         end
 
         def insert_embeds_many_changes(relation, value)
           relation = trackable_class.database_field_name(relation)
-          permitted_attrs = trackable_class.tracked_embeds_many_attributes(relation)
           relation_class = trackable_class.embeds_many_class(relation)
           paranoia_field = Mongoid::History.trackable_class_settings(relation_class)[:paranoia_field]
           @attributes[relation] = []
-          @attributes[relation][0] = value[0].reject { |rel| rel[paranoia_field].present? }.map { |v_attrs| v_attrs.slice(*permitted_attrs) }
-          @attributes[relation][1] = value[1].reject { |rel| rel[paranoia_field].present? }.map { |v_attrs| v_attrs.slice(*permitted_attrs) }
+          @attributes[relation][0] = value[0].reject { |rel| rel[paranoia_field].present? }
+                                     .map { |v_attrs| format_embeds_many_relation(relation, v_attrs) }
+          @attributes[relation][1] = value[1].reject { |rel| rel[paranoia_field].present? }
+                                     .map { |v_attrs| format_embeds_many_relation(relation, v_attrs) }
         end
       end
     end

data/lib/mongoid/history/options.rb

@@ -14,6 +14,7 @@ module Mongoid
       def parse(options = {})
         @options = default_options.merge(options)
         prepare_skipped_fields
+        prepare_formatted_fields
         parse_tracked_fields_and_relations
         @options
       end
@@ -31,7 +32,8 @@ module Mongoid
             scope: scope,
             track_create: false,
             track_update: true,
-            track_destroy: false }
+            track_destroy: false,
+            format: nil }
       end
 
       # Sets the :except attributes and relations in `options` to be an [ Array <String> ]
@@ -43,6 +45,30 @@ module Mongoid
         @options[:except] = options[:except].map { |field| trackable.database_field_name(field) }.compact.uniq
       end
 
+      def prepare_formatted_fields
+        formats = {}
+
+        if options[:format].class == Hash
+          options[:format].each do |field, format|
+            next if field.nil?
+
+            field = trackable.database_field_name(field)
+
+            if format.class == Hash && trackable.embeds_many?(field)
+              relation_class = trackable.embeds_many_class(field)
+              formats[field] = format.inject({}) { |a, e| a.merge(relation_class.database_field_name(e.first) => e.last) }
+            elsif format.class == Hash && trackable.embeds_one?(field)
+              relation_class = trackable.embeds_one_class(field)
+              formats[field] = format.inject({}) { |a, e| a.merge(relation_class.database_field_name(e.first) => e.last) }
+            else
+              formats[field] = format
+            end
+          end
+        end
+
+        options[:format] = formats
+      end
+
       def parse_tracked_fields_and_relations
         # case `options[:on]`
         # when `posts: [:id, :title]`, then it will convert it to `[[:posts, [:id, :title]]]`
@@ -64,6 +90,11 @@ module Mongoid
           @options[:on] = options[:on] | trackable.fields.keys.map(&:to_sym) - reserved_fields.map(&:to_sym)
         end
 
+        if options[:on].include?(:embedded_relations)
+          @options[:on] = options[:on].reject { |opt| opt == :embedded_relations }
+          @options[:on] = options[:on] | trackable.embedded_relations.keys
+        end
+
         @options[:fields] = []
         @options[:dynamic] = []
         @options[:relations] = { embeds_one: {}, embeds_many: {} }

data/lib/mongoid/history/trackable.rb

@@ -241,7 +241,7 @@ module Mongoid
         end
 
         def track_destroy
-          track_history_for_action(:destroy)
+          track_history_for_action(:destroy) unless destroyed?
         end
 
         def clear_trackable_memoization
@@ -387,6 +387,10 @@ module Mongoid
             !embedded_relations.map { |_, v| v.key }.include?(database_field_name(field))
         end
 
+        def field_format(field)
+          field_formats[database_field_name(field)]
+        end
+
         # Retrieves the list of tracked fields for a given action.
         #
         # @param [ String | Symbol ] action The action name (:create, :update, or :destroy)
@@ -413,6 +417,10 @@ module Mongoid
           @reserved_tracked_fields ||= ['_id', history_trackable_options[:version_field].to_s, "#{history_trackable_options[:modifier_field]}_id"]
         end
 
+        def field_formats
+          @field_formats ||= history_trackable_options[:format]
+        end
+
         # Whether or not the relation should be tracked.
         #
         # @param [ String | Symbol ] relation The name of the relation
@@ -485,6 +493,7 @@ module Mongoid
           @tracked_fields = nil
           @tracked_embeds_one = nil
           @tracked_embeds_many = nil
+          @obfuscated_fields = nil
         end
       end
     end

data/lib/mongoid/history/version.rb

@@ -1,5 +1,5 @@
 module Mongoid
   module History
-    VERSION = '0.6.0'
+    VERSION = '0.6.1'
   end
 end

data/mongoid-history.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.summary     = 'Track and audit, undo and redo changes on Mongoid documents.'
   s.description = 'This library tracks historical changes for any document, including embedded ones. It achieves this by storing all history tracks in a single collection that you define. 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. Mongoid-history 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', 'dblock@dblock.org']
-  s.homepage    = 'http://github.com/aq1018/mongoid-history'
+  s.homepage    = 'http://github.com/mongoid/mongoid-history'
   s.license     = 'MIT'
 
   s.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)

data/spec/integration/integration_spec.rb

@@ -136,6 +136,13 @@ describe Mongoid::History do
         post.destroy
         expect(post.history_tracks.last.affected['title']).to eq('Test')
       end
+
+      it 'should no-op on repeated calls to destroy' do
+        post.destroy
+        expect do
+          post.destroy
+        end.not_to change(Tracker, :count)
+      end
     end
 
     describe 'on update non-embedded' do

data/spec/unit/attributes/base_spec.rb

@@ -13,6 +13,18 @@ describe Mongoid::History::Attributes::Base do
     end
   end
 
+  before :all do
+    class ModelTwo
+      include Mongoid::Document
+      field :foo
+      field :goo
+    end
+  end
+
+  after :all do
+    Object.send(:remove_const, :ModelTwo)
+  end
+
   let(:obj_one) { model_one.new }
   let(:base) { described_class.new(obj_one) }
   subject { base }
@@ -51,4 +63,88 @@ describe Mongoid::History::Attributes::Base do
     subject { base.send(:changes) }
     it { is_expected.to eq('foo' => ['Foo', 'Foo-new']) }
   end
+
+  describe '#format_field' do
+    before(:each) do
+      model_one.instance_variable_set(:@history_trackable_options, nil)
+    end
+
+    subject { base.send(:format_field, :bar, 'foo') }
+
+    context 'when formatted via string' do
+      before do
+        model_one.track_history format: { bar: '*%s*' }
+      end
+
+      it { is_expected.to eq '*foo*' }
+    end
+
+    context 'when formatted via proc' do
+      before do
+        model_one.track_history format: { bar: ->(v) { v * 2 } }
+      end
+
+      it { is_expected.to eq 'foofoo' }
+    end
+
+    context 'when not formatted' do
+      before do
+        model_one.track_history
+      end
+
+      it { is_expected.to eq 'foo' }
+    end
+  end
+
+  shared_examples 'formats embedded relation' do |relation_type|
+    let(:model_two) { ModelTwo.new(foo: :bar, goo: :baz) }
+
+    before :each do
+      model_one.instance_variable_set(:@history_trackable_options, nil)
+      model_one.send(relation_type, :model_two)
+    end
+
+    subject { base.send("format_#{relation_type}_relation", :model_two, model_two.attributes) }
+
+    context 'with permitted attributes' do
+      before do
+        model_one.track_history on: { model_two: %i(foo) }
+      end
+
+      it 'should select only permitted attributes' do
+        is_expected.to include('foo' => :bar)
+        is_expected.to_not include('goo')
+      end
+    end
+
+    context 'with attributes formatted via string' do
+      before do
+        model_one.track_history on: { model_two: %i(foo) }, format: { model_two: { foo: '&%s&' } }
+      end
+
+      it 'should select obfuscate permitted attributes' do
+        is_expected.to include('foo' => '&bar&')
+        is_expected.to_not include('goo')
+      end
+    end
+
+    context 'with attributes formatted via proc' do
+      before do
+        model_one.track_history on: { model_two: %i(foo) }, format: { model_two: { foo: ->(v) { v.to_s * 2 } } }
+      end
+
+      it 'should select obfuscate permitted attributes' do
+        is_expected.to include('foo' => 'barbar')
+        is_expected.to_not include('goo')
+      end
+    end
+  end
+
+  describe '#format_embeds_one_relation' do
+    include_examples 'formats embedded relation', :embeds_one
+  end
+
+  describe '#format_embeds_many_relation' do
+    include_examples 'formats embedded relation', :embeds_many
+  end
 end

data/spec/unit/options_spec.rb

@@ -69,7 +69,8 @@ describe Mongoid::History::Options do
           scope: :model_one,
           track_create: false,
           track_update: true,
-          track_destroy: false }
+          track_destroy: false,
+          format: nil }
       end
       it { expect(service.send(:default_options)).to eq expected_options }
     end
@@ -104,6 +105,26 @@ describe Mongoid::History::Options do
       end
     end
 
+    describe '#prepare_formatted_fields' do
+      let(:options) { { format: value } }
+      subject { service.parse(options) }
+
+      context 'with non-hash' do
+        let(:value) { :foo }
+        it { expect(subject[:format]).to eq({}) }
+      end
+
+      context 'with a field format' do
+        let(:value) { { foo: '&&&' } }
+        it { expect(subject[:format]).to include 'foo' => '&&&' }
+      end
+
+      context 'with nested format' do
+        let(:value) { { emb_one: { f_em_foo: '***' } } }
+        it { expect(subject[:format]).to include 'emb_one' => { 'f_em_foo' => '***' } }
+      end
+    end
+
     describe '#parse_tracked_fields_and_relations' do
       context 'when options not passed' do
         let(:expected_options) do
@@ -119,7 +140,8 @@ describe Mongoid::History::Options do
             track_destroy: false,
             fields: %w(foo b),
             dynamic: [],
-            relations: { embeds_one: {}, embeds_many: {} } }
+            relations: { embeds_one: {}, embeds_many: {} },
+            format: {} }
         end
         it { expect(service.parse).to eq expected_options }
       end
@@ -232,6 +254,16 @@ describe Mongoid::History::Options do
               let(:options) { { on: :my_field } }
               it { expect(subject[:dynamic]).to eq %w(my_field) }
             end
+
+            context 'with relations' do
+              let(:options) { { on: :embedded_relations } }
+              it do
+                expect(subject[:relations]).to eq(embeds_many: { 'emb_threes' => %w(_id f_em_foo fmb),
+                                                                 'emfs'       => %w(_id f_em_baz) },
+                                                  embeds_one: { 'emb_one'    => %w(_id f_em_foo fmb),
+                                                                'emtw'       => %w(_id f_em_baz) })
+              end
+            end
           end
         end
 

data/spec/unit/trackable_spec.rb

@@ -46,7 +46,8 @@ describe Mongoid::History::Trackable do
         track_destroy: false,
         fields: %w(foo),
         relations: { embeds_one: {}, embeds_many: {} },
-        dynamic: [] }
+        dynamic: [],
+        format: {} }
     end
     let(:regular_fields) { ['foo'] }
     let(:reserved_fields) { %w(_id version modifier_id) }
@@ -151,6 +152,38 @@ describe Mongoid::History::Trackable do
       end
     end
 
+    describe '#field_format' do
+      before :all do
+        ModelOne = Class.new do
+          include Mongoid::Document
+          include Mongoid::History::Trackable
+          field :foo
+        end
+      end
+
+      let(:format) { '***' }
+
+      before do
+        ModelOne.track_history format: { foo: format }
+      end
+
+      context 'when field is formatted' do
+        it 'should return the format' do
+          expect(ModelOne.field_format(:foo)).to be format
+        end
+      end
+
+      context 'when field is not formatted' do
+        it 'should return nil' do
+          expect(ModelOne.field_format(:bar)).to be_nil
+        end
+      end
+
+      after :all do
+        Object.send(:remove_const, :ModelOne)
+      end
+    end
+
     context 'sub-model' do
       before :each do
         class MySubModel < MyModel

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongoid-history
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Aaron Qian
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-13 00:00:00.000000000 Z
+date: 2017-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: easy_diff
@@ -132,7 +132,7 @@ files:
 - spec/unit/store/request_store_spec.rb
 - spec/unit/trackable_spec.rb
 - spec/unit/tracker_spec.rb
-homepage: http://github.com/aq1018/mongoid-history
+homepage: http://github.com/mongoid/mongoid-history
 licenses:
 - MIT
 metadata: {}