paper_trail-association_tracking 2.1.1 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c44254220614ad32a3f634a83c4c3a0d8e3c5aa5dd76521f09f702d03d0be1c
-  data.tar.gz: 9434f7aa8c162a2117d7c33890bdbd2df93729a343073e67ebc024537ee773ca
+  metadata.gz: 3b49b412d6cd431cd4310dadde716d334231225fed80e84c5d4d8696f42fcb0f
+  data.tar.gz: a77500b35d0f66a1840272b8efd9891ce876da341756fe47077cd1257e4f26b2
 SHA512:
-  metadata.gz: f5ee8734919969546148c2cb12add0ef77a6e0e0acec5137713974babdc05bb80be5d7321e41b636c74d3b3d4a3463d8e42ddc6b1d5d02f0affed0de0a024fc6
-  data.tar.gz: 3205666624b7f94acecca6dc56757e971ba1382b80bb9762c818f7f7935063adebb36e2ab8d3d3d0cb8216b6276042e7eda7f84658cb5e7d696242798503a3b7
+  metadata.gz: dff6c0eacc9cf46bb6ed00edbed900426ac3b842b7e5046bb9511422b44d78bb88782d7ffc4c4322c40e28426ee0cc2c3c4fdcd7630f0c0ca4b294dabaa9f815
+  data.tar.gz: 41c42f324a608af7c22d7b442827eedf15f4d6c79e0c023eb93adc99f177076a95b84c7dc18acdf8f8a3f0d3a9726378d542d18f02b8bc92a3a18092d9e792d2

data/CHANGELOG.md

@@ -1,8 +1,24 @@
 # CHANGELOG
 
-### Unreleased - [View Diff](https://github.com/westonganger/paper_trail-association_tracking/compare/v2.1.1...master)
+### Unreleased - [View Diff](https://github.com/westonganger/paper_trail-association_tracking/compare/v2.2.1...master)
+- Nothing yet 
 
-- Nothing yet
+### v2.2.1 - [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)
+
+- [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)
+
+- [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
+
+- A late night oopsies, Release yanked immediately, 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)
 

data/README.md

@@ -1,7 +1,7 @@
 # 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.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://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>
 
 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. 
@@ -23,14 +23,13 @@ It will store in the `version_associations` table additional information to corr
 - [Known Issues](#known-issues)
 - [Contributing](#contributing)
 - [Credits](#credits)
+- [Alternative Solution](#alternative-solution)
 
 
 # Install
 
 ```ruby
-# Gemfile
-
-gem 'paper_trail' # Minimum required version is v9.2.0
+gem 'paper_trail'
 gem 'paper_trail-association_tracking'
 ```
 
@@ -182,3 +181,9 @@ 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

@@ -17,9 +17,6 @@ Rake::TestTask.new(:test) do |t|
   t.libs << "test"
   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.
   t.warning = false
 end
 
@@ -27,7 +24,7 @@ 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 bit.ly/1nVq3Jn
+  t.verbose = false # hide list of specs
 end
 
 desc "Default: run all available test suites"

data/lib/paper_trail-association_tracking.rb

@@ -9,6 +9,14 @@ require "paper_trail_association_tracking/request"
 require "paper_trail_association_tracking/paper_trail"
 require "paper_trail_association_tracking/version_concern"
 
+if defined?(Rails)
+  require "paper_trail/frameworks/active_record"
+  require "paper_trail_association_tracking/frameworks/rails"
+elsif defined?(ActiveRecord)
+  require "paper_trail/frameworks/active_record"
+  require "paper_trail_association_tracking/frameworks/active_record"
+end
+
 module PaperTrailAssociationTracking
   def self.version
     VERSION
@@ -47,20 +55,4 @@ module PaperTrail
       prepend ::PaperTrailAssociationTracking::Request::ClassMethods
     end
   end
-
-  module VersionConcern
-    include ::PaperTrailAssociationTracking::VersionConcern
-  end
-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.
-  if defined?(::Rails.application)
-    require "paper_trail_association_tracking/frameworks/rails"
-  else
-    ::Kernel.warn('PaperTrail has been loaded too early, before rails is loaded. This can happen when another gem defines the ::Rails namespace, then PT is loaded, all before rails is loaded. You may want to reorder your Gemfile, or defer the loading of PT by using `require: false` and a manual require elsewhere.')
-  end
-else
-  require "paper_trail_association_tracking/frameworks/active_record"
 end

data/lib/paper_trail_association_tracking/frameworks/active_record.rb

@@ -1,5 +1,3 @@
 # frozen_string_literal: true
 
-# This file only needs to be loaded if the gem is being used outside of Rails,
-# since otherwise the model(s) will get loaded in via the `Rails::Engine`.
 require "paper_trail_association_tracking/frameworks/active_record/models/paper_trail/version_association"

data/lib/paper_trail_association_tracking/frameworks/rails/railtie.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module PaperTrailAssociationTracking
+  class Railtie < ::Rails::Railtie
+
+    initializer "paper_trail_association_tracking", after: "paper_trail" do
+      ActiveSupport.on_load(:active_record) do
+        require "paper_trail_association_tracking/frameworks/active_record"
+      end
+    end
+
+    config.to_prepare do
+      ::PaperTrail::Version.include(::PaperTrailAssociationTracking::VersionConcern)
+    end
+
+  end
+end

data/lib/paper_trail_association_tracking/frameworks/rails.rb

@@ -1,3 +1,3 @@
 # frozen_string_literal: true
 
-require "paper_trail_association_tracking/frameworks/rails/engine"
+require "paper_trail_association_tracking/frameworks/rails/railtie"

data/lib/paper_trail_association_tracking/model_config.rb

@@ -38,15 +38,34 @@ module PaperTrailAssociationTracking
       habtm_assocs_not_skipped.each(&method(:setup_habtm_change_callbacks))
     end
 
-    def setup_habtm_change_callbacks(assoc)
-      assoc_name = assoc.name
-      %w[add remove].each do |verb|
-        @model_class.send(:"before_#{verb}_for_#{assoc_name}").send(
-          :<<,
-          lambda do |*args|
-            update_habtm_state(assoc_name, :"before_#{verb}", args[-2], args.last)
-          end
-        )
+    def setup_habtm_change_callbacks(association)
+      association_name = association.name
+
+      if ActiveRecord::VERSION::MAJOR >= 7
+        ### https://github.com/westonganger/paper_trail-association_tracking/pull/37#issuecomment-1067146121
+
+        before_add_callback = lambda do |*args|
+          update_habtm_state(association_name, :before_add, args[-2], args.last)
+        end
+
+        before_remove_callback = lambda do |*args|
+          update_habtm_state(association_name, :before_remove, args[-2], args.last)
+        end
+
+        assoc_opts = association.options.merge(before_add: before_add_callback, before_remove: before_remove_callback)
+
+        association.instance_variable_set(:@options, **assoc_opts)
+
+        ::ActiveRecord::Associations::Builder::CollectionAssociation.send(:define_callbacks, @model_class, association)
+      else
+        %w[add remove].each do |verb|
+          @model_class.send("before_#{verb}_for_#{association_name}").send(
+            :<<,
+            lambda do |*args|
+              update_habtm_state(association_name, :"before_#{verb}", args[-2], args.last)
+            end
+          )
+        end
       end
     end
 

data/lib/paper_trail_association_tracking/reifiers/has_many.rb

@@ -94,12 +94,18 @@ 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)
+          # 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) as version_id").
             where("foreign_key_name = ?", assoc.foreign_key).
             where("foreign_key_id = ?", model.id).
-            where(foreign_type: [model.class.name, nil]).
+            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").

data/lib/paper_trail_association_tracking/reifiers/has_one.rb

@@ -56,9 +56,7 @@ module PaperTrailAssociationTracking
           if options[:mark_for_destruction]
             model.send(assoc.name).mark_for_destruction if model.send(assoc.name, true)
           else
-            model.paper_trail.appear_as_new_record do
-              model.send "#{assoc.name}=", nil
-            end
+            model.association(assoc.name).target = nil
           end
         end
 

data/lib/paper_trail_association_tracking/version.rb

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

data/lib/paper_trail_association_tracking/version_concern.rb

@@ -1,10 +1,6 @@
 # frozen_string_literal: true
 
 module PaperTrailAssociationTracking
-  # Originally, PaperTrail did not provide this module, and all of this
-  # functionality was in `PaperTrail::Version`. That model still exists (and is
-  # used by most apps) but by moving the functionality to this module, people
-  # can include this concern instead of sub-classing the `Version` model.
   module VersionConcern
     extend ::ActiveSupport::Concern
 
@@ -16,22 +12,7 @@ module PaperTrailAssociationTracking
         has_many :version_associations, dependent: :destroy
       end
 
-      scope(:within_transaction, ->(id) { where transaction_id: id })
+      scope :within_transaction, ->(id) { where(transaction_id: id) }
     end
-
-    # Restore the item from this version.
-    #
-    # In addition to the options provided by PaperTrail core. This Plugin provides the following Options:
-    #
-    # - :has_one
-    #   - `true` - Also reify has_one associations.
-    #   - `false - Default.
-    # - :has_many
-    #   - `true` - Also reify has_many and has_many :through associations.
-    #   - `false` - Default.
-    #
-    #def reify(options = {})
-    #  super
-    #end
   end
 end

metadata

@@ -1,47 +1,33 @@
 --- !ruby/object:Gem::Specification
 name: paper_trail-association_tracking
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.2.1
 platform: ruby
 authors:
 - Weston Ganger
 - Jared Beck
 - Ben Atkins
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-22 00:00:00.000000000 Z
+date: 2022-03-29 00:00:00.000000000 Z
 dependencies:
 - !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
+  name: paper_trail
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '12.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
-  name: ffaker
+  name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -55,7 +41,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: generator_spec
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -69,7 +55,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: mysql2
+  name: ffaker
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -83,7 +69,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pg
+  name: generator_spec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -186,8 +172,7 @@ files:
 - lib/paper_trail_association_tracking/frameworks/active_record.rb
 - lib/paper_trail_association_tracking/frameworks/active_record/models/paper_trail/version_association.rb
 - lib/paper_trail_association_tracking/frameworks/rails.rb
-- lib/paper_trail_association_tracking/frameworks/rails/engine.rb
-- lib/paper_trail_association_tracking/frameworks/rspec.rb
+- lib/paper_trail_association_tracking/frameworks/rails/railtie.rb
 - lib/paper_trail_association_tracking/model_config.rb
 - lib/paper_trail_association_tracking/paper_trail.rb
 - lib/paper_trail_association_tracking/record_trail.rb
@@ -205,7 +190,7 @@ homepage: https://github.com/westonganger/paper_trail-association_tracking
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -213,15 +198,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.32
+signing_key:
 specification_version: 4
 summary: Plugin for the PaperTrail gem to track and reify associations
 test_files: []

data/lib/paper_trail_association_tracking/frameworks/rails/engine.rb

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-module PaperTrailAssociationTracking
-  module Rails
-    # See http://guides.rubyonrails.org/engines.html
-    class Engine < ::Rails::Engine
-      paths["app/models"] << "lib/paper_trail_association_tracking/frameworks/active_record/models"
-    end
-  end
-end

data/lib/paper_trail_association_tracking/frameworks/rspec.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-require "rspec/core"
-require "rspec/matchers"
-
-RSpec::Matchers.define :have_a_version_with do |attributes|
-  # check if the model has a version with the specified attributes
-  match do |actual|
-    versions_association = actual.class.versions_association_name
-    actual.send(versions_association).where_object(attributes).any?
-  end
-end
-
-RSpec::Matchers.define :have_a_version_with_changes do |attributes|
-  # check if the model has a version changes with the specified attributes
-  match do |actual|
-    versions_association = actual.class.versions_association_name
-    actual.send(versions_association).where_object_changes(attributes).any?
-  end
-end