Class: RuboCop::ConfigLoader

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

Class Attribute Summary collapse

Class Method Summary collapse

Methods included from ConfigLoaderResolver

resolve_inheritance, resolve_inheritance_from_gems, resolve_requires

Class Attribute Details

.auto_gen_config ⇒ Object Also known as: auto_gen_config?

Returns the value of attribute auto_gen_config.



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

def auto_gen_config
  @auto_gen_config
end

.debug ⇒ Object Also known as: debug?

Returns the value of attribute debug.



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

def debug
  @debug
end

.default_configuration ⇒ Object 



116
117
118
119
120
121
 
# File 'lib/rubocop/config_loader.rb', line 116

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

.root_level=(value) ⇒ Object (writeonly)

The upwards search is stopped at this level.



22
23
24
 
# File 'lib/rubocop/config_loader.rb', line 22

def root_level=(value)
  @root_level = value
end

Class Method Details

.add_missing_namespaces(path, hash) ⇒ Object 



54
55
56
57
58
59
60
61
 
# File 'lib/rubocop/config_loader.rb', line 54

def add_missing_namespaces(path, hash)
  hash.keys.each do |k|
    q = Cop::Cop.qualified_cop_name(k, path)
    next if q == k

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

.base_configs(path, inherit_from) ⇒ Object 



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/rubocop/config_loader.rb', line 76

def base_configs(path, inherit_from)
  configs = Array(inherit_from).compact.map do |f|
    if f =~ /\A#{URI::Parser.new.make_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 ⇒ Object 



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

def clear_options
  @debug = @auto_gen_config = @root_level = nil
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.



100
101
102
 
# File 'lib/rubocop/config_loader.rb', line 100

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

.configuration_from_file(config_file) ⇒ Object 



104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/rubocop/config_loader.rb', line 104

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 



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/rubocop/config_loader.rb', line 32

def load_file(path)
  path = File.absolute_path(path)
  hash = load_yaml_configuration(path)

  add_missing_namespaces(path, hash)

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



66
67
68
69
70
71
72
73
74
 
# File 'lib/rubocop/config_loader.rb', line 66

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.



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/rubocop/config_loader.rb', line 126

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