Merge branch 'release-2.1'

Author: starlightknight

README.md

@@ -1,5 +1,9 @@
 # Swagger Confluence
 
+[ ![Build Status](https://cloud.slkdev.net/gitlab/starlightknight/swagger-confluence/badges/develop/build.svg) ](https://cloud.slkdev.net/gitlab/starlightknight/swagger-confluence/builds)
+[ ![Quality Gate](https://cloud.slkdev.net/sonar/api/badges/gate?key=30)](https://cloud.slkdev.net/sonar/overview?id=30)
+[ ![Download](https://api.bintray.com/packages/starlightknight/maven/swagger-confluence-cli-all/images/download.svg) ](https://bintray.com/starlightknight/maven/swagger-confluence-cli-all/_latestVersion)
+
 ## Overview
 
 The primary goal of this project is to simplify publishing Swagger API documentation to an Atlassian Confluence server. Ideally, this plugin would be activated on the build of a schema jar, which would contain your contract-first Swagger JSON or YAML file
@@ -79,10 +83,12 @@ A special thanks for the following projects, who make this project possible:
 
 * [Swagger2Markup](https://github.com/Swagger2Markup/swagger2markup)
 * [AsciiDoctorJ](https://github.com/asciidoctor/asciidoctorj)
+* [JSoup](http://jsoup.org/)
 * [Confluence REST API](https://developer.atlassian.com/confdev/confluence-rest-api)
 
 
 
+
 Additional shout-outs to the following two projects - whom I tried using manually in
 conjunction with the above projects and their respective gradle plugins before starting this project:
 

build.gradle

@@ -37,7 +37,7 @@ allprojects {
 subprojects {
     group 'net.slkdev.swagger.confluence'
 
-    version '2.0'
+    version '2.1'
 
     if (project.hasProperty("release")) {
         version += '-RELEASE'
@@ -80,6 +80,15 @@ subprojects {
         gradleVersion = 2.12
     }
 
+    task sourceJar(type: Jar, dependsOn: classes) {
+        classifier = 'sources'
+        from sourceSets.main.allSource
+    }
+
+    artifacts {
+        archives sourceJar
+    }
+
     test {
         jacoco {
             enabled true

swagger-confluence-cli/build.gradle

@@ -66,10 +66,18 @@ publishing {
         myPublication(MavenPublication) {
             from components.java
             artifactId = 'swagger-confluence-cli'
+
+            artifact sourceJar {
+                classifier "sources"
+            }
         }
 		myShadowPublication(MavenPublication) {
 			from components.shadow
             artifactId = 'swagger-confluence-cli-all'
+
+            artifact sourceJar {
+                classifier "sources"
+            }
 		}
 	}
 }

swagger-confluence-cli/src/main/java/net/slkdev/swagger/confluence/cli/SwaggerConfluence.java

@@ -42,10 +42,14 @@ public static void main(final String[] args){
     private static SwaggerToConfluenceService bootSwaggerConfluence(){
         final AnnotationConfigApplicationContext annotationConfigApplicationContext =
                 new AnnotationConfigApplicationContext(SwaggerConfluenceContextConfig.class);
-        return annotationConfigApplicationContext.getBean(SwaggerToConfluenceService.class);
+        final SwaggerToConfluenceService swaggerToConfluenceService =
+                annotationConfigApplicationContext.getBean(SwaggerToConfluenceService.class);
+        annotationConfigApplicationContext.close();
+
+        return swaggerToConfluenceService;
     }
 
-    public void runCLI(final String args[]){
+    public void runCLI(final String[] args){
         final Options options = buildOptions();
         final CommandLine commandLine = parseCommandLineOptions(options, args);
 

swagger-confluence-core/build.gradle

@@ -55,6 +55,10 @@ publishing {
     publications {
         myPublication(MavenPublication) {
             from components.java
+
+            artifact sourceJar {
+                classifier "sources"
+            }
         }
     }
 }

swagger-confluence-core/src/main/java/net/slkdev/swagger/confluence/config/SwaggerConfluenceConfig.java

@@ -17,6 +17,7 @@
 
 import net.slkdev.swagger.confluence.constants.PaginationMode;
 import net.slkdev.swagger.confluence.exception.SwaggerConfluenceConfigurationException;
+import org.apache.commons.lang3.StringUtils;
 
 public class SwaggerConfluenceConfig {
 
@@ -110,8 +111,10 @@ public String getPrefix() {
     public void setPrefix(final String prefix) {
         if (prefix.endsWith(" ")) {
             this.prefix = prefix;
-        } else {
+        } else if (StringUtils.isNotEmpty(prefix)){
             this.prefix = prefix + ' ';
+        } else {
+            this.prefix = prefix;
         }
     }
 

swagger-confluence-core/src/main/java/net/slkdev/swagger/confluence/service/impl/SwaggerToAsciiDocServiceImpl.java

@@ -62,7 +62,7 @@ public String convertSwaggerToAsciiDoc(final String swaggerSchemaPath) {
         return swaggerAsciiDoc;
     }
 
-    private File getSchemaFile(final String swaggerSchemaPath) throws FileNotFoundException, URISyntaxException {
+    private static File getSchemaFile(final String swaggerSchemaPath) throws FileNotFoundException, URISyntaxException {
         // First we'll try to find the file directly
         File swaggerFile = new File(swaggerSchemaPath);
 

swagger-confluence-core/src/main/java/net/slkdev/swagger/confluence/service/impl/XHtmlToConfluenceServiceImpl.java

@@ -31,6 +31,7 @@
 import net.slkdev.swagger.confluence.model.ConfluencePage;
 import net.slkdev.swagger.confluence.model.ConfluencePageBuilder;
 import net.slkdev.swagger.confluence.service.XHtmlToConfluenceService;
+import org.apache.commons.lang3.StringUtils;
 import org.jsoup.Jsoup;
 import org.jsoup.nodes.Document;
 import org.jsoup.nodes.Element;
@@ -322,7 +323,13 @@ private static List<ConfluencePage> handlePagination() {
         for (final Element innerTocElement : innerTocElements) {
             // If we're in individual page mode, then we collect the inner ToCs
             if (individualPages) {
-                innerTocXHtmlList.add(innerTocElement.html());
+                final StringBuilder tocHtml = new StringBuilder();
+                tocHtml.append("<div id=\"toc\" class=\"toc\">");
+                tocHtml.append("<h4 id=\"toctitle\">Table of Contents</h4>");
+                tocHtml.append("<div><ul class=\"sectlevel1\">");
+                tocHtml.append(innerTocElement.html());
+                tocHtml.append("</ul></div></div>");
+                innerTocXHtmlList.add(tocHtml.toString());
             }
             // If we're in category page mode, then we strip out the inner table of contents.
             else {
@@ -408,7 +415,12 @@ private static String buildConfluenceTitle(final String originalTitle, final Int
             confluenceTitleBuilder.append(". ");
         }
 
-        confluenceTitleBuilder.append(swaggerConfluenceConfig.getPrefix());
+        final String prefix = swaggerConfluenceConfig.getPrefix();
+
+        if(StringUtils.isNotEmpty(prefix)) {
+            confluenceTitleBuilder.append(swaggerConfluenceConfig.getPrefix());
+        }
+
         confluenceTitleBuilder.append(originalTitle);
 
         return confluenceTitleBuilder.toString();
@@ -491,7 +503,7 @@ private static HttpHeaders buildHttpHeaders(final String confluenceAuthenticatio
         return headers;
     }
 
-    private Integer getPageIdFromResponse(final HttpEntity<String> responseEntity) {
+    private static Integer getPageIdFromResponse(final HttpEntity<String> responseEntity) {
         final String responseJson = responseEntity.getBody();
         final JSONParser jsonParser = new JSONParser(DEFAULT_PERMISSIVE_MODE);
 
@@ -691,6 +703,16 @@ private static String reformatXHtml(final String inputXhtml, final Map<String, C
         reformatXHtmlHeadings(document, "h3");
         reformatXHtmlHeadings(document, "#toctitle");
 
+        final SwaggerConfluenceConfig swaggerConfluenceConfig = SWAGGER_CONFLUENCE_CONFIG.get();
+
+        if(swaggerConfluenceConfig.getPaginationMode()==PaginationMode.SINGLE_PAGE){
+            if(swaggerConfluenceConfig.isIncludeTableOfContentsOnSinglePage()) {
+                reformatXHtmlBreakAfterElements(document, "#toc");
+            }
+
+            reformatXHtmlBreakAfterElements(document, ".sect1");
+        }
+
         reformatXHtmlSpacing(document.select(".sect2"));
         reformatXHtmlSpacing(document.select(".sect3"));
 
@@ -707,6 +729,10 @@ private static void reformatXHtmlHeadings(final Document document, final String
         }
     }
 
+    private static void reformatXHtmlBreakAfterElements(final Document document, final String elements){
+        document.select(elements).after("<br />");
+    }
+
     private static void reformatXHtmlSpacing(final Elements elements){
         for(final Element element : elements){
             element.before("<br />");