Class: ActiveSupport::Deprecation::Deprecators
Relationships & Source Files | |
Inherits: | Object |
Defined in: | activesupport/lib/active_support/deprecation/deprecators.rb |
Overview
A managed collection of deprecators. Configuration methods, such as #behavior=, affect all deprecators in the collection. Additionally, the #silence method silences all deprecators in the collection for the duration of a given block.
Class Method Summary
- .new ⇒ Deprecators constructor
Instance Attribute Summary
-
#behavior=(behavior)
writeonly
Sets the deprecation warning behavior for all deprecators in this collection.
-
#debug=(debug)
writeonly
Sets the debug flag for all deprecators in this collection.
-
#disallowed_behavior=(disallowed_behavior)
writeonly
Sets the disallowed deprecation warning behavior for all deprecators in this collection.
-
#disallowed_warnings=(disallowed_warnings)
writeonly
Sets the disallowed deprecation warnings for all deprecators in this collection.
-
#silenced=(silenced)
writeonly
Sets the silenced flag for all deprecators in this collection.
Instance Method Summary
-
#[](name)
Returns a deprecator added to this collection via #[]=.
-
#[]=(name, deprecator)
Adds a given ActiveSupport.deprecator to this collection.
-
#each(&block)
Iterates over all deprecators in this collection.
-
#silence(&block)
Silences all deprecators in this collection for the duration of the given block.
Constructor Details
.new ⇒ Deprecators
# File 'activesupport/lib/active_support/deprecation/deprecators.rb', line 10
def initialize @options = {} @deprecators = {} end
Instance Attribute Details
#behavior=(behavior) (writeonly)
Sets the deprecation warning behavior for all deprecators in this collection.
See ActiveSupport::Deprecation#behavior=
.
# File 'activesupport/lib/active_support/deprecation/deprecators.rb', line 60
def behavior=(behavior) set_option(:behavior, behavior) end
#debug=(debug) (writeonly)
Sets the debug flag for all deprecators in this collection.
# File 'activesupport/lib/active_support/deprecation/deprecators.rb', line 52
def debug=(debug) set_option(:debug, debug) end
#disallowed_behavior=(disallowed_behavior) (writeonly)
Sets the disallowed deprecation warning behavior for all deprecators in this collection.
See ActiveSupport::Deprecation#disallowed_behavior=
.
# File 'activesupport/lib/active_support/deprecation/deprecators.rb', line 68
def disallowed_behavior=(disallowed_behavior) set_option(:disallowed_behavior, disallowed_behavior) end
#disallowed_warnings=(disallowed_warnings) (writeonly)
Sets the disallowed deprecation warnings for all deprecators in this collection.
See ActiveSupport::Deprecation#disallowed_warnings=
.
# File 'activesupport/lib/active_support/deprecation/deprecators.rb', line 76
def disallowed_warnings=(disallowed_warnings) set_option(:disallowed_warnings, disallowed_warnings) end
#silenced=(silenced) (writeonly)
Sets the silenced flag for all deprecators in this collection.
# File 'activesupport/lib/active_support/deprecation/deprecators.rb', line 47
def silenced=(silenced) set_option(:silenced, silenced) end
Instance Method Details
#[](name)
Returns a deprecator added to this collection via #[]=.
# File 'activesupport/lib/active_support/deprecation/deprecators.rb', line 16
def [](name) @deprecators[name] end
#[]=(name, deprecator)
Adds a given ActiveSupport.deprecator to this collection. The deprecator will be immediately configured with any options previously set on this collection.
deprecators = ActiveSupport::Deprecation::Deprecators.new
deprecators.debug = true
foo_deprecator = ActiveSupport::Deprecation.new("2.0", "Foo")
foo_deprecator.debug # => false
deprecators[:foo] = foo_deprecator
deprecators[:foo].debug # => true
foo_deprecator.debug # => true
# File 'activesupport/lib/active_support/deprecation/deprecators.rb', line 34
def []=(name, deprecator) (deprecator) @deprecators[name] = deprecator end
#each(&block)
Iterates over all deprecators in this collection. If no block is given, returns an Enumerator
.
# File 'activesupport/lib/active_support/deprecation/deprecators.rb', line 41
def each(&block) return to_enum(__method__) unless block @deprecators.each_value(&block) end
#silence(&block)
Silences all deprecators in this collection for the duration of the given block.
See ActiveSupport::Deprecation#silence
.
# File 'activesupport/lib/active_support/deprecation/deprecators.rb', line 84
def silence(&block) each { |deprecator| deprecator.begin_silence } block.call ensure each { |deprecator| deprecator.end_silence } end