This is an automated email from the ASF dual-hosted git repository. michaelo pushed a commit to branch renames in repository https://gitbox.apache.org/repos/asf/maven-site-plugin.git
commit 45ed5683c93036922b2dcac654331ab51a059e45 Author: Michael Osipov <[email protected]> AuthorDate: Sun Mar 26 22:37:11 2023 +0200 Renames --- pom.xml | 2 +- .../site/render/AbstractSiteRenderingMojo.java | 13 +++++++------ .../render/CategorySummaryDocumentRenderer.java | 14 +++++++------- .../site/render/ReportDocumentRenderer.java | 22 +++++++++++----------- .../apache/maven/plugins/site/run/DoxiaFilter.java | 6 +++--- 5 files changed, 29 insertions(+), 28 deletions(-) diff --git a/pom.xml b/pom.xml index d4929d29..16dc7850 100644 --- a/pom.xml +++ b/pom.xml @@ -198,7 +198,7 @@ under the License. <!-- for dependencies --> <jettyVersion>9.4.50.v20221201</jettyVersion> <doxiaVersion>2.0.0-M6</doxiaVersion> - <doxiaSitetoolsVersion>2.0.0-M6</doxiaSitetoolsVersion> + <doxiaSitetoolsVersion>2.0.0-M7-SNAPSHOT</doxiaSitetoolsVersion> <wagonVersion>3.5.3</wagonVersion> <slf4jVersion>1.7.36</slf4jVersion> <!-- for ITs --> 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 94c9d803..aa8650fa 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 @@ -36,9 +36,9 @@ import org.apache.maven.doxia.site.decoration.DecorationModel; import org.apache.maven.doxia.site.decoration.Menu; import org.apache.maven.doxia.site.decoration.MenuItem; import org.apache.maven.doxia.siterenderer.DocumentRenderer; -import org.apache.maven.doxia.siterenderer.Renderer; +import org.apache.maven.doxia.siterenderer.DocumentRenderingContext; import org.apache.maven.doxia.siterenderer.RendererException; -import org.apache.maven.doxia.siterenderer.RenderingContext; +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.doxia.tools.SiteToolException; @@ -98,7 +98,7 @@ public abstract class AbstractSiteRenderingMojo extends AbstractSiteDescriptorMo * Site renderer. */ @Component - protected Renderer siteRenderer; + protected SiteRenderer siteRenderer; /** * Reports (Maven 2). @@ -352,7 +352,8 @@ public abstract class AbstractSiteRenderingMojo extends AbstractSiteDescriptorMo + mavenReportExecution.getPlugin().getVersion() + ':' + mavenReportExecution.getGoal(); - RenderingContext docRenderingContext = new RenderingContext(siteDirectory, outputName, reportMojoInfo); + DocumentRenderingContext docRenderingContext = + new DocumentRenderingContext(siteDirectory, outputName, reportMojoInfo); DocumentRenderer docRenderer = new ReportDocumentRenderer(mavenReportExecution, docRenderingContext, getLog()); documents.put(outputName, docRenderer); @@ -413,7 +414,7 @@ public abstract class AbstractSiteRenderingMojo extends AbstractSiteDescriptorMo // add "Project Information" category summary document List<MavenReport> categoryReports = categories.get(MavenReport.CATEGORY_PROJECT_INFORMATION); - RenderingContext docRenderingContext = new RenderingContext( + DocumentRenderingContext docRenderingContext = new DocumentRenderingContext( siteDirectory, "project-info.html", getSitePluginInfo() + ":CategorySummaryDocumentRenderer"); String title = i18n.getString("site-plugin", locale, "report.information.title"); String desc1 = i18n.getString("site-plugin", locale, "report.information.description1"); @@ -431,7 +432,7 @@ public abstract class AbstractSiteRenderingMojo extends AbstractSiteDescriptorMo if (categories.containsKey(MavenReport.CATEGORY_PROJECT_REPORTS)) { // add "Project Reports" category summary document List<MavenReport> categoryReports = categories.get(MavenReport.CATEGORY_PROJECT_REPORTS); - RenderingContext docRenderingContext = new RenderingContext( + DocumentRenderingContext docRenderingContext = new DocumentRenderingContext( siteDirectory, "project-reports.html", getSitePluginInfo() + ":CategorySummaryDocumentRenderer"); String title = i18n.getString("site-plugin", locale, "report.project.title"); String desc1 = i18n.getString("site-plugin", locale, "report.project.description1"); diff --git a/src/main/java/org/apache/maven/plugins/site/render/CategorySummaryDocumentRenderer.java b/src/main/java/org/apache/maven/plugins/site/render/CategorySummaryDocumentRenderer.java index 965c16aa..d544b62e 100644 --- a/src/main/java/org/apache/maven/plugins/site/render/CategorySummaryDocumentRenderer.java +++ b/src/main/java/org/apache/maven/plugins/site/render/CategorySummaryDocumentRenderer.java @@ -26,9 +26,9 @@ import java.util.Locale; import org.apache.maven.doxia.sink.Sink; import org.apache.maven.doxia.siterenderer.DocumentRenderer; -import org.apache.maven.doxia.siterenderer.Renderer; +import org.apache.maven.doxia.siterenderer.DocumentRenderingContext; import org.apache.maven.doxia.siterenderer.RendererException; -import org.apache.maven.doxia.siterenderer.RenderingContext; +import org.apache.maven.doxia.siterenderer.SiteRenderer; import org.apache.maven.doxia.siterenderer.SiteRenderingContext; import org.apache.maven.doxia.siterenderer.sink.SiteRendererSink; import org.apache.maven.plugin.logging.Log; @@ -41,7 +41,7 @@ import org.codehaus.plexus.i18n.I18N; * @author <a href="mailto:[email protected]";>Brett Porter</a> */ public class CategorySummaryDocumentRenderer implements DocumentRenderer { - private RenderingContext docRenderingContext; + private DocumentRenderingContext docRenderingContext; private String title; @@ -56,7 +56,7 @@ public class CategorySummaryDocumentRenderer implements DocumentRenderer { private final Log log; public CategorySummaryDocumentRenderer( - RenderingContext docRenderingContext, + DocumentRenderingContext docRenderingContext, String title, String desc1, String desc2, @@ -66,7 +66,7 @@ public class CategorySummaryDocumentRenderer implements DocumentRenderer { } public CategorySummaryDocumentRenderer( - RenderingContext docRenderingContext, + DocumentRenderingContext docRenderingContext, String title, String desc1, String desc2, @@ -82,7 +82,7 @@ public class CategorySummaryDocumentRenderer implements DocumentRenderer { this.log = log; } - public void renderDocument(Writer writer, Renderer siteRenderer, SiteRenderingContext siteRenderingContext) + public void renderDocument(Writer writer, SiteRenderer siteRenderer, SiteRenderingContext siteRenderingContext) throws RendererException, FileNotFoundException { SiteRendererSink sink = new SiteRendererSink(docRenderingContext); @@ -176,7 +176,7 @@ public class CategorySummaryDocumentRenderer implements DocumentRenderer { return docRenderingContext.getOutputName(); } - public RenderingContext getRenderingContext() { + public DocumentRenderingContext getRenderingContext() { return docRenderingContext; } diff --git a/src/main/java/org/apache/maven/plugins/site/render/ReportDocumentRenderer.java b/src/main/java/org/apache/maven/plugins/site/render/ReportDocumentRenderer.java index ba799e61..c574610a 100644 --- a/src/main/java/org/apache/maven/plugins/site/render/ReportDocumentRenderer.java +++ b/src/main/java/org/apache/maven/plugins/site/render/ReportDocumentRenderer.java @@ -30,9 +30,9 @@ import java.util.Locale; import org.apache.maven.doxia.sink.Sink; import org.apache.maven.doxia.sink.SinkFactory; import org.apache.maven.doxia.siterenderer.DocumentRenderer; -import org.apache.maven.doxia.siterenderer.Renderer; +import org.apache.maven.doxia.siterenderer.DocumentRenderingContext; import org.apache.maven.doxia.siterenderer.RendererException; -import org.apache.maven.doxia.siterenderer.RenderingContext; +import org.apache.maven.doxia.siterenderer.SiteRenderer; import org.apache.maven.doxia.siterenderer.SiteRenderingContext; import org.apache.maven.doxia.siterenderer.sink.SiteRendererSink; import org.apache.maven.plugin.logging.Log; @@ -55,7 +55,7 @@ import static org.apache.maven.shared.utils.logging.MessageUtils.buffer; public class ReportDocumentRenderer implements DocumentRenderer { private final MavenReport report; - private final RenderingContext docRenderingContext; + private final DocumentRenderingContext docRenderingContext; private final String reportMojoInfo; @@ -64,7 +64,7 @@ public class ReportDocumentRenderer implements DocumentRenderer { private final Log log; public ReportDocumentRenderer( - MavenReportExecution mavenReportExecution, RenderingContext docRenderingContext, Log log) { + MavenReportExecution mavenReportExecution, DocumentRenderingContext docRenderingContext, Log log) { this.report = mavenReportExecution.getMavenReport(); this.docRenderingContext = docRenderingContext; @@ -86,7 +86,7 @@ public class ReportDocumentRenderer implements DocumentRenderer { private String outputName; - MultiPageSubSink(File outputDir, String outputName, RenderingContext docRenderingContext) { + MultiPageSubSink(File outputDir, String outputName, DocumentRenderingContext docRenderingContext) { super(docRenderingContext); this.outputName = outputName; this.outputDir = outputDir; @@ -108,16 +108,16 @@ public class ReportDocumentRenderer implements DocumentRenderer { private MavenReport report; /** - * The main RenderingContext, which is the base for the RenderingContext of subpages + * The main DocumentRenderingContext, which is the base for the DocumentRenderingContext of subpages */ - private RenderingContext docRenderingContext; + private DocumentRenderingContext docRenderingContext; /** * List of sinks (subpages) associated to this report */ private List<MultiPageSubSink> sinks = new ArrayList<MultiPageSubSink>(); - MultiPageSinkFactory(MavenReport report, RenderingContext docRenderingContext) { + MultiPageSinkFactory(MavenReport report, DocumentRenderingContext docRenderingContext) { this.report = report; this.docRenderingContext = docRenderingContext; } @@ -128,7 +128,7 @@ public class ReportDocumentRenderer implements DocumentRenderer { String outputRelativeToTargetSite = PathTool.getRelativeFilePath( report.getReportOutputDirectory().getPath(), new File(outputDir, outputName).getPath()); - RenderingContext subSinkContext = new RenderingContext( + DocumentRenderingContext subSinkContext = new DocumentRenderingContext( docRenderingContext.getBasedir(), docRenderingContext.getBasedirRelativePath(), outputRelativeToTargetSite, @@ -170,7 +170,7 @@ public class ReportDocumentRenderer implements DocumentRenderer { } @Override - public void renderDocument(Writer writer, Renderer siteRenderer, SiteRenderingContext siteRenderingContext) + public void renderDocument(Writer writer, SiteRenderer siteRenderer, SiteRenderingContext siteRenderingContext) throws RendererException, FileNotFoundException { Locale locale = siteRenderingContext.getLocale(); String localReportName = report.getName(locale); @@ -269,7 +269,7 @@ public class ReportDocumentRenderer implements DocumentRenderer { } @Override - public RenderingContext getRenderingContext() { + public DocumentRenderingContext getRenderingContext() { return docRenderingContext; } diff --git a/src/main/java/org/apache/maven/plugins/site/run/DoxiaFilter.java b/src/main/java/org/apache/maven/plugins/site/run/DoxiaFilter.java index dc4f3fa0..0859a6b6 100644 --- a/src/main/java/org/apache/maven/plugins/site/run/DoxiaFilter.java +++ b/src/main/java/org/apache/maven/plugins/site/run/DoxiaFilter.java @@ -37,8 +37,8 @@ import java.util.Map; import org.apache.maven.doxia.siterenderer.DocumentRenderer; import org.apache.maven.doxia.siterenderer.DoxiaDocumentRenderer; -import org.apache.maven.doxia.siterenderer.Renderer; 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.plugins.site.render.ReportDocumentRenderer; import org.eclipse.jetty.http.MimeTypes; @@ -63,7 +63,7 @@ public class DoxiaFilter implements Filter { private File outputDirectory; - private Renderer siteRenderer; + private SiteRenderer siteRenderer; private Map<String, DoxiaBean> i18nDoxiaContexts; @@ -77,7 +77,7 @@ public class DoxiaFilter implements Filter { outputDirectory = (File) servletContext.getAttribute(OUTPUT_DIRECTORY_KEY); - siteRenderer = (Renderer) servletContext.getAttribute(SITE_RENDERER_KEY); + siteRenderer = (SiteRenderer) servletContext.getAttribute(SITE_RENDERER_KEY); i18nDoxiaContexts = (Map<String, DoxiaBean>) servletContext.getAttribute(I18N_DOXIA_CONTEXTS_KEY);
