class Deprecation

Ruby on Rails 8.0.5.1

Since v4.0.13

Available in: v4.0.13 v4.1.16 v4.2.11.3 v5.0.7.2 v5.1.7 v5.2.8.1 v6.0.6.1 v6.1.7.10 v7.0.10 v7.1.6 v7.2.4 v8.0.5.1 v8.1.4 edge

Compare with: (choosing a version navigates to the comparison)

Active Support Deprecation

Deprecation specifies the API used by Rails to deprecate methods, instance variables, objects, and constants. It’s also available for gems or applications.

For a gem, use Deprecation.new to create a Deprecation object and store it in your module or class (in order for users to be able to configure it).

module MyLibrary
  def self.deprecator
    @deprecator ||= ActiveSupport::Deprecation.new("2.0", "MyLibrary")
  end
end

For a Railtie or Engine, you may also want to add it to the application’s deprecators, so that the application’s configuration can be applied to it.

module MyLibrary
  class Railtie < Rails::Railtie
    initializer "my_library.deprecator" do |app|
      app.deprecators[:my_library] = MyLibrary.deprecator
    end
  end
end

With the above initializer, configuration settings like the following will affect MyLibrary.deprecator:

# in config/environments/test.rb
config.active_support.deprecation = :raise

Inherits from

Object

Namespace

Modules

Classes

Includes

Constants

Attributes

ActiveSupport::Deprecation#deprecation_horizon

Methods (defined here)

self. new

Methods (inherited)

From ActiveSupport::Deprecation::Behavior (4)

From ActiveSupport::Deprecation::Disallowed (1)

# disallowed_warnings

From ActiveSupport::Deprecation::MethodWrapper (1)

# deprecate_methods

From ActiveSupport::Deprecation::Reporting (5)

From Object (17)

From ActiveSupport::NumericWithFormat (2)

# to_formatted_s
# to_fs