You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by mi...@apache.org on 2023/03/26 22:10:45 UTC
[maven-doxia-sitetools] branch renames updated (728dc59 -> cbdf4d4)
This is an automated email from the ASF dual-hosted git repository.
michaelo pushed a change to branch renames
in repository https://gitbox.apache.org/repos/asf/maven-doxia-sitetools.git
discard 728dc59 [DOXIASITETOOLS-296] Rename o.a.m.doxia.siterenderer.RenderingContext to o.a.m.doxia.siterenderer.DocumentRenderingContext
discard c56d769 [DOXIASITETOOLS-295] Rename o.a.m.doxia.siterenderer.Renderer to o.a.m.doxia.siterenderer.SiteRenderer
new 0034091 [DOXIASITETOOLS-295] Rename o.a.m.doxia.siterenderer.Renderer to o.a.m.doxia.siterenderer.SiteRenderer
new cbdf4d4 [DOXIASITETOOLS-296] Rename o.a.m.doxia.siterenderer.RenderingContext to o.a.m.doxia.siterenderer.DocumentRenderingContext
This update added new revisions after undoing existing revisions.
That is to say, some revisions that were in the old version of the
branch are not in the new version. This situation occurs
when a user --force pushes a change and generates a repository
containing something like this:
* -- * -- B -- O -- O -- O (728dc59)
\
N -- N -- N refs/heads/renames (cbdf4d4)
You should already have received notification emails for all of the O
revisions, and so the following emails describe only the N revisions
from the common base, B.
Any revisions marked "omit" are not gone; other references still
refer to them. Any revisions marked "discard" are gone forever.
The 2 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
.../java/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.java | 2 +-
.../src/main/java/org/apache/maven/doxia/siterenderer/Renderer.java | 2 +-
.../src/main/java/org/apache/maven/doxia/siterenderer/SiteRenderer.java | 2 +-
3 files changed, 3 insertions(+), 3 deletions(-)
[maven-doxia-sitetools] 02/02: [DOXIASITETOOLS-296] Rename o.a.m.doxia.siterenderer.RenderingContext to o.a.m.doxia.siterenderer.DocumentRenderingContext
Posted by mi...@apache.org.
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-doxia-sitetools.git
commit cbdf4d49f982ddae00e4b9ef134e846a1ab452fa
Author: Michael Osipov <mi...@apache.org>
AuthorDate: Sat Mar 18 17:05:06 2023 +0100
[DOXIASITETOOLS-296] Rename o.a.m.doxia.siterenderer.RenderingContext to o.a.m.doxia.siterenderer.DocumentRenderingContext
---
.../doxia/siterenderer/DefaultSiteRenderer.java | 38 ++++++++++++----------
.../maven/doxia/siterenderer/DocumentContent.java | 2 +-
.../maven/doxia/siterenderer/DocumentRenderer.java | 8 ++---
...gContext.java => DocumentRenderingContext.java} | 13 ++++----
.../doxia/siterenderer/DoxiaDocumentRenderer.java | 18 +++++-----
.../maven/doxia/siterenderer/SiteRenderer.java | 2 +-
.../doxia/siterenderer/sink/SiteRendererSink.java | 24 +++++++-------
.../siterenderer/DefaultSiteRendererTest.java | 19 ++++++-----
.../doxia/siterenderer/RenderingContextTest.java | 37 +++++++++++----------
9 files changed, 84 insertions(+), 77 deletions(-)
diff --git a/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.java b/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.java
index 235bb02..ecaf5ce 100644
--- a/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.java
+++ b/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.java
@@ -220,23 +220,24 @@ public class DefaultSiteRenderer implements Renderer {
docs.addAll(velocityFiles);
for (String doc : docs) {
- RenderingContext context = new RenderingContext(
+ DocumentRenderingContext docRenderingContext = new DocumentRenderingContext(
moduleBasedir, moduleRelativePath, doc, module.getParserId(), extension, editable);
// TODO: DOXIA-111: we need a general filter here that knows how to alter the context
if (endsWithIgnoreCase(doc, ".vm")) {
- context.setAttribute("velocity", "true");
+ docRenderingContext.setAttribute("velocity", "true");
}
- String key = context.getOutputName();
+ String key = docRenderingContext.getOutputName();
key = StringUtils.replace(key, "\\", "/");
if (files.containsKey(key)) {
DocumentRenderer docRenderer = files.get(key);
- RenderingContext originalContext = docRenderer.getRenderingContext();
+ DocumentRenderingContext originalDocRenderingContext = docRenderer.getRenderingContext();
- File originalDoc = new File(originalContext.getBasedir(), originalContext.getInputName());
+ File originalDoc = new File(
+ originalDocRenderingContext.getBasedir(), originalDocRenderingContext.getInputName());
throw new RendererException("File '" + module.getSourceDirectory() + File.separator + doc
+ "' clashes with existing '" + originalDoc + "'.");
@@ -246,9 +247,11 @@ public class DefaultSiteRenderer implements Renderer {
// -----------------------------------------------------------------------
for (Map.Entry<String, DocumentRenderer> entry : files.entrySet()) {
if (entry.getKey().equalsIgnoreCase(key)) {
- RenderingContext originalContext = entry.getValue().getRenderingContext();
+ DocumentRenderingContext originalDocRenderingContext =
+ entry.getValue().getRenderingContext();
- File originalDoc = new File(originalContext.getBasedir(), originalContext.getInputName());
+ File originalDoc = new File(
+ originalDocRenderingContext.getBasedir(), originalDocRenderingContext.getInputName());
if (Os.isFamily(Os.FAMILY_WINDOWS)) {
throw new RendererException("File '" + module.getSourceDirectory() + File.separator + doc
@@ -262,7 +265,7 @@ public class DefaultSiteRenderer implements Renderer {
}
}
- files.put(key, new DoxiaDocumentRenderer(context));
+ files.put(key, new DoxiaDocumentRenderer(docRenderingContext));
}
}
}
@@ -272,11 +275,11 @@ public class DefaultSiteRenderer implements Renderer {
Collection<DocumentRenderer> documents, SiteRenderingContext siteRenderingContext, File outputDirectory)
throws RendererException, IOException {
for (DocumentRenderer docRenderer : documents) {
- RenderingContext renderingContext = docRenderer.getRenderingContext();
+ DocumentRenderingContext docRenderingContext = docRenderer.getRenderingContext();
File outputFile = new File(outputDirectory, docRenderer.getOutputName());
- File inputFile = new File(renderingContext.getBasedir(), renderingContext.getInputName());
+ File inputFile = new File(docRenderingContext.getBasedir(), docRenderingContext.getInputName());
boolean modified = !outputFile.exists()
|| (inputFile.lastModified() > outputFile.lastModified())
@@ -309,7 +312,8 @@ public class DefaultSiteRenderer implements Renderer {
}
/** {@inheritDoc} */
- public void renderDocument(Writer writer, RenderingContext docRenderingContext, SiteRenderingContext siteContext)
+ public void renderDocument(
+ Writer writer, DocumentRenderingContext docRenderingContext, SiteRenderingContext siteContext)
throws RendererException, FileNotFoundException, UnsupportedEncodingException {
SiteRendererSink sink = new SiteRendererSink(docRenderingContext);
@@ -389,7 +393,7 @@ public class DefaultSiteRenderer implements Renderer {
}
private void saveVelocityProcessedContent(
- RenderingContext docRenderingContext, SiteRenderingContext siteContext, String doxiaContent)
+ DocumentRenderingContext docRenderingContext, SiteRenderingContext siteContext, String doxiaContent)
throws IOException {
if (!siteContext.getProcessedContentOutput().exists()) {
siteContext.getProcessedContentOutput().mkdirs();
@@ -462,23 +466,23 @@ public class DefaultSiteRenderer implements Renderer {
/**
* Create a Velocity Context for a Doxia document, containing every information about rendered document.
*
- * @param renderingContext the document's RenderingContext
+ * @param docRenderingContext the document's rendering context
* @param siteRenderingContext the site rendering context
* @return a Velocity tools managed context
*/
protected Context createDocumentVelocityContext(
- RenderingContext renderingContext, SiteRenderingContext siteRenderingContext) {
+ DocumentRenderingContext docRenderingContext, SiteRenderingContext siteRenderingContext) {
Context context = createToolManagedVelocityContext(siteRenderingContext);
// ----------------------------------------------------------------------
// Data objects
// ----------------------------------------------------------------------
- context.put("relativePath", renderingContext.getRelativePath());
+ context.put("relativePath", docRenderingContext.getRelativePath());
- String currentFileName = renderingContext.getOutputName().replace('\\', '/');
+ String currentFileName = docRenderingContext.getOutputName().replace('\\', '/');
context.put("currentFileName", currentFileName);
- context.put("alignedFileName", PathTool.calculateLink(currentFileName, renderingContext.getRelativePath()));
+ context.put("alignedFileName", PathTool.calculateLink(currentFileName, docRenderingContext.getRelativePath()));
context.put("decoration", siteRenderingContext.getDecoration());
diff --git a/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DocumentContent.java b/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DocumentContent.java
index 8b799bc..9d50b2b 100644
--- a/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DocumentContent.java
+++ b/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DocumentContent.java
@@ -60,5 +60,5 @@ public interface DocumentContent {
* Get the document rendering context.
* @return the document rendering context
*/
- RenderingContext getRenderingContext();
+ DocumentRenderingContext getRenderingContext();
}
diff --git a/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DocumentRenderer.java b/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DocumentRenderer.java
index a1b1ebe..3047ef1 100644
--- a/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DocumentRenderer.java
+++ b/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DocumentRenderer.java
@@ -26,7 +26,7 @@ import java.io.Writer;
* Renders a page in a site, whatever the source is: a Doxia source file, a report or anything else.
*
* @author <a href="mailto:brett@apache.org">Brett Porter</a>
- * @see RenderingContext document rendering context
+ * @see DocumentRenderingContext document rendering context
*/
public interface DocumentRenderer {
/**
@@ -50,11 +50,11 @@ public interface DocumentRenderer {
String getOutputName();
/**
- * Return the RenderingContext of the document.
+ * Return the rendering context of the document.
*
- * @return RenderingContext.
+ * @return DocumentRenderingContext.
*/
- RenderingContext getRenderingContext();
+ DocumentRenderingContext getRenderingContext();
/**
* Whether to always overwrite the document, or only do so when it is changed.
diff --git a/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/RenderingContext.java b/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DocumentRenderingContext.java
similarity index 95%
rename from doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/RenderingContext.java
rename to doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DocumentRenderingContext.java
index 0c31c1d..4923895 100644
--- a/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/RenderingContext.java
+++ b/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DocumentRenderingContext.java
@@ -32,8 +32,7 @@ import org.codehaus.plexus.util.StringUtils;
* @author <a href="mailto:jason@maven.org">Jason van Zyl</a>
* @since 1.5 (was since 1.1 in o.a.m.d.sink.render)
*/
-public class RenderingContext // TODO rename to DocumentRenderingContext
- {
+public class DocumentRenderingContext {
private final File basedir;
private final String basedirRelativePath;
@@ -56,7 +55,7 @@ public class RenderingContext // TODO rename to DocumentRenderingContext
/**
* <p>
- * Constructor for RenderingContext when document is not rendered from a Doxia markup source.
+ * Constructor for rendering context when document is not rendered from a Doxia markup source.
* </p>
*
* @param basedir the pseudo-source base directory.
@@ -65,11 +64,11 @@ public class RenderingContext // TODO rename to DocumentRenderingContext
* @param generator the generator (in general a reporting goal: <code>groupId:artifactId:version:goal</code>)
* @since 1.8
*/
- public RenderingContext(File basedir, String document, String generator) {
+ public DocumentRenderingContext(File basedir, String document, String generator) {
this(basedir, null, document, null, null, false, generator);
}
- public RenderingContext(
+ public DocumentRenderingContext(
File basedir,
String basedirRelativePath,
String document,
@@ -81,7 +80,7 @@ public class RenderingContext // TODO rename to DocumentRenderingContext
/**
* <p>
- * Constructor for document RenderingContext.
+ * Constructor for document rendering context.
* </p>
*
* @param basedir the source base directory (not null, pseudo value when not a Doxia source).
@@ -95,7 +94,7 @@ public class RenderingContext // TODO rename to DocumentRenderingContext
* @param generator the generator (in general a reporting goal: <code>groupId:artifactId:version:goal</code>)
* @since 1.8
*/
- public RenderingContext(
+ public DocumentRenderingContext(
File basedir,
String basedirRelativePath,
String document,
diff --git a/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DoxiaDocumentRenderer.java b/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DoxiaDocumentRenderer.java
index 0184c6f..a2dfeea 100644
--- a/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DoxiaDocumentRenderer.java
+++ b/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DoxiaDocumentRenderer.java
@@ -24,37 +24,37 @@ import java.io.Writer;
/**
* Renderer for a document that has a source file to be parsed by Doxia.
- * Details about the source file are in {@link RenderingContext}, which is expected to have
+ * Details about the source file are in {@link DocumentRenderingContext}, which is expected to have
* a non-null parserId and extension.
*
* @author <a href="mailto:brett@apache.org">Brett Porter</a>
*/
public class DoxiaDocumentRenderer implements DocumentRenderer {
- private RenderingContext renderingContext;
+ private DocumentRenderingContext docRenderingContext;
/**
* Constructor.
*
- * @param renderingContext the document's RenderingContext to use.
+ * @param docRenderingContext the document's rendering context to use.
*/
- public DoxiaDocumentRenderer(RenderingContext renderingContext) {
- this.renderingContext = renderingContext;
+ public DoxiaDocumentRenderer(DocumentRenderingContext docRenderingContext) {
+ this.docRenderingContext = docRenderingContext;
}
/** {@inheritDoc} */
public void renderDocument(Writer writer, SiteRenderer siteRenderer, SiteRenderingContext siteRenderingContext)
throws RendererException, FileNotFoundException, UnsupportedEncodingException {
- siteRenderer.renderDocument(writer, renderingContext, siteRenderingContext);
+ siteRenderer.renderDocument(writer, docRenderingContext, siteRenderingContext);
}
/** {@inheritDoc} */
public String getOutputName() {
- return renderingContext.getOutputName();
+ return docRenderingContext.getOutputName();
}
/** {@inheritDoc} */
- public RenderingContext getRenderingContext() {
- return renderingContext;
+ public DocumentRenderingContext getRenderingContext() {
+ return docRenderingContext;
}
/** {@inheritDoc} */
diff --git a/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/SiteRenderer.java b/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/SiteRenderer.java
index 73f0076..3230a80 100644
--- a/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/SiteRenderer.java
+++ b/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/SiteRenderer.java
@@ -112,6 +112,6 @@ public interface SiteRenderer {
* @throws FileNotFoundException if it bombs.
* @throws UnsupportedEncodingException if it bombs.
*/
- void renderDocument(Writer writer, RenderingContext docRenderingContext, SiteRenderingContext siteContext)
+ void renderDocument(Writer writer, DocumentRenderingContext docRenderingContext, SiteRenderingContext siteContext)
throws RendererException, FileNotFoundException, UnsupportedEncodingException;
}
diff --git a/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/sink/SiteRendererSink.java b/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/sink/SiteRendererSink.java
index 6904da8..3bed852 100644
--- a/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/sink/SiteRendererSink.java
+++ b/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/sink/SiteRendererSink.java
@@ -26,7 +26,7 @@ import java.util.List;
import org.apache.maven.doxia.markup.HtmlMarkup;
import org.apache.maven.doxia.module.xhtml5.Xhtml5Sink;
import org.apache.maven.doxia.siterenderer.DocumentContent;
-import org.apache.maven.doxia.siterenderer.RenderingContext;
+import org.apache.maven.doxia.siterenderer.DocumentRenderingContext;
import org.apache.maven.doxia.util.HtmlTools;
import org.codehaus.plexus.util.StringUtils;
@@ -49,29 +49,29 @@ public class SiteRendererSink extends Xhtml5Sink implements DocumentContent {
private final Writer writer;
- private RenderingContext renderingContext;
+ private DocumentRenderingContext docRenderingContext;
/**
* Construct a new SiteRendererSink for a document.
*
- * @param renderingContext the document's RenderingContext.
+ * @param docRenderingContext the document's rendering context.
*/
- public SiteRendererSink(RenderingContext renderingContext) {
- this(new StringWriter(), renderingContext);
+ public SiteRendererSink(DocumentRenderingContext docRenderingContext) {
+ this(new StringWriter(), docRenderingContext);
}
/**
* Construct a new SiteRendererSink for a document.
*
* @param writer the writer for the sink.
- * @param renderingContext the document's RenderingContext.
+ * @param docRenderingContext the document's rendering context.
*/
- private SiteRendererSink(StringWriter writer, RenderingContext renderingContext) {
+ private SiteRendererSink(StringWriter writer, DocumentRenderingContext docRenderingContext) {
super(writer);
this.writer = writer;
this.headWriter = new StringWriter();
- this.renderingContext = renderingContext;
+ this.docRenderingContext = docRenderingContext;
/* the template is expected to have used the main tag, which can be used only once */
super.contentStack.push(HtmlMarkup.MAIN);
@@ -177,8 +177,8 @@ public class SiteRendererSink extends Xhtml5Sink implements DocumentContent {
return;
}
- if (renderingContext != null) {
- String relativePathToBasedir = renderingContext.getRelativePath();
+ if (docRenderingContext != null) {
+ String relativePathToBasedir = docRenderingContext.getRelativePath();
if (relativePathToBasedir == null) {
txt = StringUtils.replace(txt, "$relativePath", ".");
@@ -222,7 +222,7 @@ public class SiteRendererSink extends Xhtml5Sink implements DocumentContent {
}
/** {@inheritDoc} */
- public RenderingContext getRenderingContext() {
- return renderingContext;
+ public DocumentRenderingContext getRenderingContext() {
+ return docRenderingContext;
}
}
diff --git a/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/DefaultSiteRendererTest.java b/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/DefaultSiteRendererTest.java
index 8e67270..910c06a 100644
--- a/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/DefaultSiteRendererTest.java
+++ b/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/DefaultSiteRendererTest.java
@@ -152,10 +152,11 @@ public class DefaultSiteRendererTest {
SiteRenderer siteRenderer = container.lookup(SiteRenderer.class);
ReflectionUtils.setVariableValueInObject(siteRenderer, "doxia", doxiaSpy);
- RenderingContext renderingContext = new RenderingContext(testBasedir, "", testDocumentName, "xdoc", "", false);
+ DocumentRenderingContext docRenderingContext =
+ new DocumentRenderingContext(testBasedir, "", testDocumentName, "xdoc", "", false);
try {
- siteRenderer.renderDocument(null, renderingContext, new SiteRenderingContext());
+ siteRenderer.renderDocument(null, docRenderingContext, new SiteRenderingContext());
fail("should fail with exception");
} catch (RendererException e) {
assertEquals(
@@ -182,10 +183,11 @@ public class DefaultSiteRendererTest {
SiteRenderer siteRenderer = container.lookup(SiteRenderer.class);
ReflectionUtils.setVariableValueInObject(siteRenderer, "doxia", doxiaSpy);
- RenderingContext renderingContext = new RenderingContext(testBasedir, "", testDocumentName, "xdoc", "", false);
+ DocumentRenderingContext docRenderingContext =
+ new DocumentRenderingContext(testBasedir, "", testDocumentName, "xdoc", "", false);
try {
- siteRenderer.renderDocument(null, renderingContext, new SiteRenderingContext());
+ siteRenderer.renderDocument(null, docRenderingContext, new SiteRenderingContext());
fail("should fail with exception");
} catch (RendererException e) {
assertEquals(
@@ -245,7 +247,7 @@ public class DefaultSiteRendererTest {
when(docRenderer.isExternalReport()).thenReturn(true);
when(docRenderer.getOutputName()).thenReturn("external/index");
when(docRenderer.getRenderingContext())
- .thenReturn(new RenderingContext(new File(""), "index.html", "generator:external"));
+ .thenReturn(new DocumentRenderingContext(new File(""), "index.html", "generator:external"));
SiteRenderingContext context = new SiteRenderingContext();
@@ -272,8 +274,9 @@ public class DefaultSiteRendererTest {
siteRenderingContext.setTemplateProperties(attributes);
siteRenderingContext.setTemplateName("org/apache/maven/doxia/siterenderer/velocity-toolmanager.vm");
- RenderingContext context = new RenderingContext(new File(""), "document.html", "generator");
- SiteRendererSink sink = new SiteRendererSink(context);
+ DocumentRenderingContext docRenderingContext =
+ new DocumentRenderingContext(new File(""), "document.html", "generator");
+ SiteRendererSink sink = new SiteRendererSink(docRenderingContext);
siteRenderer.mergeDocumentIntoSite(writer, sink, siteRenderingContext);
String renderResult = writer.toString();
@@ -302,7 +305,7 @@ public class DefaultSiteRendererTest {
skin.setFile(skinFile);
SiteRenderingContext siteRenderingContext =
siteRenderer.createContextForSkin(skin, attributes, new DecorationModel(), "defaultitle", Locale.ROOT);
- RenderingContext context = new RenderingContext(new File(""), "document.html", "generator");
+ DocumentRenderingContext context = new DocumentRenderingContext(new File(""), "document.html", "generator");
SiteRendererSink sink = new SiteRendererSink(context);
siteRenderer.mergeDocumentIntoSite(writer, sink, siteRenderingContext);
String renderResult = writer.toString();
diff --git a/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/RenderingContextTest.java b/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/RenderingContextTest.java
index 283eb20..c3f4f58 100644
--- a/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/RenderingContextTest.java
+++ b/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/RenderingContextTest.java
@@ -43,33 +43,34 @@ public class RenderingContextTest {
File baseDir = new File(getBasedir() + File.separatorChar + "test" + File.separatorChar + "resources");
String docName = "file.with.dot.in.name.xml";
- RenderingContext renderingContext = new RenderingContext(baseDir, "test", docName, "", "xml", false);
- assertEquals("file.with.dot.in.name.html", renderingContext.getOutputName());
- assertEquals(".", renderingContext.getRelativePath());
+ DocumentRenderingContext docRenderingContext =
+ new DocumentRenderingContext(baseDir, "test", docName, "", "xml", false);
+ assertEquals("file.with.dot.in.name.html", docRenderingContext.getOutputName());
+ assertEquals(".", docRenderingContext.getRelativePath());
- renderingContext = new RenderingContext(baseDir, docName, "generator"); // not Doxia source
- assertEquals("file.with.dot.in.name.html", renderingContext.getOutputName());
- assertEquals(".", renderingContext.getRelativePath());
+ docRenderingContext = new DocumentRenderingContext(baseDir, docName, "generator"); // not Doxia source
+ assertEquals("file.with.dot.in.name.html", docRenderingContext.getOutputName());
+ assertEquals(".", docRenderingContext.getRelativePath());
docName = "index.xml.vm";
- renderingContext = new RenderingContext(baseDir, "test", docName, "", "xml", false);
- assertEquals("index.html", renderingContext.getOutputName());
- assertEquals(".", renderingContext.getRelativePath());
+ docRenderingContext = new DocumentRenderingContext(baseDir, "test", docName, "", "xml", false);
+ assertEquals("index.html", docRenderingContext.getOutputName());
+ assertEquals(".", docRenderingContext.getRelativePath());
docName = "download.apt.vm";
- renderingContext = new RenderingContext(baseDir, "test", docName, "", "apt", false);
- assertEquals("download.html", renderingContext.getOutputName());
- assertEquals(".", renderingContext.getRelativePath());
+ docRenderingContext = new DocumentRenderingContext(baseDir, "test", docName, "", "apt", false);
+ assertEquals("download.html", docRenderingContext.getOutputName());
+ assertEquals(".", docRenderingContext.getRelativePath());
docName = "path/file.apt";
- renderingContext = new RenderingContext(baseDir, "test", docName, "", "apt", false);
- assertEquals("path/file.html", renderingContext.getOutputName());
- assertEquals("..", renderingContext.getRelativePath());
+ docRenderingContext = new DocumentRenderingContext(baseDir, "test", docName, "", "apt", false);
+ assertEquals("path/file.html", docRenderingContext.getOutputName());
+ assertEquals("..", docRenderingContext.getRelativePath());
- renderingContext = new RenderingContext(baseDir, docName, "generator");
- assertEquals("path/file.html", renderingContext.getOutputName());
- assertEquals("..", renderingContext.getRelativePath());
+ docRenderingContext = new DocumentRenderingContext(baseDir, docName, "generator");
+ assertEquals("path/file.html", docRenderingContext.getOutputName());
+ assertEquals("..", docRenderingContext.getRelativePath());
}
}
[maven-doxia-sitetools] 01/02: [DOXIASITETOOLS-295] Rename o.a.m.doxia.siterenderer.Renderer to o.a.m.doxia.siterenderer.SiteRenderer
Posted by mi...@apache.org.
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-doxia-sitetools.git
commit 0034091dab8fdcb5e6945351e99ee783eb9e633e
Author: Michael Osipov <mi...@apache.org>
AuthorDate: Sat Mar 18 16:43:22 2023 +0100
[DOXIASITETOOLS-295] Rename o.a.m.doxia.siterenderer.Renderer to o.a.m.doxia.siterenderer.SiteRenderer
---
.../doxia/siterenderer/DefaultSiteRenderer.java | 6 +-
.../maven/doxia/siterenderer/DocumentRenderer.java | 2 +-
.../doxia/siterenderer/DoxiaDocumentRenderer.java | 2 +-
.../apache/maven/doxia/siterenderer/Renderer.java | 97 +---------------------
.../{Renderer.java => SiteRenderer.java} | 3 +-
.../siterenderer/DefaultSiteRendererTest.java | 43 +++++-----
6 files changed, 28 insertions(+), 125 deletions(-)
diff --git a/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.java b/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.java
index 94b72c7..235bb02 100644
--- a/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.java
+++ b/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DefaultSiteRenderer.java
@@ -145,7 +145,7 @@ public class DefaultSiteRenderer implements Renderer {
private static final String DOXIA_SITE_RENDERER_VERSION = getSiteRendererVersion();
// ----------------------------------------------------------------------
- // Renderer implementation
+ // SiteRenderer implementation
// ----------------------------------------------------------------------
/** {@inheritDoc} */
@@ -232,9 +232,9 @@ public class DefaultSiteRenderer implements Renderer {
key = StringUtils.replace(key, "\\", "/");
if (files.containsKey(key)) {
- DocumentRenderer renderer = files.get(key);
+ DocumentRenderer docRenderer = files.get(key);
- RenderingContext originalContext = renderer.getRenderingContext();
+ RenderingContext originalContext = docRenderer.getRenderingContext();
File originalDoc = new File(originalContext.getBasedir(), originalContext.getInputName());
diff --git a/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DocumentRenderer.java b/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DocumentRenderer.java
index c8443a1..a1b1ebe 100644
--- a/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DocumentRenderer.java
+++ b/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DocumentRenderer.java
@@ -39,7 +39,7 @@ public interface DocumentRenderer {
* @throws java.io.FileNotFoundException if it bombs.
* @throws java.io.UnsupportedEncodingException if it bombs.
*/
- void renderDocument(Writer writer, Renderer siteRenderer, SiteRenderingContext siteRenderingContext)
+ void renderDocument(Writer writer, SiteRenderer siteRenderer, SiteRenderingContext siteRenderingContext)
throws RendererException, FileNotFoundException, UnsupportedEncodingException;
/**
diff --git a/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DoxiaDocumentRenderer.java b/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DoxiaDocumentRenderer.java
index f2b0eb4..0184c6f 100644
--- a/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DoxiaDocumentRenderer.java
+++ b/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/DoxiaDocumentRenderer.java
@@ -42,7 +42,7 @@ public class DoxiaDocumentRenderer implements DocumentRenderer {
}
/** {@inheritDoc} */
- public void renderDocument(Writer writer, Renderer siteRenderer, SiteRenderingContext siteRenderingContext)
+ public void renderDocument(Writer writer, SiteRenderer siteRenderer, SiteRenderingContext siteRenderingContext)
throws RendererException, FileNotFoundException, UnsupportedEncodingException {
siteRenderer.renderDocument(writer, renderingContext, siteRenderingContext);
}
diff --git a/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/Renderer.java b/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/Renderer.java
index a327184..4d1a3e4 100644
--- a/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/Renderer.java
+++ b/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/Renderer.java
@@ -18,101 +18,10 @@
*/
package org.apache.maven.doxia.siterenderer;
-import java.io.File;
-import java.io.FileNotFoundException;
-import java.io.IOException;
-import java.io.UnsupportedEncodingException;
-import java.io.Writer;
-import java.util.Collection;
-import java.util.Locale;
-import java.util.Map;
-
-import org.apache.maven.artifact.Artifact;
-import org.apache.maven.doxia.site.decoration.DecorationModel;
-
/**
* Site Renderer interface: render a collection of documents into a site, ie decorated with a site template.
*
- * @author <a href="mailto:evenisse@codehaus.org">Emmanuel Venisse</a>
+ * @deprecated use {@link SiteRenderer}
*/
-public interface Renderer // TODO rename to SiteRenderer
- {
- /**
- * Render a collection of documents into a site.
- *
- * @param documents the documents to render.
- * @param siteRenderingContext the SiteRenderingContext to use.
- * @param outputDirectory the output directory to write results.
- * @throws RendererException if it bombs.
- * @throws IOException if it bombs.
- */
- void render(Collection<DocumentRenderer> documents, SiteRenderingContext siteRenderingContext, File outputDirectory)
- throws RendererException, IOException;
-
- /**
- * Generate a document output integrated in a site from a document content,
- * i.e. merge the document content into the site template.
- *
- * @param writer the Writer to use.
- * @param content the document content to be merged.
- * @param siteRenderingContext the SiteRenderingContext to use.
- * @throws RendererException if it bombs.
- * @since 1.8
- */
- void mergeDocumentIntoSite(Writer writer, DocumentContent content, SiteRenderingContext siteRenderingContext)
- throws RendererException;
-
- /**
- * Create a Site Rendering Context for a site using a skin.
- *
- * @param skin a skin
- * @param attributes attributes to use
- * @param decoration a decoration model
- * @param defaultTitle default title
- * @param locale locale to use
- * @return a SiteRenderingContext.
- * @throws RendererException if it bombs.
- * @throws java.io.IOException if it bombs.
- * @since 1.7.3 was previously with skin as File instead of Artifact
- */
- SiteRenderingContext createContextForSkin(
- Artifact skin, Map<String, ?> attributes, DecorationModel decoration, String defaultTitle, Locale locale)
- throws RendererException, IOException;
-
- /**
- * Copy resource files from skin, template, and site resources.
- *
- * @param siteRenderingContext the SiteRenderingContext to use.
- * @param outputDirectory output directory as file
- * @throws IOException if it bombs.
- * @since 1.7
- */
- void copyResources(SiteRenderingContext siteRenderingContext, File outputDirectory) throws IOException;
-
- /**
- * Locate Doxia document source files in the site source context.
- *
- * @param siteRenderingContext the SiteRenderingContext to use
- * @param editable Doxia document renderer as editable? (should not set editable if generated Doxia source)
- * @return the Doxia document renderers in a Map keyed by output file name.
- * @throws IOException if it bombs.
- * @throws RendererException if it bombs.
- * @since 1.8
- */
- Map<String, DocumentRenderer> locateDocumentFiles(SiteRenderingContext siteRenderingContext, boolean editable)
- throws IOException, RendererException;
-
- /**
- * Render a document written in a Doxia markup language. This method is an internal method, used by
- * {@link DoxiaDocumentRenderer}.
- *
- * @param writer the writer to render the document to.
- * @param docRenderingContext the document's rendering context, which is expected to have a non-null parser id.
- * @param siteContext the site's rendering context
- * @throws RendererException if it bombs.
- * @throws FileNotFoundException if it bombs.
- * @throws UnsupportedEncodingException if it bombs.
- */
- void renderDocument(Writer writer, RenderingContext docRenderingContext, SiteRenderingContext siteContext)
- throws RendererException, FileNotFoundException, UnsupportedEncodingException;
-}
+@Deprecated
+public interface Renderer extends SiteRenderer {}
diff --git a/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/Renderer.java b/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/SiteRenderer.java
similarity index 98%
copy from doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/Renderer.java
copy to doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/SiteRenderer.java
index a327184..73f0076 100644
--- a/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/Renderer.java
+++ b/doxia-site-renderer/src/main/java/org/apache/maven/doxia/siterenderer/SiteRenderer.java
@@ -35,8 +35,7 @@ import org.apache.maven.doxia.site.decoration.DecorationModel;
*
* @author <a href="mailto:evenisse@codehaus.org">Emmanuel Venisse</a>
*/
-public interface Renderer // TODO rename to SiteRenderer
- {
+public interface SiteRenderer {
/**
* Render a collection of documents into a site.
*
diff --git a/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/DefaultSiteRendererTest.java b/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/DefaultSiteRendererTest.java
index 1d6b97b..8e67270 100644
--- a/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/DefaultSiteRendererTest.java
+++ b/doxia-site-renderer/src/test/java/org/apache/maven/doxia/siterenderer/DefaultSiteRendererTest.java
@@ -85,14 +85,9 @@ public class DefaultSiteRendererTest {
private static final String OUTPUT = "target/output";
/**
- * The renderer used to produce output.
+ * The site renderer used to produce output.
*/
- private Renderer renderer;
-
- /**
- * The locale before executing tests.
- */
- private Locale oldLocale;
+ private SiteRenderer siteRenderer;
@Inject
private PlexusContainer container;
@@ -106,7 +101,7 @@ public class DefaultSiteRendererTest {
*/
@BeforeEach
protected void setUp() throws Exception {
- renderer = (Renderer) container.lookup(Renderer.class);
+ siteRenderer = (SiteRenderer) container.lookup(SiteRenderer.class);
InputStream skinIS = getClass().getResourceAsStream("velocity-toolmanager.vm");
JarOutputStream jarOS = new JarOutputStream(new FileOutputStream(skinJar));
@@ -137,7 +132,7 @@ public class DefaultSiteRendererTest {
*/
@AfterEach
protected void tearDown() throws Exception {
- container.release(renderer);
+ container.release(siteRenderer);
}
/**
@@ -154,13 +149,13 @@ public class DefaultSiteRendererTest {
Mockito.doThrow(new ParseException(exceptionMessage))
.when(doxiaSpy)
.parse(Mockito.<Reader>any(), Mockito.anyString(), Mockito.<Sink>any(), Mockito.anyString());
- Renderer renderer = container.lookup(Renderer.class);
- ReflectionUtils.setVariableValueInObject(renderer, "doxia", doxiaSpy);
+ SiteRenderer siteRenderer = container.lookup(SiteRenderer.class);
+ ReflectionUtils.setVariableValueInObject(siteRenderer, "doxia", doxiaSpy);
RenderingContext renderingContext = new RenderingContext(testBasedir, "", testDocumentName, "xdoc", "", false);
try {
- renderer.renderDocument(null, renderingContext, new SiteRenderingContext());
+ siteRenderer.renderDocument(null, renderingContext, new SiteRenderingContext());
fail("should fail with exception");
} catch (RendererException e) {
assertEquals(
@@ -184,13 +179,13 @@ public class DefaultSiteRendererTest {
Mockito.doThrow(new ParseException(exceptionMessage, 42, 36))
.when(doxiaSpy)
.parse(Mockito.<Reader>any(), Mockito.anyString(), Mockito.<Sink>any(), Mockito.anyString());
- Renderer renderer = container.lookup(Renderer.class);
- ReflectionUtils.setVariableValueInObject(renderer, "doxia", doxiaSpy);
+ SiteRenderer siteRenderer = container.lookup(SiteRenderer.class);
+ ReflectionUtils.setVariableValueInObject(siteRenderer, "doxia", doxiaSpy);
RenderingContext renderingContext = new RenderingContext(testBasedir, "", testDocumentName, "xdoc", "", false);
try {
- renderer.renderDocument(null, renderingContext, new SiteRenderingContext());
+ siteRenderer.renderDocument(null, renderingContext, new SiteRenderingContext());
fail("should fail with exception");
} catch (RendererException e) {
assertEquals(
@@ -217,11 +212,11 @@ public class DefaultSiteRendererTest {
SiteRenderingContext ctxt = getSiteRenderingContext(decoration, "src/test/resources/site", false);
ctxt.setRootDirectory(getTestFile(""));
- renderer.render(renderer.locateDocumentFiles(ctxt, true).values(), ctxt, getTestFile(OUTPUT));
+ siteRenderer.render(siteRenderer.locateDocumentFiles(ctxt, true).values(), ctxt, getTestFile(OUTPUT));
ctxt = getSiteRenderingContext(decoration, "src/test/resources/site-validate", true);
ctxt.setRootDirectory(getTestFile(""));
- renderer.render(renderer.locateDocumentFiles(ctxt, true).values(), ctxt, getTestFile(OUTPUT));
+ siteRenderer.render(siteRenderer.locateDocumentFiles(ctxt, true).values(), ctxt, getTestFile(OUTPUT));
// ----------------------------------------------------------------------
// Verify specific pages
@@ -254,9 +249,9 @@ public class DefaultSiteRendererTest {
SiteRenderingContext context = new SiteRenderingContext();
- renderer.render(Collections.singletonList(docRenderer), context, new File("target/output"));
+ siteRenderer.render(Collections.singletonList(docRenderer), context, new File("target/output"));
- verify(docRenderer).renderDocument(isNull(Writer.class), eq(renderer), eq(context));
+ verify(docRenderer).renderDocument(isNull(Writer.class), eq(siteRenderer), eq(context));
}
@Test
@@ -279,7 +274,7 @@ public class DefaultSiteRendererTest {
siteRenderingContext.setTemplateName("org/apache/maven/doxia/siterenderer/velocity-toolmanager.vm");
RenderingContext context = new RenderingContext(new File(""), "document.html", "generator");
SiteRendererSink sink = new SiteRendererSink(context);
- renderer.mergeDocumentIntoSite(writer, sink, siteRenderingContext);
+ siteRenderer.mergeDocumentIntoSite(writer, sink, siteRenderingContext);
String renderResult = writer.toString();
String expectedResult = IOUtils.toString(
@@ -306,10 +301,10 @@ public class DefaultSiteRendererTest {
"org.group", "artifact", VersionRange.createFromVersion("1.1"), null, "jar", "", null);
skin.setFile(skinFile);
SiteRenderingContext siteRenderingContext =
- renderer.createContextForSkin(skin, attributes, new DecorationModel(), "defaultitle", Locale.ROOT);
+ siteRenderer.createContextForSkin(skin, attributes, new DecorationModel(), "defaultitle", Locale.ROOT);
RenderingContext context = new RenderingContext(new File(""), "document.html", "generator");
SiteRendererSink sink = new SiteRendererSink(context);
- renderer.mergeDocumentIntoSite(writer, sink, siteRenderingContext);
+ siteRenderer.mergeDocumentIntoSite(writer, sink, siteRenderingContext);
String renderResult = writer.toString();
String expectedResult = StringUtils.unifyLineSeparators(IOUtils.toString(
getClass().getResourceAsStream("velocity-toolmanager.expected.txt"), StandardCharsets.UTF_8));
@@ -318,7 +313,7 @@ public class DefaultSiteRendererTest {
@Test
public void testMatchVersion() throws Exception {
- DefaultSiteRenderer r = (DefaultSiteRenderer) renderer;
+ DefaultSiteRenderer r = (DefaultSiteRenderer) siteRenderer;
assertTrue(r.matchVersion("1.7", "1.7"));
assertFalse(r.matchVersion("1.7", "1.8"));
}
@@ -334,7 +329,7 @@ public class DefaultSiteRendererTest {
"org.group", "artifact", VersionRange.createFromVersion("1.1"), null, "jar", "", null);
skin.setFile(skinFile);
SiteRenderingContext siteRenderingContext =
- renderer.createContextForSkin(skin, attributes, decoration, "defaultTitle", Locale.ROOT);
+ siteRenderer.createContextForSkin(skin, attributes, decoration, "defaultTitle", Locale.ROOT);
siteRenderingContext.addSiteDirectory(getTestFile(siteDir));
siteRenderingContext.setValidate(validate);