Methods
Constants
DEFAULT_BEHAVIORS | = | { :stderr => Proc.new { |message, callstack| $stderr.puts(message) $stderr.puts callstack.join("\n ") if debug }, :log => Proc.new { |message, callstack| logger = if defined?(Rails) && Rails.logger Rails.logger else require 'logger' Logger.new($stderr) end logger.warn message logger.debug callstack.join("\n ") if debug }, :notify => Proc.new { |message, callstack| ActiveSupport::Notifications.instrument("deprecation.rails", :message => message, :callstack => callstack) } } |
Default warning behaviors per Rails.env. |
Attributes
[RW] | debug | Whether to print a backtrace along with the warning. |
[RW] | deprecation_horizon | The version the deprecated behavior will be removed, by default. |
[RW] | silenced |
Class Public methods
Returns the set behavior or if one isn’t set, defaults to
:stderr
Sets the behavior to the specified value. Can be a single value or an array.
Examples
ActiveSupport::Deprecation.behavior = :stderr ActiveSupport::Deprecation.behavior = [:stderr, :log]
Declare that a method has been deprecated.
# File activesupport/lib/active_support/deprecation/method_wrappers.rb, line 8 def deprecate_methods(target_module, *method_names) options = method_names.extract_options! method_names += options.keys method_names.each do |method_name| target_module.alias_method_chain(method_name, :deprecation) do |target, punctuation| target_module.module_eval(" def #{target}_with_deprecation#{punctuation}(*args, &block) ::ActiveSupport::Deprecation.warn( ::ActiveSupport::Deprecation.deprecated_method_warning( :#{method_name}, #{options[method_name].inspect}), caller ) send(:#{target}_without_deprecation#{punctuation}, *args, &block) end ", __FILE__, __LINE__ + 1) end end end
# File activesupport/lib/active_support/deprecation/reporting.rb, line 25 def deprecated_method_warning(method_name, message = nil) warning = "#{method_name} is deprecated and will be removed from Rails #{deprecation_horizon}" case message when Symbol then "#{warning} (use #{message} instead)" when String then "#{warning} (#{message})" else warning end end
Silence deprecation warnings within the block.
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)"