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.
# File lib/rubocop/config_loader.rb, line 66 def base_configs(path, inherit_from) configs = Array(inherit_from).map do |f| f = File.join(File.dirname(path), f) unless f.start_with?('/') 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 configs.compact end
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.
# File lib/rubocop/config_loader.rb, line 87 def configuration_file_for(target_dir) config_files_in_path(target_dir).first || DEFAULT_FILE end
# File lib/rubocop/config_loader.rb, line 91 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
# File lib/rubocop/config_loader.rb, line 103 def default_configuration @default_configuration ||= begin print 'Default ' if debug? load_file(DEFAULT_FILE) end end
# File lib/rubocop/config_loader.rb, line 31 def load_file(path) path = File.absolute_path(path) hash = YAML.load_file(path) || {} puts "configuration from #{path}" if debug? 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
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.
# File lib/rubocop/config_loader.rb, line 56 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
Generated with the Darkfish Rdoc Generator 2.