Class: RuboCop::ConfigLoader

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain: self, `FileFinder`
Inherits:	Object
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

DEFAULT_FILE =
# File 'lib/rubocop/config_loader.rb', line 21
```
File.join(RUBOCOP_HOME, 'config', 'default.yml')
```
DOTFILE =
# File 'lib/rubocop/config_loader.rb', line 19
```
ConfigFinder::DOTFILE
```

RUBOCOP_HOME =
# File 'lib/rubocop/config_loader.rb', line 20

File.realpath(File.join(File.dirname(__FILE__), '..', '..'))

Class Attribute Summary

.cache_root(cache_root_override = nil) rw
.cache_root=(value) rw
.debug? rw

Alias for .debug.
.default_configuration rw
.default_configuration=(value) rw
.disable_pending_cops rw
.disabled_by_default rw
.enable_pending_cops rw
.enabled_by_default rw
.ignore_parent_exclusion? rw

Alias for .ignore_parent_exclusion.
.ignore_unrecognized_cops rw
.loaded_features readonly
.loaded_plugins readonly
.preview rw

Class Method Summary

.add_excludes_from_files(config, config_file)
.add_loaded_features(loaded_features) Internal use only

Used to add features that were required inside a config or from the CLI using --require.
.add_loaded_plugins(loaded_plugins) Internal use only

Used to add plugins that were required inside a config or from the CLI using --plugin.
.add_missing_namespaces(path, hash)
.apply_default_overrides(config)

Applies CLI overrides for AllCops/EnabledByDefault and AllCops/DisabledByDefault to the given configuration.
.clear_options
.configuration_file_for(target_dir)

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, check: true)
.debug (also: .debug?) rw
.ignore_parent_exclusion (also: .ignore_parent_exclusion?) rw
.inject_defaults!(config_yml_path)

This API is primarily intended for testing and documenting plugins.
.load_file(file, check: true)

rubocop:disable-next Metrics/AbcSize.
.load_yaml_configuration(absolute_path)
.merge(base_hash, derived_hash)

Return a recursive merge of two hashes.
.merge_with_default(config, config_file, unset_nil: true)

Merges the given configuration with the default one.
.project_root deprecated Deprecated.

Use ConfigFinder.project_root instead.
.check_duplication(yaml_code, absolute_path) private
.file_path(file) private
.read_file(absolute_path) private

Read the specified file, or exit with a friendly, concise message on stderr.
.resolver private
.yaml_tree_to_hash(yaml_tree) private
.yaml_tree_to_hash!(yaml_tree) private

`FileFinder` - Extended

find_file_upwards, find_last_file_upwards, traverse_directories_upwards, traverse_files_upwards

Class Attribute Details

.cache_root(cache_root_override = nil) (rw)

[ GitHub ]

# File 'lib/rubocop/config_loader.rb', line 35


def cache_root(cache_root_override = nil)
  @cache_root ||= CacheConfig.root_dir_from_toplevel_config(cache_root_override)
end

.cache_root=(value) (rw)

[ GitHub ]

# File 'lib/rubocop/config_loader.rb', line 29


attr_writer :default_configuration, :cache_root

.debug? (rw)

Alias for .debug.

[ GitHub ]

# File 'lib/rubocop/config_loader.rb', line 32


alias debug? debug

.default_configuration (rw)

[ GitHub ]

# File 'lib/rubocop/config_loader.rb', line 151


def default_configuration
  @default_configuration ||= begin
    print 'Default ' if debug?
    load_file(DEFAULT_FILE)
  end
end

.default_configuration=(value) (rw)

[ GitHub ]

# File 'lib/rubocop/config_loader.rb', line 29


attr_writer :default_configuration, :cache_root

.disable_pending_cops (rw)

[ GitHub ]

# File 'lib/rubocop/config_loader.rb', line 26


attr_accessor :debug, :ignore_parent_exclusion, :disable_pending_cops, :enable_pending_cops,
              :enabled_by_default, :disabled_by_default, :ignore_unrecognized_cops,
              :preview

.disabled_by_default (rw)

[ GitHub ]

# File 'lib/rubocop/config_loader.rb', line 26


attr_accessor :debug, :ignore_parent_exclusion, :disable_pending_cops, :enable_pending_cops,
              :enabled_by_default, :disabled_by_default, :ignore_unrecognized_cops,
              :preview

.enable_pending_cops (rw)

[ GitHub ]

# File 'lib/rubocop/config_loader.rb', line 26


attr_accessor :debug, :ignore_parent_exclusion, :disable_pending_cops, :enable_pending_cops,
              :enabled_by_default, :disabled_by_default, :ignore_unrecognized_cops,
              :preview

.enabled_by_default (rw)

[ GitHub ]

# File 'lib/rubocop/config_loader.rb', line 26


attr_accessor :debug, :ignore_parent_exclusion, :disable_pending_cops, :enable_pending_cops,
              :enabled_by_default, :disabled_by_default, :ignore_unrecognized_cops,
              :preview

.ignore_parent_exclusion? (rw)

Alias for .ignore_parent_exclusion.

[ GitHub ]

# File 'lib/rubocop/config_loader.rb', line 33


alias ignore_parent_exclusion? ignore_parent_exclusion

.ignore_unrecognized_cops (rw)

[ GitHub ]

# File 'lib/rubocop/config_loader.rb', line 26


attr_accessor :debug, :ignore_parent_exclusion, :disable_pending_cops, :enable_pending_cops,
              :enabled_by_default, :disabled_by_default, :ignore_unrecognized_cops,
              :preview

.loaded_features (readonly)

[ GitHub ]

# File 'lib/rubocop/config_loader.rb', line 30


attr_reader :loaded_plugins, :loaded_features

.loaded_plugins (readonly)

[ GitHub ]

# File 'lib/rubocop/config_loader.rb', line 30


attr_reader :loaded_plugins, :loaded_features

.preview (rw)

[ GitHub ]

# File 'lib/rubocop/config_loader.rb', line 26


attr_accessor :debug, :ignore_parent_exclusion, :disable_pending_cops, :enable_pending_cops,
              :enabled_by_default, :disabled_by_default, :ignore_unrecognized_cops,
              :preview

Class Method Details

.add_excludes_from_files(config, config_file)

[ GitHub ]

# File 'lib/rubocop/config_loader.rb', line 141


def add_excludes_from_files(config, config_file)
  exclusion_file = find_last_file_upwards(DOTFILE, config_file, ConfigFinder.project_root)

  return unless exclusion_file
  return if PathUtil.relative_path(exclusion_file) == PathUtil.relative_path(config_file)

  print 'AllCops/Exclude ' if debug?
  config.add_excludes_from_higher_level(load_file(exclusion_file))
end

.add_loaded_features(loaded_features)

Used to add features that were required inside a config or from the CLI using --require.

[ GitHub ]

# File 'lib/rubocop/config_loader.rb', line 225


def add_loaded_features(loaded_features)
  @loaded_features.merge(Array(loaded_features))
end

.add_loaded_plugins(loaded_plugins)

Used to add plugins that were required inside a config or from the CLI using --plugin.

[ GitHub ]

# File 'lib/rubocop/config_loader.rb', line 218


def add_loaded_plugins(loaded_plugins)
  @loaded_plugins.merge(Array(loaded_plugins))
end

.add_missing_namespaces(path, hash)

[ GitHub ]

# File 'lib/rubocop/config_loader.rb', line 94


def add_missing_namespaces(path, hash)
  # Using `hash.each_key` will cause the
  # `can't add a new key into hash during iteration` error
  obsoletion = ConfigObsoletion.new(hash)

  hash_keys = hash.keys
  hash_keys.each do |key|
    next if obsoletion.deprecated_cop_name?(key)

    q = Cop::Registry.qualified_cop_name(key, path)
    next if q == key

    hash[q] = hash.delete(key)
  end
end

.apply_default_overrides(config)

Applies CLI overrides for AllCops/EnabledByDefault and AllCops/DisabledByDefault to the given configuration. Used when the configuration would otherwise be returned without going through .merge_with_default (e.g. there is no user-supplied .rubocop.yml). Used when there is no configuration file, so the defaults are the whole configuration and still need the same treatment .merge_with_default would have given them.

[ GitHub ]

# File 'lib/rubocop/config_loader.rb', line 203


def apply_default_overrides(config)
  hash = resolver.apply_preview_defaults(config, preview == true)

  unless @enabled_by_default.nil? && @disabled_by_default.nil?
    hash = hash.transform_values do |params|
      params.is_a?(Hash) ? params.merge('Enabled' => !@disabled_by_default) : params
    end
  end

  Config.new(hash, config.loaded_path)
end

.check_duplication(yaml_code, absolute_path) (private)

[ GitHub ]

# File 'lib/rubocop/config_loader.rb', line 239


def check_duplication(yaml_code, absolute_path)
  smart_path = PathUtil.smart_path(absolute_path)
  YAMLDuplicationChecker.check(yaml_code, absolute_path) do |key1, key2|
    value = key1.value
    # .start_line is only available since ruby 2.5 / psych 3.0
    message = if key1.respond_to? :start_line
                line1 = key1.start_line + 1
                line2 = key2.start_line + 1
                "#{smart_path}:#{line1}: " \
                  "`#{value}` is concealed by line #{line2}"
              else
                "#{smart_path}: `#{value}` is concealed by duplicate"
              end
    warn Rainbow(message).yellow
  end
end

.clear_options

[ GitHub ]

# File 'lib/rubocop/config_loader.rb', line 39


def clear_options
  @debug = nil
  @loaded_plugins = Set.new
  @loaded_features = Set.new
  @disable_pending_cops = nil
  @enable_pending_cops = nil
  @preview = nil
  @enabled_by_default = nil
  @disabled_by_default = nil
  @ignore_parent_exclusion = nil
  @ignore_unrecognized_cops = nil
  @cache_root = nil
  FileFinder.root_level = nil
end

.configuration_file_for(target_dir)

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.

[ GitHub ]

# File 'lib/rubocop/config_loader.rb', line 122


def configuration_file_for(target_dir)
  ConfigFinder.find_config_path(target_dir)
end

.configuration_from_file(config_file, check: true)

[ GitHub ]

# File 'lib/rubocop/config_loader.rb', line 126


def configuration_from_file(config_file, check: true)
  return apply_default_overrides(default_configuration) if config_file == DEFAULT_FILE

  config = load_file(config_file, check: check)
  config.validate_after_resolution if check

  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

.debug (rw) Also known as: .debug?

[ GitHub ]

# File 'lib/rubocop/config_loader.rb', line 26


attr_accessor :debug, :ignore_parent_exclusion, :disable_pending_cops, :enable_pending_cops,
              :enabled_by_default, :disabled_by_default, :ignore_unrecognized_cops,
              :preview

.file_path(file) (private)

[ GitHub ]

# File 'lib/rubocop/config_loader.rb', line 231


def file_path(file)
  File.absolute_path(file.is_a?(RemoteConfig) ? file.file : file)
end

.ignore_parent_exclusion (rw) Also known as: .ignore_parent_exclusion?

[ GitHub ]

# File 'lib/rubocop/config_loader.rb', line 26


attr_accessor :debug, :ignore_parent_exclusion, :disable_pending_cops, :enable_pending_cops,
              :enabled_by_default, :disabled_by_default, :ignore_unrecognized_cops,
              :preview

.inject_defaults!(config_yml_path)

This API is primarily intended for testing and documenting plugins. When testing a plugin using rubocop/rspec/support, the plugin is loaded automatically, so this API is usually not needed. It is intended to be used only when implementing tests that do not use rubocop/rspec/support.

[ GitHub ]

# File 'lib/rubocop/config_loader.rb', line 162


def inject_defaults!(config_yml_path)
  if Pathname(config_yml_path).directory?
    warn Rainbow(<<~MESSAGE).yellow, uplevel: 1
      Use config YAML file path instead of project root directory.
      e.g., `path/to/config/default.yml`
    MESSAGE
    raise ArgumentError,
          'Passing a project root directory to `inject_defaults!` is no longer supported.'
  end

  path = config_yml_path.to_s
  hash = ConfigLoader.load_yaml_configuration(path)
  config = Config.new(hash, path).tap(&:make_excludes_absolute)

  @default_configuration = ConfigLoader.merge_with_default(config, path)
end

.load_file(file, check: true)

rubocop:disable-next Metrics/AbcSize

[ GitHub ]

# File 'lib/rubocop/config_loader.rb', line 55


def load_file(file, check: true)
  path = file_path(file)

  hash = load_yaml_configuration(path)

  rubocop_config = Config.create(hash, path, check: false)
  plugins = hash.delete('plugins')
  loaded_plugins = resolver.resolve_plugins(rubocop_config, plugins)
  add_loaded_plugins(loaded_plugins)

  loaded_features = resolver.resolve_requires(path, hash)
  add_loaded_features(loaded_features)

  resolver.resolve_inheritance_from_gems(hash)
  resolver.resolve_inheritance(path, hash, file, debug?)
  hash.delete('inherit_from')

  # Adding missing namespaces only after resolving requires & inheritance,
  # since both can introduce new cops that need to be considered here.
  add_missing_namespaces(path, hash)

  Config.create(hash, path, check: check)
end

.load_yaml_configuration(absolute_path)

[ GitHub ]

# File 'lib/rubocop/config_loader.rb', line 79


def load_yaml_configuration(absolute_path)
  file_contents = read_file(absolute_path)
  yaml_code = Dir.chdir(File.dirname(absolute_path)) { ERB.new(file_contents).result }
  yaml_tree = check_duplication(yaml_code, absolute_path)
  hash = yaml_tree_to_hash(yaml_tree) || {}

  puts "configuration from #{absolute_path}" if debug?

  unless hash.is_a?(Hash)
    raise(ValidationError, "Malformed configuration in #{absolute_path}")
  end

  hash
end

.merge(base_hash, derived_hash)

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.

[ GitHub ]

# File 'lib/rubocop/config_loader.rb', line 113


def merge(base_hash, derived_hash)
  resolver.merge(base_hash, derived_hash)
end

.merge_with_default(config, config_file, unset_nil: true)

Merges the given configuration with the default one.

[ GitHub ]

# File 'lib/rubocop/config_loader.rb', line 192


def merge_with_default(config, config_file, unset_nil: true)
  resolver.merge_with_default(config, config_file, unset_nil: unset_nil)
end

.project_root

Deprecated.

Use ConfigFinder.project_root instead.

Returns the path RuboCop inferred as the root of the project. No file searches will go past this directory.

[ GitHub ]

# File 'lib/rubocop/config_loader.rb', line 182


def project_root
  warn Rainbow(<<~WARNING).yellow, uplevel: 1
    `RuboCop::ConfigLoader.project_root` is deprecated and will be removed in RuboCop 2.0. \
    Use `RuboCop::ConfigFinder.project_root` instead.
  WARNING

  ConfigFinder.project_root
end

.read_file(absolute_path) (private)

Read the specified file, or exit with a friendly, concise message on stderr. Care is taken to use the standard OS exit code for a "file not found" error.

[ GitHub ]

# File 'lib/rubocop/config_loader.rb', line 259


def read_file(absolute_path)
  File.read(absolute_path, encoding: Encoding::UTF_8)
rescue Errno::ENOENT
  raise ConfigNotFoundError, "Configuration file not found: #{absolute_path}"
end

.resolver (private)

[ GitHub ]

# File 'lib/rubocop/config_loader.rb', line 235


def resolver
  @resolver ||= ConfigLoaderResolver.new
end

.yaml_tree_to_hash(yaml_tree) (private)

[ GitHub ]

# File 'lib/rubocop/config_loader.rb', line 265


def yaml_tree_to_hash(yaml_tree)
  yaml_tree_to_hash!(yaml_tree)
rescue ::StandardError
  if defined?(::SafeYAML)
    raise 'SafeYAML is unmaintained, no longer needed and should be removed'
  end

  raise
end

.yaml_tree_to_hash!(yaml_tree) (private)

[ GitHub ]

# File 'lib/rubocop/config_loader.rb', line 275


def yaml_tree_to_hash!(yaml_tree)
  return nil unless yaml_tree

  # Optimization: Because we checked for duplicate keys, we already have the
  # yaml tree and don't need to parse it again.
  # Also see https://github.com/ruby/psych/blob/v5.1.2/lib/psych.rb#L322-L336
  class_loader = YAML::ClassLoader::Restricted.new(%w[Regexp Symbol], [])
  scanner = YAML::ScalarScanner.new(class_loader)
  visitor = YAML::Visitors::ToRuby.new(scanner, class_loader)
  visitor.accept(yaml_tree)
end

Class: RuboCop::ConfigLoader

Overview

Constant Summary

Class Attribute Summary

Class Method Summary

FileFinder - Extended

Class Attribute Details

.cache_root(cache_root_override = nil) (rw)

.cache_root=(value) (rw)

.debug? (rw)

.default_configuration (rw)

.default_configuration=(value) (rw)

.disable_pending_cops (rw)

.disabled_by_default (rw)

.enable_pending_cops (rw)

.enabled_by_default (rw)

.ignore_parent_exclusion? (rw)

.ignore_unrecognized_cops (rw)

.loaded_features (readonly)

.loaded_plugins (readonly)

.preview (rw)

Class Method Details

.add_excludes_from_files(config, config_file)

.add_loaded_features(loaded_features)

.add_loaded_plugins(loaded_plugins)

.add_missing_namespaces(path, hash)

.apply_default_overrides(config)

.check_duplication(yaml_code, absolute_path) (private)

.clear_options

.configuration_file_for(target_dir)

.configuration_from_file(config_file, check: true)

.debug (rw) Also known as: .debug?

.file_path(file) (private)

.ignore_parent_exclusion (rw) Also known as: .ignore_parent_exclusion?

.inject_defaults!(config_yml_path)

.load_file(file, check: true)

.load_yaml_configuration(absolute_path)

.merge(base_hash, derived_hash)

.merge_with_default(config, config_file, unset_nil: true)

.project_root

.read_file(absolute_path) (private)

.resolver (private)

.yaml_tree_to_hash(yaml_tree) (private)

.yaml_tree_to_hash!(yaml_tree) (private)

`FileFinder` - Extended