class RuboCop::ConfigLoader

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.

Constants

AUTO_GENERATED_FILE
DEFAULT_FILE
DOTFILE
RUBOCOP_HOME

Attributes

auto_gen_config[RW]
auto_gen_config?[RW]
debug[RW]
debug?[RW]
default_configuration[W]
root_level[W]

Public Class Methods

base_configs(path, inherit_from) click to toggle source
# File lib/rubocop/config_loader.rb, line 66
def base_configs(path, inherit_from)
  configs = Array(inherit_from).compact.map do |f|
    if f =~ /\A#{URI.regexp(%w(http https))}\z/
      f = RemoteConfig.new(f, File.dirname(path)).file
    else
      f = File.expand_path(f, File.dirname(path))

      if auto_gen_config?
        next if f.include?(AUTO_GENERATED_FILE)
      end

      print 'Inheriting ' if debug?
    end
    load_file(f)
  end

  configs.compact
end
clear_options() click to toggle source
# File lib/rubocop/config_loader.rb, line 28
def clear_options
  @debug = @auto_gen_config = @root_level = nil
end
configuration_file_for(target_dir) click to toggle source

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 90
def configuration_file_for(target_dir)
  config_files_in_path(target_dir).first || DEFAULT_FILE
end
configuration_from_file(config_file) click to toggle source
# File lib/rubocop/config_loader.rb, line 94
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
default_configuration() click to toggle source
# File lib/rubocop/config_loader.rb, line 106
def default_configuration
  @default_configuration ||= begin
                               print 'Default ' if debug?
                               load_file(DEFAULT_FILE)
                             end
end
load_file(path) click to toggle source
# File lib/rubocop/config_loader.rb, line 32
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)
  resolve_requires(path, hash)

  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.validate
  config.make_excludes_absolute
  config
end
merge(base_hash, derived_hash) click to toggle source

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
merge_with_default(config, config_file) click to toggle source

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.

# File lib/rubocop/config_loader.rb, line 116
def merge_with_default(config, config_file)
  configs =
    if config.for_all_cops['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

Private Class Methods

config_files_in_path(target) click to toggle source
# File lib/rubocop/config_loader.rb, line 178
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
gem_config_path(gem_name, relative_config_path) click to toggle source
# File lib/rubocop/config_loader.rb, line 170
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
load_yaml_configuration(absolute_path) click to toggle source
# File lib/rubocop/config_loader.rb, line 140
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)
    raise(TypeError, "Malformed configuration in #{absolute_path}")
  end

  hash
end
transform(config) { |params| ... } click to toggle source

Returns a new hash where the parameters of the given config hash have been replaced by parameters returned by the given block.

# File lib/rubocop/config_loader.rb, line 136
def transform(config)
  Hash[config.map { |cop, params| [cop, yield(params)] }]
end
yaml_safe_load(yaml_code) click to toggle source
# File lib/rubocop/config_loader.rb, line 158
def yaml_safe_load(yaml_code)
  if YAML.respond_to?(:safe_load) # Ruby 2.1+
    if defined?(SafeYAML) && SafeYAML.respond_to?(:load)
      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