paper_trail-association_tracking 2.2.1 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b49b412d6cd431cd4310dadde716d334231225fed80e84c5d4d8696f42fcb0f
-  data.tar.gz: a77500b35d0f66a1840272b8efd9891ce876da341756fe47077cd1257e4f26b2
+  metadata.gz: 5a94904cbcb068a832c7aee7d04d63750631a0dddc282da68665c98cf053baed
+  data.tar.gz: bfb10257058405a0b4e99a555724d53b01cc050d18c6f00fb27979f8c415ded9
 SHA512:
-  metadata.gz: dff6c0eacc9cf46bb6ed00edbed900426ac3b842b7e5046bb9511422b44d78bb88782d7ffc4c4322c40e28426ee0cc2c3c4fdcd7630f0c0ca4b294dabaa9f815
-  data.tar.gz: 41c42f324a608af7c22d7b442827eedf15f4d6c79e0c023eb93adc99f177076a95b84c7dc18acdf8f8a3f0d3a9726378d542d18f02b8bc92a3a18092d9e792d2
+  metadata.gz: e52ddb1d136efd024b7b138dd5e2bb4676ec1f77fd6f20aeb54048e7d886e560681bac88fec4fbf1216af7aa27dc7eb485e02f5b6623a402b903de6a91cbcd8a
+  data.tar.gz: 5a2b6bbc604f5637ffa8758411874af0ac8c1c4a6b80f5d4f595e2c01e41399d64b69b608a1e83c6137c78373123a2078aa137749b5b24b8ef72d6d201f0dbbf

data/CHANGELOG.md

@@ -1,22 +1,27 @@
 # CHANGELOG
 
-### Unreleased - [View Diff](https://github.com/westonganger/paper_trail-association_tracking/compare/v2.2.1...master)
-- Nothing yet 
+### Unreleased - [View Diff](https://github.com/westonganger/paper_trail-association_tracking/compare/v2.3.0...master)
+- Nothing yet
 
-### v2.2.1 - [View Diff](https://github.com/westonganger/paper_trail-association_tracking/compare/v2.2.0...v2.2.1)
+### v2.3.0 - 2025-04-17 - [View Diff](https://github.com/westonganger/paper_trail-association_tracking/compare/v2.2.1...v2.3.0)
+- [#46](https://github.com/westonganger/paper_trail-association_tracking/pull/46) - Add support for custom version association class with separate database connection
+- [#49](https://github.com/westonganger/paper_trail-association_tracking/pull/49) - Fix has_many though associations when the through association is singular
+- [#48](https://github.com/westonganger/paper_trail-association_tracking/pull/48) - Fix belongs_to polymorphic associations with "empty string" type
+
+### v2.2.1 - 2022-03-28 - [View Diff](https://github.com/westonganger/paper_trail-association_tracking/compare/v2.2.0...v2.2.1)
 - [PR #38](https://github.com/westonganger/paper_trail-association_tracking/pull/38) - Fix the issue where reifying has_one association with `dependent: :destroy` could destroy a live record
 
-### v2.2.0 - [View Diff](https://github.com/westonganger/paper_trail-association_tracking/compare/v2.1.3...v2.2.0)
+### v2.2.0 - 2022-03-14 - [View Diff](https://github.com/westonganger/paper_trail-association_tracking/compare/v2.1.3...v2.2.0)
 
 - [PR #36](https://github.com/westonganger/paper_trail-association_tracking/pull/36) - Fix load order for paper_trail v12+
 - Drop support for Ruby 2.5
 - Add Github Actions CI supporting multiple version of Ruby, Rails and multiple databases types
 
-### 2.1.3 - [View Diff](https://github.com/westonganger/paper_trail-association_tracking/compare/v2.1.1...v2.1.3)
+### 2.1.3 - 2021-04-20 - [View Diff](https://github.com/westonganger/paper_trail-association_tracking/compare/v2.1.1...v2.1.3)
 
 - [PR #24](https://github.com/westonganger/paper_trail-association_tracking/pull/24) - Fix reification on STI models that have parent child relationships
 
-### 2.1.2
+### 2.1.2 - 2021-04-20
 
 - A late night oopsies, Release yanked immediately, had bug preventing installation.
 

data/README.md

@@ -1,30 +1,32 @@
 # 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://github.com/westonganger/paper_trail-association_tracking/actions' target='_blank'><img src="https://github.com/westonganger/paper_trail-association_tracking/workflows/Tests/badge.svg" style="max-width:100%;" height='21' style='border:0px;height:21px;' border='0' alt="CI 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>
+<a href='https://github.com/westonganger/paper_trail-association_tracking/actions' target='_blank'><img src="https://github.com/westonganger/paper_trail-association_tracking/actions/workflows/test.yml/badge.svg?branch=master" style="max-width:100%;" height='21' style='border:0px;height:21px;' border='0' alt="CI Status"></a>
+<a href='https://rubygems.org/gems/paper_trail-association_tracking' target='_blank'><img height='21' style='border:0px;height:21px;' src='https://img.shields.io/gem/dt/paper_trail-association_tracking?color=brightgreen&label=Rubygems%20Downloads' 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. This gem was extracted from PaperTrail for v9.2.0 to simplify things in PaperTrail and association tracking separately. 
+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**
 
-PaperTrail-AssociationTracking can restore three types of associations: Has-One, Has-Many, and Has-Many-Through. 
+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.
 
-
-
-
 ## Table of Contents
 
+- [Alternative Solution](#alternative-solution)
 - [Install](#install)
 - [Usage](#usage)
 - [Limitations](#limitations)
 - [Known Issues](#known-issues)
 - [Contributing](#contributing)
 - [Credits](#credits)
-- [Alternative Solution](#alternative-solution)
 
+# Alternative Solution
+
+Model versioning and restoration require concious thought, design, and understanding. You should understand your versioning and restoration process completely. This gem paper_trail-association-tracking is mostly a blackbox solution which encourages you to set it up and then assume its Just Working<sup>TM</sup>. This can make for major data problems later.
+
+Instead I recommend a newer gem that I have created for handling snapshots of records and associations called [active_snapshot](https://github.com/westonganger/active_snapshot). This gem does not utilize `paper_trail` at all. The focus of the [active_snapshot](https://github.com/westonganger/active_snapshot) gem is to have a simple and fully understandable design is easy to customize and know inside and out for your projects needs.
 
 # Install
 
@@ -67,7 +69,7 @@ product = Product.first.versions.last.reify(has_many: true, has_one: true, belon
 product.save! ### now this will also save all reified photos
 ```
 
-If you do not set `autosave: true` true on the association then you will have to save/delete them manually. 
+If you do not set `autosave: true` true on the association then you will have to save/delete them manually.
 
 For example:
 
@@ -119,6 +121,21 @@ t.amount                         # 100
 t.location.latitude              # 12.345, instead of 54.321
 ```
 
+# Configuration
+
+You can configure a different version association class by using the following configuration:
+
+```ruby
+class ProductionVersionAssociation < PaperTrail::VersionAssociation
+  # You can change the table name, i.e.:
+  self.table_name = "product_version_associations"
+end
+
+class Product < ActiveRecord::Base
+  has_paper_trail version_associations: { class_name: "ProductVersionAssociation" }
+end
+```
+
 # Limitations
 
 1. Only reifies the first level of associations. If you want to include nested associations simply add `:through` relationships to your model.
@@ -143,14 +160,14 @@ t.location.latitude              # 12.345, instead of 54.321
       has_many :books, through: :authorships
       has_paper_trail
     end
-    
+
     ### 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 = [@john.id, @joe.id]
-    
+
     ### But none of these will:
     @book.authors.delete @john
     @book.author_ids = []
@@ -166,14 +183,6 @@ t.location.latitude              # 12.345, instead of 54.321
 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.
 
 
-# Contributing
-
-We use the `appraisal` gem for testing multiple versions of `paper_trail` and `activerecord`. Please use the following steps to test using `appraisal`.
-
-1. `bundle exec appraisal install`
-2. `bundle exec appraisal rake test`
-
-
 # Credits
 
 Maintained by [Weston Ganger](https://westonganger.com) - [@westonganger](https://github.com/westonganger)
@@ -181,9 +190,3 @@ Maintained by [Weston Ganger](https://westonganger.com) - [@westonganger](https:
 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
-
-# Alternative Solution
-
-Model Versioning and Restoration require concious thought, design, and understanding. You should understand your versioning and restoration process completely. Because PT-AT it is mostly a blackbox solution which encourages you to set it up and then assume its "Just Working". This can make for major data problems later.
-
-Instead I recommend a newer gem that I have created for handling snapshots of records and associations called [active_snapshot](https://github.com/westonganger/active_snapshot). This gem does not utilize `paper_trail` at all. The focus of this gem is to have a simple and fully understandable design is easy to customize and know inside and out for your projects needs.

data/Rakefile

@@ -1,31 +1,16 @@
 require "bundler"
 Bundler::GemHelper.install_tasks
 
-desc "Set a relevant database.yml for testing"
-task :prepare do
-  ENV["DB"] ||= "sqlite"
-  FileUtils.cp(
-    "spec/dummy_app/config/database.#{ENV['DB']}.yml",
-    "spec/dummy_app/config/database.yml"
-  )
-end
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec)
 
-require "rake/testtask"
-desc "Run tests on PaperTrail with Test::Unit."
-Rake::TestTask.new(:test) do |t|
-  t.libs << "lib"
-  t.libs << "test"
-  t.pattern = "test/**/*_test.rb"
-  t.verbose = false
-  t.warning = false
-end
+task test: [:spec]
 
-require "rspec/core/rake_task"
-desc "Run tests on PaperTrail with RSpec"
-task(:spec).clear
-RSpec::Core::RakeTask.new(:spec) do |t|
-  t.verbose = false # hide list of specs
-end
+task default: [:spec]
+
+task :console do
+  require "paper_trail-association-tracking"
 
-desc "Default: run all available test suites"
-task default: %i[prepare test spec]
+  require "irb"
+  binding.irb
+end

data/lib/paper_trail_association_tracking/model_config.rb

@@ -10,10 +10,17 @@ module PaperTrailAssociationTracking
     def setup(options = {})
       super
 
+      @model_class.class_attribute :version_association_class_name
+      @model_class.version_association_class_name = options.dig(:version_associations, :class_name) || "PaperTrail::VersionAssociation"
+
       setup_transaction_callbacks
       setup_callbacks_for_habtm(options[:join_tables])
     end
 
+    def version_association_class
+      @version_association_class ||= @model_class.version_association_class_name.constantize
+    end
+
     private
 
     # Raises an error if the provided class is an `abstract_class`.

data/lib/paper_trail_association_tracking/record_trail.rb

@@ -133,7 +133,7 @@ module PaperTrailAssociationTracking
       @record.class.reflect_on_all_associations(:has_and_belongs_to_many).each do |a|
         next unless save_habtm_association?(a)
         habtm_assoc_ids(a).each do |id|
-          ::PaperTrail::VersionAssociation.create(
+          @record.class.paper_trail.version_association_class.create(
             version_id: version.transaction_id,
             foreign_key_name: a.name,
             foreign_key_id: id,
@@ -170,7 +170,7 @@ module PaperTrailAssociationTracking
 
       if assoc.options[:polymorphic]
         foreign_type = @record.send(assoc.foreign_type)
-        if foreign_type && ::PaperTrail.request.enabled_for_model?(foreign_type.constantize)
+        if foreign_type.present? && ::PaperTrail.request.enabled_for_model?(foreign_type.constantize)
           assoc_version_args[:foreign_key_id] = @record.send(assoc.foreign_key)
           assoc_version_args[:foreign_type] = foreign_type
         end
@@ -180,7 +180,7 @@ module PaperTrailAssociationTracking
       end
 
       if assoc_version_args.key?(:foreign_key_id)
-        ::PaperTrail::VersionAssociation.create(assoc_version_args)
+        @record.class.paper_trail.version_association_class.create(assoc_version_args)
       end
     end
 

data/lib/paper_trail_association_tracking/reifiers/has_and_belongs_to_many.rb

@@ -8,7 +8,7 @@ module PaperTrailAssociationTracking
       class << self
         # @api private
         def reify(pt_enabled, assoc, model, options, transaction_id)
-          version_ids = ::PaperTrail::VersionAssociation.
+          version_ids = model.class.paper_trail.version_association_class.
             where("foreign_key_name = ?", assoc.name).
             where("version_id = ?", transaction_id).
             pluck(:foreign_key_id)

data/lib/paper_trail_association_tracking/reifiers/has_many.rb

@@ -100,7 +100,7 @@ module PaperTrailAssociationTracking
                                   .select { |x| x <= model.class.base_class && x.method_defined?(assoc.name) }
                                   .map(&:name)
 
-          version_ids = ::PaperTrail::VersionAssociation.
+          version_ids = model.class.paper_trail.version_association_class.
             joins(model.class.version_association_name).
             select("MIN(version_id) as version_id").
             where("foreign_key_name = ?", assoc.foreign_key).

data/lib/paper_trail_association_tracking/reifiers/has_many_through.rb

@@ -11,7 +11,7 @@ module PaperTrailAssociationTracking
           # Load the collection of through-models. For example, if `model` is a
           # Chapter, having many Paragraphs through Sections, then
           # `through_collection` will contain Sections.
-          through_collection = model.send(assoc.options[:through])
+          through_collection = through_collection(assoc, model, options, transaction_id)
 
           # Now, given the collection of "through" models (e.g. sections), load
           # the collection of "target" models (e.g. paragraphs)
@@ -24,6 +24,27 @@ module PaperTrailAssociationTracking
 
         private
 
+        # Examine the `through_reflection`, i.e., the "through:" option on the association.
+        #
+        # @api private
+        def through_collection(assoc, model, options, transaction_id)
+          through_reflection = assoc.through_reflection
+          # If the through association is has_many, we can just return the reified association
+          return model.send(assoc.options[:through]) if through_reflection.collection?
+
+          # If the model wasn't reified with belongs_to: true/has_one: true, then
+          # the through association hasn't been reified yet.
+          unless model.association(assoc.options[:through]).loaded?
+            if through_reflection.belongs_to?
+              BelongsTo.reify(through_reflection, model, options, transaction_id)
+            else
+              HasOne.reify(through_reflection, model, options, transaction_id)
+            end
+          end
+          # Wrap the association in a collection for `collection_through_has_many`
+          [*model.send(assoc.options[:through])]
+        end
+
         # Examine the `source_reflection`, i.e. the "source" of `assoc` the
         # `ThroughReflection`. The source can be a `BelongsToReflection`
         # or a `HasManyReflection`.

data/lib/paper_trail_association_tracking/reifiers/has_one.rb

@@ -90,13 +90,17 @@ module PaperTrailAssociationTracking
         # @api private
         def load_versions(assoc, model, transaction_id, version_at, base_class_name)
           version_table_name = model.class.paper_trail.version_class.table_name
-          model.class.paper_trail.version_class.joins(:version_associations).
-            where("version_associations.foreign_key_name = ?", assoc.foreign_key).
-            where("version_associations.foreign_key_id = ?", model.id).
+
+          version_ids = model.class.paper_trail.version_association_class.
+            joins(model.class.version_association_name).
+            where("foreign_key_name = ?", assoc.foreign_key).
+            where("foreign_key_id = ?", model.id).
             where("#{version_table_name}.item_type = ?", base_class_name).
             where("created_at >= ? OR transaction_id = ?", version_at, transaction_id).
-            order("#{version_table_name}.id ASC").
-            load
+            order("version_id ASC").
+            pluck("version_id")
+
+          model.class.paper_trail.version_class.find(version_ids)
         end
 
         # @api private

data/lib/paper_trail_association_tracking/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paper_trail-association_tracking
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.3.0
 platform: ruby
 authors:
 - Weston Ganger
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-29 00:00:00.000000000 Z
+date: 2025-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: paper_trail
@@ -26,48 +26,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '12.0'
-- !ruby/object:Gem::Dependency
-  name: appraisal
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: ffaker
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: generator_spec
   requirement: !ruby/object:Gem::Requirement
@@ -82,20 +40,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rack-test
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -124,20 +68,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -205,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.4.22
 signing_key:
 specification_version: 4
 summary: Plugin for the PaperTrail gem to track and reify associations