Módulo: Mongo::Deprecations Privado

Ampliado por:
Deprecaciones, Registrable
Incluido en:
Obsolescencias
Definido en:
lib/mongo/deprecations.rb

Overview

Este módulo es parte de una API privada. Deberías evitar usar este módulo si es posible, ya que puede ser removido o cambiado en el futuro.

Se utiliza para informar sobre comportamientos obsoletos en el controlador. Cuando sea posible detectar que se está utilizando una funcionalidad obsoleta, se deberá emitir una advertencia a través de este módulo.

La advertencia se emitirá no más de una vez para esa funcionalidad, independientemente de cuántas veces se llame a Mongo::Deprecations.warn.

Ejemplos:

Emitir una advertencia de desuso.

Mongo::Deprecations.warn(:old_feature, "The old_feature is deprecated, use new_feature instead.")

Resumen de constantes colapsar

MUTEX =

Esta constante es parte de una API privada. Deberías evitar usar esta constante si es posible, ya que podría ser retirada o cambiada en el futuro.

Mutex para sincronizar el acceso a las funcionalidades advertidas.

Hilo::Mutex (exclusión mutua).Nuevo

Constantes incluidas desde Loggable

Loggable::PREFIX

Resumen del método de instancia colapsar

Métodos incluidos desde Registrable

log_debug, log_error, log_fatal, log_info, log_warn, logger

Detalles del método de instancia

#clear! ⇒ Objeto

Este método es parte de una API privada. Se debe evitar el uso de este método si es posible, ya que podría eliminarse o modificarse en el futuro.

Borra toda la memoria de las funcionalidades que se han advertido previamente.



58
59
60
61
 
# Archivo 'lib/mongo/deprecations.rb', línea 58

def ¡Despejen!
  MUTEX.sincronizar { warned_features restablecer: true }
  nulo
end

#advertir(funcionalidad, mensaje) ⇒ Objeto

Este método es parte de una API privada. Se debe evitar el uso de este método si es posible, ya que podría eliminarse o modificarse en el futuro.

Emitir una advertencia sobre una funcionalidad obsoleta. La advertencia se escribe en el registrador y no se escribirá más de una vez por funcionalidad.

Parámetros:

  • funcionalidad (String | Symbol) —

    La funcionalidad obsoleta.

  • mensaje (string) —

    El mensaje de obsolescencia.



30
31
32
33
34
35
36
37
 
# Archivo 'lib/mongo/deprecations.rb', línea 30

def advertencia(funcionalidad, mensaje)
  MUTEX.sincronizar hacer
    return si ¿Advertido?(funcionalidad)

    ¡advertido!(funcionalidad)
    log_warn("[DESUSO:#{funcionalidad}] #{message}")
  end
end

#¡advertido!(funcionalidad) ⇒ Objeto

Este método es parte de una API privada. Se debe evitar el uso de este método si es posible, ya que podría eliminarse o modificarse en el futuro.

Marca que se ha emitido una advertencia para una funcionalidad obsoleta determinada.

Parámetros:

  • funcionalidad (String | Symbol) —

    La funcionalidad obsoleta.



52
53
54
55
 
# Archivo 'lib/mongo/deprecations.rb', línea 52

def ¡advertido!(funcionalidad)
  MUTEX.sincronizar { ¡advertido!(funcionalidad) }
  nulo
end

#¿advertido?(funcionalidad, prefix: false) ⇒ true | false

Este método es parte de una API privada. Se debe evitar el uso de este método si es posible, ya que podría eliminarse o modificarse en el futuro.

Verifica si ya se ha emitido una advertencia para una funcionalidad obsoleta especificada.

Parámetros:

  • funcionalidad (String | Symbol) —

    La funcionalidad obsoleta.

  • prefix (true | false) (por defecto: false) —

    Indica si se deben buscar coincidencias de prefijo.

Devuelve:

  • (true | false) —

    Si ya se ha emitido una advertencia.



45
46
47
 
# Archivo 'lib/mongo/deprecations.rb', línea 45

def ¿Avisado?(funcionalidad, prefix: false)
  MUTEX.sincronizar { ¿Advertido?(funcionalidad, prefix: prefix) }
end