123456789_123456789_123456789_123456789_123456789_

Module: Mongoid::Criteria::Translator Private

Do not use. This module is for internal use only.
Relationships & Source Files
Defined in: lib/mongoid/criteria/translator.rb

Overview

This is a helper module for translating atomic and composite Ruby values into corresponding query and option components. Originally implemented as patches to core classes, that approach has generally fallen into disfavor, as it bleeds too much into the public namespace.

Instance Method Summary

Instance Method Details

#to_direction(value) ⇒ Hash | Numeric

Converts the given value to a direction specification for use in sorting.

Examples:

Convert the value to a direction.

Translator.to_direction(:desc)
Translator.to_direction("1")
Translator.to_direction(-1)
Translator.to_direction(score: { "$meta": "textScore" })

Parameters:

Returns:

  • (Hash | Numeric)

    The direction.

[ GitHub ]

  
# File 'lib/mongoid/criteria/translator.rb', line 29

def to_direction(value)
  case value
  when Hash then
    value
  when Numeric then
    value
  when String then
    value =~ /desc/i ? -1 : 1
  when Symbol then
    to_direction(value.to_s)
  else
    raise ArgumentError, "cannot translate #{value.inspect} (#{value.class}) to a direction specification"
  end
end