RubyGems - paper_trail-association_tracking - Versions diffs - 2.1.3 → 2.2.0 - Mend

paper_trail-association_tracking 2.1.3 → 2.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (14) hide show

checksums.yaml +4 -4
data/CHANGELOG.md +8 -4
data/README.md +16 -4
data/Rakefile +1 -4
data/lib/paper_trail-association_tracking.rb +8 -16
data/lib/paper_trail_association_tracking/frameworks/active_record.rb +0 -2
data/lib/paper_trail_association_tracking/frameworks/rails/railtie.rb +17 -0
data/lib/paper_trail_association_tracking/frameworks/rails.rb +1 -1
data/lib/paper_trail_association_tracking/model_config.rb +28 -9
data/lib/paper_trail_association_tracking/version.rb +1 -1
data/lib/paper_trail_association_tracking/version_concern.rb +1 -20
metadata +10 -39
data/lib/paper_trail_association_tracking/frameworks/rails/engine.rb +0 -10
data/lib/paper_trail_association_tracking/frameworks/rspec.rb +0 -20

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51f0ba0d9f3c256f374002822d5f7e88444b6be465dd2189c8107d90160ed457
-  data.tar.gz: 046c163be73401cc97d593b48fc8a6fb91e09480303c6ab00df3f7818fc25ddd
+  metadata.gz: 9af07695b14d97e4ca838054a2764188521584545338887289e9c56f91cdb22b
+  data.tar.gz: cb80d2ce702c4d2178cbd82c3191a3b9a81a72e7d7349447fe517b21d65e6e6b
 SHA512:
-  metadata.gz: d0e720740047a827254138caa7d8019d2ca29f5a4ee1a53fd7cc51f93d8a04998f2c8f661415840bc379f4196673347e35656f18fc2c70d14809fd47b9532f6b
-  data.tar.gz: dd3e7ecc22c067f5f60fe0fd1d21a7997bb91e62ed39955ac2a337cce83071617d93c2f49ec70f0a6de96c37efe6625041a4b0e3e2c57739c7b2ef30bbe135c9
+  metadata.gz: 2723be9c0afe1f2ffcdec97638ac073a7074ece8d78a67f42a8fe986fa56533e4a9d8306293cd7df1eedde7bfbee5dd3aa29990fb273db41f5dae9cc4a4b4d70
+  data.tar.gz: 27a332d6d0a2aa9b810f2c493f9b48f4c4567b9e8ca1280a64e25206771168ad9982f99c75a6b53cfa1d20a670c2e3f395c16cf30bdab3fafa39f2d2ef2cec51

data/CHANGELOG.md CHANGED Viewed

@@ -1,17 +1,21 @@
 # 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.0...master)
 - Nothing yet
+### 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
-- Last version that is compatible with `paper_trail` due to the change in the loading mechanism
 ### 2.1.2
-- Release yanked, had bug preventing installation
+- 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 CHANGED Viewed

@@ -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,17 +23,23 @@ 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'
 ```
+For PT v9.2 to v11.x you must use PT-AT v2
+```ruby
+gem 'paper_trail'#, ">=9.2.0", "< 12.0"
+gem 'paper_trail-association_tracking', "<= 2.1.3"
+```
 Then run `rails generate paper_trail_association_tracking:install` which will do the following two things for you:
 1. Create a `version_associations` table
@@ -182,3 +188,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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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 ADDED Viewed

@@ -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 CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -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/version.rb CHANGED Viewed

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

data/lib/paper_trail_association_tracking/version_concern.rb CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: paper_trail-association_tracking
 version: !ruby/object:Gem::Version
-  version: 2.1.3
+  version: 2.2.0
 platform: ruby
 authors:
 - Weston Ganger
 - Jared Beck
 - Ben Atkins
-autorequire:
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-20 00:00:00.000000000 Z
+date: 2022-03-15 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
@@ -82,34 +82,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: mysql2
-  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: pg
-  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: rack-test
   requirement: !ruby/object:Gem::Requirement
@@ -200,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
@@ -219,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
@@ -227,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 DELETED Viewed

@@ -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 DELETED Viewed

@@ -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