paper_trail-association_tracking 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e55c15952e70d133273bb7e64458a3064124070c64228667ec1e160f6b0213a2
-  data.tar.gz: 755381e69ab58abb9d7167040ad237f384e2cd7c940c15b72c4d7da9454432a6
+  metadata.gz: 844d3ff1eb96a7bae834ad57625e2fb87cf37ebbea76bd489621a31c2a57d6f7
+  data.tar.gz: 0cd147df0a5ee52494abcda09e0fc44c10ebae176cc567a3659debb7533ad72c
 SHA512:
-  metadata.gz: 80e0609842fb80eed4e07e57e568d79a4721fcd09d510d6b5033338570963b8989026e96c97e5647599b613a1f0639db6d2211612d41898d349ccd4a3de548e3
-  data.tar.gz: 991d02c97096a303e445f166a49d0110dda689781ef9bd3f3fcb85083b6d79503e6988e6499e1d873e67345a06265ce5695b92ef30b983bc2627d7aaf72fccbb
+  metadata.gz: b49a595381d282b2ace65a18405921fba2970a22dde79841b5b7e42d148392b37caac9323136721cbebb9e0f0b74962d333e38883f923a934bb599b54dcf967a
+  data.tar.gz: '0180dff00868dfb4e49be3722df2210c630aa1550cf2963714d445f1b0c7d4eadfc96db258bcf88b4554949720821a33f3f00178b2ee4aeb61c52c26238de047'

data/CHANGELOG.md

@@ -1,8 +1,14 @@
 # CHANGELOG
 
-This project follows [semver 2.0.0](http://semver.org/spec/v2.0.0.html) and 
-the recommendations of [keepachangelog.com](http://keepachangelog.com/).
+## Unreleased
 
-## 1.0.0
+- None
+
+## 1.1.0 - 2018-12-28
+
+- [#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.
+
+## 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,6 +1,8 @@
 # PaperTrail-AssociationTracking
 
-[![Build Status][1]][2]
+<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://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.
 
@@ -43,9 +45,8 @@ Has-Many-Through. In order to do this, you will need to do two things:
 1. Create a `version_associations` table
 2. Set `PaperTrail.config.track_associations = true` (e.g. in an initializer)
 
-Both will be done for you automatically if you install PaperTrail with the
-`--with_associations` option
-(e.g. `rails generate paper_trail:install --with-associations`)
+
+Both will be done for you automatically if you run the PaperTrail-AssociationTracking generator (e.g. `rails generate paper_trail_association_tracking:install`)
 
 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
@@ -242,6 +243,3 @@ Plugin authored by [Weston Ganger](https://github.com/westonganger) & Jared Beck
 Maintained by [Weston Ganger](https://github.com/westonganger) & [Jared Beck](https://github.com/jaredbeck) 
 
 Associations code originally contributed by Ben Atkins, Jared Beck, Andy Stewart & more
-
-[1]: https://api.travis-ci.org/westonganger/paper_trail-association_tracking.svg?branch=master
-[2]: https://travis-ci.org/westonganger/paper_trail-association_tracking

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

@@ -6,10 +6,11 @@ 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
     end
     add_index :version_associations, [:version_id]
     add_index :version_associations,
-      %i(foreign_key_name foreign_key_id),
+      %i(foreign_key_name foreign_key_id foreign_type),
       name: "index_version_associations_on_foreign_key"
   end
 

data/lib/paper_trail_association_tracking/record_trail.rb

@@ -136,7 +136,8 @@ module PaperTrailAssociationTracking
           ::PaperTrail::VersionAssociation.create(
             version_id: version.transaction_id,
             foreign_key_name: a.name,
-            foreign_key_id: id
+            foreign_key_id: id,
+            foreign_type: a.klass
           )
         end
       end
@@ -168,12 +169,14 @@ module PaperTrailAssociationTracking
       }
 
       if assoc.options[:polymorphic]
-        associated_record = @record.send(assoc.name) if @record.send(assoc.foreign_type)
-        if associated_record && ::PaperTrail.request.enabled_for_model?(associated_record.class)
-          assoc_version_args[:foreign_key_id] = associated_record.id
+        foreign_type = @record.send(assoc.foreign_type)
+        if foreign_type && ::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
       elsif ::PaperTrail.request.enabled_for_model?(assoc.klass)
         assoc_version_args[:foreign_key_id] = @record.send(assoc.foreign_key)
+        assoc_version_args[:foreign_type] = assoc.klass
       end
 
       if assoc_version_args.key?(:foreign_key_id)

data/lib/paper_trail_association_tracking/reifier.rb

@@ -50,9 +50,11 @@ module PaperTrailAssociationTracking
       end
 
       # @api private
-      def each_enabled_association(associations)
+      def each_enabled_association(associations, model)
         associations.each do |assoc|
-          next unless ::PaperTrail.request.enabled_for_model?(assoc.klass)
+          assoc_klass = assoc.polymorphic? ?
+                          model.send(assoc.foreign_type).constantize : assoc.klass
+          next unless ::PaperTrail.request.enabled_for_model?(assoc_klass)
           yield assoc
         end
       end
@@ -79,7 +81,7 @@ module PaperTrailAssociationTracking
       # @api private
       def reify_has_one_associations(transaction_id, model, options = {})
         associations = model.class.reflect_on_all_associations(:has_one)
-        each_enabled_association(associations) do |assoc|
+        each_enabled_association(associations, model) do |assoc|
           ::PaperTrailAssociationTracking::Reifiers::HasOne.reify(assoc, model, options, transaction_id)
         end
       end
@@ -88,7 +90,7 @@ module PaperTrailAssociationTracking
       # @api private
       def reify_belongs_to_associations(transaction_id, model, options = {})
         associations = model.class.reflect_on_all_associations(:belongs_to)
-        each_enabled_association(associations) do |assoc|
+        each_enabled_association(associations, model) do |assoc|
           ::PaperTrailAssociationTracking::Reifiers::BelongsTo.reify(assoc, model, options, transaction_id)
         end
       end
@@ -97,7 +99,7 @@ module PaperTrailAssociationTracking
       # @api private
       def reify_has_many_associations(transaction_id, associations, model, options = {})
         version_table_name = model.class.paper_trail.version_class.table_name
-        each_enabled_association(associations) do |assoc|
+        each_enabled_association(associations, model) do |assoc|
           ::PaperTrailAssociationTracking::Reifiers::HasMany.reify(assoc, model, options, transaction_id, version_table_name)
         end
       end
@@ -106,7 +108,7 @@ module PaperTrailAssociationTracking
       # direct (non-`through`) has_manys have been reified.
       # @api private
       def reify_has_many_through_associations(transaction_id, associations, model, options = {})
-        each_enabled_association(associations) do |assoc|
+        each_enabled_association(associations, model) do |assoc|
           ::PaperTrailAssociationTracking::Reifiers::HasManyThrough.reify(assoc, model, options, transaction_id)
         end
       end

data/lib/paper_trail_association_tracking/reifiers/belongs_to.rb

@@ -9,8 +9,10 @@ module PaperTrailAssociationTracking
         # @api private
         def reify(assoc, model, options, transaction_id)
           id = model.send(assoc.foreign_key)
-          version = load_version(assoc, id, transaction_id, options[:version_at])
-          record = load_record(assoc, id, options, version)
+          klass = assoc.polymorphic? ?
+                    model.send(assoc.foreign_type).constantize : assoc.klass
+          version = load_version(klass, id, transaction_id, options[:version_at])
+          record = load_record(klass, id, options, version)
           model.send("#{assoc.name}=".to_sym, record)
         end
 
@@ -19,9 +21,9 @@ module PaperTrailAssociationTracking
         # Given a `belongs_to` association and a `version`, return a record that
         # can be assigned in order to reify that association.
         # @api private
-        def load_record(assoc, id, options, version)
+        def load_record(assoc_klass, id, options, version)
           if version.nil?
-            assoc.klass.where(assoc.klass.primary_key => id).first
+            assoc_klass.where(assoc_klass.primary_key => id).first
           else
             version.reify(
               options.merge(
@@ -37,9 +39,9 @@ module PaperTrailAssociationTracking
         # Given a `belongs_to` association and an `id`, return a version record
         # from the point in time identified by `transaction_id` or `version_at`.
         # @api private
-        def load_version(assoc, id, transaction_id, version_at)
-          assoc.klass.paper_trail.version_class.
-            where("item_type = ?", assoc.klass.base_class.name).
+        def load_version(assoc_klass, id, transaction_id, version_at)
+          assoc_klass.paper_trail.version_class.
+            where("item_type = ?", assoc_klass.base_class.name).
             where("item_id = ?", id).
             where("created_at >= ? OR transaction_id = ?", version_at, transaction_id).
             order("id").limit(1).first

data/lib/paper_trail_association_tracking/reifiers/has_many.rb

@@ -100,6 +100,7 @@ module PaperTrailAssociationTracking
             select("MIN(version_id)").
             where("foreign_key_name = ?", assoc.foreign_key).
             where("foreign_key_id = ?", model.id).
+            where("foreign_type = ?", model.class.name).
             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/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paper_trail-association_tracking
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Weston Ganger
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-05 00:00:00.000000000 Z
+date: 2018-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appraisal
@@ -252,8 +252,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Plugin for the PaperTrail gem to track and reify associations