跳到內容 跳到搜尋
方法
A
D
S
W

屬性

[RW] gem_name

方法已於此 Gem 中停用
[W] silenced

是否要印出訊息（靜音模式）

執行個體公開方法

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

在區塊內允許先前已停用的方法停用警告。allowed_warnings 可以是包含字串、符號或正規表示式的陣列。（符號會當作字串處理）。這些字串會與區塊中產生的方法停用警告訊息進行比對。符合條件的警告將會被豁免在 ActiveSupport::Deprecation#disallowed_warnings 中所設定的規則之外。

選用的 if: 參數接受 true/false 值或是一個物件，該物件可以對 .call 進行回應。如果為 true，則會允許符合條件的警告。如果為 false，則方法會在不允許警告的情況下傳遞到區塊。

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