mongoid-history 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d92239564a7df075b3a55eb68c9f7f22666e24ef
-  data.tar.gz: 13f5bb15f7102d5b0957b569cb880af4249a0c75
+  metadata.gz: c2d2105bf114627851d9fca6f7b7117f4766b0d9
+  data.tar.gz: bfc95d7ddcfcdd2b977f799641d63b61d2da3b45
 SHA512:
-  metadata.gz: e9b09271720419ebbd843f78954d182430e4a3e5f020cc6b835993154c08fa55e6c8627beaef64f8813632ce15118186057d39771ddb863cf40f28a68c6ce7d3
-  data.tar.gz: 8d337e3008f6468a42b01c0babafa649685237f686e255bd620d380bf8d91bf77d56888445ca20b043ee6f2e7398d4821709fb877bafe11765948fc38ee6ddad
+  metadata.gz: b2a0ef3daab0538b8d7a853f3e1c1f40d10a244521fd9811ee6feff55529ae1d58d685126262510bc0311da2bb0184f6c5b1d883accbd02742e665346ab84b93
+  data.tar.gz: d2358b6e8625a06aa1a52a1de2783d15b4a86cfb3b644055912ecae13063cc951c22440f38e9837c43810e780c8f220ff10936e8558fdf57be8ca6b2d4afd38c

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-04-09 18:25:15 -0400 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: 100
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/BlockLength:
+  Max: 801
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 124
 
 # Offense count: 4
 Metrics/CyclomaticComplexity:
   Max: 10
 
-# Offense count: 199
-# Configuration parameters: AllowURI, URISchemes.
+# Offense count: 435
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
 Metrics/LineLength:
   Max: 688
 
-# Offense count: 7
+# Offense count: 13
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
-  Max: 33
+  Max: 23
 
 # Offense count: 2
 # Configuration parameters: CountComments.
 Metrics/ModuleLength:
-  Max: 223
+  Max: 176
 
 # Offense count: 4
 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,8 @@
+### 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

@@ -20,16 +20,17 @@ else
 end
 
 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
@@ -509,6 +509,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,68 @@
+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).
+
+```
+Next Release
+============
+
+* 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,9 @@
+### 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.

data/lib/mongoid/history.rb

@@ -11,7 +11,7 @@ require 'mongoid/history/trackable'
 
 module Mongoid
   module History
-    GLOBAL_TRACK_HISTORY_FLAG = 'mongoid_history_trackable_enabled'
+    GLOBAL_TRACK_HISTORY_FLAG = 'mongoid_history_trackable_enabled'.freeze
 
     class << self
       attr_accessor :tracker_class_name

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

@@ -33,9 +33,9 @@ module Mongoid
           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) }
+                                             .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) }
+                                             .map { |v_attrs| format_embeds_many_relation(relation, v_attrs) }
         end
       end
     end

data/lib/mongoid/history/options.rb

@@ -24,7 +24,7 @@ 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,
@@ -83,7 +83,7 @@ module Mongoid
             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 +163,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 +172,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
 

data/lib/mongoid/history/trackable.rb

@@ -22,9 +22,9 @@ module Mongoid
           delegate :history_trackable_options, to: 'self.class'
           delegate :track_history?, to: 'self.class'
 
-          before_update :track_update if options[:track_update]
-          before_create :track_create if options[:track_create]
-          before_destroy :track_destroy if options[:track_destroy]
+          around_update :track_update if options[:track_update]
+          around_create :track_create if options[:track_create]
+          around_destroy :track_destroy if options[:track_destroy]
 
           Mongoid::History.trackable_class_options ||= {}
           Mongoid::History.trackable_class_options[options_parser.scope] = options
@@ -131,7 +131,7 @@ module Mongoid
             elsif options[:last]
               versions = history_tracks.limit(options[:last])
             else
-              fail 'Invalid options, please specify (:from / :to) keys or :last key.'
+              raise 'Invalid options, please specify (:from / :to) keys or :last key.'
             end
           else
             options_or_version = options_or_version.to_a if options_or_version.is_a?(Range)
@@ -178,7 +178,7 @@ module Mongoid
                 relation.class_name == node.metadata.class_name.to_s && relation.name == node.metadata.name
               else
                 relation.class_name == node.relation_metadata.class_name.to_s &&
-                relation.name == node.relation_metadata.name
+                  relation.name == node.relation_metadata.name
               end
             end
           end
@@ -232,16 +232,16 @@ module Mongoid
           @history_tracker_attributes
         end
 
-        def track_create
-          track_history_for_action(:create)
+        def track_create(&block)
+          track_history_for_action(:create, &block)
         end
 
-        def track_update
-          track_history_for_action(:update)
+        def track_update(&block)
+          track_history_for_action(:update, &block)
         end
 
-        def track_destroy
-          track_history_for_action(:destroy) unless destroyed?
+        def track_destroy(&block)
+          track_history_for_action(:destroy, &block) unless destroyed?
         end
 
         def clear_trackable_memoization
@@ -273,9 +273,20 @@ module Mongoid
           if track_history_for_action?(action)
             current_version = (send(history_trackable_options[:version_field]) || 0) + 1
             send("#{history_trackable_options[:version_field]}=", current_version)
-            self.class.tracker_class.create!(history_tracker_attributes(action.to_sym).merge(version: current_version, action: action.to_s, trackable: self))
+            last_track = self.class.tracker_class.create!(history_tracker_attributes(action.to_sym).merge(version: current_version, action: action.to_s, trackable: self))
           end
+
           clear_trackable_memoization
+
+          begin
+            yield
+          rescue => e
+            if track_history_for_action?(action)
+              send("#{history_trackable_options[:version_field]}=", current_version - 1)
+              last_track.destroy
+            end
+            raise e
+          end
         end
       end
 
@@ -445,8 +456,8 @@ module Mongoid
         def tracked_embeds_one
           @tracked_embeds_one ||= begin
             reflect_on_all_associations(:embeds_one)
-            .map(&:key)
-            .select { |rel| history_trackable_options[:relations][:embeds_one].include? rel }
+              .map(&:key)
+              .select { |rel| history_trackable_options[:relations][:embeds_one].include? rel }
           end
         end
 
@@ -469,8 +480,8 @@ module Mongoid
         def tracked_embeds_many
           @tracked_embeds_many ||= begin
             reflect_on_all_associations(:embeds_many)
-            .map(&:key)
-            .select { |rel| history_trackable_options[:relations][:embeds_many].include? rel }
+              .map(&:key)
+              .select { |rel| history_trackable_options[:relations][:embeds_many].include? rel }
           end
         end