Class: Testable::Deprecator

Inherits:
Object show all
Defined in:
lib/testable/deprecator.rb

Class Method Summary collapse

Class Method Details

.deprecate(current, upcoming = nil, known_version = nil) ⇒ Object 



4
5
6
7
8
9
10
11
12
13
14
15
16
17
 
# File 'lib/testable/deprecator.rb', line 4

def deprecate(current, upcoming = nil, known_version = nil)
  if upcoming
    warn(
      "#{current} is being deprecated and should no longer be used. \
      Use #{upcoming} instead."
    )
  else
    warn("#{current} is being deprecated and should no longer be used.")
  end

  warn(
    "#{current} will be removed in Testable #{known_version}."
  ) if known_version
end

.soft_deprecate(current, reason, known_version, upcoming = nil) ⇒ Object 



19
20
21
22
23
24
25
26
27
 
# File 'lib/testable/deprecator.rb', line 19

def soft_deprecate(current, reason, known_version, upcoming = nil)
  debug("The #{current} method is changing and is now configurable.")
  debug("REASON: #{reason}.")
  debug(
    "Moving forwards into Testable #{known_version}, \
    the default behavior will change."
  )
  debug("It is advised that you change to using #{upcoming}") if upcoming
end