Class: RuboCop::Config

Inherits:
Hash
  • Object
show all
Includes:
PathUtil
Defined in:
lib/rubocop/config.rb

Overview

This class represents the configuration of the RuboCop application and all its cops. A Config is associated with a YAML configuration file from which it was read. Several different Configs can be used during a run of the rubocop program, if files in several directories are inspected.

Defined Under Namespace

Classes: ValidationError

Constant Summary collapse

COMMON_PARAMS =
%w(Exclude Include Severity)

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from PathUtil

issue_deprecation_warning, match_path?, relative_path

Constructor Details

#initialize(hash = {}, loaded_path = nil) ⇒ Config

Returns a new instance of Config.


21
22
23
24
25
# File 'lib/rubocop/config.rb', line 21

def initialize(hash = {}, loaded_path = nil)
  @hash = hash
  @loaded_path = loaded_path
  super(@hash)
end

Instance Attribute Details

#loaded_pathObject (readonly)

Returns the value of attribute loaded_path


19
20
21
# File 'lib/rubocop/config.rb', line 19

def loaded_path
  @loaded_path
end

Instance Method Details

#add_excludes_from_higher_level(highest_config) ⇒ Object


39
40
41
42
43
44
45
46
47
48
49
50
51
# File 'lib/rubocop/config.rb', line 39

def add_excludes_from_higher_level(highest_config)
  return unless highest_config['AllCops'] &&
                highest_config['AllCops']['Exclude']

  self['AllCops'] ||= {}
  excludes = self['AllCops']['Exclude'] ||= []
  highest_config['AllCops']['Exclude'].each do |path|
    unless path.is_a?(Regexp) || path.start_with?('/')
      path = File.join(File.dirname(highest_config.loaded_path), path)
    end
    excludes << path unless excludes.include?(path)
  end
end

#add_missing_namespacesObject


83
84
85
86
87
88
89
90
91
# File 'lib/rubocop/config.rb', line 83

def add_missing_namespaces
  keys.each do |k|
    q = Cop::Cop.qualified_cop_name(k, loaded_path)
    next if q == k

    self[q] = self[k]
    delete(k)
  end
end

#base_dir_for_path_parametersObject

Paths specified in .rubocop.yml files are relative to the directory where that file is. Paths in other config files are relative to the current directory. This is so that paths in config/default.yml, for example, are not relative to RuboCop's config directory since that wouldn't work.


141
142
143
144
145
146
147
# File 'lib/rubocop/config.rb', line 141

def base_dir_for_path_parameters
  if File.basename(loaded_path) == ConfigLoader::DOTFILE
    File.expand_path(File.dirname(loaded_path))
  else
    Dir.pwd
  end
end

#cop_enabled?(cop) ⇒ Boolean

Returns:

  • (Boolean)

73
74
75
# File 'lib/rubocop/config.rb', line 73

def cop_enabled?(cop)
  for_cop(cop).nil? || for_cop(cop)['Enabled']
end

#deprecation_checkObject


53
54
55
56
57
58
59
60
61
62
63
64
65
# File 'lib/rubocop/config.rb', line 53

def deprecation_check
  all_cops = self['AllCops']
  return unless all_cops

  %w(Exclude Include).each do |key|
    plural = "#{key}s"
    next unless all_cops[plural]

    all_cops[key] = all_cops[plural] # Stay backwards compatible.
    all_cops.delete(plural)
    yield "AllCops/#{plural} was renamed to AllCops/#{key}"
  end
end

#file_to_exclude?(file) ⇒ Boolean

Returns:

  • (Boolean)

118
119
120
121
122
123
# File 'lib/rubocop/config.rb', line 118

def file_to_exclude?(file)
  file = File.expand_path(file)
  patterns_to_exclude.any? do |pattern|
    match_path?(pattern, file, loaded_path)
  end
end

#file_to_include?(file) ⇒ Boolean

Returns:

  • (Boolean)

111
112
113
114
115
116
# File 'lib/rubocop/config.rb', line 111

def file_to_include?(file)
  relative_file_path = path_relative_to_config(file)
  patterns_to_include.any? do |pattern|
    match_path?(pattern, relative_file_path, loaded_path)
  end
end

#for_cop(cop) ⇒ Object


67
68
69
70
71
# File 'lib/rubocop/config.rb', line 67

def for_cop(cop)
  cop = cop.cop_name if cop.respond_to?(:cop_name)
  @for_cop ||= {}
  @for_cop[cop] ||= self[Cop::Cop.qualified_cop_name(cop, loaded_path)]
end

#make_excludes_absoluteObject


27
28
29
30
31
32
33
34
35
36
37
# File 'lib/rubocop/config.rb', line 27

def make_excludes_absolute
  return unless self['AllCops'] && self['AllCops']['Exclude']

  self['AllCops']['Exclude'].map! do |exclude_elem|
    if exclude_elem.is_a?(String) && !exclude_elem.start_with?('/')
      File.join(base_dir_for_path_parameters, exclude_elem)
    else
      exclude_elem
    end
  end
end

#path_relative_to_config(path) ⇒ Object


133
134
135
# File 'lib/rubocop/config.rb', line 133

def path_relative_to_config(path)
  relative_path(path, base_dir_for_path_parameters)
end

#patterns_to_excludeObject


129
130
131
# File 'lib/rubocop/config.rb', line 129

def patterns_to_exclude
  @hash['AllCops']['Exclude']
end

#patterns_to_includeObject


125
126
127
# File 'lib/rubocop/config.rb', line 125

def patterns_to_include
  @hash['AllCops']['Include']
end

#validateObject

TODO: This should be a private method


94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
# File 'lib/rubocop/config.rb', line 94

def validate
  # Don't validate RuboCop's own files. Avoids inifinite recursion.
  return if loaded_path.start_with?(File.join(ConfigLoader::RUBOCOP_HOME,
                                              'config'))

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

  invalid_cop_names.each do |name|
    fail ValidationError,
         "unrecognized cop #{name} found in #{loaded_path || self}"
  end

  validate_parameter_names(valid_cop_names)
end

#warn_unless_validObject


77
78
79
80
81
# File 'lib/rubocop/config.rb', line 77

def warn_unless_valid
  validate
rescue Config::ValidationError => e
  warn "Warning: #{e.message}".color(:red)
end