mongodb/mongoid

# frozen_string_literal: true
# rubocop:todo all

module Mongoid
  class Criteria
    module Queryable

      # The options is a hash representation of options passed to MongoDB queries,
      # such as skip, limit, and sorting criteria.
      class Options < Smash

        # Convenience method for getting the field options.
        #
        # @example Get the fields options.
        #   options.fields
        #
        # @return [ Hash ] The fields options.
        def fields
          self[:fields]
        end

        # Convenience method for getting the limit option.
        #
        # @example Get the limit option.
        #   options.limit
        #
        # @return [ Integer ] The limit option.
        def limit
          self[:limit]
        end

        # Convenience method for getting the skip option.
        #
        # @example Get the skip option.
        #   options.skip
        #
        # @return [ Integer ] The skip option.
        def skip
          self[:skip]
        end

        # Convenience method for getting the sort options.
        #
        # @example Get the sort options.
        #   options.sort
        #
        # @return [ Hash ] The sort options.
        def sort
          self[:sort]
        end

        # Store the value in the options for the provided key. The options will
        # handle all necessary serialization and localization in this step.
        #
        # @example Store a value in the options.
        #   options.store(:key, "testing")
        #
        # @param [ String | Symbol ] key The name of the attribute.
        # @param [ Object ] value The value to add.
        #
        # @return [ Object ] The stored object.
        def store(key, value, localize = true)
          super(key, evolve(value, localize))
        end
        alias :[]= :store

        # Convert the options to aggregation pipeline friendly options.
        #
        # @example Convert the options to a pipeline.
        #   options.to_pipeline
        #
        # @return [ Array<Hash> ] The options in pipeline form.
        def to_pipeline
          pipeline = []
          pipeline.push({ "$skip" => skip }) if skip
          pipeline.push({ "$limit" => limit }) if limit
          pipeline.push({ "$sort" => sort }) if sort
          pipeline
        end

        # Perform a deep copy of the options.
        #
        # @example Perform a deep copy.
        #   options.__deep_copy__
        #
        # @return [ Options ] The copied options.
        def __deep_copy__
          self.class.new(aliases, serializers, associations, aliased_associations) do |copy|
            each_pair do |key, value|
              copy.merge!(key => value.__deep_copy__)
            end
          end
        end

        private

        # Evolve a single key selection with various types of values.
        #
        # @api private
        #
        # @example Evolve a simple selection.
        #   options.evolve(field, 5)
        #
        # @param [ Object ] value The value to serialize.
        #
        # @return [ Object ] The serialized object.
        def evolve(value, localize = true)
          case value
          when Hash
            evolve_hash(value, localize)
          else
            value
          end
        end

        # Evolve a single key selection with hash values.
        #
        # @api private
        #
        # @example Evolve a simple selection.
        #   options.evolve(field, { "$gt" => 5 })
        #
        # @param [ Hash ] value The hash to serialize.
        #
        # @return [ Object ] The serialized hash.
        def evolve_hash(value, localize = true)
          value.inject({}) do |hash, (field, _value)|
            name, serializer = storage_pair(field)
            name = localized_key(name, serializer) if localize
            hash[name] = _value
            hash
          end
        end
      end
    end
  end
end