Class: RuboCop::OptionsValidator Private
- Inherits:
-
Object
- Object
- RuboCop::OptionsValidator
- Defined in:
- lib/rubocop/options.rb
Overview
This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.
Validates option arguments and the options' compatibility with each other.
Class Method Summary collapse
-
.validate_cop_list(names) ⇒ Object
private
Cop name validation must be done later than option parsing, so it’s not called from within Options.
Instance Method Summary collapse
- #boolean_or_empty_cache? ⇒ Boolean private
- #disable_parallel_when_invalid_option_combo ⇒ Object private
- #display_only_fail_level_offenses_with_autocorrect? ⇒ Boolean private
- #except_syntax? ⇒ Boolean private
- #incompatible_options ⇒ Object private
-
#initialize(options) ⇒ OptionsValidator
constructor
private
A new instance of OptionsValidator.
- #invalid_arguments_for_parallel ⇒ Object private
- #only_includes_redundant_disable? ⇒ Boolean private
-
#validate_auto_gen_config ⇒ Object
private
rubocop:enable Metrics/AbcSize.
- #validate_autocorrect ⇒ Object private
- #validate_cache_enabled_for_cache_root ⇒ Object private
-
#validate_compatibility ⇒ Object
private
rubocop:disable Metrics/AbcSize.
- #validate_cop_options ⇒ Object private
- #validate_display_only_correctable_and_autocorrect ⇒ Object private
- #validate_display_only_failed ⇒ Object private
- #validate_display_only_failed_and_display_only_correctable ⇒ Object private
- #validate_exclude_limit_option ⇒ Object private
Constructor Details
#initialize(options) ⇒ OptionsValidator
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Returns a new instance of OptionsValidator.
349 350 351 |
# File 'lib/rubocop/options.rb', line 349 def initialize() @options = end |
Class Method Details
.validate_cop_list(names) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
Cop name validation must be done later than option parsing, so it’s not called from within Options.
318 319 320 321 322 323 324 325 326 327 328 329 330 331 |
# File 'lib/rubocop/options.rb', line 318 def validate_cop_list(names) return unless names cop_names = Cop::Registry.global.names departments = Cop::Registry.global.departments.map(&:to_s) names.each do |name| next if cop_names.include?(name) next if departments.include?(name) next if SYNTAX_DEPARTMENTS.include?(name) raise IncorrectCopNameError, (name, cop_names) end end |
Instance Method Details
#boolean_or_empty_cache? ⇒ Boolean
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
471 472 473 |
# File 'lib/rubocop/options.rb', line 471 def boolean_or_empty_cache? !@options.key?(:cache) || %w[true false].include?(@options[:cache]) end |
#disable_parallel_when_invalid_option_combo ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
437 438 439 440 441 442 443 444 445 446 447 448 |
# File 'lib/rubocop/options.rb', line 437 def disable_parallel_when_invalid_option_combo return unless @options.key?(:parallel) invalid_flags = invalid_arguments_for_parallel return if invalid_flags.empty? @options.delete(:parallel) puts '-P/--parallel is being ignored because ' \ "it is not compatible with #{invalid_flags.join(', ')}." end |
#display_only_fail_level_offenses_with_autocorrect? ⇒ Boolean
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
463 464 465 |
# File 'lib/rubocop/options.rb', line 463 def display_only_fail_level_offenses_with_autocorrect? @options.key?(:display_only_fail_level_offenses) && @options.key?(:autocorrect) end |
#except_syntax? ⇒ Boolean
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
467 468 469 |
# File 'lib/rubocop/options.rb', line 467 def except_syntax? @options.key?(:except) && (@options[:except] & %w[Lint/Syntax Syntax]).any? end |
#incompatible_options ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
475 476 477 |
# File 'lib/rubocop/options.rb', line 475 def @incompatible_options ||= @options.keys & Options::EXITING_OPTIONS end |
#invalid_arguments_for_parallel ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
450 451 452 453 454 455 456 |
# File 'lib/rubocop/options.rb', line 450 def invalid_arguments_for_parallel [('--auto-gen-config' if @options.key?(:auto_gen_config)), ('-F/--fail-fast' if @options.key?(:fail_fast)), ('--profile' if @options[:profile]), ('--memory' if @options[:memory]), ('--cache false' if @options > { cache: 'false' })].compact end |
#only_includes_redundant_disable? ⇒ Boolean
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
458 459 460 461 |
# File 'lib/rubocop/options.rb', line 458 def only_includes_redundant_disable? @options.key?(:only) && (@options[:only] & %w[Lint/RedundantCopDisableDirective RedundantCopDisableDirective]).any? end |
#validate_auto_gen_config ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
rubocop:enable Metrics/AbcSize
384 385 386 387 388 389 390 391 392 393 394 395 |
# File 'lib/rubocop/options.rb', line 384 def validate_auto_gen_config return if @options.key?(:auto_gen_config) = '--%<flag>s can only be used together with --auto-gen-config.' %i[exclude_limit offense_counts auto_gen_timestamp auto_gen_only_exclude].each do |option| if @options.key?(option) raise OptionArgumentError, format(, flag: option.to_s.tr('_', '-')) end end end |
#validate_autocorrect ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
423 424 425 426 427 428 429 430 431 432 433 434 435 |
# File 'lib/rubocop/options.rb', line 423 def validate_autocorrect if @options.key?(:safe_autocorrect) && @options.key?(:autocorrect_all) = Rainbow(<<~MESSAGE).red Error: Both safe and unsafe autocorrect options are specified, use only one. MESSAGE raise OptionArgumentError, end return if @options.key?(:autocorrect) return unless @options.key?(:disable_uncorrectable) raise OptionArgumentError, format('--disable-uncorrectable can only be used together with --autocorrect.') end |
#validate_cache_enabled_for_cache_root ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
487 488 489 490 491 |
# File 'lib/rubocop/options.rb', line 487 def validate_cache_enabled_for_cache_root return unless @options[:cache] == 'false' raise OptionArgumentError, '--cache-root cannot be used with --cache false' end |
#validate_compatibility ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
rubocop:disable Metrics/AbcSize
358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 |
# File 'lib/rubocop/options.rb', line 358 def validate_compatibility # rubocop:disable Metrics/MethodLength if only_includes_redundant_disable? raise OptionArgumentError, 'Lint/RedundantCopDisableDirective cannot be used with --only.' end raise OptionArgumentError, 'Syntax checking cannot be turned off.' if except_syntax? unless boolean_or_empty_cache? raise OptionArgumentError, '-C/--cache argument must be true or false' end if display_only_fail_level_offenses_with_autocorrect? raise OptionArgumentError, '--autocorrect cannot be used with ' \ '--display-only-fail-level-offenses.' end validate_auto_gen_config validate_autocorrect validate_display_only_failed validate_display_only_failed_and_display_only_correctable validate_display_only_correctable_and_autocorrect disable_parallel_when_invalid_option_combo return if .size <= 1 raise OptionArgumentError, "Incompatible cli options: #{.inspect}" end |
#validate_cop_options ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
353 354 355 |
# File 'lib/rubocop/options.rb', line 353 def %i[only except].each { |opt| OptionsValidator.validate_cop_list(@options[opt]) } end |
#validate_display_only_correctable_and_autocorrect ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
405 406 407 408 409 410 411 412 |
# File 'lib/rubocop/options.rb', line 405 def validate_display_only_correctable_and_autocorrect return unless @options.key?(:autocorrect) return if !@options.key?(:display_only_correctable) && !@options.key?(:display_only_safe_correctable) raise OptionArgumentError, '--autocorrect cannot be used with --display-only-[safe-]correctable.' end |
#validate_display_only_failed ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
397 398 399 400 401 402 403 |
# File 'lib/rubocop/options.rb', line 397 def validate_display_only_failed return unless @options.key?(:display_only_failed) return if @options[:format] == 'junit' raise OptionArgumentError, format('--display-only-failed can only be used together with --format junit.') end |
#validate_display_only_failed_and_display_only_correctable ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
414 415 416 417 418 419 420 421 |
# File 'lib/rubocop/options.rb', line 414 def validate_display_only_failed_and_display_only_correctable return unless @options.key?(:display_only_failed) return if !@options.key?(:display_only_correctable) && !@options.key?(:display_only_safe_correctable) raise OptionArgumentError, format('--display-only-failed cannot be used together with other display options.') end |
#validate_exclude_limit_option ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
479 480 481 482 483 484 485 |
# File 'lib/rubocop/options.rb', line 479 def validate_exclude_limit_option return if /^\d+$/.match?(@options[:exclude_limit]) # Emulate OptionParser's behavior to make failures consistent regardless # of option order. raise OptionParser::MissingArgument end |