Class: Semverve::VersionChecks::RailsConfigMetadataCheck

Inherits:
Check
  • Object
show all
Defined in:
lib/semverve/version_checks.rb

Overview

Rails config metadata version check.

Instance Method Summary collapse

Methods inherited from Check

#exact_target_fix_noop_notice?, #fix_label, #targetable?, #task_arguments

Constructor Details

#initialize(scanner: RailsConfigMetadata) ⇒ Semverve::VersionChecks::RailsConfigMetadataCheck

Initializes the check.

Parameters:

  • scanner (Class) (defaults to: RailsConfigMetadata) 


445
446
447
 
# File 'lib/semverve/version_checks.rb', line 445

def initialize(scanner: RailsConfigMetadata)
  @scanner = scanner
end

Instance Method Details

#check_description ⇒ String

Focused check task description.

Returns:

  • (String) 


469
470
471
 
# File 'lib/semverve/version_checks.rb', line 469

def check_description
  "Check Rails config metadata for version mismatches"
end

#clean_message ⇒ String

Message printed when no findings or replacements exist.

Returns:

  • (String) 


493
494
495
 
# File 'lib/semverve/version_checks.rb', line 493

def clean_message
  "Rails config metadata is current."
end

#finding_label ⇒ String

Label printed for Rails config metadata findings and replacements.

Returns:

  • (String) 


485
486
487
 
# File 'lib/semverve/version_checks.rb', line 485

def finding_label
  "Rails config version"
end

#findings(configuration, current_version, include_ignored: false, target_version: nil) ⇒ Object 



497
498
499
 
# File 'lib/semverve/version_checks.rb', line 497

def findings(configuration, current_version, include_ignored: false, target_version: nil)
  scanner.new(configuration, current_version).findings
end

#fix(configuration, current_version, target_version: nil) ⇒ Object 



501
502
503
 
# File 'lib/semverve/version_checks.rb', line 501

def fix(configuration, current_version, target_version: nil)
  scanner.new(configuration, current_version).fix
end

#fix_description ⇒ String

Focused fix task description.

Returns:

  • (String) 


477
478
479
 
# File 'lib/semverve/version_checks.rb', line 477

def fix_description
  "Fix safe Rails config metadata version mismatches"
end

#name ⇒ Symbol

Public check name used in config.version_checks.

Returns:

  • (Symbol) 


453
454
455
 
# File 'lib/semverve/version_checks.rb', line 453

def name
  :rails_config_metadata
end

#task_name ⇒ Symbol

Focused Rake task suffix.

Returns:

  • (Symbol) 


461
462
463
 
# File 'lib/semverve/version_checks.rb', line 461

def task_name
  :rails_config_metadata
end