Merge remote-tracking branch 'origin/master' into 1.0.x

Author: hauner

build.gradle

@@ -3,18 +3,21 @@ plugins {
     id 'groovy'
     id 'java-library'
     id 'maven-publish'
-    id 'com.jfrog.bintray' version '1.8.4'
-    id 'org.jetbrains.kotlin.jvm' version '1.3.61'
+    id 'com.jfrog.bintray' version '1.8.5'
+    id 'org.jetbrains.kotlin.jvm' version '1.3.72'
     id 'org.jetbrains.dokka' version '0.10.1'
-    id 'org.unbroken-dome.test-sets' version '2.2.1'
-    id "com.github.ben-manes.versions" version "0.27.0"
+    id 'org.unbroken-dome.test-sets' version '3.0.1'
+    id "com.github.ben-manes.versions" version "0.28.0"
 }
 
 group 'com.github.hauner.openapi'
-version '1.0.0.M13'
+version '1.0.0.M14'
+
+java {
+    sourceCompatibility = JavaVersion.VERSION_1_8
+    targetCompatibility = JavaVersion.VERSION_1_8
+}
 
-sourceCompatibility = JavaVersion.VERSION_1_8
-targetCompatibility = JavaVersion.VERSION_1_8
 
 ext {
     processorApiVersion = '1.0.0.M4'
@@ -56,22 +59,31 @@ compileTestGroovy {
     classpath += files(compileKotlin.destinationDir)
 }
 
+compileKotlin {
+    kotlinOptions.jvmTarget = "1.8"
+}
 
 dependencies {
-    implementation 'org.codehaus.groovy:groovy:2.5.4'
-    implementation 'org.jetbrains.kotlin:kotlin-stdlib'
-    implementation 'io.swagger.parser.v3:swagger-parser:2.0.17'
-    implementation 'org.openapi4j:openapi-parser:0.8'
+    implementation 'org.codehaus.groovy:groovy:2.5.10'
+    implementation 'org.codehaus.groovy:groovy-nio:2.5.10'
+    implementation 'org.jetbrains.kotlin:kotlin-stdlib-jdk8'
+
+    implementation ('io.swagger.parser.v3:swagger-parser:2.0.19') {
+        exclude group: 'io.swagger.parser.v3', module: 'swagger-parser-v2-converter'
+        exclude group: 'io.swagger.core.v3', module: 'swagger-annotations'
+    }
+    implementation 'org.openapi4j:openapi-parser:0.9'
     implementation 'com.google.googlejavaformat:google-java-format:1.7'
     compileOnly "com.github.hauner.openapi:openapi-processor-api:$processorApiVersion"
 
+    testImplementation 'com.google.jimfs:jimfs:1.1'
     testImplementation ('org.spockframework:spock-core:2.0-M2-groovy-2.5') {
         exclude group: 'org.codehaus.groovy'
     }
     testImplementation ('org.spockframework:spock-junit4:2.0-M2-groovy-2.5') {
         exclude group: 'org.codehaus.groovy'
     }
-    testImplementation 'net.bytebuddy:byte-buddy:1.10.7'
+    testImplementation 'net.bytebuddy:byte-buddy:1.10.9'
     testImplementation 'ch.qos.logback:logback-classic:1.2.3'
 
     testIntImplementation "com.github.hauner.openapi:openapi-processor-api:$processorApiVersion"
@@ -80,7 +92,6 @@ dependencies {
 //    testIntRuntimeOnly 'org.slf4j:slf4j-nop:1.6.1'
 }
 
-
 tasks.withType(Test) {
     finalizedBy jacocoTestReport
 }

docs/modules/ROOT/pages/index.adoc

@@ -17,8 +17,16 @@ link:{oaps-license}[image:{badge-license}[]]
 *openapi-processor-spring* is an link:{openapi}[OpenAPI] interface & model only java code generator
 for link:{springboot}[Spring Boot].
 
-It supports an API first approach where you API is explicitly defined and documented with OpenAPI
- before it gets implemented.
+It supports an approach where you explicitly define and document your Service API (using OpenAPI)
+with the Interface to the outside and its usage in mind before you implement it. You do not derive
+the API later from the implementation and its implicit design. (of course, adapt as you go...)
+
+The advantages are:
+
+* you have a single place to maintain the api which makes it easier to create a consistent api
+and keep the overview.
+* it is easy to document in plain text. You can use markdown in the OpenAPI `description`
+properties.
 
 The processor generates java interfaces based on the endpoint description of the API and simple POJO
 classes for parameter or response objects defined in the API. The processor adds all the required

src/main/groovy/com/github/hauner/openapi/spring/parser/Parser.groovy

@@ -18,35 +18,38 @@ package com.github.hauner.openapi.spring.parser
 
 import com.github.hauner.openapi.spring.parser.swagger.Parser as Swagger
 import com.github.hauner.openapi.spring.parser.openapi4j.Parser as OpenApi4J
+import org.slf4j.Logger
+import org.slf4j.LoggerFactory
 
 /**
  * OpenAPI parser abstraction. Supports swagger or openapi4 parser.
  *
  * @author Martin Hauner
  */
 class Parser {
+    private static final Logger LOG = LoggerFactory.getLogger (Parser.class)
 
     OpenApi parse (Map<String, ?> processorOptions) {
         def apiPath = processorOptions.apiPath as String
 
         switch (processorOptions.parser as ParserType) {
 
             case ParserType.SWAGGER:
-                println "info: using SWAGGER parser"
+                LOG.info ("using SWAGGER parser")
 
                 def parser = new Swagger ()
                 return parser.parse (apiPath)
 
             case ParserType.OPENAPI4J:
-                println "info: using OPENAPI4J parser"
+                LOG.info ("using OPENAPI4J parser")
 
                 def parser = new OpenApi4J ()
                 return parser.parse (apiPath)
 
             default:
                 if (processorOptions.parser != null) {
-                    println "warning: unknown parser type: ${processorOptions.parser}"
-                    println "warning: available parsers: SWAGGER, OPENAPI4J"
+                    LOG.warn ("unknown parser type: {}", processorOptions.parser)
+                    LOG.warn ("available parsers: SWAGGER, OPENAPI4J")
                 }
 
                 def parser = new Swagger ()

src/main/groovy/com/github/hauner/openapi/spring/parser/openapi4j/Parser.groovy

@@ -30,9 +30,12 @@ import org.openapi4j.parser.validation.v3.OpenApi3Validator
 class Parser {
 
     ParserOpenApi parse (String apiPath) {
+        if (!hasScheme (apiPath)) {
+            apiPath = "file://${apiPath}"
+        }
 
         OpenApi3 api = new OpenApi3Parser ()
-            .parse (new File (apiPath), true)
+            .parse (new URL (apiPath), true)
 
         ValidationResults results = OpenApi3Validator
             .instance ()
@@ -41,4 +44,8 @@ class Parser {
         new OpenApi (api, results)
     }
 
+    boolean hasScheme (String path) {
+        path.indexOf ("://") > -1
+    }
+
 }

src/main/groovy/com/github/hauner/openapi/spring/parser/swagger/Parser.groovy

@@ -22,13 +22,17 @@ import io.swagger.v3.parser.core.models.ParseOptions
 import io.swagger.v3.parser.core.models.SwaggerParseResult
 
 /**
- * openapi4j parser.
+ * swagger parser.
  *
  * @author Martin Hauner
  */
 class Parser {
 
     ParserOpenApi parse (String apiPath) {
+        if (!hasScheme (apiPath)) {
+            apiPath = "file://${apiPath}"
+        }
+
         ParseOptions opts = new ParseOptions(
             // loads $refs to other files into #/components/schema and replaces the $refs to the
             // external files with $refs to #/components/schema.
@@ -40,4 +44,8 @@ class Parser {
         new OpenApi(result)
     }
 
+    boolean hasScheme (String path) {
+        path.indexOf ("://") > -1
+    }
+
 }

src/main/groovy/com/github/hauner/openapi/spring/processor/MappingReader.groovy

@@ -37,13 +37,16 @@ class MappingReader {
             return null
         }
 
-        String mapping = typeMappings
-        if (isFileName (typeMappings)) {
+        def mapping
+        if (isUrl (typeMappings)) {
+            mapping = new URL (typeMappings).text
+        } else if (isFileName (typeMappings)) {
             mapping = new File (typeMappings).text
+        } else {
+            mapping = typeMappings
         }
 
         def mapper = createYamlParser ()
-
         mapper.readValue (mapping, Mapping)
     }
 
@@ -61,4 +64,12 @@ class MappingReader {
         name.endsWith ('.yaml') || name.endsWith ('.yml')
     }
 
+    private boolean isUrl (String source) {
+        try {
+            new URL (source)
+        } catch (MalformedURLException ignore) {
+            false
+        }
+    }
+
 }

src/main/groovy/com/github/hauner/openapi/spring/writer/ApiWriter.groovy

@@ -25,6 +25,9 @@ import com.google.googlejavaformat.java.Formatter
 import com.google.googlejavaformat.java.JavaFormatterOptions
 import groovy.util.logging.Slf4j
 
+import java.nio.file.Files
+import java.nio.file.Path
+
 import static com.github.hauner.openapi.support.Identifier.toClass
 
 /**
@@ -40,8 +43,8 @@ class ApiWriter {
     DataTypeWriter dataTypeWriter
     StringEnumWriter enumWriter
 
-    File apiFolder
-    File modelFolder
+    Path apiFolder
+    Path modelFolder
 
     Formatter formatter
 
@@ -69,22 +72,22 @@ class ApiWriter {
         createTargetFolders ()
 
         api.interfaces.each {
-            def target = new File (apiFolder, "${it.interfaceName}.java")
-            def writer = new FileWriter(target)
+            def target = apiFolder.resolve ("${it.interfaceName}.java")
+            def writer = new BufferedWriter (new PathWriter(target))
             writeInterface (writer, it)
             writer.close ()
         }
 
         api.models.objectDataTypes.each {
-            def target = new File (modelFolder, "${it.name}.java")
-            def writer = new FileWriter(target)
+            def target = modelFolder.resolve ("${it.name}.java")
+            def writer = new BufferedWriter (new PathWriter(target))
             writeDataType (writer, it)
             writer.close ()
         }
 
         api.models.enumDataTypes.each {
-            def target = new File (modelFolder, "${it.name}.java")
-            def writer = new FileWriter(target)
+            def target = modelFolder.resolve ("${it.name}.java")
+            def writer = new BufferedWriter (new PathWriter(target))
             writeEnumDataType (writer, it)
             writer.close ()
         }
@@ -132,23 +135,25 @@ class ApiWriter {
         log.debug ('creating target folders: {}', rootPkg)
 
         apiFolder = createTargetPackage (apiPkg)
-        log.debug ('created target folder: {}', apiFolder.absolutePath)
+        log.debug ('created target folder: {}', apiFolder.toAbsolutePath ().toString ())
 
         modelFolder = createTargetPackage (modelPkg)
-        log.debug ('created target folder: {}', modelFolder.absolutePath)
+        log.debug ('created target folder: {}', modelFolder.toAbsolutePath ().toString ())
     }
 
-    private File createTargetPackage (String apiPkg) {
-        def folder = new File ([options.targetDir, apiPkg].join (File.separator))
-        if (folder.exists () && folder.isDirectory ()) {
-            return folder
+    private Path createTargetPackage (String apiPkg) {
+        String root = options.targetDir
+        if (!hasScheme (root)) {
+            root = "file://${root}"
         }
 
-        def success = folder.mkdirs ()
-        if (!success) {
-            log.error ('failed to create package {}', folder)
-        }
-        folder
+        def target = Path.of (new URL ([root, apiPkg].join ('/')).toURI ())
+        Files.createDirectories (target)
+        target
+    }
+
+    private boolean hasScheme (String source) {
+        source.indexOf ("://") > -1
     }
 
 }

src/main/groovy/com/github/hauner/openapi/spring/writer/PathWriter.groovy

@@ -0,0 +1,33 @@
+/*
+ * Copyright 2019-2020 the original authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.github.hauner.openapi.spring.writer
+
+import java.nio.file.Files
+import java.nio.file.Path
+
+/**
+ * Path based Writer
+ *
+ * @author Martin Haner
+ */
+class PathWriter extends OutputStreamWriter {
+
+    PathWriter(Path target) throws IOException {
+        super(Files.newOutputStream (target));
+    }
+
+}