class Semverve::VersionReferences

Finds and updates version references in configured project files.

Constants

IGNORE_MARKER

Marker that suppresses version-reference findings.

@return [String]

TEXT_EXTENSIONS

Text file extensions scanned as full content.

@return [Array<String>]

VERSION_PATTERN

Version strings supported by Semverve.

@return [Regexp]

Public Class Methods

new (configuration, current_version, include_ignored: false)

Source

# File lib/semverve/version_references.rb, line 110
def initialize(configuration, current_version, include_ignored: false)
  @configuration = configuration
  @current_version = current_version
  @include_ignored = include_ignored
end

Initializes version-reference scanning.

@param [Semverve::ResolvedConfiguration] configuration @param [Semverve::SemanticVersion] current_version

@return [Semverve::VersionReferences]

Public Instance Methods

findings ()

Source

# File lib/semverve/version_references.rb, line 120
def findings
  files.flat_map { |path| findings_for_file(path) }
end

Version-reference findings in configured files.

@return [Array<Semverve::VersionReferences::Finding>]

fix ()

Source

# File lib/semverve/version_references.rb, line 128
def fix
  changed_files = []
  replacement_count = 0

  files.each do |path|
    content = File.read(path)
    fixed, count = fixed_content(path, content)

    next if count.zero?

    File.write(path, fixed)
    changed_files << relative_path(path)
    replacement_count += count
  end

  FixResult.new(changed_files: changed_files, replacement_count: replacement_count)
end

Replaces found version references with the current version.

@return [Semverve::VersionReferences::FixResult]