Module: Deprecated

Defined in:
lib/cxxproject/utils/deprecated.rb

Overview

modified from http://www.seejohncode.com/2012/01/09/deprecating-methods-in-ruby/

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#deprecated_warnings ⇒ Object

Returns the value of attribute deprecated_warnings.



3
4
5
 
# File 'lib/cxxproject/utils/deprecated.rb', line 3

def deprecated_warnings
  @deprecated_warnings
end

Instance Method Details

#deprecated_alias(name, replacement) ⇒ Object

Define a deprecated alias for a method

Parameters:

  • name (Symbol) —
    • name of method to define
  • replacement (Symbol) —
    • name of method to (alias)


12
13
14
15
16
17
18
19
20
21
 
# File 'lib/cxxproject/utils/deprecated.rb', line 12

def deprecated_alias(name, replacement)
  define_method(name) do |*args, &block|
    self.class.deprecated_warnings ||= {}
    if self.class.deprecated_warnings.has_key?(name) == false
      warn "#{self.class.name}##{name} deprecated (please use ##{replacement})"
      self.class.deprecated_warnings[name] = true
    end
    send replacement, *args, &block
  end
end

#reset ⇒ Object 



5
6
7
 
# File 'lib/cxxproject/utils/deprecated.rb', line 5

def reset
  self.deprecated_warnings = {}
end