paper_trail-association_tracking 2.1.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b2d339d9003d50ddc86c1e1cdea91863bcb2908ce4b4c42db9b59937431a3f0
-  data.tar.gz: c9638879c3932b3f5c07b549401c60b2c473da0afed2dab078b35deb5b8eae10
+  metadata.gz: 1c44254220614ad32a3f634a83c4c3a0d8e3c5aa5dd76521f09f702d03d0be1c
+  data.tar.gz: 9434f7aa8c162a2117d7c33890bdbd2df93729a343073e67ebc024537ee773ca
 SHA512:
-  metadata.gz: 79f9131a55657ea99ae5393e5c1bb17e00e79744896f99faf70d2df982c2a38a2c06cb17c8bed7131213de814c10c0e96c29f27782ad1bb064db1778649bc6a7
-  data.tar.gz: 2199d8c642a22494c6f792f809bc7cd7143f287f9fc6a2a8cd3ea31243ab100de9914bc27ef06ebeafd902730b46b7747d2f8a5d41ca6e662b81d2354c140315
+  metadata.gz: f5ee8734919969546148c2cb12add0ef77a6e0e0acec5137713974babdc05bb80be5d7321e41b636c74d3b3d4a3463d8e42ddc6b1d5d02f0affed0de0a024fc6
+  data.tar.gz: 3205666624b7f94acecca6dc56757e971ba1382b80bb9762c818f7f7935063adebb36e2ab8d3d3d0cb8216b6276042e7eda7f84658cb5e7d696242798503a3b7

data/CHANGELOG.md

@@ -1,17 +1,23 @@
 # CHANGELOG
 
-## Unreleased
+### Unreleased - [View Diff](https://github.com/westonganger/paper_trail-association_tracking/compare/v2.1.1...master)
 
 - Nothing yet
 
-## 2.1.0 - 2020-08-14
+### 2.1.1 - 2020-10-21 - [View Diff](https://github.com/westonganger/paper_trail-association_tracking/compare/v2.1.0...v2.1.1)
+
+- Bug fix for reify on `has_many :through` relationships when `:source` is specified
+- Bug fix for reify on `has_many :through` relationships where the association is a has_one on the through model
+- Bug fix to ensure install generator will set `PaperTrail.association_tracking = true`
+
+### 2.1.0 - 2020-08-14 - [View Diff](https://github.com/westonganger/paper_trail-association_tracking/compare/v2.0.0...v2.1.0)
 
 - [PR #18](https://github.com/westonganger/paper_trail-association_tracking/pull/18) - Improve performance for `Model.reify(has_many: true)` by separating the SQL subquery.
 - [PR #15](https://github.com/westonganger/paper_trail-association_tracking/pull/15) - Recreate `version_associations.foreign_key` index to utilize the new `version_associations.foreign_type` column
 - Update test matrix to support multiple versions of PT-core and ActiveRecord
 - Remove deprecated methods `clear_transaction_id`, `transaction_id` and `transaction_id=`
 
-## 2.0.0 - 2019-01-22
+### 2.0.0 - 2019-01-22 - [View Diff](https://github.com/westonganger/paper_trail-association_tracking/compare/v1.1.1...v2.0.0)
 
 - [PR #11](https://github.com/westonganger/paper_trail-association_tracking/issues/11) - Remove null constraint on `version_associations.foreign_type` column which was added in `v1.1.0`. This fixes issues adding the column to existing projects who are upgrading.
 - Add generator `rails g paper_trail_association_tracking:add_foreign_type_to_version_associations` for `versions_associations.foreign_type` column for upgrading applications from `v1.0.0` or earlier.
@@ -20,16 +26,16 @@
 
 - Run `rails g paper_trail_association_tracking:add_foreign_type_to_version_associations` and then migrate your database.
 
-## 1.1.1 - 2018-01-14
+### 1.1.1 - 2018-01-14 - [View Diff](https://github.com/westonganger/paper_trail-association_tracking/compare/v1.1.0...v1.1.1)
 
 - Same as v2 release, this is released simply to maintain a working `v1` branch since `v1.1.0` was broken
 
-## 1.1.0 - 2018-12-28
+### 1.1.0 - 2018-12-28 - [View Diff](https://github.com/westonganger/paper_trail-association_tracking/compare/v1.0.0...v1.1.0)
 
 - Note: This release is somewhat broken, please upgrade to `v2.0.0` or stay on `v1.0.0`
 - [PR #10](https://github.com/westonganger/paper_trail-association_tracking/pull/10) - The `has_many: true` option now reifies polymorphic associations. Previously they were skipped.
 - [PR #9](https://github.com/westonganger/paper_trail-association_tracking/pull/9) - The `belongs_to: true` option now reifies polymorphic associations. Previously they were skipped.
 
-## 1.0.0 - 2018-06-04
+### 1.0.0 - 2018-06-04
 
 - [PT #1070](https://github.com/paper-trail-gem/paper_trail/issues/1070), [#2](https://github.com/westonganger/paper_trail-association_tracking/issues/2) - Extracted from paper_trail gem in v9.2

data/README.md

@@ -55,56 +55,76 @@ For example:
 item.versions.last.reify(has_many: true, has_one: true, belongs_to: false)
 ```
 
-If the parent and child are updated in one go, it will utilize the aforementioned `transaction_id` to reify the models as they were before the transaction (instead of before the update to the model).
+If you want the reified associations to be saved upon calling `save` on the parent model then you must set `autosave: true` on all required associations. A little tip, `accepts_nested_attributes` automatically sets `autosave` to true but you should probably still state it explicitly.
 
-```ruby
-item.amount                  # 100
-item.location.latitude       # 12.345
+For example:
 
-Item.transaction do
-  item.location.update(latitude: 54.321)
-  item.update(amount: 153)
+```ruby
+class Product
+  has_many :photos, autosave: true
 end
 
-t = item.versions.last.reify(has_one: true)
-t.amount                         # 100
-t.location.latitude              # 12.345, instead of 54.321
+product = Product.first.versions.last.reify(has_many: true, has_one: true, belongs_to: false)
+product.save! ### now this will also save all reified photos
 ```
 
-By default, it excludes an associated record from the reified parent model if the associated record exists in the live model but did not exist as at the time the version was created. This is usually what you want if you just want to look at the reified version. But if you want to persist it, it would be better to pass in option `mark_for_destruction: true` so that the associated record is included and marked for destruction. Note that `mark_for_destruction` only has [an effect on associations marked with `autosave: true`](http://api.rubyonrails.org/classes/ActiveRecord/AutosaveAssociation.html#method-i-mark_for_destruction).
+If you do not set `autosave: true` true on the association then you will have to save/delete them manually. 
+
+For example:
 
 ```ruby
 class Product < ActiveRecord::Base
   has_paper_trail
-  has_one :photo, autosave: true
-end
-
-class Photo < ActiveRecord::Base
-  has_paper_trail
-  belongs_to :product
+  has_many :photos, autosave: false ### or if autosave not set
 end
 
 product = Product.create(name: 'product_0')
-product.update(name: 'product_1')
-product.create_photo(name: 'photo')
+product.photos.create(name: 'photo')
+product.update(name: 'product_a')
+product.photos.create(name: 'photo')
+
+reified_product = product.versions.last.reify(has_many: true, mark_for_destruction: true)
+reified_product.save!
+reified_product.name # product_a
+reified_product.photos.size # 2
+reified_product.photos.reload
+reified_product.photos.size # 1 ### bad, didnt save the associations
+
+product = Product.create(name: 'product_1')
+product.update(name: 'product_b')
+product.photos.create(name: 'photo')
+
+reified_product = product.versions.last.reify(has_many: true, mark_for_destruction: true)
+reified_product.save!
+reified_product.name # product_b
+reified_product.photos.size # 1
+reified_product.photos.each{|x| x.marked_for_destruction? ? x.destroy! : x.save! }
+reified_product.photos.size # 0
+```
 
-product_0 = product.versions.last.reify(has_one: true)
-product_0.photo                                  # nil
+It will also respect AR transactions by utilizing the aforementioned `transaction_id` to reify the models as they were before the transaction (instead of before the update to the model).
 
-product_0 = product.versions.last.reify(has_one: true, mark_for_destruction: true)
-product_0.photo.marked_for_destruction?          # true
-product_0.save!
-product.reload.photo                             # nil
-```
+For example:
 
+```ruby
+item.amount                  # 100
+item.location.latitude       # 12.345
+
+Item.transaction do
+  item.location.update(latitude: 54.321)
+  item.update(amount: 153)
+end
+
+t = item.versions.last.reify(has_one: true)
+t.amount                         # 100
+t.location.latitude              # 12.345, instead of 54.321
+```
 
 # Limitations
 
-1. Only reifies the first level of associations. If you want to include nested associations simply add :through relationships to your model.
+1. Only reifies the first level of associations. If you want to include nested associations simply add `:through` relationships to your model.
 1. Currently we only supports a single `version_associations` table. Therefore, you can only use a single table to store the versions for all related models.
-1. Relies on the callbacks on the association model (and the :through association model for Has-Many-Through associations) to record the versions and the relationship between the versions. If the association is changed without invoking the callbacks, Reification won't work. Below are some examples:
-
-    Given these models:
+1. Relies on the callbacks on the association model (and the `:through` association model for Has-Many-Through associations) to record the versions and the relationship between the versions. If the association is changed without invoking the callbacks, then reification won't work. Example:
 
     ```ruby
     class Book < ActiveRecord::Base
@@ -124,22 +144,16 @@ product.reload.photo                             # nil
       has_many :books, through: :authorships
       has_paper_trail
     end
-    ```
-
-    Then each of the following will store authorship versions:
-
-    ```ruby
-    @book.authors << @dostoyevsky
-    @book.authors.create(name: 'Tolstoy')
+    
+    ### Each of the following will store authorship versions:
+    @book.authors << @john
+    @book.authors.create(name: 'Jack')
     @book.authorships.last.destroy
     @book.authorships.clear
-    @book.author_ids = [@solzhenistyn.id, @dostoyevsky.id]
-    ```
-
-    But none of these will:
-
-    ```ruby
-    @book.authors.delete @tolstoy
+    @book.author_ids = [@john.id, @joe.id]
+    
+    ### But none of these will:
+    @book.authors.delete @john
     @book.author_ids = []
     @book.authors = []
     ```
@@ -149,7 +163,7 @@ product.reload.photo                             # nil
 
 1. Sometimes the has_one association will find more than one possible candidate and will raise a `PaperTrailAssociationTracking::Reifiers::HasOne::FoundMoreThanOne` error. For example, see `spec/models/person_spec.rb`
     - If you are not using STI, you may want to just assume the first result of multiple is the correct one and continue. PaperTrail <= v8 did this without error or warning. To do so add the following line to your initializer: `PaperTrail.config.association_reify_error_behaviour = :warn`. Valid options are: `[:error, :warn, :ignore]`
-    - When using STI, even if you enable `:warn` you will likely still end up recieving an `ActiveRecord::AssociationTypeMismatch` error. See [PT Issue #594](https://github.com/airblade/paper_trail/issues/594). I recommend that you never use STI in any Rails application due to the problems they cause.
+    - When using STI, even if you enable `:warn` you will likely still end up recieving an `ActiveRecord::AssociationTypeMismatch` error. See [PT Issue #594](https://github.com/airblade/paper_trail/issues/594). I strongly recommend that you do not use STI, however if you do need to decide to use STI, please see https://github.com/paper-trail-gem/paper_trail#4b1-the-optional-item_subtype-column
 1. Not compatible with transactional tests, see [PT Issue #542](https://github.com/airblade/paper_trail/issues/542). However, apparently there has been some success by using the [transactional_capybara](https://rubygems.org/gems/transactional_capybara) gem.
 
 

data/lib/generators/paper_trail_association_tracking/install_generator.rb

@@ -28,7 +28,7 @@ module PaperTrailAssociationTracking
     def create_initializer
       create_file(
         "config/initializers/paper_trail.rb",
-        "PaperTrail.config.track_associations = #{!!options.with_associations?}\n",
+        "PaperTrail.config.track_associations = true\n",
         "PaperTrail.config.association_reify_error_behaviour = :error"
       )
     end

data/lib/paper_trail_association_tracking/reifiers/has_many_through.rb

@@ -53,7 +53,16 @@ module PaperTrailAssociationTracking
           # association, that is, `model.paragraphs`, has not been loaded. So,
           # we do that now.
           through_collection.flat_map { |through_model|
-            through_model.public_send(assoc.name.to_sym).to_a
+            records = through_model.public_send(assoc.source_reflection_name)
+            
+            if records.respond_to?(:to_a)
+              # Has Many association
+              records = records.to_a
+            else
+              # Has One association - Nothing more to do
+            end
+            
+            records
           }
         end
 

data/lib/paper_trail_association_tracking/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PaperTrailAssociationTracking
-  VERSION = "2.1.0"
+  VERSION = "2.1.1".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paper_trail-association_tracking
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Weston Ganger
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-14 00:00:00.000000000 Z
+date: 2020-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appraisal