This is an automated email from the ASF dual-hosted git repository.
michaelo pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-site-plugin.git
commit 961f83fe5492c27c3e751ba86219cb3b5c09fb0a
Author: Michael Osipov <micha...@apache.org>
AuthorDate: Sun Mar 19 22:49:21 2023 +0100
Properly distinguish variable names between different rendering contexts
and renderers
---
.../site/render/AbstractSiteRenderingMojo.java | 32 +++++++--------
.../render/CategorySummaryDocumentRenderer.java | 20 +++++-----
.../site/render/ReportDocumentRenderer.java | 46 +++++++++++-----------
.../apache/maven/plugins/site/run/DoxiaFilter.java | 32 +++++++--------
4 files changed, 65 insertions(+), 65 deletions(-)
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 1d1041e9..6577b7b6 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
@@ -365,10 +365,10 @@ public abstract class AbstractSiteRenderingMojo extends
AbstractSiteDescriptorMo
+ mavenReportExecution.getPlugin().getVersion()
+ ':'
+ mavenReportExecution.getGoal();
- RenderingContext renderingContext = new
RenderingContext(siteDirectory, outputName, reportMojoInfo);
- DocumentRenderer renderer =
- new ReportDocumentRenderer(mavenReportExecution,
renderingContext, getLog());
- documents.put(outputName, renderer);
+ RenderingContext docRenderingContext = new
RenderingContext(siteDirectory, outputName, reportMojoInfo);
+ DocumentRenderer docRenderer =
+ new ReportDocumentRenderer(mavenReportExecution,
docRenderingContext, getLog());
+ documents.put(outputName, docRenderer);
}
}
return reportsByOutputName;
@@ -426,36 +426,36 @@ public abstract class AbstractSiteRenderingMojo extends
AbstractSiteDescriptorMo
// add "Project Information" category summary document
List<MavenReport> categoryReports =
categories.get(MavenReport.CATEGORY_PROJECT_INFORMATION);
- RenderingContext renderingContext = new RenderingContext(
+ RenderingContext docRenderingContext = new RenderingContext(
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");
String desc2 = i18n.getString("site-plugin", locale,
"report.information.description2");
- DocumentRenderer renderer = new CategorySummaryDocumentRenderer(
- renderingContext, title, desc1, desc2, i18n,
categoryReports, getLog());
+ DocumentRenderer docRenderer = new CategorySummaryDocumentRenderer(
+ docRenderingContext, title, desc1, desc2, i18n,
categoryReports, getLog());
- if (!documents.containsKey(renderer.getOutputName())) {
- documents.put(renderer.getOutputName(), renderer);
+ if (!documents.containsKey(docRenderer.getOutputName())) {
+ documents.put(docRenderer.getOutputName(), docRenderer);
} else {
- getLog().info("Category summary '" + renderer.getOutputName()
+ "' skipped; already exists");
+ getLog().info("Category summary '" +
docRenderer.getOutputName() + "' skipped; already exists");
}
}
if (categories.containsKey(MavenReport.CATEGORY_PROJECT_REPORTS)) {
// add "Project Reports" category summary document
List<MavenReport> categoryReports =
categories.get(MavenReport.CATEGORY_PROJECT_REPORTS);
- RenderingContext renderingContext = new RenderingContext(
+ RenderingContext docRenderingContext = new RenderingContext(
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");
String desc2 = i18n.getString("site-plugin", locale,
"report.project.description2");
- DocumentRenderer renderer = new CategorySummaryDocumentRenderer(
- renderingContext, title, desc1, desc2, i18n,
categoryReports, getLog());
+ DocumentRenderer docRenderer = new CategorySummaryDocumentRenderer(
+ docRenderingContext, title, desc1, desc2, i18n,
categoryReports, getLog());
- if (!documents.containsKey(renderer.getOutputName())) {
- documents.put(renderer.getOutputName(), renderer);
+ if (!documents.containsKey(docRenderer.getOutputName())) {
+ documents.put(docRenderer.getOutputName(), docRenderer);
} else {
- getLog().info("Category summary '" + renderer.getOutputName()
+ "' skipped; already exists");
+ getLog().info("Category summary '" +
docRenderer.getOutputName() + "' skipped; already exists");
}
}
return documents;
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 32777d67..965c16aa 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
@@ -41,7 +41,7 @@ import org.codehaus.plexus.i18n.I18N;
* @author <a href="mailto:br...@apache.org";>Brett Porter</a>
*/
public class CategorySummaryDocumentRenderer implements DocumentRenderer {
- private RenderingContext renderingContext;
+ private RenderingContext docRenderingContext;
private String title;
@@ -56,24 +56,24 @@ public class CategorySummaryDocumentRenderer implements
DocumentRenderer {
private final Log log;
public CategorySummaryDocumentRenderer(
- RenderingContext renderingContext,
+ RenderingContext docRenderingContext,
String title,
String desc1,
String desc2,
I18N i18n,
List<MavenReport> categoryReports) {
- this(renderingContext, title, desc1, desc2, i18n, categoryReports,
null);
+ this(docRenderingContext, title, desc1, desc2, i18n, categoryReports,
null);
}
public CategorySummaryDocumentRenderer(
- RenderingContext renderingContext,
+ RenderingContext docRenderingContext,
String title,
String desc1,
String desc2,
I18N i18n,
List<MavenReport> categoryReports,
Log log) {
- this.renderingContext = renderingContext;
+ this.docRenderingContext = docRenderingContext;
this.title = title;
this.desc1 = desc1;
this.desc2 = desc2;
@@ -82,9 +82,9 @@ public class CategorySummaryDocumentRenderer implements
DocumentRenderer {
this.log = log;
}
- public void renderDocument(Writer writer, Renderer renderer,
SiteRenderingContext siteRenderingContext)
+ public void renderDocument(Writer writer, Renderer siteRenderer,
SiteRenderingContext siteRenderingContext)
throws RendererException, FileNotFoundException {
- SiteRendererSink sink = new SiteRendererSink(renderingContext);
+ SiteRendererSink sink = new SiteRendererSink(docRenderingContext);
sink.head();
@@ -169,15 +169,15 @@ public class CategorySummaryDocumentRenderer implements
DocumentRenderer {
sink.close();
- renderer.mergeDocumentIntoSite(writer, sink, siteRenderingContext);
+ siteRenderer.mergeDocumentIntoSite(writer, sink, siteRenderingContext);
}
public String getOutputName() {
- return renderingContext.getOutputName();
+ return docRenderingContext.getOutputName();
}
public RenderingContext getRenderingContext() {
- return renderingContext;
+ return docRenderingContext;
}
public boolean isOverwrite() {
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 147789b5..ba799e61 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
@@ -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 renderingContext;
+ private final RenderingContext docRenderingContext;
private final String reportMojoInfo;
@@ -64,10 +64,10 @@ public class ReportDocumentRenderer implements
DocumentRenderer {
private final Log log;
public ReportDocumentRenderer(
- MavenReportExecution mavenReportExecution, RenderingContext
renderingContext, Log log) {
+ MavenReportExecution mavenReportExecution, RenderingContext
docRenderingContext, Log log) {
this.report = mavenReportExecution.getMavenReport();
- this.renderingContext = renderingContext;
+ this.docRenderingContext = docRenderingContext;
// full MavenReportExecution prepared by maven-reporting-impl
this.reportMojoInfo = mavenReportExecution.getPlugin().getArtifactId()
@@ -86,8 +86,8 @@ public class ReportDocumentRenderer implements
DocumentRenderer {
private String outputName;
- MultiPageSubSink(File outputDir, String outputName, RenderingContext
context) {
- super(context);
+ MultiPageSubSink(File outputDir, String outputName, RenderingContext
docRenderingContext) {
+ super(docRenderingContext);
this.outputName = outputName;
this.outputDir = outputDir;
}
@@ -110,34 +110,34 @@ public class ReportDocumentRenderer implements
DocumentRenderer {
/**
* The main RenderingContext, which is the base for the
RenderingContext of subpages
*/
- private RenderingContext context;
+ private RenderingContext docRenderingContext;
/**
* List of sinks (subpages) associated to this report
*/
private List<MultiPageSubSink> sinks = new
ArrayList<MultiPageSubSink>();
- MultiPageSinkFactory(MavenReport report, RenderingContext context) {
+ MultiPageSinkFactory(MavenReport report, RenderingContext
docRenderingContext) {
this.report = report;
- this.context = context;
+ this.docRenderingContext = docRenderingContext;
}
@Override
public Sink createSink(File outputDir, String outputName) {
- // Create a new context, similar to the main one, but with a
different output name
+ // Create a new document rendering context, similar to the main
one, but with a different output name
String outputRelativeToTargetSite = PathTool.getRelativeFilePath(
report.getReportOutputDirectory().getPath(), new
File(outputDir, outputName).getPath());
RenderingContext subSinkContext = new RenderingContext(
- context.getBasedir(),
- context.getBasedirRelativePath(),
+ docRenderingContext.getBasedir(),
+ docRenderingContext.getBasedirRelativePath(),
outputRelativeToTargetSite,
- context.getParserId(),
- context.getExtension(),
- context.isEditable(),
- context.getGenerator());
+ docRenderingContext.getParserId(),
+ docRenderingContext.getExtension(),
+ docRenderingContext.isEditable(),
+ docRenderingContext.getGenerator());
- // Create a sink for this subpage, based on this new context
+ // Create a sink for this subpage, based on this new document
rendering context
MultiPageSubSink sink = new MultiPageSubSink(outputDir,
outputName, subSinkContext);
// Add it to the list of sinks associated to this report
@@ -170,7 +170,7 @@ public class ReportDocumentRenderer implements
DocumentRenderer {
}
@Override
- public void renderDocument(Writer writer, Renderer renderer,
SiteRenderingContext siteRenderingContext)
+ public void renderDocument(Writer writer, Renderer siteRenderer,
SiteRenderingContext siteRenderingContext)
throws RendererException, FileNotFoundException {
Locale locale = siteRenderingContext.getLocale();
String localReportName = report.getName(locale);
@@ -185,9 +185,9 @@ public class ReportDocumentRenderer implements
DocumentRenderer {
// CHECKSTYLE_ON: MagicNumber
// main sink
- SiteRendererSink mainSink = new SiteRendererSink(renderingContext);
+ SiteRendererSink mainSink = new SiteRendererSink(docRenderingContext);
// sink factory, for multi-page reports that need sub-sinks
- MultiPageSinkFactory multiPageSinkFactory = new
MultiPageSinkFactory(report, renderingContext);
+ MultiPageSinkFactory multiPageSinkFactory = new
MultiPageSinkFactory(report, docRenderingContext);
ClassLoader originalClassLoader =
Thread.currentThread().getContextClassLoader();
try {
@@ -228,7 +228,7 @@ public class ReportDocumentRenderer implements
DocumentRenderer {
}
// render main sink document content
- renderer.mergeDocumentIntoSite(writer, mainSink, siteRenderingContext);
+ siteRenderer.mergeDocumentIntoSite(writer, mainSink,
siteRenderingContext);
// render sub-sinks, eventually created by multi-page reports
String outputName = "";
@@ -249,7 +249,7 @@ public class ReportDocumentRenderer implements
DocumentRenderer {
File outputFile = new File(mySink.getOutputDir(), outputName);
try (Writer out = WriterFactory.newWriter(outputFile,
siteRenderingContext.getOutputEncoding())) {
- renderer.mergeDocumentIntoSite(out, mySink,
siteRenderingContext);
+ siteRenderer.mergeDocumentIntoSite(out, mySink,
siteRenderingContext);
mySink.close();
mySink = null;
} finally {
@@ -265,12 +265,12 @@ public class ReportDocumentRenderer implements
DocumentRenderer {
@Override
public String getOutputName() {
- return renderingContext.getOutputName();
+ return docRenderingContext.getOutputName();
}
@Override
public RenderingContext getRenderingContext() {
- return renderingContext;
+ return docRenderingContext;
}
@Override
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 a2bfd594..dc4f3fa0 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
@@ -139,17 +139,17 @@ public class DoxiaFilter implements Filter {
//
----------------------------------------------------------------------
if (documents.containsKey(path)) {
try {
- DocumentRenderer renderer = documents.get(path);
- logDocumentRenderer(path, renderer);
- String outputName = renderer.getOutputName();
+ DocumentRenderer docRenderer = documents.get(path);
+ logDocumentRenderer(path, docRenderer);
+ String outputName = docRenderer.getOutputName();
String contentType =
MimeTypes.getDefaultMimeByExtension(outputName);
if (contentType != null) {
servletResponse.setContentType(contentType);
}
- renderer.renderDocument(servletResponse.getWriter(),
siteRenderer, context);
+ docRenderer.renderDocument(servletResponse.getWriter(),
siteRenderer, context);
- if (renderer instanceof ReportDocumentRenderer) {
- ReportDocumentRenderer reportDocumentRenderer =
(ReportDocumentRenderer) renderer;
+ if (docRenderer instanceof ReportDocumentRenderer) {
+ ReportDocumentRenderer reportDocumentRenderer =
(ReportDocumentRenderer) docRenderer;
if (reportDocumentRenderer.isExternalReport()) {
Path externalReportFile =
outputDirectory.toPath().resolve(outputName);
servletResponse.reset();
@@ -170,14 +170,14 @@ public class DoxiaFilter implements Filter {
siteRenderer.locateDocumentFiles(generatedSiteContext,
false);
if (locateDocuments.containsKey(path)) {
- DocumentRenderer renderer = locateDocuments.get(path);
- logDocumentRenderer(path, renderer);
- String outputName = renderer.getOutputName();
+ DocumentRenderer docRenderer = locateDocuments.get(path);
+ logDocumentRenderer(path, docRenderer);
+ String outputName = docRenderer.getOutputName();
String contentType =
MimeTypes.getDefaultMimeByExtension(outputName);
if (contentType != null) {
servletResponse.setContentType(contentType);
}
- renderer.renderDocument(servletResponse.getWriter(),
siteRenderer, generatedSiteContext);
+ docRenderer.renderDocument(servletResponse.getWriter(),
siteRenderer, generatedSiteContext);
return;
}
@@ -189,16 +189,16 @@ public class DoxiaFilter implements Filter {
filterChain.doFilter(servletRequest, servletResponse);
}
- private void logDocumentRenderer(String path, DocumentRenderer renderer) {
+ private void logDocumentRenderer(String path, DocumentRenderer
docRenderer) {
String source;
- if (renderer instanceof DoxiaDocumentRenderer) {
- DoxiaDocumentRenderer doxiaDocumentRenderer =
(DoxiaDocumentRenderer) renderer;
+ if (docRenderer instanceof DoxiaDocumentRenderer) {
+ DoxiaDocumentRenderer doxiaDocumentRenderer =
(DoxiaDocumentRenderer) docRenderer;
source =
doxiaDocumentRenderer.getRenderingContext().getInputName();
- } else if (renderer instanceof ReportDocumentRenderer) {
- ReportDocumentRenderer reportDocumentRenderer =
(ReportDocumentRenderer) renderer;
+ } else if (docRenderer instanceof ReportDocumentRenderer) {
+ ReportDocumentRenderer reportDocumentRenderer =
(ReportDocumentRenderer) docRenderer;
source = reportDocumentRenderer.getReportMojoInfo();
} else {
- source = renderer.getClass().getName();
+ source = docRenderer.getClass().getName();
}
servletContext.log(path + " -> " + buffer().strong(source));
}
