Class: RuboCop::ConfigLoader

Inherits:
Object
  • Object
show all
Extended by:
FileFinder
Defined in:
lib/rubocop/config_loader.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 collapse

DOTFILE = 
ConfigFinder::DOTFILE
RUBOCOP_HOME = 
File.realpath(File.join(File.dirname(__FILE__), '..', '..'))
DEFAULT_FILE = 
File.join(RUBOCOP_HOME, 'config', 'default.yml')
PENDING_BANNER = 
<<~BANNER
  The following cops were added to RuboCop, but are not configured. Please set Enabled to either `true` or `false` in your `.rubocop.yml` file.

  Please also note that you can opt-in to new cops by default by adding this to your config:
    AllCops:
      NewCops: enable
BANNER

Class Attribute Summary collapse

Class Method Summary collapse

Methods included from FileFinder

find_file_upwards, find_last_file_upwards, traverse_directories_upwards

Class Attribute Details

.debug ⇒ Object Also known as: debug?

Returns the value of attribute debug.



33
34
35
 
# File 'lib/rubocop/config_loader.rb', line 33

def debug
  @debug
end

.default_configuration ⇒ Object 



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

def default_configuration
  @default_configuration ||= begin
    print 'Default ' if debug?
    load_file(DEFAULT_FILE)
  end
end

.disable_pending_cops ⇒ Object

Returns the value of attribute disable_pending_cops.



33
34
35
 
# File 'lib/rubocop/config_loader.rb', line 33

def disable_pending_cops
  @disable_pending_cops
end

.enable_pending_cops ⇒ Object

Returns the value of attribute enable_pending_cops.



33
34
35
 
# File 'lib/rubocop/config_loader.rb', line 33

def enable_pending_cops
  @enable_pending_cops
end

.ignore_parent_exclusion ⇒ Object Also known as: ignore_parent_exclusion?

Returns the value of attribute ignore_parent_exclusion.



33
34
35
 
# File 'lib/rubocop/config_loader.rb', line 33

def ignore_parent_exclusion
  @ignore_parent_exclusion
end

.ignore_unrecognized_cops ⇒ Object

Returns the value of attribute ignore_unrecognized_cops.



33
34
35
 
# File 'lib/rubocop/config_loader.rb', line 33

def ignore_unrecognized_cops
  @ignore_unrecognized_cops
end

.loaded_features ⇒ Object (readonly)

Returns the value of attribute loaded_features.



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

def loaded_features
  @loaded_features
end

Class Method Details

.add_excludes_from_files(config, config_file) ⇒ Object 



137
138
139
140
141
142
143
144
145
 
# File 'lib/rubocop/config_loader.rb', line 137

def add_excludes_from_files(config, config_file)
  exclusion_file = find_last_file_upwards(DOTFILE, config_file, ConfigFinder.project_root)

  return unless exclusion_file
  return if PathUtil.relative_path(exclusion_file) == PathUtil.relative_path(config_file)

  print 'AllCops/Exclude ' if debug?
  config.add_excludes_from_higher_level(load_file(exclusion_file))
end

.add_loaded_features(loaded_features) ⇒ Object

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.

Used to add features that were required inside a config or from the CLI using ‘–require`.



198
199
200
 
# File 'lib/rubocop/config_loader.rb', line 198

def add_loaded_features(loaded_features)
  @loaded_features.merge(Array(loaded_features))
end

.add_missing_namespaces(path, hash) ⇒ Object 



80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/rubocop/config_loader.rb', line 80

def add_missing_namespaces(path, hash)
  # Using `hash.each_key` will cause the
  # `can't add a new key into hash during iteration` error
  hash_keys = hash.keys
  hash_keys.each do |key|
    q = Cop::Registry.qualified_cop_name(key, path)
    next if q == key

    hash[q] = hash.delete(key)
  end
end

.clear_options ⇒ Object 



41
42
43
44
45
 
# File 'lib/rubocop/config_loader.rb', line 41

def clear_options
  @debug = nil
  @loaded_features = Set.new
  FileFinder.root_level = nil
end

.configuration_file_for(target_dir) ⇒ Object

Returns the path of .rubocop.yml searching upwards in the directory structure starting at the given directory where the inspected file is. If no .rubocop.yml is found there, the user’s home directory is checked. If there’s no .rubocop.yml there either, the path to the default file is returned.



104
105
106
 
# File 'lib/rubocop/config_loader.rb', line 104

def configuration_file_for(target_dir)
  ConfigFinder.find_config_path(target_dir)
end

.configuration_from_file(config_file, check: true) ⇒ Object 



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/rubocop/config_loader.rb', line 108

def configuration_from_file(config_file, check: true)
  return default_configuration if config_file == DEFAULT_FILE

  config = load_file(config_file, check: check)
  config.validate_after_resolution if check

  if ignore_parent_exclusion?
    print 'Ignoring AllCops/Exclude from parent folders' if debug?
  else
    add_excludes_from_files(config, config_file)
  end

  merge_with_default(config, config_file).tap do |merged_config|
    unless possible_new_cops?(merged_config)
      pending_cops = pending_cops_only_qualified(merged_config.pending_cops)
      warn_on_pending_cops(pending_cops) unless pending_cops.empty?
    end
  end
end

.inject_defaults!(project_root) ⇒ Object

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. 



155
156
157
158
159
160
161
 
# File 'lib/rubocop/config_loader.rb', line 155

def inject_defaults!(project_root)
  path = File.join(project_root, 'config', 'default.yml')
  config = load_file(path)
  new_config = ConfigLoader.merge_with_default(config, path)
  puts "configuration from #{path}" if debug?
  @default_configuration = new_config
end

.load_file(file, check: true) ⇒ Object 



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/rubocop/config_loader.rb', line 47

def load_file(file, check: true)
  path = file_path(file)

  hash = load_yaml_configuration(path)

  loaded_features = resolver.resolve_requires(path, hash)
  add_loaded_features(loaded_features)

  resolver.override_department_setting_for_cops({}, hash)
  resolver.resolve_inheritance_from_gems(hash)
  resolver.resolve_inheritance(path, hash, file, debug?)
  hash.delete('inherit_from')

  # Adding missing namespaces only after resolving requires & inheritance,
  # since both can introduce new cops that need to be considered here.
  add_missing_namespaces(path, hash)

  Config.create(hash, path, check: check)
end

.load_yaml_configuration(absolute_path) ⇒ Object

Raises:

  • (TypeError) 


67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/rubocop/config_loader.rb', line 67

def load_yaml_configuration(absolute_path)
  file_contents = read_file(absolute_path)
  yaml_code = Dir.chdir(File.dirname(absolute_path)) { ERB.new(file_contents).result }
  yaml_tree = check_duplication(yaml_code, absolute_path)
  hash = yaml_tree_to_hash(yaml_tree) || {}

  puts "configuration from #{absolute_path}" if debug?

  raise(TypeError, "Malformed configuration in #{absolute_path}") unless hash.is_a?(Hash)

  hash
end

.merge(base_hash, derived_hash) ⇒ Object

Return a recursive merge of two hashes. That is, a normal hash merge, with the addition that any value that is a hash, and occurs in both arguments, will also be merged. And so on.



95
96
97
 
# File 'lib/rubocop/config_loader.rb', line 95

def merge(base_hash, derived_hash)
  resolver.merge(base_hash, derived_hash)
end

.merge_with_default(config, config_file, unset_nil: true) ⇒ Object

Merges the given configuration with the default one.



191
192
193
 
# File 'lib/rubocop/config_loader.rb', line 191

def merge_with_default(config, config_file, unset_nil: true)
  resolver.merge_with_default(config, config_file, unset_nil: unset_nil)
end

.pending_cops_only_qualified(pending_cops) ⇒ Object 



128
129
130
 
# File 'lib/rubocop/config_loader.rb', line 128

def pending_cops_only_qualified(pending_cops)
  pending_cops.select { |cop| Cop::Registry.qualified_cop?(cop.name) }
end

.possible_new_cops?(config) ⇒ Boolean

Returns:

  • (Boolean) 


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

def possible_new_cops?(config)
  disable_pending_cops || enable_pending_cops ||
    config.disabled_new_cops? || config.enabled_new_cops?
end

.project_root ⇒ Object

Deprecated.

Use ‘RuboCop::ConfigFinder.project_root` instead.

Returns the path RuboCop inferred as the root of the project. No file searches will go past this directory.



166
167
168
169
170
171
172
173
 
# File 'lib/rubocop/config_loader.rb', line 166

def project_root
  warn Rainbow(<<~WARNING).yellow, uplevel: 1
    `RuboCop::ConfigLoader.project_root` is deprecated and will be removed in RuboCop 2.0. \
    Use `RuboCop::ConfigFinder.project_root` instead.
  WARNING

  ConfigFinder.project_root
end

.warn_on_pending_cops(pending_cops) ⇒ Object 



175
176
177
178
179
180
181
 
# File 'lib/rubocop/config_loader.rb', line 175

def warn_on_pending_cops(pending_cops)
  warn Rainbow(PENDING_BANNER).yellow

  pending_cops.each { |cop| warn_pending_cop cop }

  warn Rainbow('For more information: https://docs.rubocop.org/rubocop/versioning.html').yellow
end

.warn_pending_cop(cop) ⇒ Object 



183
184
185
186
187
188
 
# File 'lib/rubocop/config_loader.rb', line 183

def warn_pending_cop(cop)
  version = cop.metadata['VersionAdded'] || 'N/A'

  warn Rainbow("#{cop.name}: # new in #{version}").yellow
  warn Rainbow('  Enabled: true').yellow
end