mongoid-history 0.6.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d92239564a7df075b3a55eb68c9f7f22666e24ef
-  data.tar.gz: 13f5bb15f7102d5b0957b569cb880af4249a0c75
+  metadata.gz: d77abcedc5d3a8dd4dc76cc8d6320fbce3aaa1da
+  data.tar.gz: 7ea0951e39d1ce44841a92dacd55d576c6542612
 SHA512:
-  metadata.gz: e9b09271720419ebbd843f78954d182430e4a3e5f020cc6b835993154c08fa55e6c8627beaef64f8813632ce15118186057d39771ddb863cf40f28a68c6ce7d3
-  data.tar.gz: 8d337e3008f6468a42b01c0babafa649685237f686e255bd620d380bf8d91bf77d56888445ca20b043ee6f2e7398d4821709fb877bafe11765948fc38ee6ddad
+  metadata.gz: 332314784de0fa89013bab41d9586eeae0e72ee743ce964561d384df270a255970fe23abbc6081f7b0a592085bba8d7cf4f056a3bf24e4deff0099a23628d2b2
+  data.tar.gz: '0228bacf2516b4da7bd57db5171d3e92bc4b418c0df3fcc49fc366d783ed3bf789b2487abb9c32036996fb8ad975dd4adcfad1edeecfff72671bb3da5384b200'

data/.rubocop_todo.yml

@@ -1,92 +1,101 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2015-09-17 17:43:47 -0400 using RuboCop version 0.34.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
 # versions of RuboCop, may require this file to be generated again.
 
+# Offense count: 6
+# Configuration parameters: Include.
+# Include: **/Gemfile, **/gems.rb
+Bundler/DuplicatedGem:
+  Exclude:
+    - 'Gemfile'
+
 # Offense count: 3
 Lint/HandleExceptions:
   Exclude:
     - 'spec/unit/trackable_spec.rb'
 
-Metrics/ClassLength:
-  Max: 103
+# Offense count: 2
+Lint/ParenthesesAsGroupedExpression:
+  Exclude:
+    - 'spec/integration/integration_spec.rb'
 
-# Offense count: 12
+# Offense count: 21
 Metrics/AbcSize:
-  Max: 60
+  Max: 50
+
+# Offense count: 111
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/BlockLength:
+  Max: 807
 
-# Offense count: 4
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 126
+
+# Offense count: 5
 Metrics/CyclomaticComplexity:
   Max: 10
 
-# Offense count: 199
-# Configuration parameters: AllowURI, URISchemes.
+# Offense count: 462
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
 Metrics/LineLength:
   Max: 688
 
-# Offense count: 7
+# Offense count: 15
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
-  Max: 33
+  Max: 23
 
 # Offense count: 2
 # Configuration parameters: CountComments.
 Metrics/ModuleLength:
-  Max: 223
+  Max: 180
 
-# Offense count: 4
+# Offense count: 5
 Metrics/PerceivedComplexity:
   Max: 12
 
-# Offense count: 44
+# Offense count: 12
 Style/Documentation:
   Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
     - 'lib/mongoid/history.rb'
-    - 'lib/mongoid/history/options.rb'
-    - 'lib/mongoid/history/trackable.rb'
-    - 'lib/mongoid/history/tracker.rb'
-    - 'lib/mongoid/history/version.rb'
     - 'lib/mongoid/history/attributes/base.rb'
     - 'lib/mongoid/history/attributes/create.rb'
     - 'lib/mongoid/history/attributes/destroy.rb'
     - 'lib/mongoid/history/attributes/update.rb'
-    - 'spec/integration/embedded_in_polymorphic_spec.rb'
-    - 'spec/integration/integration_spec.rb'
-    - 'spec/integration/multi_relation_spec.rb'
-    - 'spec/integration/nested_embedded_documents_spec.rb'
-    - 'spec/integration/nested_embedded_polymorphic_documents_spec.rb'
-    - 'spec/integration/subclasses_spec.rb'
-    - 'spec/support/mongoid_history.rb'
-    - 'spec/unit/options_spec.rb'
-    - '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'
+    - 'lib/mongoid/history/options.rb'
+    - 'lib/mongoid/history/trackable.rb'
+    - 'lib/mongoid/history/tracker.rb'
 
-# Offense count: 6
+# Offense count: 3
+# Cop supports --auto-correct.
 Style/EachWithObject:
   Exclude:
     - 'lib/mongoid/history/trackable.rb'
     - 'lib/mongoid/history/tracker.rb'
 
-# Offense count: 1
-# Configuration parameters: Exclude.
+# Offense count: 2
+# Configuration parameters: ExpectMatchingDefinition, Regex, IgnoreExecutableScripts, AllowedAcronyms.
+# AllowedAcronyms: CLI, DSL, ACL, API, ASCII, CPU, CSS, DNS, EOF, GUID, HTML, HTTP, HTTPS, ID, IP, JSON, LHS, QPS, RAM, RHS, RPC, SLA, SMTP, SQL, SSH, TCP, TLS, TTL, UDP, UI, UID, UUID, URI, URL, UTF8, VM, XML, XMPP, XSRF, XSS
 Style/FileName:
   Exclude:
+    - 'Dangerfile'
     - 'lib/mongoid-history.rb'
 
-# Offense count: 3
-Style/MultilineBlockChain:
+# Offense count: 1
+Style/IfInsideElse:
   Exclude:
     - 'lib/mongoid/history/trackable.rb'
-    - 'lib/mongoid/history/tracker.rb'
 
-Style/ClassLength:
+# Offense count: 1
+Style/MultilineBlockChain:
   Exclude:
-    - 'lib/mongoid/history/options.rb'
+    - 'lib/mongoid/history/tracker.rb'

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+### 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).
+* [#196](https://github.com/mongoid/mongoid-history/pull/196): Fix bug causing history tracks to get mixed up between multiple trackers when using multiple trackers - [@ojbucao](https://github.com/ojbucao).
+
 ### 0.6.1 (2017/01/04)
 
 * [#182](https://github.com/mongoid/mongoid-history/pull/182): No-op on repeated calls to destroy - [@msaffitz](https://github.com/msaffitz).

data/Gemfile

@@ -18,18 +18,20 @@ when /3/
 else
   gem 'mongoid', version
 end
+gem 'mongoid-compatibility'
 
 group :development, :test do
-  gem 'rake', '< 11.0'
   gem 'bundler'
+  gem 'pry'
+  gem 'rake', '< 11.0'
 end
 
 group :test do
+  gem 'coveralls'
+  gem 'gem-release'
   gem 'mongoid-danger', '~> 0.1.0', require: false
+  gem 'request_store'
   gem 'rspec', '~> 3.1'
-  gem 'rubocop', '0.34.1'
+  gem 'rubocop', '0.48.1'
   gem 'yard'
-  gem 'gem-release'
-  gem 'coveralls'
-  gem 'request_store'
 end

data/README.md

@@ -37,8 +37,8 @@ end
 **Set default tracker class name (Optional)**
 
 Mongoid::History will use the first loaded class to include Mongoid::History::Tracker as the
-default history tracker. If you are using multiple Tracker classes and would like to set
-a global default you may do so in a Rails initializer:
+default history tracker. If you are using multiple Tracker classes, you should set a global
+default in a Rails initializer:
 
 ```ruby
 # config/initializers/mongoid_history.rb
@@ -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
@@ -509,6 +522,57 @@ end
 
 For more examples, check out [spec/integration/integration_spec.rb](spec/integration/integration_spec.rb).
 
+**Multiple Trackers**
+
+You can have different trackers for different classes like so.
+
+```
+class First
+  include Mongoid::Document
+  include Mongoid::History::Trackable
+
+  field :text, type: String
+  track_history on: [:text],
+                tracker_class_name: :first_history_tracker
+end
+
+class Second
+  include Mongoid::Document
+  include Mongoid::History::Trackable
+
+  field :text, type: String
+  track_history on: [:text],
+                tracker_class_name: :second_history_tracker
+end
+
+class FirstHistoryTracker
+  include Mongoid::History::Tracker
+end
+
+class SecondHistoryTracker
+  include Mongoid::History::Tracker
+end
+```
+
+Note that if you are using a tracker for an embedded object that is different
+from the parent's tracker, redos and undos will not work. You have to use the
+same tracker for these to work across embedded relationships.
+
+If you are using multiple trackers and the `tracker_class_name` parameter is
+not specified, Mongoid::History will use the default tracker configured in the
+initializer file or whatever the first tracker was loaded.
+
+
+**Dependent Restrict Associations**
+
+When `dependent: :restrict` is used on an association, a call to `destroy` on
+the model will raise `Mongoid::Errors::DeleteRestriction` when the dependency
+is violated. Just be aware that this gem will create a history track document
+before the `destroy` call and then remove if an error is raised. This applies
+to all persistence calls: create, update and destroy.
+
+See [spec/integration/validation_failure_spec.rb](spec/integration/validation_failure_spec.rb)
+for examples.
 
 **Thread Safety**
 

data/RELEASING.md

@@ -0,0 +1,67 @@
+Releasing Mongoid::History
+========================
+
+There're no particular rules about when to release mongoid-history. Release bug fixes frequently, features not so frequently and breaking API changes rarely.
+
+### Release
+
+Run tests, check that all tests succeed locally.
+
+```
+bundle install
+bundle exec rake
+```
+
+Check that the last build succeeded in [Travis CI](https://travis-ci.org/mongoid/mongoid-history) for all supported platforms.
+
+Increment the version, modify [lib/mongoid/history/version.rb](lib/mongoid/history/version.rb).
+
+*  Increment the third number if the release has bug fixes and/or very minor features, only (eg. change `0.5.1` to `0.5.2`).
+*  Increment the second number if the release contains major features or breaking API changes (eg. change `0.5.1` to `0.4.0`).
+
+Change "Next Release" in [CHANGELOG.md](CHANGELOG.md) to the new version.
+
+```
+### 0.4.0 (2014-01-27)
+```
+
+Remove the line with "Your contribution here.", since there will be no more contributions to this release.
+
+Commit your changes.
+
+```
+git add CHANGELOG.md lib/mongoid/history/version.rb
+git commit -m "Preparing for release, 0.4.0."
+git push origin master
+```
+
+Release.
+
+```
+$ rake release
+
+mongoid-history 0.4.0 built to pkg/mongoid-history-0.4.0.gem.
+Tagged v0.4.0.
+Pushed git commits and tags.
+Pushed mongoid-history 0.4.0 to rubygems.org.
+```
+
+### Prepare for the Next Version
+
+Add the next release to [CHANGELOG.md](CHANGELOG.md).
+
+```
+### 0.4.1 (Next)
+
+* Your contribution here.
+```
+
+Increment the minor version, modify [lib/mongoid/history/version.rb](lib/mongoid/history/version.rb).
+
+Commit your changes.
+
+```
+git add CHANGELOG.md lib/mongoid/history/version.rb
+git commit -m "Preparing for next release, 0.4.1."
+git push origin master
+```

data/Rakefile

@@ -18,7 +18,7 @@ end
 require 'rubocop/rake_task'
 RuboCop::RakeTask.new(:rubocop)
 
-task default: [:rubocop, :spec]
+task default: %i[rubocop spec]
 
 require 'yard'
 YARD::Rake::YardocTask.new

data/UPGRADING.md

@@ -0,0 +1,34 @@
+## 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
+
+When an error is raised in a call to create, update or destroy a tracked model, any history track
+created before the call will now be deleted. In the past this was a problem for associations marked
+`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/create.rb

@@ -40,8 +40,8 @@ module Mongoid
             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| format_embeds_many_relation(rel, obj.attributes) }]
+                                         .reject { |obj| obj.respond_to?(paranoia_field) && obj.public_send(paranoia_field).present? }
+                                         .map { |obj| format_embeds_many_relation(rel, obj.attributes) }]
           end
         end
       end

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

@@ -14,19 +14,19 @@ module Mongoid
 
         def insert_embeds_one_changes
           trackable_class.tracked_embeds_one
-            .map { |rel| aliased_fields.key(rel) || rel }
-            .each do |rel|
-              obj = trackable.send(rel)
-              @attributes[rel] = [format_embeds_one_relation(rel, obj.attributes), nil] if obj
-            end
+                         .map { |rel| aliased_fields.key(rel) || rel }
+                         .each do |rel|
+            obj = trackable.send(rel)
+            @attributes[rel] = [format_embeds_one_relation(rel, obj.attributes), nil] if obj
+          end
         end
 
         def insert_embeds_many_changes
           trackable_class.tracked_embeds_many
-            .map { |rel| aliased_fields.key(rel) || rel }
-            .each do |rel|
-              @attributes[rel] = [trackable.send(rel).map { |obj| format_embeds_many_relation(rel, obj.attributes) }, nil]
-            end
+                         .map { |rel| aliased_fields.key(rel) || rel }
+                         .each do |rel|
+            @attributes[rel] = [trackable.send(rel).map { |obj| format_embeds_many_relation(rel, obj.attributes) }, nil]
+          end
         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] = 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
@@ -24,15 +26,15 @@ module Mongoid
       def default_options
         @default_options ||=
           { on: :all,
-            except: [:created_at, :updated_at],
+            except: %i[created_at updated_at],
             tracker_class_name: nil,
             modifier_field: :modifier,
             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,14 +78,7 @@ 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 }
+        @options[:on] = options[:on].map { |opt| opt == :all ? :fields : opt }
 
         if options[:on].include?(:fields)
           @options[:on] = options[:on].reject { |opt| opt == :fields }
@@ -163,7 +158,7 @@ module Mongoid
         @options[:relations][:embeds_one][field] = if field_options.blank?
                                                      relation_class.fields.keys
                                                    else
-                                                     %w(_id) | field_options.map { |opt| relation_class.database_field_name(opt) }
+                                                     %w[_id] | field_options.map { |opt| relation_class.database_field_name(opt) }
                                                    end
       end
 
@@ -172,7 +167,7 @@ module Mongoid
         @options[:relations][:embeds_many][field] = if field_options.blank?
                                                       relation_class.fields.keys
                                                     else
-                                                      %w(_id) | field_options.map { |opt| relation_class.database_field_name(opt) }
+                                                      %w[_id] | field_options.map { |opt| relation_class.database_field_name(opt) }
                                                     end
       end