class Semverve::VersionChecks::DocReferences

Documentation/reference version check.

Public Class Methods

Source

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

Initializes the check.

@param [Class] scanner

@return [Semverve::VersionChecks::DocReferences]

Public Instance Methods

check_description ()

Source

# File lib/semverve/version_checks.rb, line 205
def check_description
  "Check configured files for stale version references"
end

Focused check task description.

@return [String]

clean_message ()

Source

# File lib/semverve/version_checks.rb, line 229
def clean_message
  "Version references 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 237
def exact_target_fix_noop_notice?
  true
end

finding_label ()

Source

# File lib/semverve/version_checks.rb, line 221
def finding_label
  "version reference"
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 241
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 250
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 213
def fix_description
  "Replace stale version references in configured files"
end

Focused fix task description.

@return [String]

name ()

Source

# File lib/semverve/version_checks.rb, line 189
def name
  :doc_references
end

Public check name used in config.version_checks.

@return [Symbol]

targetable? ()

Source

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

task_name ()

Source

# File lib/semverve/version_checks.rb, line 197
def task_name
  :references
end

Focused Rake task suffix.

@return [Symbol]