Module Mongo::Options::Mapper
In: lib/mongo/options/mapper.rb

Utility class for various options mapping behavior.

@since 2.0.0

Methods

Public Instance methods

Transforms the provided options to a new set of options given the provided mapping.

Options which are not present in the provided mapping are returned unmodified.

@example Transform the options.

  Mapper.transform({ name: 1 }, { :name => :nombre })

@param [ Hash ] options The options to transform @param [ Hash ] mappings The key mappings.

@return [ Hash ] The transformed options.

@since 2.0.0

Transforms the provided options to a new set of options given the provided mapping. Expects BSON::Documents in and out so no explicit string conversion needs to happen.

@example Transform the options.

  Mapper.transform_documents({ name: 1 }, { :name => :nombre })

@param [ BSON::Document ] options The options to transform @param [ BSON::Document ] mappings The key mappings. @param [ BSON::Document ] document The output document.

@return [ BSON::Document ] The transformed options.

@since 2.0.0

Coverts all the keys of the options to strings.

@example Convert all option keys to strings.

  Mapper.transform({ :name => 1 })

@param [ Hash ] options The options to transform.

@return [ Hash ] The transformed options.

@since 2.0.0

Coverts all the keys of the options to symbols.

@example Convert all option keys to symbols.

  Mapper.transform({ 'name' => 1 })

@param [ Hash ] options The options to transform.

@return [ Hash ] The transformed options.

@since 2.2.2

Coverts all the symbol values to strings.

@example Convert all option symbol values to strings.

  Mapper.transform({ :name => 1 })

@param [ Hash ] options The options to transform.

@return [ Hash ] The transformed options.

@since 2.0.0

[Validate]