Module: ActiveSupport::Deprecation

### Home Classes Methods

### In Files

- lib/active_support/deprecation.rb
- lib/active_support/deprecation/behaviors.rb
- lib/active_support/deprecation/method_wrappers.rb
- lib/active_support/deprecation/proxy_wrappers.rb
- lib/active_support/deprecation/reporting.rb

### Methods

- ::behavior
- ::behavior=
- ::deprecate_methods
- ::deprecated_method_warning
- ::silence
- ::warn

### Class/Module Index

Quicksearch

- ActiveSupport
- ActiveSupport::Autoload
- ActiveSupport::BacktraceCleaner
- ActiveSupport::Base64
- ActiveSupport::BasicObject
- ActiveSupport::Benchmarkable
- ActiveSupport::BufferedLogger
- ActiveSupport::BufferedLogger::Severity
- ActiveSupport::Cache
- ActiveSupport::Cache::Entry
- ActiveSupport::Cache::FileStore
- ActiveSupport::Cache::MemCacheStore
- ActiveSupport::Cache::MemoryStore
- ActiveSupport::Cache::NullStore
- ActiveSupport::Cache::Store
- ActiveSupport::Cache::Strategy
- ActiveSupport::Cache::Strategy::LocalCache
- ActiveSupport::Cache::Strategy::LocalCache::LocalStore
- ActiveSupport::Callbacks
- ActiveSupport::Callbacks::ClassMethods
- ActiveSupport::Concern
- ActiveSupport::Configurable
- ActiveSupport::Configurable::ClassMethods
- ActiveSupport::Configurable::Configuration
- ActiveSupport::Dependencies
- ActiveSupport::Dependencies::ClassCache
- ActiveSupport::Dependencies::WatchStack
- ActiveSupport::Deprecation
- ActiveSupport::DescendantsTracker
- ActiveSupport::Duration
- ActiveSupport::FileUpdateChecker
- ActiveSupport::FileWatcher
- ActiveSupport::FileWatcher::Backend
- ActiveSupport::Gzip
- ActiveSupport::Gzip::Stream
- ActiveSupport::HashWithIndifferentAccess
- ActiveSupport::HashWithIndifferentAccess
- ActiveSupport::Inflector
- ActiveSupport::Inflector::Inflections
- ActiveSupport::InheritableOptions
- ActiveSupport::JSON
- ActiveSupport::JSON::Encoding
- ActiveSupport::JSON::Encoding::CircularReferenceError
- ActiveSupport::JSON::Encoding::Encoder
- ActiveSupport::JSON::Variable
- ActiveSupport::LogSubscriber
- ActiveSupport::LogSubscriber::TestHelper
- ActiveSupport::LogSubscriber::TestHelper::MockLogger
- ActiveSupport::Memoizable
- ActiveSupport::Memoizable::InstanceMethods
- ActiveSupport::MessageEncryptor
- ActiveSupport::MessageEncryptor::InvalidMessage
- ActiveSupport::MessageVerifier
- ActiveSupport::MessageVerifier::InvalidSignature
- ActiveSupport::Multibyte
- ActiveSupport::Multibyte::Chars
- ActiveSupport::Multibyte::EncodingError
- ActiveSupport::Multibyte::Unicode
- ActiveSupport::Multibyte::Unicode::Codepoint
- ActiveSupport::Multibyte::Unicode::UnicodeDatabase
- ActiveSupport::Notifications
- ActiveSupport::Notifications::Event
- ActiveSupport::Notifications::Fanout
- ActiveSupport::Notifications::Instrumenter
- ActiveSupport::OrderedHash
- ActiveSupport::OrderedOptions
- ActiveSupport::Railtie
- ActiveSupport::Rescuable
- ActiveSupport::Rescuable::ClassMethods
- ActiveSupport::SafeBuffer
- ActiveSupport::SafeBuffer::SafeConcatError
- ActiveSupport::StringInquirer
- ActiveSupport::TaggedLogging
- ActiveSupport::TestCase
- ActiveSupport::Testing
- ActiveSupport::Testing::Assertions
- ActiveSupport::Testing::Declarative
- ActiveSupport::Testing::Isolation
- ActiveSupport::Testing::Isolation::Forking
- ActiveSupport::Testing::Isolation::MiniTest
- ActiveSupport::Testing::Isolation::Subprocess
- ActiveSupport::Testing::Isolation::TestUnit
- ActiveSupport::Testing::Pending
- ActiveSupport::Testing::Performance
- ActiveSupport::Testing::Performance::Benchmarker
- ActiveSupport::Testing::Performance::ForClassicTestUnit
- ActiveSupport::Testing::Performance::ForMiniTest
- ActiveSupport::Testing::Performance::Metrics
- ActiveSupport::Testing::Performance::Metrics::Amount
- ActiveSupport::Testing::Performance::Metrics::Base
- ActiveSupport::Testing::Performance::Metrics::CpuTime
- ActiveSupport::Testing::Performance::Metrics::DigitalInformationUnit
- ActiveSupport::Testing::Performance::Metrics::GcRuns
- ActiveSupport::Testing::Performance::Metrics::GcTime
- ActiveSupport::Testing::Performance::Metrics::Memory
- ActiveSupport::Testing::Performance::Metrics::Objects
- ActiveSupport::Testing::Performance::Metrics::ProcessTime
- ActiveSupport::Testing::Performance::Metrics::Time
- ActiveSupport::Testing::Performance::Metrics::UserTime
- ActiveSupport::Testing::Performance::Metrics::WallTime
- ActiveSupport::Testing::Performance::Performer
- ActiveSupport::Testing::Performance::Profiler
- ActiveSupport::Testing::ProxyTestResult
- ActiveSupport::Testing::RemoteError
- ActiveSupport::Testing::SetupAndTeardown
- ActiveSupport::Testing::SetupAndTeardown::ClassMethods
- ActiveSupport::Testing::SetupAndTeardown::ForClassicTestUnit
- ActiveSupport::Testing::SetupAndTeardown::ForMiniTest
- ActiveSupport::TimeWithZone
- ActiveSupport::TimeZone
- ActiveSupport::XmlMini
- ActiveSupport::XmlMini_LibXMLSAX
- ActiveSupport::XmlMini_LibXMLSAX::HashBuilder
- ActiveSupport::XmlMini_NokogiriSAX
- ActiveSupport::XmlMini_NokogiriSAX::HashBuilder
- Test
- Test::Unit
- Test::Unit::Collector
- Test::Unit::Collector::ObjectSpace
- Object
- Object::HashWithIndifferentAccess
- Object::MissingSourceFile
- ERB
- ERB::Util
- I18n
- I18n::Railtie
- LoadError
- LoadError
- Logger
- Logger::SimpleFormatter
- Array
- Base64
- Benchmark
- BigDecimal
- Class
- Date
- DateTime
- Enumerable
- FalseClass
- File
- Float
- Hash
- Integer
- Kernel
- Module
- NameError
- NilClass
- Numeric
- Process
- QualifiedConstUtils
- Range
- Regexp
- String
- Symbol
- Time
- TrueClass
- URI

No matching classes.

# ActiveSupport::Deprecation

### Constants

DEFAULT_BEHAVIORS

  Default warning behaviors per Rails.env.

### Attributes

debug[RW]

Whether to print a backtrace along with the warning.

deprecation_horizon[RW]

The version the deprecated behavior will be removed, by default.

silenced[RW]

### Public Class Methods

behavior() click to toggle source

Returns the set behavior or if one isn’t set, defaults to `:stderr`

    # File lib/active_support/deprecation/behaviors.rb, line 11
    def behavior
      @behavior ||= [DEFAULT_BEHAVIORS[:stderr]]
    end

behavior=(behavior) click to toggle source

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]

    # File lib/active_support/deprecation/behaviors.rb, line 21
    def behavior=(behavior)
      @behavior = Array.wrap(behavior).map { |b| DEFAULT_BEHAVIORS[b] || b }
    end

deprecate_methods(target_module, *method_names) click to toggle source

Declare that a method has been deprecated.

    # File 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

deprecated_method_warning(method_name, message = nil) click to toggle source

    # File 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() click to toggle source

Silence deprecation warnings within the block.

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

warn(message = nil, callstack = caller) click to toggle source

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)"

    # File lib/active_support/deprecation/reporting.rb, line 10
    def warn(message = nil, callstack = caller)
      return if silenced
      deprecation_message(callstack, message).tap do |m|
        behavior.each { |b| b.call(m, callstack) }
      end
    end

[Validate]

Generated with the Darkfish Rdoc Generator 2.