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')
AUTO_GENERATED_FILE = 
'.rubocop_todo.yml'

Class Attribute Summary collapse

Class Method Summary collapse

Methods included from FileFinder

find_file_upwards, find_files_upwards, root_level=, root_level?

Class Attribute Details

.auto_gen_config ⇒ Object Also known as: auto_gen_config?

Returns the value of attribute auto_gen_config.



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

def auto_gen_config
  @auto_gen_config
end

.debug ⇒ Object Also known as: debug?

Returns the value of attribute debug.



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

def debug
  @debug
end

.default_configuration ⇒ Object 



112
113
114
115
116
117
 
# File 'lib/rubocop/config_loader.rb', line 112

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

.ignore_parent_exclusion ⇒ Object Also known as: ignore_parent_exclusion?

Returns the value of attribute ignore_parent_exclusion.



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

def ignore_parent_exclusion
  @ignore_parent_exclusion
end

.options_config ⇒ Object

Returns the value of attribute options_config.



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

def options_config
  @options_config
end

Class Method Details

.add_excludes_from_files(config, config_file) ⇒ Object 



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

def add_excludes_from_files(config, config_file)
  found_files =
    find_files_upwards(DOTFILE, config_file) +
    [find_user_dotfile, find_user_xdg_config].compact

  return if found_files.empty?
  return if PathUtil.relative_path(found_files.last) ==
            PathUtil.relative_path(config_file)

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

.add_inheritance_from_auto_generated_file ⇒ Object 



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/rubocop/config_loader.rb', line 145

def add_inheritance_from_auto_generated_file
  file_string = " #{AUTO_GENERATED_FILE}"

  config_file = options_config || DOTFILE

  if File.exist?(config_file)
    files = Array(load_yaml_configuration(config_file)['inherit_from'])

    return if files.include?(AUTO_GENERATED_FILE)

    files.unshift(AUTO_GENERATED_FILE)
    file_string = "\n  - " + files.join("\n  - ") if files.size > 1
    rubocop_yml_contents = existing_configuration(config_file)
  end

  write_config_file(config_file, file_string, rubocop_yml_contents)

  puts "Added inheritance from `#{AUTO_GENERATED_FILE}` in `#{DOTFILE}`."
end

.add_missing_namespaces(path, hash) ⇒ Object 



57
58
59
60
61
62
63
64
 
# File 'lib/rubocop/config_loader.rb', line 57

def add_missing_namespaces(path, hash)
  hash.keys.each do |key|
    q = Cop::Cop.qualified_cop_name(key, path)
    next if q == key

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

.clear_options ⇒ Object 



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

def clear_options
  @debug = @auto_gen_config = @options_config = nil
  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.



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

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) ⇒ Object 



85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/rubocop/config_loader.rb', line 85

def configuration_from_file(config_file)
  config = load_file(config_file)
  return config if config_file == DEFAULT_FILE

  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)
  end
end

.load_file(file) ⇒ Object 



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

def load_file(file)
  path = File.absolute_path(file.is_a?(RemoteConfig) ? file.file : file)

  hash = load_yaml_configuration(path)

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

  add_missing_namespaces(path, hash)

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

  hash.delete('inherit_from')

  Config.create(hash, path)
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.



69
70
71
 
# File 'lib/rubocop/config_loader.rb', line 69

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. If AllCops:DisabledByDefault is true, it changes the Enabled params so that only cops from user configuration are enabled. If AllCops::EnabledByDefault is true, it changes the Enabled params so that only cops explicitly disabled in user configuration are disabled.



141
142
143
 
# File 'lib/rubocop/config_loader.rb', line 141

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

.warn_on_pending_cops(config) ⇒ Object 



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/rubocop/config_loader.rb', line 119

def warn_on_pending_cops(config)
  pending_cops = config.keys.select do |key|
    config[key]['Enabled'] == 'pending'
  end

  return if pending_cops.none?

  warn Rainbow('The following cops were added to RuboCop, but are not ' \
               'configured. Please set Enabled to either `true` or ' \
               '`false` in your `.rubocop.yml` file:').yellow

  pending_cops.each do |cop|
    warn Rainbow(" - #{cop}").yellow
  end
end