Add PdfPublisher test

Author: sdelamo

.gitignore

@@ -36,3 +36,4 @@ target
 
 /.idea/
 /grails-test-suite-uber/configured/
+/grails-docs/src/test/resources/docs/guide/single.pdf

grails-docs/build.gradle

@@ -20,6 +20,7 @@ dependencies {
     runtime "org.slf4j:slf4j-api:$slf4jVersion"
 
     runtime('com.lowagie:itext:2.0.8')
+
     compile 'org.jsoup:jsoup:1.7.3'
     testCompile "junit:junit:$junitVersion"
     testCompile("org.spockframework:spock-core:${spockVersion}") {

grails-docs/src/main/groovy/grails/doc/PdfBuilder.groovy

@@ -65,7 +65,7 @@ class PdfBuilder {
         cleanupHtml(htmlFile, xml)
     }
 
-    static boolean cleanHtml = Boolean.getBoolean("grails.docs.clean.html")
+    static boolean cleanHtml = System.getProperty('grails.docs.clean.html') == null ? true : Boolean.getBoolean("grails.docs.clean.html")
     static boolean debugPdf = Boolean.getBoolean("grails.docs.debug.pdf")
 
     private static String cleanupHtml(File htmlFile, String xml) {
@@ -112,23 +112,27 @@ class PdfBuilder {
          pre, code {
           font-size: 10px;
          } 
-        .contribute-btn, #navigation, #ref-button { display: none; }
+         .toc-item { margin-bottom: 2px; }
+         .toc-item strong { margin-right: 2px; }
+        .contribute-btn, #navigation, #ref-button, #toggle-col1 { display: none; }
                 .paragraph, table, h2, h3, h4, h5, h6, li, pre, code {
             width: 595px;
         }
         </style>
         """
     }
 
-    static void createPdf(String xml, File outputFile, File urlBase) {
-        def dbf = DocumentBuilderFactory.newInstance()
+    static Document createDocument(String xml) {
+        DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance()
         dbf.validating = false
         dbf.setFeature "http://apache.org/xml/features/nonvalidating/load-external-dtd", false
         dbf.setFeature "http://apache.org/xml/features/nonvalidating/load-dtd-grammar", false
-        
+
         DocumentBuilder builder = dbf.newDocumentBuilder()
-        Document doc = builder.parse(new ByteArrayInputStream(xml.getBytes("UTF-8")))
+        builder.parse(new ByteArrayInputStream(xml.getBytes("UTF-8")))
+    }
 
+    static void createPdfWithDocument(Document doc, File outputFile, File urlBase) {
         ITextRenderer renderer = new ITextRenderer()
         renderer.setDocument(doc, urlBase.toURI().toString())
 
@@ -142,4 +146,10 @@ class PdfBuilder {
             outputStream?.close()
         }
     }
+
+    static void createPdf(String xml, File outputFile, File urlBase) {
+        Document doc = createDocument(xml)
+        createPdfWithDocument(doc, outputFile, urlBase)
+
+    }
 }

grails-docs/src/main/groovy/grails/doc/PdfPublisher.groovy

@@ -0,0 +1,18 @@
+package grails.doc
+
+import groovy.transform.CompileStatic
+import org.w3c.dom.Document
+
+@CompileStatic
+class PdfPublisher {
+
+    static void publishPdfFromHtml(File outputDir, String child, String pdfName) {
+        PdfBuilder pdfBuilder = new PdfBuilder()
+        File currFile = new File(outputDir, child)
+        String xml = pdfBuilder.createXml(currFile, outputDir.absolutePath)
+        Document doc = pdfBuilder.createDocument(xml)
+        File outputFile = new File(currFile.parentFile, pdfName)
+        File urlBase = new File(outputDir, "guide/single.html")
+        pdfBuilder.createPdfWithDocument(doc, outputFile, urlBase)
+    }
+}

grails-docs/src/main/groovy/grails/doc/gradle/PublishPdf.groovy

@@ -15,6 +15,7 @@
 package grails.doc.gradle
 
 import grails.doc.PdfBuilder
+import grails.doc.PdfPublisher
 import org.gradle.api.DefaultTask
 import org.gradle.api.tasks.*
 
@@ -30,14 +31,9 @@ class PublishPdf extends DefaultTask {
 
     @TaskAction
     def publish() {
-        def outputDir = new File(outputDirectory, language ?: "")
+        File outputDir = new File(outputDirectory, language ?: "")
         try {
-            def currFile = new File(outputDir, "guide/single.html")
-            def pdfBuilder = new PdfBuilder()
-            def xml = pdfBuilder.createXml(currFile, outputDir.absolutePath)
-            pdfBuilder.createPdf xml,
-                    new File(currFile.parentFile, pdfName),
-                    new File(outputDir, "guide/single.html")
+            PdfPublisher.publishPdfFromHtml(outputDir, "guide/single.html", pdfName)
         }
         catch (Exception ex) {
             ex.printStackTrace()

grails-docs/src/test/groovy/grails/doc/PdfPublisherSpec.groovy

@@ -0,0 +1,28 @@
+package grails.doc
+
+import spock.lang.Specification
+
+class PdfPublisherSpec extends Specification {
+
+    void "generate pdf from sample docs"() {
+        given:
+        String sampleDocsFolderPath = 'src/test/resources/docs'
+        File sampleDocsFolder = new File(sampleDocsFolderPath)
+        String pdfName = 'single.pdf'
+        String child = "guide/single.html"
+
+        expect:
+        sampleDocsFolder.exists()
+        !new File("${sampleDocsFolderPath}/guide/${pdfName}").exists()
+
+        when:
+        PdfPublisher.publishPdfFromHtml(sampleDocsFolder, child, pdfName)
+
+        then:
+        noExceptionThrown()
+        new File("${sampleDocsFolderPath}/guide/${pdfName}").exists()
+
+        cleanup:
+        new File("${sampleDocsFolderPath}/guide/${pdfName}").delete()
+    }
+}

grails-docs/src/test/resources/docs/css/custom-pdf.css

@@ -0,0 +1,3 @@
+/*
+   Dummy stylesheet allowing for some customisation of pdf output without having to copy and modify the other stylesheets.
+*/

grails-docs/src/test/resources/docs/css/custom.css

@@ -0,0 +1,9 @@
+/*
+ Hidden blocks for translations
+*/
+.hidden-block {
+    display: none;
+    background-color: #DED;
+    color: #622;
+    padding: 0.5em 0;
+}