Added functionality to render sitemap.xml

pom.xml

@@ -65,6 +65,7 @@
 		<maven.build.timestamp.format>yyyy-MM-dd HH:mm</maven.build.timestamp.format>
 
 		<asciidoctor.java.version>0.1.4</asciidoctor.java.version>
+        <commons.collections.version>3.2.1</commons.collections.version>
 		<commons.io.version>2.4</commons.io.version>
 		<commons.configuration.version>1.9</commons.configuration.version>
 		<args4j.version>2.0.23</args4j.version>
@@ -184,6 +185,11 @@
 		</resources>
 	</build>
 	<dependencies>
+        <dependency>
+            <groupId>commons-collections</groupId>
+            <artifactId>commons-collections</artifactId>
+            <version>${commons.collections.version}</version>
+        </dependency>
 		<dependency>
 			<groupId>commons-io</groupId>
 			<artifactId>commons-io</artifactId>

src/main/java/org/jbake/app/Oven.java

@@ -9,6 +9,8 @@
 import java.util.List;
 import java.util.Map;
 
+import org.apache.commons.collections.CollectionUtils;
+import org.apache.commons.collections.ListUtils;
 import org.apache.commons.configuration.CompositeConfiguration;
 import org.apache.commons.configuration.ConfigurationException;
 import org.apache.commons.configuration.PropertiesConfiguration;
@@ -159,6 +161,11 @@ public void bake() throws Exception {
 			renderer.renderFeed(publishedPosts, config.getString("feed.file"));
 		}
 
+        // write sitemap file
+        if (config.getBoolean("render.sitemap")) {
+            renderer.renderSitemap(ListUtils.union(pages, publishedPosts));
+        }
+
 		// write master archive file
 		if (config.getBoolean("render.archive")) {
 			renderer.renderArchive(publishedPosts, config.getString("archive.file"));

src/main/java/org/jbake/app/Renderer.java

@@ -35,6 +35,8 @@ public class Renderer {
 	private CompositeConfiguration config;
 	private List<Map<String, Object>> posts;
 	private List<Map<String, Object>> pages;
+
+    public static final String SITEMAP_XML_FILE_NAME = "sitemap.xml";
 
 	/**
 	 * Creates a new instance of Renderer with supplied references to folders.
@@ -178,8 +180,33 @@ public void renderFeed(List<Map<String, Object>> posts, String feedFile) {
 			System.out.println("failed!");
 		}
 	}
-
-	/**
+
+    /**
+     * Render an XML sitemap file using the supplied content.
+     *
+     * @param pages     The combined list of pages and posts to render
+     *
+     * @see <a href="https://support.google.com/webmasters/answer/156184?hl=en&ref_topic=8476">About Sitemaps</a>
+     * @see <a href="http://www.sitemaps.org/">Sitemap protocol</a>
+     */
+    public void renderSitemap(List<Map<String, Object>> pages) {
+
+        final File outputFile = new File(destination.getPath() + File.separator + SITEMAP_XML_FILE_NAME);
+        System.out.print("Rendering sitemap [" + outputFile + "]... ");
+
+        Map<String, Object> model = new HashMap<String, Object>();
+        model.put("pages", pages);
+
+        try {
+            render(model, config.getString("template.sitemap.file"), outputFile);
+            System.out.println("done!");
+        } catch (Exception e) {
+            e.printStackTrace();
+            System.out.println("failed!");
+        }
+    }
+
+    /**
 	 * Render an archive file using the supplied content.   
 	 * 
 	 * @param posts			The content to render

src/main/resources/default.properties

@@ -43,4 +43,8 @@ server.port=8820
 # default template file
 base.template=base.zip
 # default asciidoctor options
-asciidoctor.options=source-highlighter=prettify
+asciidoctor.options=source-highlighter=prettify
+# render sitemap.xml file?
+render.sitemap=true
+# filename of sitemap template file
+template.sitemap.file=sitemap.ftl

src/test/java/org/jbake/app/RendererTest.java

@@ -5,11 +5,14 @@
 import java.io.PrintWriter;
 import java.net.URISyntaxException;
 import java.net.URL;
+import java.util.List;
 import java.util.Map;
 import java.util.Scanner;
 
+import org.apache.commons.collections.ListUtils;
 import org.apache.commons.configuration.CompositeConfiguration;
 import org.apache.commons.configuration.PropertiesConfiguration;
+import org.apache.commons.io.FileUtils;
 import org.junit.Assert;
 import org.junit.Before;
 import org.junit.Rule;
@@ -146,7 +149,29 @@ public void renderFeed() throws Exception {
 		Assert.assertTrue(foundFirstTitle);
 		Assert.assertTrue(foundSecondTitle);
 	}
-
+
+    @Test
+    public void renderSitemaps() throws Exception {
+        Crawler crawler = new Crawler(sourceFolder, config);
+        crawler.crawl(new File(sourceFolder.getPath()+File.separator+"content"));
+        Renderer renderer = new Renderer(sourceFolder, destinationFolder, templateFolder, config, crawler.getPosts(), crawler.getPages());
+        renderer.renderSitemap(ListUtils.union(crawler.getPages(), crawler.getPosts()));
+        File outputFile = new File(destinationFolder, "sitemap.xml");
+        Assert.assertTrue(outputFile.exists());
+
+        final String[] lines = FileUtils.readLines(outputFile).toArray(new String[0]);
+
+        Assert.assertTrue(lines[0].trim().equals("<?xml version=\"1.0\" encoding=\"UTF-8\"?>"));
+        Assert.assertTrue(lines[1].trim().startsWith("<urlset"));
+        Assert.assertTrue(lines[2].trim().equals("<url>"));
+        Assert.assertTrue(lines[3].trim().startsWith("<loc>"));
+        Assert.assertTrue(lines[4].trim().startsWith("<lastmod>"));
+
+        Assert.assertTrue(lines[lines.length - 2].trim().equals("</url>"));
+        Assert.assertTrue(lines[lines.length - 1].trim().equals("</urlset>"));
+
+    }
+
 	@Test
 	public void renderArchive() throws Exception {
 		Crawler crawler = new Crawler(sourceFolder, config);

src/test/resources/custom.properties

@@ -10,3 +10,4 @@ archive.file=archive.html
 render.tags=false
 tag.path=tags
 test.property=testing123
+site.host=http://www.jbake.org

src/test/resources/templates/sitemap.ftl

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.sitemaps.org/schemas/sitemap/0.9 http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd">
+<#list pages as page>
+    <url>
+        <loc>${config.site_host}${page.uri}</loc>
+        <lastmod>${page.date?string("yyyy-MM-dd")}</lastmod>
+    </url>
+</#list>
+</urlset>