Module: Sequel::Deprecation
- Defined in:
- lib/sequel_core/deprecated.rb
Overview
This module makes it easy to add deprecation functionality to other classes.
Class Method Summary collapse
-
.deprecate(message) ⇒ Object
Puts the messages unaltered to the deprecation message stream.
-
.deprecation_message_stream=(file) ⇒ Object
This sets the output stream for the deprecation messages.
-
.print_tracebacks=(pt) ⇒ Object
Set this to true to print tracebacks with every deprecation message, so you can see exactly where in your code the deprecated methods are being called.
Instance Method Summary collapse
-
#deprecate(meth, message = nil) ⇒ Object
Formats the message with a message that it will be removed in Sequel 2.0.
Class Method Details
.deprecate(message) ⇒ Object
Puts the messages unaltered to the deprecation message stream
19 20 21 22 23 24 |
# File 'lib/sequel_core/deprecated.rb', line 19 def self.deprecate() if @dms @dms.puts() caller.each{|c| @dms.puts(c)} if @pt end end |
.deprecation_message_stream=(file) ⇒ Object
This sets the output stream for the deprecation messages. Set it to an IO (or any object that responds to puts) and it will call puts on that object with the deprecation message. Set to nil to ignore deprecation messages.
7 8 9 |
# File 'lib/sequel_core/deprecated.rb', line 7 def self.(file) @dms = file end |
.print_tracebacks=(pt) ⇒ Object
Set this to true to print tracebacks with every deprecation message, so you can see exactly where in your code the deprecated methods are being called.
14 15 16 |
# File 'lib/sequel_core/deprecated.rb', line 14 def self.print_tracebacks=(pt) @pt = pt end |
Instance Method Details
#deprecate(meth, message = nil) ⇒ Object
Formats the message with a message that it will be removed in Sequel 2.0. This is the method that is added to the classes that include Sequel::Deprecation.
28 29 30 |
# File 'lib/sequel_core/deprecated.rb', line 28 def deprecate(meth, = nil) ::Sequel::Deprecation.deprecate("#{meth} is deprecated, and will be removed in Sequel 2.0.#{" #{}." if }") end |