mongoid-history 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 200d89256cdc175333764f52ff8e87d9e15c5050
-  data.tar.gz: 0c16bfb17523fb50f65af6b3576026d7bddaa1ea
+  metadata.gz: 1fd1d2a3abaccb54ecc0c83da09b16dbaa7d8210
+  data.tar.gz: 1126ed19a46d4542a059c2434665436043787424
 SHA512:
-  metadata.gz: 9c56ee00ab7c9f6aacb8fa8e0816a4729b2f17c7b33abb6ccd95783d9d5e331182a2cf7707579e4dcd2868f48766777570b35a6497e54be37a34351c86e3963e
-  data.tar.gz: 5317fa4ee38a6b554dc94d85571a6e80cf6eb2a16fd57b8cfc7ca366820b57947cdd353c2cf8ad7091086953bb7945cb925785cd6a1d78bce21512a208114384
+  metadata.gz: d83f26cbfe246d76d2659414b7a7feb48b1a27007cafec7bf1c4d957568b688375ce09302f0ed3a15329d31e87a4e15147212c70f3fa4796d6de783e17edfd0d
+  data.tar.gz: 27fce1d91542b620f197f213185b570f057508a929f05abc8b2647cfeeeef543e536850e3127d9b29e567f032bc94a2d587a72c9d8f91facec0254632540b49e

data/.rubocop_todo.yml

@@ -11,9 +11,12 @@ Lint/HandleExceptions:
   Exclude:
     - 'spec/unit/trackable_spec.rb'
 
+Metrics/ClassLength:
+  Max: 103
+
 # Offense count: 12
 Metrics/AbcSize:
-  Max: 51
+  Max: 60
 
 # Offense count: 4
 Metrics/CyclomaticComplexity:
@@ -27,12 +30,12 @@ Metrics/LineLength:
 # Offense count: 7
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
-  Max: 32
+  Max: 33
 
 # Offense count: 2
 # Configuration parameters: CountComments.
 Metrics/ModuleLength:
-  Max: 168
+  Max: 223
 
 # Offense count: 4
 Metrics/PerceivedComplexity:
@@ -42,9 +45,14 @@ Metrics/PerceivedComplexity:
 Style/Documentation:
   Exclude:
     - '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'
@@ -52,8 +60,13 @@ Style/Documentation:
     - '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/create_spec.rb'
+    - 'spec/unit/attributes/destroy_spec.rb'
+    - 'spec/unit/attributes/update_spec.rb'
 
 # Offense count: 6
 Style/EachWithObject:

data/.travis.yml

@@ -1,4 +1,3 @@
-services: mongodb
 
 sudo: false
 
@@ -6,15 +5,31 @@ language: ruby
 
 cache: bundler
 
-rvm:
-  - 2.2
-  - 2.1.1
-  - 2.0.0
-  - 1.9.3
-  - rbx-2.2.10
-  - jruby-19mode
+services: mongodb
 
 env:
   - MONGOID_VERSION=3
   - MONGOID_VERSION=4
   - MONGOID_VERSION=5
+  - MONGOID_VERSION=6
+  - MONGOID_VERSION=HEAD
+
+rvm:
+  - 2.3.1
+
+before_install:
+  - gem update bundler
+
+before_script:
+  - bundle exec danger
+
+addons:
+  apt:
+    sources:
+      - mongodb-3.2-precise
+    packages:
+      - mongodb-org-server
+
+matrix:
+  allow_failures:
+    - env: MONGOID_VERSION=HEAD

data/CHANGELOG.md

@@ -1,8 +1,22 @@
+0.6.0 (2016/09/13)
+------------------
+
+* [#2](https://github.com/mongoid/mongoid-history/pull/2): Froked into the [mongoid](https://github.com/mongoid) organization - [@dblock](https://github.com/dblock).
+* [#1](https://github.com/mongoid/mongoid-history/pull/1): Added Danger, PR linter - [@dblock](https://github.com/dblock).
+* [#166](https://github.com/aq1018/mongoid-history/pull/166): Hash fields should default to an empty Hash - [@johnnyshields](https://github.com/johnnyshields).
+* [#162](https://github.com/aq1018/mongoid-history/pull/162): Do not consider embedded relations as dynamic fields - [@JagdeepSingh](https://github.com/JagdeepSingh).
+* [#144](https://github.com/aq1018/mongoid-history/pull/158): Can modify history tracker insertion on object creation - [@sivagollapalli](https://github.com/sivagollapalli).
+* [#155](https://github.com/aq1018/mongoid-history/pull/155): Add support to whitelist the attributes for tracked embeds_one and embeds_many relations - [@JagdeepSingh](https://github.com/JagdeepSingh).
+* [#154](https://github.com/aq1018/mongoid-history/pull/154): Prevent soft-deleted embedded documents from tracking - [@JagdeepSingh](https://github.com/JagdeepSingh).
+* [#151](https://github.com/aq1018/mongoid-history/pull/151): Added ability to customize tracker class for each trackable; multiple trackers across the app are now possible - [@JagdeepSingh](https://github.com/JagdeepSingh).
+* [#151](https://github.com/aq1018/mongoid-history/pull/151): Added automatic support for `request_store` gem as drop-in replacement for `Thread.current` - [@JagdeepSingh](https://github.com/JagdeepSingh).
+* [#150](https://github.com/aq1018/mongoid-history/pull/150): Added support for keeping embedded objects audit history in parent itself - [@JagdeepSingh](https://github.com/JagdeepSingh).
+
 0.5.0 (2015/09/18)
 ------------------
 
 * [#143](https://github.com/aq1018/mongoid-history/pull/143): Added support for Mongoid 5 - [@dblock](https://github.com/dblock).
-* [#133](https://github.com/aq1018/mongoid-history/pull/133): Added dynamic attributes tracking (Mongoid::Attributes::Dynamic): [@minisai](https://github.com/minisai).
+* [#133](https://github.com/aq1018/mongoid-history/pull/133): Added dynamic attributes tracking (Mongoid::Attributes::Dynamic) - [@minisai](https://github.com/minisai).
 * [#142](https://github.com/aq1018/mongoid-history/pull/142): Allow non-database fields to be specified in conjunction with a custom changes method - [@kayakyakr](https://github.com/kayakyakr).
 
 0.4.7 (2015/04/06)
@@ -26,13 +40,13 @@
 0.4.3 (2014/07/10)
 ------------------
 
-* [#110](https://github.com/aq1018/mongoid-history/pull/110): Fixed scope reference on history tracks criteria -  [@adbeelitamar](https://github.com/adbeelitamar).
+* [#110](https://github.com/aq1018/mongoid-history/pull/110): Fixed scope reference on history tracks criteria - [@adbeelitamar](https://github.com/adbeelitamar).
 
 0.4.2 (2014/07/01)
 ------------------
 
-* [#106](https://github.com/aq1018/mongoid-history/pull/106): Added support for polymorphic relationship `scope` -  [@adbeelitamar](https://github.com/adbeelitamar).
-* [#106](https://github.com/aq1018/mongoid-history/pull/106): Enabled specifying an array of relationships in `scope` -  [@adbeelitamar](https://github.com/adbeelitamar).
+* [#106](https://github.com/aq1018/mongoid-history/pull/106): Added support for polymorphic relationship `scope` - [@adbeelitamar](https://github.com/adbeelitamar).
+* [#106](https://github.com/aq1018/mongoid-history/pull/106): Enabled specifying an array of relationships in `scope` - [@adbeelitamar](https://github.com/adbeelitamar).
 * [#83](https://github.com/aq1018/mongoid-history/pull/83): Added support for Mongoid 4.x, which removed `attr_accessible` in favor of protected attributes - [@dblock](https://github.com/dblock).
 * [#103](https://github.com/aq1018/mongoid-history/pull/103): Fixed compatibility with models using `default_scope` - [@mrjlynch](https://github.com/mrjlynch).
 
@@ -53,7 +67,7 @@
 
 * Added `Mongoid::History.disable` and `Mongoid::History.enabled?` methods for global tracking disablement - [@johnnyshields](https://github.com/johnnyshields).
 * Added `:changes_method` that optionally overrides which method to call to collect changes - [@joelnordel](https://github.com/joelnordell).
-* [API Change] The `:destroy` action now stores trackers in the format `original=value, modified=nil` (previously it was the reverse): [@johnnyshields](https://github.com/johnnyshields).
+* The `:destroy` action now stores trackers in the format `original=value, modified=nil` (previously it was the reverse) - [@johnnyshields](https://github.com/johnnyshields).
 * Support for polymorphic embedded classes - [@tstepp](https://github.com/tstepp).
 * Support for Mongoid field aliases, e.g. `field :n, as: :name` - [@johnnyshields](https://github.com/johnnyshields).
 * Support for Mongoid embedded aliases, e.g. `embeds_many :comments, store_as: :coms` - [@johnnyshields](https://github.com/johnnyshields).
@@ -102,7 +116,7 @@
 
 * [#23](https://github.com/aq1018/mongoid-history/pull/34): Updated `Trackable::association_hash` to write through parent - [@tcopple](https://github.com/tcopple).
 * Fix: `Trackable::association_hash` nil meta value call - [@tcopple](https://github.com/tcopple).
-* [#27](https://github.com/aq1018/mongoid-history/pull/27): Added support for re-creation of destroyed embedded documents - [@erlingwl](https://github.com/erlingwl)
+* [#27](https://github.com/aq1018/mongoid-history/pull/27): Added support for re-creation of destroyed embedded documents - [@erlingwl](https://github.com/erlingwl).
 
 0.1.7 (2011/12/09)
 ------------------

data/Dangerfile

@@ -0,0 +1 @@
+danger.import_dangerfile(gem: 'mongoid-danger')

data/Gemfile

@@ -2,13 +2,34 @@ source 'https://rubygems.org'
 
 gemspec
 
-case version = ENV['MONGOID_VERSION'] || '~> 5.0'
+case version = ENV['MONGOID_VERSION'] || '~> 6.0.0.rc0'
+when 'HEAD'
+  gem 'mongoid', github: 'mongodb/mongoid'
+when /6/
+  gem 'mongoid', '~> 6.0.0.rc0'
 when /5/
   gem 'mongoid', '~> 5.0'
+  gem 'mongoid-observers', '~> 0.2.0'
 when /4/
   gem 'mongoid', '~> 4.0'
+  gem 'mongoid-observers', '~> 0.2.0'
 when /3/
   gem 'mongoid', '~> 3.1'
 else
   gem 'mongoid', version
 end
+
+group :development, :test do
+  gem 'rake'
+  gem 'bundler'
+end
+
+group :test do
+  gem 'mongoid-danger', '~> 0.1.0', require: false
+  gem 'rspec', '~> 3.1'
+  gem 'rubocop', '0.34.1'
+  gem 'yard'
+  gem 'gem-release'
+  gem 'coveralls'
+  gem 'request_store'
+end

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2011 Aaron Qian
+Copyright (c) 2011-2016 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

@@ -1,11 +1,11 @@
 mongoid-history
 ===============
 
-[![Gem Version](https://badge.fury.io/rb/mongoid-history.png)](http://badge.fury.io/rb/mongoid-history)
-[![Build Status](https://secure.travis-ci.org/aq1018/mongoid-history.png?branch=master)](http://travis-ci.org/aq1018/mongoid-history)
-[![Dependency Status](https://gemnasium.com/aq1018/mongoid-history.png)](https://gemnasium.com/aq1018/mongoid-history)
-[![Code Climate](https://codeclimate.com/github/aq1018/mongoid-history.png)](https://codeclimate.com/github/aq1018/mongoid-history)
-[![Coverage Status](https://coveralls.io/repos/aq1018/mongoid-history/badge.png?branch=coveralls)](https://coveralls.io/r/aq1018/mongoid-history?branch=coveralls)
+[![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)
 
 Mongoid-history tracks historical changes for any document, including embedded ones. It achieves this by storing all history tracks in a single collection that you define. Embedded documents are referenced by storing an association path, which is an array of `document_name` and `document_id` fields starting from the top most parent document and down to the embedded document that should track history.
 
@@ -34,14 +34,14 @@ class HistoryTracker
 end
 ```
 
-**Set tracker class name**
+**Set default tracker class name (Optional)**
 
-Manually set the tracker class name to make sure your tracker can be found and loaded properly. You can skip this step if you manually require your tracker before using any trackables.
-
-The following example sets the tracker class name using a Rails initializer.
+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:
 
 ```ruby
-# config/initializers/mongoid-history.rb
+# config/initializers/mongoid_history.rb
 # initializer for mongoid-history
 # assuming HistoryTracker is your tracker class
 Mongoid::History.tracker_class_name = :history_tracker
@@ -156,7 +156,78 @@ Mongoid::History.disable do
 end
 ```
 
-**Retrieving the list of tracked fields**
+**Include embedded objects attributes in parent audit**
+
+Modify above `Post` and `Comment` classes as below:
+
+```ruby
+class Post
+  include Mongoid::Document
+  include Mongoid::Timestamps
+  include Mongoid::History::Trackable
+
+  field           :title
+  field           :body
+  field           :rating
+  embeds_many     :comments
+
+  track_history   :on => [:title, :body, :comments],
+                  :modifier_field => :modifier,
+                  :modifier_field_inverse_of => :nil,
+                  :version_field => :version,
+                  :track_create   =>  true,     # track create on Post
+                  :track_update   =>  true,
+                  :track_destroy  =>  false
+end
+
+class Comment
+  include Mongoid::Document
+  include Mongoid::Timestamps
+
+  field             :title
+  field             :body
+  embedded_in       :post, :inverse_of => :comments
+end
+
+user = User.create(:name => "Aaron")
+post = Post.create(:title => "Test", :body => "Post", :modifier => user)
+comment = post.comments.build(:title => "test", :body => "comment", :modifier => user)
+post.save
+post.history_tracks.count # should be 1
+
+comment.respond_to?(:history_tracks) # should be false
+
+track = post.history_tracks.first
+track.original # {}
+track.modified # { "title" => "Test", "body" => "Post", "comments" => [{ "_id" => "575fa9e667d827e5ed00000d", "title" => "test", "body" => "comment" }], ... }
+```
+
+**Whitelist the tracked attributes of embedded relations**
+
+If you don't want to track all the attributes of embedded relations in parent audit history, you can whitelist the attributes as below:
+
+```ruby
+class Book
+  include Mongoid::Document
+  ...
+  embeds_many :pages
+  track_history :on => { :pages => [:title, :content] }
+end
+
+class Page
+  include Mongoid::Document
+  ...
+  field :number
+  field :title
+  field :subtitle
+  field :content
+  embedded_in :book
+end
+```
+
+It will now track only `_id` (Mandatory), `title` and `content` attributes for `pages` relation.
+
+**Retrieving the list of tracked static and dynamic fields**
 
 ```ruby
 class Book
@@ -172,6 +243,42 @@ Book.tracked_field?(:title)   #=> true
 Book.tracked_field?(:author)  #=> false
 ```
 
+**Retrieving the list of tracked relations**
+
+```ruby
+class Book
+  ...
+  track_history :on => [:pages]
+end
+
+Book.tracked_relation?(:pages)    #=> true
+Book.tracked_embeds_many          #=> ["pages"]
+Book.tracked_embeds_many?(:pages) #=> true
+```
+
+**Skip soft-deleted embedded objects with nested tracking**
+
+Default paranoia field is `deleted_at`. You can use custom field for each class as below:
+
+```ruby
+class Book
+  include Mongoid::Document
+  include Mongoid::History::Trackable
+  embeds_many :pages
+  track_history on: :pages
+end
+
+class Page
+  include Mongoid::Document
+  include Mongoid::History::Trackable
+  ...
+  embedded_in :book
+  history_settings paranoia_field: :removed_at
+end
+```
+
+This will skip the `page` documents with `removed_at` set to a non-blank value from nested tracking
+
 **Displaying history trackers as an audit trail**
 
 In your Controller:
@@ -336,7 +443,16 @@ class Baz
 end
 ```
 
-For more examples, check out [spec/integration/integration_spec.rb](https://github.com/aq1018/mongoid-history/blob/master/spec/integration/integration_spec.rb).
+For more examples, check out [spec/integration/integration_spec.rb](spec/integration/integration_spec.rb).
+
+
+**Thread Safety**
+
+Mongoid::History stores the tracking enable/disable flag in `Thread.current`.
+If the [RequestStore](https://github.com/steveklabnik/request_store) gem is installed, Mongoid::History
+will automatically store variables in the `RequestStore.store` instead. RequestStore is recommended
+for threaded web servers like Thin or Puma.
+
 
 Contributing to mongoid-history
 -------------------------------
@@ -346,10 +462,6 @@ You're encouraged to contribute to this library. See [CONTRIBUTING](CONTRIBUTING
 Copyright
 ---------
 
-Copyright (c) 2011-2012 Aaron Qian. MIT License.
-
-See [LICENSE.txt](https://github.com/aq1018/mongoid-history/blob/master/LICENSE.txt) for further details.
-
-
+Copyright (c) 2011-2016 Aaron Qian and Contributors.
 
-[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/aq1018/mongoid-history/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
+MIT License. See [LICENSE.txt](LICENSE.txt) for further details.

data/lib/mongoid/history.rb

@@ -1,5 +1,10 @@
 require 'easy_diff'
 require 'mongoid/compatibility'
+require 'mongoid/history/attributes/base'
+require 'mongoid/history/attributes/create'
+require 'mongoid/history/attributes/update'
+require 'mongoid/history/attributes/destroy'
+require 'mongoid/history/options'
 require 'mongoid/history/version'
 require 'mongoid/history/tracker'
 require 'mongoid/history/trackable'
@@ -8,28 +13,40 @@ module Mongoid
   module History
     GLOBAL_TRACK_HISTORY_FLAG = 'mongoid_history_trackable_enabled'
 
-    mattr_accessor :tracker_class_name
-    mattr_accessor :trackable_class_options
-    mattr_accessor :modifier_class_name
-    mattr_accessor :current_user_method
+    class << self
+      attr_accessor :tracker_class_name
+      attr_accessor :trackable_class_options
+      attr_accessor :trackable_settings
+      attr_accessor :modifier_class_name
+      attr_accessor :current_user_method
 
-    def self.tracker_class
-      @tracker_class ||= tracker_class_name.to_s.classify.constantize
-    end
+      def disable(&_block)
+        store[GLOBAL_TRACK_HISTORY_FLAG] = false
+        yield
+      ensure
+        store[GLOBAL_TRACK_HISTORY_FLAG] = true
+      end
 
-    def self.disable(&_block)
-      Thread.current[GLOBAL_TRACK_HISTORY_FLAG] = false
-      yield
-    ensure
-      Thread.current[GLOBAL_TRACK_HISTORY_FLAG] = true
-    end
+      def enabled?
+        store[GLOBAL_TRACK_HISTORY_FLAG] != false
+      end
+
+      def store
+        defined?(RequestStore) ? RequestStore.store : Thread.current
+      end
+
+      def default_settings
+        @default_settings ||= { paranoia_field: 'deleted_at' }
+      end
 
-    def self.enabled?
-      Thread.current[GLOBAL_TRACK_HISTORY_FLAG] != false
+      def trackable_class_settings(trackable_class)
+        trackable_settings[trackable_class.name.to_sym] || default_settings
+      end
     end
   end
 end
 
 Mongoid::History.modifier_class_name = 'User'
 Mongoid::History.trackable_class_options = {}
+Mongoid::History.trackable_settings = {}
 Mongoid::History.current_user_method ||= :current_user