Class: Rubocop::Config

Inherits:
Hash
  • Object
show all
Includes:
PathUtil
Defined in:
lib/rubocop/config.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.

Defined Under Namespace

Classes: ValidationError

Constant Summary collapse

COMMON_PARAMS = 
%w(Exclude Include Severity)

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from PathUtil

match_path?, relative_path

Constructor Details

#initialize(hash = {}, loaded_path = nil) ⇒ Config

Returns a new instance of Config.



21
22
23
24
25
 
# File 'lib/rubocop/config.rb', line 21

def initialize(hash = {}, loaded_path = nil)
  @hash = hash
  @loaded_path = loaded_path
  super(@hash)
end

Instance Attribute Details

#loaded_path ⇒ Object (readonly)

Returns the value of attribute loaded_path.



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

def loaded_path
  @loaded_path
end

Instance Method Details

#base_dir_for_path_parameters ⇒ Object

Paths specified in .rubocop.yml files are relative to the directory where that file is. Paths in other config files are relative to the current directory. This is so that paths in config/default.yml, for example, are not relative to RuboCop's config directory since that wouldn't work.



98
99
100
101
102
103
104
 
# File 'lib/rubocop/config.rb', line 98

def base_dir_for_path_parameters
  if File.basename(loaded_path) == ConfigLoader::DOTFILE
    File.dirname(loaded_path)
  else
    Dir.pwd
  end
end

#cop_enabled?(cop) ⇒ Boolean

Returns:

  • (Boolean) 


32
33
34
 
# File 'lib/rubocop/config.rb', line 32

def cop_enabled?(cop)
  for_cop(cop).nil? || for_cop(cop)['Enabled']
end

#file_to_exclude?(file) ⇒ Boolean

Returns:

  • (Boolean) 


77
78
79
80
 
# File 'lib/rubocop/config.rb', line 77

def file_to_exclude?(file)
  file = File.join(Dir.pwd, file) unless file.start_with?('/')
  patterns_to_exclude.any? { |pattern| match_path?(pattern, file) }
end

#file_to_include?(file) ⇒ Boolean

Returns:

  • (Boolean) 


70
71
72
73
74
75
 
# File 'lib/rubocop/config.rb', line 70

def file_to_include?(file)
  relative_file_path = path_relative_to_config(file)
  patterns_to_include.any? do |pattern|
    match_path?(pattern, relative_file_path)
  end
end

#for_cop(cop) ⇒ Object 



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

def for_cop(cop)
  cop = cop.cop_name if cop.respond_to?(:cop_name)
  self[cop]
end

#path_relative_to_config(path) ⇒ Object 



90
91
92
 
# File 'lib/rubocop/config.rb', line 90

def path_relative_to_config(path)
  relative_path(path, base_dir_for_path_parameters)
end

#patterns_to_exclude ⇒ Object 



86
87
88
 
# File 'lib/rubocop/config.rb', line 86

def patterns_to_exclude
  @hash['AllCops']['Exclude']
end

#patterns_to_include ⇒ Object 



82
83
84
 
# File 'lib/rubocop/config.rb', line 82

def patterns_to_include
  @hash['AllCops']['Include']
end

#validate ⇒ Object

TODO: This should be a private method



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/rubocop/config.rb', line 43

def validate
  # Don't validate RuboCop's own files. Avoids inifinite recursion.
  return if @loaded_path.start_with?(ConfigLoader::RUBOCOP_HOME)

  default_config = ConfigLoader.default_configuration

  valid_cop_names, invalid_cop_names = @hash.keys.partition do |key|
    default_config.key?(key)
  end

  invalid_cop_names.each do |name|
    fail ValidationError,
         "unrecognized cop #{name} found in #{loaded_path || self}"
  end

  valid_cop_names.each do |name|
    @hash[name].each_key do |param|
      unless COMMON_PARAMS.include?(param) ||
             default_config[name].key?(param)
        fail ValidationError,
             "unrecognized parameter #{name}:#{param} found " \
             "in #{loaded_path || self}"
      end
    end
  end
end

#warn_unless_valid ⇒ Object 



36
37
38
39
40
 
# File 'lib/rubocop/config.rb', line 36

def warn_unless_valid
  validate
rescue Config::ValidationError => e
  warn "Warning: #{e.message}".color(:red)
end