Class: RuboCop::Config

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Includes:
FileFinder, 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: CopConfig

Constant Summary collapse

DEFAULT_RAILS_VERSION = 
5.0

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from FileFinder

#find_file_upwards, #find_files_upwards, root_level=, root_level?

Methods included from PathUtil

absolute?, chdir, hidden_dir?, hidden_file_in_not_hidden_dir?, match_path?, pwd, relative_path, reset_pwd, smart_path

Constructor Details

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

Returns a new instance of Config.



24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/rubocop/config.rb', line 24

def initialize(hash = {}, loaded_path = nil)
  @loaded_path = loaded_path
  @for_cop = Hash.new do |h, cop|
    qualified_cop_name = Cop::Cop.qualified_cop_name(cop, loaded_path)
    cop_options = self[qualified_cop_name] || {}
    cop_options['Enabled'] = enable_cop?(qualified_cop_name, cop_options)
    h[cop] = cop_options
  end
  @hash = hash
  @validator = ConfigValidator.new(self)
end

Instance Attribute Details

#loaded_path ⇒ Object (readonly)

Returns the value of attribute loaded_path.



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

def loaded_path
  @loaded_path
end

Class Method Details

.create(hash, path) ⇒ Object 



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

def self.create(hash, path)
  new(hash, path).check
end

Instance Method Details

#add_excludes_from_higher_level(highest_config) ⇒ Object 



84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/rubocop/config.rb', line 84

def add_excludes_from_higher_level(highest_config)
  return unless highest_config.for_all_cops['Exclude']

  excludes = for_all_cops['Exclude'] ||= []
  highest_config.for_all_cops['Exclude'].each do |path|
    unless path.is_a?(Regexp) || absolute?(path)
      path = File.join(File.dirname(highest_config.loaded_path), path)
    end
    excludes << path unless excludes.include?(path)
  end
end

#allowed_camel_case_file?(file) ⇒ Boolean

Returns:

  • (Boolean) 


148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/rubocop/config.rb', line 148

def allowed_camel_case_file?(file)
  # Gemspecs are allowed to have dashes because that fits with bundler best
  # practices in the case when the gem is nested under a namespace (e.g.,
  # `bundler-console` conveys `Bundler::Console`).
  return true if File.extname(file) == '.gemspec'

  file_to_include?(file) do |pattern, relative_path, absolute_path|
    pattern.to_s =~ /[A-Z]/ &&
      (match_path?(pattern, relative_path) ||
       match_path?(pattern, absolute_path))
  end
end

#base_dir_for_path_parameters ⇒ Object

Paths specified in configuration files starting with .rubocop 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.



195
196
197
198
199
200
201
202
203
 
# File 'lib/rubocop/config.rb', line 195

def base_dir_for_path_parameters
  @base_dir_for_path_parameters ||=
    if File.basename(loaded_path).start_with?('.rubocop') &&
       loaded_path != File.join(Dir.home, ConfigLoader::DOTFILE)
      File.expand_path(File.dirname(loaded_path))
    else
      Dir.pwd
    end
end

#bundler_lock_file_path ⇒ Object 



220
221
222
223
224
225
226
227
228
229
 
# File 'lib/rubocop/config.rb', line 220

def bundler_lock_file_path
  return nil unless loaded_path

  base_path = base_dir_for_path_parameters
  ['gems.locked', 'Gemfile.lock'].each do |file_name|
    path = find_file_upwards(file_name, base_path)
    return path if path
  end
  nil
end

#check ⇒ Object 



40
41
42
43
44
45
46
47
 
# File 'lib/rubocop/config.rb', line 40

def check
  deprecation_check do |deprecation_message|
    warn("#{loaded_path} - #{deprecation_message}")
  end
  @validator.validate
  make_excludes_absolute
  self
end

#deprecation_check ⇒ Object 



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

def deprecation_check
  %w[Exclude Include].each do |key|
    plural = "#{key}s"
    next unless for_all_cops[plural]

    for_all_cops[key] = for_all_cops[plural] # Stay backwards compatible.
    for_all_cops.delete(plural)
    yield "AllCops/#{plural} was renamed to AllCops/#{key}"
  end
end

#disabled_new_cops? ⇒ Boolean

Returns:

  • (Boolean) 


119
120
121
 
# File 'lib/rubocop/config.rb', line 119

def disabled_new_cops?
  for_all_cops['NewCops'] == 'disable'
end

#enabled_new_cops? ⇒ Boolean

Returns:

  • (Boolean) 


123
124
125
 
# File 'lib/rubocop/config.rb', line 123

def enabled_new_cops?
  for_all_cops['NewCops'] == 'enable'
end

#file_to_exclude?(file) ⇒ Boolean

Returns:

  • (Boolean) 


171
172
173
174
175
176
 
# File 'lib/rubocop/config.rb', line 171

def file_to_exclude?(file)
  file = File.expand_path(file)
  patterns_to_exclude.any? do |pattern|
    match_path?(pattern, file)
  end
end

#file_to_include?(file) ⇒ Boolean

Returns:

  • (Boolean) 


127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/rubocop/config.rb', line 127

def file_to_include?(file)
  relative_file_path = path_relative_to_config(file)

  # Optimization to quickly decide if the given file is hidden (on the top
  # level) and cannot be matched by any pattern.
  is_hidden = relative_file_path.start_with?('.') &&
              !relative_file_path.start_with?('..')
  return false if is_hidden && !possibly_include_hidden?

  absolute_file_path = File.expand_path(file)

  patterns_to_include.any? do |pattern|
    if block_given?
      yield pattern, relative_file_path, absolute_file_path
    else
      match_path?(pattern, relative_file_path) ||
        match_path?(pattern, absolute_file_path)
    end
  end
end

#for_all_cops ⇒ Object 



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

def for_all_cops
  @for_all_cops ||= self['AllCops'] || {}
end

#for_cop(cop) ⇒ Object 



107
108
109
 
# File 'lib/rubocop/config.rb', line 107

def for_cop(cop)
  @for_cop[cop.respond_to?(:cop_name) ? cop.cop_name : cop]
end

#for_department(department_name) ⇒ Object 



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

def for_department(department_name)
  @for_cop[department_name]
end

#internal? ⇒ Boolean

True if this is a config file that is shipped with RuboCop

Returns:

  • (Boolean) 


62
63
64
65
66
 
# File 'lib/rubocop/config.rb', line 62

def internal?
  base_config_path = File.expand_path(File.join(ConfigLoader::RUBOCOP_HOME,
                                                'config'))
  File.expand_path(loaded_path).start_with?(base_config_path)
end

#make_excludes_absolute ⇒ Object 



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

def make_excludes_absolute
  each_key do |key|
    @validator.validate_section_presence(key)
    next unless self[key]['Exclude']

    self[key]['Exclude'].map! do |exclude_elem|
      if exclude_elem.is_a?(String) && !absolute?(exclude_elem)
        File.expand_path(File.join(base_dir_for_path_parameters,
                                   exclude_elem))
      else
        exclude_elem
      end
    end
  end
end

#path_relative_to_config(path) ⇒ Object 



186
187
188
 
# File 'lib/rubocop/config.rb', line 186

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

#patterns_to_exclude ⇒ Object 



182
183
184
 
# File 'lib/rubocop/config.rb', line 182

def patterns_to_exclude
  for_all_cops['Exclude'] || []
end

#patterns_to_include ⇒ Object 



178
179
180
 
# File 'lib/rubocop/config.rb', line 178

def patterns_to_include
  for_all_cops['Include'] || []
end

#pending_cops ⇒ Object 



231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/rubocop/config.rb', line 231

def pending_cops
  keys.each_with_object([]) do |qualified_cop_name, pending_cops|
    department = department_of(qualified_cop_name)
    next if department && department['Enabled'] == false

    cop_metadata = self[qualified_cop_name]
    next unless cop_metadata['Enabled'] == 'pending'

    pending_cops << CopConfig.new(qualified_cop_name, cop_metadata)
  end
end

#possibly_include_hidden? ⇒ Boolean

Returns true if there’s a chance that an Include pattern matches hidden files, false if that’s definitely not possible.

Returns:

  • (Boolean) 


163
164
165
166
167
168
169
 
# File 'lib/rubocop/config.rb', line 163

def possibly_include_hidden?
  return @possibly_include_hidden if defined?(@possibly_include_hidden)

  @possibly_include_hidden = patterns_to_include.any? do |s|
    s.is_a?(Regexp) || s.start_with?('.') || s.include?('/.')
  end
end

#signature ⇒ Object 



57
58
59
 
# File 'lib/rubocop/config.rb', line 57

def signature
  @signature ||= Digest::SHA1.hexdigest(to_s)
end

#smart_loaded_path ⇒ Object 



216
217
218
 
# File 'lib/rubocop/config.rb', line 216

def smart_loaded_path
  PathUtil.smart_path(@loaded_path)
end

#target_rails_version ⇒ Object 



205
206
207
208
209
210
211
212
213
214
 
# File 'lib/rubocop/config.rb', line 205

def target_rails_version
  @target_rails_version ||=
    if for_all_cops['TargetRailsVersion']
      for_all_cops['TargetRailsVersion'].to_f
    elsif target_rails_version_from_bundler_lock_file
      target_rails_version_from_bundler_lock_file
    else
      DEFAULT_RAILS_VERSION
    end
end

#to_s ⇒ Object 



53
54
55
 
# File 'lib/rubocop/config.rb', line 53

def to_s
  @to_s ||= @hash.to_s
end