Use maven injection for GAV helper

Author: ukcrpb6

src/main/java/com/e_gineering/maven/gitflowhelper/AbstractGitflowBasedRepositoryMojo.java

@@ -80,7 +80,17 @@ private static PrintWriter newPrintWriter(File catalog) throws FileNotFoundExcep
     @Component(role = ArtifactRepositoryLayout.class)
     private Map<String, ArtifactRepositoryLayout> repositoryLayouts;
 
-    private GavCoordinateFactory gavCoordinateFactory;
+    @Component
+    private GavCoordinateHelperFactory gavCoordinateFactory;
+
+    private GavCoordinateHelper gavCoordinateHelper;
+
+    @Override
+    public void execute() throws MojoExecutionException, MojoFailureException {
+        gavCoordinateHelper = gavCoordinateFactory.using(session);
+
+        super.execute();
+    }
 
     /**
      * Builds an ArtifactRepository for targeting deployments.
@@ -216,7 +226,7 @@ void attachArtifactCatalog() throws MojoExecutionException {
     }
 
     private void catalogArtifact(PrintWriter writer, Artifact artifact) {
-        String coords = gavCoordinateFactory().getCoordinates(artifact);
+        String coords = gavCoordinateHelper.getCoordinates(artifact);
         getLog().info("Cataloging: " + coords);
         writer.println(coords);
     }
@@ -320,7 +330,7 @@ void attachExistingArtifacts(final String sourceRepository, final boolean disabl
         }
 
         // Get the current build artifact coordinates, so that we replace rather than re-attach.
-        String projectArtifactCoordinates = gavCoordinateFactory().getCoordinates(project.getArtifact());
+        String projectArtifactCoordinates = gavCoordinateHelper.getCoordinates(project.getArtifact());
         getLog().debug("Current Project Coordinates: " + projectArtifactCoordinates);
 
         // For each artifactResult, copy it to the build directory,
@@ -331,12 +341,12 @@ void attachExistingArtifacts(final String sourceRepository, final boolean disabl
                 FileUtils.copyFileToDirectory(artifactResult.getArtifact().getFile(), buildDirectory);
                 artifactResult.setArtifact(artifactResult.getArtifact().setFile(new File(buildDirectory, artifactResult.getArtifact().getFile().getName())));
 
-                if (gavCoordinateFactory().getCoordinates(artifactResult).equals(projectArtifactCoordinates)) {
+                if (gavCoordinateHelper.getCoordinates(artifactResult).equals(projectArtifactCoordinates)) {
                     getLog().debug("    Setting primary artifact: " + artifactResult.getArtifact().getFile());
                     project.getArtifact().setFile(artifactResult.getArtifact().getFile());
                 } else {
                     getLog().debug(
-                            "    Attaching artifact: " + gavCoordinateFactory().getCoordinates(artifactResult) + " "
+                            "    Attaching artifact: " + gavCoordinateHelper.getCoordinates(artifactResult) + " "
                                     + artifactResult.getArtifact().getFile());
                     projectHelper.attachArtifact(project, artifactResult.getArtifact().getExtension(), artifactResult.getArtifact().getClassifier(), artifactResult.getArtifact().getFile());
                 }
@@ -388,12 +398,4 @@ private boolean hasFile(@Nullable Artifact artifact) {
                && project.getArtifact().getFile().exists()
                && project.getArtifact().getFile().isFile();
     }
-
-    private GavCoordinateFactory gavCoordinateFactory() {
-        if (gavCoordinateFactory == null) {
-            // TODO(somebody): this could probably be nicely injected as a maven component
-            gavCoordinateFactory = new GavCoordinateFactory(session, project, getLog());
-        }
-        return gavCoordinateFactory;
-    }
 }

src/main/java/com/e_gineering/maven/gitflowhelper/GavCoordinateFactory.java renamed to src/main/java/com/e_gineering/maven/gitflowhelper/DefaultGavCoordinateHelper.java

@@ -2,8 +2,8 @@
 
 import com.google.common.base.Joiner;
 import org.apache.maven.artifact.Artifact;
-import org.apache.maven.plugin.logging.Log;
 import org.apache.maven.project.MavenProject;
+import org.codehaus.plexus.logging.Logger;
 import org.eclipse.aether.RepositorySystemSession;
 import org.eclipse.aether.resolution.ArtifactResult;
 
@@ -15,47 +15,36 @@
 /**
  * A helper factory for creating maven (GroupId, ArtifactId, Extension, Classifier, Version) coordinates.
  */
-class GavCoordinateFactory {
-    // TODO(somebody): Consider using maven @Component to make this an injectable component in the mojo
+class DefaultGavCoordinateHelper implements GavCoordinateHelper {
 
     private static final Joiner GAV_JOINER = Joiner.on(':').skipNulls();
 
-    private final RepositorySystemSession session;
+    private final Logger log;
 
     private final MavenProject project;
-    private final Log log;
+
+    private final RepositorySystemSession session;
 
     /**
-     * Creates a new {@link GavCoordinateFactory}.
+     * Creates a new {@link DefaultGavCoordinateHelperFactory}.
      *
      * @param session the repository session
      * @param project the project
      * @param log     the logger
      */
-    GavCoordinateFactory(RepositorySystemSession session, MavenProject project, Log log) {
+    DefaultGavCoordinateHelper(RepositorySystemSession session, MavenProject project, Logger log) {
         this.session = checkNotNull(session, "session must not be null");
         this.project = checkNotNull(project, "project must not be null");
         this.log = checkNotNull(log, "log must not be null");
     }
 
-    /**
-     * Get GAV coordinates for the {@link ArtifactResult}.
-     *
-     * @param result the result
-     * @return the GAV coordinate string
-     */
-    String getCoordinates(ArtifactResult result) {
+    @Override
+    public String getCoordinates(ArtifactResult result) {
         return getCoordinates(result.getArtifact());
     }
 
-    /**
-     * Get GAV coordinates for the {@link org.eclipse.aether.artifact.Artifact}.
-     *
-     * @param artifact the artifact
-     * @return the GAV coordinate string
-     */
-    @SuppressWarnings("WeakerAccess")
-    String getCoordinates(org.eclipse.aether.artifact.Artifact artifact) {
+    @Override
+    public String getCoordinates(org.eclipse.aether.artifact.Artifact artifact) {
         return getCoordinates(
                 emptyToNull(artifact.getGroupId()),
                 emptyToNull(artifact.getArtifactId()),
@@ -65,13 +54,8 @@ String getCoordinates(org.eclipse.aether.artifact.Artifact artifact) {
         );
     }
 
-    /**
-     * Get GAV coordinates for the {@link Artifact}.
-     *
-     * @param artifact the artifact
-     * @return the GAV coordinate string
-     */
-    String getCoordinates(Artifact artifact) {
+    @Override
+    public String getCoordinates(Artifact artifact) {
         log.debug("   Encoding Coordinates For: " + artifact);
 
         // Get the extension according to the artifact type.

src/main/java/com/e_gineering/maven/gitflowhelper/DefaultGavCoordinateHelperFactory.java

@@ -0,0 +1,25 @@
+package com.e_gineering.maven.gitflowhelper;
+
+import org.apache.maven.project.MavenProject;
+import org.codehaus.plexus.component.annotations.Component;
+import org.codehaus.plexus.component.annotations.Requirement;
+import org.codehaus.plexus.logging.Logger;
+import org.eclipse.aether.RepositorySystemSession;
+
+/**
+ * A helper factory for creating {@link GavCoordinateHelper} instances scoped to a repository session.
+ */
+@Component(role = GavCoordinateHelperFactory.class)
+class DefaultGavCoordinateHelperFactory implements GavCoordinateHelperFactory {
+
+    @Requirement
+    private Logger log;
+
+    @Requirement
+    private MavenProject project;
+
+    @Override
+    public GavCoordinateHelper using(RepositorySystemSession session) {
+        return new DefaultGavCoordinateHelper(session, project, log);
+    }
+}

src/main/java/com/e_gineering/maven/gitflowhelper/GavCoordinateHelper.java

@@ -0,0 +1,33 @@
+package com.e_gineering.maven.gitflowhelper;
+
+import org.apache.maven.artifact.Artifact;
+import org.eclipse.aether.resolution.ArtifactResult;
+
+/**
+ * A helper factory for creating maven (GroupId, ArtifactId, Extension, Classifier, Version) coordinates.
+ */
+public interface GavCoordinateHelper {
+    /**
+     * Get GAV coordinates for the {@link ArtifactResult}.
+     *
+     * @param result the result
+     * @return the GAV coordinate string
+     */
+    String getCoordinates(ArtifactResult result);
+
+    /**
+     * Get GAV coordinates for the {@link org.eclipse.aether.artifact.Artifact}.
+     *
+     * @param artifact the artifact
+     * @return the GAV coordinate string
+     */
+    String getCoordinates(org.eclipse.aether.artifact.Artifact artifact);
+
+    /**
+     * Get GAV coordinates for the {@link Artifact}.
+     *
+     * @param artifact the artifact
+     * @return the GAV coordinate string
+     */
+    String getCoordinates(Artifact artifact);
+}

src/main/java/com/e_gineering/maven/gitflowhelper/GavCoordinateHelperFactory.java

@@ -0,0 +1,19 @@
+package com.e_gineering.maven.gitflowhelper;
+
+import org.eclipse.aether.RepositorySystemSession;
+
+/**
+ * A {@link GavCoordinateHelper} factory.
+ */
+public interface GavCoordinateHelperFactory {
+
+    String ROLE = GavCoordinateHelperFactory.class.getName();
+
+    /**
+     * Create a coordinate helper scoped to the {@link RepositorySystemSession}.
+     *
+     * @param session the session
+     * @return the coordinate helper
+     */
+    GavCoordinateHelper using(RepositorySystemSession session);
+}