W3cubDocs

/Ruby on Rails 6.0

module ActiveSupport::Deprecation::Reporting

Constants

RAILS_GEM_ROOT

Attributes

gem_name[RW]

Name of gem where method is deprecated

silenced[RW]

Whether to print a message (silent mode)

Public Instance Methods

deprecation_warning(deprecated_method_name, message = nil, caller_backtrace = nil) Show source

# File activesupport/lib/active_support/deprecation/reporting.rb, line 43
def deprecation_warning(deprecated_method_name, message = nil, caller_backtrace = nil)
  caller_backtrace ||= caller_locations(2)
  deprecated_method_warning(deprecated_method_name, message).tap do |msg|
    warn(msg, caller_backtrace)
  end
end

silence() { || ... } Show source

# File activesupport/lib/active_support/deprecation/reporting.rb, line 36
def silence
  old_silenced, @silenced = @silenced, true
  yield
ensure
  @silenced = old_silenced
end

Silence deprecation warnings within the block.

ActiveSupport::Deprecation.warn('something broke!')
# => "DEPRECATION WARNING: something broke! (called from your_code.rb:1)"

ActiveSupport::Deprecation.silence do
  ActiveSupport::Deprecation.warn('something broke!')
end
# => nil

warn(message = nil, callstack = nil) Show source

# File activesupport/lib/active_support/deprecation/reporting.rb, line 18
def warn(message = nil, callstack = nil)
  return if silenced

  callstack ||= caller_locations(2)
  deprecation_message(callstack, message).tap do |m|
    behavior.each { |b| b.call(m, callstack, deprecation_horizon, gem_name) }
  end
end

Outputs a deprecation warning to the output configured by ActiveSupport::Deprecation.behavior.

ActiveSupport::Deprecation.warn('something broke!')
# => "DEPRECATION WARNING: something broke! (called from your_code.rb:1)"