diff options
| author | Ryan Bigg <radarlistener@gmail.com> | 2010-12-20 11:50:47 +1000 |
|---|---|---|
| committer | Ryan Bigg <radarlistener@gmail.com> | 2010-12-21 10:40:15 +1000 |
| commit | 1cacb08b213e9d0f92cf1fad89ff10141211bce8 (patch) | |
| tree | d08e3c5110d1853a45ceef122a52966b7a525d79 /activesupport/lib/active_support/deprecation | |
| parent | 8373c735c7dc8adeffffbf85176676fecb6221fc (diff) | |
| download | rails-1cacb08b213e9d0f92cf1fad89ff10141211bce8.tar.gz rails-1cacb08b213e9d0f92cf1fad89ff10141211bce8.tar.bz2 rails-1cacb08b213e9d0f92cf1fad89ff10141211bce8.zip | |
Improve documentation on ActiveSupport::Deprecation.
Diffstat (limited to 'activesupport/lib/active_support/deprecation')
| -rw-r--r-- | activesupport/lib/active_support/deprecation/behaviors.rb | 7 | ||||
| -rw-r--r-- | activesupport/lib/active_support/deprecation/reporting.rb | 8 |
2 files changed, 14 insertions, 1 deletions
diff --git a/activesupport/lib/active_support/deprecation/behaviors.rb b/activesupport/lib/active_support/deprecation/behaviors.rb index f54f65dcf0..da4af339fc 100644 --- a/activesupport/lib/active_support/deprecation/behaviors.rb +++ b/activesupport/lib/active_support/deprecation/behaviors.rb @@ -7,10 +7,17 @@ module ActiveSupport # Whether to print a backtrace along with the warning. attr_accessor :debug + # Returns the set behaviour or if one isn't set, defaults to +:stderr+ def behavior @behavior ||= [DEFAULT_BEHAVIORS[:stderr]] end + # Sets the behaviour to the specified value. Can be a single value or an array. + # + # Examples + # + # ActiveSupport::Deprecation.behavior = :stderr + # ActiveSupport::Deprecation.behavior = [:stderr, :log] def behavior=(behavior) @behavior = Array.wrap(behavior).map { |b| DEFAULT_BEHAVIORS[b] || b } end diff --git a/activesupport/lib/active_support/deprecation/reporting.rb b/activesupport/lib/active_support/deprecation/reporting.rb index 6a7b11c7e0..c7723d139b 100644 --- a/activesupport/lib/active_support/deprecation/reporting.rb +++ b/activesupport/lib/active_support/deprecation/reporting.rb @@ -2,7 +2,13 @@ module ActiveSupport module Deprecation class << self attr_accessor :silenced - + + # Outputs a deprecation warning to the output configured by <tt>ActiveSupport::Deprecation.behavior</tt> + # + # Example: + # + # ActiveSupport::Deprecation.warn("something broke!") + # #=> "DEPRECATION WARNING: something broke! (called from your_code.rb:1)" def warn(message = nil, callstack = caller) return if silenced deprecation_message(callstack, message).tap do |m| |