Merge pull request #172 from fnonnenmacher/markdown-exporter

Markdown Exporter (#159)

build.gradle

@@ -32,10 +32,11 @@ apply from: 'scripts/exportVisio.gradle'
 apply from: 'scripts/exportChangelog.gradle'
 apply from: 'scripts/exportJiraIssues.gradle'
 apply from: 'scripts/exportExcel.gradle'
+apply from: 'scripts/exportMarkdown.gradle'
 apply from: 'scripts/pandoc.gradle'
 apply from: 'scripts/publishToConfluence.gradle'
 apply from: 'scripts/htmlSanityCheck.gradle'
 
 // let's set a defaultTask for convenience
 //defaultTasks 'exportChangeLog','exportJiraIssues','asciidoctor'
-defaultTasks 'exportChangeLog', 'generateHTML', 'generatePDF', 'htmlSanityCheck'
+defaultTasks 'exportChangeLog', 'exportMarkdown', 'generateHTML', 'generatePDF', 'htmlSanityCheck'

scripts/exportMarkdown.gradle

@@ -0,0 +1,32 @@
+buildscript {
+    dependencies {
+        //for the markdown conversion
+        classpath 'nl.jworks.markdown_to_asciidoc:markdown_to_asciidoc:1.0'
+    }
+    repositories {
+        jcenter()
+    }
+}
+
+//tag::exportMarkdown[]
+task exportMarkdown(
+        description: 'exports all markdown files to AsciiDoc',
+        group: 'docToolchain',
+        type: Copy
+) {
+    from srcDir
+
+    include("**/*.md") //include only markdown files
+    includeEmptyDirs = false
+    rename(/(.+).md/, '$1.adoc') //rename all files from *.md to *.adoc
+    filter(Markdown2AdocFilter) // convert the content of the files
+
+    into targetDir
+}
+
+class Markdown2AdocFilter extends FilterReader {
+    Markdown2AdocFilter(Reader input) {
+        super(new StringReader(nl.jworks.markdown_to_asciidoc.Converter.convertMarkdownToAsciiDoc(input.text)))
+    }
+}
+//end::exportMarkdown[]

src/docs/exportMarkdownDocs.md

@@ -0,0 +1,5 @@
+# exportMarkdown
+
+The *exportMarkdown* task can be used to include [markdown](http://markdown.de) files into the documentation.
+
+The task is scanning the directory `/src/docs` for markdown files (`*.md`) and converts them into AsciiDoc files.

src/docs/manual.adoc

@@ -98,6 +98,12 @@ include::manual/03_task_exportExcel.adoc[leveloffset=+2]
 
 <<<<
 
+include::manual/03_task_exportMarkdown.adoc[leveloffset=+2]
+
+---
+
+<<<<
+
 include::manual/03_task_htmlSanityCheck.adoc[leveloffset=+2]
 
 ---

src/docs/manual/03_task_exportMarkdown.adoc

@@ -0,0 +1,11 @@
+ifndef::imagesdir[:imagesdir: ../images]
+
+include::../../../build/docs/exportMarkdownDocs.adoc[]
+
+== Source
+
+.exportMarkdown.gradle
+[source,groovy]
+----
+include::../../../scripts/exportMarkdown.gradle[tags=exportMarkdown]
+----

src/docs/manual/05_contributors.adoc

@@ -29,6 +29,7 @@ Here is an incomplete and unordered list of contributors:
 - https://twitter.com/marioggar[Mario García]
 - https://github.com/joex2[Joe]
 - https://github.com/davidmc24[David M. Carr]
+- https://github.com/fnonnenmacher[Fabian Nonnenmacher]
 
 (please update your entry to match your preferences! :-)
 

src/test/groovy/docToolchain/ExportMarkdownSpec.groovy

@@ -0,0 +1,33 @@
+package docToolchain
+
+import org.gradle.testkit.runner.GradleRunner
+import spock.lang.Specification
+
+import static org.gradle.testkit.runner.TaskOutcome.SUCCESS
+
+class ExportMarkdownSpec extends Specification {
+
+
+    public static final File exportedMarkdownFile = new File('./build/docs/exportMarkdownDocs.adoc')
+
+    void 'test conversion of sample markdown file'() {
+
+        given: 'a clean the environment'
+        exportedMarkdownFile.delete()
+
+        when: 'executing the gradle task `exportMarkdown`'
+        def result = GradleRunner.create()
+                .withProjectDir(new File('.'))
+                .withArguments('exportMarkdown')
+                .build()
+
+        then: 'the task has been successfully executed'
+        result.task(":exportMarkdown").outcome == SUCCESS
+
+        and: 'the AsciiDoc file has been created'
+        exportedMarkdownFile.exists()
+
+        and: 'its content is in AsciiDoc syntax'
+        exportedMarkdownFile.text.startsWith('= exportMarkdown')
+    }
+}