Skip to content

Commit d89ae17

Browse files
goekaygoekay
committed
refactor DTO class names
reason: swagger UI cannot infer the proper schema, if there are overlapping inner classes with the same name, such as: - OcppTagQueryForm.ForApi - TransactionQueryForm.ForApi
1 parent 4703d1c commit d89ae17

File tree

11 files changed

+43
-44
lines changed

11 files changed

+43
-44
lines changed

‎src/main/java/de/rwth/idsg/steve/repository/OcppTagRepository.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
* @since 19.08.2014
3232
*/
3333
public interface OcppTagRepository {
34-
List<OcppTag.Overview> getOverview(OcppTagQueryForm form);
34+
List<OcppTag.OcppTagOverview> getOverview(OcppTagQueryForm form);
3535

3636
Result<OcppTagActivityRecord> getRecords();
3737
Result<OcppTagActivityRecord> getRecords(List<String> idTagList);

‎src/main/java/de/rwth/idsg/steve/repository/dto/OcppTag.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ public final class OcppTag {
3535
@Getter
3636
@Builder
3737
@ToString
38-
public static final class Overview {
38+
public static final class OcppTagOverview {
3939
@Schema(description = "PK of the OCPP tag")
4040
private final Integer ocppTagPk;
4141

‎src/main/java/de/rwth/idsg/steve/repository/impl/OcppTagRepositoryImpl.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020

2121
import de.rwth.idsg.steve.SteveException;
2222
import de.rwth.idsg.steve.repository.OcppTagRepository;
23-
import de.rwth.idsg.steve.repository.dto.OcppTag.Overview;
23+
import de.rwth.idsg.steve.repository.dto.OcppTag.OcppTagOverview;
2424
import de.rwth.idsg.steve.web.dto.OcppTagForm;
2525
import de.rwth.idsg.steve.web.dto.OcppTagQueryForm;
2626
import jooq.steve.db.tables.OcppTagActivity;
@@ -66,7 +66,7 @@ public OcppTagRepositoryImpl(DSLContext ctx) {
6666

6767
@Override
6868
@SuppressWarnings("unchecked")
69-
public List<Overview> getOverview(OcppTagQueryForm form) {
69+
public List<OcppTagOverview> getOverview(OcppTagQueryForm form) {
7070
SelectQuery selectQuery = ctx.selectQuery();
7171
selectQuery.addFrom(OCPP_TAG_ACTIVITY);
7272

@@ -258,10 +258,10 @@ private void processBooleanType(SelectQuery selectQuery,
258258
}
259259

260260
private static class UserMapper
261-
implements RecordMapper<Record10<Integer, Integer, String, String, DateTime, Boolean, Boolean, Integer, Long, String>, Overview> {
261+
implements RecordMapper<Record10<Integer, Integer, String, String, DateTime, Boolean, Boolean, Integer, Long, String>, OcppTagOverview> {
262262
@Override
263-
public Overview map(Record10<Integer, Integer, String, String, DateTime, Boolean, Boolean, Integer, Long, String> r) {
264-
return Overview.builder()
263+
public OcppTagOverview map(Record10<Integer, Integer, String, String, DateTime, Boolean, Boolean, Integer, Long, String> r) {
264+
return OcppTagOverview.builder()
265265
.ocppTagPk(r.value1())
266266
.parentOcppTagPk(r.value2())
267267
.idTag(r.value3())

‎src/main/java/de/rwth/idsg/steve/service/OcppTagService.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@
2222
import static de.rwth.idsg.steve.utils.OcppTagActivityRecordUtils.isExpired;
2323

2424
import com.google.common.base.Strings;
25-
import de.rwth.idsg.steve.SteveException;
2625
import de.rwth.idsg.steve.repository.OcppTagRepository;
2726
import de.rwth.idsg.steve.repository.dto.OcppTag;
2827
import de.rwth.idsg.steve.service.dto.UnidentifiedIncomingObject;
@@ -56,7 +55,7 @@ public class OcppTagService {
5655
private final OcppTagRepository ocppTagRepository;
5756
private final AuthTagService authTagService;
5857

59-
public List<OcppTag.Overview> getOverview(OcppTagQueryForm form) {
58+
public List<OcppTag.OcppTagOverview> getOverview(OcppTagQueryForm form) {
6059
return ocppTagRepository.getOverview(form);
6160
}
6261

‎src/main/java/de/rwth/idsg/steve/web/api/OcppTagsRestController.java

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,11 @@
1919
package de.rwth.idsg.steve.web.api;
2020

2121
import de.rwth.idsg.steve.SteveException;
22-
import de.rwth.idsg.steve.repository.dto.OcppTag;
22+
import de.rwth.idsg.steve.repository.dto.OcppTag.OcppTagOverview;
2323
import de.rwth.idsg.steve.service.OcppTagService;
2424
import de.rwth.idsg.steve.web.api.ApiControllerAdvice.ApiErrorResponse;
2525
import de.rwth.idsg.steve.web.dto.OcppTagForm;
26-
import de.rwth.idsg.steve.web.dto.OcppTagQueryForm;
26+
import de.rwth.idsg.steve.web.dto.OcppTagQueryForm.OcppTagQueryFormForApi;
2727
import io.swagger.v3.oas.annotations.Operation;
2828
import io.swagger.v3.oas.annotations.media.Content;
2929
import io.swagger.v3.oas.annotations.media.Schema;
@@ -80,7 +80,7 @@ public class OcppTagsRestController {
8080
)
8181
@GetMapping(value = "")
8282
@ResponseBody
83-
public List<OcppTag.Overview> get(OcppTagQueryForm.ForApi params) {
83+
public List<OcppTagOverview> get(OcppTagQueryFormForApi params) {
8484
log.debug("Read request for query: {}", params);
8585

8686
var response = ocppTagService.getOverview(params);
@@ -100,7 +100,7 @@ public List<OcppTag.Overview> get(OcppTagQueryForm.ForApi params) {
100100
)
101101
@GetMapping("/{ocppTagPk}")
102102
@ResponseBody
103-
public OcppTag.Overview getOne(@PathVariable("ocppTagPk") Integer ocppTagPk) {
103+
public OcppTagOverview getOne(@PathVariable("ocppTagPk") Integer ocppTagPk) {
104104
log.debug("Read request for ocppTagPk: {}", ocppTagPk);
105105

106106
var response = getOneInternal(ocppTagPk);
@@ -123,7 +123,7 @@ public OcppTag.Overview getOne(@PathVariable("ocppTagPk") Integer ocppTagPk) {
123123
@PostMapping
124124
@ResponseBody
125125
@ResponseStatus(HttpStatus.CREATED)
126-
public OcppTag.Overview create(@RequestBody @Valid OcppTagForm params) {
126+
public OcppTagOverview create(@RequestBody @Valid OcppTagForm params) {
127127
log.debug("Create request: {}", params);
128128

129129
int ocppTagPk = ocppTagService.addOcppTag(params);
@@ -145,7 +145,7 @@ public OcppTag.Overview create(@RequestBody @Valid OcppTagForm params) {
145145
)
146146
@PutMapping("/{ocppTagPk}")
147147
@ResponseBody
148-
public OcppTag.Overview update(@PathVariable("ocppTagPk") Integer ocppTagPk, @RequestBody @Valid OcppTagForm params) {
148+
public OcppTagOverview update(@PathVariable("ocppTagPk") Integer ocppTagPk, @RequestBody @Valid OcppTagForm params) {
149149
params.setOcppTagPk(ocppTagPk); // the one from incoming params does not matter
150150
log.debug("Update request: {}", params);
151151

@@ -169,7 +169,7 @@ public OcppTag.Overview update(@PathVariable("ocppTagPk") Integer ocppTagPk, @Re
169169
)
170170
@DeleteMapping("/{ocppTagPk}")
171171
@ResponseBody
172-
public OcppTag.Overview delete(@PathVariable("ocppTagPk") Integer ocppTagPk) {
172+
public OcppTagOverview delete(@PathVariable("ocppTagPk") Integer ocppTagPk) {
173173
log.debug("Delete request for ocppTagPk: {}", ocppTagPk);
174174

175175
var response = getOneInternal(ocppTagPk);
@@ -179,11 +179,11 @@ public OcppTag.Overview delete(@PathVariable("ocppTagPk") Integer ocppTagPk) {
179179
return response;
180180
}
181181

182-
private OcppTag.Overview getOneInternal(int ocppTagPk) {
183-
OcppTagQueryForm.ForApi params = new OcppTagQueryForm.ForApi();
182+
private OcppTagOverview getOneInternal(int ocppTagPk) {
183+
OcppTagQueryFormForApi params = new OcppTagQueryFormForApi();
184184
params.setOcppTagPk(ocppTagPk);
185185

186-
List<OcppTag.Overview> results = ocppTagService.getOverview(params);
186+
List<OcppTagOverview> results = ocppTagService.getOverview(params);
187187
if (results.isEmpty()) {
188188
throw new SteveException.NotFound("Could not find this ocppTag");
189189
}

‎src/main/java/de/rwth/idsg/steve/web/api/TransactionsRestController.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ public class TransactionsRestController {
7070
)
7171
@GetMapping(value = "")
7272
@ResponseBody
73-
public List<Transaction> get(@Valid TransactionQueryForm.ForApi params) {
73+
public List<Transaction> get(@Valid TransactionQueryForm.TransactionQueryFormForApi params) {
7474
log.debug("Read request for query: {}", params);
7575

7676
if (params.isReturnCSV()) {

‎src/main/java/de/rwth/idsg/steve/web/dto/OcppTagQueryForm.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -116,9 +116,9 @@ public static BooleanType fromValue(String v) {
116116
}
117117

118118
@ToString(callSuper = true)
119-
public static class ForApi extends OcppTagQueryForm {
119+
public static class OcppTagQueryFormForApi extends OcppTagQueryForm {
120120

121-
public ForApi () {
121+
public OcppTagQueryFormForApi() {
122122
super();
123123
setExpired(BooleanType.ALL);
124124
setInTransaction(BooleanType.ALL);

‎src/main/java/de/rwth/idsg/steve/web/dto/TransactionQueryForm.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -119,9 +119,9 @@ public static QueryPeriodType fromValue(String v) {
119119
}
120120

121121
@ToString(callSuper = true)
122-
public static class ForApi extends TransactionQueryForm {
122+
public static class TransactionQueryFormForApi extends TransactionQueryForm {
123123

124-
public ForApi() {
124+
public TransactionQueryFormForApi() {
125125
super();
126126
setType(QueryType.ALL);
127127
setPeriodType(QueryPeriodType.ALL);

‎src/test/java/de/rwth/idsg/steve/issues/Issue1219.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ private void realTest() {
9494
var repository = new OcppTagRepositoryImpl(ctx);
9595

9696
long start = System.currentTimeMillis();
97-
List<OcppTag.Overview> values = repository.getOverview(new OcppTagQueryForm());
97+
List<OcppTag.OcppTagOverview> values = repository.getOverview(new OcppTagQueryForm());
9898
long stop = System.currentTimeMillis();
9999

100100
System.out.println("took " + Duration.millis(stop - start));

‎src/test/java/de/rwth/idsg/steve/web/api/OcppTagsRestControllerTest.java

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ public void setup() {
8787
@DisplayName("GET all: Test with empty results, expected 200")
8888
public void test1() throws Exception {
8989
// given
90-
List<OcppTag.Overview> results = Collections.emptyList();
90+
List<OcppTag.OcppTagOverview> results = Collections.emptyList();
9191

9292
// when
9393
when(ocppTagService.getOverview(any())).thenReturn(results);
@@ -102,7 +102,7 @@ public void test1() throws Exception {
102102
@DisplayName("GET all: Test with one result, expected 200")
103103
public void test2() throws Exception {
104104
// given
105-
List<OcppTag.Overview> results = List.of(OcppTag.Overview.builder().ocppTagPk(96).build());
105+
List<OcppTag.OcppTagOverview> results = List.of(OcppTag.OcppTagOverview.builder().ocppTagPk(96).build());
106106

107107
// when
108108
when(ocppTagService.getOverview(any())).thenReturn(results);
@@ -141,7 +141,7 @@ public void test4() throws Exception {
141141
public void test5() throws Exception {
142142
// given
143143
DateTime someDate = DateTime.parse("2020-10-01T00:00:00.000Z");
144-
OcppTag.Overview result = OcppTag.Overview.builder()
144+
OcppTag.OcppTagOverview result = OcppTag.OcppTagOverview.builder()
145145
.ocppTagPk(121)
146146
.idTag("id-1")
147147
.parentOcppTagPk(454)
@@ -206,7 +206,7 @@ public void test7() throws Exception {
206206
@DisplayName("GET one: One entity found, expected 200")
207207
public void test8() throws Exception {
208208
// given
209-
OcppTag.Overview result = OcppTag.Overview.builder().ocppTagPk(12).build();
209+
OcppTag.OcppTagOverview result = OcppTag.OcppTagOverview.builder().ocppTagPk(12).build();
210210

211211
// when
212212
when(ocppTagService.getOverview(any())).thenReturn(List.of(result));
@@ -265,7 +265,7 @@ public void test11() throws Exception {
265265
OcppTagForm form = new OcppTagForm();
266266
form.setIdTag("id-123");
267267

268-
OcppTag.Overview result = OcppTag.Overview.builder()
268+
OcppTag.OcppTagOverview result = OcppTag.OcppTagOverview.builder()
269269
.ocppTagPk(ocppTagPk)
270270
.idTag(form.getIdTag())
271271
.build();
@@ -296,7 +296,7 @@ public void test12() throws Exception {
296296
form.setIdTag("id-123");
297297
form.setNote("note-1");
298298

299-
OcppTag.Overview result = OcppTag.Overview.builder()
299+
OcppTag.OcppTagOverview result = OcppTag.OcppTagOverview.builder()
300300
.ocppTagPk(ocppTagPk)
301301
.idTag(form.getIdTag())
302302
.note(form.getNote())
@@ -367,7 +367,7 @@ public void test15() throws Exception {
367367
// given
368368
int ocppTagPk = 123;
369369

370-
OcppTag.Overview result = OcppTag.Overview.builder()
370+
OcppTag.OcppTagOverview result = OcppTag.OcppTagOverview.builder()
371371
.ocppTagPk(ocppTagPk)
372372
.idTag("id-123")
373373
.note("note-2")
@@ -390,7 +390,7 @@ public void test16() throws Exception {
390390
// given
391391
int ocppTagPk = 123;
392392

393-
OcppTag.Overview result = OcppTag.Overview.builder()
393+
OcppTag.OcppTagOverview result = OcppTag.OcppTagOverview.builder()
394394
.ocppTagPk(ocppTagPk)
395395
.idTag("id-123")
396396
.note("note-2")
@@ -445,14 +445,14 @@ public void test18() throws Exception {
445445
.andExpectAll(errorJsonMatchers());
446446

447447
verify(ocppTagService, times(0)).removeUnknown(anyList());
448-
verify(ocppTagService, times(0)).getOverview(any(OcppTagQueryForm.ForApi.class));
448+
verify(ocppTagService, times(0)).getOverview(any(OcppTagQueryForm.OcppTagQueryFormForApi.class));
449449
}
450450

451451
@Test
452452
@DisplayName("GET all: Query param 'expired' is translated correctly, while others are defaulted")
453453
public void test19() throws Exception {
454454
// given
455-
ArgumentCaptor<OcppTagQueryForm.ForApi> formToCapture = ArgumentCaptor.forClass(OcppTagQueryForm.ForApi.class);
455+
ArgumentCaptor<OcppTagQueryForm.OcppTagQueryFormForApi> formToCapture = ArgumentCaptor.forClass(OcppTagQueryForm.OcppTagQueryFormForApi.class);
456456

457457
// when
458458
when(ocppTagService.getOverview(any())).thenReturn(Collections.emptyList());
@@ -463,7 +463,7 @@ public void test19() throws Exception {
463463
.andExpect(status().isOk());
464464

465465
verify(ocppTagService).getOverview(formToCapture.capture());
466-
OcppTagQueryForm.ForApi capturedForm = formToCapture.getValue();
466+
OcppTagQueryForm.OcppTagQueryFormForApi capturedForm = formToCapture.getValue();
467467

468468
assertEquals(capturedForm.getExpired(), OcppTagQueryForm.BooleanType.FALSE);
469469
assertEquals(capturedForm.getInTransaction(), OcppTagQueryForm.BooleanType.ALL);
@@ -474,7 +474,7 @@ public void test19() throws Exception {
474474
@DisplayName("GET all: Query param 'inTransaction' is translated correctly, while others are defaulted")
475475
public void test20() throws Exception {
476476
// given
477-
ArgumentCaptor<OcppTagQueryForm.ForApi> formToCapture = ArgumentCaptor.forClass(OcppTagQueryForm.ForApi.class);
477+
ArgumentCaptor<OcppTagQueryForm.OcppTagQueryFormForApi> formToCapture = ArgumentCaptor.forClass(OcppTagQueryForm.OcppTagQueryFormForApi.class);
478478

479479
// when
480480
when(ocppTagService.getOverview(any())).thenReturn(Collections.emptyList());
@@ -485,7 +485,7 @@ public void test20() throws Exception {
485485
.andExpect(status().isOk());
486486

487487
verify(ocppTagService).getOverview(formToCapture.capture());
488-
OcppTagQueryForm.ForApi capturedForm = formToCapture.getValue();
488+
OcppTagQueryForm.OcppTagQueryFormForApi capturedForm = formToCapture.getValue();
489489

490490
assertEquals(capturedForm.getExpired(), OcppTagQueryForm.BooleanType.ALL);
491491
assertEquals(capturedForm.getInTransaction(), OcppTagQueryForm.BooleanType.TRUE);
@@ -496,7 +496,7 @@ public void test20() throws Exception {
496496
@DisplayName("GET all: Query param 'inTransaction' is translated correctly, while others are defaulted")
497497
public void test21() throws Exception {
498498
// given
499-
ArgumentCaptor<OcppTagQueryForm.ForApi> formToCapture = ArgumentCaptor.forClass(OcppTagQueryForm.ForApi.class);
499+
ArgumentCaptor<OcppTagQueryForm.OcppTagQueryFormForApi> formToCapture = ArgumentCaptor.forClass(OcppTagQueryForm.OcppTagQueryFormForApi.class);
500500

501501
// when
502502
when(ocppTagService.getOverview(any())).thenReturn(Collections.emptyList());
@@ -507,7 +507,7 @@ public void test21() throws Exception {
507507
.andExpect(status().isOk());
508508

509509
verify(ocppTagService).getOverview(formToCapture.capture());
510-
OcppTagQueryForm.ForApi capturedForm = formToCapture.getValue();
510+
OcppTagQueryForm.OcppTagQueryFormForApi capturedForm = formToCapture.getValue();
511511

512512
assertEquals(capturedForm.getExpired(), OcppTagQueryForm.BooleanType.ALL);
513513
assertEquals(capturedForm.getInTransaction(), OcppTagQueryForm.BooleanType.ALL);

‎src/test/java/de/rwth/idsg/steve/web/api/TransactionRestControllerTest.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -213,7 +213,7 @@ public void test9() throws Exception {
213213
@DisplayName("GET all: Query param 'type' is translated correctly, while others are defaulted")
214214
public void test10() throws Exception {
215215
// given
216-
ArgumentCaptor<TransactionQueryForm.ForApi> formToCapture = ArgumentCaptor.forClass(TransactionQueryForm.ForApi.class);
216+
ArgumentCaptor<TransactionQueryForm.TransactionQueryFormForApi> formToCapture = ArgumentCaptor.forClass(TransactionQueryForm.TransactionQueryFormForApi.class);
217217

218218
// when
219219
when(transactionRepository.getTransactions(any())).thenReturn(Collections.emptyList());
@@ -224,7 +224,7 @@ public void test10() throws Exception {
224224
.andExpect(status().isOk());
225225

226226
verify(transactionRepository).getTransactions(formToCapture.capture());
227-
TransactionQueryForm.ForApi capturedForm = formToCapture.getValue();
227+
TransactionQueryForm.TransactionQueryFormForApi capturedForm = formToCapture.getValue();
228228

229229
assertEquals(capturedForm.getType(), TransactionQueryForm.QueryType.ACTIVE);
230230
assertEquals(capturedForm.getPeriodType(), TransactionQueryForm.QueryPeriodType.ALL);
@@ -234,7 +234,7 @@ public void test10() throws Exception {
234234
@DisplayName("GET all: Query param 'periodType' is translated correctly, while others are defaulted")
235235
public void test11() throws Exception {
236236
// given
237-
ArgumentCaptor<TransactionQueryForm.ForApi> formToCapture = ArgumentCaptor.forClass(TransactionQueryForm.ForApi.class);
237+
ArgumentCaptor<TransactionQueryForm.TransactionQueryFormForApi> formToCapture = ArgumentCaptor.forClass(TransactionQueryForm.TransactionQueryFormForApi.class);
238238

239239
// when
240240
when(transactionRepository.getTransactions(any())).thenReturn(Collections.emptyList());
@@ -245,7 +245,7 @@ public void test11() throws Exception {
245245
.andExpect(status().isOk());
246246

247247
verify(transactionRepository).getTransactions(formToCapture.capture());
248-
TransactionQueryForm.ForApi capturedForm = formToCapture.getValue();
248+
TransactionQueryForm.TransactionQueryFormForApi capturedForm = formToCapture.getValue();
249249

250250
assertEquals(capturedForm.getType(), TransactionQueryForm.QueryType.ALL);
251251
assertEquals(capturedForm.getPeriodType(), TransactionQueryForm.QueryPeriodType.LAST_30);

0 commit comments

Comments
 (0)