mongoid/mongoid-slug

# frozen_string_literal: true

module Mongoid
  module Slug
    module IndexBuilder
      extend self

      # Creates indexes on a document for a given slug scope
      #
      # @param [ Mongoid::Document ] doc The document on which to create the index(es)
      # @param [ String or Symbol or Array<String, Symbol> ] scope_key The optional scope key for the index(es)
      # @param [ Boolean ] by_model_type Whether or not to use single table inheritance
      # @param [ Boolean or Array ] localize The locale for localized index field
      #
      # @return [ Array(Hash, Hash) ] the indexable fields and index options.
      def build_indexes(doc, scope_key = nil, by_model_type = false, locales = nil)
        if locales.is_a?(Array)
          locales.each { |locale| build_index(doc, scope_key, by_model_type, locale) }
        else
          build_index(doc, scope_key, by_model_type, locales)
        end
      end

      private

      def build_index(doc, scope_key = nil, by_model_type = false, locale = nil)
        # The order of field keys is intentional.
        # See: http://docs.mongodb.org/manual/core/index-compound/
        fields = {}
        fields[:_type] = 1 if by_model_type

        Array(scope_key).each { |key| fields[key] = 1 }

        locale = ::I18n.default_locale if locale.is_a?(TrueClass)
        if locale
          fields[:"_slugs.#{locale}"] = 1
        else
          fields[:_slugs] = 1
        end

        # By design, we use the unique index constraint when possible to enforce slug uniqueness.
        # When migrating legacy data to Mongoid slug, the _slugs field may be null on many records,
        # hence we set the sparse index option to ignore these from the unique index.
        # See: http://docs.mongodb.org/manual/core/index-sparse/
        #
        # There are three edge cases where the index must not be unique:
        #
        # 1) Legacy tables with `scope_key`. The sparse indexes on compound keys (scope + _slugs) are
        #    whenever ANY of the key values are present (e.g. when scope is set and _slugs is unset),
        #    and collisions will occur when multiple records have the same scope but null slugs.
        #
        # 2) Single Table Inheritance (`by_model_type`). MongoDB creates indexes on the parent collection,
        #    irrespective of how STI is defined in Mongoid, i.e. ANY child index will be applied to EVERY child.
        #    This can cause collisions using various combinations of scopes.
        #
        # In the future, MongoDB may implement partial indexes or improve sparse index behavior.
        # See: https://jira.mongodb.org/browse/SERVER-785
        #      https://jira.mongodb.org/browse/SERVER-13780
        #      https://jira.mongodb.org/browse/SERVER-10403
        options = {}
        unless scope_key || by_model_type
          options[:unique] = true
          options[:sparse] = true
        end

        doc.index(fields, options)
      end
    end
  end
end