class RuboCop::ConfigLoader
directories are inspected.
during a run of the rubocop program, if files in several
file from which it was read. Several different Configs can be used
and all its cops. A Config is associated with a YAML configuration
This class represents the configuration of the RuboCop application
def base_configs(path, inherit_from)
def base_configs(path, inherit_from) configs = Array(inherit_from).compact.map do |f| if f =~ URI.regexp f = RemoteConfig.new(f).file load_file(f) else f = File.expand_path(f, File.dirname(path)) if auto_gen_config? next if f.include?(AUTO_GENERATED_FILE) old_auto_config_file_warning if f.include?('rubocop-todo.yml') end print 'Inheriting ' if debug? load_file(f) end end configs.compact end
def config_files_in_path(target)
def config_files_in_path(target) possible_config_files = dirs_to_search(target).map do |dir| File.join(dir, DOTFILE) end possible_config_files.select { |config_file| File.exist?(config_file) } end
def configuration_file_for(target_dir)
user's home directory is checked. If there's no .rubocop.yml
inspected file is. If no .rubocop.yml is found there, the
directory structure starting at the given directory where the
Returns the path of .rubocop.yml searching upwards in the
def configuration_file_for(target_dir) config_files_in_path(target_dir).first || DEFAULT_FILE end
def configuration_from_file(config_file)
def configuration_from_file(config_file) config = load_file(config_file) return config if config_file == DEFAULT_FILE found_files = config_files_in_path(config_file) if found_files.any? && found_files.last != config_file print 'AllCops/Exclude ' if debug? config.add_excludes_from_higher_level(load_file(found_files.last)) end merge_with_default(config, config_file) end
def default_configuration
def default_configuration @default_configuration ||= begin print 'Default ' if debug? load_file(DEFAULT_FILE) end end
def dirs_to_search(target_dir)
def dirs_to_search(target_dir) dirs_to_search = [] Pathname.new(File.expand_path(target_dir)).ascend do |dir_pathname| break if dir_pathname.to_s == @root_level dirs_to_search << dir_pathname.to_s end dirs_to_search << Dir.home end
def gem_config_path(gem_name, relative_config_path)
def gem_config_path(gem_name, relative_config_path) spec = Gem::Specification.find_by_name(gem_name) return File.join(spec.gem_dir, relative_config_path) rescue Gem::LoadError => e raise Gem::LoadError, "Unable to find gem #{gem_name}; is the gem installed? #{e}" end
def load_file(path)
def load_file(path) path = File.absolute_path(path) hash = load_yaml_configuration(path) resolve_inheritance_from_gems(hash, hash.delete('inherit_gem')) resolve_inheritance(path, hash) Array(hash.delete('require')).each { |r| require(r) } hash.delete('inherit_from') config = Config.new(hash, path) config.deprecation_check do |deprecation_message| warn("#{path} - #{deprecation_message}") end config.add_missing_namespaces config.warn_unless_valid config.make_excludes_absolute config end
def load_yaml_configuration(absolute_path)
def load_yaml_configuration(absolute_path) yaml_code = IO.read(absolute_path) # At one time, there was a problem with the psych YAML engine under # Ruby 1.9.3. YAML.load_file would crash when reading empty .yml files # or files that only contained comments and blank lines. This problem # is not possible to reproduce now, but we want to avoid it in case # it's still there. So we only load the YAML code if we find some real # code in there. hash = yaml_code =~ /^[A-Z]/i ? yaml_safe_load(yaml_code) : {} puts "configuration from #{absolute_path}" if debug? unless hash.is_a?(Hash) fail(TypeError, "Malformed configuration in #{absolute_path}") end hash end
def merge(base_hash, derived_hash)
with the addition that any value that is a hash, and occurs in both
Return a recursive merge of two hashes. That is, a normal hash merge,
def merge(base_hash, derived_hash) result = base_hash.merge(derived_hash) keys_appearing_in_both = base_hash.keys & derived_hash.keys keys_appearing_in_both.each do |key| next unless base_hash[key].is_a?(Hash) result[key] = merge(base_hash[key], derived_hash[key]) end result end
def merge_with_default(config, config_file)
AllCops:DisabledByDefault is true, it changes the Enabled params so
Merges the given configuration with the default one. If
def merge_with_default(config, config_file) configs = if config.key?('AllCops') && config['AllCops']['DisabledByDefault'] disabled_default = transform(default_configuration) do |params| params.merge('Enabled' => false) # Overwrite with false. end enabled_user_config = transform(config) do |params| { 'Enabled' => true }.merge(params) # Set true if not set. end [disabled_default, enabled_user_config] else [default_configuration, config] end Config.new(merge(configs.first, configs.last), config_file) end
def old_auto_config_file_warning
def old_auto_config_file_warning warn Rainbow('Attention: rubocop-todo.yml has been renamed to ' \ "#{AUTO_GENERATED_FILE}").red exit(1) end
def resolve_inheritance(path, hash)
def resolve_inheritance(path, hash) base_configs(path, hash['inherit_from']).reverse_each do |base_config| base_config.each do |k, v| hash[k] = hash.key?(k) ? merge(v, hash[k]) : v if v.is_a?(Hash) end end end
def resolve_inheritance_from_gems(hash, gems)
def resolve_inheritance_from_gems(hash, gems) (gems || {}).each_pair do |gem_name, config_path| hash['inherit_from'] = Array(hash['inherit_from']) hash['inherit_from'] << gem_config_path(gem_name, config_path) end end
def transform(config)
Returns a new hash where the parameters of the given config hash have
def transform(config) Hash[config.map { |cop, params| [cop, yield(params)] }] end
def yaml_safe_load(yaml_code)
def yaml_safe_load(yaml_code) if YAML.respond_to?(:safe_load) # Ruby 2.1+ if defined?(SafeYAML) SafeYAML.load(yaml_code, nil, whitelisted_tags: %w(!ruby/regexp)) else YAML.safe_load(yaml_code, [Regexp]) end else YAML.load(yaml_code) end end