invalid_elem_match_operator.rb

# frozen_string_literal: true
# rubocop:todo all

module Mongoid
  module Errors

    # Raised when invalid field-level operator is passed to the $elemMatch
    # embedded matcher.
    class InvalidElemMatchOperator < InvalidQuery

      # @api private
      VALID_OPERATORS = %w(
        and all eq exists gt gte in lt lte ne nin nor not or regex size
      ).freeze

      # Creates the exception.
      #
      # @param [ String ] operator The operator that was used.
      #
      # @api private
      def initialize(operator)
        @operator = operator
        super(compose_message("invalid_elem_match_operator",
          operator: operator,
          valid_operators: VALID_OPERATORS.map { |op| "'$#{op}'" }.join(', '),
        ))
      end

      # @return [ String ] The operator that was used.
      attr_reader :operator
    end
  end
end