mongo_trails 10.3.1 → 14.0.0

data/lib/mongo_trails/attribute_serializers/attribute_serializer_factory.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-require "mongo_trails/type_serializers/postgres_array_serializer"
-
-module PaperTrail
-  module AttributeSerializers
-    # Values returned by some Active Record serializers are
-    # not suited for writing JSON to a text column. This factory
-    # replaces certain default Active Record serializers
-    # with custom PaperTrail ones.
-    module AttributeSerializerFactory
-      AR_PG_ARRAY_CLASS = "ActiveRecord::ConnectionAdapters::PostgreSQL::OID::Array"
-
-      def self.for(klass, attr)
-        active_record_serializer = klass.type_for_attribute(attr)
-        if active_record_serializer.class.name == AR_PG_ARRAY_CLASS
-          TypeSerializers::PostgresArraySerializer.new(
-            active_record_serializer.subtype,
-            active_record_serializer.delimiter
-          )
-        else
-          active_record_serializer
-        end
-      end
-    end
-  end
-end

data/lib/mongo_trails/attribute_serializers/cast_attribute_serializer.rb

@@ -1,51 +0,0 @@
-# frozen_string_literal: true
-
-require "mongo_trails/attribute_serializers/attribute_serializer_factory"
-
-module PaperTrail
-  # :nodoc:
-  module AttributeSerializers
-    # The `CastAttributeSerializer` (de)serializes model attribute values. For
-    # example, the string "1.99" serializes into the integer `1` when assigned
-    # to an attribute of type `ActiveRecord::Type::Integer`.
-    #
-    # This implementation depends on the `type_for_attribute` method, which was
-    # introduced in rails 4.2. As of PT 8, we no longer support rails < 4.2.
-    class CastAttributeSerializer
-      def initialize(klass)
-        @klass = klass
-      end
-
-      private
-
-      # Returns a hash mapping attributes to hashes that map strings to
-      # integers. Example:
-      #
-      # ```
-      # { "status" => { "draft"=>0, "published"=>1, "archived"=>2 } }
-      # ```
-      #
-      # ActiveRecord::Enum was added in AR 4.1
-      # http://edgeguides.rubyonrails.org/4_1_release_notes.html#active-record-enums
-      def defined_enums
-        @defined_enums ||= (@klass.respond_to?(:defined_enums) ? @klass.defined_enums : {})
-      end
-    end
-
-    # Uses AR 5's `serialize` and `deserialize`.
-    class CastAttributeSerializer
-      def serialize(attr, val)
-        AttributeSerializerFactory.for(@klass, attr).serialize(val)
-      end
-
-      def deserialize(attr, val)
-        if defined_enums[attr] && val.is_a?(::String)
-          # Because PT 4 used to save the string version of enums to `object_changes`
-          val
-        else
-          AttributeSerializerFactory.for(@klass, attr).deserialize(val)
-        end
-      end
-    end
-  end
-end

data/lib/mongo_trails/attribute_serializers/object_attribute.rb

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-require "mongo_trails/attribute_serializers/cast_attribute_serializer"
-
-module PaperTrail
-  module AttributeSerializers
-    # Serialize or deserialize the `version.object` column.
-    class ObjectAttribute
-      def initialize(model_class)
-        @model_class = model_class
-      end
-
-      def serialize(attributes)
-        alter(attributes, :serialize)
-      end
-
-      def deserialize(attributes)
-        alter(attributes, :deserialize)
-      end
-
-      private
-
-      # Modifies `attributes` in place.
-      # TODO: Return a new hash instead.
-      def alter(attributes, serialization_method)
-        # Don't serialize before values before inserting into columns of type
-        # `JSON` on `PostgreSQL` databases.
-        return attributes if object_col_is_json?
-
-        serializer = CastAttributeSerializer.new(@model_class)
-        attributes.each do |key, value|
-          attributes[key] = serializer.send(serialization_method, key, value)
-        end
-      end
-
-      def object_col_is_json?
-        @model_class.paper_trail.version_class.object_col_is_json?
-      end
-    end
-  end
-end

data/lib/mongo_trails/attribute_serializers/object_changes_attribute.rb

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-require "mongo_trails/attribute_serializers/cast_attribute_serializer"
-
-module PaperTrail
-  module AttributeSerializers
-    # Serialize or deserialize the `version.object_changes` column.
-    class ObjectChangesAttribute
-      def initialize(item_class)
-        @item_class = item_class
-      end
-
-      def serialize(changes)
-        alter(changes, :serialize)
-      end
-
-      def deserialize(changes)
-        alter(changes, :deserialize)
-      end
-
-      private
-
-      # Modifies `changes` in place.
-      # TODO: Return a new hash instead.
-      def alter(changes, serialization_method)
-        # Don't serialize before values before inserting into columns of type
-        # `JSON` on `PostgreSQL` databases.
-        return changes if object_changes_col_is_json?
-
-        serializer = CastAttributeSerializer.new(@item_class)
-        changes.clone.each do |key, change|
-          # `change` is an Array with two elements, representing before and after.
-          changes[key] = Array(change).map do |value|
-            serializer.send(serialization_method, key, value)
-          end
-        end
-      end
-
-      def object_changes_col_is_json?
-        @item_class.paper_trail.version_class.object_changes_col_is_json?
-      end
-    end
-  end
-end

data/lib/mongo_trails/cleaner.rb

@@ -1,60 +0,0 @@
-# frozen_string_literal: true
-
-module PaperTrail
-  # Utilities for deleting version records.
-  module Cleaner
-    # Destroys all but the most recent version(s) for items on a given date
-    # (or on all dates). Useful for deleting drafts.
-    #
-    # Options:
-    #
-    # - :keeping - An `integer` indicating the number of versions to be kept for
-    #   each item per date. Defaults to `1`. The most recent matching versions
-    #   are kept.
-    # - :date - Should either be a `Date` object specifying which date to
-    #   destroy versions for or `:all`, which will specify that all dates
-    #   should be cleaned. Defaults to `:all`.
-    # - :item_id - The `id` for the item to be cleaned on, or `nil`, which
-    #   causes all items to be cleaned. Defaults to `nil`.
-    #
-    def clean_versions!(options = {})
-      options = { keeping: 1, date: :all }.merge(options)
-      gather_versions(options[:item_id], options[:date]).each do |_item_id, item_versions|
-        group_versions_by_date(item_versions).each do |_date, date_versions|
-          # Remove the number of versions we wish to keep from the collection
-          # of versions prior to destruction.
-          date_versions.pop(options[:keeping])
-          date_versions.map(&:destroy)
-        end
-      end
-    end
-
-    private
-
-    # Returns a hash of versions grouped by the `item_id` attribute formatted
-    # like this: {:item_id => PaperTrail::Version}. If `item_id` or `date` is
-    # set, versions will be narrowed to those pointing at items with those ids
-    # that were created on specified date. Versions are returned in
-    # chronological order.
-    def gather_versions(item_id = nil, date = :all)
-      unless date == :all || date.respond_to?(:to_date)
-        raise ArgumentError, "Expected date to be a Timestamp or :all"
-      end
-      versions = item_id ? PaperTrail::Version.where(item_id: item_id) : PaperTrail::Version
-      versions = versions.order(PaperTrail::Version.timestamp_sort_order)
-      versions = versions.between(date.to_date, date.to_date + 1.day) unless date == :all
-
-      # If `versions` has not been converted to an ActiveRecord::Relation yet,
-      # do so now.
-      versions = PaperTrail::Version.all if versions == PaperTrail::Version
-      versions.group_by(&:item_id)
-    end
-
-    # Given an array of versions, returns a hash mapping dates to arrays of
-    # versions.
-    # @api private
-    def group_versions_by_date(versions)
-      versions.group_by { |v| v.created_at.to_date }
-    end
-  end
-end

data/lib/mongo_trails/compatibility.rb

@@ -1,51 +0,0 @@
-# frozen_string_literal: true
-
-module PaperTrail
-  # Rails does not follow SemVer, makes breaking changes in minor versions.
-  # Breaking changes are expected, and are generally good for the rails
-  # ecosystem. However, they often require dozens of hours to fix, even with the
-  # [help of experts](https://github.com/paper-trail-gem/mongo_trails/pull/899).
-  #
-  # It is not safe to assume that a new version of rails will be compatible with
-  # PaperTrail. PT is only compatible with the versions of rails that it is
-  # tested against. See `.travis.yml`.
-  #
-  # However, as of
-  # [#1213](https://github.com/paper-trail-gem/mongo_trails/pull/1213) our
-  # gemspec allows installation with newer, incompatible rails versions. We hope
-  # this will make it easier for contributors to work on compatibility with
-  # newer rails versions. Most PT users should avoid incompatible rails
-  # versions.
-  module Compatibility
-    ACTIVERECORD_GTE = ">= 5.2" # enforced in gemspec
-    ACTIVERECORD_LT = "< 6.1" # not enforced in gemspec
-
-    E_INCOMPATIBLE_AR = <<-EOS
-      PaperTrail %s is not compatible with ActiveRecord %s. We allow PT
-      contributors to install incompatible versions of ActiveRecord, and this
-      warning can be silenced with an environment variable, but this is a bad
-      idea for normal use. Please install a compatible version of ActiveRecord
-      instead (%s). Please see the discussion in mongo_trails/compatibility.rb
-      for details.
-    EOS
-
-    # Normal users need a warning if they accidentally install an incompatible
-    # version of ActiveRecord. Contributors can silence this warning with an
-    # environment variable.
-    def self.check_activerecord(ar_version)
-      raise ::TypeError unless ar_version.instance_of?(::Gem::Version)
-      return if ::ENV["PT_SILENCE_AR_COMPAT_WARNING"].present?
-      req = ::Gem::Requirement.new([ACTIVERECORD_GTE, ACTIVERECORD_LT])
-      unless req.satisfied_by?(ar_version)
-        ::Kernel.warn(
-          format(
-            E_INCOMPATIBLE_AR,
-            ::PaperTrail.gem_version,
-            ar_version,
-            req
-          )
-        )
-      end
-    end
-  end
-end

data/lib/mongo_trails/events/create.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-require "mongo_trails/events/base"
-
-module PaperTrail
-  module Events
-    # See docs in `Base`.
-    #
-    # @api private
-    class Create < Base
-      # Return attributes of nascent `Version` record.
-      #
-      # @api private
-      def data
-        data = {
-          item: @record,
-          event: @record.paper_trail_event || "create",
-          whodunnit: PaperTrail.request.whodunnit
-        }
-        if @record.respond_to?(:updated_at)
-          data[:created_at] = @record.updated_at
-        end
-        if record_object_changes? && changed_notably?
-          changes = notable_changes
-          data[:object_changes] = prepare_object_changes(changes)
-        end
-        merge_item_subtype_into(data)
-        merge_metadata_into(data)
-      end
-    end
-  end
-end

data/lib/mongo_trails/events/destroy.rb

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-require "mongo_trails/events/base"
-
-module PaperTrail
-  module Events
-    # See docs in `Base`.
-    #
-    # @api private
-    class Destroy < Base
-      # Return attributes of nascent `Version` record.
-      #
-      # @api private
-      def data
-        data = {
-          item_id: @record.id,
-          item_type: @record.class.base_class.name,
-          event: @record.paper_trail_event || "destroy",
-          whodunnit: PaperTrail.request.whodunnit
-        }
-        if record_object?
-          data[:object] = recordable_object(false)
-        end
-        if record_object_changes?
-          data[:object_changes] = prepare_object_changes(notable_changes)
-        end
-        merge_item_subtype_into(data)
-        merge_metadata_into(data)
-      end
-
-      private
-
-      # Rails' implementation (eg. `@record.saved_changes`) returns nothing on
-      # destroy, so we have to build the hash we want.
-      #
-      # @override
-      def changes_in_latest_version
-        @record.attributes.map { |attr, value| [attr, [value, nil]] }.to_h
-      end
-    end
-  end
-end

data/lib/mongo_trails/events/update.rb

@@ -1,60 +0,0 @@
-# frozen_string_literal: true
-
-require "mongo_trails/events/base"
-
-module PaperTrail
-  module Events
-    # See docs in `Base`.
-    #
-    # @api private
-    class Update < Base
-      # - is_touch - [boolean] - Used in the two situations that are touch-like:
-      #   - `after_touch` we call `RecordTrail#record_update`
-      # - force_changes - [Hash] - Only used by `RecordTrail#update_columns`,
-      #   because there dirty-tracking is off, so it has to track its own changes.
-      #
-      # @api private
-      def initialize(record, in_after_callback, is_touch, force_changes)
-        super(record, in_after_callback)
-        @is_touch = is_touch
-        @force_changes = force_changes
-      end
-
-      # Return attributes of nascent `Version` record.
-      #
-      # @api private
-      def data
-        data = {
-          item: @record,
-          event: @record.paper_trail_event || "update",
-          whodunnit: PaperTrail.request.whodunnit
-        }
-        if @record.respond_to?(:updated_at)
-          data[:created_at] = @record.updated_at
-        end
-        if record_object?
-          data[:object] = recordable_object(@is_touch)
-        end
-        if record_object_changes?
-          changes = @force_changes.nil? ? notable_changes : @force_changes
-          data[:object_changes] = prepare_object_changes(changes)
-        end
-        merge_item_subtype_into(data)
-        merge_metadata_into(data)
-      end
-
-      private
-
-      # `touch` cannot record `object_changes` because rails' `touch` does not
-      # perform dirty-tracking. Specifically, methods from `Dirty`, like
-      # `saved_changes`, return the same values before and after `touch`.
-      #
-      # See https://github.com/rails/rails/issues/33429
-      #
-      # @api private
-      def record_object_changes?
-        !@is_touch && super
-      end
-    end
-  end
-end

data/lib/mongo_trails/frameworks/cucumber.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-# before hook for Cucumber
-Before do
-  PaperTrail.enabled = false
-  PaperTrail.request.enabled = true
-  PaperTrail.request.whodunnit = nil
-  PaperTrail.request.controller_info = {} if defined?(::Rails)
-end
-
-module PaperTrail
-  module Cucumber
-    # Helper method for enabling PT in Cucumber features.
-    module Extensions
-      # :call-seq:
-      # with_versioning
-      #
-      # enable versioning for specific blocks
-
-      def with_versioning
-        was_enabled = ::PaperTrail.enabled?
-        ::PaperTrail.enabled = true
-        begin
-          yield
-        ensure
-          ::PaperTrail.enabled = was_enabled
-        end
-      end
-    end
-  end
-end
-
-World PaperTrail::Cucumber::Extensions

data/lib/mongo_trails/frameworks/rails/controller.rb

@@ -1,109 +0,0 @@
-# frozen_string_literal: true
-
-module PaperTrail
-  module Rails
-    # Extensions to rails controllers. Provides convenient ways to pass certain
-    # information to the model layer, with `controller_info` and `whodunnit`.
-    # Also includes a convenient on/off switch,
-    # `paper_trail_enabled_for_controller`.
-    module Controller
-      def self.included(controller)
-        controller.before_action(
-          :set_paper_trail_enabled_for_controller,
-          :set_paper_trail_controller_info
-        )
-      end
-
-      protected
-
-      # Returns the user who is responsible for any changes that occur.
-      # By default this calls `current_user` and returns the result.
-      #
-      # Override this method in your controller to call a different
-      # method, e.g. `current_person`, or anything you like.
-      #
-      # @api public
-      def user_for_paper_trail
-        return unless defined?(current_user)
-        current_user.try(:id) || current_user
-      end
-
-      # Returns any information about the controller or request that you
-      # want PaperTrail to store alongside any changes that occur.  By
-      # default this returns an empty hash.
-      #
-      # Override this method in your controller to return a hash of any
-      # information you need.  The hash's keys must correspond to columns
-      # in your `versions` table, so don't forget to add any new columns
-      # you need.
-      #
-      # For example:
-      #
-      #     {:ip => request.remote_ip, :user_agent => request.user_agent}
-      #
-      # The columns `ip` and `user_agent` must exist in your `versions` # table.
-      #
-      # Use the `:meta` option to
-      # `PaperTrail::Model::ClassMethods.has_paper_trail` to store any extra
-      # model-level data you need.
-      #
-      # @api public
-      def info_for_paper_trail
-        {}
-      end
-
-      # Returns `true` (default) or `false` depending on whether PaperTrail
-      # should be active for the current request.
-      #
-      # Override this method in your controller to specify when PaperTrail
-      # should be off.
-      #
-      # ```
-      # def paper_trail_enabled_for_controller
-      #   # Don't omit `super` without a good reason.
-      #   super && request.user_agent != 'Disable User-Agent'
-      # end
-      # ```
-      #
-      # @api public
-      def paper_trail_enabled_for_controller
-        ::PaperTrail.enabled?
-      end
-
-      private
-
-      # Tells PaperTrail whether versions should be saved in the current
-      # request.
-      #
-      # @api public
-      def set_paper_trail_enabled_for_controller
-        ::PaperTrail.request.enabled = paper_trail_enabled_for_controller
-      end
-
-      # Tells PaperTrail who is responsible for any changes that occur.
-      #
-      # @api public
-      def set_paper_trail_whodunnit
-        if ::PaperTrail.request.enabled?
-          ::PaperTrail.request.whodunnit = user_for_paper_trail
-        end
-      end
-
-      # Tells PaperTrail any information from the controller you want to store
-      # alongside any changes that occur.
-      #
-      # @api public
-      def set_paper_trail_controller_info
-        if ::PaperTrail.request.enabled?
-          ::PaperTrail.request.controller_info = info_for_paper_trail
-        end
-      end
-    end
-  end
-end
-
-if defined?(::ActionController)
-  ::ActiveSupport.on_load(:action_controller) do
-    include ::PaperTrail::Rails::Controller
-  end
-end

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

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-module PaperTrail
-  module Rails
-    # See http://guides.rubyonrails.org/engines.html
-    class Engine < ::Rails::Engine
-      DPR_CONFIG_ENABLED = <<~EOS.squish.freeze
-        The rails configuration option config.paper_trail.enabled is deprecated.
-        Please use PaperTrail.enabled= instead. People were getting confused
-        that PT has both, specifically regarding *when* each was happening. If
-        you'd like to keep config.paper_trail, join the discussion at
-        https://github.com/paper-trail-gem/mongo_trails/pull/1176
-      EOS
-      private_constant :DPR_CONFIG_ENABLED
-      DPR_RUDELY_ENABLING = <<~EOS.squish.freeze
-        At some point early in the rails boot process, you have set
-        PaperTrail.enabled = false. PT's rails engine is now overriding your
-        setting, and setting it to true. We're not sure why, but this is how PT
-        has worked since 5.0, when the config.paper_trail.enabled option was
-        introduced. This is now deprecated. In the future, PT will not override
-        your setting. See
-        https://github.com/paper-trail-gem/mongo_trails/pull/1176 for discussion.
-      EOS
-      private_constant :DPR_RUDELY_ENABLING
-
-      # --- Begin deprecated section ---
-      config.paper_trail = ActiveSupport::OrderedOptions.new
-      initializer "paper_trail.initialisation" do |app|
-        enable = app.config.paper_trail[:enabled]
-        if enable.nil?
-          unless PaperTrail.enabled?
-            ::ActiveSupport::Deprecation.warn(DPR_RUDELY_ENABLING)
-            PaperTrail.enabled = true
-          end
-        else
-          ::ActiveSupport::Deprecation.warn(DPR_CONFIG_ENABLED)
-          PaperTrail.enabled = enable
-        end
-      end
-      # --- End deprecated section ---
-    end
-  end
-end

data/lib/mongo_trails/frameworks/rails.rb

@@ -1,4 +0,0 @@
-# frozen_string_literal: true
-
-require "mongo_trails/frameworks/rails/controller"
-require "mongo_trails/frameworks/rails/engine"

data/lib/mongo_trails/frameworks/rspec/helpers.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-module PaperTrail
-  module RSpec
-    module Helpers
-      # Included in the RSpec configuration in `frameworks/rspec.rb`
-      module InstanceMethods
-        # enable versioning for specific blocks (at instance-level)
-        def with_versioning
-          was_enabled = ::PaperTrail.enabled?
-          ::PaperTrail.enabled = true
-          yield
-        ensure
-          ::PaperTrail.enabled = was_enabled
-        end
-      end
-
-      # Extended by the RSpec configuration in `frameworks/rspec.rb`
-      module ClassMethods
-        # enable versioning for specific blocks (at class-level)
-        def with_versioning(&block)
-          context "with versioning", versioning: true do
-            class_exec(&block)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/mongo_trails/frameworks/rspec.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-require "rspec/core"
-require "rspec/matchers"
-require "mongo_trails/frameworks/rspec/helpers"
-
-RSpec.configure do |config|
-  config.include ::PaperTrail::RSpec::Helpers::InstanceMethods
-  config.extend ::PaperTrail::RSpec::Helpers::ClassMethods
-
-  config.before(:each) do
-    ::Mongoid.purge!
-    ::PaperTrail.enabled = false
-    ::PaperTrail.request.enabled = true
-    ::PaperTrail.request.whodunnit = nil
-    ::PaperTrail.request.controller_info = {} if defined?(::Rails) && defined?(::RSpec::Rails)
-  end
-
-  config.before(:each, versioning: true) do
-    ::PaperTrail.enabled = true
-  end
-end
-
-RSpec::Matchers.define :be_versioned do
-  # check to see if the model has `has_paper_trail` declared on it
-  match { |actual| actual.is_a?(::PaperTrail::Model::InstanceMethods) }
-end
-
-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