Skip to content

Commit b01e336

Browse files
lukasjeloneklukasjelonek
committed
Rename fields and methods according to discussions in PR #101 
1 parent 5cec341 commit b01e336

File tree

3 files changed

+51
-60
lines changed

3 files changed

+51
-60
lines changed

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

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -15,25 +15,16 @@
1515
import io.vertx.codegen.annotations.Nullable;
1616
import io.vertx.codegen.annotations.VertxGen;
1717
import io.vertx.core.Future;
18-
import io.vertx.core.Promise;
1918
import io.vertx.core.Vertx;
2019
import io.vertx.core.http.HttpMethod;
21-
import io.vertx.core.internal.ContextInternal;
2220
import io.vertx.core.json.JsonObject;
23-
import io.vertx.json.schema.JsonSchema;
24-
import io.vertx.json.schema.JsonSchemaValidationException;
2521
import io.vertx.json.schema.SchemaRepository;
26-
import io.vertx.openapi.contract.impl.OpenAPIContractImpl;
2722

28-
import java.util.ArrayList;
29-
import java.util.HashMap;
3023
import java.util.List;
3124
import java.util.Map;
3225

3326
import static io.vertx.core.Future.failedFuture;
3427
import static io.vertx.openapi.contract.OpenAPIContractException.createInvalidContract;
35-
import static io.vertx.openapi.impl.Utils.readYamlOrJson;
36-
import static java.util.Collections.emptyMap;
3728

3829
@VertxGen
3930
public interface OpenAPIContract {
@@ -89,7 +80,7 @@ static Future<OpenAPIContract> from(Vertx vertx, String unresolvedContractPath,
8980

9081
return builder(vertx)
9182
.setContract(unresolvedContractPath)
92-
.setAdditionalContentFiles(additionalContractFiles)
83+
.setAdditionalContractFiles(additionalContractFiles)
9384
.build();
9485
}
9586

@@ -110,7 +101,7 @@ static Future<OpenAPIContract> from(Vertx vertx, JsonObject unresolvedContract,
110101
return Future.failedFuture(OpenAPIContractException.createInvalidContract("Spec must not be null"));
111102
return builder(vertx)
112103
.setContract(unresolvedContract)
113-
.setAdditionalContent(additionalContractFiles)
104+
.setAdditionalContracts(additionalContractFiles)
114105
.build();
115106
}
116107

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

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,8 @@ public OpenAPIContractBuilderException(String message) {
4343
private final Vertx vertx;
4444
private String contractFile;
4545
private JsonObject contract;
46-
private final Map<String, String> additionalContentFiles = new HashMap<>();
47-
private final Map<String, JsonObject> additionalContent = new HashMap<>();
46+
private final Map<String, String> additionalContractFiles = new HashMap<>();
47+
private final Map<String, JsonObject> additionalContracts = new HashMap<>();
4848

4949
public OpenAPIContractBuilder(Vertx vertx) {
5050
this.vertx = vertx;
@@ -85,26 +85,26 @@ public OpenAPIContractBuilder setContract(JsonObject contract) {
8585
* @param path The path to the contract file.
8686
* @return The builder, for a fluent interface
8787
*/
88-
public OpenAPIContractBuilder putAdditionalContentFile(String key, String path) {
89-
additionalContentFiles.put(key, path);
90-
additionalContent.remove(key);
88+
public OpenAPIContractBuilder putAdditionalContractFile(String key, String path) {
89+
additionalContractFiles.put(key, path);
90+
additionalContracts.remove(key);
9191
return this;
9292
}
9393

9494
/**
9595
* Uses the contract files from the provided map to resolve referenced contracts.
96-
* Replaces all previously put contracts by {@link #putAdditionalContentFile(String, String)}.
97-
* If the same key is used also overrides the contracts set by {@link #putAdditionalContent(String, JsonObject)}
98-
* and {@link #setAdditionalContent(Map)}.
96+
* Replaces all previously put contracts by {@link #putAdditionalContractFile(String, String)}.
97+
* If the same key is used also overrides the contracts set by {@link #putAdditionalContract(String, JsonObject)}
98+
* and {@link #setAdditionalContracts(Map)}.
9999
*
100100
* @param contractFiles A map that contains all additional contract files.
101101
* @return The builder, for a fluent interface.
102102
*/
103-
public OpenAPIContractBuilder setAdditionalContentFiles(Map<String, String> contractFiles) {
104-
additionalContentFiles.clear();
103+
public OpenAPIContractBuilder setAdditionalContractFiles(Map<String, String> contractFiles) {
104+
additionalContractFiles.clear();
105105
for (var e : contractFiles.entrySet()) {
106-
putAdditionalContentFile(e.getKey(), e.getValue());
107-
additionalContent.remove(e.getKey());
106+
putAdditionalContractFile(e.getKey(), e.getValue());
107+
additionalContracts.remove(e.getKey());
108108
}
109109
return this;
110110
}
@@ -118,26 +118,26 @@ public OpenAPIContractBuilder setAdditionalContentFiles(Map<String, String> cont
118118
* @param content The parsed contract.
119119
* @return The builder, for a fluent interface
120120
*/
121-
public OpenAPIContractBuilder putAdditionalContent(String key, JsonObject content) {
122-
additionalContent.put(key, content);
123-
additionalContentFiles.remove(key);
121+
public OpenAPIContractBuilder putAdditionalContract(String key, JsonObject content) {
122+
additionalContracts.put(key, content);
123+
additionalContractFiles.remove(key);
124124
return this;
125125
}
126126

127127
/**
128128
* Uses the contracts from the provided map to resolve referenced contracts.
129-
* Replaces all previously put contracts by {@link #putAdditionalContent(String, JsonObject)}.
130-
* If the same key is used also replaces the contracts set by {@link #putAdditionalContentFile(String, String)}
131-
* and {@link #setAdditionalContentFiles(Map)}.
129+
* Replaces all previously put contracts by {@link #putAdditionalContract(String, JsonObject)}.
130+
* If the same key is used also replaces the contracts set by {@link #putAdditionalContractFile(String, String)}
131+
* and {@link #setAdditionalContractFiles(Map)}.
132132
*
133133
* @param contracts A map that contains all additional contract files.
134134
* @return The builder, for a fluent interface.
135135
*/
136-
public OpenAPIContractBuilder setAdditionalContent(Map<String, JsonObject> contracts) {
137-
additionalContent.clear();
136+
public OpenAPIContractBuilder setAdditionalContracts(Map<String, JsonObject> contracts) {
137+
additionalContracts.clear();
138138
for (var e : contracts.entrySet()) {
139-
putAdditionalContent(e.getKey(), e.getValue());
140-
additionalContentFiles.remove(e.getKey());
139+
putAdditionalContract(e.getKey(), e.getValue());
140+
additionalContractFiles.remove(e.getKey());
141141
}
142142
return this;
143143
}
@@ -157,7 +157,7 @@ public Future<OpenAPIContract> build() {
157157
: Utils.readYamlOrJson(vertx, contractFile);
158158

159159
var resolvedContracts = Future
160-
.succeededFuture(additionalContent)
160+
.succeededFuture(additionalContracts)
161161
.compose(x -> readContractFiles()
162162
.map(r -> {
163163
var all = new HashMap<>(x);
@@ -169,12 +169,12 @@ public Future<OpenAPIContract> build() {
169169
.compose(x -> {
170170
JsonObject contract = x.resultAt(0);
171171
Map<String, JsonObject> other = x.resultAt(1);
172-
return from(contract, other);
172+
return buildOpenAPIContract(contract, other);
173173
});
174174
}
175175

176-
private Future<OpenAPIContract> from(JsonObject unresolvedContract,
177-
Map<String, JsonObject> additionalContractFiles) {
176+
private Future<OpenAPIContract> buildOpenAPIContract(JsonObject unresolvedContract,
177+
Map<String, JsonObject> additionalContractFiles) {
178178
if (unresolvedContract == null) {
179179
return failedFuture(createInvalidContract("Spec must not be null"));
180180
}
@@ -221,10 +221,10 @@ private Future<OpenAPIContract> from(JsonObject unresolvedContract,
221221
}
222222

223223
private Future<Map<String, JsonObject>> readContractFiles() {
224-
if (additionalContentFiles.isEmpty()) return Future.succeededFuture(Map.of());
224+
if (additionalContractFiles.isEmpty()) return Future.succeededFuture(Map.of());
225225

226226
var read = new HashMap<String, JsonObject>();
227-
return Future.all(additionalContentFiles.entrySet().stream()
227+
return Future.all(additionalContractFiles.entrySet().stream()
228228
.map(e -> Utils.readYamlOrJson(vertx, e.getValue())
229229
.map(c -> read.put(e.getKey(), c)))
230230
.collect(Collectors.toList()))

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

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ void should_create_contract_when_valid_contract_is_provided(Vertx vertx, VertxTe
5454
void should_create_contract_when_valid_contract_file_and_additional_file_is_provided(Vertx vertx, VertxTestContext ctx) {
5555
OpenAPIContract.builder(vertx)
5656
.setContract("io/vertx/tests/contract/from_with_path_and_additional_files/petstore.json")
57-
.putAdditionalContentFile("https://example.com/petstore", "io/vertx/tests/contract/from_with_path_and_additional_files/components.json")
57+
.putAdditionalContractFile("https://example.com/petstore", "io/vertx/tests/contract/from_with_path_and_additional_files/components.json")
5858
.build()
5959
.onComplete(ctx.succeedingThenComplete());
6060
}
@@ -64,7 +64,7 @@ void should_create_contract_when_valid_contract_and_additional_file_is_provided(
6464
var contract = vertx.fileSystem().readFileBlocking("io/vertx/tests/contract/from_with_path_and_additional_files/petstore.json").toJsonObject();
6565
OpenAPIContract.builder(vertx)
6666
.setContract(contract)
67-
.putAdditionalContentFile("https://example.com/petstore", "io/vertx/tests/contract/from_with_path_and_additional_files/components.json")
67+
.putAdditionalContractFile("https://example.com/petstore", "io/vertx/tests/contract/from_with_path_and_additional_files/components.json")
6868
.build()
6969
.onComplete(ctx.succeedingThenComplete());
7070
}
@@ -74,7 +74,7 @@ void should_create_contract_when_valid_contract_file_and_additional_content_is_p
7474
var components = vertx.fileSystem().readFileBlocking("io/vertx/tests/contract/from_with_path_and_additional_files/components.json").toJsonObject();
7575
OpenAPIContract.builder(vertx)
7676
.setContract("io/vertx/tests/contract/from_with_path_and_additional_files/petstore.json")
77-
.putAdditionalContent("https://example.com/petstore", components)
77+
.putAdditionalContract("https://example.com/petstore", components)
7878
.build()
7979
.onComplete(ctx.succeedingThenComplete());
8080
}
@@ -135,9 +135,9 @@ private JsonObject content(String path) {
135135
void set_additional_content_should_override_existing_file(Vertx vertx) {
136136
var c = OpenAPIContract.builder(vertx)
137137
.setContract("io/vertx/tests/builder/contract.yaml")
138-
.putAdditionalContentFile(REF1_ID, REF1_1_FILE)
139-
.putAdditionalContentFile(REF2_ID, REF2_1_FILE)
140-
.setAdditionalContent(Map.of(REF1_ID, content(REF1_2_FILE)))
138+
.putAdditionalContractFile(REF1_ID, REF1_1_FILE)
139+
.putAdditionalContractFile(REF2_ID, REF2_1_FILE)
140+
.setAdditionalContracts(Map.of(REF1_ID, content(REF1_2_FILE)))
141141
.build()
142142
.await();
143143
should_have(c, "ref1.2", "ref2.1");
@@ -147,9 +147,9 @@ void set_additional_content_should_override_existing_file(Vertx vertx) {
147147
void put_additional_content_should_override_existing_file(Vertx vertx) {
148148
var c = OpenAPIContract.builder(vertx)
149149
.setContract("io/vertx/tests/builder/contract.yaml")
150-
.putAdditionalContentFile(REF1_ID, REF1_1_FILE)
151-
.putAdditionalContentFile(REF2_ID, REF2_1_FILE)
152-
.putAdditionalContent(REF1_ID, content(REF1_2_FILE))
150+
.putAdditionalContractFile(REF1_ID, REF1_1_FILE)
151+
.putAdditionalContractFile(REF2_ID, REF2_1_FILE)
152+
.putAdditionalContract(REF1_ID, content(REF1_2_FILE))
153153
.build()
154154
.await();
155155
should_have(c, "ref1.2", "ref2.1");
@@ -159,9 +159,9 @@ void put_additional_content_should_override_existing_file(Vertx vertx) {
159159
void set_additional_content_file_should_override_existing_content(Vertx vertx) {
160160
var c = OpenAPIContract.builder(vertx)
161161
.setContract("io/vertx/tests/builder/contract.yaml")
162-
.putAdditionalContent(REF1_ID, content(REF1_1_FILE))
163-
.putAdditionalContent(REF2_ID, content(REF2_1_FILE))
164-
.setAdditionalContentFiles(Map.of(REF2_ID, REF2_2_FILE))
162+
.putAdditionalContract(REF1_ID, content(REF1_1_FILE))
163+
.putAdditionalContract(REF2_ID, content(REF2_1_FILE))
164+
.setAdditionalContractFiles(Map.of(REF2_ID, REF2_2_FILE))
165165
.build()
166166
.await();
167167
should_have(c, "ref1.1", "ref2.2");
@@ -171,9 +171,9 @@ void set_additional_content_file_should_override_existing_content(Vertx vertx) {
171171
void put_additional_content_file_should_override_existing_content_file(Vertx vertx) {
172172
var c = OpenAPIContract.builder(vertx)
173173
.setContract("io/vertx/tests/builder/contract.yaml")
174-
.putAdditionalContent(REF1_ID, content(REF1_1_FILE))
175-
.putAdditionalContent(REF2_ID, content(REF2_1_FILE))
176-
.putAdditionalContentFile(REF2_ID, REF2_2_FILE)
174+
.putAdditionalContract(REF1_ID, content(REF1_1_FILE))
175+
.putAdditionalContract(REF2_ID, content(REF2_1_FILE))
176+
.putAdditionalContractFile(REF2_ID, REF2_2_FILE)
177177
.build()
178178
.await();
179179
should_have(c, "ref1.1", "ref2.2");
@@ -192,9 +192,9 @@ private void should_have(OpenAPIContract contract, String requestDescription, St
192192
void set_additional_content_should_replace_existing_content(Vertx vertx) {
193193
var c = OpenAPIContract.builder(vertx)
194194
.setContract("io/vertx/tests/builder/contract.yaml")
195-
.putAdditionalContent(REF1_ID, content(REF1_1_FILE))
196-
.putAdditionalContent(REF2_ID, content(REF2_1_FILE))
197-
.setAdditionalContent(Map.of(REF2_ID, content(REF2_2_FILE)))
195+
.putAdditionalContract(REF1_ID, content(REF1_1_FILE))
196+
.putAdditionalContract(REF2_ID, content(REF2_1_FILE))
197+
.setAdditionalContracts(Map.of(REF2_ID, content(REF2_2_FILE)))
198198
.build()
199199
.await();
200200
assertThat(c.getSchemaRepository().find(REF1_ID)).isNull();
@@ -204,9 +204,9 @@ void set_additional_content_should_replace_existing_content(Vertx vertx) {
204204
void set_additional_content_files_should_replace_existing_content_files(Vertx vertx) {
205205
var c = OpenAPIContract.builder(vertx)
206206
.setContract("io/vertx/tests/builder/contract.yaml")
207-
.putAdditionalContentFile(REF1_ID, REF1_1_FILE)
208-
.putAdditionalContentFile(REF2_ID, REF2_1_FILE)
209-
.setAdditionalContentFiles(Map.of(REF2_ID, REF2_2_FILE))
207+
.putAdditionalContractFile(REF1_ID, REF1_1_FILE)
208+
.putAdditionalContractFile(REF2_ID, REF2_1_FILE)
209+
.setAdditionalContractFiles(Map.of(REF2_ID, REF2_2_FILE))
210210
.build()
211211
.await();
212212
assertThat(c.getSchemaRepository().find(REF1_ID)).isNull();

0 commit comments

Comments
 (0)