Módulo: Mongoid::Deprecable Private

Incluído em:
Mongoid
Definido em:
lib/mongoid/deprecable.rb

Visão geral

Este módulo faz parte de uma API privada. Você deve evitar usar este módulo, se possível, pois ele pode ser removido ou alterado no futuro.

Adiciona a capacidade de declarar depreciações específicas do Mongoide.

Recolhimento do Resumo do método de instância

Detalhes do método de instância

#obsoleto(target_module, *method_descriptors) ➤ Objeto

Este método faz parte de uma API privada. Evite usar esse método, se possível, pois ele pode ser removido ou alterado no futuro.

Declara método(s) como obsoleto(s).

Exemplos:

Descontinuar um método.

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

Desative um método e declare o método de substituição.

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)")

Descontinuar um método e dar instruções de substituição.

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) —

    O principal que contém o método.

  • *method_descriptors ([ Símbolo | Hash<Símbolo, [ Símbolo | string ]> ]...) —

    Os métodos para descontinuar, com instruções de substituição opcionais.



30
31
32
33
 
# Arquivo 'lib/mongoid/deprecable.rb', linha 30

def depreciar(target_module, *method_descriptors)
  @_deprecator ||= Mongoid::Descontinuação.Novo
  @_deprecator.deprecate_methods(target_module, *method_descriptors)
end