class Semverve::VersionChecks::CodeReferences

Code literal version check.

Public Class Methods

Source

# File lib/semverve/version_checks.rb, line 272
def initialize(scanner: VersionCodeReferences)
  @scanner = scanner
end

Initializes the check.

@param [Class] scanner

@return [Semverve::VersionChecks::CodeReferences]

Public Instance Methods

check_description ()

Source

# File lib/semverve/version_checks.rb, line 296
def check_description
  "Check configured code files for version literals"
end

Focused check task description.

@return [String]

clean_message ()

Source

# File lib/semverve/version_checks.rb, line 320
def clean_message
  "Code version literals are current."
end

Message printed when no findings or replacements exist.

@return [String]

exact_target_fix_noop_notice? ()

Source

# File lib/semverve/version_checks.rb, line 328
def exact_target_fix_noop_notice?
  true
end

finding_label ()

Source

# File lib/semverve/version_checks.rb, line 312
def finding_label
  "code version literal"
end

Label printed for findings and replacement counts.

@return [String]

findings (configuration, current_version, include_ignored: false, target_version: nil)

Source

# File lib/semverve/version_checks.rb, line 332
def findings(configuration, current_version, include_ignored: false, target_version: nil)
  scanner.new(
    configuration,
    current_version,
    include_ignored: include_ignored,
    target_version: target_version
  ).findings
end

fix (configuration, current_version, target_version: nil)

Source

# File lib/semverve/version_checks.rb, line 341
def fix(configuration, current_version, target_version: nil)
  scanner.new(configuration, current_version, target_version: target_version).fix
end

fix_description ()

Source

# File lib/semverve/version_checks.rb, line 304
def fix_description
  "Replace safe code version literals in configured files"
end

Focused fix task description.

@return [String]

name ()

Source

# File lib/semverve/version_checks.rb, line 280
def name
  :code_references
end

Public check name used in config.version_checks.

@return [Symbol]

targetable? ()

Source

# File lib/semverve/version_checks.rb, line 324
def targetable?
  true
end

task_name ()

Source

# File lib/semverve/version_checks.rb, line 288
def task_name
  :code
end

Focused Rake task suffix.

@return [Symbol]