Class: RuboCop::Config
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: CopConfig
Constant Summary
collapse
- EMPTY_CONFIG =
{}.freeze
- DEFAULT_RAILS_VERSION =
5.0
Constants included
from PathUtil
PathUtil::HIDDEN_FILE_PATTERN
Instance Attribute Summary collapse
Class Method Summary
collapse
Instance Method Summary
collapse
Methods included from FileFinder
#find_file_upwards, #find_last_file_upwards, #traverse_directories_upwards
Methods included from PathUtil
absolute?, glob?, hidden_dir?, hidden_file?, hidden_file_in_not_hidden_dir?, match_path?, maybe_hidden_file?, relative_path, remote_file?, smart_path
Constructor Details
#initialize(hash = RuboCop::ConfigLoader.default_configuration, loaded_path = nil) ⇒ Config
rubocop:disable Metrics/AbcSize, Metrics/MethodLength
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
|
# File 'lib/rubocop/config.rb', line 31
def initialize(hash = RuboCop::ConfigLoader.default_configuration, loaded_path = nil)
@loaded_path = loaded_path
@for_cop = Hash.new do |h, cop|
cop_name = cop.respond_to?(:cop_name) ? cop.cop_name : cop
if ConfigObsoletion.deprecated_cop_name?(cop)
cop_options = self[cop_name].dup || {}
else
qualified_cop_name = Cop::Registry.qualified_cop_name(cop_name, loaded_path, warn: false)
cop_options = self[qualified_cop_name].dup || {}
cop_options['Enabled'] = enable_cop?(qualified_cop_name, cop_options)
ConfigObsoletion.deprecated_names_for(cop).each do |deprecated_cop_name|
deprecated_config = @for_cop[deprecated_cop_name]
next if deprecated_config.empty?
warn Rainbow(<<~WARNING).yellow
Warning: Using `#{deprecated_cop_name}` configuration in #{loaded_path} for `#{cop}`.
WARNING
cop_options.merge!(@for_cop[deprecated_cop_name])
end
end
h[cop] = h[cop_name] = cop_options
end
@hash = hash
@validator = ConfigValidator.new(self)
@badge_config_cache = {}.compare_by_identity
@clusivity_config_exists_cache = {}
end
|
Instance Attribute Details
#loaded_path ⇒ Object
Returns the value of attribute loaded_path.
21
22
23
|
# File 'lib/rubocop/config.rb', line 21
def loaded_path
@loaded_path
end
|
Class Method Details
.create(hash, path, check: true) ⇒ Object
23
24
25
26
27
28
|
# File 'lib/rubocop/config.rb', line 23
def self.create(hash, path, check: true)
config = new(hash, path)
config.check if check
config
end
|
Instance Method Details
#active_support_extensions_enabled? ⇒ Boolean
212
213
214
|
# File 'lib/rubocop/config.rb', line 212
def active_support_extensions_enabled?
for_all_cops['ActiveSupportExtensionsEnabled']
end
|
#add_excludes_from_higher_level(highest_config) ⇒ Object
127
128
129
130
131
132
133
134
135
136
137
|
# File 'lib/rubocop/config.rb', line 127
def add_excludes_from_higher_level(highest_config)
return unless highest_config.for_all_cops['Exclude']
excludes = for_all_cops['Exclude'] ||= []
highest_config.for_all_cops['Exclude'].each do |path|
unless path.is_a?(Regexp) || absolute?(path)
path = File.join(File.dirname(highest_config.loaded_path), path)
end
excludes << path unless excludes.include?(path)
end
end
|
#allowed_camel_case_file?(file) ⇒ Boolean
239
240
241
242
243
244
245
246
247
248
249
|
# File 'lib/rubocop/config.rb', line 239
def allowed_camel_case_file?(file)
return true if File.extname(file) == '.gemspec'
file_to_include?(file) do |pattern, relative_path, absolute_path|
/[A-Z]/.match?(pattern.to_s) &&
(match_path?(pattern, relative_path) || match_path?(pattern, absolute_path))
end
end
|
#base_dir_for_path_parameters ⇒ Object
Paths specified in configuration files starting with .rubocop 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.
283
284
285
286
287
288
289
290
291
|
# File 'lib/rubocop/config.rb', line 283
def base_dir_for_path_parameters
@base_dir_for_path_parameters ||=
if loaded_path && File.basename(loaded_path).start_with?('.rubocop') &&
loaded_path != File.join(Dir.home, ConfigLoader::DOTFILE)
File.expand_path(File.dirname(loaded_path))
else
Dir.pwd
end
end
|
#bundler_lock_file_path ⇒ String?
313
314
315
316
317
318
319
320
321
322
|
# File 'lib/rubocop/config.rb', line 313
def bundler_lock_file_path
return nil unless loaded_path
base_path = base_dir_for_path_parameters
['Gemfile.lock', 'gems.locked'].each do |file_name|
path = find_file_upwards(file_name, base_path)
return path if path
end
nil
end
|
#check ⇒ Object
85
86
87
88
89
90
|
# File 'lib/rubocop/config.rb', line 85
def check
deprecation_check { |deprecation_message| warn("#{loaded_path} - #{deprecation_message}") }
@validator.validate
make_excludes_absolute
self
end
|
#clusivity_config_for_badge?(badge) ⇒ Boolean
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.
Returns whether config for this badge has ‘Include’ or ‘Exclude’ keys.
180
181
182
183
184
185
186
|
# File 'lib/rubocop/config.rb', line 180
def clusivity_config_for_badge?(badge)
exists = @clusivity_config_exists_cache[badge.to_s]
return exists unless exists.nil?
cop_config = for_badge(badge)
@clusivity_config_exists_cache[badge.to_s] = cop_config['Include'] || cop_config['Exclude']
end
|
#cop_enabled?(name) ⇒ Boolean
200
201
202
|
# File 'lib/rubocop/config.rb', line 200
def cop_enabled?(name)
!!for_cop(name)['Enabled']
end
|
#deprecation_check ⇒ Object
139
140
141
142
143
144
145
146
147
148
|
# File 'lib/rubocop/config.rb', line 139
def deprecation_check
%w[Exclude Include].each do |key|
plural = "#{key}s"
next unless for_all_cops[plural]
for_all_cops[key] = for_all_cops[plural] for_all_cops.delete(plural)
yield "AllCops/#{plural} was renamed to AllCops/#{key}"
end
end
|
#disabled_new_cops? ⇒ Boolean
204
205
206
|
# File 'lib/rubocop/config.rb', line 204
def disabled_new_cops?
for_all_cops['NewCops'] == 'disable'
end
|
#enabled_new_cops? ⇒ Boolean
208
209
210
|
# File 'lib/rubocop/config.rb', line 208
def enabled_new_cops?
for_all_cops['NewCops'] == 'enable'
end
|
#file_to_exclude?(file) ⇒ Boolean
261
262
263
264
|
# File 'lib/rubocop/config.rb', line 261
def file_to_exclude?(file)
file = File.expand_path(file)
patterns_to_exclude.any? { |pattern| match_path?(pattern, file) }
end
|
#file_to_include?(file) ⇒ Boolean
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
|
# File 'lib/rubocop/config.rb', line 220
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|
if block_given?
yield pattern, relative_file_path, absolute_file_path
else
match_path?(pattern, relative_file_path) || match_path?(pattern, absolute_file_path)
end
end
end
|
#for_all_cops ⇒ Object
196
197
198
|
# File 'lib/rubocop/config.rb', line 196
def for_all_cops
@for_all_cops ||= self['AllCops'] || {}
end
|
#for_badge(badge) ⇒ Config
Note: the ‘Enabled’ attribute is same as that returned by ‘for_cop`
166
167
168
169
170
171
172
173
174
175
176
|
# File 'lib/rubocop/config.rb', line 166
def for_badge(badge)
@badge_config_cache[badge] ||= begin
department_config = self[badge.department_name]
cop_config = for_cop(badge.to_s)
if department_config
department_config.merge(cop_config)
else
cop_config
end
end
end
|
#for_cop(cop) ⇒ Config
Note: the ‘Enabled’ attribute is calculated according to the department’s and ‘AllCops’ configuration; other attributes are not inherited.
153
154
155
|
# File 'lib/rubocop/config.rb', line 153
def for_cop(cop)
@for_cop[cop]
end
|
#for_department(department_name) ⇒ Config
Note: the ‘Enabled’ attribute will be present only if specified at the department’s level
191
192
193
194
|
# File 'lib/rubocop/config.rb', line 191
def for_department(department_name)
@for_department ||= Hash.new { |h, dept| h[dept] = self[dept] || {} }
@for_department[department_name.to_s]
end
|
#for_enabled_cop(cop) ⇒ Config, Hash
If the given cop is enabled, returns its configuration hash. Otherwise, returns an empty hash.
160
161
162
|
# File 'lib/rubocop/config.rb', line 160
def for_enabled_cop(cop)
cop_enabled?(cop) ? for_cop(cop) : EMPTY_CONFIG
end
|
#gem_versions_in_target ⇒ Object
Returns target’s locked gem versions (i.e. from Gemfile.lock or gems.locked)
338
339
340
|
# File 'lib/rubocop/config.rb', line 338
def gem_versions_in_target
@gem_versions_in_target ||= read_gem_versions_from_target_lockfile
end
|
#inspect ⇒ Object
342
343
344
|
# File 'lib/rubocop/config.rb', line 342
def inspect "#<#{self.class.name}:#{object_id} @loaded_path=#{loaded_path}>"
end
|
#internal? ⇒ Boolean
True if this is a config file that is shipped with RuboCop
110
111
112
113
|
# File 'lib/rubocop/config.rb', line 110
def internal?
base_config_path = File.expand_path(File.join(ConfigLoader::RUBOCOP_HOME, 'config'))
File.expand_path(loaded_path).start_with?(base_config_path)
end
|
#loaded_features ⇒ Object
#loaded_plugins ⇒ Object
rubocop:enable Metrics/AbcSize, Metrics/MethodLength
#make_excludes_absolute ⇒ Object
115
116
117
118
119
120
121
122
123
124
125
|
# File 'lib/rubocop/config.rb', line 115
def make_excludes_absolute
each_key do |key|
dig(key, 'Exclude')&.map! do |exclude_elem|
if exclude_elem.is_a?(String) && !absolute?(exclude_elem)
File.expand_path(File.join(base_dir_for_path_parameters, exclude_elem))
else
exclude_elem
end
end
end
end
|
#parser_engine ⇒ Object
293
294
295
|
# File 'lib/rubocop/config.rb', line 293
def parser_engine
@parser_engine ||= for_all_cops.fetch('ParserEngine', :default).to_sym
end
|
#path_relative_to_config(path) ⇒ Object
274
275
276
|
# File 'lib/rubocop/config.rb', line 274
def path_relative_to_config(path)
relative_path(path, base_dir_for_path_parameters)
end
|
#patterns_to_exclude ⇒ Object
270
271
272
|
# File 'lib/rubocop/config.rb', line 270
def patterns_to_exclude
for_all_cops['Exclude'] || []
end
|
#patterns_to_include ⇒ Object
266
267
268
|
# File 'lib/rubocop/config.rb', line 266
def patterns_to_include
for_all_cops['Include'] || []
end
|
#pending_cops ⇒ Object
324
325
326
327
328
329
330
331
332
333
334
|
# File 'lib/rubocop/config.rb', line 324
def pending_cops
keys.each_with_object([]) do |qualified_cop_name, pending_cops|
department = department_of(qualified_cop_name)
next if department && department['Enabled'] == false
cop_metadata = self[qualified_cop_name]
next unless cop_metadata['Enabled'] == 'pending'
pending_cops << CopConfig.new(qualified_cop_name, cop_metadata)
end
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.
253
254
255
256
257
258
259
|
# File 'lib/rubocop/config.rb', line 253
def possibly_include_hidden?
return @possibly_include_hidden if defined?(@possibly_include_hidden)
@possibly_include_hidden = patterns_to_include.any? do |s|
s.is_a?(Regexp) || s.start_with?('.') || s.include?('/.')
end
end
|
#signature ⇒ Object
105
106
107
|
# File 'lib/rubocop/config.rb', line 105
def signature
@signature ||= Digest::SHA1.hexdigest(to_s)
end
|
#smart_loaded_path ⇒ Object
308
309
310
|
# File 'lib/rubocop/config.rb', line 308
def smart_loaded_path
PathUtil.smart_path(@loaded_path)
end
|
#string_literals_frozen_by_default? ⇒ Boolean
216
217
218
|
# File 'lib/rubocop/config.rb', line 216
def string_literals_frozen_by_default?
for_all_cops['StringLiteralsFrozenByDefault']
end
|
#target_rails_version ⇒ Object
297
298
299
300
301
302
303
304
305
306
|
# File 'lib/rubocop/config.rb', line 297
def target_rails_version
@target_rails_version ||=
if for_all_cops['TargetRailsVersion']
for_all_cops['TargetRailsVersion'].to_f
elsif target_rails_version_from_bundler_lock_file
target_rails_version_from_bundler_lock_file
else
DEFAULT_RAILS_VERSION
end
end
|
#to_s ⇒ Object
101
102
103
|
# File 'lib/rubocop/config.rb', line 101
def to_s
@to_s ||= @hash.to_s
end
|
#validate_after_resolution ⇒ Object
92
93
94
95
|
# File 'lib/rubocop/config.rb', line 92
def validate_after_resolution
@validator.validate_after_resolution
self
end
|