You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by el...@apache.org on 2024/12/26 12:44:42 UTC

(maven-site-plugin) branch master updated: Convert to Guice injection (#218)

This is an automated email from the ASF dual-hosted git repository.

elharo pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-site-plugin.git


The following commit(s) were added to refs/heads/master by this push:
     new e6f70941 Convert to Guice injection (#218)
e6f70941 is described below

commit e6f70941e714886ca4e113324d15762b9cd537bc
Author: Elliotte Rusty Harold <el...@users.noreply.github.com>
AuthorDate: Thu Dec 26 12:44:38 2024 +0000

    Convert to Guice injection (#218)
    
    * Prefer Guice to Plexus
---
 pom.xml                                            | 12 +++++++----
 .../descriptor/AbstractSiteDescriptorMojo.java     | 15 +++++++------
 .../plugins/site/descriptor/EffectiveSiteMojo.java |  8 +++++++
 .../site/descriptor/SiteDescriptorAttachMojo.java  |  4 +++-
 .../site/render/AbstractSiteRenderingMojo.java     | 25 ++++++++++++++--------
 .../maven/plugins/site/render/SiteJarMojo.java     | 11 +++++++++-
 .../apache/maven/plugins/site/render/SiteMojo.java | 13 +++++++++++
 .../apache/maven/plugins/site/run/SiteRunMojo.java | 13 +++++++++++
 8 files changed, 80 insertions(+), 21 deletions(-)

diff --git a/pom.xml b/pom.xml
index b9e0f85a..b2b092d5 100644
--- a/pom.xml
+++ b/pom.xml
@@ -296,15 +296,19 @@ under the License.
       <artifactId>maven-plugin-annotations</artifactId>
       <scope>provided</scope>
     </dependency>
+    <dependency>
+      <groupId>javax.inject</groupId>
+      <artifactId>javax.inject</artifactId>
+      <version>1</version>
+      <scope>provided</scope>
+    </dependency>
 
     <!-- Plexus -->
     <dependency>
-      <groupId>org.sonatype.sisu</groupId>
-      <artifactId>sisu-inject-plexus</artifactId>
-      <version>1.4.2</version>
+      <groupId>org.eclipse.sisu</groupId>
+      <artifactId>org.eclipse.sisu.plexus</artifactId>
       <scope>provided</scope>
     </dependency>
-
     <dependency>
       <groupId>org.codehaus.plexus</groupId>
       <artifactId>plexus-archiver</artifactId>
diff --git a/src/main/java/org/apache/maven/plugins/site/descriptor/AbstractSiteDescriptorMojo.java b/src/main/java/org/apache/maven/plugins/site/descriptor/AbstractSiteDescriptorMojo.java
index 3f8e55d6..38e8960b 100644
--- a/src/main/java/org/apache/maven/plugins/site/descriptor/AbstractSiteDescriptorMojo.java
+++ b/src/main/java/org/apache/maven/plugins/site/descriptor/AbstractSiteDescriptorMojo.java
@@ -27,7 +27,6 @@ import org.apache.maven.doxia.site.inheritance.SiteModelInheritanceAssembler;
 import org.apache.maven.doxia.tools.SiteTool;
 import org.apache.maven.doxia.tools.SiteToolException;
 import org.apache.maven.plugin.MojoExecutionException;
-import org.apache.maven.plugins.annotations.Component;
 import org.apache.maven.plugins.annotations.Parameter;
 import org.apache.maven.plugins.site.AbstractSiteMojo;
 import org.apache.maven.project.MavenProject;
@@ -40,11 +39,6 @@ import org.eclipse.aether.repository.RemoteRepository;
  * @since 3.5
  */
 public abstract class AbstractSiteDescriptorMojo extends AbstractSiteMojo {
-    /**
-     * The component for assembling site model inheritance.
-     */
-    @Component
-    private SiteModelInheritanceAssembler assembler;
 
     /**
      * The reactor projects.
@@ -86,6 +80,15 @@ public abstract class AbstractSiteDescriptorMojo extends AbstractSiteMojo {
     @Parameter(property = "relativizeSiteLinks", defaultValue = "true")
     private boolean relativizeSiteLinks;
 
+    /**
+     * The component for assembling site model inheritance.
+     */
+    private final SiteModelInheritanceAssembler assembler;
+
+    protected AbstractSiteDescriptorMojo(SiteModelInheritanceAssembler assembler) {
+        this.assembler = assembler;
+    }
+
     protected SiteModel prepareSiteModel(Locale locale) throws MojoExecutionException {
         SiteModel siteModel;
         try {
diff --git a/src/main/java/org/apache/maven/plugins/site/descriptor/EffectiveSiteMojo.java b/src/main/java/org/apache/maven/plugins/site/descriptor/EffectiveSiteMojo.java
index e4c0046a..bfea34f3 100644
--- a/src/main/java/org/apache/maven/plugins/site/descriptor/EffectiveSiteMojo.java
+++ b/src/main/java/org/apache/maven/plugins/site/descriptor/EffectiveSiteMojo.java
@@ -18,6 +18,8 @@
  */
 package org.apache.maven.plugins.site.descriptor;
 
+import javax.inject.Inject;
+
 import java.io.File;
 import java.io.IOException;
 import java.io.StringWriter;
@@ -25,6 +27,7 @@ import java.io.Writer;
 
 import org.apache.commons.lang3.StringUtils;
 import org.apache.maven.doxia.site.SiteModel;
+import org.apache.maven.doxia.site.inheritance.SiteModelInheritanceAssembler;
 import org.apache.maven.doxia.site.io.xpp3.SiteXpp3Writer;
 import org.apache.maven.plugin.MojoExecutionException;
 import org.apache.maven.plugin.MojoFailureException;
@@ -54,6 +57,11 @@ public class EffectiveSiteMojo extends AbstractSiteDescriptorMojo {
     @Parameter(property = "output")
     protected File output;
 
+    @Inject
+    public EffectiveSiteMojo(SiteModelInheritanceAssembler assembler) {
+        super(assembler);
+    }
+
     /**
      * {@inheritDoc}
      */
diff --git a/src/main/java/org/apache/maven/plugins/site/descriptor/SiteDescriptorAttachMojo.java b/src/main/java/org/apache/maven/plugins/site/descriptor/SiteDescriptorAttachMojo.java
index d416c7a8..0924e1cc 100644
--- a/src/main/java/org/apache/maven/plugins/site/descriptor/SiteDescriptorAttachMojo.java
+++ b/src/main/java/org/apache/maven/plugins/site/descriptor/SiteDescriptorAttachMojo.java
@@ -24,6 +24,7 @@ import java.io.File;
 import java.io.IOException;
 import java.util.Locale;
 
+import org.apache.maven.doxia.site.inheritance.SiteModelInheritanceAssembler;
 import org.apache.maven.plugin.MojoExecutionException;
 import org.apache.maven.plugins.annotations.LifecyclePhase;
 import org.apache.maven.plugins.annotations.Mojo;
@@ -65,7 +66,8 @@ public class SiteDescriptorAttachMojo extends AbstractSiteDescriptorMojo {
     private final MavenProjectHelper projectHelper;
 
     @Inject
-    public SiteDescriptorAttachMojo(MavenProjectHelper projectHelper) {
+    public SiteDescriptorAttachMojo(SiteModelInheritanceAssembler assembler, MavenProjectHelper projectHelper) {
+        super(assembler);
         this.projectHelper = projectHelper;
     }
 
diff --git a/src/main/java/org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.java b/src/main/java/org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.java
index 1030d63c..9628c6bb 100644
--- a/src/main/java/org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.java
+++ b/src/main/java/org/apache/maven/plugins/site/render/AbstractSiteRenderingMojo.java
@@ -35,6 +35,7 @@ import org.apache.maven.artifact.Artifact;
 import org.apache.maven.doxia.site.Menu;
 import org.apache.maven.doxia.site.MenuItem;
 import org.apache.maven.doxia.site.SiteModel;
+import org.apache.maven.doxia.site.inheritance.SiteModelInheritanceAssembler;
 import org.apache.maven.doxia.siterenderer.DocumentRenderer;
 import org.apache.maven.doxia.siterenderer.DocumentRenderingContext;
 import org.apache.maven.doxia.siterenderer.RendererException;
@@ -49,7 +50,6 @@ import org.apache.maven.model.Reporting;
 import org.apache.maven.plugin.MojoExecution;
 import org.apache.maven.plugin.MojoExecutionException;
 import org.apache.maven.plugin.MojoFailureException;
-import org.apache.maven.plugins.annotations.Component;
 import org.apache.maven.plugins.annotations.Parameter;
 import org.apache.maven.plugins.site.descriptor.AbstractSiteDescriptorMojo;
 import org.apache.maven.reporting.MavenReport;
@@ -94,12 +94,6 @@ public abstract class AbstractSiteRenderingMojo extends AbstractSiteDescriptorMo
     @Parameter
     private Map<String, Object> attributes;
 
-    /**
-     * Site renderer.
-     */
-    @Component
-    protected SiteRenderer siteRenderer;
-
     /**
      * Directory containing generated documentation in source format (Doxia supported markup).
      * This is used to pick up other source docs that might have been generated at build time (by reports or any other
@@ -176,8 +170,21 @@ public abstract class AbstractSiteRenderingMojo extends AbstractSiteDescriptorMo
     @Parameter(defaultValue = "${project.build.outputTimestamp}")
     protected String outputTimestamp;
 
-    @Component
-    protected MavenReportExecutor mavenReportExecutor;
+    /**
+     * Site renderer.
+     */
+    protected final SiteRenderer siteRenderer;
+
+    protected final MavenReportExecutor mavenReportExecutor;
+
+    protected AbstractSiteRenderingMojo(
+            SiteModelInheritanceAssembler assembler,
+            SiteRenderer siteRenderer,
+            MavenReportExecutor mavenReportExecutor) {
+        super(assembler);
+        this.siteRenderer = siteRenderer;
+        this.mavenReportExecutor = mavenReportExecutor;
+    }
 
     /**
      * Gets the input files encoding.
diff --git a/src/main/java/org/apache/maven/plugins/site/render/SiteJarMojo.java b/src/main/java/org/apache/maven/plugins/site/render/SiteJarMojo.java
index 52acd27e..eb6f95c3 100644
--- a/src/main/java/org/apache/maven/plugins/site/render/SiteJarMojo.java
+++ b/src/main/java/org/apache/maven/plugins/site/render/SiteJarMojo.java
@@ -26,6 +26,8 @@ import java.io.IOException;
 import org.apache.maven.archiver.MavenArchiveConfiguration;
 import org.apache.maven.archiver.MavenArchiver;
 import org.apache.maven.artifact.DependencyResolutionRequiredException;
+import org.apache.maven.doxia.site.inheritance.SiteModelInheritanceAssembler;
+import org.apache.maven.doxia.siterenderer.SiteRenderer;
 import org.apache.maven.plugin.MojoExecutionException;
 import org.apache.maven.plugin.MojoFailureException;
 import org.apache.maven.plugins.annotations.LifecyclePhase;
@@ -33,6 +35,7 @@ import org.apache.maven.plugins.annotations.Mojo;
 import org.apache.maven.plugins.annotations.Parameter;
 import org.apache.maven.plugins.annotations.ResolutionScope;
 import org.apache.maven.project.MavenProjectHelper;
+import org.apache.maven.reporting.exec.MavenReportExecutor;
 import org.codehaus.plexus.archiver.ArchiverException;
 import org.codehaus.plexus.archiver.jar.JarArchiver;
 import org.codehaus.plexus.archiver.jar.ManifestException;
@@ -115,7 +118,13 @@ public class SiteJarMojo extends SiteMojo {
     private final JarArchiver jarArchiver;
 
     @Inject
-    public SiteJarMojo(MavenProjectHelper projectHelper, JarArchiver jarArchiver) {
+    public SiteJarMojo(
+            SiteModelInheritanceAssembler assembler,
+            SiteRenderer siteRenderer,
+            MavenReportExecutor mavenReportExecutor,
+            MavenProjectHelper projectHelper,
+            JarArchiver jarArchiver) {
+        super(assembler, siteRenderer, mavenReportExecutor);
         this.projectHelper = projectHelper;
         this.jarArchiver = jarArchiver;
     }
diff --git a/src/main/java/org/apache/maven/plugins/site/render/SiteMojo.java b/src/main/java/org/apache/maven/plugins/site/render/SiteMojo.java
index 4f4b61dc..ea8f171a 100644
--- a/src/main/java/org/apache/maven/plugins/site/render/SiteMojo.java
+++ b/src/main/java/org/apache/maven/plugins/site/render/SiteMojo.java
@@ -18,6 +18,8 @@
  */
 package org.apache.maven.plugins.site.render;
 
+import javax.inject.Inject;
+
 import java.io.File;
 import java.io.IOException;
 import java.util.ArrayList;
@@ -28,9 +30,11 @@ import java.util.Locale;
 import java.util.Map;
 import java.util.TreeMap;
 
+import org.apache.maven.doxia.site.inheritance.SiteModelInheritanceAssembler;
 import org.apache.maven.doxia.siterenderer.DocumentRenderer;
 import org.apache.maven.doxia.siterenderer.DoxiaDocumentRenderer;
 import org.apache.maven.doxia.siterenderer.RendererException;
+import org.apache.maven.doxia.siterenderer.SiteRenderer;
 import org.apache.maven.doxia.siterenderer.SiteRenderingContext;
 import org.apache.maven.doxia.tools.SiteTool;
 import org.apache.maven.execution.MavenSession;
@@ -42,6 +46,7 @@ import org.apache.maven.plugins.annotations.ResolutionScope;
 import org.apache.maven.project.MavenProject;
 import org.apache.maven.reporting.MavenReportException;
 import org.apache.maven.reporting.exec.MavenReportExecution;
+import org.apache.maven.reporting.exec.MavenReportExecutor;
 import org.apache.maven.shared.utils.logging.MessageBuilder;
 
 import static org.apache.maven.shared.utils.logging.MessageUtils.buffer;
@@ -80,6 +85,14 @@ public class SiteMojo extends AbstractSiteRenderingMojo {
     @Parameter(property = "validate", defaultValue = "false")
     private boolean validate;
 
+    @Inject
+    public SiteMojo(
+            SiteModelInheritanceAssembler assembler,
+            SiteRenderer siteRenderer,
+            MavenReportExecutor mavenReportExecutor) {
+        super(assembler, siteRenderer, mavenReportExecutor);
+    }
+
     /**
      * {@inheritDoc}
      */
diff --git a/src/main/java/org/apache/maven/plugins/site/run/SiteRunMojo.java b/src/main/java/org/apache/maven/plugins/site/run/SiteRunMojo.java
index eb2ad981..a8b785a3 100644
--- a/src/main/java/org/apache/maven/plugins/site/run/SiteRunMojo.java
+++ b/src/main/java/org/apache/maven/plugins/site/run/SiteRunMojo.java
@@ -18,6 +18,8 @@
  */
 package org.apache.maven.plugins.site.run;
 
+import javax.inject.Inject;
+
 import java.io.File;
 import java.io.FileOutputStream;
 import java.io.IOException;
@@ -28,7 +30,9 @@ import java.util.List;
 import java.util.Locale;
 import java.util.Map;
 
+import org.apache.maven.doxia.site.inheritance.SiteModelInheritanceAssembler;
 import org.apache.maven.doxia.siterenderer.DocumentRenderer;
+import org.apache.maven.doxia.siterenderer.SiteRenderer;
 import org.apache.maven.doxia.siterenderer.SiteRenderingContext;
 import org.apache.maven.doxia.tools.SiteTool;
 import org.apache.maven.plugin.MojoExecutionException;
@@ -38,6 +42,7 @@ import org.apache.maven.plugins.annotations.Parameter;
 import org.apache.maven.plugins.annotations.ResolutionScope;
 import org.apache.maven.plugins.site.render.AbstractSiteRenderingMojo;
 import org.apache.maven.reporting.exec.MavenReportExecution;
+import org.apache.maven.reporting.exec.MavenReportExecutor;
 import org.codehaus.plexus.util.IOUtil;
 import org.eclipse.jetty.server.Server;
 import org.eclipse.jetty.webapp.WebAppContext;
@@ -71,6 +76,14 @@ public class SiteRunMojo extends AbstractSiteRenderingMojo {
     @Parameter(property = "port", defaultValue = "8080")
     private int port;
 
+    @Inject
+    public SiteRunMojo(
+            SiteModelInheritanceAssembler assembler,
+            SiteRenderer siteRenderer,
+            MavenReportExecutor mavenReportExecutor) {
+        super(assembler, siteRenderer, mavenReportExecutor);
+    }
+
     /**
      * @see org.apache.maven.plugin.AbstractMojo#execute()
      */