Merge pull request #171 from ajoberstar/next

Next version of Reckon

Author: ajoberstar

README.md

@@ -125,8 +125,30 @@ plugins {
 reckon {
   scopeFromProp()
   stageFromProp('milestone', 'rc', 'final')
+
   // alternative to stageFromProp
   // snapshotFromProp()
+
+  // omit this to use the default of 'minor'
+  defaultInferredScope = 'patch'
+  
+  // omit to use default remote
+  remote = 'other-remote'
+
+  // omit this to use the default of parsing tag names of the form 1.2.3 or v1.2.3
+  // this is a String to Optional<Version> function
+  // return an empty optional for tags you don't consider a relevant version
+  tagParser = tagName -> java.util.Optional.of(tagName)
+    .filter(name -> name.startsWith("project-a/"))
+    .map(name -> name.replace("project-a/", ""))
+    .flatMap(name -> org.ajoberstar.reckon.core.Version.parse(name))
+
+  // omit this to use the default of writing tag names of the form 1.2.3
+  // this is a Version to String function
+  tagWriter = version -> "project-a/" + version
+
+  // omit this to use the default of tag messages including just the raw version, e.g. "1.2.3"
+  tagMessage = version.map(v -> "Version " + v)
 }
 ```
 

reckon-core/src/main/java/org/ajoberstar/reckon/core/GitInventorySupplier.java

@@ -8,7 +8,6 @@
 import java.util.Map;
 import java.util.Optional;
 import java.util.Set;
-import java.util.function.Function;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
@@ -39,18 +38,11 @@ final class GitInventorySupplier implements VcsInventorySupplier {
   private static final Logger logger = LoggerFactory.getLogger(GitInventorySupplier.class);
 
   private final Repository repo;
-  private final Function<Ref, Optional<Version>> tagParser;
+  private final VersionTagParser tagParser;
 
-  public GitInventorySupplier(Repository repo) {
-    this(repo, tagName -> Optional.of(tagName.replaceAll("^v", "")));
-  }
-
-  public GitInventorySupplier(Repository repo, Function<String, Optional<String>> tagSelector) {
+  public GitInventorySupplier(Repository repo, VersionTagParser tagParser) {
     this.repo = repo;
-    this.tagParser = ref -> {
-      String tagName = Repository.shortenRefName(ref.getName());
-      return tagSelector.apply(tagName).flatMap(Version::parse);
-    };
+    this.tagParser = tagParser;
   }
 
   @Override
@@ -60,7 +52,7 @@ public VcsInventory getInventory() {
       // saves on some performance as we don't really need the commit bodys
       walk.setRetainBody(false);
 
-      ObjectId headObjectId = repo.getRefDatabase().getRef("HEAD").getObjectId();
+      ObjectId headObjectId = repo.getRefDatabase().findRef("HEAD").getObjectId();
 
       if (headObjectId == null) {
         logger.debug("No HEAD commit. Presuming repo is empty.");
@@ -88,8 +80,7 @@ public VcsInventory getInventory() {
       Set<RevCommit> taggedCommits = taggedVersions.stream().map(TaggedVersion::getCommit).collect(Collectors.toSet());
       Set<Version> parallelVersions = parallelCandidates.stream()
           .map(version -> findParallel(walk, headCommit, version, taggedCommits))
-          // TODO Java 9 Optional::stream
-          .flatMap(opt -> opt.isPresent() ? Stream.of(opt.get()) : Stream.empty())
+          .flatMap(Optional::stream)
           .collect(Collectors.toSet());
 
       Set<Version> claimedVersions = taggedVersions.stream().map(TaggedVersion::getVersion).collect(Collectors.toSet());
@@ -121,12 +112,15 @@ private boolean isClean() {
   private Set<TaggedVersion> getTaggedVersions(RevWalk walk) throws IOException {
     Set<TaggedVersion> versions = new HashSet<>();
 
-    for (Ref ref : repo.getRefDatabase().getRefs(Constants.R_TAGS).values()) {
-      Ref tag = repo.peel(ref);
+    for (Ref ref : repo.getRefDatabase().getRefsByPrefix(Constants.R_TAGS)) {
+
+      Ref tag = repo.getRefDatabase().peel(ref);
       // only annotated tags return a peeled object id
       ObjectId objectId = tag.getPeeledObjectId() == null ? tag.getObjectId() : tag.getPeeledObjectId();
       RevCommit commit = walk.parseCommit(objectId);
-      tagParser.apply(tag).ifPresent(version -> {
+
+      String tagName = Repository.shortenRefName(ref.getName());
+      tagParser.parse(tagName).ifPresent(version -> {
         versions.add(new TaggedVersion(version, commit));
       });
     }
@@ -198,9 +192,7 @@ private Optional<Version> findParallel(RevWalk walk, RevCommit head, TaggedVersi
       walk.reset();
       walk.setRevFilter(RevFilter.ALL);
       boolean taggedSinceMergeBase = RevWalkUtils.find(walk, head, mergeBase).stream()
-          .filter(tagged::contains)
-          .findAny()
-          .isPresent();
+          .anyMatch(tagged::contains);
 
       if (mergeBase != null
           && !taggedSinceMergeBase

reckon-core/src/main/java/org/ajoberstar/reckon/core/Reckoner.java

@@ -32,14 +32,16 @@ public final class Reckoner {
   private final VcsInventorySupplier inventorySupplier;
   private final Function<VcsInventory, Optional<String>> scopeCalc;
   private final BiFunction<VcsInventory, Version, Optional<String>> stageCalc;
+  private final Scope defaultInferredScope;
   private final Set<String> stages;
   private final String defaultStage;
 
-  private Reckoner(Clock clock, VcsInventorySupplier inventorySupplier, Function<VcsInventory, Optional<String>> scopeCalc, BiFunction<VcsInventory, Version, Optional<String>> stageCalc, Set<String> stages, String defaultStage) {
+  private Reckoner(Clock clock, VcsInventorySupplier inventorySupplier, Function<VcsInventory, Optional<String>> scopeCalc, BiFunction<VcsInventory, Version, Optional<String>> stageCalc, Scope defaultInferredScope, Set<String> stages, String defaultStage) {
     this.clock = clock;
     this.inventorySupplier = inventorySupplier;
     this.scopeCalc = scopeCalc;
     this.stageCalc = stageCalc;
+    this.defaultInferredScope = defaultInferredScope;
     this.stages = stages;
     this.defaultStage = defaultStage;
   }
@@ -83,7 +85,7 @@ private Version reckonNormal(VcsInventory inventory) {
       logger.debug("Using provided scope value: {}", scope);
     } else {
       Optional<Scope> inferredScope = Scope.infer(inventory.getBaseNormal(), inventory.getBaseVersion());
-      scope = inferredScope.orElse(Scope.MINOR);
+      scope = inferredScope.orElse(defaultInferredScope);
       logger.debug("Inferred scope from base version: {}", scope);
     }
 
@@ -154,6 +156,7 @@ public static final class Builder {
     private VcsInventorySupplier inventorySupplier;
     private Function<VcsInventory, Optional<String>> scopeCalc;
     private BiFunction<VcsInventory, Version, Optional<String>> stageCalc;
+    private Scope defaultInferredScope = Scope.MINOR;
     private Set<String> stages;
     private String defaultStage;
 
@@ -174,10 +177,22 @@ Builder vcs(VcsInventorySupplier inventorySupplier) {
      * @return this builder
      */
     public Builder git(Repository repo) {
+      return git(repo, null);
+    }
+
+    /**
+     * Use the given JGit repository to infer the state of Git.
+     *
+     * @param repo repository that the version should be inferred from
+     * @param tagParser a parser used to find versions from tag names
+     * @return this builder
+     */
+    public Builder git(Repository repo, VersionTagParser tagParser) {
       if (repo == null) {
         this.inventorySupplier = () -> new VcsInventory(null, false, null, null, null, 0, Collections.emptySet(), Collections.emptySet());
       } else {
-        this.inventorySupplier = new GitInventorySupplier(repo);
+        var realParser = Optional.ofNullable(tagParser).orElse(VersionTagParser.getDefault());
+        this.inventorySupplier = new GitInventorySupplier(repo, realParser);
       }
       return this;
     }
@@ -193,6 +208,11 @@ public Builder scopeCalc(Function<VcsInventory, Optional<String>> scopeCalc) {
       return this;
     }
 
+    public Builder defaultInferredScope(Scope defaultInferredScope) {
+      this.defaultInferredScope = defaultInferredScope;
+      return this;
+    }
+
     /**
      * Use the given stages as valid options during inference.
      *
@@ -248,9 +268,10 @@ public Reckoner build() {
       Clock clock = Optional.ofNullable(this.clock).orElseGet(Clock::systemUTC);
       Objects.requireNonNull(inventorySupplier, "Must provide a vcs.");
       Objects.requireNonNull(scopeCalc, "Must provide a scope supplier.");
+      Objects.requireNonNull(defaultInferredScope, "Must provide a default inferred scope");
       Objects.requireNonNull(stages, "Must provide set of stages.");
       Objects.requireNonNull(stageCalc, "Must provide a stage supplier.");
-      return new Reckoner(clock, inventorySupplier, scopeCalc, stageCalc, stages, defaultStage);
+      return new Reckoner(clock, inventorySupplier, scopeCalc, stageCalc, defaultInferredScope, stages, defaultStage);
     }
   }
 }

reckon-core/src/main/java/org/ajoberstar/reckon/core/VersionTagParser.java

@@ -0,0 +1,12 @@
+package org.ajoberstar.reckon.core;
+
+import java.util.Optional;
+
+@FunctionalInterface
+public interface VersionTagParser {
+  Optional<Version> parse(String tagName);
+
+  static VersionTagParser getDefault() {
+    return tagName -> Version.parse(tagName.replaceAll("^v", ""));
+  }
+}

reckon-core/src/main/java/org/ajoberstar/reckon/core/VersionTagWriter.java

@@ -0,0 +1,10 @@
+package org.ajoberstar.reckon.core;
+
+@FunctionalInterface
+public interface VersionTagWriter {
+  String write(Version version);
+
+  static VersionTagWriter getDefault() {
+    return Version::toString;
+  }
+}

reckon-core/src/test/groovy/org/ajoberstar/reckon/core/GitInventorySupplierTest.groovy

@@ -146,7 +146,7 @@ class GitInventorySupplierTest extends Specification {
   def 'if no commits, all results are empty'() {
     given:
     def emptyGrgit = Grgit.init(dir: Files.createTempDirectory('repo2').toFile())
-    def emptySupplier = new GitInventorySupplier(emptyGrgit.repository.jgit.repository)
+    def emptySupplier = new GitInventorySupplier(emptyGrgit.repository.jgit.repository, VersionTagParser.getDefault())
     expect:
     emptySupplier.getInventory() == new VcsInventory(null, true, null, null, null, 0, null, null)
   }
@@ -230,7 +230,7 @@ class GitInventorySupplierTest extends Specification {
   }
 
   def setup() {
-    supplier = new GitInventorySupplier(grgit.repository.jgit.repository)
+    supplier = new GitInventorySupplier(grgit.repository.jgit.repository, VersionTagParser.getDefault())
   }
 
   private void commit() {

reckon-core/src/test/groovy/org/ajoberstar/reckon/core/ReckonerTest.groovy

@@ -281,6 +281,31 @@ class ReckonerTest extends Specification {
     reckonStage(inventory, null, 'final') == '1.3.0'
   }
 
+  def 'if supplier returns empty, scope defaults to provided default inferred scope if base version is base normal'() {
+    given:
+    def inventory = new VcsInventory(
+      'abcdef',
+      true,
+      null,
+      Version.valueOf('1.2.2'),
+      Version.valueOf('1.2.2'),
+      1,
+      [] as Set,
+      [] as Set
+    )
+    expect:
+    Reckoner.builder()
+      .clock(CLOCK)
+      .vcs { -> inventory }
+      .defaultInferredScope(Scope.PATCH)
+      .scopeCalc { i -> Optional.empty() }
+      .stages('beta', 'milestone', 'rc', 'final')
+      .stageCalc { i, v -> Optional.of('final') }
+      .build()
+      .reckon()
+      .toString() == '1.2.3'
+  }
+
   def 'if supplier returns empty, scope defaults to scope used by base version'() {
     given:
     def inventory = new VcsInventory(