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 c56d769a9b35b79211f45ff204f9a8369482a480 Author: Michael Osipov <[email protected]> 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 | 8 +- .../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, 29 insertions(+), 126 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..07fb433 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 @@ -119,7 +119,7 @@ import org.slf4j.LoggerFactory; */ @Singleton @Named -public class DefaultSiteRenderer implements Renderer { +public class DefaultSiteRenderer implements SiteRenderer { private static final Logger LOGGER = LoggerFactory.getLogger(DefaultSiteRenderer.class); // ---------------------------------------------------------------------- @@ -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..2d56253 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:[email protected]";>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 {} 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..e476b01 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:[email protected]";>Emmanuel Venisse</a> */ -public interface Renderer // TODO rename to SiteRenderer - { +public interface SiteRenderer extends Renderer { /** * 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);
