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'.freeze
- RUBOCOP_HOME =
File.realpath(File.join(File.dirname(__FILE__), '..', '..'))
- DEFAULT_FILE =
File.join(RUBOCOP_HOME, 'config', 'default.yml')
- AUTO_GENERATED_FILE =
'.rubocop_todo.yml'.freeze
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
-
.ignore_parent_exclusion ⇒ Object
(also: ignore_parent_exclusion?)
Returns the value of attribute ignore_parent_exclusion.
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
-
.merge(base_hash, derived_hash) ⇒ Object
Return a recursive merge of two hashes.
-
.merge_with_default(config, config_file) ⇒ Object
Merges the given configuration with the default one.
- .target_ruby_version_to_f!(hash) ⇒ 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.
25 26 27 |
# File 'lib/rubocop/config_loader.rb', line 25 def auto_gen_config @auto_gen_config end |
.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
102 103 104 105 106 107 |
# File 'lib/rubocop/config_loader.rb', line 102 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.
25 26 27 |
# File 'lib/rubocop/config_loader.rb', line 25 def ignore_parent_exclusion @ignore_parent_exclusion end |
Class Method Details
.add_excludes_from_files(config, config_file) ⇒ Object
93 94 95 96 97 98 99 100 |
# File 'lib/rubocop/config_loader.rb', line 93 def add_excludes_from_files(config, config_file) found_files = find_files_upwards(DOTFILE, config_file, use_home: true) 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
126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 |
# File 'lib/rubocop/config_loader.rb', line 126 def add_inheritance_from_auto_generated_file file_string = " #{AUTO_GENERATED_FILE}" if File.exist?(DOTFILE) files = Array(load_yaml_configuration(DOTFILE)['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 = IO.read(DOTFILE, encoding: Encoding::UTF_8) .sub(/^inherit_from: *[.\w]+/, '') .sub(/^inherit_from: *(\n *- *[.\w]+)+/, '') end write_dotfile(file_string, rubocop_yml_contents) puts "Added inheritance from `#{AUTO_GENERATED_FILE}` in `#{DOTFILE}`." end |
.add_missing_namespaces(path, hash) ⇒ Object
56 57 58 59 60 61 62 63 |
# File 'lib/rubocop/config_loader.rb', line 56 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
32 33 34 35 |
# File 'lib/rubocop/config_loader.rb', line 32 def @debug = @auto_gen_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.
77 78 79 |
# File 'lib/rubocop/config_loader.rb', line 77 def configuration_file_for(target_dir) find_file_upwards(DOTFILE, target_dir, use_home: true) || DEFAULT_FILE end |
.configuration_from_file(config_file) ⇒ Object
81 82 83 84 85 86 87 88 89 90 91 |
# File 'lib/rubocop/config_loader.rb', line 81 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) end |
.load_file(file) ⇒ Object
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 |
# File 'lib/rubocop/config_loader.rb', line 37 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) target_ruby_version_to_f!(hash) resolver.resolve_inheritance_from_gems(hash, hash.delete('inherit_gem')) 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.
68 69 70 |
# File 'lib/rubocop/config_loader.rb', line 68 def merge(base_hash, derived_hash) resolver.merge(base_hash, derived_hash) end |
.merge_with_default(config, config_file) ⇒ 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.
115 116 117 |
# File 'lib/rubocop/config_loader.rb', line 115 def merge_with_default(config, config_file) resolver.merge_with_default(config, config_file) end |
.target_ruby_version_to_f!(hash) ⇒ Object
119 120 121 122 123 124 |
# File 'lib/rubocop/config_loader.rb', line 119 def target_ruby_version_to_f!(hash) version = 'TargetRubyVersion' return unless hash['AllCops'] && hash['AllCops'][version] hash['AllCops'][version] = hash['AllCops'][version].to_f end |