Class: RuboCop::Config

Inherits:
Object
  • Object
show all
Extended by:
SimpleForwardable
Includes:
FileFinder, 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: 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, smart_path

Constructor Details

#initialize(hash = RuboCop::ConfigLoader.default_configuration, loaded_path = nil) ⇒ Config

rubocop:disable Metrics/AbcSize



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
 
# 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
    qualified_cop_name = Cop::Registry.qualified_cop_name(cop_name, loaded_path)
    cop_options = self[qualified_cop_name].dup || {}
    cop_options['Enabled'] = enable_cop?(qualified_cop_name, cop_options)
    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 (readonly)

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

Returns:

  • (Boolean) 


179
180
181
 
# File 'lib/rubocop/config.rb', line 179

def active_support_extensions_enabled?
  for_all_cops['ActiveSupportExtensionsEnabled']
end

#add_excludes_from_higher_level(highest_config) ⇒ Object 



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

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

Returns:

  • (Boolean) 


206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/rubocop/config.rb', line 206

def allowed_camel_case_file?(file)
  # Gemspecs are allowed to have dashes because that fits with bundler best
  # practices in the case when the gem is nested under a namespace (e.g.,
  # `bundler-console` conveys `Bundler::Console`).
  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.



250
251
252
253
254
255
256
257
258
 
# File 'lib/rubocop/config.rb', line 250

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?

Returns:



280
281
282
283
284
285
286
287
288
289
 
# File 'lib/rubocop/config.rb', line 280

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 



52
53
54
55
56
57
 
# File 'lib/rubocop/config.rb', line 52

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.

Returns:

  • (Boolean) —

    whether config for this badge has ‘Include’ or ‘Exclude’ keys



147
148
149
150
151
152
153
 
# File 'lib/rubocop/config.rb', line 147

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

Returns:

  • (Boolean) 


167
168
169
 
# File 'lib/rubocop/config.rb', line 167

def cop_enabled?(name)
  !!for_cop(name)['Enabled']
end

#deprecation_check ⇒ Object 



106
107
108
109
110
111
112
113
114
115
 
# File 'lib/rubocop/config.rb', line 106

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] # Stay backwards compatible.
    for_all_cops.delete(plural)
    yield "AllCops/#{plural} was renamed to AllCops/#{key}"
  end
end

#disabled_new_cops? ⇒ Boolean

Returns:

  • (Boolean) 


171
172
173
 
# File 'lib/rubocop/config.rb', line 171

def disabled_new_cops?
  for_all_cops['NewCops'] == 'disable'
end

#enabled_new_cops? ⇒ Boolean

Returns:

  • (Boolean) 


175
176
177
 
# File 'lib/rubocop/config.rb', line 175

def enabled_new_cops?
  for_all_cops['NewCops'] == 'enable'
end

#file_to_exclude?(file) ⇒ Boolean

Returns:

  • (Boolean) 


228
229
230
231
 
# File 'lib/rubocop/config.rb', line 228

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

Returns:

  • (Boolean) 


187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/rubocop/config.rb', line 187

def file_to_include?(file)
  relative_file_path = path_relative_to_config(file)

  # Optimization to quickly decide if the given file is hidden (on the top
  # level) and cannot be matched by any pattern.
  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 



163
164
165
 
# File 'lib/rubocop/config.rb', line 163

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`

Returns:

  • (Config) —

    for the given cop merged with that of its department (if any)



133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/rubocop/config.rb', line 133

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.

Returns:

  • (Config) —

    for the given cop / cop name.



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

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

Returns:

  • (Config) —

    for the given department name.



158
159
160
161
 
# File 'lib/rubocop/config.rb', line 158

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.

Returns:

  • (Config, Hash) —

    for the given cop / cop name.



127
128
129
 
# File 'lib/rubocop/config.rb', line 127

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)



305
306
307
 
# File 'lib/rubocop/config.rb', line 305

def gem_versions_in_target
  @gem_versions_in_target ||= read_gem_versions_from_target_lockfile
end

#inspect ⇒ Object

:nodoc:



309
310
311
 
# File 'lib/rubocop/config.rb', line 309

def inspect # :nodoc:
  "#<#{self.class.name}:#{object_id} @loaded_path=#{loaded_path}>"
end

#internal? ⇒ Boolean

True if this is a config file that is shipped with RuboCop

Returns:

  • (Boolean) 


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

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

rubocop:enable Metrics/AbcSize



48
49
50
 
# File 'lib/rubocop/config.rb', line 48

def loaded_features
  @loaded_features ||= ConfigLoader.loaded_features
end

#make_excludes_absolute ⇒ Object 



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

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 



260
261
262
 
# File 'lib/rubocop/config.rb', line 260

def parser_engine
  @parser_engine ||= for_all_cops.fetch('ParserEngine', :parser_whitequark).to_sym
end

#path_relative_to_config(path) ⇒ Object 



241
242
243
 
# File 'lib/rubocop/config.rb', line 241

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

#patterns_to_exclude ⇒ Object 



237
238
239
 
# File 'lib/rubocop/config.rb', line 237

def patterns_to_exclude
  for_all_cops['Exclude'] || []
end

#patterns_to_include ⇒ Object 



233
234
235
 
# File 'lib/rubocop/config.rb', line 233

def patterns_to_include
  for_all_cops['Include'] || []
end

#pending_cops ⇒ Object 



291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/rubocop/config.rb', line 291

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.

Returns:

  • (Boolean) 


220
221
222
223
224
225
226
 
# File 'lib/rubocop/config.rb', line 220

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 



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

def signature
  @signature ||= Digest::SHA1.hexdigest(to_s)
end

#smart_loaded_path ⇒ Object 



275
276
277
 
# File 'lib/rubocop/config.rb', line 275

def smart_loaded_path
  PathUtil.smart_path(@loaded_path)
end

#string_literals_frozen_by_default? ⇒ Boolean

Returns:

  • (Boolean) 


183
184
185
 
# File 'lib/rubocop/config.rb', line 183

def string_literals_frozen_by_default?
  for_all_cops['StringLiteralsFrozenByDefault']
end

#target_rails_version ⇒ Object 



264
265
266
267
268
269
270
271
272
273
 
# File 'lib/rubocop/config.rb', line 264

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 



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

def to_s
  @to_s ||= @hash.to_s
end

#validate_after_resolution ⇒ Object 



59
60
61
62
 
# File 'lib/rubocop/config.rb', line 59

def validate_after_resolution
  @validator.validate_after_resolution
  self
end