renamed project

Author: hauner

README.md

@@ -1,60 +1,51 @@
-[![][badge-license]][generatr-license]
+[![][badge-license]][oap-license]
 [![][badge-ci]][workflow-ci]
 
-# openapi-generatr-json
+![openapi-processor-api logo](images/openapi-processor-json@1280x200.png)
 
-a simple [OpenAPI][openapi] yaml to json generatr.
- 
 
-# Getting Started
+# openapi-processor-json
 
-The openapi generatr [gradle plugin][generatr-gradle] is the easiest way to use yaml to json generatr. 
+a simple [OpenAPI][openapi] yaml to json converter.
+ 
 
-## adding generatr-json
+# Getting Started
 
-The plugin provides a `openapiGeneratr` dependency configuration that is used to add the generatr dependency.
+The openapi processor [gradle plugin][opa-gradle] is the easiest way to use the yaml to json processor. 
 
-        dependencies {
-            // 'openapiGeneratr' is a custom configuration that is used by the gradle plugin.
-            openapiGeneratr 'com.github.hauner.openapi:openapi-generatr-json:1.0.0.M1'
-            
-            // .... 
-            // normal project dependencies
-            // .... 
-        }
-        
-## configuring generatr-json
+## configuring openapi-processor-json
 
-The plugin will add an `openapiGeneratr` configuration block that is used to configure the generatrs.
-Configuration for a specific generatr is placed inside it using the generatr name as configuration
-block name.   
+The plugin will add an `openapiGeneratr` configuration block that is used to configure the openapi processors.
+Configuration for a specific processor is placed inside it using the processor name (in this case `json`) as
+configuration block name.   
 
-        openapiGeneratr {
+        openapiProcessor {
 
             json {
+                processor 'com.github.hauner.openapi:openapi-processor-json:1.0.0.Mx'
+            
                 apiPath = "$projectDir/src/api/openapi.yaml"
                 targetDir = "$projectDir/build/openapi"
             }        
 
         }
         
-- `apiPath`: (**required**) the path to the `openapi.yaml` file and the main input for the generatr.
+- `apiPath`: (**required**) the path to the `openapi.yaml` file and the main input for the processor.
 
 - `targetDir`: (**required**) the output folder for generating the `openapi.json` file.
 
 # Sample
 
-See [`openapi-generatr-spring-mvc-sample`][generatr-sample] for a complete working sample of a minimal
- openapi.yaml.
+See [`openapi-processor-spring-mvc-sample`][oap-sample] for a complete working sample of a minimal openapi.yaml.
 
 
 [badge-license]: https://img.shields.io/badge/License-Apache%202.0-blue.svg?labelColor=313A42
-[badge-ci]: https://github.com/hauner/openapi-generatr-json/workflows/ci/badge.svg
+[badge-ci]: https://github.com/hauner/openapi-processor-json/workflows/ci/badge.svg
 
-[workflow-ci]: https://github.com/hauner/openapi-generatr-json/actions?query=workflow%3Aci
+[workflow-ci]: https://github.com/hauner/openapi-processor-json/actions?query=workflow%3Aci
 
 [openapi]: https://www.openapis.org/
 
-[generatr-license]: https://github.com/hauner/openapi-generatr-json/blob/master/LICENSE
-[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-processor-json/blob/master/LICENSE
+[oap-gradle]: https://github.com/hauner/openapi-processor-gradle
+[oap-sample]: https://github.com/hauner/openapi-generatr-spring-mvc-sample

build.gradle.kts

@@ -6,17 +6,17 @@ plugins {
 }
 
 group = "com.github.hauner.openapi"
-version = "1.0.0.M2"
+version = "1.0.0.M3"
 
 repositories {
     mavenCentral()
     maven {
-        setUrl("https://dl.bintray.com/hauner/openapi-generatr")
+        setUrl("https://dl.bintray.com/hauner/openapi-processor")
     }
 }
 
 project.ext {
-    set("generatrApiVersion", "1.0.0.M3")
+    set("generatrApiVersion", "1.0.0.M4")
 
     set("bintrayUser", project.findProperty("BINTRAY_USER") ?: "n/a")
     set("bintrayKey", project.findProperty("BINTRAY_KEY") ?: "n/a")
@@ -27,12 +27,12 @@ dependencies {
     implementation(kotlin("stdlib"))
 
     implementation("io.swagger.parser.v3:swagger-parser:2.0.12")
-    compileOnly("com.github.hauner.openapi:openapi-generatr-api:${project.ext.get("generatrApiVersion")}")
+    compileOnly("com.github.hauner.openapi:openapi-processor-api:${project.ext.get("generatrApiVersion")}")
 
     testImplementation("net.bytebuddy:byte-buddy:1.9.13")
     testImplementation("org.spockframework:spock-core:1.3-groovy-2.5")
     testImplementation("io.github.java-diff-utils:java-diff-utils:4.0")
-    testImplementation("com.github.hauner.openapi:openapi-generatr-api:${project.ext.get("generatrApiVersion")}")
+    testImplementation("com.github.hauner.openapi:openapi-processor-api:${project.ext.get("generatrApiVersion")}")
 }
 
 tasks.withType<org.jetbrains.kotlin.gradle.tasks.KotlinCompile> {
@@ -64,14 +64,14 @@ bintray {
     user = project.ext.get("bintrayUser").toString()
     key = project.ext.get("bintrayKey").toString()
 
-    setPublications("GeneratrJson")
+    setPublications("processor")
 
     pkg.apply {
-        repo = "openapi-generatr"
-        name = "openapi-generatr-json"
+        repo = "openapi-processor"
+        name = "openapi-processor-json"
         //userOrg = 'openapi-generatr'
         setLicenses("Apache-2.0")
-        vcsUrl = "https://github.com/hauner/openapi-generatr-json"
+        vcsUrl = "https://github.com/hauner/openapi-processor-json"
 
         version.apply {
             name = project.version.toString()
@@ -81,7 +81,7 @@ bintray {
 
 publishing {
     publications {
-        create<MavenPublication>("GeneratrJson") {
+        create<MavenPublication>("processor") {
             from(components["java"])
             artifact(sourcesJar.get())
             artifact(javadocJar.get())

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

@@ -1,2 +1 @@
-rootProject.name = "openapi-generatr-json"
-
+rootProject.name = "openapi-processor-json"

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

@@ -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.
@@ -14,21 +14,21 @@
  * limitations under the License.
  */
 
-package com.github.hauner.openapi.json.generatr
+package com.github.hauner.openapi.json.processor
 
-import com.github.hauner.openapi.api.OpenApiGeneratr
+import com.github.hauner.openapi.api.OpenApiProcessor
 import io.swagger.v3.core.util.Json
 import io.swagger.v3.parser.OpenAPIV3Parser
 import io.swagger.v3.parser.core.models.ParseOptions
 import io.swagger.v3.parser.core.models.SwaggerParseResult
 import java.io.File
 
 /**
- *  Entry point of the openapi-generatr-json.
+ *  Entry point of the openapi-processor-json.
  *
  *  @author Martin Hauner
  */
-class JsonGeneratr : OpenApiGeneratr {
+class JsonProcessor : OpenApiProcessor {
 
     /**
      * provides the generatr name.
@@ -38,26 +38,26 @@ class JsonGeneratr : OpenApiGeneratr {
     }
 
     /**
-     * runs the generatr.
+     * runs the processor.
      *
      * the options map should contain the following key/value pairs:
      *
-     * - apiPath: (required) the path to the openapi.yaml file and the main input for the generatr.
+     * - apiPath: (required) the path to the openapi.yaml file and the main input for the processor.
      * - targetDir: (required) the output folder for generating the openapi.json file.
      *
-     * @param options map of generatr properties
+     * @param options map of processor properties
      */
     override fun run(options: MutableMap<String, *>) {
         val apiPath: String? = options["apiPath"]?.toString()
         val targetDir: String? = options["targetDir"]?.toString()
 
         if (apiPath == null) {
-            println("openapi-generatr-json: missing apiPath!")
+            println("openapi-processor-json: missing apiPath!")
             return
         }
 
         if (targetDir == null) {
-            println("openapi-generatr-json: missing targetDir!")
+            println("openapi-processor-json: missing targetDir!")
             return
         }
 

settings.gradle.kts

@@ -0,0 +1 @@
+com.github.hauner.openapi.json.processor.JsonProcessor

src/main/kotlin/com/github/hauner/openapi/json/generatr/JsonGeneratr.kt renamed to src/main/kotlin/com/github/hauner/openapi/json/processor/JsonProcessor.kt

@@ -14,15 +14,15 @@
  * limitations under the License.
  */
 
-package com.github.hauner.openapi.json.generatr
+package com.github.hauner.openapi.json.processor
 
 import com.github.difflib.DiffUtils
 import com.github.difflib.UnifiedDiffUtils
 import org.junit.Rule
 import org.junit.rules.TemporaryFolder
 import spock.lang.Specification
 
-class JsonGeneratrSpec extends Specification {
+class JsonProcessorSpec extends Specification {
 
     @Rule
     public TemporaryFolder folder = new TemporaryFolder()
@@ -39,7 +39,7 @@ class JsonGeneratrSpec extends Specification {
         ]
 
         when:
-        def generatr = new JsonGeneratr()
+        def generatr = new JsonProcessor()
         generatr.run (options)
 
         then: