fr.brouillard.oss.jgitver.impl

Class VersionStrategy<T extends VersionStrategy>

java.lang.Object

fr.brouillard.oss.jgitver.impl.VersionStrategy<T>

Direct Known Subclasses:

ConfigurableVersionStrategy, MavenVersionStrategy, PatternVersionStrategy

public abstract class VersionStrategy<T extends VersionStrategy>
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VersionStrategy.StrategySearchMode

Constructor Summary

Constructors

Constructor and Description
VersionStrategy(VersionNamingConfiguration vnc, org.eclipse.jgit.lib.Repository repository, org.eclipse.jgit.api.Git git, MetadataRegistrar registrar) Default constructor.

Method Summary

Modifier and Type	Method and Description
abstract Version	build(Commit head, List<Commit> parents) Build a version using the given information extracted from the git repository.
protected TagType	computeTagType(org.eclipse.jgit.lib.Ref tagToUse, org.eclipse.jgit.lib.Ref annotatedTag)
protected Version	enhanceVersionWithBranch(Version baseVersion, String branch)
protected Commit	findMaxVersionCommit(Commit head, List<Commit> parents)
protected org.eclipse.jgit.lib.Ref	findTagToUse(Commit head, Commit base)
protected Commit	findVersionCommit(Commit head, List<Commit> parents)
protected Version	getBaseVersionAndRegisterMetadata(Commit base, org.eclipse.jgit.lib.Ref tagToUse)
protected org.eclipse.jgit.api.Git	getGit()
protected MetadataRegistrar	getRegistrar()
protected org.eclipse.jgit.lib.Repository	getRepository()
protected VersionNamingConfiguration	getVersionNamingConfiguration()
protected boolean	isBaseCommitOnHead(Commit head, Commit base)
protected boolean	isGitDirty()
boolean	isVersionTag(org.eclipse.jgit.lib.Ref tag) Checks regarding the current strategy if the given Ref corresponds to a tag of a version.
protected Optional<org.eclipse.jgit.lib.Ref>	maxVersionTag(List<org.eclipse.jgit.lib.Ref> tags)
protected org.eclipse.jgit.lib.Ref	maxVersionTag(List<org.eclipse.jgit.lib.Ref> primaryTags, List<org.eclipse.jgit.lib.Ref> secondaryTags)
protected T	runAndGetSelf(Runnable runnable)
int	searchDepthLimit() Defines the history commit depth, starting from HEAD, until which parent commits will be parsed to find tags information.
VersionStrategy.StrategySearchMode	searchMode()
protected T	self()
T	setSearchDepthLimit(int newLimit) Sets a limit to the depth of lookup for base version tags.
protected Version	tagToVersion(String tagName)
protected fr.brouillard.oss.jgitver.impl.VersionStrategy.VersionTarget<Commit>	toVersionTarget(Commit head, Commit commit)
protected fr.brouillard.oss.jgitver.impl.VersionStrategy.VersionTarget<org.eclipse.jgit.lib.Ref>	toVersionTarget(org.eclipse.jgit.lib.Ref tagRef)
Version	versionFromTag(org.eclipse.jgit.lib.Ref ref) Computes a Version object from the given tag reference using the strategy configuration.

Methods inherited from class java.lang.Object

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

Constructor Detail

VersionStrategy

public VersionStrategy(VersionNamingConfiguration vnc,
                       org.eclipse.jgit.lib.Repository repository,
                       org.eclipse.jgit.api.Git git,
                       MetadataRegistrar registrar)

Default constructor.

Parameters:

vnc - the configuration to use

repository - the git repository

git - a git helper object built from the repository

registrar - a storage for found/calculated metadata

Method Detail

getRegistrar

protected MetadataRegistrar getRegistrar()

build

public abstract Version build(Commit head,
                              List<Commit> parents)
                       throws VersionCalculationException

Build a version using the given information extracted from the git repository.

Parameters:

head - cannot be null the current head commit

parents - a non null list of commits that will be involved in version naming. The list cannot be null and contains the first commit of the repository if no commit with version tag can be found.

Returns:

a non null Version object

Throws:

VersionCalculationException - in case an error occurred while computing the version

searchDepthLimit

public int searchDepthLimit()

Defines the history commit depth, starting from HEAD, until which parent commits will be parsed to find tags information. This parameter is informative and will be respected only if at least one commit with version information is found between HEAD and the defined depth. If none is found then the search will go deeper until it find one commit with version information or until it reaches the first commit. Valid only when the searchMode() is VersionStrategy.StrategySearchMode.DEPTH.

Returns:

a strict positive integer representing the depth until which the search will stop.

setSearchDepthLimit

public T setSearchDepthLimit(int newLimit)

Sets a limit to the depth of lookup for base version tags.

Parameters:

newLimit - a positive value or 0 if the given value is negative

Returns:

self instance of the strategy object to allow method chaining

isVersionTag

public boolean isVersionTag(org.eclipse.jgit.lib.Ref tag)

Checks regarding the current strategy if the given Ref corresponds to a tag of a version.

Parameters:

tag - a non null tag as a Ref object

Returns:

true if the given tag matches the version rules of this strategy, false otherwise

searchMode

public VersionStrategy.StrategySearchMode searchMode()

computeTagType

protected TagType computeTagType(org.eclipse.jgit.lib.Ref tagToUse,
                                 org.eclipse.jgit.lib.Ref annotatedTag)

runAndGetSelf

protected T runAndGetSelf(Runnable runnable)

self

protected T self()

getBaseVersionAndRegisterMetadata

protected Version getBaseVersionAndRegisterMetadata(Commit base,
                                                    org.eclipse.jgit.lib.Ref tagToUse)

tagToVersion

protected Version tagToVersion(String tagName)

isGitDirty

protected boolean isGitDirty()

findTagToUse

protected org.eclipse.jgit.lib.Ref findTagToUse(Commit head,
                                                Commit base)

findVersionCommit

protected Commit findVersionCommit(Commit head,
                                   List<Commit> parents)

findMaxVersionCommit

protected Commit findMaxVersionCommit(Commit head,
                                      List<Commit> parents)

maxVersionTag

protected org.eclipse.jgit.lib.Ref maxVersionTag(List<org.eclipse.jgit.lib.Ref> primaryTags,
                                                 List<org.eclipse.jgit.lib.Ref> secondaryTags)

maxVersionTag

protected Optional<org.eclipse.jgit.lib.Ref> maxVersionTag(List<org.eclipse.jgit.lib.Ref> tags)

versionFromTag

public Version versionFromTag(org.eclipse.jgit.lib.Ref ref)

Computes a Version object from the given tag reference using the strategy configuration.

Parameters:

ref - a git Ref object corresponding to the tag

Returns:

the corresponding Version object

toVersionTarget

protected fr.brouillard.oss.jgitver.impl.VersionStrategy.VersionTarget<org.eclipse.jgit.lib.Ref> toVersionTarget(org.eclipse.jgit.lib.Ref tagRef)

toVersionTarget

protected fr.brouillard.oss.jgitver.impl.VersionStrategy.VersionTarget<Commit> toVersionTarget(Commit head,
                                                                                               Commit commit)

getVersionNamingConfiguration

protected VersionNamingConfiguration getVersionNamingConfiguration()

getRepository

protected org.eclipse.jgit.lib.Repository getRepository()

getGit

protected org.eclipse.jgit.api.Git getGit()

isBaseCommitOnHead

protected boolean isBaseCommitOnHead(Commit head,
                                     Commit base)

enhanceVersionWithBranch

protected Version enhanceVersionWithBranch(Version baseVersion,
                                           String branch)