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 = 
'.rubocop.yml'
XDG_CONFIG = 
'config.yml'
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, root_level=, root_level?

Class Attribute Details

.debug ⇒ Object Also known as: debug?

Returns the value of attribute debug.


25
26
27
 
# File 'lib/rubocop/config_loader.rb', line 25

def debug
  @debug
end

.default_configuration ⇒ Object 


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

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.


25
26
27
 
# File 'lib/rubocop/config_loader.rb', line 25

def disable_pending_cops
  @disable_pending_cops
end

.enable_pending_cops ⇒ Object

Returns the value of attribute enable_pending_cops.


25
26
27
 
# File 'lib/rubocop/config_loader.rb', line 25

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.


25
26
27
 
# File 'lib/rubocop/config_loader.rb', line 25

def ignore_parent_exclusion
  @ignore_parent_exclusion
end

.loaded_features ⇒ Object (readonly)

Returns the value of attribute loaded_features.


27
28
29
 
# File 'lib/rubocop/config_loader.rb', line 27

def loaded_features
  @loaded_features
end

.project_root ⇒ Object

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


139
140
141
 
# File 'lib/rubocop/config_loader.rb', line 139

def project_root
  @project_root ||= find_project_root
end

Class Method Details

.add_excludes_from_files(config, config_file) ⇒ Object 


120
121
122
123
124
125
126
127
128
 
# File 'lib/rubocop/config_loader.rb', line 120

def add_excludes_from_files(config, config_file)
  exclusion_file = find_last_file_upwards(DOTFILE, config_file, 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`.


176
177
178
 
# File 'lib/rubocop/config_loader.rb', line 176

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

.add_missing_namespaces(path, hash) ⇒ Object 


71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/rubocop/config_loader.rb', line 71

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 


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

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.


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

def configuration_file_for(target_dir)
  find_project_dotfile(target_dir) || find_user_dotfile ||
    find_user_xdg_config || DEFAULT_FILE
end

.configuration_from_file(config_file, check: true) ⇒ Object 


100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/rubocop/config_loader.rb', line 100

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

  config = load_file(config_file, check: 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|
    warn_on_pending_cops(merged_config.pending_cops) unless possible_new_cops?(merged_config)
  end
end

.load_file(file, check: true) ⇒ Object 


38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/rubocop/config_loader.rb', line 38

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

  hash = load_yaml_configuration(path)

  # Resolve requires first in case they define additional cops
  loaded_features = resolver.resolve_requires(path, hash)
  add_loaded_features(loaded_features)

  add_missing_namespaces(path, hash)

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

  hash.delete('inherit_from')

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

.load_yaml_configuration(absolute_path) ⇒ Object

Raises:

  • (TypeError) 

58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/rubocop/config_loader.rb', line 58

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 }
  check_duplication(yaml_code, absolute_path)
  hash = yaml_safe_load(yaml_code, absolute_path) || {}

  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.


86
87
88
 
# File 'lib/rubocop/config_loader.rb', line 86

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.


169
170
171
 
# File 'lib/rubocop/config_loader.rb', line 169

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

.possible_new_cops?(config) ⇒ Boolean

Returns:

  • (Boolean) 

115
116
117
118
 
# File 'lib/rubocop/config_loader.rb', line 115

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

.warn_on_pending_cops(pending_cops) ⇒ Object 


151
152
153
154
155
156
157
158
159
 
# File 'lib/rubocop/config_loader.rb', line 151

def warn_on_pending_cops(pending_cops)
  return if pending_cops.empty?

  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 


161
162
163
164
165
166
 
# File 'lib/rubocop/config_loader.rb', line 161

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