Class: RuboCop::Config

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
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

DEFAULT_RAILS_VERSION =
5.0

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from FileFinder

#find_file_upwards, #find_last_file_upwards, root_level=, root_level?

Methods included from PathUtil

absolute?, hidden_dir?, hidden_file?, hidden_file_in_not_hidden_dir?, match_path?, maybe_hidden_file?, relative_path, smart_path

Constructor Details

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

Returns a new instance of Config.


24
25
26
27
28
29
30
31
32
33
34
# File 'lib/rubocop/config.rb', line 24

def initialize(hash = {}, loaded_path = nil)
  @loaded_path = loaded_path
  @for_cop = Hash.new do |h, cop|
    qualified_cop_name = Cop::Registry.qualified_cop_name(cop, loaded_path)
    cop_options = self[qualified_cop_name] || {}
    cop_options['Enabled'] = enable_cop?(qualified_cop_name, cop_options)
    h[cop] = cop_options
  end
  @hash = hash
  @validator = ConfigValidator.new(self)
end

Instance Attribute Details

#loaded_pathObject (readonly)

Returns the value of attribute loaded_path


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

def loaded_path
  @loaded_path
end

Class Method Details

.create(hash, path) ⇒ Object


36
37
38
# File 'lib/rubocop/config.rb', line 36

def self.create(hash, path)
  new(hash, path).check
end

Instance Method Details

#add_excludes_from_higher_level(highest_config) ⇒ Object


88
89
90
91
92
93
94
95
96
97
98
# File 'lib/rubocop/config.rb', line 88

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)

169
170
171
172
173
174
175
176
177
178
179
180
# File 'lib/rubocop/config.rb', line 169

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_parametersObject

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.


216
217
218
219
220
221
222
223
224
# File 'lib/rubocop/config.rb', line 216

def base_dir_for_path_parameters
  @base_dir_for_path_parameters ||=
    if 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_pathObject


241
242
243
244
245
246
247
248
249
250
# File 'lib/rubocop/config.rb', line 241

def bundler_lock_file_path
  return nil unless loaded_path

  base_path = base_dir_for_path_parameters
  ['gems.locked', 'Gemfile.lock'].each do |file_name|
    path = find_file_upwards(file_name, base_path)
    return path if path
  end
  nil
end

#checkObject


44
45
46
47
48
49
50
51
# File 'lib/rubocop/config.rb', line 44

def check
  deprecation_check do |deprecation_message|
    warn("#{loaded_path} - #{deprecation_message}")
  end
  @validator.validate
  make_excludes_absolute
  self
end

#deprecation_checkObject


100
101
102
103
104
105
106
107
108
109
# File 'lib/rubocop/config.rb', line 100

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)

140
141
142
# File 'lib/rubocop/config.rb', line 140

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

#enabled_new_cops?Boolean

Returns:

  • (Boolean)

144
145
146
# File 'lib/rubocop/config.rb', line 144

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

#file_to_exclude?(file) ⇒ Boolean

Returns:

  • (Boolean)

192
193
194
195
196
197
# File 'lib/rubocop/config.rb', line 192

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

#file_to_include?(file) ⇒ Boolean

Returns:

  • (Boolean)

148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
# File 'lib/rubocop/config.rb', line 148

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_copsObject


136
137
138
# File 'lib/rubocop/config.rb', line 136

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)


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

def for_badge(badge)
  cop_config = for_cop(badge.to_s)
  fetch(badge.department.to_s) { return cop_config }
    .merge(cop_config)
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.


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

def for_cop(cop)
  @for_cop[cop.respond_to?(:cop_name) ? cop.cop_name : 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.


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

def for_department(department_name)
  @for_department ||= Hash.new do |h, dept|
    h[dept] = self[dept] || {}
  end
  @for_department[department_name.to_s]
end

#internal?Boolean

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

Returns:

  • (Boolean)

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

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_featuresObject


40
41
42
# File 'lib/rubocop/config.rb', line 40

def loaded_features
  @loaded_features ||= ConfigLoader.loaded_features
end

#make_excludes_absoluteObject


72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
# File 'lib/rubocop/config.rb', line 72

def make_excludes_absolute
  each_key do |key|
    @validator.validate_section_presence(key)
    next unless self[key]['Exclude']

    self[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

#path_relative_to_config(path) ⇒ Object


207
208
209
# File 'lib/rubocop/config.rb', line 207

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

#patterns_to_excludeObject


203
204
205
# File 'lib/rubocop/config.rb', line 203

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

#patterns_to_includeObject


199
200
201
# File 'lib/rubocop/config.rb', line 199

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

#pending_copsObject


252
253
254
255
256
257
258
259
260
261
262
# File 'lib/rubocop/config.rb', line 252

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

     = self[qualified_cop_name]
    next unless ['Enabled'] == 'pending'

    pending_cops << CopConfig.new(qualified_cop_name, )
  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)

184
185
186
187
188
189
190
# File 'lib/rubocop/config.rb', line 184

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

#signatureObject


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

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

#smart_loaded_pathObject


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

def smart_loaded_path
  PathUtil.smart_path(@loaded_path)
end

#target_rails_versionObject


226
227
228
229
230
231
232
233
234
235
# File 'lib/rubocop/config.rb', line 226

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_sObject


57
58
59
# File 'lib/rubocop/config.rb', line 57

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