Class: RuboCop::ConfigLoader

Inherits:
Object
  • Object
show all
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'
RUBOCOP_HOME =
File.realpath(File.join(File.dirname(__FILE__), '..', '..'))
DEFAULT_FILE =
File.join(RUBOCOP_HOME, 'config', 'default.yml')
AUTO_GENERATED_FILE =
'.rubocop_todo.yml'

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.auto_gen_configObject Also known as: auto_gen_config?

Returns the value of attribute auto_gen_config


19
20
21
# File 'lib/rubocop/config_loader.rb', line 19

def auto_gen_config
  @auto_gen_config
end

.debugObject Also known as: debug?

Returns the value of attribute debug


19
20
21
# File 'lib/rubocop/config_loader.rb', line 19

def debug
  @debug
end

.default_configurationObject


103
104
105
106
107
108
# File 'lib/rubocop/config_loader.rb', line 103

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

.exclude_limitObject

Returns the value of attribute exclude_limit


19
20
21
# File 'lib/rubocop/config_loader.rb', line 19

def exclude_limit
  @exclude_limit
end

.root_level=(value) ⇒ Object (writeonly)

The upwards search is stopped at this level.


20
21
22
# File 'lib/rubocop/config_loader.rb', line 20

def root_level=(value)
  @root_level = value
end

Class Method Details

.base_configs(path, inherit_from) ⇒ Object


61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
# File 'lib/rubocop/config_loader.rb', line 61

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

.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.


87
88
89
# File 'lib/rubocop/config_loader.rb', line 87

def configuration_file_for(target_dir)
  config_files_in_path(target_dir).first || DEFAULT_FILE
end

.configuration_from_file(config_file) ⇒ Object


91
92
93
94
95
96
97
98
99
100
101
# 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

.load_file(path) ⇒ Object


26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
# File 'lib/rubocop/config_loader.rb', line 26

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

.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.


51
52
53
54
55
56
57
58
59
# File 'lib/rubocop/config_loader.rb', line 51

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) ⇒ 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.


113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
# File 'lib/rubocop/config_loader.rb', line 113

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