mongoid-history 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c2d2105bf114627851d9fca6f7b7117f4766b0d9
-  data.tar.gz: bfc95d7ddcfcdd2b977f799641d63b61d2da3b45
+  metadata.gz: d77abcedc5d3a8dd4dc76cc8d6320fbce3aaa1da
+  data.tar.gz: 7ea0951e39d1ce44841a92dacd55d576c6542612
 SHA512:
-  metadata.gz: b2a0ef3daab0538b8d7a853f3e1c1f40d10a244521fd9811ee6feff55529ae1d58d685126262510bc0311da2bb0184f6c5b1d883accbd02742e665346ab84b93
-  data.tar.gz: d2358b6e8625a06aa1a52a1de2783d15b4a86cfb3b644055912ecae13063cc951c22440f38e9837c43810e780c8f220ff10936e8558fdf57be8ca6b2d4afd38c
+  metadata.gz: 332314784de0fa89013bab41d9586eeae0e72ee743ce964561d384df270a255970fe23abbc6081f7b0a592085bba8d7cf4f056a3bf24e4deff0099a23628d2b2
+  data.tar.gz: '0228bacf2516b4da7bd57db5171d3e92bc4b418c0df3fcc49fc366d783ed3bf789b2487abb9c32036996fb8ad975dd4adcfad1edeecfff72671bb3da5384b200'

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2017-04-09 18:25:15 -0400 using RuboCop version 0.48.1.
+# on 2017-12-08 18:06:04 +0530 using RuboCop version 0.48.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -27,27 +27,27 @@ Lint/ParenthesesAsGroupedExpression:
 Metrics/AbcSize:
   Max: 50
 
-# Offense count: 100
+# Offense count: 111
 # Configuration parameters: CountComments, ExcludedMethods.
 Metrics/BlockLength:
-  Max: 801
+  Max: 807
 
 # Offense count: 1
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
-  Max: 124
+  Max: 126
 
-# Offense count: 4
+# Offense count: 5
 Metrics/CyclomaticComplexity:
   Max: 10
 
-# Offense count: 435
+# Offense count: 462
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
 Metrics/LineLength:
   Max: 688
 
-# Offense count: 13
+# Offense count: 15
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
   Max: 23
@@ -55,9 +55,9 @@ Metrics/MethodLength:
 # Offense count: 2
 # Configuration parameters: CountComments.
 Metrics/ModuleLength:
-  Max: 176
+  Max: 180
 
-# Offense count: 4
+# Offense count: 5
 Metrics/PerceivedComplexity:
   Max: 12
 

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+### 0.8.0 (2018/01/16)
+
+* [#180](https://github.com/mongoid/mongoid-history/pull/180): Removed deprecation notice - [@sivagollapalli](https://github.com/sivagollapalli).
+* [#208](https://github.com/mongoid/mongoid-history/pull/208): Fix: history tracks fields declared after `track_history` - [@mikwat](https://github.com/mikwat).
+* [#210](https://github.com/mongoid/mongoid-history/pull/210): Do not track unmodified embedded relations - [@jagdeepsingh](https://github.com/jagdeepsingh).
+* [#205](https://github.com/mongoid/mongoid-history/pull/205): Allow modifier field to be optional - [@yads](https://github.com/yads).
+* [#211](https://github.com/mongoid/mongoid-history/pull/211): Enable tracking create/destroy by default - [@jagdeepsingh](https://github.com/jagdeepsingh).
+* [#212](https://github.com/mongoid/mongoid-history/pull/212): `track_history` method support for `:if` and `:unless` options - [@jagdeepsingh](https://github.com/jagdeepsingh).
+
 ### 0.7.0 (2017/11/14)
 
 * [#202](https://github.com/mongoid/mongoid-history/pull/202): Do not create tracker on persistence error - [@mikwat](https://github.com/mikwat).

data/Gemfile

@@ -18,6 +18,7 @@ when /3/
 else
   gem 'mongoid', version
 end
+gem 'mongoid-compatibility'
 
 group :development, :test do
   gem 'bundler'

data/README.md

@@ -66,12 +66,13 @@ class Post
   # telling Mongoid::History how you want to track changes
   # dynamic fields will be tracked automatically (for MongoId 4.0+ you should include Mongoid::Attributes::Dynamic to your model)
   track_history   :on => [:title, :body],       # track title and body fields only, default is :all
-                  :modifier_field => :modifier, # adds "belongs_to :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, set to nil to not create modifier_field
                   :modifier_field_inverse_of => :nil, # adds an ":inverse_of" option to the "belongs_to :modifier" relation, default is not set
+                  :modifier_field_optional => true, # marks the modifier relationship as optional (requires Mongoid 6 or higher)
                   :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
+                  :track_create  => true,       # track document creation, default is true
+                  :track_update  => true,       # track document updates, default is true
+                  :track_destroy => true        # track document destruction, default is true
 end
 
 class Comment
@@ -429,6 +430,18 @@ Or perhaps you are namespacing to a module:
 Mongoid::History.modifier_class_name = 'CMS::Author'
 ```
 
+**Conditional :if and :unless options**
+
+The `track_history` method supports `:if` and `:unless` options which will skip generating
+the history tracker unless they are satisfied. These options can take either a method
+`Symbol` or a `Proc`. They behave identical to how `:if` and `:unless` behave in Rails model callbacks.
+
+```ruby
+  track_history on: [:ip],
+                if: :should_i_track_history?,
+                unless: ->(obj){ obj.method_to_skip_history }
+```
+
 **Using an alternate changes method**
 
 Sometimes you may wish to provide an alternate method for determining which changes should be tracked.  For example, if you are using embedded documents

data/RELEASING.md

@@ -51,8 +51,7 @@ Pushed mongoid-history 0.4.0 to rubygems.org.
 Add the next release to [CHANGELOG.md](CHANGELOG.md).
 
 ```
-Next Release
-============
+### 0.4.1 (Next)
 
 * Your contribution here.
 ```

data/UPGRADING.md

@@ -1,3 +1,22 @@
+## Upgrading Mongoid History
+
+### Upgrading to 0.8.0
+
+#### History is now tracked on create and destroy by default
+
+By default, Mongoid History will now track all actions (create, update, and destroy.)
+Previously, only update actions were tracked by default.
+
+To preserve the old behavior, please modify your call to `track_history` as follows:
+
+```ruby
+  track_history ...
+                track_create: false,
+                track_destroy: false
+```
+
+See [#207](https://github.com/mongoid/mongoid-history/pull/207) for more information.
+
 ### Upgrading to 0.7.0
 
 #### Remove history track when create, update or destroy raises an error
@@ -7,3 +26,9 @@ created before the call will now be deleted. In the past this was a problem for
 `dependent: :restrict`.
 
 See [#202](https://github.com/mongoid/mongoid-history/pull/202) for more information.
+
+# Main Changes / Upgrading Notes
+
+See [#189](https://github.com/mongoid/mongoid-history/pull/189) for more information.
+
+* Currently, the `:all` option behaves identically to `:fields`. Future versions will track all fields and relations of trackable class when using `:all`. 

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] = format_field(k, v)
+              @attributes[k] = format_field(k, v) unless v.all?(&:blank?)
             end
           end
           @attributes
@@ -22,20 +22,22 @@ module Mongoid
           relation = trackable_class.database_field_name(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? ? {} : format_embeds_one_relation(relation, value[0])
-          @attributes[relation][1] = value[1][paranoia_field].present? ? {} : format_embeds_one_relation(relation, value[1])
+          original_value = value[0][paranoia_field].present? ? {} : format_embeds_one_relation(relation, value[0])
+          modified_value = value[1][paranoia_field].present? ? {} : format_embeds_one_relation(relation, value[1])
+          return if original_value == modified_value
+          @attributes[relation] = [original_value, modified_value]
         end
 
         def insert_embeds_many_changes(relation, value)
           relation = trackable_class.database_field_name(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| 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) }
+          original_value = value[0].reject { |rel| rel[paranoia_field].present? }
+                                   .map { |v_attrs| format_embeds_many_relation(relation, v_attrs) }
+          modified_value = value[1].reject { |rel| rel[paranoia_field].present? }
+                                   .map { |v_attrs| format_embeds_many_relation(relation, v_attrs) }
+          return if original_value == modified_value
+          @attributes[relation] = [original_value, modified_value]
         end
       end
     end

data/lib/mongoid/history/options.rb

@@ -3,20 +3,22 @@ module Mongoid
     class Options
       attr_reader :trackable, :options
 
-      def initialize(trackable)
+      def initialize(trackable, opts = {})
         @trackable = trackable
+        @options = default_options.merge(opts)
       end
 
       def scope
         trackable.collection_name.to_s.singularize.to_sym
       end
 
-      def parse(options = {})
-        @options = default_options.merge(options)
-        prepare_skipped_fields
-        prepare_formatted_fields
-        parse_tracked_fields_and_relations
-        @options
+      def prepared
+        @prepared ||= begin
+          prepare_skipped_fields
+          prepare_formatted_fields
+          parse_tracked_fields_and_relations
+          options
+        end
       end
 
       private
@@ -30,9 +32,9 @@ module Mongoid
             version_field: :version,
             changes_method: :changes,
             scope: scope,
-            track_create: false,
+            track_create: true,
             track_update: true,
-            track_destroy: false,
+            track_destroy: true,
             format: nil }
       end
 
@@ -76,13 +78,6 @@ module Mongoid
         # when `[:foo, { posts: [:id, :title] }]`, then return as is
         @options[:on] = Array(options[:on])
 
-        # # :all is just an alias to :fields for now, to support existing users of `mongoid-history`
-        # # In future, :all will track all the fields and relations of trackable class
-        if options[:on].include?(:all)
-          warn "[DEPRECATION] Use :fields instead of :all to track all fields in class #{trackable}.\n\
-            Going forward, :all will track all the fields and relations for the class"
-        end
-
         @options[:on] = options[:on].map { |opt| opt == :all ? :fields : opt }
 
         if options[:on].include?(:fields)

data/lib/mongoid/history/trackable.rb

@@ -7,14 +7,16 @@ module Mongoid
         def track_history(options = {})
           extend EmbeddedMethods
 
-          options_parser = Mongoid::History::Options.new(self)
-          options = options_parser.parse(options)
+          history_options = Mongoid::History::Options.new(self, options)
 
-          field options[:version_field].to_sym, type: Integer
+          field history_options.options[:version_field].to_sym, type: Integer
 
-          belongs_to_modifier_options = { class_name: Mongoid::History.modifier_class_name }
-          belongs_to_modifier_options[:inverse_of] = options[:modifier_field_inverse_of] if options.key?(:modifier_field_inverse_of)
-          belongs_to options[:modifier_field].to_sym, belongs_to_modifier_options
+          unless history_options.options[:modifier_field].nil?
+            belongs_to_modifier_options = { class_name: Mongoid::History.modifier_class_name }
+            belongs_to_modifier_options[:inverse_of] = history_options.options[:modifier_field_inverse_of] if history_options.options.key?(:modifier_field_inverse_of)
+            belongs_to_modifier_options[:optional] = true if history_options.options[:modifier_field_optional] && Mongoid::Compatibility::Version.mongoid6_or_newer?
+            belongs_to history_options.options[:modifier_field].to_sym, belongs_to_modifier_options
+          end
 
           include MyInstanceMethods
           extend SingletonMethods
@@ -22,12 +24,13 @@ module Mongoid
           delegate :history_trackable_options, to: 'self.class'
           delegate :track_history?, to: 'self.class'
 
-          around_update :track_update if options[:track_update]
-          around_create :track_create if options[:track_create]
-          around_destroy :track_destroy if options[:track_destroy]
+          callback_options = history_options.options.slice(:if, :unless)
+          around_update :track_update, callback_options if history_options.options[:track_update]
+          around_create :track_create, callback_options if history_options.options[:track_create]
+          around_destroy :track_destroy, callback_options if history_options.options[:track_destroy]
 
           Mongoid::History.trackable_class_options ||= {}
-          Mongoid::History.trackable_class_options[options_parser.scope] = options
+          Mongoid::History.trackable_class_options[history_options.scope] = history_options
         end
 
         def history_settings(options = {})
@@ -219,11 +222,12 @@ module Mongoid
         def history_tracker_attributes(action)
           return @history_tracker_attributes if @history_tracker_attributes
 
+          modifier_field = history_trackable_options[:modifier_field]
           @history_tracker_attributes = {
             association_chain: traverse_association_chain,
-            scope: related_scope,
-            modifier: send(history_trackable_options[:modifier_field])
+            scope: related_scope
           }
+          @history_tracker_attributes[:modifier] = send(modifier_field) if modifier_field
 
           original, modified = transform_changes(modified_attributes_for_action(action))
 
@@ -425,7 +429,12 @@ module Mongoid
         #
         # @return [ Array < String > ] the list of reserved database field names
         def reserved_tracked_fields
-          @reserved_tracked_fields ||= ['_id', history_trackable_options[:version_field].to_s, "#{history_trackable_options[:modifier_field]}_id"]
+          @reserved_tracked_fields ||= begin
+                                         fields = ['_id', history_trackable_options[:version_field].to_s]
+                                         modifier_field = history_trackable_options[:modifier_field]
+                                         fields << "#{modifier_field}_id" if modifier_field
+                                         fields
+                                       end
         end
 
         def field_formats
@@ -494,7 +503,7 @@ module Mongoid
         end
 
         def history_trackable_options
-          @history_trackable_options ||= Mongoid::History.trackable_class_options[trackable_scope]
+          @history_trackable_options ||= Mongoid::History.trackable_class_options[trackable_scope].prepared
         end
 
         def clear_trackable_memoization

data/lib/mongoid/history/tracker.rb

@@ -14,7 +14,11 @@ module Mongoid
         field :version,                 type: Integer
         field :action,                  type: String
         field :scope,                   type: String
-        belongs_to :modifier, class_name: Mongoid::History.modifier_class_name
+        modifier_options = {
+          class_name: Mongoid::History.modifier_class_name
+        }
+        modifier_options[:optional] = true if Mongoid::Compatibility::Version.mongoid6_or_newer?
+        belongs_to :modifier, modifier_options
 
         index(scope: 1)
         index(association_chain: 1)
@@ -50,7 +54,7 @@ module Mongoid
         undo_hash = affected.easy_unmerge(modified)
         undo_hash.easy_merge!(original)
         modifier_field = trackable.history_trackable_options[:modifier_field]
-        undo_hash[modifier_field] = modifier
+        undo_hash[modifier_field] = modifier if modifier_field
         (modified.keys - undo_hash.keys).each do |k|
           undo_hash[k] = nil
         end
@@ -61,7 +65,7 @@ module Mongoid
         redo_hash = affected.easy_unmerge(original)
         redo_hash.easy_merge!(modified)
         modifier_field = trackable.history_trackable_options[:modifier_field]
-        redo_hash[modifier_field] = modifier
+        redo_hash[modifier_field] = modifier if modifier_field
         localize_keys(redo_hash)
       end
 

data/lib/mongoid/history/version.rb

@@ -1,5 +1,5 @@
 module Mongoid
   module History
-    VERSION = '0.7.0'.freeze
+    VERSION = '0.8.0'.freeze
   end
 end

data/mongoid-history.gemspec

@@ -20,6 +20,6 @@ Gem::Specification.new do |s|
 
   s.add_runtime_dependency 'easy_diff'
   s.add_runtime_dependency 'mongoid', '>= 3.0'
-  s.add_runtime_dependency 'mongoid-compatibility'
+  s.add_runtime_dependency 'mongoid-compatibility', '>= 0.5.1'
   s.add_runtime_dependency 'activesupport'
 end

data/spec/integration/integration_spec.rb

@@ -122,6 +122,7 @@ describe Mongoid::History do
 
     describe 'on destruction' do
       it 'should have two history track records in post' do
+        post # This will create history track records for creation
         expect do
           post.destroy
         end.to change(Tracker, :count).by(1)
@@ -147,12 +148,14 @@ describe Mongoid::History do
 
     describe 'on update non-embedded' do
       it 'should create a history track if changed attributes match tracked attributes' do
+        post # This will create history track records for creation
         expect do
           post.update_attributes(title: 'Another Test')
         end.to change(Tracker, :count).by(1)
       end
 
       it 'should not create a history track if changed attributes do not match tracked attributes' do
+        post # This will create history track records for creation
         expect do
           post.update_attributes(rating: 'untracked')
         end.to change(Tracker, :count).by(0)
@@ -188,8 +191,9 @@ describe Mongoid::History do
       end
 
       it 'should assign version on post' do
+        expect(post.version).to eq(1) # Created
         post.update_attributes(title: 'Another Test')
-        expect(post.version).to eq(1)
+        expect(post.version).to eq(2) # Updated
       end
 
       it 'should assign scope' do
@@ -205,16 +209,16 @@ describe Mongoid::History do
       it 'should exclude defined options' do
         name = user.name
         user.update_attributes(name: 'Aaron2', email: 'aaronsnewemail@randomemail.com')
-        expect(user.history_tracks.first.original.keys).to eq(['n'])
-        expect(user.history_tracks.first.original['n']).to eq(name)
-        expect(user.history_tracks.first.modified.keys).to eq(['n'])
-        expect(user.history_tracks.first.modified['n']).to eq(user.name)
+        expect(user.history_tracks.last.original.keys).to eq(['n'])
+        expect(user.history_tracks.last.original['n']).to eq(name)
+        expect(user.history_tracks.last.modified.keys).to eq(['n'])
+        expect(user.history_tracks.last.modified['n']).to eq(user.name)
       end
 
       it 'should undo field changes' do
         name = user.name
         user.update_attributes(name: 'Aaron2', email: 'aaronsnewemail@randomemail.com')
-        user.history_tracks.first.undo! nil
+        user.history_tracks.last.undo! nil
         expect(user.reload.name).to eq(name)
       end
 
@@ -223,21 +227,21 @@ describe Mongoid::History do
         expect(post.reload.title).to be_nil
         post.update_attributes(title: 'Aaron2')
         expect(post.reload.title).to eq('Aaron2')
-        post.history_tracks.first.undo! nil
+        post.history_tracks.last.undo! nil
         expect(post.reload.title).to be_nil
       end
 
       it 'should track array changes' do
         aliases = user.aliases
         user.update_attributes(aliases: %w[bob joe])
-        expect(user.history_tracks.first.original['aliases']).to eq(aliases)
-        expect(user.history_tracks.first.modified['aliases']).to eq(user.aliases)
+        expect(user.history_tracks.last.original['aliases']).to eq(aliases)
+        expect(user.history_tracks.last.modified['aliases']).to eq(user.aliases)
       end
 
       it 'should undo array changes' do
         aliases = user.aliases
         user.update_attributes(aliases: %w[bob joe])
-        user.history_tracks.first.undo! nil
+        user.history_tracks.last.undo! nil
         expect(user.reload.aliases).to eq(aliases)
       end
     end
@@ -259,7 +263,7 @@ describe Mongoid::History do
         end
       end
       context 'update action' do
-        subject { user.history_tracks.first.tracked_changes }
+        subject { user.history_tracks.last.tracked_changes }
         before do
           user.update_attributes(name: 'Aaron2', email: nil, country: '',  city: nil, phone: '867-5309', aliases: ['', 'bill', 'james'])
         end
@@ -305,7 +309,7 @@ describe Mongoid::History do
         end
       end
       context 'update action' do
-        subject { user.history_tracks.first.tracked_edits }
+        subject { user.history_tracks.last.tracked_edits }
         before do
           user.update_attributes(name: 'Aaron2', email: nil, country: '', city: nil, phone: '867-5309', aliases: ['', 'bill', 'james'])
         end
@@ -348,12 +352,14 @@ describe Mongoid::History do
 
     describe 'on update non-embedded twice' do
       it 'should assign version on post' do
+        expect(post.version).to eq(1)
         post.update_attributes(title: 'Test2')
         post.update_attributes(title: 'Test3')
-        expect(post.version).to eq(2)
+        expect(post.version).to eq(3)
       end
 
       it 'should create a history track if changed attributes match tracked attributes' do
+        post # Created
         expect do
           post.update_attributes(title: 'Test2')
           post.update_attributes(title: 'Test3')
@@ -369,7 +375,7 @@ describe Mongoid::History do
       it 'should assign modified fields' do
         post.update_attributes(title: 'Test2')
         post.update_attributes(title: 'Test3')
-        expect(post.history_tracks.where(version: 2).first.modified).to eq(
+        expect(post.history_tracks.where(version: 3).first.modified).to eq(
           'title' => 'Test3'
         )
       end
@@ -377,7 +383,7 @@ describe Mongoid::History do
       it 'should assign original fields' do
         post.update_attributes(title: 'Test2')
         post.update_attributes(title: 'Test3')
-        expect(post.history_tracks.where(version: 2).first.original).to eq(
+        expect(post.history_tracks.where(version: 3).first.original).to eq(
           'title' => 'Test2'
         )
       end
@@ -504,7 +510,7 @@ describe Mongoid::History do
       it 'should be possible to create with redo after undo create embedded from parent' do
         comment # initialize
         post.comments.create!(title: 'The second one')
-        track = post.history_tracks.last
+        track = post.history_tracks[2]
         track.undo!(user)
         track.redo!(user)
         post.reload
@@ -552,14 +558,14 @@ describe Mongoid::History do
     describe 'non-embedded' do
       it 'should undo changes' do
         post.update_attributes(title: 'Test2')
-        post.history_tracks.where(version: 1).last.undo!(user)
+        post.history_tracks.where(version: 2).last.undo!(user)
         post.reload
         expect(post.title).to eq('Test')
       end
 
       it 'should undo destruction' do
         post.destroy
-        post.history_tracks.where(version: 1).last.undo!(user)
+        post.history_tracks.where(version: 2).last.undo!(user)
         expect(Post.find(post.id).title).to eq('Test')
       end
 
@@ -568,12 +574,12 @@ describe Mongoid::History do
         post.update_attributes(title: 'Test2')
         post.history_tracks.last.undo!(user)
         post.reload
-        expect(post.history_tracks.count).to eq(3)
+        expect(post.history_tracks.count).to eq(4)
       end
 
       it 'should assign user as the modifier of the newly created history track' do
         post.update_attributes(title: 'Test2')
-        post.history_tracks.where(version: 1).last.undo!(user)
+        post.history_tracks.where(version: 2).last.undo!(user)
         post.reload
         expect(post.history_tracks.where(version: 2).last.modifier).to eq(user)
       end
@@ -590,7 +596,7 @@ describe Mongoid::History do
 
       it 'should be destroyed after undo and redo' do
         post.destroy
-        track = post.history_tracks.where(version: 1).last
+        track = post.history_tracks.where(version: 2).last
         track.undo!(user)
         track.redo!(user)
         expect(Post.where(_id: post.id).first).to be_nil

data/spec/integration/track_history_order_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe Mongoid::History::Tracker do
+  it 'should not track fields when track_history not called' do
+    class NotModel
+      include Mongoid::Document
+      include Mongoid::History::Trackable
+
+      field :foo
+    end
+
+    expect(NotModel.respond_to?(:tracked?)).to be false
+  end
+
+  it 'should track fields when track_history called inside class and before fields' do
+    class InsideBeforeModel
+      include Mongoid::Document
+      include Mongoid::History::Trackable
+
+      track_history on: :fields
+
+      field :foo
+    end
+
+    expect(InsideBeforeModel.tracked?(:foo)).to be true
+  end
+
+  it 'should track fields when track_history called inside class and after fields' do
+    class InsideAfterModel
+      include Mongoid::Document
+      include Mongoid::History::Trackable
+
+      field :foo
+
+      track_history on: :fields
+    end
+
+    expect(InsideAfterModel.tracked?(:foo)).to be true
+  end
+
+  it 'should track fields when track_history called outside class' do
+    class OutsideModel
+      include Mongoid::Document
+      include Mongoid::History::Trackable
+
+      field :foo
+    end
+
+    OutsideModel.track_history on: :fields
+    expect(OutsideModel.tracked?(:foo)).to be true
+  end
+end

data/spec/unit/attributes/destroy_spec.rb

@@ -28,7 +28,7 @@ describe Mongoid::History::Attributes::Destroy do
         obj_one.save!
       end
       let(:obj_one) { model_one.new(foo: 'Foo', bar: 'Bar') }
-      it { is_expected.to eq('_id' => [obj_one._id, nil], 'foo' => ['Foo', nil]) }
+      it { is_expected.to eq('_id' => [obj_one._id, nil], 'foo' => ['Foo', nil], 'version' => [1, nil]) }
     end
 
     describe '#insert_embeds_one_changes' do

data/spec/unit/attributes/update_spec.rb

@@ -110,6 +110,44 @@ describe Mongoid::History::Attributes::Update do
           Object.send(:remove_const, :EmbOne)
         end
       end
+
+      context 'when original and modified value same' do
+        before(:all) do
+          class DummyUpdateModel
+            include Mongoid::Document
+            include Mongoid::History::Trackable
+            store_in collection: :dummy_update_models
+            embeds_one :dummy_embedded_model
+            track_history on: :fields
+          end
+
+          class DummyEmbeddedModel
+            include Mongoid::Document
+            field :em_foo
+            field :em_bar
+            embedded_in :dummy_update_model
+          end
+        end
+
+        before(:each) do
+          DummyUpdateModel.clear_trackable_memoization
+          allow(base).to receive(:changes) { changes }
+          DummyUpdateModel.track_history on: :dummy_embedded_model
+        end
+
+        let(:obj_one) { DummyUpdateModel.new }
+        let(:base) { described_class.new(obj_one) }
+        let(:changes) do
+          { 'dummy_embedded_model' => [{ 'em_foo' => 'Em-Foo', 'em_bar' => 'Em-Bar' }, { 'em_foo' => 'Em-Foo', 'em_bar' => 'Em-Bar' }] }
+        end
+        subject { base.attributes }
+        it { expect(subject.keys).to_not include 'dummy_embedded_model' }
+
+        after(:all) do
+          Object.send(:remove_const, :DummyUpdateModel)
+          Object.send(:remove_const, :DummyEmbeddedModel)
+        end
+      end
     end
 
     describe '#insert_embeds_many_changes' do
@@ -199,11 +237,84 @@ describe Mongoid::History::Attributes::Update do
         it 'should save audit history under relation alias' do
           expect(subject['eons']).to eq [[{ 'em_foo' => 'Em-Foo' }], [{ 'em_foo' => 'Em-Foo-new', 'em_bar' => 'Em-Bar-new' }]]
         end
+
+        after(:all) do
+          Object.send(:remove_const, :ModelOne)
+          Object.send(:remove_const, :EmbOne)
+        end
+      end
+
+      context 'when original and modified value same' do
+        before(:all) do
+          class ModelOne
+            include Mongoid::Document
+            include Mongoid::History::Trackable
+            store_in collection: :model_ones
+            embeds_many :emb_ones
+            track_history on: :fields
+          end
+
+          class EmbOne
+            include Mongoid::Document
+            field :em_foo
+            field :em_bar
+            embedded_in :model_one
+          end
+        end
+
+        before(:each) do
+          ModelOne.clear_trackable_memoization
+          allow(base).to receive(:changes) { changes }
+          ModelOne.track_history on: :emb_ones
+        end
+
+        let(:obj_one) { ModelOne.new }
+        let(:base) { described_class.new(obj_one) }
+        let(:changes) do
+          { 'emb_ones' => [[{ 'em_foo' => 'Em-Foo', 'em_bar' => 'Em-Bar' }], [{ 'em_foo' => 'Em-Foo', 'em_bar' => 'Em-Bar' }]] }
+        end
+        subject { base.attributes }
+        it { expect(subject.keys).to_not include 'emb_ones' }
+
+        after(:all) do
+          Object.send(:remove_const, :ModelOne)
+          Object.send(:remove_const, :EmbOne)
+        end
+      end
+    end
+
+    context 'when original and modified values blank' do
+      before(:all) do
+        class DummyParent
+          include Mongoid::Document
+          include Mongoid::History::Trackable
+          store_in collection: :dummy_parents
+          has_and_belongs_to_many :other_dummy_parents
+          track_history on: :fields
+        end
+
+        class OtherDummyParent
+          include Mongoid::Document
+          has_and_belongs_to_many :dummy_parents
+        end
+      end
+
+      before(:each) do
+        DummyParent.clear_trackable_memoization
+        allow(base).to receive(:changes) { changes }
+        DummyParent.track_history on: :other_dummy_parent_ids
+      end
+
+      let(:base) { described_class.new(DummyParent.new) }
+      let(:changes) do
+        { 'other_dummy_parent_ids' => [nil, []] }
       end
+      subject { base.attributes }
+      it { expect(subject.keys).to_not include 'other_dummy_parent_ids' }
 
       after(:all) do
-        Object.send(:remove_const, :ModelOne)
-        Object.send(:remove_const, :EmbOne)
+        Object.send(:remove_const, :DummyParent)
+        Object.send(:remove_const, :OtherDummyParent)
       end
     end
   end

data/spec/unit/callback_options_spec.rb

@@ -0,0 +1,159 @@
+require 'spec_helper'
+
+describe Mongoid::History::Options do
+  describe ':if' do
+    let(:dummy_model) do
+      Class.new do
+        include Mongoid::Document
+        include Mongoid::History::Trackable
+        store_in collection: :model_ones
+        field :foo
+        attr_accessor :bar
+        track_history track_create: true,
+                      track_update: true,
+                      track_destroy: true,
+                      if: :bar
+        def self.name
+          'DummyModel'
+        end
+      end
+    end
+    let(:obj) { dummy_model.new(foo: 'Foo') }
+
+    context 'when condition evaluates to true' do
+      before { obj.bar = true }
+      it 'should create history tracks' do
+        expect { obj.save }.to change(Tracker, :count).by(1)
+        expect do
+          obj.update_attributes(foo: 'Foo-2')
+        end.to change(Tracker, :count).by(1)
+        expect { obj.destroy }.to change(Tracker, :count).by(1)
+      end
+    end
+
+    context 'when condition evaluates to false' do
+      before { obj.bar = false }
+      it 'should not create history tracks' do
+        expect { obj.save }.to_not change(Tracker, :count)
+        expect do
+          obj.update_attributes(foo: 'Foo-2')
+        end.to_not change(Tracker, :count)
+        expect { obj.destroy }.to_not change(Tracker, :count)
+      end
+    end
+  end
+
+  describe ':unless' do
+    let(:dummy_model) do
+      Class.new do
+        include Mongoid::Document
+        include Mongoid::History::Trackable
+        store_in collection: :model_ones
+        field :foo
+        attr_accessor :bar
+        track_history track_create: true,
+                      track_update: true,
+                      track_destroy: true,
+                      unless: ->(obj) { obj.bar }
+        def self.name
+          'DummyModel'
+        end
+      end
+    end
+    let(:obj) { dummy_model.new(foo: 'Foo') }
+
+    context 'when condition evaluates to true' do
+      before { obj.bar = true }
+      it 'should not create history tracks' do
+        expect { obj.save }.to_not change(Tracker, :count)
+        expect do
+          obj.update_attributes(foo: 'Foo-2')
+        end.to_not change(Tracker, :count)
+        expect { obj.destroy }.to_not change(Tracker, :count)
+      end
+    end
+
+    context 'when condition evaluates to false' do
+      before { obj.bar = false }
+      it 'should create history tracks' do
+        expect { obj.save }.to change(Tracker, :count).by(1)
+        expect do
+          obj.update_attributes(foo: 'Foo-2')
+        end.to change(Tracker, :count).by(1)
+        expect { obj.destroy }.to change(Tracker, :count).by(1)
+      end
+    end
+  end
+
+  describe ':if and :unless' do
+    let(:dummy_model) do
+      Class.new do
+        include Mongoid::Document
+        include Mongoid::History::Trackable
+        store_in collection: :model_ones
+        field :foo
+        attr_accessor :bar, :baz
+        track_history track_create: true,
+                      track_update: true,
+                      track_destroy: true,
+                      if: :bar, unless: ->(obj) { obj.baz }
+        def self.name
+          'DummyModel'
+        end
+      end
+    end
+    let(:obj) { dummy_model.new(foo: 'Foo') }
+
+    context 'when :if condition evaluates to true' do
+      before { obj.bar = true }
+
+      context 'and :unless condition evaluates to true' do
+        before { obj.baz = true }
+        it 'should not create history tracks' do
+          expect { obj.save }.to_not change(Tracker, :count)
+          expect do
+            obj.update_attributes(foo: 'Foo-2')
+          end.to_not change(Tracker, :count)
+          expect { obj.destroy }.to_not change(Tracker, :count)
+        end
+      end
+
+      context 'and :unless condition evaluates to false' do
+        before { obj.baz = false }
+        it 'should create history tracks' do
+          expect { obj.save }.to change(Tracker, :count).by(1)
+          expect do
+            obj.update_attributes(foo: 'Foo-2')
+          end.to change(Tracker, :count).by(1)
+          expect { obj.destroy }.to change(Tracker, :count).by(1)
+        end
+      end
+    end
+
+    context 'when :if condition evaluates to false' do
+      before { obj.bar = false }
+
+      context 'and :unless condition evaluates to true' do
+        before { obj.baz = true }
+        it 'should not create history tracks' do
+          expect { obj.save }.to_not change(Tracker, :count)
+          expect do
+            obj.update_attributes(foo: 'Foo-2')
+          end.to_not change(Tracker, :count)
+          expect { obj.destroy }.to_not change(Tracker, :count)
+        end
+      end
+
+      context 'and :unless condition evaluates to false' do
+        before { obj.baz = false }
+        it 'should not create history tracks' do
+          expect { obj.save }.to_not change(Tracker, :count)
+          expect do
+            obj.update_attributes(foo: 'Foo-2')
+          end.to_not change(Tracker, :count)
+          expect { obj.destroy }.to_not change(Tracker, :count)
+        end
+      end
+    end
+  end
+end

data/spec/unit/options_spec.rb

@@ -42,7 +42,8 @@ describe Mongoid::History::Options do
     end
   end
 
-  let(:service) { described_class.new(ModelOne) }
+  let(:options) { {} }
+  let(:service) { described_class.new(ModelOne, options) }
 
   subject { service }
 
@@ -67,9 +68,9 @@ describe Mongoid::History::Options do
           version_field: :version,
           changes_method: :changes,
           scope: :model_one,
-          track_create: false,
+          track_create: true,
           track_update: true,
-          track_destroy: false,
+          track_destroy: true,
           format: nil }
       end
       it { expect(service.send(:default_options)).to eq expected_options }
@@ -77,7 +78,7 @@ describe Mongoid::History::Options do
 
     describe '#prepare_skipped_fields' do
       let(:options) { { except: value } }
-      subject { service.parse(options) }
+      subject { service.prepared }
 
       context 'with field' do
         let(:value) { :foo }
@@ -107,7 +108,7 @@ describe Mongoid::History::Options do
 
     describe '#prepare_formatted_fields' do
       let(:options) { { format: value } }
-      subject { service.parse(options) }
+      subject { service.prepared }
 
       context 'with non-hash' do
         let(:value) { :foo }
@@ -135,19 +136,19 @@ describe Mongoid::History::Options do
             version_field: :version,
             changes_method: :changes,
             scope: :model_one,
-            track_create: false,
+            track_create: true,
             track_update: true,
-            track_destroy: false,
+            track_destroy: true,
             fields: %w[foo b],
             dynamic: [],
             relations: { embeds_one: {}, embeds_many: {} },
             format: {} }
         end
-        it { expect(service.parse).to eq expected_options }
+        it { expect(service.prepared).to eq expected_options }
       end
 
       context 'when options passed' do
-        subject { service.parse(options) }
+        subject { service.prepared }
 
         describe '@options' do
           let(:options) { { on: value } }

data/spec/unit/trackable_spec.rb

@@ -28,9 +28,16 @@ describe Mongoid::History::Trackable do
   end
 
   describe '#track_history' do
+    class MyModelWithNoModifier
+      include Mongoid::Document
+      include Mongoid::History::Trackable
+      field :foo
+    end
+
     before :all do
       MyModel.track_history
       @persisted_history_options = Mongoid::History.trackable_class_options
+      MyModelWithNoModifier.track_history modifier_field: nil
     end
     before(:each) { Mongoid::History.trackable_class_options = @persisted_history_options }
     let(:expected_option) do
@@ -41,9 +48,9 @@ describe Mongoid::History::Trackable do
         version_field: :version,
         changes_method: :changes,
         scope: :my_model,
-        track_create: false,
+        track_create: true,
         track_update: true,
-        track_destroy: false,
+        track_destroy: true,
         fields: %w[foo],
         relations: { embeds_one: {}, embeds_many: {} },
         dynamic: [],
@@ -53,7 +60,7 @@ describe Mongoid::History::Trackable do
     let(:reserved_fields) { %w[_id version modifier_id] }
 
     it 'should have default options' do
-      expect(Mongoid::History.trackable_class_options[:my_model]).to eq(expected_option)
+      expect(Mongoid::History.trackable_class_options[:my_model].prepared).to eq(expected_option)
     end
 
     it 'should define callback function #track_update' do
@@ -72,6 +79,31 @@ describe Mongoid::History::Trackable do
       expect(MyModel.history_trackable_options).to eq(expected_option)
     end
 
+    describe '#modifier' do
+      context 'modifier_field set to nil' do
+        it 'should not have a modifier relationship' do
+          expect(MyModelWithNoModifier.reflect_on_association(:modifier)).to be_nil
+        end
+      end
+
+      context 'modifier_field_optional true' do
+        class MyModelWithOptionalModifier
+          include Mongoid::Document
+          include Mongoid::History::Trackable
+          field :foo
+        end
+
+        it 'marks modifier relationship optional' do
+          MyModelWithOptionalModifier.track_history modifier_field_optional: true
+          if Mongoid::Compatibility::Version.mongoid6_or_newer?
+            expect(MyModelWithOptionalModifier.reflect_on_association(:modifier)[:optional]).to be true
+          else
+            expect(MyModelWithOptionalModifier.reflect_on_association(:modifier)).not_to be_nil
+          end
+        end
+      end
+    end
+
     describe '#tracked_fields' do
       it 'should return the tracked field list' do
         expect(MyModel.tracked_fields).to eq(regular_fields)
@@ -82,6 +114,10 @@ describe Mongoid::History::Trackable do
       it 'should return the protected field list' do
         expect(MyModel.reserved_tracked_fields).to eq(reserved_fields)
       end
+
+      it 'should not include modifier_field if not specified' do
+        expect(MyModelWithNoModifier.reserved_tracked_fields).not_to include('modifier')
+      end
     end
 
     describe '#tracked_fields_for_action' do
@@ -191,7 +227,7 @@ describe Mongoid::History::Trackable do
       end
 
       it 'should have default options' do
-        expect(Mongoid::History.trackable_class_options[:my_model]).to eq(expected_option)
+        expect(Mongoid::History.trackable_class_options[:my_model].prepared).to eq(expected_option)
       end
 
       it 'should define #history_trackable_options' do
@@ -559,6 +595,7 @@ describe Mongoid::History::Trackable do
       describe 'fields' do
         context 'when custom method for changes' do
           before(:each) do
+            ModelOne.clear_trackable_memoization
             ModelOne.track_history(on: :foo, changes_method: :my_changes_method)
             allow(ModelOne).to receive(:dynamic_enabled?) { false }
             allow(model_one).to receive(:my_changes_method) { changes }
@@ -590,7 +627,7 @@ describe Mongoid::History::Trackable do
       @persisted_history_options = Mongoid::History.trackable_class_options
     end
     before(:each) { Mongoid::History.trackable_class_options = @persisted_history_options }
-    let(:m) { MyModel.create!(foo: 'bar') }
+    let!(:m) { MyModel.create!(foo: 'bar') }
 
     it 'should create history' do
       expect { m.update_attributes!(foo: 'bar2') }.to change(Tracker, :count).by(1)
@@ -610,7 +647,7 @@ describe Mongoid::History::Trackable do
       @persisted_history_options = Mongoid::History.trackable_class_options
     end
     before(:each) { Mongoid::History.trackable_class_options = @persisted_history_options }
-    let(:m) { MyModel.create!(foo: 'bar') }
+    let!(:m) { MyModel.create!(foo: 'bar') }
 
     it 'should create history' do
       expect { m.destroy }.to change(Tracker, :count).by(1)
@@ -628,6 +665,7 @@ describe Mongoid::History::Trackable do
     before :all do
       MyModel.track_history(on: :foo, track_create: true)
       @persisted_history_options = Mongoid::History.trackable_class_options
+      MyModelWithNoModifier.track_history modifier_field: nil
     end
     before(:each) { Mongoid::History.trackable_class_options = @persisted_history_options }
 
@@ -635,6 +673,12 @@ describe Mongoid::History::Trackable do
       expect { MyModel.create!(foo: 'bar') }.to change(Tracker, :count).by(1)
     end
 
+    context 'no modifier_field' do
+      it 'should create history' do
+        expect { MyModelWithNoModifier.create!(foo: 'bar').to change(Tracker, :count).by(1) }
+      end
+    end
+
     it 'should not create history when error raised' do
       expect(MyModel).to receive(:create!).and_raise(StandardError)
       expect do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongoid-history
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Aaron Qian
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-14 00:00:00.000000000 Z
+date: 2018-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: easy_diff
@@ -46,14 +46,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.5.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.5.1
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -119,6 +119,7 @@ files:
 - spec/integration/nested_embedded_documents_spec.rb
 - spec/integration/nested_embedded_polymorphic_documents_spec.rb
 - spec/integration/subclasses_spec.rb
+- spec/integration/track_history_order_spec.rb
 - spec/integration/validation_failure_spec.rb
 - spec/spec_helper.rb
 - spec/support/mongoid.rb
@@ -127,6 +128,7 @@ files:
 - spec/unit/attributes/create_spec.rb
 - spec/unit/attributes/destroy_spec.rb
 - spec/unit/attributes/update_spec.rb
+- spec/unit/callback_options_spec.rb
 - spec/unit/embedded_methods_spec.rb
 - spec/unit/history_spec.rb
 - spec/unit/my_instance_methods_spec.rb
@@ -156,7 +158,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Track and audit, undo and redo changes on Mongoid documents.
@@ -168,6 +170,7 @@ test_files:
 - spec/integration/nested_embedded_documents_spec.rb
 - spec/integration/nested_embedded_polymorphic_documents_spec.rb
 - spec/integration/subclasses_spec.rb
+- spec/integration/track_history_order_spec.rb
 - spec/integration/validation_failure_spec.rb
 - spec/spec_helper.rb
 - spec/support/mongoid.rb
@@ -176,6 +179,7 @@ test_files:
 - spec/unit/attributes/create_spec.rb
 - spec/unit/attributes/destroy_spec.rb
 - spec/unit/attributes/update_spec.rb
+- spec/unit/callback_options_spec.rb
 - spec/unit/embedded_methods_spec.rb
 - spec/unit/history_spec.rb
 - spec/unit/my_instance_methods_spec.rb