commit 3c1fbd6c3ad267c67577cfcbd294207dc6785508 Author: Robert Winkler Date: Thu Feb 19 16:34:38 2015 +0100 Initial commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..27709626 --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +.idea +*.iml +.gradle +build diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 00000000..b6629ec5 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,7 @@ +language: java +jdk: + - oraclejdk7 +before_install: + - chmod +x gradlew +after_success: +- ./gradlew jacocoTestReport coveralls \ No newline at end of file diff --git a/README.adoc b/README.adoc new file mode 100644 index 00000000..a2cbd027 --- /dev/null +++ b/README.adoc @@ -0,0 +1,31 @@ += MarkupDocBuilder +:author: Robert Winkler +:version: 0.1.0 +:hardbreaks: + +== Overview + +This project is a Markup document builder (AsciiDoc and Markdown). The primary goal of this project is to simplify the creation of Markup documents. + +The project requires at least JDK 7. + +=== Usage +The MarkupDocBuilder allows to build an AsciiDoc or Markdown document via the Builder pattern. You can create +[source,java] +---- +MarkupDocBuilder builder = MarkupDocBuilders.documentBuilder(MarkupLanguage.ASCIIDOC); +builder.documentTitle("Test title").textLine("Text line").writeToFile("/tmp", "test.adoc", StandardCharsets.UTF_8); + +MarkupDocBuilder builder = MarkupDocBuilders.documentBuilder(MarkupLanguage.Markdown); +builder.documentTitle("Test title").textLine("Text line").writeToFile("/tmp", "test.adoc", StandardCharsets.UTF_8); +---- + +It can also create Tables and source code listings. + +```java +DocumentBuilder builder = DocumentBuilders.documentBuilder(MarkupLanguage.ASCIIDOC); +builder.documentTitle("Test title").textLine("Text line").writeToFile("/tmp", "test.adoc", StandardCharsets.UTF_8); + +DocumentBuilder builder = DocumentBuilders.documentBuilder(MarkupLanguage.MARKDOWN); +builder.documentTitle("Test title").source("Java code", "java").paragraph("Long text paragaph with line breaks").writeToFile("/tmp", "test.adoc", StandardCharsets.UTF_8); +``` diff --git a/RELEASENOTES.adoc b/RELEASENOTES.adoc new file mode 100644 index 00000000..0364153b --- /dev/null +++ b/RELEASENOTES.adoc @@ -0,0 +1,4 @@ += Release Notes + +== Version 0.1.0 +* Initial version with support for AsciiDoc and Markdown \ No newline at end of file diff --git a/build.gradle b/build.gradle new file mode 100644 index 00000000..7027e3f9 --- /dev/null +++ b/build.gradle @@ -0,0 +1,98 @@ +buildscript { + repositories { + jcenter() + mavenCentral() + } + dependencies { + classpath 'org.asciidoctor:asciidoctor-gradle-plugin:1.5.2' + classpath 'org.asciidoctor:asciidoctorj-pdf:1.5.0-alpha.6' + classpath 'io.spring.gradle:dependency-management-plugin:0.3.1.RELEASE' + classpath 'org.kt3k.gradle.plugin:coveralls-gradle-plugin:2.0.1' + classpath 'org.asciidoctor:asciidoctorj:1.5.2' + classpath 'com.jfrog.bintray.gradle:gradle-bintray-plugin:1.0' + } +} +description = 'A Markup (Markdown, AsciiDoc) document builder' +version = '0.1.0' +group = 'io.github.robwin' + +apply plugin: 'java' +apply plugin: 'maven-publish' +apply plugin: 'org.asciidoctor.convert' +apply plugin: 'jacoco' +apply plugin: 'com.github.kt3k.coveralls' +apply plugin: 'io.spring.dependency-management' +apply plugin: 'com.jfrog.bintray' +apply from: 'gradle/publishing.gradle' + +tasks.withType(JavaCompile) { + sourceCompatibility = "1.7" + targetCompatibility = "1.7" + options.deprecation = true + options.encoding = 'UTF-8' + options.compilerArgs << "-Xlint:unchecked" +} + +repositories { + jcenter() + mavenCentral() +} + +dependencies { + compile 'commons-io:commons-io' + compile 'ch.qos.logback:logback-classic' + testCompile 'junit:junit' +} + +dependencyManagement { + dependencies { + "commons-io:commons-io" "2.4" + "ch.qos.logback:logback-classic" "1.1.2" + "junit:junit" "4.11" + } +} + +task sourcesJar(type: Jar, dependsOn: classes) { + classifier = 'sources' + from sourceSets.main.allSource +} + +task javadocJar(type: Jar, dependsOn: javadoc) { + classifier = 'javadoc' + from javadoc.destinationDir +} + +artifacts { + archives sourcesJar + archives javadocJar +} + +asciidoctor { + backends = ['html5', 'pdf'] + attributes = [ + doctype: 'book', + toc: 'left', + toclevels: '2', + numbered: '' + ] + sourceDir "build/tmp" +} + +jacocoTestReport { + reports { + xml.enabled = true // coveralls plugin depends on xml format report + html.enabled = true + } +} + +tasks.coveralls { + dependsOn 'check' +} + +tasks.asciidoctor { + dependsOn 'check' +} + +task wrapper(type: Wrapper) { + gradleVersion = '2.2.1' +} \ No newline at end of file diff --git a/gradle/publishing.gradle b/gradle/publishing.gradle new file mode 100644 index 00000000..1e22c3e2 --- /dev/null +++ b/gradle/publishing.gradle @@ -0,0 +1,77 @@ +import java.text.SimpleDateFormat + +Date buildTimeAndDate = new Date() +ext { + buildDate = new SimpleDateFormat('yyyy-MM-dd').format(buildTimeAndDate) + buildTime = new SimpleDateFormat('HH:mm:ss.SSSZ').format(buildTimeAndDate) +} + +def projectArtifactId = 'swagger2markup' + +jar { + manifest { + attributes( + 'Built-By': 'Robert Winkler', + 'Created-By': System.properties['java.version'] + " (" + System.properties['java.vendor'] + " " + System.properties['java.vm.version'] + ")", + 'Build-Date': project.buildDate, + 'Build-Time': project.buildTime, + 'Specification-Title': projectArtifactId, + 'Specification-Version': project.version, + 'Implementation-Title': projectArtifactId, + 'Implementation-Version': project.version + ) + } +} + +if (!project.hasProperty('bintrayUsername')) ext.bintrayUsername = '' +if (!project.hasProperty('bintrayApiKey')) ext.bintrayApiKey = '' + +bintray { + user = project.bintrayUsername + key = project.bintrayApiKey + publications = ['mavenJava'] + pkg { + repo = 'maven' + name = 'swagger2markup' + websiteUrl = 'https://github.com/RobWin/markup-document-builder' + issueTrackerUrl = 'https://github.com/RobWin/markup-document-builder/issues' + vcsUrl = 'https://github.com/RobWin/markup-document-builder.git' + desc = 'A Markup (Markdown, AsciiDoc) document builder.' + licenses = ['Apache-2.0'] + version { + vcsTag = project.version + } + } +} + +publishing { + publications { + mavenJava(MavenPublication) { + from components.java + pom.withXml { + def devs = ['RobWin': 'Robert Winkler'] + def root = asNode() + root.appendNode('name', 'markup-document-builder') + root.appendNode('packaging', 'jar') + root.appendNode('url', 'https://github.com/RobWin/markup-document-builder') + root.appendNode('description', 'A Markup (Markdown, AsciiDoc) document builder.') + + def license = root.appendNode('licenses').appendNode('license') + license.appendNode('name', 'Apache-2.0') + license.appendNode('url', 'https://github.com/RobWin/markup-document-builder/blob/master/LICENSE.txt') + license.appendNode('distribution', 'repo') + + root.appendNode('scm').appendNode('url', 'https://github.com/RobWin/markup-document-builder.git') + + def developers = root.appendNode('developers') + devs.each { + def d = developers.appendNode('developer') + d.appendNode('id', it.key) + d.appendNode('name', it.value) + } + } + artifact sourcesJar + artifact javadocJar + } + } +} \ No newline at end of file diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 00000000..b7612167 Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 00000000..7df92f21 --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,6 @@ +#Thu Feb 19 15:49:46 CET 2015 +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-2.0-all.zip diff --git a/gradlew b/gradlew new file mode 100644 index 00000000..91a7e269 --- /dev/null +++ b/gradlew @@ -0,0 +1,164 @@ +#!/usr/bin/env bash + +############################################################################## +## +## Gradle start up script for UN*X +## +############################################################################## + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS="" + +APP_NAME="Gradle" +APP_BASE_NAME=`basename "$0"` + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD="maximum" + +warn ( ) { + echo "$*" +} + +die ( ) { + echo + echo "$*" + echo + exit 1 +} + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +case "`uname`" in + CYGWIN* ) + cygwin=true + ;; + Darwin* ) + darwin=true + ;; + MINGW* ) + msys=true + ;; +esac + +# For Cygwin, ensure paths are in UNIX format before anything is touched. +if $cygwin ; then + [ -n "$JAVA_HOME" ] && JAVA_HOME=`cygpath --unix "$JAVA_HOME"` +fi + +# Attempt to set APP_HOME +# Resolve links: $0 may be a link +PRG="$0" +# Need this for relative symlinks. +while [ -h "$PRG" ] ; do + ls=`ls -ld "$PRG"` + link=`expr "$ls" : '.*-> \(.*\)$'` + if expr "$link" : '/.*' > /dev/null; then + PRG="$link" + else + PRG=`dirname "$PRG"`"/$link" + fi +done +SAVED="`pwd`" +cd "`dirname \"$PRG\"`/" >&- +APP_HOME="`pwd -P`" +cd "$SAVED" >&- + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD="$JAVA_HOME/jre/sh/java" + else + JAVACMD="$JAVA_HOME/bin/java" + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD="java" + which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if [ "$cygwin" = "false" -a "$darwin" = "false" ] ; then + MAX_FD_LIMIT=`ulimit -H -n` + if [ $? -eq 0 ] ; then + if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then + MAX_FD="$MAX_FD_LIMIT" + fi + ulimit -n $MAX_FD + if [ $? -ne 0 ] ; then + warn "Could not set maximum file descriptor limit: $MAX_FD" + fi + else + warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" + fi +fi + +# For Darwin, add options to specify how the application appears in the dock +if $darwin; then + GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" +fi + +# For Cygwin, switch paths to Windows format before running java +if $cygwin ; then + APP_HOME=`cygpath --path --mixed "$APP_HOME"` + CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` + + # We build the pattern for arguments to be converted via cygpath + ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` + SEP="" + for dir in $ROOTDIRSRAW ; do + ROOTDIRS="$ROOTDIRS$SEP$dir" + SEP="|" + done + OURCYGPATTERN="(^($ROOTDIRS))" + # Add a user-defined pattern to the cygpath arguments + if [ "$GRADLE_CYGPATTERN" != "" ] ; then + OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" + fi + # Now convert the arguments - kludge to limit ourselves to /bin/sh + i=0 + for arg in "$@" ; do + CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` + CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option + + if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition + eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` + else + eval `echo args$i`="\"$arg\"" + fi + i=$((i+1)) + done + case $i in + (0) set -- ;; + (1) set -- "$args0" ;; + (2) set -- "$args0" "$args1" ;; + (3) set -- "$args0" "$args1" "$args2" ;; + (4) set -- "$args0" "$args1" "$args2" "$args3" ;; + (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; + (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; + (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; + (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; + (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; + esac +fi + +# Split up the JVM_OPTS And GRADLE_OPTS values into an array, following the shell quoting and substitution rules +function splitJvmOpts() { + JVM_OPTS=("$@") +} +eval splitJvmOpts $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS +JVM_OPTS[${#JVM_OPTS[*]}]="-Dorg.gradle.appname=$APP_BASE_NAME" + +exec "$JAVACMD" "${JVM_OPTS[@]}" -classpath "$CLASSPATH" org.gradle.wrapper.GradleWrapperMain "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 00000000..8a0b282a --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,90 @@ +@if "%DEBUG%" == "" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS= + +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if "%ERRORLEVEL%" == "0" goto init + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto init + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:init +@rem Get command-line arguments, handling Windowz variants + +if not "%OS%" == "Windows_NT" goto win9xME_args +if "%@eval[2+2]" == "4" goto 4NT_args + +:win9xME_args +@rem Slurp the command line arguments. +set CMD_LINE_ARGS= +set _SKIP=2 + +:win9xME_args_slurp +if "x%~1" == "x" goto execute + +set CMD_LINE_ARGS=%* +goto execute + +:4NT_args +@rem Get arguments from the 4NT Shell from JP Software +set CMD_LINE_ARGS=%$ + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="0" goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/settings.gradle b/settings.gradle new file mode 100644 index 00000000..4695d59c --- /dev/null +++ b/settings.gradle @@ -0,0 +1,2 @@ +rootProject.name = 'markup-document-builder' + diff --git a/src/main/java/io/github/robwin/markup/builder/AbstractMarkupDocBuilder.java b/src/main/java/io/github/robwin/markup/builder/AbstractMarkupDocBuilder.java new file mode 100644 index 00000000..ebbb56ac --- /dev/null +++ b/src/main/java/io/github/robwin/markup/builder/AbstractMarkupDocBuilder.java @@ -0,0 +1,106 @@ +package io.github.robwin.markup.builder; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.io.BufferedWriter; +import java.io.IOException; +import java.nio.charset.Charset; +import java.nio.file.Files; +import java.nio.file.Paths; +import java.util.List; + +/** + * @author Robert Winkler + */ +public abstract class AbstractMarkupDocBuilder implements MarkupDocBuilder { + + protected StringBuilder documentBuilder = new StringBuilder(); + protected String newLine = System.getProperty("line.separator"); + protected Logger logger = LoggerFactory.getLogger(getClass()); + + protected void documentTitle(Markup markup, String title){ + documentBuilder.append(markup).append(title).append(newLine).append(newLine); + } + + protected void documentTitleWithAttributes(Markup markup, String title){ + documentBuilder.append(markup).append(title).append(newLine); + } + + protected void sectionTitleLevel1(Markup markup, String title){ + documentBuilder.append(markup).append(title).append(newLine); + } + + protected void sectionTitleLevel2(Markup markup, String title){ + documentBuilder.append(markup).append(title).append(newLine); + } + + protected void sectionTitleLevel3(Markup markup, String title){ + documentBuilder.append(markup).append(title).append(newLine); + } + + @Override + public MarkupDocBuilder textLine(String text){ + documentBuilder.append(text).append(newLine); + return this; + } + + protected void paragraph(Markup markup, String text){ + documentBuilder.append(markup).append(newLine).append(text).append(newLine).append(newLine); + } + + protected void listing(Markup markup, String text){ + delimitedTextLine(markup, text); + } + + protected void delimitedTextLine(Markup markup, String text){ + documentBuilder.append(markup).append(newLine).append(text).append(newLine).append(markup).append(newLine).append(newLine); + } + + protected void delimitedTextLineWithoutLineBreaks(Markup markup, String text){ + documentBuilder.append(markup).append(text).append(markup).append(newLine); + } + + protected void preserveLineBreaks(Markup markup){ + documentBuilder.append(markup).append(newLine); + } + + protected void boldTextLine(Markup markup, String text){ + delimitedTextLineWithoutLineBreaks(markup, text); + } + + protected void italicTextLine(Markup markup, String text){ + delimitedTextLineWithoutLineBreaks(markup, text); + } + + protected void unorderedList(Markup markup, List list){ + documentBuilder.append(newLine); + for(String listEntry : list){ + documentBuilder.append(markup).append(listEntry).append(newLine); + } + documentBuilder.append(newLine); + } + + @Override + public MarkupDocBuilder newLine(){ + documentBuilder.append(newLine); + return this; + } + + @Override + public String toString(){ + return documentBuilder.toString(); + } + + @Override + public void writeToFile(String directory, String fileNameWithExtension, Charset charset) throws IOException { + Files.createDirectories(Paths.get(directory)); + try (BufferedWriter writer = Files.newBufferedWriter(Paths.get(directory, fileNameWithExtension), charset)){ + writer.write(documentBuilder.toString()); + } + if (logger.isInfoEnabled()) { + logger.info("{} was written to: {}", fileNameWithExtension, directory); + } + documentBuilder = new StringBuilder(); + } +} diff --git a/src/main/java/io/github/robwin/markup/builder/Markup.java b/src/main/java/io/github/robwin/markup/builder/Markup.java new file mode 100644 index 00000000..dfeca83d --- /dev/null +++ b/src/main/java/io/github/robwin/markup/builder/Markup.java @@ -0,0 +1,8 @@ +package io.github.robwin.markup.builder; + +/** + * @author Robert Winkler + */ +public interface Markup { + public String toString(); +} diff --git a/src/main/java/io/github/robwin/markup/builder/MarkupDocBuilder.java b/src/main/java/io/github/robwin/markup/builder/MarkupDocBuilder.java new file mode 100644 index 00000000..8f096385 --- /dev/null +++ b/src/main/java/io/github/robwin/markup/builder/MarkupDocBuilder.java @@ -0,0 +1,53 @@ +package io.github.robwin.markup.builder; + +import java.io.IOException; +import java.nio.charset.Charset; +import java.util.List; + +/** + * @author Robert Winkler + */ +public interface MarkupDocBuilder { + MarkupDocBuilder documentTitle(String title); + + MarkupDocBuilder documentTitleWithAttributes(String title); + + MarkupDocBuilder sectionTitleLevel1(String title); + + MarkupDocBuilder sectionTitleLevel2(String title); + + MarkupDocBuilder sectionTitleLevel3(String title); + + MarkupDocBuilder textLine(String text); + + MarkupDocBuilder paragraph(String text); + + MarkupDocBuilder listing(String text); + + MarkupDocBuilder source(String text, String language); + + MarkupDocBuilder boldTextLine(String text); + + MarkupDocBuilder italicTextLine(String text); + + MarkupDocBuilder unorderedList(List list); + + MarkupDocBuilder tableWithHeaderRow(List rowsInCSV); + + MarkupDocBuilder newLine(); + + /** + * Returns a string representation of the document. + */ + String toString(); + + /** + * Writes the content of the builder to a file and clears the builder. + * + * @param directory the directory where the generated file should be stored + * @param fileName the name of the file + * @param charset the the charset to use for encoding + * @throws java.io.IOException if the file cannot be written + */ + void writeToFile(String directory, String fileName, Charset charset) throws IOException; +} diff --git a/src/main/java/io/github/robwin/markup/builder/MarkupDocBuilders.java b/src/main/java/io/github/robwin/markup/builder/MarkupDocBuilders.java new file mode 100644 index 00000000..968408a1 --- /dev/null +++ b/src/main/java/io/github/robwin/markup/builder/MarkupDocBuilders.java @@ -0,0 +1,22 @@ +package io.github.robwin.markup.builder; + + +import io.github.robwin.markup.builder.asciidoc.AsciiDocBuilder; +import io.github.robwin.markup.builder.markdown.MarkdownBuilder; + +/** + * @author Robert Winkler + */ +public final class MarkupDocBuilders { + + private MarkupDocBuilders(){}; + + public static MarkupDocBuilder documentBuilder(MarkupLanguage markupLanguage){ + switch(markupLanguage){ + case MARKDOWN: return new MarkdownBuilder(); + case ASCIIDOC: return new AsciiDocBuilder(); + default: return new AsciiDocBuilder(); + } + } + +} diff --git a/src/main/java/io/github/robwin/markup/builder/MarkupLanguage.java b/src/main/java/io/github/robwin/markup/builder/MarkupLanguage.java new file mode 100644 index 00000000..2f22a772 --- /dev/null +++ b/src/main/java/io/github/robwin/markup/builder/MarkupLanguage.java @@ -0,0 +1,25 @@ +package io.github.robwin.markup.builder; + +import java.util.Arrays; +import java.util.List; + +/** + * @author Robert Winkler + */ +public enum MarkupLanguage { + ASCIIDOC(".adoc,.asciidoc"), + MARKDOWN(".md,.markdown"); + + private final String fileNameExtensions; + + /** + * @param fileNameExtensions file name suffix + */ + private MarkupLanguage(final String fileNameExtensions) { + this.fileNameExtensions = fileNameExtensions; + } + + public List getFileNameExtensions() { + return Arrays.asList(fileNameExtensions.split(",")); + } +} diff --git a/src/main/java/io/github/robwin/markup/builder/asciidoc/AsciiDoc.java b/src/main/java/io/github/robwin/markup/builder/asciidoc/AsciiDoc.java new file mode 100644 index 00000000..4449f6b7 --- /dev/null +++ b/src/main/java/io/github/robwin/markup/builder/asciidoc/AsciiDoc.java @@ -0,0 +1,38 @@ +package io.github.robwin.markup.builder.asciidoc; + + +import io.github.robwin.markup.builder.Markup; + +/** + * @author Robert Winkler + */ +public enum AsciiDoc implements Markup { + LABELED(":: "), + TABLE("|==="), + LISTING("----"), + HARDBREAKS(":hardbreaks:"), + DOCUMENT_TITLE("= "), + SECTION_TITLE_LEVEL1("== "), + SECTION_TITLE_LEVEL2("=== "), + SECTION_TITLE_LEVEL3("==== "), + BOLD("*"), + ITALIC("_"), + LIST_ENTRY("* "); + + private final String markup; + + /** + * @param markup AsciiDoc markup + */ + private AsciiDoc(final String markup) { + this.markup = markup; + } + + /* (non-Javadoc) + * @see java.lang.Enum#toString() + */ + @Override + public String toString() { + return markup; + } +} diff --git a/src/main/java/io/github/robwin/markup/builder/asciidoc/AsciiDocBuilder.java b/src/main/java/io/github/robwin/markup/builder/asciidoc/AsciiDocBuilder.java new file mode 100644 index 00000000..fa2fafea --- /dev/null +++ b/src/main/java/io/github/robwin/markup/builder/asciidoc/AsciiDocBuilder.java @@ -0,0 +1,99 @@ +package io.github.robwin.markup.builder.asciidoc; + +import io.github.robwin.markup.builder.AbstractMarkupDocBuilder; +import io.github.robwin.markup.builder.MarkupDocBuilder; + +import java.io.IOException; +import java.nio.charset.Charset; +import java.util.List; + +/** + * @author Robert Winkler + */ +public class AsciiDocBuilder extends AbstractMarkupDocBuilder { + + @Override + public MarkupDocBuilder documentTitle(String title){ + documentTitle(AsciiDoc.DOCUMENT_TITLE, title); + return this; + } + + @Override + public MarkupDocBuilder documentTitleWithAttributes(String title) { + documentTitle(AsciiDoc.DOCUMENT_TITLE, title); + return this; + } + + @Override + public MarkupDocBuilder sectionTitleLevel1(String title){ + sectionTitleLevel1(AsciiDoc.SECTION_TITLE_LEVEL1, title); + return this; + } + + @Override + public MarkupDocBuilder sectionTitleLevel2(String title){ + sectionTitleLevel2(AsciiDoc.SECTION_TITLE_LEVEL2, title); + return this; + } + + @Override + public MarkupDocBuilder sectionTitleLevel3(String title){ + sectionTitleLevel3(AsciiDoc.SECTION_TITLE_LEVEL3, title); + return this; + } + + @Override + public MarkupDocBuilder paragraph(String text){ + paragraph(AsciiDoc.HARDBREAKS, text); + return this; + } + + @Override + public MarkupDocBuilder listing(String text){ + listing(AsciiDoc.LISTING, text); + return this; + } + + @Override + public MarkupDocBuilder boldTextLine(String text){ + boldTextLine(AsciiDoc.BOLD, text); + return this; + } + + @Override + public MarkupDocBuilder italicTextLine(String text) { + italicTextLine(AsciiDoc.ITALIC, text); + return this; + } + + @Override + public MarkupDocBuilder unorderedList(List list){ + unorderedList(AsciiDoc.LIST_ENTRY, list); + return this; + } + + @Override + public MarkupDocBuilder source(String text, String language){ + documentBuilder.append(String.format("[source,%s]", language)).append(newLine); + listing(AsciiDoc.LISTING, text); + return this; + } + + @Override + public MarkupDocBuilder tableWithHeaderRow(List rowsInCSV){ + documentBuilder.append("[format=\"csv\", options=\"header\"]").append(newLine); + documentBuilder.append(AsciiDoc.TABLE).append(newLine); + for(String row : rowsInCSV){ + documentBuilder.append(row).append(newLine); + } + documentBuilder.append(AsciiDoc.TABLE).append(newLine).append(newLine); + return this; + } + + @Override + public void writeToFile(String directory, String fileName, Charset charset) throws IOException { + String fileNameWithExtension = fileName + ".adoc"; + super.writeToFile(directory, fileNameWithExtension, charset); + } + +} diff --git a/src/main/java/io/github/robwin/markup/builder/markdown/Markdown.java b/src/main/java/io/github/robwin/markup/builder/markdown/Markdown.java new file mode 100644 index 00000000..a745c567 --- /dev/null +++ b/src/main/java/io/github/robwin/markup/builder/markdown/Markdown.java @@ -0,0 +1,37 @@ +package io.github.robwin.markup.builder.markdown; + +import io.github.robwin.markup.builder.Markup; + +/** + * @author Robert Winkler + */ +public enum Markdown implements Markup { + HARDBREAKS(""), + TABLE_COLUMN("|"), + TABLE_ROW("-"), + LISTING("```"), + DOCUMENT_TITLE("# "), + SECTION_TITLE_LEVEL1("## "), + SECTION_TITLE_LEVEL2("### "), + SECTION_TITLE_LEVEL3("### "), + BOLD("**"), + ITALIC("*"), + LIST_ENTRY("* "); + + private final String markup; + + /** + * @param markup AsciiDoc markup + */ + private Markdown(final String markup) { + this.markup = markup; + } + + /* (non-Javadoc) + * @see java.lang.Enum#toString() + */ + @Override + public String toString() { + return markup; + } +} diff --git a/src/main/java/io/github/robwin/markup/builder/markdown/MarkdownBuilder.java b/src/main/java/io/github/robwin/markup/builder/markdown/MarkdownBuilder.java new file mode 100644 index 00000000..6f3d993c --- /dev/null +++ b/src/main/java/io/github/robwin/markup/builder/markdown/MarkdownBuilder.java @@ -0,0 +1,122 @@ +package io.github.robwin.markup.builder.markdown; + +import io.github.robwin.markup.builder.AbstractMarkupDocBuilder; +import io.github.robwin.markup.builder.MarkupDocBuilder; + +import java.io.IOException; +import java.nio.charset.Charset; +import java.util.Arrays; +import java.util.List; + +/** + * @author Robert Winkler + */ +public class MarkdownBuilder extends AbstractMarkupDocBuilder +{ + @Override + public MarkupDocBuilder documentTitle(String title){ + documentTitle(Markdown.DOCUMENT_TITLE, title); + return this; + } + + @Override + public MarkupDocBuilder documentTitleWithAttributes(String title) { + documentTitle(Markdown.DOCUMENT_TITLE, title); + return this; + } + + @Override + public MarkupDocBuilder sectionTitleLevel1(String title){ + sectionTitleLevel1(Markdown.SECTION_TITLE_LEVEL1, title); + return this; + } + + @Override + public MarkupDocBuilder sectionTitleLevel2(String title){ + sectionTitleLevel2(Markdown.SECTION_TITLE_LEVEL2, title); + return this; + } + + @Override + public MarkupDocBuilder sectionTitleLevel3(String title){ + sectionTitleLevel3(Markdown.SECTION_TITLE_LEVEL3, title); + return this; + } + + @Override + public MarkupDocBuilder paragraph(String text){ + paragraph(Markdown.HARDBREAKS, text); + return this; + } + + @Override + public MarkupDocBuilder listing(String text){ + listing(Markdown.LISTING, text); + return this; + } + + @Override + public MarkupDocBuilder source(String text, String language){ + documentBuilder.append(Markdown.LISTING).append(language).append(newLine). + append(text).append(newLine). + append(Markdown.LISTING).append(newLine).append(newLine); + return this; + } + + @Override + public MarkupDocBuilder boldTextLine(String text){ + boldTextLine(Markdown.BOLD, text); + return this; + } + + @Override + public MarkupDocBuilder italicTextLine(String text) { + italicTextLine(Markdown.ITALIC, text); + return this; + } + + @Override + public MarkupDocBuilder unorderedList(List list){ + unorderedList(Markdown.LIST_ENTRY, list); + return this; + } + + @Override + public MarkupDocBuilder tableWithHeaderRow(List rowsInCSV){ + String headersInCSV = rowsInCSV.get(0); + List contentRowsInCSV = rowsInCSV.subList(1, rowsInCSV.size()); + List headers = Arrays.asList(headersInCSV.split(",")); + // Header + documentBuilder.append(Markdown.TABLE_COLUMN); + for(String header : headers){ + documentBuilder.append(header).append(Markdown.TABLE_COLUMN); + } + newLine(); + // Header/Content separator + documentBuilder.append(Markdown.TABLE_COLUMN); + for(String header : headers){ + for(int i = 1; i<5; i++) { + documentBuilder.append(Markdown.TABLE_ROW); + } + documentBuilder.append(Markdown.TABLE_COLUMN); + } + newLine(); + // Content + for(String contentRow : contentRowsInCSV){ + documentBuilder.append(Markdown.TABLE_COLUMN); + List columns = Arrays.asList(contentRow.split(",")); + for(String columnText : columns){ + documentBuilder.append(columnText).append(Markdown.TABLE_COLUMN); + } + newLine(); + } + newLine().newLine(); + return this; + } + + @Override + public void writeToFile(String directory, String fileName, Charset charset) throws IOException { + String fileNameWithExtension = fileName + ".md"; + super.writeToFile(directory, fileNameWithExtension, charset); + } +} diff --git a/src/main/resources/logback.xml b/src/main/resources/logback.xml new file mode 100644 index 00000000..8b43a9e7 --- /dev/null +++ b/src/main/resources/logback.xml @@ -0,0 +1,12 @@ + + + + + %d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n + + + + + + + \ No newline at end of file diff --git a/src/test/java/io/github/robwin/markup/builder/MarkupDocBuilderTest.java b/src/test/java/io/github/robwin/markup/builder/MarkupDocBuilderTest.java new file mode 100644 index 00000000..de4c4848 --- /dev/null +++ b/src/test/java/io/github/robwin/markup/builder/MarkupDocBuilderTest.java @@ -0,0 +1,66 @@ +package io.github.robwin.markup.builder; + +import org.junit.Before; +import org.junit.Test; + +import java.io.IOException; +import java.nio.charset.StandardCharsets; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.List; + +/** + * @author Robert Winkler + */ +public class MarkupDocBuilderTest { + + List tableCsvRows; + + @Before + public void setUp(){ + tableCsvRows = new ArrayList<>(); + tableCsvRows.add("Header 1,Header 2,Header2"); + tableCsvRows.add("Row 1 Column 1,Row 1 Column 2,Row 1 Column 3"); + tableCsvRows.add("Row 2 Column 1,Row 2 Column 2,Row 2 Column 3"); + } + + + @Test + public void testToAsciiDocFile() throws IOException { + MarkupDocBuilder builder = MarkupDocBuilders.documentBuilder(MarkupLanguage.ASCIIDOC); + builder.documentTitle("Test title") + .sectionTitleLevel1("Section Level 1a") + .sectionTitleLevel2("Section Level 2a") + .sectionTitleLevel3("Section Level 3a") + .paragraph("Paragraph with long text bla bla bla bla bla") + .listing("Source code listing") + .source("MarkupDocBuilder builder = MarkupDocBuilders.documentBuilder(MarkupLanguage.ASCIIDOC)", "java") + .tableWithHeaderRow(tableCsvRows) + .sectionTitleLevel1("Section Level 1b") + .sectionTitleLevel2("Section Level 2b") + .boldTextLine("Bold text line b") + .italicTextLine("Italic text line b") + .unorderedList(Arrays.asList("Entry1", "Entry2", "Entry 2")) + .writeToFile("build/tmp", "test", StandardCharsets.UTF_8); + } + + @Test + public void testToMarkdownDocFile() throws IOException { + MarkupDocBuilder builder = MarkupDocBuilders.documentBuilder(MarkupLanguage.MARKDOWN); + builder.documentTitle("Test title") + .sectionTitleLevel1("Section Level 1a") + .sectionTitleLevel2("Section Level 2a") + .sectionTitleLevel3("Section Level 3a") + .paragraph("Paragraph with long text bla bla bla bla bla") + .listing("Source code listing") + .source("MarkupDocBuilder builder = MarkupDocBuilders.documentBuilder(MarkupLanguage.ASCIIDOC)", "java") + .tableWithHeaderRow(tableCsvRows) + .sectionTitleLevel1("Section Level 1b") + .sectionTitleLevel2("Section Level 2b") + .boldTextLine("Bold text line b") + .italicTextLine("Italic text line b") + .unorderedList(Arrays.asList("Entry1", "Entry2", "Entry 2")) + .writeToFile("build/tmp", "test", StandardCharsets.UTF_8); + } + +}