Módulo: Mongoid::Deprecable Privado

Incluido en:
Mongoid
Definido en:
lib/mongoid/deprecable.rb

Overview

Este módulo forma parte de una API privada. Debe evitar su uso siempre que sea posible, ya que podría eliminarse o modificarse en el futuro.

Agrega la capacidad de declarar desusos específicos de Mongoid.

Resumen del método de instancia colapsar

Detalles del método de instancia

#deprecate(target_module, *method_descriptors) ⇒ objeto

Este método forma parte de una API privada. Debe evitarlo si es posible, ya que podría eliminarse o modificarse en el futuro.

Declara el/los método(s) obsoleto(s).

Ejemplos:

Descontinuar un método.

Mongoid.deprecate(Cat, :meow); Cat.new.meow
#=> Mongoid.logger.warn("meow is deprecated and will be removed from Mongoid 8.0")

Deprérquese un método y declare el método de reemplazo.

Mongoid.deprecate(Cat, meow: :speak); Cat.new.meow
#=> Mongoid.logger.warn("meow is deprecated and will be removed from Mongoid 8.0 (use speak instead)")

Obsolece un método y proporciona instrucciones de reemplazo.

Mongoid.deprecate(Cat, meow: 'eat :catnip instead'); Cat.new.meow
#=> Mongoid.logger.warn("meow is deprecated and will be removed from Mongoid 8.0 (eat :catnip instead)")

Parámetros:

  • target_module (Módulo) —

    El padre que contiene el método.

  • *descriptores_de_método ([ Símbolo | Hash<Símbolo, [ Símbolo | String ]> ]...) —

    Los métodos para descontinuar, con instrucciones de reemplazo opcionales.



30
31
32
33
 
# Archivo 'lib/mongoid/deprecable.rb', línea 30

def desaconsejar(target_module, *descriptores de métodos)
  @_deprecatador ||= Mongoid::Obsolescencia.Nuevo
  @_deprecatador.deprecate_methods(target_module, *descriptores de métodos)
end