Class VersionCalculator

java.lang.Object

io.github.joke.conventionalversion.calc.VersionCalculator

public class VersionCalculator
extends Object

Turns gathered repository facts into a version, predicting what release-please will publish.

Pure: given the same RepositoryState and VersionPolicy it always returns the same VersionResult, with no clock, no filesystem and no process involved.

Constructor Summary

Constructors

Constructor	Description
VersionCalculator(CommitMessageParser parser, BumpReducer reducer)

Method Summary

Modifier and Type	Method	Description
protected SemanticVersion	applyBump(Bump bump, SemanticVersion base, VersionPolicy policy)
VersionResult	calculate(RepositoryState state, VersionPolicy policy)
protected Bump	downgrade(Bump original, Bump downgraded, boolean enabled)
protected Bump	effectiveBump(Bump bump, SemanticVersion base, VersionPolicy policy)
protected Optional<SemanticVersion>	findOverride(List<ConventionalCommit> commits)	The most recent override wins, which with an oldest-first range is the last one.
protected Optional<SemanticVersion>	findReleasedVersion(RepositoryState state)	On a release commit the recorded version is the truth and nothing is derived - not the bump, and not a Release-As: override earlier in history.
protected SemanticVersion	nextVersion(@Nullable SemanticVersion recorded, VersionPolicy policy, Optional<SemanticVersion> override, Bump bump)
protected List<ConventionalCommit>	parseAll(List<String> messages)
protected Bump	preMajorBump(Bump bump, VersionPolicy policy)
protected VersionResult	releasedResult(SemanticVersion released, String sha)
protected VersionResult	snapshotResult(RepositoryState state, VersionPolicy policy)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

VersionCalculator

public VersionCalculator(CommitMessageParser parser,
 BumpReducer reducer)

Method Details

calculate

public VersionResult calculate(RepositoryState state,
 VersionPolicy policy)

findReleasedVersion

@VisibleForTesting
protected Optional<SemanticVersion> findReleasedVersion(RepositoryState state)

On a release commit the recorded version is the truth and nothing is derived - not the bump, and not a Release-As: override earlier in history.

releasedResult

@VisibleForTesting
protected VersionResult releasedResult(SemanticVersion released,
 String sha)

snapshotResult

@VisibleForTesting
protected VersionResult snapshotResult(RepositoryState state,
 VersionPolicy policy)

parseAll

@VisibleForTesting
protected List<ConventionalCommit> parseAll(List<String> messages)

findOverride

@VisibleForTesting
protected Optional<SemanticVersion> findOverride(List<ConventionalCommit> commits)

The most recent override wins, which with an oldest-first range is the last one.

nextVersion

@VisibleForTesting
protected SemanticVersion nextVersion(@Nullable SemanticVersion recorded,
 VersionPolicy policy,
 Optional<SemanticVersion> override,
 Bump bump)

applyBump

@VisibleForTesting
protected SemanticVersion applyBump(Bump bump,
 SemanticVersion base,
 VersionPolicy policy)

effectiveBump

@VisibleForTesting
protected Bump effectiveBump(Bump bump,
 SemanticVersion base,
 VersionPolicy policy)

preMajorBump

@VisibleForTesting
protected Bump preMajorBump(Bump bump,
 VersionPolicy policy)

downgrade

@VisibleForTesting
protected Bump downgrade(Bump original,
 Bump downgraded,
 boolean enabled)