Class: RuboCop::Config
- Inherits:
-
Hash
- Object
- Hash
- RuboCop::Config
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 AutoCorrect)
Instance Attribute Summary collapse
Instance Method Summary
collapse
Methods included from PathUtil
hidden?, 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
|
# File 'lib/rubocop/config.rb', line 21
def initialize(hash = {}, loaded_path = nil)
@loaded_path = loaded_path
super(hash)
end
|
Instance Attribute Details
#loaded_path ⇒ Object
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
42
43
44
45
46
47
48
49
50
51
52
53
54
|
# File 'lib/rubocop/config.rb', line 42
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_namespaces ⇒ Object
86
87
88
89
90
91
92
93
94
|
# File 'lib/rubocop/config.rb', line 86
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_parameters ⇒ Object
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.
165
166
167
168
169
170
171
|
# File 'lib/rubocop/config.rb', line 165
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
76
77
78
|
# File 'lib/rubocop/config.rb', line 76
def cop_enabled?(cop)
for_cop(cop).nil? || for_cop(cop)['Enabled']
end
|
#deprecation_check ⇒ Object
56
57
58
59
60
61
62
63
64
65
66
67
68
|
# File 'lib/rubocop/config.rb', line 56
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] all_cops.delete(plural)
yield "AllCops/#{plural} was renamed to AllCops/#{key}"
end
end
|
#file_to_exclude?(file) ⇒ Boolean
142
143
144
145
146
147
|
# File 'lib/rubocop/config.rb', line 142
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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
|
# File 'lib/rubocop/config.rb', line 114
def file_to_include?(file)
relative_file_path = path_relative_to_config(file)
is_hidden = relative_file_path.start_with?('.') &&
!relative_file_path.start_with?('..')
return false if is_hidden && !possibly_include_hidden?
absolute_file_path = File.expand_path(file)
patterns_to_include.any? do |pattern|
match_path?(pattern, relative_file_path, loaded_path) ||
match_path?(pattern, absolute_file_path, loaded_path)
end
end
|
#for_cop(cop) ⇒ Object
70
71
72
73
74
|
# File 'lib/rubocop/config.rb', line 70
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_absolute ⇒ Object
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
|
# File 'lib/rubocop/config.rb', line 26
def make_excludes_absolute
keys.each do |key|
validate_section_presence(key)
next unless self[key]['Exclude']
self[key]['Exclude'].map! do |exclude_elem|
if exclude_elem.is_a?(String) && !exclude_elem.start_with?('/')
File.expand_path(File.join(base_dir_for_path_parameters,
exclude_elem))
else
exclude_elem
end
end
end
end
|
#path_relative_to_config(path) ⇒ Object
157
158
159
|
# File 'lib/rubocop/config.rb', line 157
def path_relative_to_config(path)
relative_path(path, base_dir_for_path_parameters)
end
|
#patterns_to_exclude ⇒ Object
153
154
155
|
# File 'lib/rubocop/config.rb', line 153
def patterns_to_exclude
self['AllCops']['Exclude']
end
|
#patterns_to_include ⇒ Object
149
150
151
|
# File 'lib/rubocop/config.rb', line 149
def patterns_to_include
self['AllCops']['Include']
end
|
#possibly_include_hidden? ⇒ Boolean
Returns true if there's a chance that an Include pattern matches hidden
files, false if that's definitely not possible.
133
134
135
136
137
138
139
140
|
# File 'lib/rubocop/config.rb', line 133
def possibly_include_hidden?
if @possibly_include_hidden.nil?
@possibly_include_hidden = patterns_to_include.any? do |s|
s.is_a?(Regexp) || s.start_with?('.') || s.include?('/.')
end
end
@possibly_include_hidden
end
|
#validate ⇒ Object
TODO: This should be a private method
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
|
# File 'lib/rubocop/config.rb', line 97
def validate
base_config_path = File.expand_path(File.join(ConfigLoader::RUBOCOP_HOME,
'config'))
return if File.expand_path(loaded_path).start_with?(base_config_path)
valid_cop_names, invalid_cop_names = 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}"
end
validate_parameter_names(valid_cop_names)
end
|
#warn_unless_valid ⇒ Object
80
81
82
83
84
|
# File 'lib/rubocop/config.rb', line 80
def warn_unless_valid
validate
rescue Config::ValidationError => e
warn "Warning: #{e.message}".color(:red)
end
|