Class: RuboCop::Config

Inherits:
Hash
  • Object
show all
Includes:
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: ValidationError

Constant Summary collapse

COMMON_PARAMS = 
%w(Exclude Include Severity)

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from PathUtil

issue_deprecation_warning, match_path?, relative_path

Constructor Details

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

Returns a new instance of Config.



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

def initialize(hash = {}, loaded_path = nil)
  @hash = hash
  @loaded_path = loaded_path
  super(@hash)
end

Instance Attribute Details

#loaded_path ⇒ Object (readonly)

Returns the value of attribute loaded_path.



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

def loaded_path
  @loaded_path
end

Instance Method Details

#add_excludes_from_higher_level(highest_config) ⇒ Object 



41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/rubocop/config.rb', line 41

def add_excludes_from_higher_level(highest_config)
  return unless highest_config['AllCops'] &&
                highest_config['AllCops']['Exclude']

  self['AllCops'] ||= {}
  excludes = self['AllCops']['Exclude'] ||= []
  highest_config['AllCops']['Exclude'].each do |path|
    unless path.is_a?(Regexp) || path.start_with?('/')
      path = File.join(File.dirname(highest_config.loaded_path), path)
    end
    excludes << path unless excludes.include?(path)
  end
end

#add_missing_namespaces ⇒ Object 



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

def add_missing_namespaces
  keys.each do |k|
    q = Cop::Cop.qualified_cop_name(k, loaded_path)
    next if q == k

    self[q] = self[k]
    delete(k)
  end
end

#base_dir_for_path_parameters ⇒ Object

Paths specified in .rubocop.yml files 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.



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

def base_dir_for_path_parameters
  if File.basename(loaded_path) == ConfigLoader::DOTFILE
    File.expand_path(File.dirname(loaded_path))
  else
    Dir.pwd
  end
end

#cop_enabled?(cop) ⇒ Boolean

Returns:

  • (Boolean) 


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

def cop_enabled?(cop)
  for_cop(cop).nil? || for_cop(cop)['Enabled']
end

#deprecation_check ⇒ Object 



55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/rubocop/config.rb', line 55

def deprecation_check
  all_cops = self['AllCops']
  return unless all_cops

  %w(Exclude Include).each do |key|
    plural = "#{key}s"
    next unless all_cops[plural]

    all_cops[key] = all_cops[plural] # Stay backwards compatible.
    all_cops.delete(plural)
    yield "AllCops/#{plural} was renamed to AllCops/#{key}"
  end
end

#file_to_exclude?(file) ⇒ Boolean

Returns:

  • (Boolean) 


122
123
124
125
126
127
 
# File 'lib/rubocop/config.rb', line 122

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

#file_to_include?(file) ⇒ Boolean

Returns:

  • (Boolean) 


113
114
115
116
117
118
119
120
 
# File 'lib/rubocop/config.rb', line 113

def file_to_include?(file)
  absolute_file_path = File.expand_path(file)
  relative_file_path = path_relative_to_config(file)
  patterns_to_include.any? do |pattern|
    match_path?(pattern, relative_file_path, loaded_path) ||
      match_path?(pattern, absolute_file_path, loaded_path)
  end
end

#for_cop(cop) ⇒ Object 



69
70
71
72
73
 
# File 'lib/rubocop/config.rb', line 69

def for_cop(cop)
  cop = cop.cop_name if cop.respond_to?(:cop_name)
  @for_cop ||= {}
  @for_cop[cop] ||= self[Cop::Cop.qualified_cop_name(cop, loaded_path)]
end

#make_excludes_absolute ⇒ Object 



27
28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/rubocop/config.rb', line 27

def make_excludes_absolute
  keys.each do |key|
    next unless self[key]['Exclude']

    self[key]['Exclude'].map! do |exclude_elem|
      if exclude_elem.is_a?(String) && !exclude_elem.start_with?('/')
        File.join(base_dir_for_path_parameters, exclude_elem)
      else
        exclude_elem
      end
    end
  end
end

#path_relative_to_config(path) ⇒ Object 



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

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

#patterns_to_exclude ⇒ Object 



133
134
135
 
# File 'lib/rubocop/config.rb', line 133

def patterns_to_exclude
  @hash['AllCops']['Exclude']
end

#patterns_to_include ⇒ Object 



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

def patterns_to_include
  @hash['AllCops']['Include']
end

#validate ⇒ Object

TODO: This should be a private method



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/rubocop/config.rb', line 96

def validate
  # Don't validate RuboCop's own files. Avoids infinite recursion.
  return if loaded_path.start_with?(File.join(ConfigLoader::RUBOCOP_HOME,
                                              'config'))

  valid_cop_names, invalid_cop_names = @hash.keys.partition do |key|
    ConfigLoader.default_configuration.key?(key)
  end

  invalid_cop_names.each do |name|
    fail ValidationError,
         "unrecognized cop #{name} found in #{loaded_path || self}"
  end

  validate_parameter_names(valid_cop_names)
end

#warn_unless_valid ⇒ Object 



79
80
81
82
83
 
# File 'lib/rubocop/config.rb', line 79

def warn_unless_valid
  validate
rescue Config::ValidationError => e
  warn "Warning: #{e.message}".color(:red)
end