renamed project

Author: hauner

CONTRIBUTING.md

@@ -1,4 +1,4 @@
-# contributing to openapi-generatr
+# contributing to openapi-processor
 
 ## feature & bug reports
 
@@ -22,7 +22,7 @@ should create. The structure looks like this:
 
 The `mapping.yaml` contains the type mapping information and is an optional file.
 
-See the [existing integration tests][generatr-int-resources] for a couple of examples.
+See the [existing integration tests][oap-int-resources] for a couple of examples.
 
 ## working on the code
 
@@ -32,7 +32,7 @@ the minimum jdk is currently JDK 8
 
 ### ide setup
 
-openapi-generatr can be imported into IntelliJ IDEA by opening the `build.gradle` file.
+openapi-processor can be imported into IntelliJ IDEA by opening the `build.gradle` file.
 
 ### running the tests
 
@@ -44,3 +44,4 @@ To run the tests use `./gradlew check`.
 
 The documentation is in `docs`. See the `README` in `docs` for setup and viewing it locally.
 
+[oap-int-resources]: https://github.com/hauner/openapi-processor-spring/tree/master/src/testInt/resources

README.md

@@ -1,28 +1,30 @@
-[![][badge-license]][generatr-license]
+[![][badge-license]][oap-license]
 [![][badge-ci]][workflow-ci]
 
-# openapi-generatr-spring
+![openapi-processor-spring logo](images/openapi-processor-spring@1280x200.png)
+
+# openapi-processor-spring
 
 a simple [OpenAPI][openapi] interface only code generator for [Spring Boot][springboot].
 
 
 # Getting Started
 
-See the [documentation][generatr-doc].
+See the [documentation][oap-doc].
 
 
 # Sample
 
-See [`openapi-generatr-spring-mvc-sample`][generatr-sample] for a complete working sample of a minimal
+See [`openapi-processor-spring-mvc-sample`][oap-sample] for a complete working sample of a minimal
  openapi.yaml.
 
 # Features & Bugs
 
-In case some feature is missing or the generated code is not 100% what you would expect create an issue
-with test case. Providing a test case will help significantly :-) 
+In case some feature is missing or the generated code is not 100% what you would expect create an
+ issue with test case. Providing a test case will help significantly :-) 
 
-A test case is a single folder with an openapi.yaml file and the expected Java files the generatr should create.
-The structure looks like this:
+A test case is a single folder with an openapi.yaml file and the expected Java files the processor
+ should create. The structure looks like this:
 
     my-new-test-case/
                      openapi.yaml
@@ -38,12 +40,12 @@ The structure looks like this:
 
 The `mapping.yaml` contains the type mapping information.
 
-See the [existing integration tests][generatr-int-resources] for a couple of examples. 
+See the [existing integration tests][oap-int-resources] for a couple of examples. 
 
 [badge-license]: https://img.shields.io/badge/License-Apache%202.0-blue.svg?labelColor=313A42
 [badge-ci]: https://github.com/hauner/openapi-generatr-spring/workflows/ci/badge.svg
 
-[workflow-ci]: https://github.com/hauner/openapi-generatr-spring/actions?query=workflow%3Aci
+[workflow-ci]: https://github.com/hauner/openapi-processor-spring/actions?query=workflow%3Aci
 
 [openapi]: https://www.openapis.org/
 [openapi-spec]: https://github.com/OAI/OpenAPI-Specification
@@ -54,8 +56,8 @@ See the [existing integration tests][generatr-int-resources] for a couple of exa
 [spring-requestparam]: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/web/bind/annotation/RequestParam.html
 [spring-responseentity]: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/http/ResponseEntity.html
 
-[generatr-license]: https://github.com/hauner/openapi-generatr-spring/blob/master/LICENSE
-[generatr-doc]: https://hauner.github.io/openapi-generatr-spring/
-[generatr-int-resources]: https://github.com/hauner/openapi-generatr-spring/tree/master/src/testInt/resources
-[generatr-gradle]: https://github.com/hauner/openapi-generatr-gradle
-[generatr-sample]: https://github.com/hauner/openapi-generatr-spring-mvc-sample
+[oap-license]: https://github.com/hauner/openapi-generatr-spring/blob/master/LICENSE
+[oap-doc]: https://hauner.github.io/openapi-processor-spring/
+[oap-int-resources]: https://github.com/hauner/openapi-processor-spring/tree/master/src/testInt/resources
+[oap-gradle]: https://github.com/hauner/openapi-processor-gradle
+[oap-sample]: https://github.com/hauner/openapi-generatr-spring-mvc-sample

build.gradle

@@ -16,7 +16,7 @@ sourceCompatibility = JavaVersion.VERSION_1_8
 targetCompatibility = JavaVersion.VERSION_1_8
 
 ext {
-    generatrApiVersion = '1.0.0.M3'
+    processorApiVersion = '1.0.0.M4'
 
     bintrayUser = project.hasProperty ('BINTRAY_USER') ? BINTRAY_USER : 'n/a'
     bintrayKey =  project.hasProperty ('BINTRAY_KEY')  ? BINTRAY_KEY  : 'n/a'
@@ -30,7 +30,7 @@ repositories {
         url "https://oss.sonatype.org/content/repositories/snapshots"
     }
     maven {
-        url  "https://dl.bintray.com/hauner/openapi-generatr"
+        url  "https://dl.bintray.com/hauner/openapi-processor"
     }
 }
 
@@ -49,7 +49,7 @@ dependencies {
     implementation 'org.jetbrains.kotlin:kotlin-stdlib'
     implementation 'io.swagger.parser.v3:swagger-parser:2.0.17'
     implementation 'com.google.googlejavaformat:google-java-format:1.7'
-    compileOnly "com.github.hauner.openapi:openapi-generatr-api:$generatrApiVersion"
+    compileOnly "com.github.hauner.openapi:openapi-processor-api:$processorApiVersion"
 
     testImplementation ('org.spockframework:spock-core:2.0-M2-groovy-3.0') {
         exclude group: 'org.codehaus.groovy'
@@ -60,7 +60,7 @@ dependencies {
     testImplementation 'net.bytebuddy:byte-buddy:1.10.7'
     testImplementation 'ch.qos.logback:logback-classic:1.2.3'
 
-    testIntImplementation "com.github.hauner.openapi:openapi-generatr-api:$generatrApiVersion"
+    testIntImplementation "com.github.hauner.openapi:openapi-processor-api:$processorApiVersion"
     testIntImplementation 'io.github.java-diff-utils:java-diff-utils:4.5'
 //    testIntRuntimeOnly 'org.slf4j:slf4j-simple:1.7.30'
 //    testIntRuntimeOnly 'org.slf4j:slf4j-nop:1.6.1'
@@ -93,14 +93,14 @@ dokka {
 bintray {
     user = bintrayUser
     key = bintrayKey
-    publications = ['GeneratrSpring']
+    publications = ['processor']
 
     pkg {
-        repo = 'openapi-generatr'
-        name = 'openapi-generatr-spring'
+        repo = 'openapi-processor'
+        name = 'openapi-processor-spring'
         //userOrg = 'openapi-generatr'
         licenses = ['Apache-2.0']
-        vcsUrl = 'https://github.com/hauner/openapi-generatr-spring'
+        vcsUrl = 'https://github.com/hauner/openapi-processor-spring'
 
         version {
             name = project.version
@@ -110,7 +110,7 @@ bintray {
 
 publishing {
     publications {
-        GeneratrSpring (MavenPublication) {
+        processor (MavenPublication) {
             from components.java
             artifact sourcesJar
             artifact javadocJar

images/openapi-processor-spring@1280x200.png

@@ -1 +1 @@
-rootProject.name = 'openapi-generatr-spring'
+rootProject.name = 'openapi-processor-spring'

images/openapi-processor-spring@1280x640.png

@@ -14,21 +14,21 @@
  * limitations under the License.
  */
 
-package com.github.hauner.openapi.spring.generatr
+package com.github.hauner.openapi.spring.processor
 
 import com.github.hauner.openapi.spring.converter.mapping.AddParameterTypeMapping
 import com.github.hauner.openapi.spring.converter.mapping.EndpointTypeMapping
 import com.github.hauner.openapi.spring.converter.mapping.Mapping
 import com.github.hauner.openapi.spring.converter.mapping.ParameterTypeMapping
 import com.github.hauner.openapi.spring.converter.mapping.ResponseTypeMapping
 import com.github.hauner.openapi.spring.converter.mapping.TypeMapping
-import com.github.hauner.openapi.spring.generatr.mapping.AdditionalParameter
-import com.github.hauner.openapi.spring.generatr.mapping.Mapping as YamlMapping
-import com.github.hauner.openapi.spring.generatr.mapping.Parameter
-import com.github.hauner.openapi.spring.generatr.mapping.Path
-import com.github.hauner.openapi.spring.generatr.mapping.RequestParameter
-import com.github.hauner.openapi.spring.generatr.mapping.Response
-import com.github.hauner.openapi.spring.generatr.mapping.Type
+import com.github.hauner.openapi.spring.processor.mapping.AdditionalParameter
+import com.github.hauner.openapi.spring.processor.mapping.Mapping as YamlMapping
+import com.github.hauner.openapi.spring.processor.mapping.Parameter
+import com.github.hauner.openapi.spring.processor.mapping.Path
+import com.github.hauner.openapi.spring.processor.mapping.RequestParameter
+import com.github.hauner.openapi.spring.processor.mapping.Response
+import com.github.hauner.openapi.spring.processor.mapping.Type
 
 import java.util.regex.Matcher
 import java.util.regex.Pattern

settings.gradle

@@ -14,16 +14,16 @@
  * limitations under the License.
  */
 
-package com.github.hauner.openapi.spring.generatr
+package com.github.hauner.openapi.spring.processor
 
 import com.fasterxml.jackson.databind.DeserializationFeature
 import com.fasterxml.jackson.databind.ObjectMapper
 import com.fasterxml.jackson.databind.PropertyNamingStrategy
 import com.fasterxml.jackson.databind.module.SimpleModule
 import com.fasterxml.jackson.dataformat.yaml.YAMLFactory
-import com.github.hauner.openapi.spring.generatr.mapping.Mapping
-import com.github.hauner.openapi.spring.generatr.mapping.Parameter
-import com.github.hauner.openapi.spring.generatr.mapping.ParameterDeserializer
+import com.github.hauner.openapi.spring.processor.mapping.Mapping
+import com.github.hauner.openapi.spring.processor.mapping.Parameter
+import com.github.hauner.openapi.spring.processor.mapping.ParameterDeserializer
 
 import java.util.regex.Pattern
 

…/spring/generatr/MappingConverter.groovy …spring/processor/MappingConverter.groovysrc/main/groovy/com/github/hauner/openapi/spring/generatr/MappingConverter.groovy renamed to src/main/groovy/com/github/hauner/openapi/spring/processor/MappingConverter.groovy src/main/groovy/com/github/hauner/openapi/spring/generatr/MappingConverter.groovy renamed to src/main/groovy/com/github/hauner/openapi/spring/processor/MappingConverter.groovy

@@ -14,9 +14,9 @@
  * limitations under the License.
  */
 
-package com.github.hauner.openapi.spring.generatr
+package com.github.hauner.openapi.spring.processor
 
-import com.github.hauner.openapi.api.OpenApiGeneratr
+import com.github.hauner.openapi.api.OpenApiProcessor
 import com.github.hauner.openapi.spring.converter.ApiConverter
 import com.github.hauner.openapi.spring.converter.ApiOptions
 import com.github.hauner.openapi.spring.writer.ApiWriter
@@ -31,34 +31,34 @@ import io.swagger.v3.parser.core.models.ParseOptions
 import io.swagger.v3.parser.core.models.SwaggerParseResult
 
 /**
- *  Entry point of openapi-generatr-spring.
+ *  Entry point of openapi-processor-spring.
  *
  *  @author Martin Hauner
  *  @author Bastian Wilhelm
  */
-class SpringGeneratr implements OpenApiGeneratr {
+class SpringProcessor implements OpenApiProcessor {
 
     @Override
     String getName () {
         return 'spring'
     }
 
     @Override
-    void run (Map<String, ?> generatrOptions) {
+    void run (Map<String, ?> processorOptions) {
         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.
             resolve: true
         )
 
         SwaggerParseResult result = new OpenAPIV3Parser ()
-            .readLocation (generatrOptions.apiPath as String, null, opts)
+            .readLocation (processorOptions.apiPath as String, null, opts)
 
-        if (generatrOptions.showWarnings) {
+        if (processorOptions.showWarnings) {
             printWarnings(result.messages)
         }
 
-        def options = convertOptions (generatrOptions)
+        def options = convertOptions (processorOptions)
         def cv = new ApiConverter(options)
         def api = cv.convert (result.openAPI)
 
@@ -86,30 +86,30 @@ class SpringGeneratr implements OpenApiGeneratr {
         writer.write (api)
     }
 
-    private ApiOptions convertOptions (Map<String, ?> generatrOptions) {
+    private ApiOptions convertOptions (Map<String, ?> processorOptions) {
         def reader = new MappingReader ()
         def converter = new MappingConverter ()
         def mapping
 
-        if (generatrOptions.containsKey ('mapping')) {
-            mapping = reader.read (generatrOptions.mapping as String)
+        if (processorOptions.containsKey ('mapping')) {
+            mapping = reader.read (processorOptions.mapping as String)
 
-        } else if (generatrOptions.containsKey ('typeMappings')) {
-            mapping = reader.read (generatrOptions.typeMappings as String)
+        } else if (processorOptions.containsKey ('typeMappings')) {
+            mapping = reader.read (processorOptions.typeMappings as String)
             println "warning: 'typeMappings' option is deprecated, use 'mapping'!"
         }
 
         def options = new ApiOptions ()
-        options.apiPath = generatrOptions.apiPath
-        options.targetDir = generatrOptions.targetDir
+        options.apiPath = processorOptions.apiPath
+        options.targetDir = processorOptions.targetDir
 
-        if (generatrOptions.packageName) {
-            options.packageName = generatrOptions.packageName
+        if (processorOptions.packageName) {
+            options.packageName = processorOptions.packageName
             println "warning: 'options:package-name' should be set in the mapping yaml!"
         }
 
-        if (generatrOptions.containsKey ('beanValidation')) {
-            options.beanValidation = generatrOptions.beanValidation
+        if (processorOptions.containsKey ('beanValidation')) {
+            options.beanValidation = processorOptions.beanValidation
             println "warning: 'options:bean-validation' should be set in the mapping yaml!"
         }
 

…api/spring/generatr/MappingReader.groovy …pi/spring/processor/MappingReader.groovysrc/main/groovy/com/github/hauner/openapi/spring/generatr/MappingReader.groovy renamed to src/main/groovy/com/github/hauner/openapi/spring/processor/MappingReader.groovy src/main/groovy/com/github/hauner/openapi/spring/generatr/MappingReader.groovy renamed to src/main/groovy/com/github/hauner/openapi/spring/processor/MappingReader.groovy

@@ -14,10 +14,7 @@
  * limitations under the License.
  */
 
-package com.github.hauner.openapi.spring.generatr.mapping
-
-import com.fasterxml.jackson.annotation.JsonProperty
-
+package com.github.hauner.openapi.spring.processor.mapping
 /**
  * a "parameters:" add parameter entry in the mapping yaml
  *