Module: CMDx::Deprecators::Error Private

Extended by:
Error
Included in:
Error
Defined in:
lib/cmdx/deprecators/error.rb

Overview

This module is part of a private API. You should avoid using this module if possible, as it may be removed or be changed in the future.

Raises CMDx::DeprecationError to prevent the task from executing. Use for tasks that must no longer run.

Instance Method Summary collapse

Instance Method Details

#call(task) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Parameters:

Raises:



16
17
18
19
20
21
 
# File 'lib/cmdx/deprecators/error.rb', line 16

def call(task)
  raise DeprecationError, <<~MSG.chomp
    #{task.class} is deprecated and prohibited from execution.
    See https://drexed.github.io/cmdx/deprecation/#error
  MSG
end