Class: Semverve::VersionChecks::PackageMetadataCheck

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

Overview

Package metadata version check.

Instance Method Summary collapse

Methods inherited from Check

#exact_target_fix_noop_notice?, #targetable?, #task_arguments

Constructor Details

#initialize(scanner: PackageMetadata) ⇒ Semverve::VersionChecks::PackageMetadataCheck

Initializes the check.

Parameters:

  • scanner (Class) (defaults to: PackageMetadata) 


363
364
365
 
# File 'lib/semverve/version_checks.rb', line 363

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

Instance Method Details

#check_description ⇒ String

Focused check task description.

Returns:

  • (String) 


387
388
389
 
# File 'lib/semverve/version_checks.rb', line 387

def check_description
  "Check package metadata for version mismatches"
end

#clean_message ⇒ String

Message printed when no findings or replacements exist.

Returns:

  • (String) 


415
416
417
 
# File 'lib/semverve/version_checks.rb', line 415

def clean_message
  "Package metadata is current."
end

#finding_label ⇒ nil

Package findings provide their own labels.

Returns:

  • (nil) 


403
404
405
 
# File 'lib/semverve/version_checks.rb', line 403

def finding_label
  nil
end

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



419
420
421
 
# File 'lib/semverve/version_checks.rb', line 419

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 



423
424
425
 
# File 'lib/semverve/version_checks.rb', line 423

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

#fix_description ⇒ String

Focused fix task description.

Returns:

  • (String) 


395
396
397
 
# File 'lib/semverve/version_checks.rb', line 395

def fix_description
  "Fix safe package metadata version mismatches"
end

#fix_label ⇒ Object 



407
408
409
 
# File 'lib/semverve/version_checks.rb', line 407

def fix_label
  "package metadata version"
end

#name ⇒ Symbol

Public check name used in config.version_checks.

Returns:

  • (Symbol) 


371
372
373
 
# File 'lib/semverve/version_checks.rb', line 371

def name
  :package_metadata
end

#task_name ⇒ Symbol

Focused Rake task suffix.

Returns:

  • (Symbol) 


379
380
381
 
# File 'lib/semverve/version_checks.rb', line 379

def task_name
  :package_metadata
end