RSpec
Ruby on Rails
Ruby
method
deprecate_methods
Ruby on Rails latest stable (v6.1.7.7)
-
0 notes -
Class: MethodWrapper
- 1.0.0
- 1.1.6
- 1.2.6
- 2.0.3
- 2.1.0
- 2.2.1
- 2.3.8
- 3.0.0
- 3.0.9
- 3.1.0
- 3.2.1
- 3.2.8
- 3.2.13
- 4.0.2 (0)
- 4.1.8 (0)
- 4.2.1 (0)
- 4.2.7 (0)
- 4.2.9 (0)
- 5.0.0.1 (38)
- 5.1.7 (-1)
- 5.2.3 (0)
- 6.0.0 (0)
- 6.1.3.1 (0)
- 6.1.7.7 (0)
- 7.0.0 (0)
- 7.1.3.2 (-28)
- What's this?
= private
= protected
deprecate_methods(target_module, *method_names)
public
Declare that a method has been deprecated.
class Fred def aaa; end def bbb; end def ccc; end def ddd; end def eee; end end
Using the default deprecator:
ActiveSupport::Deprecation.deprecate_methods(Fred, :aaa, bbb: :zzz, ccc: 'use Bar#ccc instead') # => Fred Fred.new.aaa # DEPRECATION WARNING: aaa is deprecated and will be removed from Rails 5.1. (called from irb_binding at (irb):10) # => nil Fred.new.bbb # DEPRECATION WARNING: bbb is deprecated and will be removed from Rails 5.1 (use zzz instead). (called from irb_binding at (irb):11) # => nil Fred.new.ccc # DEPRECATION WARNING: ccc is deprecated and will be removed from Rails 5.1 (use Bar#ccc instead). (called from irb_binding at (irb):12) # => nil
Passing in a custom deprecator:
custom_deprecator = ActiveSupport::Deprecation.new('next-release', 'MyGem') ActiveSupport::Deprecation.deprecate_methods(Fred, ddd: :zzz, deprecator: custom_deprecator) # => [:ddd] Fred.new.ddd DEPRECATION WARNING: ddd is deprecated and will be removed from MyGem next-release (use zzz instead). (called from irb_binding at (irb):15) # => nil
Using a custom deprecator directly:
custom_deprecator = ActiveSupport::Deprecation.new('next-release', 'MyGem') custom_deprecator.deprecate_methods(Fred, eee: :zzz) # => [:eee] Fred.new.eee DEPRECATION WARNING: eee is deprecated and will be removed from MyGem next-release (use zzz instead). (called from irb_binding at (irb):18) # => nil
