paper_trail-association_tracking 1.1.0 → 2.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 844d3ff1eb96a7bae834ad57625e2fb87cf37ebbea76bd489621a31c2a57d6f7
-  data.tar.gz: 0cd147df0a5ee52494abcda09e0fc44c10ebae176cc567a3659debb7533ad72c
+  metadata.gz: 51f0ba0d9f3c256f374002822d5f7e88444b6be465dd2189c8107d90160ed457
+  data.tar.gz: 046c163be73401cc97d593b48fc8a6fb91e09480303c6ab00df3f7818fc25ddd
 SHA512:
-  metadata.gz: b49a595381d282b2ace65a18405921fba2970a22dde79841b5b7e42d148392b37caac9323136721cbebb9e0f0b74962d333e38883f923a934bb599b54dcf967a
-  data.tar.gz: '0180dff00868dfb4e49be3722df2210c630aa1550cf2963714d445f1b0c7d4eadfc96db258bcf88b4554949720821a33f3f00178b2ee4aeb61c52c26238de047'
+  metadata.gz: d0e720740047a827254138caa7d8019d2ca29f5a4ee1a53fd7cc51f93d8a04998f2c8f661415840bc379f4196673347e35656f18fc2c70d14809fd47b9532f6b
+  data.tar.gz: dd3e7ecc22c067f5f60fe0fd1d21a7997bb91e62ed39955ac2a337cce83071617d93c2f49ec70f0a6de96c37efe6625041a4b0e3e2c57739c7b2ef30bbe135c9

data/CHANGELOG.md

@@ -1,14 +1,50 @@
 # CHANGELOG
 
-## Unreleased
+### Unreleased - [View Diff](https://github.com/westonganger/paper_trail-association_tracking/compare/v2.1.1...master)
 
-- None
+- Nothing yet
 
-## 1.1.0 - 2018-12-28
+### 2.1.3 - [View Diff](https://github.com/westonganger/paper_trail-association_tracking/compare/v2.1.1...v2.1.3)
 
-- [#10](https://github.com/westonganger/paper_trail-association_tracking/pull/9) - The `has_many: true` option now reifies polymorphic associations. Previously they were skipped.
-- [#9](https://github.com/westonganger/paper_trail-association_tracking/pull/9) - The `belongs_to: true` option now reifies polymorphic associations. Previously they were skipped.
+- [PR #24](https://github.com/westonganger/paper_trail-association_tracking/pull/24) - Fix reification on STI models that have parent child relationships
+- Last version that is compatible with `paper_trail` due to the change in the loading mechanism
 
-## 1.0.0 - 2018-06-04
+### 2.1.2
+
+- Release yanked, had bug preventing installation
+
+### 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 - [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.
+
+### How to Upgrade from v1.0.0 or earlier
+
+- Run `rails g paper_trail_association_tracking:add_foreign_type_to_version_associations` and then migrate your database.
+
+### 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 - [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
 
 - [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

@@ -1,173 +1,130 @@
 # PaperTrail-AssociationTracking
 
 <a href="https://badge.fury.io/rb/paper_trail-association_tracking" target="_blank"><img height="21" style='border:0px;height:21px;' border='0' src="https://badge.fury.io/rb/paper_trail-association_tracking.svg" alt="Gem Version"></a>
-<a href='https://travis-ci.org/westonganger/paper_trail-association_tracking' target='_blank'><img height='21' style='border:0px;height:21px;' src='https://api.travis-ci.org/westonganger/paper_trail-association_tracking.svg?branch=master' border='0' alt='Build Status' /></a>
+<a href='https://travis-ci.com/westonganger/paper_trail-association_tracking' target='_blank'><img height='21' style='border:0px;height:21px;' src='https://api.travis-ci.com/westonganger/paper_trail-association_tracking.svg?branch=master' border='0' alt='Build Status' /></a>
 <a href='https://rubygems.org/gems/paper_trail-association_tracking' target='_blank'><img height='21' style='border:0px;height:21px;' src='https://ruby-gem-downloads-badge.herokuapp.com/paper_trail-association_tracking?label=rubygems&type=total&total_label=downloads&color=brightgreen' border='0' alt='RubyGems Downloads' /></a>
 
-Plugin for the [PaperTrail](https://github.com/paper-trail-gem/paper_trail.git) gem to track and reify associations.
+Plugin for the [PaperTrail](https://github.com/paper-trail-gem/paper_trail.git) gem to track and reify associations. This gem was extracted from PaperTrail for v9.2.0 to simplify things in PaperTrail and association tracking separately. 
 
 **PR's will happily be accepted**
 
-This gem was extracted from PaperTrail in v9.2 to simplify things in PaperTrail and association tracking seperately. 
-At this time, `paper_trail` has a runtime dependency on this gem and will keep running the existing tests related 
-to association tracking. This arrangement will be maintained for a few years, if practical.
+PaperTrail-AssociationTracking can restore three types of associations: Has-One, Has-Many, and Has-Many-Through. 
+
+It will store in the `version_associations` table additional information to correlate versions of the association and versions of the model when the associated record is changed. When reifying the model, it will utilize this table, together with the `transaction_id` to find the correct version of the association and reify it. The `transaction_id` is a unique id for version records created in the same transaction. It is used to associate the version of the model and the version of the association that are created in the same transaction.
 
-A little history lesson, discussed as early as 2009, and first implemented in late 2014, association
-tracking was part of PT core until 2018 as an experimental feature and was use at your own risk. This gem now
-maintains a list of known issues and we hope the community can help remove some of them via PR's.
 
-## Table of Contents
 
-<!-- toc -->
+
+## Table of Contents
 
 - [Install](#install)
-- [Associations](#associations)
+- [Usage](#usage)
+- [Limitations](#limitations)
 - [Known Issues](#known-issues)
 - [Contributing](#contributing)
 - [Credits](#credits)
 
-<!-- tocstop -->
 
 # Install
 
 ```ruby
 # Gemfile
 
-gem 'paper_trail' # Requires v9.2+
+gem 'paper_trail' # Minimum required version is v9.2.0
 gem 'paper_trail-association_tracking'
 ```
 
-# Association Tracking
-
-This plugin currently can restore three types of associations: Has-One, Has-Many, and
-Has-Many-Through. In order to do this, you will need to do two things:
+Then run `rails generate paper_trail_association_tracking:install` which will do the following two things for you:
 
 1. Create a `version_associations` table
-2. Set `PaperTrail.config.track_associations = true` (e.g. in an initializer)
+2. Set `PaperTrail.config.track_associations = true` in an initializer
 
+# Usage
 
-Both will be done for you automatically if you run the PaperTrail-AssociationTracking generator (e.g. `rails generate paper_trail_association_tracking:install`)
+First, ensure that you have added `has_paper_trail` to your main model and all associated models that are to be tracked.
 
-If you want to add this functionality after the initial installation, you will
-need to create the `version_associations` table manually, and you will need to
-ensure that `PaperTrail.config.track_associations = true` is set.
+To restore associations as they were at the time you must pass any of the following options to the `reify` method.
 
-PaperTrail will store in the `version_associations` table additional information
-to correlate versions of the association and versions of the model when the
-associated record is changed. When reifying the model, PaperTrail can use this
-table, together with the `transaction_id` to find the correct version of the
-association and reify it. The `transaction_id` is a unique id for version records
-created in the same transaction. It is used to associate the version of the model
-and the version of the association that are created in the same transaction.
+- To restore Has-Many and Has-Many-Through associations, use option `has_many: true`
+- To restore Has-One associations , use option `has_one: true` to `reify`
+- To restore Belongs-To associations, use option `belongs_to: true`
 
-To restore Has-One associations as they were at the time, pass option `has_one:
-true` to `reify`. To restore Has-Many and Has-Many-Through associations, use
-option `has_many: true`. To restore Belongs-To association, use
-option `belongs_to: true`. For example:
+For example:
 
 ```ruby
-class Location < ActiveRecord::Base
-  belongs_to :treasure
-  has_paper_trail
-end
-
-class Treasure < ActiveRecord::Base
-  has_one :location
-  has_paper_trail
-end
-
-treasure.amount                  # 100
-treasure.location.latitude       # 12.345
-
-treasure.update_attributes amount: 153
-treasure.location.update_attributes latitude: 54.321
-
-t = treasure.versions.last.reify(has_one: true)
-t.amount                         # 100
-t.location.latitude              # 12.345
+item.versions.last.reify(has_many: true, has_one: true, belongs_to: false)
 ```
 
-If the parent and child are updated in one go, PaperTrail-AssociationTracking can use 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
-treasure.amount                  # 100
-treasure.location.latitude       # 12.345
+For example:
 
-Treasure.transaction do
-treasure.location.update_attributes latitude: 54.321
-treasure.update_attributes amount: 153
+```ruby
+class Product
+  has_many :photos, autosave: true
 end
 
-t = treasure.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, PaperTrail-AssociationTracking 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. 
 
-```ruby
-class Widget < ActiveRecord::Base
-  has_paper_trail
-  has_one :wotsit, autosave: true
-end
+For example:
 
-class Wotsit < ActiveRecord::Base
+```ruby
+class Product < ActiveRecord::Base
   has_paper_trail
-  belongs_to :widget
+  has_many :photos, autosave: false ### or if autosave not set
 end
 
-widget = Widget.create(name: 'widget_0')
-widget.update_attributes(name: 'widget_1')
-widget.create_wotsit(name: 'wotsit')
+product = Product.create(name: 'product_0')
+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
+```
 
-widget_0 = widget.versions.last.reify(has_one: true)
-widget_0.wotsit                                  # 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).
 
-widget_0 = widget.versions.last.reify(has_one: true, mark_for_destruction: true)
-widget_0.wotsit.marked_for_destruction?          # true
-widget_0.save!
-widget.reload.wotsit                             # nil
-```
+For example:
 
-# Known Issues
+```ruby
+item.amount                  # 100
+item.location.latitude       # 12.345
 
-Associations have the following known issues, in order of descending importance. Use in Production at your own risk. 
+Item.transaction do
+  item.location.update(latitude: 54.321)
+  item.update(amount: 153)
+end
 
-**PR's for these issues will happily be accepted**
+t = item.versions.last.reify(has_one: true)
+t.amount                         # 100
+t.location.latitude              # 12.345, instead of 54.321
+```
 
-If you notice anything here that should be updated/removed/edited feel free to create an issue.
+# Limitations
 
-1. PaperTrail-AssociationTracking only reifies the first level of associations.
-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.
-1. Not compatible with [transactional tests](https://github.com/rails/rails/blob/591a0bb87fff7583e01156696fbbf929d48d3e54/activerecord/lib/active_record/fixtures.rb#L142), aka. transactional fixtures. - [PT Issue #542](https://github.com/airblade/paper_trail/issues/542)
-1. Requires database timestamp columns with fractional second precision.
-   - Sqlite and postgres timestamps have fractional second precision by default.
-   [MySQL timestamps do not](https://dev.mysql.com/doc/refman/5.6/en/fractional-seconds.html). Furthermore, MySQL 5.5 and earlier do not
-   support fractional second precision at all.
-   - Also, support for fractional seconds in MySQL was not added to
-   rails until ActiveRecord 4.2 (https://github.com/rails/rails/pull/14359).
-1. PaperTrail-AssociationTracking can't restore an association properly if the association record
-   can be updated to replace its parent model (by replacing the foreign key)
-1. Currently PaperTrail-AssociationTracking only supports a single `version_associations` table.
-   Therefore, you can only use a single table to store the versions for
-   all related models. Sorry for those who use multiple version tables.
-1. PaperTrail-AssociationTracking 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. 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, then reification won't work. Example:
 
     ```ruby
     class Book < ActiveRecord::Base
@@ -187,59 +144,41 @@ If you notice anything here that should be updated/removed/edited feel free to c
       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 = []
     ```
 
-    Having said that, you can apparently get all these working (I haven't tested it
-    myself) with this patch:
-
-    ```ruby
-    # config/initializers/active_record_patch.rb
-
-    class HasManyThroughAssociationPatch
-      def delete_records(records, method)
-        method ||= :destroy
-        super
-      end
-    end
-
-    ActiveRecord::Associations::HasManyThroughAssociation.prepend(HasManyThroughAssociationPatch)
-    ```
 
-    See [PT Issue #113](https://github.com/paper-trail-gem/paper_trail/issues/113) for a discussion about this.
+# Known Issues
 
+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 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.
 
-### Regarding ActiveRecord Single Table Inheritance (STI)
 
-At this time during `reify` any STI `has_one` associations will raise a `PaperTrailAssociationTracking::Reifiers::HasOne::FoundMoreThanOne` error. See [PT Issue #594](https://github.com/airblade/paper_trail/issues/594)
+# Contributing
 
-Something to note though, is while the PaperTrail gem supports [Single Table Inheritance](http://api.rubyonrails.org/classes/ActiveRecord/Base.html#class-ActiveRecord::Base-label-Single+table+inheritance), I do NOT recommend STI ever. Your better off rolling your own solution rather than using STI.
+We use the `appraisal` gem for testing multiple versions of `paper_trail` and `activerecord`. Please use the following steps to test using `appraisal`.
 
-# Contributing
+1. `bundle exec appraisal install`
+2. `bundle exec appraisal rake test`
 
-See the paper_trail [contribution guidelines](https://github.com/paper-trail-gem/paper_trail/blob/master/.github/CONTRIBUTING.md)
 
 # Credits
 
-Plugin authored by [Weston Ganger](https://github.com/westonganger) & Jared Beck
+Maintained by [Weston Ganger](https://westonganger.com) - [@westonganger](https://github.com/westonganger)
 
-Maintained by [Weston Ganger](https://github.com/westonganger) & [Jared Beck](https://github.com/jaredbeck) 
+Plugin authored by [Weston Ganger](https://westonganger.com) - [@westonganger](https://github.com/westonganger)
 
 Associations code originally contributed by Ben Atkins, Jared Beck, Andy Stewart & more

data/Rakefile

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 require "bundler"
 Bundler::GemHelper.install_tasks
 
@@ -20,9 +18,8 @@ Rake::TestTask.new(:test) do |t|
   t.pattern = "test/**/*_test.rb"
   t.verbose = false
 
-  # Enabling ruby interpreter warnings (-w) is, sadly, impractical. There are
-  # too many noisy warnings that we have no control over, e.g. caused by libs we
-  # depend on.
+  ### Enabling ruby interpreter warnings (-w) is, sadly, impractical. 
+  ### There are too many noisy warnings that we have no control over, e.g. caused by libs we depend on.
   t.warning = false
 end
 
@@ -33,29 +30,5 @@ RSpec::Core::RakeTask.new(:spec) do |t|
   t.verbose = false # hide list of specs bit.ly/1nVq3Jn
 end
 
-task :autocorrect do
-  rules = [
-    'FrozenStringLiteralComment',
-    'Layout/EmptyLineAfterMagicComment',
-    'Layout/EmptyLinesAroundBlockBody',
-    'Layout/EmptyLinesAroundClassBody',
-    'Layout/EmptyLinesAroundMethodBody',
-    'Layout/EmptyLinesAroundModuleBody',
-    'Layout/TrailingWhitespace',
-    'Style/EmptyMethod',
-    'Style/TrailingCommaInArguments',
-  ]
-
-  rules.each do |rule|
-    `bundle exec rubocop --auto-correct --only #{rule}`
-  end
-
-  Rake::Task['rubocop'].invoke
-end
-
-require "rubocop/rake_task"
-RuboCop::RakeTask.new
-
-### TODO: Allow rubocop to fail, but still continue
 desc "Default: run all available test suites"
 task default: %i[prepare test spec]

data/lib/generators/paper_trail_association_tracking/add_foreign_type_to_version_associations_generator.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+require "rails/generators/active_record"
+
+module PaperTrailAssociationTracking
+  # Installs PaperTrail in a rails app.
+  class AddForeignTypeToVersionAssociationsGenerator < ::Rails::Generators::Base
+    include ::Rails::Generators::Migration
+
+    # Class names of MySQL adapters.
+    # - `MysqlAdapter` - Used by gems: `mysql`, `activerecord-jdbcmysql-adapter`.
+    # - `Mysql2Adapter` - Used by `mysql2` gem.
+    MYSQL_ADAPTERS = [
+      "ActiveRecord::ConnectionAdapters::MysqlAdapter",
+      "ActiveRecord::ConnectionAdapters::Mysql2Adapter"
+    ].freeze
+
+    source_root File.expand_path("../templates", __FILE__)
+
+    desc "Generates (but does not run) a migration to add a the foreign_type column to the version_associations table after upgrading from v1.0 or earlier."
+
+    def create_migrations
+      add_paper_trail_migration("add_foreign_type_to_version_associations")
+    end
+
+    def self.next_migration_number(dirname)
+      ::ActiveRecord::Generators::Base.next_migration_number(dirname)
+    end
+
+    protected
+
+    def add_paper_trail_migration(template)
+      migration_dir = File.expand_path("db/migrate")
+      if self.class.migration_exists?(migration_dir, template)
+        ::Kernel.warn "Migration already exists: #{template}"
+      else
+        migration_template(
+          "#{template}.rb.erb",
+          "db/migrate/#{template}.rb",
+          migration_version: migration_version
+        )
+      end
+    end
+
+    private
+
+    def migration_version
+      "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
+    end
+  end
+end

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
@@ -55,10 +55,7 @@ module PaperTrailAssociationTracking
     private
 
     def migration_version
-      major = ActiveRecord::VERSION::MAJOR
-      if major >= 5
-        "[#{major}.#{ActiveRecord::VERSION::MINOR}]"
-      end
+      "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
     end
   end
 end

data/lib/generators/paper_trail_association_tracking/templates/add_foreign_type_to_version_associations.rb.erb

@@ -0,0 +1,21 @@
+# This migration and AddTransactionIdColumnToVersions provide the necessary
+# schema for tracking associations.
+class AddForeignTypeToVersionAssociations < ActiveRecord::Migration<%= migration_version %>
+  def self.up
+    add_column :version_associations, :foreign_type, :string, index: true
+    remove_index :version_associations,
+      name: "index_version_associations_on_foreign_key"
+    add_index :version_associations,
+      %i(foreign_key_name foreign_key_id foreign_type),
+      name: "index_version_associations_on_foreign_key"
+  end
+
+  def self.down
+    remove_index :version_associations,
+      name: "index_version_associations_on_foreign_key"
+    remove_column :version_associations, :foreign_type
+    add_index :version_associations,
+      %i(foreign_key_name foreign_key_id),
+      name: "index_version_associations_on_foreign_key"
+  end
+end

data/lib/generators/paper_trail_association_tracking/templates/create_version_associations.rb.erb

@@ -6,7 +6,7 @@ class CreateVersionAssociations < ActiveRecord::Migration<%= migration_version %
       t.integer  :version_id
       t.string   :foreign_key_name, null: false
       t.integer  :foreign_key_id
-      t.string   :foreign_type, null: false
+      t.string   :foreign_type
     end
     add_index :version_associations, [:version_id]
     add_index :version_associations,

data/lib/paper_trail-association_tracking.rb

@@ -55,8 +55,7 @@ end
 
 # Require frameworks
 if defined?(::Rails)
-  # Rails module is sometimes defined by gems like rails-html-sanitizer
-  # so we check for presence of Rails.application.
+  # Rails module is sometimes defined by gems like rails-html-sanitizer so we check for presence of Rails.application.
   if defined?(::Rails.application)
     require "paper_trail_association_tracking/frameworks/rails"
   else

data/lib/paper_trail_association_tracking/paper_trail.rb

@@ -6,33 +6,6 @@ module PaperTrailAssociationTracking
       def transaction?
         ::ActiveRecord::Base.connection.open_transactions.positive?
       end
-
-      # @deprecated
-      def clear_transaction_id
-        ::ActiveSupport::Deprecation.warn(
-          "PaperTrail.clear_transaction_id is deprecated, use PaperTrail.request.clear_transaction_id",
-          caller(1)
-        )
-        request.clear_transaction_id
-      end
-
-      # @deprecated
-      def transaction_id
-        ::ActiveSupport::Deprecation.warn(
-          "PaperTrail.transaction_id is deprecated without replacement.",
-          caller(1)
-        )
-        request.transaction_id
-      end
-
-      # @deprecated
-      def transaction_id=(id)
-        ::ActiveSupport::Deprecation.warn(
-          "PaperTrail.transaction_id= is deprecated without replacement.",
-          caller(1)
-        )
-        request.transaction_id = id
-      end
     end
   end
 end

data/lib/paper_trail_association_tracking/reifiers/has_many.rb

@@ -78,14 +78,13 @@ module PaperTrailAssociationTracking
         #
         # @api private
         # @param klass - An ActiveRecord class.
-        # @param version_id_subquery - String. A SQL subquery that selects
-        #   the IDs of version records.
+        # @param version_ids - Array. The IDs of version records.
         # @return A `Hash` mapping IDs to `Version`s
         #
-        def versions_by_id(klass, version_id_subquery)
+        def versions_by_id(klass, version_ids)
           klass.
             paper_trail.version_class.
-            where("id IN (#{version_id_subquery})").
+            where(id: version_ids).
             inject({}) { |a, e| a.merge!(e.item_id => e) }
         end
 
@@ -95,17 +94,23 @@ module PaperTrailAssociationTracking
         # from the point in time identified by `tx_id` or `version_at`.
         # @api private
         def load_versions_for_hm_association(assoc, model, version_table, tx_id, version_at)
-          version_id_subquery = ::PaperTrail::VersionAssociation.
+          # For STI models, associations may be defined to reference superclasses, so looking up 
+          # based on only the child-most class is not appropriate.
+          sti_model_names =  model.class.ancestors
+                                  .select { |x| x <= model.class.base_class && x.method_defined?(assoc.name) }
+                                  .map(&:name)
+
+          version_ids = ::PaperTrail::VersionAssociation.
             joins(model.class.version_association_name).
-            select("MIN(version_id)").
+            select("MIN(version_id) as version_id").
             where("foreign_key_name = ?", assoc.foreign_key).
             where("foreign_key_id = ?", model.id).
-            where("foreign_type = ?", model.class.name).
+            where(foreign_type: sti_model_names + [nil]).
             where("#{version_table}.item_type = ?", assoc.klass.base_class.name).
             where("created_at >= ? OR transaction_id = ?", version_at, tx_id).
             group("item_id").
-            to_sql
-          versions_by_id(model.class, version_id_subquery)
+            map{|e| e.version_id}
+          versions_by_id(model.class, version_ids)
         end
       end
     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
 
@@ -73,8 +82,8 @@ module PaperTrailAssociationTracking
         # `version_at`.
         # @api private
         def load_versions_for_hmt_association(assoc, ids, tx_id, version_at)
-          version_id_subquery = assoc.klass.paper_trail.version_class.
-            select("MIN(id)").
+          version_ids = assoc.klass.paper_trail.version_class.
+            select("MIN(id) as id").
             where("item_type = ?", assoc.klass.base_class.name).
             where("item_id IN (?)", ids).
             where(
@@ -83,8 +92,8 @@ module PaperTrailAssociationTracking
               tx_id
             ).
             group("item_id").
-            to_sql
-          ::PaperTrailAssociationTracking::Reifiers::HasMany.versions_by_id(assoc.klass, version_id_subquery)
+            map{|e| e.id}
+          ::PaperTrailAssociationTracking::Reifiers::HasMany.versions_by_id(assoc.klass, version_ids)
         end
       end
     end

data/lib/paper_trail_association_tracking/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paper_trail-association_tracking
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.1.3
 platform: ruby
 authors:
 - Weston Ganger
@@ -10,196 +10,176 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-28 00:00:00.000000000 Z
+date: 2021-04-20 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: paper_trail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '9.1'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '9.1'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: ffaker
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.7'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: generator_spec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.4
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.4
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: mysql2
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.10
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.10
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.21.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.21.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.3
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.3
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.7.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.7.2
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.51.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.51.0
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.19.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.19.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: '0'
 description: Plugin for the PaperTrail gem to track and reify associations
 email: weston@westonganger.com
 executables: []
@@ -210,7 +190,9 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- lib/generators/paper_trail_association_tracking/add_foreign_type_to_version_associations_generator.rb
 - lib/generators/paper_trail_association_tracking/install_generator.rb
+- lib/generators/paper_trail_association_tracking/templates/add_foreign_type_to_version_associations.rb.erb
 - lib/generators/paper_trail_association_tracking/templates/add_transaction_id_column_to_versions.rb.erb
 - lib/generators/paper_trail_association_tracking/templates/create_version_associations.rb.erb
 - lib/paper_trail-association_tracking.rb
@@ -250,9 +232,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.6
+      version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Plugin for the PaperTrail gem to track and reify associations