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_config ⇒ Object 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

.debug ⇒ Object 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 



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/rubocop/config_loader.rb', line 71

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.



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

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

.configuration_from_file(config_file) ⇒ Object 



96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/rubocop/config_loader.rb', line 96

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 ⇒ Object 



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

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
53
54
55
56
 
# File 'lib/rubocop/config_loader.rb', line 25

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

  # Psych can give an error when reading an empty file, so we use syck in
  # Ruby versions where it's available. Also, the problem with empty
  # files does not appear in Ruby 2 or in JRuby 1.9 mode.
  if RUBY_VERSION < '2.0.0' && RUBY_PLATFORM != 'java'
    original_yamler = YAML::ENGINE.yamler
    YAML::ENGINE.yamler = 'syck'
  end
  hash = YAML.load_file(path) || {}
  # Restore yamler for applications using RuboCop as a library.
  YAML::ENGINE.yamler = original_yamler if original_yamler

  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.



61
62
63
64
65
66
67
68
69
 
# File 'lib/rubocop/config_loader.rb', line 61

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 



115
116
117
 
# File 'lib/rubocop/config_loader.rb', line 115

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