跳至内容 跳至搜索
方法
A
D
S
W

属性

[RW] gem_name

弃用方法所在的 gem 的名称
[W] silenced

是否打印消息（静默模式）

实例公共方法

allow(allowed_warnings = :all, if: true, &block)

在块内允许先前不允许的弃用警告。allowed_warnings 可以是包含字符串、符号或正则表达式的数组。（符号被视为字符串）。这些与块内生成的弃用警告消息的文本进行比较。匹配的警告将免受 ActiveSupport::Deprecation#disallowed_warnings 设置的规则约束。

可选的 if: 参数接受一个真/假值或响应 .call 的对象。如果为真，则允许匹配的警告。如果为假，则该方法在不允许多警告的情况下向块中传递。

deprecator = ActiveSupport::Deprecation.new
deprecator.disallowed_behavior = :raise
deprecator.disallowed_warnings = [
  "something broke"
]

deprecator.warn('something broke!')
# => ActiveSupport::DeprecationException

deprecator.allow ['something broke'] do
  deprecator.warn('something broke!')
end
# => nil

deprecator.allow ['something broke'], if: Rails.env.production? do
  deprecator.warn('something broke!')
end
# => ActiveSupport::DeprecationException for dev/test, nil for production

来源：显示 | 在 GitHub 上

# File activesupport/lib/active_support/deprecation/reporting.rb, line 89
def allow(allowed_warnings = :all, if: true, &block)
  conditional = binding.local_variable_get(:if)
  conditional = conditional.call if conditional.respond_to?(:call)
  if conditional
    @explicitly_allowed_warnings.bind(allowed_warnings, &block)
  else
    yield
  end
end

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

来源：显示 | 在 GitHub 上

# File activesupport/lib/active_support/deprecation/reporting.rb, line 99
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(&block)

在块内静默弃用警告。

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

deprecator.silence do
  deprecator.warn('something broke!')
end
# => nil

来源：显示 | 在 GitHub 上

# File activesupport/lib/active_support/deprecation/reporting.rb, line 41
def silence(&block)
  begin_silence
  block.call
ensure
  end_silence
end

silenced()

来源：显示 | 在 GitHub 上

# File activesupport/lib/active_support/deprecation/reporting.rb, line 56
def silenced
  @silenced || @silence_counter.value.nonzero?
end

warn(message = nil, callstack = nil)

将弃用警告输出到由 ActiveSupport::Deprecation#behavior 配置的输出。

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

来源：显示 | 在 GitHub 上

# 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 |full_message|
    if deprecation_disallowed?(message)
      disallowed_behavior.each { |b| b.call(full_message, callstack, self) }
    else
      behavior.each { |b| b.call(full_message, callstack, self) }
    end
  end
end