mongoid-history 0.8.0 → 0.8.5

data/RELEASING.md

@@ -1,67 +1,66 @@
-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
-```
+# Releasing Mongoid::History
+
+There are no particular rules about when to release Mongoid History.
+Release bug fixes frequently, features not so frequently and breaking API changes rarely.
+
+### Release Procedure
+
+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).
+Mongoid History versions should follow [Semantic Versioning (SemVer)](https://semver.org/).
+
+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

@@ -1,24 +1,24 @@
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts 'Run `bundle install` to install missing gems'
-  exit e.status_code
-end
-
-Bundler::GemHelper.install_tasks
-
-require 'rspec/core'
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = FileList['spec/**/*_spec.rb']
-end
-
-require 'rubocop/rake_task'
-RuboCop::RakeTask.new(:rubocop)
-
-task default: %i[rubocop spec]
-
-require 'yard'
-YARD::Rake::YardocTask.new
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts 'Run `bundle install` to install missing gems'
+  exit e.status_code
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new(:rubocop)
+
+task default: %i[rubocop spec]
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/UPGRADING.md

@@ -1,34 +1,53 @@
-## 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`. 
+## 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`.
+
+### Upgrading to 0.4.1
+
+#### Migrate Userstamp
+
+`Mongoid::History` no longer supports the userstamp natively. 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.
+
+```ruby
+class MyHistoryTracker
+  include Mongoid::History::Tracker
+  include Mongoid::Userstamp
+end
+```
+
+Rename the field.
+
+```ruby
+MyHistoryTracker.all.rename(modifier_id: :created_by)
+```

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

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

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

@@ -1,50 +1,45 @@
-module Mongoid
-  module History
-    module Attributes
-      class Create < ::Mongoid::History::Attributes::Base
-        def attributes
-          @attributes = {}
-          trackable.attributes.each do |k, v|
-            next unless trackable_class.tracked_field?(k, :create)
-            modified = if changes[k]
-                         changes[k].class == Array ? changes[k].last : changes[k]
-                       else
-                         v
-                       end
-            @attributes[k] = [nil, format_field(k, modified)]
-          end
-          insert_embeds_one_changes
-          insert_embeds_many_changes
-          @attributes
-        end
-
-        private
-
-        def insert_embeds_one_changes
-          trackable_class.tracked_embeds_one.each do |rel|
-            rel_class = trackable_class.embeds_one_class(rel)
-            paranoia_field = Mongoid::History.trackable_class_settings(rel_class)[:paranoia_field]
-            paranoia_field = rel_class.aliased_fields.key(paranoia_field) || paranoia_field
-            rel = aliased_fields.key(rel) || rel
-            obj = trackable.send(rel)
-            next if !obj || (obj.respond_to?(paranoia_field) && obj.public_send(paranoia_field).present?)
-            @attributes[rel] = [nil, format_embeds_one_relation(rel, obj.attributes)]
-          end
-        end
-
-        def insert_embeds_many_changes
-          trackable_class.tracked_embeds_many.each do |rel|
-            rel_class = trackable_class.embeds_many_class(rel)
-            paranoia_field = Mongoid::History.trackable_class_settings(rel_class)[:paranoia_field]
-            paranoia_field = rel_class.aliased_fields.key(paranoia_field) || paranoia_field
-            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) }]
-          end
-        end
-      end
-    end
-  end
-end
+module Mongoid
+  module History
+    module Attributes
+      class Create < ::Mongoid::History::Attributes::Base
+        def attributes
+          @attributes = {}
+          changes.each do |k, v|
+            next unless trackable_class.tracked_field?(k, :create)
+            @attributes[k] = format_field(k, v)
+          end
+          insert_embeds_one_changes
+          insert_embeds_many_changes
+          @attributes
+        end
+
+        private
+
+        def insert_embeds_one_changes
+          trackable_class.tracked_embeds_one.each do |rel|
+            rel_class = trackable_class.relation_class_of(rel)
+            paranoia_field = Mongoid::History.trackable_class_settings(rel_class)[:paranoia_field]
+            paranoia_field = rel_class.aliased_fields.key(paranoia_field) || paranoia_field
+            rel = aliased_fields.key(rel) || rel
+            obj = trackable.send(rel)
+            next if !obj || (obj.respond_to?(paranoia_field) && obj.public_send(paranoia_field).present?)
+            @attributes[rel] = [nil, format_embeds_one_relation(rel, obj.attributes)]
+          end
+        end
+
+        def insert_embeds_many_changes
+          trackable_class.tracked_embeds_many.each do |rel|
+            rel_class = trackable_class.relation_class_of(rel)
+            paranoia_field = Mongoid::History.trackable_class_settings(rel_class)[:paranoia_field]
+            paranoia_field = rel_class.aliased_fields.key(paranoia_field) || paranoia_field
+            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) }]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,34 +1,34 @@
-module Mongoid
-  module History
-    module Attributes
-      class Destroy < ::Mongoid::History::Attributes::Base
-        def attributes
-          @attributes = {}
-          trackable.attributes.each { |k, v| @attributes[k] = [format_field(k, v), nil] if trackable_class.tracked_field?(k, :destroy) }
-          insert_embeds_one_changes
-          insert_embeds_many_changes
-          @attributes
-        end
-
-        private
-
-        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
-        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
-        end
-      end
-    end
-  end
-end
+module Mongoid
+  module History
+    module Attributes
+      class Destroy < ::Mongoid::History::Attributes::Base
+        def attributes
+          @attributes = {}
+          trackable.attributes.each { |k, v| @attributes[k] = [format_field(k, v), nil] if trackable_class.tracked_field?(k, :destroy) }
+          insert_embeds_one_changes
+          insert_embeds_many_changes
+          @attributes
+        end
+
+        private
+
+        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
+        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
+        end
+      end
+    end
+  end
+end