Class: RuboCop::ConfigObsoletion::ChangedParameter Private

Inherits:
ParameterRule show all
Defined in:
lib/rubocop/config_obsoletion/changed_parameter.rb

Overview

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

Encapsulation of a ConfigObsoletion rule for changing a parameter

Constant Summary collapse

BASE_MESSAGE =

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

'obsolete parameter `%<parameter>s` (for `%<cop>s`) found in %<path>s'

Instance Attribute Summary

Attributes inherited from ParameterRule

#cop, #metadata, #parameter

Instance Method Summary collapse

Methods inherited from ParameterRule

#initialize, #parameter_rule?, #violated?, #warning?

Methods inherited from Rule

#cop_rule?, #initialize, #parameter_rule?, #violated?

Constructor Details

This class inherits a constructor from RuboCop::ConfigObsoletion::ParameterRule

Instance Method Details

#messageObject

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.


10
11
12
13
14
15
16
17
18
# File 'lib/rubocop/config_obsoletion/changed_parameter.rb', line 10

def message
  base = format(BASE_MESSAGE, parameter: parameter, cop: cop, path: smart_loaded_path)

  if alternative
    "#{base}\n`#{parameter}` has been renamed to `#{alternative.chomp}`."
  else
    "#{base}\n#{reason.chomp}"
  end
end