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 728dc59ad7ccc3c50ca3ce3ab0ca5c215b00d5c7 Author: Michael Osipov <[email protected]> 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 07fb433..4210b34 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 SiteRenderer { 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 SiteRenderer { // ----------------------------------------------------------------------- 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 SiteRenderer { } } - files.put(key, new DoxiaDocumentRenderer(context)); + files.put(key, new DoxiaDocumentRenderer(docRenderingContext)); } } } @@ -272,11 +275,11 @@ public class DefaultSiteRenderer implements SiteRenderer { 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 SiteRenderer { } /** {@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 SiteRenderer { } 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 SiteRenderer { /** * 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:[email protected]";>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:[email protected]";>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:[email protected]";>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 e476b01..ef2a836 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 extends Renderer { * @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()); } }
