paper_trail 9.2.0 → 14.0.0

data/lib/paper_trail.rb

@@ -8,33 +8,24 @@
 # can revisit this decision.
 require "active_support/all"
 
-# AR is required for, eg. has_paper_trail.rb, so we could put this `require` in
-# all of those files, but it seems easier to troubleshoot if we just make sure
-# AR is loaded here before loading *any* of PT. See discussion of
-# performance/simplicity tradeoff for activesupport above.
-require "active_record"
+# We used to `require "active_record"` here, but that was [replaced with a
+# Railtie](https://github.com/paper-trail-gem/paper_trail/pull/1281) in PT 12.
+# As a result, we cannot reference `ActiveRecord` in this file (ie. until our
+# Railtie has loaded). If we did, it would cause [problems with non-Rails
+# projects](https://github.com/paper-trail-gem/paper_trail/pull/1401).
 
-require "request_store"
+require "paper_trail/errors"
 require "paper_trail/cleaner"
+require "paper_trail/compatibility"
 require "paper_trail/config"
-require "paper_trail/has_paper_trail"
 require "paper_trail/record_history"
-require "paper_trail/reifier"
 require "paper_trail/request"
-require "paper_trail/version_concern"
 require "paper_trail/version_number"
 require "paper_trail/serializers/json"
-require "paper_trail/serializers/yaml"
 
 # An ActiveRecord extension that tracks changes to your models, for auditing or
 # versioning.
 module PaperTrail
-  E_RAILS_NOT_LOADED = <<-EOS.squish.freeze
-    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.
-  EOS
   E_TIMESTAMP_FIELD_CONFIG = <<-EOS.squish.freeze
     PaperTrail.timestamp_field= has been removed, without replacement. It is no
     longer configurable. The timestamp column in the versions table must now be
@@ -57,46 +48,6 @@ module PaperTrail
       !!PaperTrail.config.enabled
     end
 
-    # @deprecated
-    def enabled_for_controller=(value)
-      ::ActiveSupport::Deprecation.warn(
-        "PaperTrail.enabled_for_controller= is deprecated, " \
-        "use PaperTrail.request.enabled=",
-        caller(1)
-      )
-      request.enabled = value
-    end
-
-    # @deprecated
-    def enabled_for_controller?
-      ::ActiveSupport::Deprecation.warn(
-        "PaperTrail.enabled_for_controller? is deprecated, " \
-        "use PaperTrail.request.enabled?",
-        caller(1)
-      )
-      request.enabled?
-    end
-
-    # @deprecated
-    def enabled_for_model(model, value)
-      ::ActiveSupport::Deprecation.warn(
-        "PaperTrail.enabled_for_model is deprecated, " \
-        "use PaperTrail.request.enabled_for_model",
-        caller(1)
-      )
-      request.enabled_for_model(model, value)
-    end
-
-    # @deprecated
-    def enabled_for_model?(model)
-      ::ActiveSupport::Deprecation.warn(
-        "PaperTrail.enabled_for_model? is deprecated, " \
-        "use PaperTrail.request.enabled_for_model?",
-        caller(1)
-      )
-      request.enabled_for_model?(model)
-    end
-
     # Returns PaperTrail's `::Gem::Version`, convenient for comparisons. This is
     # recommended over `::PaperTrail::VERSION::STRING`.
     #
@@ -124,7 +75,7 @@ module PaperTrail
     #
     # @api public
     def request(options = nil, &block)
-      if options.nil? && !block_given?
+      if options.nil? && !block
         Request
       else
         Request.with(options, &block)
@@ -134,54 +85,7 @@ module PaperTrail
     # Set the field which records when a version was created.
     # @api public
     def timestamp_field=(_field_name)
-      raise(E_TIMESTAMP_FIELD_CONFIG)
-    end
-
-    # @deprecated
-    def whodunnit=(value)
-      ::ActiveSupport::Deprecation.warn(
-        "PaperTrail.whodunnit= is deprecated, use PaperTrail.request.whodunnit=",
-        caller(1)
-      )
-      request.whodunnit = value
-    end
-
-    # @deprecated
-    def whodunnit(value = nil, &block)
-      if value.nil?
-        ::ActiveSupport::Deprecation.warn(
-          "PaperTrail.whodunnit is deprecated, use PaperTrail.request.whodunnit",
-          caller(1)
-        )
-        request.whodunnit
-      elsif block_given?
-        ::ActiveSupport::Deprecation.warn(
-          "Passing a block to PaperTrail.whodunnit is deprecated, " \
-          'use PaperTrail.request(whodunnit: "John") do .. end',
-          caller(1)
-        )
-        request(whodunnit: value, &block)
-      else
-        raise ArgumentError, "Invalid arguments"
-      end
-    end
-
-    # @deprecated
-    def controller_info=(value)
-      ::ActiveSupport::Deprecation.warn(
-        "PaperTrail.controller_info= is deprecated, use PaperTrail.request.controller_info=",
-        caller(1)
-      )
-      request.controller_info = value
-    end
-
-    # @deprecated
-    def controller_info
-      ::ActiveSupport::Deprecation.warn(
-        "PaperTrail.controller_info is deprecated, use PaperTrail.request.controller_info",
-        caller(1)
-      )
-      request.controller_info
+      raise Error, E_TIMESTAMP_FIELD_CONFIG
     end
 
     # Set the PaperTrail serializer. This setting affects all threads.
@@ -198,7 +102,7 @@ module PaperTrail
 
     # Returns PaperTrail's global configuration object, a singleton. These
     # settings affect all threads.
-    # @api private
+    # @api public
     def config
       @config ||= PaperTrail::Config.instance
       yield @config if block_given?
@@ -206,29 +110,25 @@ module PaperTrail
     end
     alias configure config
 
+    # @api public
     def version
       VERSION::STRING
     end
   end
 end
 
-ActiveSupport.on_load(:active_record) do
-  include PaperTrail::Model
-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/frameworks/rails"
-  else
-    ::Kernel.warn(::PaperTrail::E_RAILS_NOT_LOADED)
-  end
+# PT is built on ActiveRecord, but does not require Rails. If Rails is defined,
+# our Railtie makes sure not to load the AR-dependent parts of PT until AR is
+# ready. A typical Rails `application.rb` has:
+#
+# ```
+# require 'rails/all' # Defines `Rails`
+# Bundler.require(*Rails.groups) # require 'paper_trail' (this file)
+# ```
+#
+# Non-rails applications should take similar care to load AR before PT.
+if defined?(Rails)
+  require "paper_trail/frameworks/rails"
 else
   require "paper_trail/frameworks/active_record"
 end
-
-# https://github.com/paper-trail-gem/paper_trail/issues/1070
-# https://github.com/westonganger/paper_trail-association_tracking/issues/2
-require "paper_trail-association_tracking"

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: paper_trail
 version: !ruby/object:Gem::Version
-  version: 9.2.0
+  version: 14.0.0
 platform: ruby
 authors:
 - Andy Stewart
 - Ben Atkins
 - Jared Beck
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-06-10 00:00:00.000000000 Z
+date: 2022-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -18,90 +18,70 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5.3'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
-    - - "<"
-      - !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'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: request_store
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: 2.4.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: 2.4.1
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '11.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '11.1'
 - !ruby/object:Gem::Dependency
   name: ffaker
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.8'
+        version: '2.20'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.8'
+        version: '2.20'
 - !ruby/object:Gem::Dependency
   name: generator_spec
   requirement: !ruby/object:Gem::Requirement
@@ -117,103 +97,201 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.9.4
 - !ruby/object:Gem::Dependency
-  name: mysql2
+  name: memory_profiler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.10
+        version: 1.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.10
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
-  name: pg
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.21.0
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.21.0
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.7.2
+        version: 5.0.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.7.2
+        version: 5.0.2
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.56.0
+        version: 1.22.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.22.2
+- !ruby/object:Gem::Dependency
+  name: rubocop-packaging
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.11.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.11.5
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.12.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.12.4
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.56.0
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.25.1
+        version: 2.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.2
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.3
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.25.1
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.4'
 description: |
   Track changes to your models, for auditing or versioning. See how a model looked
   at any stage in its lifecycle, revert it to any version, or restore it after it
@@ -223,10 +301,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 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/create_versions.rb.erb
+- LICENSE
+- lib/generators/paper_trail/install/USAGE
+- lib/generators/paper_trail/install/install_generator.rb
+- lib/generators/paper_trail/install/templates/add_object_changes_to_versions.rb.erb
+- lib/generators/paper_trail/install/templates/create_versions.rb.erb
+- lib/generators/paper_trail/migration_generator.rb
+- lib/generators/paper_trail/update_item_subtype/USAGE
+- lib/generators/paper_trail/update_item_subtype/templates/update_versions_for_item_subtype.rb.erb
+- lib/generators/paper_trail/update_item_subtype/update_item_subtype_generator.rb
 - lib/paper_trail.rb
 - lib/paper_trail/attribute_serializers/README.md
 - lib/paper_trail/attribute_serializers/attribute_serializer_factory.rb
@@ -234,19 +317,28 @@ files:
 - lib/paper_trail/attribute_serializers/object_attribute.rb
 - lib/paper_trail/attribute_serializers/object_changes_attribute.rb
 - lib/paper_trail/cleaner.rb
+- lib/paper_trail/compatibility.rb
 - lib/paper_trail/config.rb
+- lib/paper_trail/errors.rb
+- lib/paper_trail/events/base.rb
+- lib/paper_trail/events/create.rb
+- lib/paper_trail/events/destroy.rb
+- lib/paper_trail/events/update.rb
 - lib/paper_trail/frameworks/active_record.rb
 - lib/paper_trail/frameworks/active_record/models/paper_trail/version.rb
 - lib/paper_trail/frameworks/cucumber.rb
 - lib/paper_trail/frameworks/rails.rb
 - lib/paper_trail/frameworks/rails/controller.rb
-- lib/paper_trail/frameworks/rails/engine.rb
+- lib/paper_trail/frameworks/rails/railtie.rb
 - lib/paper_trail/frameworks/rspec.rb
 - lib/paper_trail/frameworks/rspec/helpers.rb
 - lib/paper_trail/has_paper_trail.rb
 - lib/paper_trail/model_config.rb
+- lib/paper_trail/queries/versions/where_attribute_changes.rb
 - lib/paper_trail/queries/versions/where_object.rb
 - lib/paper_trail/queries/versions/where_object_changes.rb
+- lib/paper_trail/queries/versions/where_object_changes_from.rb
+- lib/paper_trail/queries/versions/where_object_changes_to.rb
 - lib/paper_trail/record_history.rb
 - lib/paper_trail/record_trail.rb
 - lib/paper_trail/reifier.rb
@@ -260,7 +352,7 @@ homepage: https://github.com/paper-trail-gem/paper_trail
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -268,16 +360,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Track changes to your models.
 test_files: []

data/lib/generators/paper_trail/USAGE

@@ -1,2 +0,0 @@
-Description:
-  Generates (but does not run) a migration to add a versions table.

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

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-module PaperTrail
-  module Rails
-    # See http://guides.rubyonrails.org/engines.html
-    class Engine < ::Rails::Engine
-      paths["app/models"] << "lib/paper_trail/frameworks/active_record/models"
-      config.paper_trail = ActiveSupport::OrderedOptions.new
-      initializer "paper_trail.initialisation" do |app|
-        PaperTrail.enabled = app.config.paper_trail.fetch(:enabled, true)
-      end
-    end
-  end
-end