paper_trail 9.1.1 → 9.2.0

data/lib/paper_trail/reifier.rb

@@ -1,11 +1,6 @@
 # frozen_string_literal: true
 
 require "paper_trail/attribute_serializers/object_attribute"
-require "paper_trail/reifiers/belongs_to"
-require "paper_trail/reifiers/has_and_belongs_to_many"
-require "paper_trail/reifiers/has_many"
-require "paper_trail/reifiers/has_many_through"
-require "paper_trail/reifiers/has_one"
 
 module PaperTrail
   # Given a version record and some options, builds a new model object.
@@ -20,22 +15,9 @@ module PaperTrail
         model = init_model(attrs, options, version)
         reify_attributes(model, version, attrs)
         model.send "#{model.class.version_association_name}=", version
-        reify_associations(model, options, version)
         model
       end
 
-      # Restore the `model`'s has_many associations as they were at version_at
-      # timestamp We lookup the first child versions after version_at timestamp or
-      # in same transaction.
-      # @api private
-      def reify_has_manys(transaction_id, model, options = {})
-        assoc_has_many_through, assoc_has_many_directly =
-          model.class.reflect_on_all_associations(:has_many).
-            partition { |assoc| assoc.options[:through] }
-        reify_has_many_associations(transaction_id, assoc_has_many_directly, model, options)
-        reify_has_many_through_associations(transaction_id, assoc_has_many_through, model, options)
-      end
-
       private
 
       # Given a hash of `options` for `.reify`, return a new hash with default
@@ -53,14 +35,6 @@ module PaperTrail
         }.merge(options)
       end
 
-      # @api private
-      def each_enabled_association(associations)
-        associations.each do |assoc|
-          next unless ::PaperTrail.request.enabled_for_model?(assoc.klass)
-          yield assoc
-        end
-      end
-
       # Initialize a model object suitable for reifying `version` into. Does
       # not perform reification, merely instantiates the appropriate model
       # class and, if specified by `options[:unversioned_attributes]`, sets
@@ -136,70 +110,6 @@ module PaperTrail
         end
       end
 
-      # @api private
-      def reify_associations(model, options, version)
-        if options[:has_one]
-          reify_has_one_associations(version.transaction_id, model, options)
-        end
-        if options[:belongs_to]
-          reify_belongs_to_associations(version.transaction_id, model, options)
-        end
-        if options[:has_many]
-          reify_has_manys(version.transaction_id, model, options)
-        end
-        if options[:has_and_belongs_to_many]
-          reify_habtm_associations version.transaction_id, model, options
-        end
-      end
-
-      # Restore the `model`'s has_one associations as they were when this
-      # version was superseded by the next (because that's what the user was
-      # looking at when they made the change).
-      # @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|
-          Reifiers::HasOne.reify(assoc, model, options, transaction_id)
-        end
-      end
-
-      # Reify all `belongs_to` associations of `model`.
-      # @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|
-          Reifiers::BelongsTo.reify(assoc, model, options, transaction_id)
-        end
-      end
-
-      # Reify all direct (not `through`) `has_many` associations of `model`.
-      # @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|
-          Reifiers::HasMany.reify(assoc, model, options, transaction_id, version_table_name)
-        end
-      end
-
-      # Reify all HMT associations of `model`. This must be called after the
-      # 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|
-          Reifiers::HasManyThrough.reify(assoc, model, options, transaction_id)
-        end
-      end
-
-      # Reify all HABTM associations of `model`.
-      # @api private
-      def reify_habtm_associations(transaction_id, model, options = {})
-        model.class.reflect_on_all_associations(:has_and_belongs_to_many).each do |assoc|
-          pt_enabled = ::PaperTrail.request.enabled_for_model?(assoc.klass)
-          next unless model.class.paper_trail_save_join_tables.include?(assoc.name) || pt_enabled
-          Reifiers::HasAndBelongsToMany.reify(pt_enabled, assoc, model, options, transaction_id)
-        end
-      end
-
       # Given a `version`, return the class to reify. This method supports
       # Single Table Inheritance (STI) with custom inheritance columns.
       #

data/lib/paper_trail/request.rb

@@ -16,11 +16,6 @@ module PaperTrail
     end
 
     class << self
-      # @api private
-      def clear_transaction_id
-        self.transaction_id = nil
-      end
-
       # Sets any data from the controller that you want PaperTrail to store.
       # See also `PaperTrail::Rails::Controller#info_for_paper_trail`.
       #
@@ -105,16 +100,6 @@ module PaperTrail
         store.deep_dup
       end
 
-      # @api private
-      def transaction_id
-        store[:transaction_id]
-      end
-
-      # @api private
-      def transaction_id=(id)
-        store[:transaction_id] = id
-      end
-
       # Temporarily set `options` and execute a block.
       # @api private
       def with(options)
@@ -171,8 +156,6 @@ module PaperTrail
               :enabled,
               :whodunnit
             next
-          when :transaction_id
-            raise InvalidOption, "Cannot set private option: #{k}"
           else
             raise InvalidOption, "Invalid option: #{k}"
           end

data/lib/paper_trail/version_concern.rb

@@ -19,17 +19,8 @@ module PaperTrail
         belongs_to :item, polymorphic: true
       end
 
-      # Since the test suite has test coverage for this, we want to declare
-      # the association when the test suite is running. This makes it pass when
-      # DB is not initialized prior to test runs such as when we run on Travis
-      # CI (there won't be a db in `spec/dummy_app/db/`).
-      if PaperTrail.config.track_associations?
-        has_many :version_associations, dependent: :destroy
-      end
-
       validates_presence_of :event
       after_create :enforce_version_limit!
-      scope(:within_transaction, ->(id) { where transaction_id: id })
     end
 
     # :nodoc:
@@ -265,6 +256,10 @@ module PaperTrail
 
     # @api private
     def load_changeset
+      if PaperTrail.config.object_changes_adapter
+        return PaperTrail.config.object_changes_adapter.load_changeset(self)
+      end
+
       # First, deserialize the `object_changes` column.
       changes = HashWithIndifferentAccess.new(object_changes_deserialized)
 

data/lib/paper_trail/version_number.rb

@@ -8,8 +8,8 @@ module PaperTrail
   # People are encouraged to use `PaperTrail.gem_version` instead.
   module VERSION
     MAJOR = 9
-    MINOR = 1
-    TINY = 1
+    MINOR = 2
+    TINY = 0
 
     # Set PRE to nil unless it's a pre-release (beta, rc, etc.)
     PRE = nil

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paper_trail
 version: !ruby/object:Gem::Version
-  version: 9.1.1
+  version: 9.2.0
 platform: ruby
 authors:
 - Andy Stewart
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-30 00:00:00.000000000 Z
+date: 2018-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -32,6 +32,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '5.3'
+- !ruby/object:Gem::Dependency
+  name: paper_trail-association_tracking
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: request_store
   requirement: !ruby/object:Gem::Requirement
@@ -212,8 +226,6 @@ files:
 - lib/generators/paper_trail/USAGE
 - lib/generators/paper_trail/install_generator.rb
 - lib/generators/paper_trail/templates/add_object_changes_to_versions.rb.erb
-- lib/generators/paper_trail/templates/add_transaction_id_column_to_versions.rb.erb
-- lib/generators/paper_trail/templates/create_version_associations.rb.erb
 - lib/generators/paper_trail/templates/create_versions.rb.erb
 - lib/paper_trail.rb
 - lib/paper_trail/attribute_serializers/README.md
@@ -225,7 +237,6 @@ files:
 - lib/paper_trail/config.rb
 - lib/paper_trail/frameworks/active_record.rb
 - lib/paper_trail/frameworks/active_record/models/paper_trail/version.rb
-- lib/paper_trail/frameworks/active_record/models/paper_trail/version_association.rb
 - lib/paper_trail/frameworks/cucumber.rb
 - lib/paper_trail/frameworks/rails.rb
 - lib/paper_trail/frameworks/rails/controller.rb
@@ -239,16 +250,10 @@ files:
 - lib/paper_trail/record_history.rb
 - lib/paper_trail/record_trail.rb
 - lib/paper_trail/reifier.rb
-- lib/paper_trail/reifiers/belongs_to.rb
-- lib/paper_trail/reifiers/has_and_belongs_to_many.rb
-- lib/paper_trail/reifiers/has_many.rb
-- lib/paper_trail/reifiers/has_many_through.rb
-- lib/paper_trail/reifiers/has_one.rb
 - lib/paper_trail/request.rb
 - lib/paper_trail/serializers/json.rb
 - lib/paper_trail/serializers/yaml.rb
 - lib/paper_trail/type_serializers/postgres_array_serializer.rb
-- lib/paper_trail/version_association_concern.rb
 - lib/paper_trail/version_concern.rb
 - lib/paper_trail/version_number.rb
 homepage: https://github.com/paper-trail-gem/paper_trail

data/lib/generators/paper_trail/templates/add_transaction_id_column_to_versions.rb.erb

@@ -1,13 +0,0 @@
-# This migration and CreateVersionAssociations provide the necessary
-# schema for tracking associations.
-class AddTransactionIdColumnToVersions < ActiveRecord::Migration<%= migration_version %>
-  def self.up
-    add_column :versions, :transaction_id, :integer
-    add_index :versions, [:transaction_id]
-  end
-
-  def self.down
-    remove_index :versions, [:transaction_id]
-    remove_column :versions, :transaction_id
-  end
-end

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

@@ -1,22 +0,0 @@
-# This migration and AddTransactionIdColumnToVersions provide the necessary
-# schema for tracking associations.
-class CreateVersionAssociations < ActiveRecord::Migration<%= migration_version %>
-  def self.up
-    create_table :version_associations do |t|
-      t.integer  :version_id
-      t.string   :foreign_key_name, null: false
-      t.integer  :foreign_key_id
-    end
-    add_index :version_associations, [:version_id]
-    add_index :version_associations,
-      %i(foreign_key_name foreign_key_id),
-      name: "index_version_associations_on_foreign_key"
-  end
-
-  def self.down
-    remove_index :version_associations, [:version_id]
-    remove_index :version_associations,
-      name: "index_version_associations_on_foreign_key"
-    drop_table :version_associations
-  end
-end

data/lib/paper_trail/frameworks/active_record/models/paper_trail/version_association.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-require "paper_trail/version_association_concern"
-
-module PaperTrail
-  # This is the default ActiveRecord model provided by PaperTrail. Most simple
-  # applications will only use this and its partner, `Version`, but it is
-  # possible to sub-class, extend, or even do without this model entirely.
-  # See the readme for details.
-  class VersionAssociation < ::ActiveRecord::Base
-    include PaperTrail::VersionAssociationConcern
-  end
-end

data/lib/paper_trail/reifiers/belongs_to.rb

@@ -1,50 +0,0 @@
-# frozen_string_literal: true
-
-module PaperTrail
-  module Reifiers
-    # Reify a single `belongs_to` association of `model`.
-    # @api private
-    module BelongsTo
-      class << self
-        # @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)
-          model.send("#{assoc.name}=".to_sym, record)
-        end
-
-        private
-
-        # 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)
-          if version.nil?
-            assoc.klass.where(assoc.klass.primary_key => id).first
-          else
-            version.reify(
-              options.merge(
-                has_many: false,
-                has_one: false,
-                belongs_to: false,
-                has_and_belongs_to_many: false
-              )
-            )
-          end
-        end
-
-        # 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).
-            where("item_id = ?", id).
-            where("created_at >= ? OR transaction_id = ?", version_at, transaction_id).
-            order("id").limit(1).first
-        end
-      end
-    end
-  end
-end

data/lib/paper_trail/reifiers/has_and_belongs_to_many.rb

@@ -1,52 +0,0 @@
-# frozen_string_literal: true
-
-module PaperTrail
-  module Reifiers
-    # Reify a single HABTM association of `model`.
-    # @api private
-    module HasAndBelongsToMany
-      class << self
-        # @api private
-        def reify(pt_enabled, assoc, model, options, transaction_id)
-          version_ids = ::PaperTrail::VersionAssociation.
-            where("foreign_key_name = ?", assoc.name).
-            where("version_id = ?", transaction_id).
-            pluck(:foreign_key_id)
-
-          model.send(assoc.name).proxy_association.target =
-            version_ids.map do |id|
-              if pt_enabled
-                version = load_version(assoc, id, transaction_id, options[:version_at])
-                if version
-                  next version.reify(
-                    options.merge(
-                      has_many: false,
-                      has_one: false,
-                      belongs_to: false,
-                      has_and_belongs_to_many: false
-                    )
-                  )
-                end
-              end
-              assoc.klass.where(assoc.klass.primary_key => id).first
-            end
-        end
-
-        private
-
-        # Given a HABTM association `assoc` 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).
-            where("item_id = ?", id).
-            where("created_at >= ? OR transaction_id = ?", version_at, transaction_id).
-            order("id").
-            limit(1).
-            first
-        end
-      end
-    end
-  end
-end

data/lib/paper_trail/reifiers/has_many.rb

@@ -1,112 +0,0 @@
-# frozen_string_literal: true
-
-module PaperTrail
-  module Reifiers
-    # Reify a single, direct (not `through`) `has_many` association of `model`.
-    # @api private
-    module HasMany
-      class << self
-        # @api private
-        def reify(assoc, model, options, transaction_id, version_table_name)
-          versions = load_versions_for_hm_association(
-            assoc,
-            model,
-            version_table_name,
-            transaction_id,
-            options[:version_at]
-          )
-          collection = Array.new model.send(assoc.name).reload # to avoid cache
-          prepare_array(collection, options, versions)
-          model.send(assoc.name).proxy_association.target = collection
-        end
-
-        # Replaces each record in `array` with its reified version, if present
-        # in `versions`.
-        #
-        # @api private
-        # @param array - The collection to be modified.
-        # @param options
-        # @param versions - A `Hash` mapping IDs to `Version`s
-        # @return nil - Always returns `nil`
-        #
-        # Once modified by this method, `array` will be assigned to the
-        # AR association currently being reified.
-        #
-        def prepare_array(array, options, versions)
-          # Iterate each child to replace it with the previous value if there is
-          # a version after the timestamp.
-          array.map! do |record|
-            if (version = versions.delete(record.id)).nil?
-              record
-            elsif version.event == "create"
-              options[:mark_for_destruction] ? record.tap(&:mark_for_destruction) : nil
-            else
-              version.reify(
-                options.merge(
-                  has_many: false,
-                  has_one: false,
-                  belongs_to: false,
-                  has_and_belongs_to_many: false
-                )
-              )
-            end
-          end
-
-          # Reify the rest of the versions and add them to the collection, these
-          # versions are for those that have been removed from the live
-          # associations.
-          array.concat(
-            versions.values.map { |v|
-              v.reify(
-                options.merge(
-                  has_many: false,
-                  has_one: false,
-                  belongs_to: false,
-                  has_and_belongs_to_many: false
-                )
-              )
-            }
-          )
-
-          array.compact!
-
-          nil
-        end
-
-        # Given a SQL fragment that identifies the IDs of version records,
-        # returns a `Hash` mapping those IDs to `Version`s.
-        #
-        # @api private
-        # @param klass - An ActiveRecord class.
-        # @param version_id_subquery - String. A SQL subquery that selects
-        #   the IDs of version records.
-        # @return A `Hash` mapping IDs to `Version`s
-        #
-        def versions_by_id(klass, version_id_subquery)
-          klass.
-            paper_trail.version_class.
-            where("id IN (#{version_id_subquery})").
-            inject({}) { |a, e| a.merge!(e.item_id => e) }
-        end
-
-        private
-
-        # Given a `has_many` association on `model`, return the version records
-        # 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.
-            joins(model.class.version_association_name).
-            select("MIN(version_id)").
-            where("foreign_key_name = ?", assoc.foreign_key).
-            where("foreign_key_id = ?", model.id).
-            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)
-        end
-      end
-    end
-  end
-end