Merge pull request #100 from hauner/jimfs

support alternative `FileSystem`, ie. replace `File` with  `Path`.

Author: hauner

build.gradle

@@ -13,7 +13,7 @@ plugins {
 group 'com.github.hauner.openapi'
 version '1.0.0.M13'
 
-sourceCompatibility = JavaVersion.VERSION_1_8
+sourceCompatibility = JavaVersion.VERSION_11
 targetCompatibility = JavaVersion.VERSION_1_8
 
 ext {
@@ -58,13 +58,15 @@ compileTestGroovy {
 
 
 dependencies {
-    implementation 'org.codehaus.groovy:groovy:2.5.4'
+    implementation 'org.codehaus.groovy:groovy:2.5.10'
+    implementation 'org.codehaus.groovy:groovy-nio:2.5.10'
     implementation 'org.jetbrains.kotlin:kotlin-stdlib'
-    implementation 'io.swagger.parser.v3:swagger-parser:2.0.17'
-    implementation 'org.openapi4j:openapi-parser:0.8'
+    implementation 'io.swagger.parser.v3:swagger-parser:2.0.19'
+    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'
     }

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));
+    }
+
+}

src/test/groovy/com/github/hauner/openapi/spring/processor/MappingReaderSpec.groovy

@@ -16,12 +16,20 @@
 
 package com.github.hauner.openapi.spring.processor
 
+import com.google.common.jimfs.Configuration
+import com.google.common.jimfs.Jimfs
 import org.junit.Rule
 import org.junit.rules.TemporaryFolder
+import spock.lang.Shared
 import spock.lang.Specification
 
+import java.nio.file.FileSystem
+
 class MappingReaderSpec extends Specification {
 
+    @Shared
+    FileSystem fs = Jimfs.newFileSystem (Configuration.unix ())
+
     @Rule
     TemporaryFolder folder
 
@@ -37,30 +45,51 @@ class MappingReaderSpec extends Specification {
         yaml << [null, ""]
     }
 
-    void "reads mapping from file" () {
+    void "reads mapping from url" () {
+        def yaml = """\
+openapi-processor-spring: v1.0
+    
+map:
+  types:
+    - from: array
+      to: java.util.Collection
+"""
+
+        def yamlFile = fs.getPath ('mapping.yaml')
+        yamlFile.text = yaml
+
+        when:
+        def reader = new MappingReader()
+        def mapping = reader.read (yamlFile.toUri ().toURL ().toString ())
+
+        then:
+        mapping
+    }
+
+    void "reads mapping from local file if the scheme is missing" () {
         def yaml = """\
-openapi-generatr-spring: v1.0
+openapi-processor-spring: v1.0
     
 map:
   types:
     - from: array
       to: java.util.Collection
 """
 
-        def yamlFile = folder.newFile ("openapi-generatr-spring.yaml")
+        def yamlFile = folder.newFile ('mapping.yaml')
         yamlFile.text = yaml
 
         when:
         def reader = new MappingReader()
-        def mapping = reader.read (yamlFile.absolutePath)
+        def mapping = reader.read (yamlFile.toString ())
 
         then:
         mapping
     }
 
     void "reads mapping from string" () {
         def yaml = """\
-openapi-generatr-spring: v1.0
+openapi-processor-spring: v1.0
     
 map:
   types:

src/test/groovy/com/github/hauner/openapi/spring/writer/ApiWriterSpec.groovy

@@ -47,7 +47,8 @@ class ApiWriterSpec extends Specification {
         )
 
         when:
-        new ApiWriter (opts, Stub (InterfaceWriter), null, null).write (new Api())
+        new ApiWriter (opts, Stub (InterfaceWriter), null, null)
+            .write (new Api())
 
         then:
         def api = new File([opts.targetDir, 'com', 'github', 'hauner', 'openapi', 'api'].join(File.separator))

src/testInt/groovy/com/github/hauner/openapi/processor/ProcessorEndToEndTest.groovy

@@ -1,5 +1,5 @@
 /*
- * Copyright 2019 the original authors
+ * 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.
@@ -17,48 +17,23 @@
 package com.github.hauner.openapi.processor
 
 import com.github.hauner.openapi.spring.parser.ParserType
+import org.junit.Test
 import org.junit.runner.RunWith
 import org.junit.runners.Parameterized
 
 /**
  * using Junit so IDEA adds a "<Click to see difference>" when using assertEquals().
  */
-
 @RunWith(Parameterized)
 class ProcessorEndToEndTest extends ProcessorTestBase {
 
-    static def testSets = [
-        'bean-validation',
-        'endpoint-exclude',
-        'method-operation-id',
-        'no-response-content',
-        'params-additional',
-        'params-complex-data-types',
-        'params-enum',
-        'params-simple-data-types',
-        'params-request-body',
-        'params-request-body-multipart-form-data',
-        'params-path-simple-data-types',
-        'params-spring-pageable-mapping',
-        'ref-into-another-file',
-        'ref-loop',
-        'response-array-data-type-mapping',
-        'response-complex-data-types',
-        'response-content-multiple',
-        'response-content-single',
-        'response-result-mapping',
-        'response-simple-data-types',
-        'response-single-multi-mapping',
-        'schema-composed'
-    ]
-
     @Parameterized.Parameters(name = "{0}")
     static Collection<TestSet> sources () {
-        def swagger = testSets.collect {
+        def swagger = TestSet.testSets.collect {
            new TestSet (name: it, parser: ParserType.SWAGGER)
         }
 
-        def openapi4j = testSets.collect {
+        def openapi4j = TestSet.testSets.collect {
            new TestSet (name: it, parser: ParserType.OPENAPI4J)
         }
 
@@ -69,4 +44,9 @@ class ProcessorEndToEndTest extends ProcessorTestBase {
         super (testSet)
     }
 
+    @Test
+    void "native - processor creates expected files for api set "() {
+        runOnNativeFileSystem ()
+    }
+
 }