class RuboCop::Config

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.

Constants

CopConfig
DEFAULT_RAILS_VERSION

Attributes

loaded_path[R]

Public Class Methods

create(hash, path, check: true) click to toggle source
# File lib/rubocop/config.rb, line 22
def self.create(hash, path, check: true)
  config = new(hash, path)
  config.check if check

  config
end
new(hash = RuboCop::ConfigLoader.default_configuration, loaded_path = nil) click to toggle source

rubocop:disable Metrics/AbcSize

# File lib/rubocop/config.rb, line 30
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

Public Instance Methods

active_support_extensions_enabled?() click to toggle source
# File lib/rubocop/config.rb, line 170
def active_support_extensions_enabled?
  for_all_cops['ActiveSupportExtensionsEnabled']
end
add_excludes_from_higher_level(highest_config) click to toggle source
# File lib/rubocop/config.rb, line 96
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) click to toggle source
# File lib/rubocop/config.rb, line 197
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() click to toggle source

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.

# File lib/rubocop/config.rb, line 241
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() click to toggle source

@return [String, nil]

# File lib/rubocop/config.rb, line 271
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() click to toggle source
# File lib/rubocop/config.rb, line 51
def check
  deprecation_check { |deprecation_message| warn("#{loaded_path} - #{deprecation_message}") }
  @validator.validate
  make_excludes_absolute
  self
end
clusivity_config_for_badge?(badge) click to toggle source

@return [Boolean] whether config for this badge has ‘Include’ or ‘Exclude’ keys @api private

# File lib/rubocop/config.rb, line 142
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
deprecation_check() { |"AllCops/#{plural} was renamed to AllCops/#{key}"| ... } click to toggle source
# File lib/rubocop/config.rb, line 108
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?() click to toggle source
# File lib/rubocop/config.rb, line 162
def disabled_new_cops?
  for_all_cops['NewCops'] == 'disable'
end
enabled_new_cops?() click to toggle source
# File lib/rubocop/config.rb, line 166
def enabled_new_cops?
  for_all_cops['NewCops'] == 'enable'
end
file_to_exclude?(file) click to toggle source
# File lib/rubocop/config.rb, line 219
def file_to_exclude?(file)
  file = File.expand_path(file)
  patterns_to_exclude.any? { |pattern| match_path?(pattern, file) }
end
file_to_include?(file) { |pattern, relative_file_path, absolute_file_path| ... } click to toggle source
# File lib/rubocop/config.rb, line 178
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() click to toggle source
# File lib/rubocop/config.rb, line 158
def for_all_cops
  @for_all_cops ||= self['AllCops'] || {}
end
for_badge(badge) click to toggle source

@return [Config] for the given cop merged with that of its department (if any) Note: the ‘Enabled’ attribute is same as that returned by ‘for_cop`

# File lib/rubocop/config.rb, line 128
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) click to toggle source

@return [Config] for the given cop / cop name. Note: the ‘Enabled’ attribute is calculated according to the department’s and ‘AllCops’ configuration; other attributes are not inherited.

# File lib/rubocop/config.rb, line 122
def for_cop(cop)
  @for_cop[cop]
end
for_department(department_name) click to toggle source

@return [Config] for the given department name. Note: the ‘Enabled’ attribute will be present only if specified at the department’s level

# File lib/rubocop/config.rb, line 153
def for_department(department_name)
  @for_department ||= Hash.new { |h, dept| h[dept] = self[dept] || {} }
  @for_department[department_name.to_s]
end
gem_versions_in_target() click to toggle source

Returns target’s locked gem versions (i.e. from Gemfile.lock or gems.locked) @returns [Hash{String => Gem::Version}] The locked gem versions, keyed by the gems’ names.

# File lib/rubocop/config.rb, line 296
def gem_versions_in_target
  @gem_versions_in_target ||= read_gem_versions_from_target_lockfile
end
internal?() click to toggle source

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

# File lib/rubocop/config.rb, line 76
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() click to toggle source

rubocop:enable Metrics/AbcSize

# File lib/rubocop/config.rb, line 47
def loaded_features
  @loaded_features ||= ConfigLoader.loaded_features
end
make_excludes_absolute() click to toggle source
# File lib/rubocop/config.rb, line 81
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
parser_engine() click to toggle source
# File lib/rubocop/config.rb, line 251
def parser_engine
  @parser_engine ||= for_all_cops.fetch('ParserEngine', :parser_whitequark).to_sym
end
path_relative_to_config(path) click to toggle source
# File lib/rubocop/config.rb, line 232
def path_relative_to_config(path)
  relative_path(path, base_dir_for_path_parameters)
end
patterns_to_exclude() click to toggle source
# File lib/rubocop/config.rb, line 228
def patterns_to_exclude
  for_all_cops['Exclude'] || []
end
patterns_to_include() click to toggle source
# File lib/rubocop/config.rb, line 224
def patterns_to_include
  for_all_cops['Include'] || []
end
pending_cops() click to toggle source
# File lib/rubocop/config.rb, line 282
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?() click to toggle source

Returns true if there’s a chance that an Include pattern matches hidden files, false if that’s definitely not possible.

# File lib/rubocop/config.rb, line 211
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() click to toggle source
# File lib/rubocop/config.rb, line 71
def signature
  @signature ||= Digest::SHA1.hexdigest(to_s)
end
smart_loaded_path() click to toggle source
# File lib/rubocop/config.rb, line 266
def smart_loaded_path
  PathUtil.smart_path(@loaded_path)
end
string_literals_frozen_by_default?() click to toggle source
# File lib/rubocop/config.rb, line 174
def string_literals_frozen_by_default?
  for_all_cops['StringLiteralsFrozenByDefault']
end
target_rails_version() click to toggle source
# File lib/rubocop/config.rb, line 255
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() click to toggle source
# File lib/rubocop/config.rb, line 67
def to_s
  @to_s ||= @hash.to_s
end
validate_after_resolution() click to toggle source
# File lib/rubocop/config.rb, line 58
def validate_after_resolution
  @validator.validate_after_resolution
  self
end

Private Instance Methods

department_of(qualified_cop_name) click to toggle source
# File lib/rubocop/config.rb, line 350
def department_of(qualified_cop_name)
  *cop_department, _ = qualified_cop_name.split('/')
  return nil if cop_department.empty?

  self[cop_department.join('/')]
end
enable_cop?(qualified_cop_name, cop_options) click to toggle source
# File lib/rubocop/config.rb, line 338
def enable_cop?(qualified_cop_name, cop_options)
  # If the cop is explicitly enabled or `Lint/Syntax`, the other checks can be skipped.
  return true if cop_options['Enabled'] == true || qualified_cop_name == 'Lint/Syntax'

  department = department_of(qualified_cop_name)
  cop_enabled = cop_options.fetch('Enabled') { !for_all_cops['DisabledByDefault'] }
  return true if cop_enabled == 'override_department'
  return false if department && department['Enabled'] == false

  cop_enabled
end
gem_version_to_major_minor_float(gem_version) click to toggle source

@param [Gem::Version] gem_version an object like ‘Gem::Version.new(“7.1.2.3”)` @return [Float] The major and minor version, like `7.1`

# File lib/rubocop/config.rb, line 325
def gem_version_to_major_minor_float(gem_version)
  segments = gem_version.segments
  Float("#{segments[0]}.#{segments[1]}")
end
read_gem_versions_from_target_lockfile() click to toggle source

@returns [Hash{String => Gem::Version}] The locked gem versions, keyed by the gems’ names.

# File lib/rubocop/config.rb, line 331
def read_gem_versions_from_target_lockfile
  lockfile_path = bundler_lock_file_path
  return nil unless lockfile_path

  Lockfile.new(lockfile_path).gem_versions
end
read_rails_version_from_bundler_lock_file() click to toggle source

@return [Float, nil] The Rails version as a ‘major.minor` Float.

# File lib/rubocop/config.rb, line 312
def read_rails_version_from_bundler_lock_file
  return nil unless gem_versions_in_target

  # Look for `railties` instead of `rails`, to support apps that only use a subset of `rails`
  # See https://github.com/rubocop/rubocop/pull/11289
  rails_version_in_target = gem_versions_in_target['railties']
  return nil unless rails_version_in_target

  gem_version_to_major_minor_float(rails_version_in_target)
end
target_rails_version_from_bundler_lock_file() click to toggle source

@return [Float, nil] The Rails version as a ‘major.minor` Float.

# File lib/rubocop/config.rb, line 307
def target_rails_version_from_bundler_lock_file
  @target_rails_version_from_bundler_lock_file ||= read_rails_version_from_bundler_lock_file
end