mongoid-history 0.6.1 → 0.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d92239564a7df075b3a55eb68c9f7f22666e24ef
-  data.tar.gz: 13f5bb15f7102d5b0957b569cb880af4249a0c75
+SHA256:
+  metadata.gz: 7f7558f1c6033e5350cdeb3732e385d483c7abfa71ffc7f89acfbba22befff97
+  data.tar.gz: 71c5f5ab67e1bd040e14b040211b1acc5532449f048919c83adcb4e875f7eac4
 SHA512:
-  metadata.gz: e9b09271720419ebbd843f78954d182430e4a3e5f020cc6b835993154c08fa55e6c8627beaef64f8813632ce15118186057d39771ddb863cf40f28a68c6ce7d3
-  data.tar.gz: 8d337e3008f6468a42b01c0babafa649685237f686e255bd620d380bf8d91bf77d56888445ca20b043ee6f2e7398d4821709fb877bafe11765948fc38ee6ddad
+  metadata.gz: f528411205ca81444296803927b54c1bd1ef570611b2b4a9bb79f6e4165fb038c5b13ad5fb79c8adde96c62eaefa1142bf5f4c6b5f44d72a80743f38a0aa5d48
+  data.tar.gz: 4149122d3f6c474f5f0105772fa64a9fe237d299005e97ad021e887f42687d1a81ede778c589070231319704b9c71e2f99a5e660d04c2581a078178e965b0425

data/.rubocop_todo.yml

@@ -1,92 +1,99 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2015-09-17 17:43:47 -0400 using RuboCop version 0.34.1.
+# on 2020-04-10 17:25:32 -0500 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: 7
+# 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: 3
+Lint/ParenthesesAsGroupedExpression:
+  Exclude:
+    - 'spec/integration/integration_spec.rb'
+    - 'spec/integration/nested_embedded_polymorphic_documents_spec.rb'
 
-# Offense count: 12
+# Offense count: 22
 Metrics/AbcSize:
-  Max: 60
+  Max: 52
+
+# Offense count: 122
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/BlockLength:
+  Max: 837
 
-# Offense count: 4
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 120
+
+# Offense count: 6
 Metrics/CyclomaticComplexity:
-  Max: 10
+  Max: 13
 
-# Offense count: 199
-# Configuration parameters: AllowURI, URISchemes.
+# Offense count: 412
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
 Metrics/LineLength:
   Max: 688
 
-# Offense count: 7
+# Offense count: 17
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
-  Max: 33
+  Max: 23
 
 # Offense count: 2
 # Configuration parameters: CountComments.
 Metrics/ModuleLength:
-  Max: 223
+  Max: 191
 
-# Offense count: 4
+# Offense count: 6
 Metrics/PerceivedComplexity:
-  Max: 12
+  Max: 15
 
-# Offense count: 44
+# Offense count: 15
 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'
+    - 'perf/benchmark_modified_attributes_for_create.rb'
+    - 'perf/gc_suite.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
+# Offense count: 1
 Style/MultilineBlockChain:
   Exclude:
-    - 'lib/mongoid/history/trackable.rb'
     - 'lib/mongoid/history/tracker.rb'
-
-Style/ClassLength:
-  Exclude:
-    - 'lib/mongoid/history/options.rb'

data/.travis.yml

@@ -12,10 +12,11 @@ env:
   - MONGOID_VERSION=4
   - MONGOID_VERSION=5
   - MONGOID_VERSION=6
+  - MONGOID_VERSION=7
   - MONGOID_VERSION=HEAD
 
 rvm:
-  - 2.3.1
+  - 2.3
 
 before_install:
   - gem update bundler

data/CHANGELOG.md

@@ -1,3 +1,36 @@
+### 0.8.3 (2020/05/17)
+
+* [#236](https://github.com/mongoid/mongoid-history/pull/236): Fix Ruby 2.7 keyword argument warnings - [@vasilysn](https://github.com/vasilysn).
+* [#237](https://github.com/mongoid/mongoid-history/pull/237): Fix tracking subclasses with additional fields - [@getaroom](https://github.com/getaroom).
+* [#239](https://github.com/mongoid/mongoid-history/pull/239): Optimize `modified_attributes_for_create` 6-7x - [@getaroom](https://github.com/getaroom).
+* [#240](https://github.com/mongoid/mongoid-history/pull/240): `Mongoid::History.disable` and `disable_tracking` now restore the original state - [@getaroom](https://github.com/getaroom).
+* [#240](https://github.com/mongoid/mongoid-history/pull/240): Added `Mongoid::History.enable`, `Mongoid::History.enable!`, `Mongoid::History.disable!`, `enable_tracking`, `enable_tracking!`, and `disable_tracking!` - [@getaroom](https://github.com/getaroom).
+
+### 0.8.2 (2019/12/02)
+
+* [#233](https://github.com/mongoid/mongoid-history/pull/233): Bug fix-Track ALL embedded relations when used with fields and filtered attributes on embedded objects - [@jagdeepsingh](https://github.com/jagdeepsingh).
+* [#232](https://github.com/mongoid/mongoid-history/pull/232): Bug/187 track changes from embedded documents (not deeply nested) - [@Startouf](https://github.com/Startouf).
+* [#227](https://github.com/mongoid/mongoid-history/pull/227): Store options in inheritable class attributes - [@jnfeinstein](https://github.com/jnfeinstein).
+* [#229](https://github.com/mongoid/mongoid-history/pull/229), [#225](https://github.com/mongoid/mongoid-history/pull/225): Fixed inheritance of `history_trackable_options` - [@jnfeinstein](https://github.com/jnfeinstein).
+
+### 0.8.1 (2018/06/28)
+
+* [#221](https://github.com/mongoid/mongoid-history/pull/221): Mongoid 7 support - [@dblock](https://github.com/dblock).
+
+### 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/CONTRIBUTING.md

@@ -1,16 +1,16 @@
 Contributing to Mongoid-History
 ===============================
 
-Mongoid-History is work of [many of contributors](https://github.com/intridea/mongoid-history/graphs/contributors). You're encouraged to submit [pull requests](https://github.com/intridea/mongoid-history/pulls), [propose features, ask questions and discuss issues](https://github.com/intridea/mongoid-history/issues).
+Mongoid-History is work of [many of contributors](https://github.com/mongoid/mongoid-history/graphs/contributors). You're encouraged to submit [pull requests](https://github.com/mongoid/mongoid-history/pulls), [propose features, ask questions and discuss issues](https://github.com/mongoid/mongoid-history/issues).
 
 #### Fork the Project
 
-Fork the [project on Github](https://github.com/intridea/mongoid-history) and check out your copy.
+Fork the [project on Github](https://github.com/mongoid/mongoid-history) and check out your copy.
 
 ```
 git clone https://github.com/contributor/mongoid-history.git
 cd mongoid-history
-git remote add upstream https://github.com/intridea/mongoid-history.git
+git remote add upstream https://github.com/mongoid/mongoid-history.git
 ```
 
 #### Create a Topic Branch
@@ -95,7 +95,7 @@ git push origin my-feature-branch -f
 Update the [CHANGELOG](CHANGELOG.md) with the pull request number. A typical entry looks as follows.
 
 ```
-* [#123](https://github.com/intridea/mongoid-history/pull/123): Reticulated splines - [@contributor](https://github.com/contributor).
+* [#123](https://github.com/mongoid/mongoid-history/pull/123): Reticulated splines - [@contributor](https://github.com/contributor).
 ```
 
 Amend your previous commit and force push the changes.

data/Gemfile

@@ -2,34 +2,39 @@ source 'https://rubygems.org'
 
 gemspec
 
-case version = ENV['MONGOID_VERSION'] || '~> 6.0.0'
+case version = ENV['MONGOID_VERSION'] || '~> 7.0.0'
 when 'HEAD'
   gem 'mongoid', github: 'mongodb/mongoid'
-when /6/
+when /\b7/
+  gem 'mongoid', '~> 7.0.0'
+when /\b6/
   gem 'mongoid', '~> 6.0.0'
-when /5/
+when /\b5/
   gem 'mongoid', '~> 5.0'
   gem 'mongoid-observers', '~> 0.2.0'
-when /4/
+when /\b4/
   gem 'mongoid', '~> 4.0'
   gem 'mongoid-observers', '~> 0.2.0'
-when /3/
-  gem 'mongoid', '~> 3.1'
+when /\b3/
+  gem 'mongoid', '~> 3.1.7'
 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 'benchmark-ips', require: false
+  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/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2011-2016 Aaron Qian & Contributors
+Copyright (c) 2011-2018 Aaron Qian & Contributors
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -3,7 +3,6 @@ mongoid-history
 
 [![Gem Version](https://badge.fury.io/rb/mongoid-history.svg)](http://badge.fury.io/rb/mongoid-history)
 [![Build Status](https://secure.travis-ci.org/mongoid/mongoid-history.svg?branch=master)](http://travis-ci.org/mongoid/mongoid-history)
-[![Dependency Status](https://gemnasium.com/mongoid/mongoid-history.svg)](https://gemnasium.com/mongoid/mongoid-history)
 [![Code Climate](https://codeclimate.com/github/mongoid/mongoid-history.svg)](https://codeclimate.com/github/mongoid/mongoid-history)
 [![Coverage Status](https://coveralls.io/repos/mongoid/mongoid-history/badge.svg)](https://coveralls.io/r/mongoid/mongoid-history?branch=coveralls)
 
@@ -14,7 +13,7 @@ This gem also implements multi-user undo, which allows users to undo any history
 Install
 -------
 
-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`.
+This gem supports Mongoid 3, 4, 5 on Ruby 1.9.3 or newer and Mongoid 6 and 7 on Ruby 2.2.2+. Add it to your `Gemfile` or run `gem install mongoid-history`.
 
 ```ruby
 gem 'mongoid-history'
@@ -37,8 +36,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 +65,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
@@ -149,11 +149,34 @@ Comment.disable_tracking do
   comment.update_attributes(:title => "Test 3")
 end
 
-# globally disable all history tracking
+# disable tracking for comments by default
+Comment.disable_tracking!
+
+# enable tracking for comments within a block
+Comment.enable_tracking do
+  comment.update_attributes(:title => "Test 3")
+end
+
+# renable tracking for comments by default
+Comment.enable_tracking!
+
+# globally disable all history tracking within a block
 Mongoid::History.disable do
   comment.update_attributes(:title => "Test 3")
   user.update_attributes(:name => "Eddie Van Halen")
 end
+
+# globally disable all history tracking by default
+Mongoid::History.disable!
+
+# globally enable all history tracking within a block
+Mongoid::History.enable do
+  comment.update_attributes(:title => "Test 3")
+  user.update_attributes(:name => "Eddie Van Halen")
+end
+
+# globally renable all history tracking by default
+Mongoid::History.enable!
 ```
 
 You may want to track changes on all fields.
@@ -388,7 +411,7 @@ In your View, you might do something like (example in HAML format):
 
 **Adding Userstamp on History Trackers**
 
-To track the User in the application who created the HistoryTracker, please add the
+To track the User in the application who created the HistoryTracker, add the
 [Mongoid::Userstamp gem](https://github.com/tbpro/mongoid_userstamp) to your HistoryTracker class.
 This will add a field called `created_by` and an accessor `creator` to the model (you can rename these via gem config).
 
@@ -399,15 +422,6 @@ class MyHistoryTracker
 end
 ```
 
-*Migrating Userstamp from Previous Versions*
-
-Since October 2013 (mongoid-history version 0.4.1 and onwards), Mongoid::History itself no longer supports the userstamp natively. In order to migrate, follow the
-instructions above then run the following command:
-
-```
-MyHistoryTracker.all.rename(modifier_id: :created_by)
-```
-
 **Setting Modifier Class Name**
 
 If your app will track history changes to a user, Mongoid History looks for these modifiers in the ``User`` class by default.  If you have named your 'user' accounts differently, you will need to add that to your Mongoid History config:
@@ -429,6 +443,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 +535,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.
+
+``` ruby
+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**
 
@@ -526,6 +603,6 @@ You're encouraged to contribute to this library. See [CONTRIBUTING](CONTRIBUTING
 Copyright
 ---------
 
-Copyright (c) 2011-2016 Aaron Qian and Contributors.
+Copyright (c) 2011-2018 Aaron Qian and Contributors.
 
 MIT License. See [LICENSE.txt](LICENSE.txt) for further details.