Rename fields and methods according to discussions in PR eclipse-vertx#101

Author: lukasjelonek

src/main/java/io/vertx/openapi/contract/OpenAPIContract.java

@@ -15,26 +15,14 @@
 import io.vertx.codegen.annotations.Nullable;
 import io.vertx.codegen.annotations.VertxGen;
 import io.vertx.core.Future;
-import io.vertx.core.Promise;
 import io.vertx.core.Vertx;
 import io.vertx.core.http.HttpMethod;
-import io.vertx.core.internal.ContextInternal;
 import io.vertx.core.json.JsonObject;
-import io.vertx.json.schema.JsonSchema;
-import io.vertx.json.schema.JsonSchemaValidationException;
 import io.vertx.json.schema.SchemaRepository;
-import io.vertx.openapi.contract.impl.OpenAPIContractImpl;
 
-import java.util.ArrayList;
-import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 
-import static io.vertx.core.Future.failedFuture;
-import static io.vertx.openapi.contract.OpenAPIContractException.createInvalidContract;
-import static io.vertx.openapi.impl.Utils.readYamlOrJson;
-import static java.util.Collections.emptyMap;
-
 @VertxGen
 public interface OpenAPIContract {
 
@@ -89,7 +77,7 @@ static Future<OpenAPIContract> from(Vertx vertx, String unresolvedContractPath,
 
     return builder(vertx)
       .setContract(unresolvedContractPath)
-      .setAdditionalContentFiles(additionalContractFiles)
+      .setAdditionalContractFiles(additionalContractFiles)
       .build();
   }
 
@@ -110,7 +98,7 @@ static Future<OpenAPIContract> from(Vertx vertx, JsonObject unresolvedContract,
       return Future.failedFuture(OpenAPIContractException.createInvalidContract("Spec must not be null"));
     return builder(vertx)
       .setContract(unresolvedContract)
-      .setAdditionalContent(additionalContractFiles)
+      .setAdditionalContracts(additionalContractFiles)
       .build();
   }
 

src/main/java/io/vertx/openapi/contract/OpenAPIContractBuilder.java

@@ -43,16 +43,16 @@ public OpenAPIContractBuilderException(String message) {
   private final Vertx vertx;
   private String contractFile;
   private JsonObject contract;
-  private final Map<String, String> additionalContentFiles = new HashMap<>();
-  private final Map<String, JsonObject> additionalContent = new HashMap<>();
+  private final Map<String, String> additionalContractFiles = new HashMap<>();
+  private final Map<String, JsonObject> additionalContracts = new HashMap<>();
 
   public OpenAPIContractBuilder(Vertx vertx) {
     this.vertx = vertx;
   }
 
   /**
    * Sets the path to the contract file. Either provide the path to the contract or the parsed contract,
-   * not both. Overrides the contract set by {@link #contract(JsonObject)}.
+   * not both. Overrides the contract set by {@link #setContract(JsonObject)}.
    *
    * @param contractPath The path to the contract file
    * @return The builder, for a fluent interface
@@ -65,7 +65,7 @@ public OpenAPIContractBuilder setContract(String contractPath) {
 
   /**
    * Sets the contract. Either provide the contract or the path to the contract,
-   * not both. Overrides the contract set by {@link #contract(String)}.
+   * not both. Overrides the contract set by {@link #setContract(String)}.
    *
    * @param contract The parsed contract
    * @return The builder, for a fluent interface
@@ -85,26 +85,26 @@ public OpenAPIContractBuilder setContract(JsonObject contract) {
    * @param path The path to the contract file.
    * @return The builder, for a fluent interface
    */
-  public OpenAPIContractBuilder putAdditionalContentFile(String key, String path) {
-    additionalContentFiles.put(key, path);
-    additionalContent.remove(key);
+  public OpenAPIContractBuilder putAdditionalContractFile(String key, String path) {
+    additionalContractFiles.put(key, path);
+    additionalContracts.remove(key);
     return this;
   }
 
   /**
    * Uses the contract files from the provided map to resolve referenced contracts.
-   * Replaces all previously put contracts by {@link #putAdditionalContentFile(String, String)}.
-   * If the same key is used also overrides the contracts set by {@link #putAdditionalContent(String, JsonObject)}
-   * and {@link #setAdditionalContent(Map)}.
+   * Replaces all previously put contracts by {@link #putAdditionalContractFile(String, String)}.
+   * If the same key is used also overrides the contracts set by {@link #putAdditionalContract(String, JsonObject)}
+   * and {@link #setAdditionalContracts(Map)}.
    *
    * @param contractFiles A map that contains all additional contract files.
    * @return The builder, for a fluent interface.
    */
-  public OpenAPIContractBuilder setAdditionalContentFiles(Map<String, String> contractFiles) {
-    additionalContentFiles.clear();
+  public OpenAPIContractBuilder setAdditionalContractFiles(Map<String, String> contractFiles) {
+    additionalContractFiles.clear();
     for (var e : contractFiles.entrySet()) {
-      putAdditionalContentFile(e.getKey(), e.getValue());
-      additionalContent.remove(e.getKey());
+      putAdditionalContractFile(e.getKey(), e.getValue());
+      additionalContracts.remove(e.getKey());
     }
     return this;
   }
@@ -118,26 +118,26 @@ public OpenAPIContractBuilder setAdditionalContentFiles(Map<String, String> cont
    * @param content The parsed contract.
    * @return The builder, for a fluent interface
    */
-  public OpenAPIContractBuilder putAdditionalContent(String key, JsonObject content) {
-    additionalContent.put(key, content);
-    additionalContentFiles.remove(key);
+  public OpenAPIContractBuilder putAdditionalContract(String key, JsonObject content) {
+    additionalContracts.put(key, content);
+    additionalContractFiles.remove(key);
     return this;
   }
 
   /**
    * Uses the contracts from the provided map to resolve referenced contracts.
-   * Replaces all previously put contracts by {@link #putAdditionalContent(String, JsonObject)}.
-   * If the same key is used also replaces the contracts set by {@link #putAdditionalContentFile(String, String)}
-   * and {@link #setAdditionalContentFiles(Map)}.
+   * Replaces all previously put contracts by {@link #putAdditionalContract(String, JsonObject)}.
+   * If the same key is used also replaces the contracts set by {@link #putAdditionalContractFile(String, String)}
+   * and {@link #setAdditionalContractFiles(Map)}.
    *
    * @param contracts A map that contains all additional contract files.
    * @return The builder, for a fluent interface.
    */
-  public OpenAPIContractBuilder setAdditionalContent(Map<String, JsonObject> contracts) {
-    additionalContent.clear();
+  public OpenAPIContractBuilder setAdditionalContracts(Map<String, JsonObject> contracts) {
+    additionalContracts.clear();
     for (var e : contracts.entrySet()) {
-      putAdditionalContent(e.getKey(), e.getValue());
-      additionalContentFiles.remove(e.getKey());
+      putAdditionalContract(e.getKey(), e.getValue());
+      additionalContractFiles.remove(e.getKey());
     }
     return this;
   }
@@ -157,7 +157,7 @@ public Future<OpenAPIContract> build() {
       : Utils.readYamlOrJson(vertx, contractFile);
 
     var resolvedContracts = Future
-      .succeededFuture(additionalContent)
+      .succeededFuture(additionalContracts)
       .compose(x -> readContractFiles()
         .map(r -> {
           var all = new HashMap<>(x);
@@ -169,12 +169,12 @@ public Future<OpenAPIContract> build() {
       .compose(x -> {
         JsonObject contract = x.resultAt(0);
         Map<String, JsonObject> other = x.resultAt(1);
-        return from(contract, other);
+        return buildOpenAPIContract(contract, other);
       });
   }
 
-  private Future<OpenAPIContract> from(JsonObject unresolvedContract,
-                                       Map<String, JsonObject> additionalContractFiles) {
+  private Future<OpenAPIContract> buildOpenAPIContract(JsonObject unresolvedContract,
+                                                       Map<String, JsonObject> additionalContractFiles) {
     if (unresolvedContract == null) {
       return failedFuture(createInvalidContract("Spec must not be null"));
     }
@@ -221,10 +221,10 @@ private Future<OpenAPIContract> from(JsonObject unresolvedContract,
   }
 
   private Future<Map<String, JsonObject>> readContractFiles() {
-    if (additionalContentFiles.isEmpty()) return Future.succeededFuture(Map.of());
+    if (additionalContractFiles.isEmpty()) return Future.succeededFuture(Map.of());
 
     var read = new HashMap<String, JsonObject>();
-    return Future.all(additionalContentFiles.entrySet().stream()
+    return Future.all(additionalContractFiles.entrySet().stream()
         .map(e -> Utils.readYamlOrJson(vertx, e.getValue())
           .map(c -> read.put(e.getKey(), c)))
         .collect(Collectors.toList()))

src/test/java/io/vertx/tests/contract/OpenAPIContractBuilderTest.java

@@ -54,7 +54,7 @@ void should_create_contract_when_valid_contract_is_provided(Vertx vertx, VertxTe
   void should_create_contract_when_valid_contract_file_and_additional_file_is_provided(Vertx vertx, VertxTestContext ctx) {
     OpenAPIContract.builder(vertx)
       .setContract("io/vertx/tests/contract/from_with_path_and_additional_files/petstore.json")
-      .putAdditionalContentFile("https://example.com/petstore", "io/vertx/tests/contract/from_with_path_and_additional_files/components.json")
+      .putAdditionalContractFile("https://example.com/petstore", "io/vertx/tests/contract/from_with_path_and_additional_files/components.json")
       .build()
       .onComplete(ctx.succeedingThenComplete());
   }
@@ -64,7 +64,7 @@ void should_create_contract_when_valid_contract_and_additional_file_is_provided(
     var contract = vertx.fileSystem().readFileBlocking("io/vertx/tests/contract/from_with_path_and_additional_files/petstore.json").toJsonObject();
     OpenAPIContract.builder(vertx)
       .setContract(contract)
-      .putAdditionalContentFile("https://example.com/petstore", "io/vertx/tests/contract/from_with_path_and_additional_files/components.json")
+      .putAdditionalContractFile("https://example.com/petstore", "io/vertx/tests/contract/from_with_path_and_additional_files/components.json")
       .build()
       .onComplete(ctx.succeedingThenComplete());
   }
@@ -74,7 +74,7 @@ void should_create_contract_when_valid_contract_file_and_additional_content_is_p
     var components = vertx.fileSystem().readFileBlocking("io/vertx/tests/contract/from_with_path_and_additional_files/components.json").toJsonObject();
     OpenAPIContract.builder(vertx)
       .setContract("io/vertx/tests/contract/from_with_path_and_additional_files/petstore.json")
-      .putAdditionalContent("https://example.com/petstore", components)
+      .putAdditionalContract("https://example.com/petstore", components)
       .build()
       .onComplete(ctx.succeedingThenComplete());
   }
@@ -135,9 +135,9 @@ private JsonObject content(String path) {
     void set_additional_content_should_override_existing_file(Vertx vertx) {
       var c = OpenAPIContract.builder(vertx)
         .setContract("io/vertx/tests/builder/contract.yaml")
-        .putAdditionalContentFile(REF1_ID, REF1_1_FILE)
-        .putAdditionalContentFile(REF2_ID, REF2_1_FILE)
-        .setAdditionalContent(Map.of(REF1_ID, content(REF1_2_FILE)))
+        .putAdditionalContractFile(REF1_ID, REF1_1_FILE)
+        .putAdditionalContractFile(REF2_ID, REF2_1_FILE)
+        .setAdditionalContracts(Map.of(REF1_ID, content(REF1_2_FILE)))
         .build()
         .await();
       should_have(c, "ref1.2", "ref2.1");
@@ -147,9 +147,9 @@ void set_additional_content_should_override_existing_file(Vertx vertx) {
     void put_additional_content_should_override_existing_file(Vertx vertx) {
       var c = OpenAPIContract.builder(vertx)
         .setContract("io/vertx/tests/builder/contract.yaml")
-        .putAdditionalContentFile(REF1_ID, REF1_1_FILE)
-        .putAdditionalContentFile(REF2_ID, REF2_1_FILE)
-        .putAdditionalContent(REF1_ID, content(REF1_2_FILE))
+        .putAdditionalContractFile(REF1_ID, REF1_1_FILE)
+        .putAdditionalContractFile(REF2_ID, REF2_1_FILE)
+        .putAdditionalContract(REF1_ID, content(REF1_2_FILE))
         .build()
         .await();
       should_have(c, "ref1.2", "ref2.1");
@@ -159,9 +159,9 @@ void put_additional_content_should_override_existing_file(Vertx vertx) {
     void set_additional_content_file_should_override_existing_content(Vertx vertx) {
       var c = OpenAPIContract.builder(vertx)
         .setContract("io/vertx/tests/builder/contract.yaml")
-        .putAdditionalContent(REF1_ID, content(REF1_1_FILE))
-        .putAdditionalContent(REF2_ID, content(REF2_1_FILE))
-        .setAdditionalContentFiles(Map.of(REF2_ID, REF2_2_FILE))
+        .putAdditionalContract(REF1_ID, content(REF1_1_FILE))
+        .putAdditionalContract(REF2_ID, content(REF2_1_FILE))
+        .setAdditionalContractFiles(Map.of(REF2_ID, REF2_2_FILE))
         .build()
         .await();
       should_have(c, "ref1.1", "ref2.2");
@@ -171,9 +171,9 @@ void set_additional_content_file_should_override_existing_content(Vertx vertx) {
     void put_additional_content_file_should_override_existing_content_file(Vertx vertx) {
       var c = OpenAPIContract.builder(vertx)
         .setContract("io/vertx/tests/builder/contract.yaml")
-        .putAdditionalContent(REF1_ID, content(REF1_1_FILE))
-        .putAdditionalContent(REF2_ID, content(REF2_1_FILE))
-        .putAdditionalContentFile(REF2_ID, REF2_2_FILE)
+        .putAdditionalContract(REF1_ID, content(REF1_1_FILE))
+        .putAdditionalContract(REF2_ID, content(REF2_1_FILE))
+        .putAdditionalContractFile(REF2_ID, REF2_2_FILE)
         .build()
         .await();
       should_have(c, "ref1.1", "ref2.2");
@@ -192,9 +192,9 @@ private void should_have(OpenAPIContract contract, String requestDescription, St
     void set_additional_content_should_replace_existing_content(Vertx vertx) {
       var c = OpenAPIContract.builder(vertx)
         .setContract("io/vertx/tests/builder/contract.yaml")
-        .putAdditionalContent(REF1_ID, content(REF1_1_FILE))
-        .putAdditionalContent(REF2_ID, content(REF2_1_FILE))
-        .setAdditionalContent(Map.of(REF2_ID, content(REF2_2_FILE)))
+        .putAdditionalContract(REF1_ID, content(REF1_1_FILE))
+        .putAdditionalContract(REF2_ID, content(REF2_1_FILE))
+        .setAdditionalContracts(Map.of(REF2_ID, content(REF2_2_FILE)))
         .build()
         .await();
       assertThat(c.getSchemaRepository().find(REF1_ID)).isNull();
@@ -204,9 +204,9 @@ void set_additional_content_should_replace_existing_content(Vertx vertx) {
     void set_additional_content_files_should_replace_existing_content_files(Vertx vertx) {
       var c = OpenAPIContract.builder(vertx)
         .setContract("io/vertx/tests/builder/contract.yaml")
-        .putAdditionalContentFile(REF1_ID, REF1_1_FILE)
-        .putAdditionalContentFile(REF2_ID, REF2_1_FILE)
-        .setAdditionalContentFiles(Map.of(REF2_ID, REF2_2_FILE))
+        .putAdditionalContractFile(REF1_ID, REF1_1_FILE)
+        .putAdditionalContractFile(REF2_ID, REF2_1_FILE)
+        .setAdditionalContractFiles(Map.of(REF2_ID, REF2_2_FILE))
         .build()
         .await();
       assertThat(c.getSchemaRepository().find(REF1_ID)).isNull();