Class: RuboCop::ConfigValidator

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Defined in:
lib/rubocop/config_validator.rb

Overview

Handles validation of configuration, for example cop names, parameter names, and Ruby versions.

Constant Summary collapse

COMMON_PARAMS =

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. 

%w[Exclude Include Severity inherit_mode
AutoCorrect StyleGuide Details].freeze
INTERNAL_PARAMS =

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. 

%w[Description StyleGuide
VersionAdded VersionChanged VersionRemoved
Reference Safe SafeAutoCorrect].freeze
NEW_COPS_VALUES =

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. 

%w[pending disable enable].freeze

Instance Method Summary collapse

Constructor Details

#initialize(config) ⇒ ConfigValidator

Returns a new instance of ConfigValidator.


28
29
30
31
32
 
# File 'lib/rubocop/config_validator.rb', line 28

def initialize(config)
  @config = config
  @config_obsoletion = ConfigObsoletion.new(config)
  @target_ruby = TargetRuby.new(config)
end

Instance Method Details

#target_ruby_version ⇒ Object 


56
57
58
 
# File 'lib/rubocop/config_validator.rb', line 56

def target_ruby_version
  target_ruby.version
end

#validate ⇒ Object 


34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/rubocop/config_validator.rb', line 34

def validate
  check_cop_config_value(@config)
  reject_conflicting_safe_settings

  # Don't validate RuboCop's own files further. Avoids infinite recursion.
  return if @config.internal?

  valid_cop_names, invalid_cop_names = @config.keys.partition do |key|
    ConfigLoader.default_configuration.key?(key)
  end

  check_obsoletions

  alert_about_unrecognized_cops(invalid_cop_names)
  check_target_ruby
  validate_new_cops_parameter
  validate_parameter_names(valid_cop_names)
  validate_enforced_styles(valid_cop_names)
  validate_syntax_cop
  reject_mutually_exclusive_defaults
end

#validate_section_presence(name) ⇒ Object

Raises:


60
61
62
63
64
65
 
# File 'lib/rubocop/config_validator.rb', line 60

def validate_section_presence(name)
  return unless @config.key?(name) && @config[name].nil?

  raise ValidationError,
        "empty section #{name} found in #{smart_loaded_path}"
end