Class: RuboCop::ConfigLoader
- Inherits:
-
Object
- Object
- RuboCop::ConfigLoader
- 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
-
.auto_gen_config ⇒ Object
(also: auto_gen_config?)
Returns the value of attribute auto_gen_config.
-
.debug ⇒ Object
(also: debug?)
Returns the value of attribute debug.
- .default_configuration ⇒ Object
-
.disable_pending_cops ⇒ Object
Returns the value of attribute disable_pending_cops.
-
.enable_pending_cops ⇒ Object
Returns the value of attribute enable_pending_cops.
-
.ignore_parent_exclusion ⇒ Object
(also: ignore_parent_exclusion?)
Returns the value of attribute ignore_parent_exclusion.
-
.options_config ⇒ Object
Returns the value of attribute options_config.
Class Method Summary collapse
- .add_excludes_from_files(config, config_file) ⇒ Object
- .add_inheritance_from_auto_generated_file ⇒ Object
- .add_missing_namespaces(path, hash) ⇒ Object
- .clear_options ⇒ Object
-
.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.
- .configuration_from_file(config_file) ⇒ Object
-
.load_file(file) ⇒ Object
rubocop:disable Metrics/AbcSize.
-
.merge(base_hash, derived_hash) ⇒ Object
Return a recursive merge of two hashes.
-
.merge_with_default(config, config_file, unset_nil: true) ⇒ Object
Merges the given configuration with the default one.
- .possible_new_cops?(config) ⇒ Boolean
- .warn_on_pending_cops(pending_cops) ⇒ Object
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
121 122 123 124 125 126 |
# File 'lib/rubocop/config_loader.rb', line 121 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.
26 27 28 |
# File 'lib/rubocop/config_loader.rb', line 26 def disable_pending_cops @disable_pending_cops end |
.enable_pending_cops ⇒ Object
Returns the value of attribute enable_pending_cops.
26 27 28 |
# File 'lib/rubocop/config_loader.rb', line 26 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.
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 end |
Class Method Details
.add_excludes_from_files(config, config_file) ⇒ Object
109 110 111 112 113 114 115 116 117 118 119 |
# File 'lib/rubocop/config_loader.rb', line 109 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
154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 |
# File 'lib/rubocop/config_loader.rb', line 154 def add_inheritance_from_auto_generated_file file_string = " #{AUTO_GENERATED_FILE}" config_file = || 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
58 59 60 61 62 63 64 65 66 67 68 |
# File 'lib/rubocop/config_loader.rb', line 58 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::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 @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.
82 83 84 85 |
# File 'lib/rubocop/config_loader.rb', line 82 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
87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 |
# File 'lib/rubocop/config_loader.rb', line 87 def configuration_from_file(config_file) return ConfigLoader.default_configuration if config_file == DEFAULT_FILE config = load_file(config_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| unless possible_new_cops?(config) warn_on_pending_cops(merged_config.pending_cops) end end end |
.load_file(file) ⇒ Object
rubocop:disable Metrics/AbcSize
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 39 def load_file(file) # rubocop:disable Metrics/AbcSize 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.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) 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.
73 74 75 |
# File 'lib/rubocop/config_loader.rb', line 73 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.
150 151 152 |
# File 'lib/rubocop/config_loader.rb', line 150 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
104 105 106 107 |
# File 'lib/rubocop/config_loader.rb', line 104 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
128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 |
# File 'lib/rubocop/config_loader.rb', line 128 def warn_on_pending_cops(pending_cops) return if pending_cops.empty? 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| version = cop.['VersionAdded'] || 'N/A' warn Rainbow(" - #{cop.name} (#{version})").yellow end warn Rainbow('For more information: https://docs.rubocop.org/en/latest/versioning/').yellow end |