Class: RuboCop::Config
- Inherits:
-
Object
- Object
- RuboCop::Config
- Includes:
- PathUtil
- Defined in:
- lib/rubocop/config.rb
Overview
rubocop:disable Metrics/ClassLength
Constant Summary collapse
- COMMON_PARAMS =
%w[Exclude Include Severity AutoCorrect StyleGuide Details].freeze
- DEFAULT_RUBY_VERSION =
2.1 is the oldest officially supported Ruby version.
2.1
- KNOWN_RUBIES =
[2.1, 2.2, 2.3, 2.4, 2.5].freeze
- OBSOLETE_RUBIES =
{ 1.9 => '0.50', 2.0 => '0.50' }.freeze
- DEFAULT_RAILS_VERSION =
5.0
- OBSOLETE_COPS =
{ 'Style/TrailingComma' => 'The `Style/TrailingComma` cop no longer exists. Please use ' \ '`Style/TrailingCommaInLiteral` and/or ' \ '`Style/TrailingCommaInArguments` instead.', 'Rails/DefaultScope' => 'The `Rails/DefaultScope` cop no longer exists.', 'Lint/InvalidCharacterLiteral' => 'The `Lint/InvalidCharacterLiteral` cop has been removed since it ' \ 'was never being actually triggered.', 'Style/SingleSpaceBeforeFirstArg' => 'The `Style/SingleSpaceBeforeFirstArg` cop has been renamed to ' \ '`Layout/SpaceBeforeFirstArg`.', 'Lint/RescueWithoutErrorClass' => 'The `Lint/RescueWithoutErrorClass` cop has been replaced by ' \ '`Style/RescueStandardError`.', 'Lint/SpaceBeforeFirstArg' => 'The `Lint/SpaceBeforeFirstArg` cop has been removed, since it was a ' \ 'duplicate of `Layout/SpaceBeforeFirstArg`. Please use ' \ '`Layout/SpaceBeforeFirstArg` instead.', 'Layout/SpaceAfterControlKeyword' => 'The `Layout/SpaceAfterControlKeyword` cop has been removed. Please ' \ 'use `Layout/SpaceAroundKeyword` instead.', 'Layout/SpaceBeforeModifierKeyword' => 'The `Layout/SpaceBeforeModifierKeyword` cop has been removed. ' \ 'Please use `Layout/SpaceAroundKeyword` instead.', 'Style/SpaceAfterControlKeyword' => 'The `Style/SpaceAfterControlKeyword` cop has been removed. Please ' \ 'use `Layout/SpaceAroundKeyword` instead.', 'Style/SpaceBeforeModifierKeyword' => 'The `Style/SpaceBeforeModifierKeyword` cop has been removed. Please ' \ 'use `Layout/SpaceAroundKeyword` instead.', 'Style/MethodCallParentheses' => 'The `Style/MethodCallParentheses` cop has been renamed to ' \ '`Style/MethodCallWithoutArgsParentheses`.', 'Lint/Eval' => 'The `Lint/Eval` cop has been renamed to `Security/Eval`.', 'Style/DeprecatedHashMethods' => 'The `Style/DeprecatedHashMethods` cop has been renamed to ' \ '`Style/PreferredHashMethods`.', 'Style/AccessorMethodName' => 'The `Style/AccessorMethodName` cop has been moved to ' \ '`Naming/AccessorMethodName`.', 'Style/AsciiIdentifiers' => 'The `Style/AsciiIdentifiers` cop has been moved to ' \ '`Naming/AccessorMethodName`.', 'Style/OpMethod' => 'The `Style/OpMethod` cop has been renamed and moved to ' \ '`Naming/BinaryOperatorParameterName`.', 'Style/ClassAndModuleCamelCase' => 'The `Style/ClassAndModuleCamelCase` cop has been renamed to ' \ '`Naming/ClassAndModuleCamelCase`.', 'Style/ConstantName' => 'The `Style/ConstantName` cop has been renamed to ' \ '`Naming/ConstantName`.', 'Style/FileName' => 'The `Style/FileName` cop has been renamed to `Naming/FileName`.', 'Style/MethodName' => 'The `Style/MethodName` cop has been renamed to ' \ '`Naming/MethodName`.', 'Style/PredicateName' => 'The `Style/PredicateName` cop has been renamed to ' \ '`Naming/PredicateName`.', 'Style/VariableName' => 'The `Style/VariableName` cop has been renamed to ' \ '`Naming/VariableName`.', 'Style/VariableNumber' => 'The `Style/VariableNumber` cop has been renamed to ' \ '`Naming/VariableNumber`.' }.freeze
- OBSOLETE_PARAMETERS =
[ { cop: 'Layout/SpaceAroundOperators', parameter: 'MultiSpaceAllowedForOperators', alternative: 'If your intention was to allow extra spaces ' \ 'for alignment, please use AllowForAlignment: ' \ 'true instead.' }, { cop: 'Style/Encoding', parameter: 'EnforcedStyle', alternative: 'Style/Encoding no longer supports styles. ' \ 'The "never" behavior is always assumed.' }, { cop: 'Style/Encoding', parameter: 'SupportedStyles', alternative: 'Style/Encoding no longer supports styles. ' \ 'The "never" behavior is always assumed.' }, { cop: 'Style/Encoding', parameter: 'AutoCorrectEncodingComment', alternative: 'Style/Encoding no longer supports styles. ' \ 'The "never" behavior is always assumed.' }, { cop: 'Style/IfUnlessModifier', parameter: 'MaxLineLength', alternative: '`Style/IfUnlessModifier: MaxLineLength` has been removed. Use ' \ '`Metrics/LineLength: Max` instead' }, { cop: 'Style/SpaceAroundOperators', parameter: 'MultiSpaceAllowedForOperators', alternative: 'If your intention was to allow extra spaces ' \ 'for alignment, please use AllowForAlignment: ' \ 'true instead.' }, { cop: 'Style/WhileUntilModifier', parameter: 'MaxLineLength', alternative: '`Style/WhileUntilModifier: MaxLineLength` has been removed. Use ' \ '`Metrics/LineLength: Max` instead' }, { cop: 'AllCops', parameter: 'RunRailsCops', alternative: "Use the following configuration instead:\n" \ "Rails:\n Enabled: true" }, { cop: 'Layout/CaseIndentation', parameter: 'IndentWhenRelativeTo', alternative: '`IndentWhenRelativeTo` has been renamed to ' \ '`EnforcedStyle`' }, { cop: 'Lint/BlockAlignment', parameter: 'AlignWith', alternative: '`AlignWith` has been renamed to ' \ '`EnforcedStyleAlignWith`' }, { cop: 'Lint/EndAlignment', parameter: 'AlignWith', alternative: '`AlignWith` has been renamed to ' \ '`EnforcedStyleAlignWith`' }, { cop: 'Lint/DefEndAlignment', parameter: 'AlignWith', alternative: '`AlignWith` has been renamed to ' \ '`EnforcedStyleAlignWith`' }, { cop: 'Rails/UniqBeforePluck', parameter: 'EnforcedMode', alternative: '`EnforcedMode` has been renamed to ' \ '`EnforcedStyle`' } ].freeze
Instance Attribute Summary collapse
-
#loaded_path ⇒ Object
readonly
Returns the value of attribute loaded_path.
Class Method Summary collapse
Instance Method Summary collapse
- #[](key) ⇒ Object
- #[]=(key, value) ⇒ Object
- #add_excludes_from_higher_level(highest_config) ⇒ Object
-
#base_dir_for_path_parameters ⇒ Object
Paths specified in configuration files starting with .rubocop are relative to the directory where that file is.
- #check ⇒ Object
- #delete(key) ⇒ Object
- #deprecation_check ⇒ Object
- #each(&block) ⇒ Object
- #each_key(&block) ⇒ Object
- #file_to_exclude?(file) ⇒ Boolean
- #file_to_include?(file) ⇒ Boolean
- #for_all_cops ⇒ Object
- #for_cop(cop) ⇒ Object
-
#initialize(hash = {}, loaded_path = nil) ⇒ Config
constructor
A new instance of Config.
- #key?(key) ⇒ Boolean
- #keys ⇒ Object
- #make_excludes_absolute ⇒ Object
- #map(&block) ⇒ Object
- #merge(other_hash) ⇒ Object
- #path_relative_to_config(path) ⇒ Object
- #patterns_to_exclude ⇒ Object
- #patterns_to_include ⇒ Object
-
#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.
- #target_rails_version ⇒ Object
- #target_ruby_version ⇒ Object
- #to_h ⇒ Object
- #to_hash ⇒ Object
- #to_s ⇒ Object
- #validate ⇒ Object
Methods included from PathUtil
absolute?, match_path?, pwd, relative_path, reset_pwd, smart_path
Constructor Details
#initialize(hash = {}, loaded_path = nil) ⇒ Config
Returns a new instance of Config.
181 182 183 184 185 186 187 188 189 190 |
# File 'lib/rubocop/config.rb', line 181 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) = self[qualified_cop_name] || {} ['Enabled'] = enable_cop?(qualified_cop_name, ) h[cop] = end @hash = hash end |
Instance Attribute Details
#loaded_path ⇒ Object (readonly)
Returns the value of attribute loaded_path.
179 180 181 |
# File 'lib/rubocop/config.rb', line 179 def loaded_path @loaded_path end |
Class Method Details
.create(hash, path) ⇒ Object
192 193 194 |
# File 'lib/rubocop/config.rb', line 192 def self.create(hash, path) new(hash, path).check end |
Instance Method Details
#[](key) ⇒ Object
205 206 207 |
# File 'lib/rubocop/config.rb', line 205 def [](key) @hash[key] end |
#[]=(key, value) ⇒ Object
209 210 211 |
# File 'lib/rubocop/config.rb', line 209 def []=(key, value) @hash[key] = value end |
#add_excludes_from_higher_level(highest_config) ⇒ Object
269 270 271 272 273 274 275 276 277 278 279 |
# File 'lib/rubocop/config.rb', line 269 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 |
#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.
370 371 372 373 374 375 376 377 378 |
# File 'lib/rubocop/config.rb', line 370 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.(File.dirname(loaded_path)) else Dir.pwd end end |
#check ⇒ Object
196 197 198 199 200 201 202 203 |
# File 'lib/rubocop/config.rb', line 196 def check deprecation_check do || warn("#{path} - #{}") end validate make_excludes_absolute self end |
#delete(key) ⇒ Object
213 214 215 |
# File 'lib/rubocop/config.rb', line 213 def delete(key) @hash.delete(key) end |
#deprecation_check ⇒ Object
281 282 283 284 285 286 287 288 289 290 |
# File 'lib/rubocop/config.rb', line 281 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 |
#each(&block) ⇒ Object
217 218 219 |
# File 'lib/rubocop/config.rb', line 217 def each(&block) @hash.each(&block) end |
#each_key(&block) ⇒ Object
229 230 231 |
# File 'lib/rubocop/config.rb', line 229 def each_key(&block) @hash.each_key(&block) end |
#file_to_exclude?(file) ⇒ Boolean
346 347 348 349 350 351 |
# File 'lib/rubocop/config.rb', line 346 def file_to_exclude?(file) file = File.(file) patterns_to_exclude.any? do |pattern| match_path?(pattern, file) end end |
#file_to_include?(file) ⇒ Boolean
319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 |
# File 'lib/rubocop/config.rb', line 319 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 can not 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.(file) patterns_to_include.any? do |pattern| match_path?(pattern, relative_file_path) || match_path?(pattern, absolute_file_path) end end |
#for_all_cops ⇒ Object
296 297 298 |
# File 'lib/rubocop/config.rb', line 296 def for_all_cops @for_all_cops ||= self['AllCops'] || {} end |
#for_cop(cop) ⇒ Object
292 293 294 |
# File 'lib/rubocop/config.rb', line 292 def for_cop(cop) @for_cop[cop.respond_to?(:cop_name) ? cop.cop_name : cop] end |
#key?(key) ⇒ Boolean
221 222 223 |
# File 'lib/rubocop/config.rb', line 221 def key?(key) @hash.key?(key) end |
#keys ⇒ Object
225 226 227 |
# File 'lib/rubocop/config.rb', line 225 def keys @hash.keys end |
#make_excludes_absolute ⇒ Object
253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 |
# File 'lib/rubocop/config.rb', line 253 def make_excludes_absolute each_key do |key| 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.(File.join(base_dir_for_path_parameters, exclude_elem)) else exclude_elem end end end end |
#map(&block) ⇒ Object
233 234 235 |
# File 'lib/rubocop/config.rb', line 233 def map(&block) @hash.map(&block) end |
#merge(other_hash) ⇒ Object
237 238 239 |
# File 'lib/rubocop/config.rb', line 237 def merge(other_hash) @hash.merge(other_hash) end |
#path_relative_to_config(path) ⇒ Object
361 362 363 |
# File 'lib/rubocop/config.rb', line 361 def path_relative_to_config(path) relative_path(path, base_dir_for_path_parameters) end |
#patterns_to_exclude ⇒ Object
357 358 359 |
# File 'lib/rubocop/config.rb', line 357 def patterns_to_exclude for_all_cops['Exclude'] end |
#patterns_to_include ⇒ Object
353 354 355 |
# File 'lib/rubocop/config.rb', line 353 def patterns_to_include for_all_cops['Include'] 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.
338 339 340 341 342 343 344 |
# File 'lib/rubocop/config.rb', line 338 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 |
#target_rails_version ⇒ Object
397 398 399 400 |
# File 'lib/rubocop/config.rb', line 397 def target_rails_version @target_rails_version ||= for_all_cops.fetch('TargetRailsVersion', DEFAULT_RAILS_VERSION) end |
#target_ruby_version ⇒ Object
380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 |
# File 'lib/rubocop/config.rb', line 380 def target_ruby_version @target_ruby_version ||= if for_all_cops['TargetRubyVersion'] @target_ruby_version_source = :rubocop_yml for_all_cops['TargetRubyVersion'] elsif File.file?('.ruby-version') && /\A(ruby-)?(?<version>\d+\.\d+)/ =~ File.read('.ruby-version') @target_ruby_version_source = :dot_ruby_version version.to_f else DEFAULT_RUBY_VERSION end end |
#to_h ⇒ Object
241 242 243 |
# File 'lib/rubocop/config.rb', line 241 def to_h @hash end |
#to_hash ⇒ Object
245 246 247 |
# File 'lib/rubocop/config.rb', line 245 def to_hash @hash end |
#to_s ⇒ Object
249 250 251 |
# File 'lib/rubocop/config.rb', line 249 def to_s @to_s ||= @hash.to_s end |
#validate ⇒ Object
300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 |
# File 'lib/rubocop/config.rb', line 300 def validate # Don't validate RuboCop's own files. Avoids infinite recursion. base_config_path = File.(File.join(ConfigLoader::RUBOCOP_HOME, 'config')) return if File.(loaded_path).start_with?(base_config_path) valid_cop_names, invalid_cop_names = keys.partition do |key| ConfigLoader.default_configuration.key?(key) end reject_obsolete_cops_and_parameters warn_about_unrecognized_cops(invalid_cop_names) check_target_ruby validate_parameter_names(valid_cop_names) validate_enforced_styles(valid_cop_names) validate_syntax_cop reject_mutually_exclusive_defaults end |