Class: RuboCop::OptionsValidator

Inherits:
Object
  • Object
show all
Defined in:
lib/rubocop/options.rb

Overview

Validates option arguments and the options’ compatibility with each other.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ OptionsValidator

Returns a new instance of OptionsValidator.



239
240
241
 
# File 'lib/rubocop/options.rb', line 239

def initialize(options)
  @options = options
end

Class Method Details

.validate_cop_list(names) ⇒ Object

Cop name validation must be done later than option parsing, so it’s not called from within Options.



205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/rubocop/options.rb', line 205

def validate_cop_list(names)
  return unless names

  cop_names = Cop::Cop.registry.names
  departments = Cop::Cop.registry.departments.map(&:to_s)

  names.each do |name|
    next if cop_names.include?(name)
    next if departments.include?(name)
    next if %w[Syntax Lint/Syntax].include?(name)

    raise IncorrectCopNameError, format_message_from(name, cop_names)
  end
end

Instance Method Details

#boolean_or_empty_cache? ⇒ Boolean

Returns:

  • (Boolean) 


312
313
314
 
# File 'lib/rubocop/options.rb', line 312

def boolean_or_empty_cache?
  !@options.key?(:cache) || %w[true false].include?(@options[:cache])
end

#except_syntax? ⇒ Boolean

Returns:

  • (Boolean) 


307
308
309
310
 
# File 'lib/rubocop/options.rb', line 307

def except_syntax?
  @options.key?(:except) &&
    (@options[:except] & %w[Lint/Syntax Syntax]).any?
end

#incompatible_options ⇒ Object 



316
317
318
 
# File 'lib/rubocop/options.rb', line 316

def incompatible_options
  @incompatible_options ||= @options.keys & Options::EXITING_OPTIONS
end

#only_includes_unneeded_disable? ⇒ Boolean

Returns:

  • (Boolean) 


301
302
303
304
305
 
# File 'lib/rubocop/options.rb', line 301

def only_includes_unneeded_disable?
  @options.key?(:only) &&
    (@options[:only] & %w[Lint/UnneededCopDisableDirective
                          UnneededCopDisableDirective]).any?
end

#validate_auto_gen_config ⇒ Object 



262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/rubocop/options.rb', line 262

def validate_auto_gen_config
  return if @options.key?(:auto_gen_config)

  message = '--%<flag>s can only be used together with --auto-gen-config.'

  %i[exclude_limit no_offense_counts no_auto_gen_timestamp].each do |option|
    if @options.key?(option)
      raise OptionArgumentError,
            format(message, flag: option.to_s.tr('_', '-'))
    end
  end
end

#validate_compatibility ⇒ Object

rubocop:disable Metrics/MethodLength

Raises:



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/rubocop/options.rb', line 243

def validate_compatibility # rubocop:disable Metrics/MethodLength
  if only_includes_unneeded_disable?
    raise OptionArgumentError, 'Lint/UnneededCopDisableDirective can not ' \
                               'be used with --only.'
  end
  if except_syntax?
    raise OptionArgumentError, 'Syntax checking can not be turned off.'
  end
  unless boolean_or_empty_cache?
    raise OptionArgumentError, '-C/--cache argument must be true or false'
  end
  validate_auto_gen_config
  validate_parallel

  return if incompatible_options.size <= 1
  raise OptionArgumentError, 'Incompatible cli options: ' \
                             "#{incompatible_options.inspect}"
end

#validate_exclude_limit_option ⇒ Object

Raises:

  • (OptionParser::MissingArgument) 


320
321
322
323
324
325
 
# File 'lib/rubocop/options.rb', line 320

def validate_exclude_limit_option
  return if @options[:exclude_limit] =~ /^\d+$/
  # Emulate OptionParser's behavior to make failures consistent regardless
  # of option order.
  raise OptionParser::MissingArgument
end

#validate_parallel ⇒ Object 



275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/rubocop/options.rb', line 275

def validate_parallel
  return unless @options.key?(:parallel)

  if @options[:cache] == 'false'
    raise OptionArgumentError, '-P/--parallel uses caching to speed up ' \
                               'execution, so combining with --cache ' \
                               'false is not allowed.'
  end

  validate_parallel_with_combo_option
end

#validate_parallel_with_combo_option ⇒ Object 



287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/rubocop/options.rb', line 287

def validate_parallel_with_combo_option
  combos = {
    auto_gen_config: '-P/--parallel uses caching to speed up execution, ' \
                     'while --auto-gen-config needs a non-cached run, ' \
                     'so they cannot be combined.',
    fail_fast: '-P/--parallel can not be combined with -F/--fail-fast.',
    auto_correct: '-P/--parallel can not be combined with --auto-correct.'
  }

  combos.each do |key, msg|
    raise OptionArgumentError, msg if @options.key?(key)
  end
end