123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Config

Relationships & Source Files
Namespace Children
Classes:
CopConfig
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, SimpleForwardable
Instance Chain:
self, FileFinder, PathUtil
Inherits: Object
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.

Constant Summary

PathUtil - Included

HIDDEN_FILE_PATTERN, SMART_PATH_CACHE

Class Method Summary

Instance Attribute Summary

Instance Method Summary

FileFinder - Included

#find_file_upwards, #find_last_file_upwards, #traverse_directories_upwards, #traverse_files_upwards

PathUtil - Included

#absolute?

Returns true for an absolute Unix or Windows path.
#glob?

Returns true for a glob.
#hidden_dir?, #hidden_file?, #hidden_file_in_not_hidden_dir?,
#match_path?

Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity.
#maybe_hidden_file?

Loose check to reduce memory allocations.
#pwd

Returns the current working directory, cached for the duration of a run.
#relative_path, #remote_file?,
#reset_pwd

Reset the cached pwd.
#smart_path

Constructor Details

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

Metrics/MethodLength

[ GitHub ] 

  


# 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)
      # Since a deprecated cop will no longer have a qualified name (as the badge is no
      # longer valid), and since we do not want to automatically enable the cop, we just
      # set the configuration to an empty hash if it is unset.
      # This is necessary to allow a renamed cop have its old configuration merged in
      # before being used (which is necessary to allow it to be disabled via config).
      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)

      # If the cop has deprecated names (ie. it has been renamed), it is possible that
      # users will still have old configuration for the cop's old name. In this case,
      # if `ConfigObsoletion` is configured to warn rather than error (and therefore
      # RuboCop runs), we want to respect the old configuration, so merge it in.
      #
      # NOTE: If there is configuration for both the cop and a deprecated names, the old
      # configuration will be merged on top of the new configuration!
      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


  







Class Method Details



  

    .create(hash, path, check: true)  
  

  [ GitHub ]


  

  


# 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 Attribute Details



  

    #active_support_extensions_enabled?  ⇒ Boolean  (readonly)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/config.rb', line 226



def active_support_extensions_enabled?
  for_all_cops['ActiveSupportExtensionsEnabled']
end


  








  

    #disabled_new_cops?  ⇒ Boolean  (readonly)
  

  [ GitHub ]


  

  


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



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


  








  

    #enabled_new_cops?  ⇒ Boolean  (readonly)
  

  [ GitHub ]


  

  


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



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


  








  

    #internal?  ⇒ Boolean  (readonly)
  



  

    


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



  





  


  [ GitHub ]


  

  


# 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_path   (readonly)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/config.rb', line 21



attr_reader :loaded_path


  








  

    #possibly_include_hidden?  ⇒ Boolean  (readonly)
  



  

    


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



  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/config.rb', line 265



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


  








  

    #string_literals_frozen_by_default?  ⇒ Boolean  (readonly)
  

  [ GitHub ]


  

  


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



def string_literals_frozen_by_default?
  for_all_cops['StringLiteralsFrozenByDefault']
end


  







Instance Method Details



  

    #add_excludes_from_higher_level(highest_config)  
  

  [ GitHub ]


  

  


# 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 
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/config.rb', line 254



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) { |pattern| /[A-Z]/.match?(pattern.to_s) }
end


  








  

    #base_dir_for_path_parameters  
  



  

    


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.



  



  [ GitHub ]


  

  


# File 'lib/rubocop/config.rb', line 295



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
      PathUtil.pwd
    end
end


  








  

    #bundler_lock_file_path  ⇒ String? 
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/config.rb', line 325



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  
  

  [ GitHub ]


  

  


# 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 
  



  

    
  





  
Returns:


    
  
  • 
    (Boolean)
—    
    

    whether config for this badge has 'Include' or 'Exclude' keys
    

    
  
    • 





  [ GitHub ]


  

  


# 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


  








  

    #comparable_version(value)   (private)
  



  

    


Returns a Gem::Version for values like '1.19' or 1.19, and nil
for non-version values like 'N/A' or href="#next">[next]'.



  



  [ GitHub ]


  

  


# File 'lib/rubocop/config.rb', line 451



def comparable_version(value)
  value = value.to_s
  Gem::Version.new(value) if value.match?(/\A\d/) && Gem::Version.correct?(value)
end


  








  

    #cop_enabled?(name)  ⇒ Boolean 
  



  

    
  





  


  [ GitHub ]


  

  


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



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


  








  

    #department_of(qualified_cop_name)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/config.rb', line 411



def department_of(qualified_cop_name)
  *cop_department, _ = qualified_cop_name.split('/')
  return nil if cop_department.empty?

  self[cop_department.join('/')]
end


  








  

    #deprecation_check  
  

  [ GitHub ]


  

  


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


  








  

    #enable_cop?(qualified_cop_name, cop_options)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/config.rb', line 399



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


  








  

    #enabled_new_cop?(qualified_cop_name)  ⇒ Boolean 
  



  

    


Whether the given pending cop should be enabled, based on the NewCops setting of
its department (if any) or of AllCops. A department may set NewCops to enable,
disable, pending, or a version, in which case pending cops added in that version
or earlier are enabled.



  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/config.rb', line 216



def enabled_new_cop?(qualified_cop_name)
  setting = new_cops_setting_for(qualified_cop_name)

  case setting.to_s
  when 'enable' then true
  when '', 'pending', 'disable' then false
  else new_cops_version_covers?(setting, qualified_cop_name)
  end
end


  








  

    #file_to_exclude?(file)  ⇒ Boolean 
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/config.rb', line 273



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 true if the file matches any include pattern. If a block is given, the block is called
to determine if the pattern is relevant (true returned by the block) or should be skipped
(false returned).



  





  


  [ GitHub ]


  

  


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



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|
    next if block_given? && !yield(pattern)

    match_relative_or_absolute_path?(pattern, relative_file_path, absolute_file_path)
  end
end


  








  

    #for_all_cops  
  

  [ GitHub ]


  

  


# 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



  





  
Returns:


    
  
  • 
    (Config)
—    
    

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

    
  
    • 





  [ GitHub ]


  

  


# 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.



  





  
Returns:


    
  
  • 
    (Config)
—    
    

    for the given cop / cop name.
    

    
  
    • 





  [ GitHub ]


  

  


# 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



  





  
Returns:


    
  
  • 
    (Config)
—    
    

    for the given department name.
    

    
  
    • 





  [ GitHub ]


  

  


# 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.



  





  
Returns:


    
  
  • 
    (Config, Hash)
—    
    

    for the given cop / cop name.
    

    
  
    • 





  [ GitHub ]


  

  


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



def for_enabled_cop(cop)
  cop_enabled?(cop) ? for_cop(cop) : EMPTY_CONFIG
end


  








  

    #gem_version_to_major_minor_float(gem_version)  ⇒ Float  (private)
  



  

    
  





  
Parameters:


    
  
  • 
    gem_version
    (Gem::Version)
—    
    

    an object like Gem::Version.new("7.1.2.3")
    

    
  
    • 



Returns:


    
  
  • 
    (Float)
—    
    

    The major and minor version, like 7.1
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/rubocop/config.rb', line 386



def gem_version_to_major_minor_float(gem_version)
  segments = gem_version.segments
  Float("#{segments[0]}.#{segments[1]}")
end


  








  

    #gem_versions_in_target  
  



  

    


Returns target’s locked gem versions (i.e. from Gemfile.lock or gems.locked)



  



  [ GitHub ]


  

  


# File 'lib/rubocop/config.rb', line 351



def gem_versions_in_target
  @gem_versions_in_target ||= read_gem_versions_from_target_lockfile
end


  








  

    #inspect  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'lib/rubocop/config.rb', line 355



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


  








  

    #loaded_features  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/config.rb', line 81



def loaded_features
  @loaded_features ||= ConfigLoader.loaded_features
end


  








  

    #loaded_plugins  
  



  

    


Metrics/MethodLength



  



  [ GitHub ]


  

  


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



def loaded_plugins
  @loaded_plugins ||= ConfigLoader.loaded_plugins
end


  








  

    #make_excludes_absolute  
  

  [ GitHub ]


  

  


# 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


  








  

    #match_relative_or_absolute_path?(pattern, relative_file_path, absolute_file_path)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/config.rb', line 361



def match_relative_or_absolute_path?(pattern, relative_file_path, absolute_file_path)
  should_use_absolute_path = absolute?(pattern.to_s) || pattern.to_s.start_with?('..') ||
                             relative_file_path.start_with?('..')
  match_path?(pattern, should_use_absolute_path ? absolute_file_path : relative_file_path)
end


  








  

    #new_cops_covered?(qualified_cop_name)  ⇒ Boolean  (private)
  



  

    


Whether the cop’s pending status is resolved by a NewCops setting,
so that it should not appear in the pending cops warning.
Unlike #enabled_new_cop?, disable counts as covered.



  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/config.rb', line 430



def new_cops_covered?(qualified_cop_name)
  setting = new_cops_setting_for(qualified_cop_name)

  case setting.to_s
  when 'enable', 'disable' then true
  when '', 'pending' then false
  else new_cops_version_covers?(setting, qualified_cop_name)
  end
end


  








  

    #new_cops_setting_for(qualified_cop_name)   (private)
  



  

    


The effective NewCops setting for the given cop: the department-level
setting if present, otherwise the AllCops setting.



  



  [ GitHub ]


  

  


# File 'lib/rubocop/config.rb', line 420



def new_cops_setting_for(qualified_cop_name)
  department = department_of(qualified_cop_name)
  setting = department['NewCops'] if department

  setting || for_all_cops['NewCops']
end


  








  

    #new_cops_version_covers?(new_cops_version, qualified_cop_name)  ⇒ Boolean  (private)
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/rubocop/config.rb', line 440



def new_cops_version_covers?(new_cops_version, qualified_cop_name)
  cop_metadata = self[qualified_cop_name]
  version_added = comparable_version(cop_metadata['VersionAdded']) if cop_metadata
  pinned_version = comparable_version(new_cops_version)
  return false if version_added.nil? || pinned_version.nil?

  version_added <= pinned_version
end


  








  

    #parser_engine  
  

  [ GitHub ]


  

  


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



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


  








  

    #path_relative_to_config(path)  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/config.rb', line 286



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


  








  

    #patterns_to_exclude  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/config.rb', line 282



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


  








  

    #patterns_to_include  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/config.rb', line 278



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


  








  

    #pending_cops  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/config.rb', line 336



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'
    next if new_cops_covered?(qualified_cop_name)

    pending_cops << CopConfig.new(qualified_cop_name, cop_metadata)
  end
end


  








  

    #read_gem_versions_from_target_lockfile   (private)
  

  [ GitHub ]


  

  


# File 'lib/rubocop/config.rb', line 392



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  ⇒ Float?  (private)
  



  

    
  





  
Returns:


    
  
  • 
    (Float, nil)
—    
    

    The Rails version as a major.minor Float.
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/rubocop/config.rb', line 373



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


  








  

    #signature  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/config.rb', line 105



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


  








  

    #smart_loaded_path  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/config.rb', line 320



def smart_loaded_path
  PathUtil.smart_path(@loaded_path)
end


  








  

    #target_rails_version  
  

  [ GitHub ]


  

  


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



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


  








  

    #target_rails_version_from_bundler_lock_file  ⇒ Float?  (private)
  



  

    
  





  
Returns:


    
  
  • 
    (Float, nil)
—    
    

    The Rails version as a major.minor Float.
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/rubocop/config.rb', line 368



def target_rails_version_from_bundler_lock_file
  @target_rails_version_from_bundler_lock_file ||= read_rails_version_from_bundler_lock_file
end


  








  

    #to_s  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/config.rb', line 101



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


  








  

    #validate_after_resolution  
  

  [ GitHub ]


  

  


# File 'lib/rubocop/config.rb', line 92



def validate_after_resolution
  @validator.validate_after_resolution
  self
end