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

.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


67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
# File 'lib/rubocop/config_loader.rb', line 67

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

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


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

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

.configuration_from_file(config_file) ⇒ Object


92
93
94
95
96
97
98
99
100
101
102
# File 'lib/rubocop/config_loader.rb', line 92

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_configurationObject


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

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

.load_file(path) ⇒ Object


25
26
27
28
29
30
31
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 25

def load_file(path)
  path = File.absolute_path(path)
  yaml_code = IO.read(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.load(yaml_code) : {}
  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

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


57
58
59
60
61
62
63
64
65
# File 'lib/rubocop/config_loader.rb', line 57

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


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

def merge_with_default(config, config_file)
  Config.new(merge(default_configuration, config), config_file)
end