chore(refactor): fix spotbugs warnings for dtos

theborakompanioni · Oct 29, 2023 · 1ed5560 · 1ed5560
1 parent 5c65efa
commit 1ed5560
Show file tree

Hide file tree

Showing 6 changed files with 23 additions and 21 deletions.
diff --git a/...application/src/main/java/org/tbk/bitcoin/exchange/example/api/rate/ExchangeRateCtrl.java b/...application/src/main/java/org/tbk/bitcoin/exchange/example/api/rate/ExchangeRateCtrl.java
@@ -13,7 +13,7 @@
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RequestParam;
 import org.springframework.web.bind.annotation.RestController;
-import org.tbk.bitcoin.exchange.example.api.rate.ExchangeRateResponseImpl.ExchangeRateImpl;
+import org.tbk.bitcoin.exchange.example.api.rate.ExchangeRateResponseDtoImpl.ExchangeRateDtoImpl;
 import reactor.core.publisher.Flux;
 
 import javax.money.CurrencyUnit;
@@ -43,7 +43,7 @@ public ResponseEntity<? extends Map<String, Object>> get() {
     }
 
     @GetMapping("/latest")
-    public ResponseEntity<ExchangeRateResponse> latest(
+    public ResponseEntity<ExchangeRateResponseDto> latest(
             @RequestParam(name = "base", required = false) CurrencyUnit baseParamOrNull,
             @Parameter(array = @ArraySchema(schema = @Schema(implementation = String.class)))
             @RequestParam(name = "target", required = false) List<CurrencyUnit> targetParamOrNull,
@@ -64,7 +64,7 @@ public ResponseEntity<ExchangeRateResponse> latest(
         ConversionQueryBuilder conversionQueryBuilder = ConversionQueryBuilder.of()
                 .setBaseCurrency(baseCurrency);
 
-        Optional<ExchangeRateResponse> exchangeRateResponse = Flux.fromIterable(targetCurrencies)
+        Optional<ExchangeRateResponseDto> exchangeRateResponse = Flux.fromIterable(targetCurrencies)
                 .map(conversionQueryBuilder::setTermCurrency)
                 .map(ConversionQueryBuilder::build)
                 .flatMap(conversionQuery -> {
@@ -87,9 +87,9 @@ public ResponseEntity<ExchangeRateResponse> latest(
                                 }
                             });
                 })
-                .map(exchangeRate -> ExchangeRateImpl.toDto(exchangeRate).build())
+                .map(exchangeRate -> ExchangeRateDtoImpl.toDto(exchangeRate).build())
                 .collectList()
-                .map(rates -> (ExchangeRateResponse) ExchangeRateResponseImpl.builder()
+                .map(rates -> (ExchangeRateResponseDto) ExchangeRateResponseDtoImpl.builder()
                         .base(baseCurrency.getCurrencyCode())
                         .rates(rates)
                         .build())

diff --git a/...change/example/api/rate/ExchangeRate.java → ...nge/example/api/rate/ExchangeRateDto.java b/...change/example/api/rate/ExchangeRate.java → ...nge/example/api/rate/ExchangeRateDto.java
@@ -6,8 +6,8 @@
 import java.util.List;
 import java.util.Map;
 
-@JsonDeserialize(as = ExchangeRateResponseImpl.ExchangeRateImpl.class)
-public interface ExchangeRate {
+@JsonDeserialize(as = ExchangeRateResponseDtoImpl.ExchangeRateDtoImpl.class)
+public interface ExchangeRateDto {
     String getBase();
 
     boolean isDerived();
@@ -20,7 +20,7 @@ public interface ExchangeRate {
 
     String getType();
 
-    List<ExchangeRate> getChain();
+    List<ExchangeRateDto> getChain();
 
     Map<String, Object> getMeta();
 }
diff --git a/...xample/api/rate/ExchangeRateResponse.java → ...ple/api/rate/ExchangeRateResponseDto.java b/...xample/api/rate/ExchangeRateResponse.java → ...ple/api/rate/ExchangeRateResponseDto.java
@@ -4,9 +4,9 @@
 
 import java.util.List;
 
-@JsonDeserialize(as = ExchangeRateResponseImpl.class)
-public interface ExchangeRateResponse {
+@JsonDeserialize(as = ExchangeRateResponseDtoImpl.class)
+public interface ExchangeRateResponseDto {
     String getBase();
 
-    List<? extends ExchangeRate> getRates();
+    List<? extends ExchangeRateDto> getRates();
 }
diff --git a/...le/api/rate/ExchangeRateResponseImpl.java → ...api/rate/ExchangeRateResponseDtoImpl.java b/...le/api/rate/ExchangeRateResponseImpl.java → ...api/rate/ExchangeRateResponseDtoImpl.java
@@ -17,15 +17,15 @@
 @Value
 @Builder
 @Jacksonized
-public class ExchangeRateResponseImpl implements ExchangeRateResponse {
+public class ExchangeRateResponseDtoImpl implements ExchangeRateResponseDto {
 
     String base;
-    List<? extends ExchangeRate> rates;
+    List<? extends ExchangeRateDto> rates;
 
     @Value
     @Builder
     @Jacksonized
-    public static class ExchangeRateImpl implements ExchangeRate {
+    public static class ExchangeRateDtoImpl implements ExchangeRateDto {
 
         private static final class ContextUtil {
             public static Map<String, Object> toMap(AbstractContext context) {
@@ -34,8 +34,8 @@ public static Map<String, Object> toMap(AbstractContext context) {
             }
         }
 
-        public static ExchangeRateImplBuilder toDto(javax.money.convert.ExchangeRate exchangeRate) {
-            return ExchangeRateResponseImpl.ExchangeRateImpl.builder()
+        public static ExchangeRateDtoImplBuilder toDto(javax.money.convert.ExchangeRate exchangeRate) {
+            return ExchangeRateDtoImpl.builder()
                     .factor(new BigDecimal(exchangeRate.getFactor().toString()))
                     .base(exchangeRate.getBaseCurrency().getCurrencyCode())
                     .target(exchangeRate.getCurrency().getCurrencyCode())
@@ -44,8 +44,8 @@ public static ExchangeRateImplBuilder toDto(javax.money.convert.ExchangeRate exc
                     .type(exchangeRate.getContext().getRateType().name())
                     .chain(exchangeRate.getExchangeRateChain().stream()
                             .filter(val -> !exchangeRate.equals(val))
-                            .map(ExchangeRateImpl::toDto)
-                            .map(ExchangeRateImplBuilder::build)
+                            .map(ExchangeRateDtoImpl::toDto)
+                            .map(ExchangeRateDtoImplBuilder::build)
                             .toList())
                     .meta(ContextUtil.toMap(exchangeRate.getContext()))
                     .date(exchangeRate.getContext().get(LocalDate.class));
@@ -65,7 +65,7 @@ public static ExchangeRateImplBuilder toDto(javax.money.convert.ExchangeRate exc
         LocalDate date;
 
         @Singular("addChain")
-        List<ExchangeRate> chain;
+        List<ExchangeRateDto> chain;
 
         @Singular("addMeta")
         Map<String, Object> meta;

diff --git a/...ication/src/main/java/org/tbk/lightning/playground/example/api/ErrorAttributesSchema.java b/...ication/src/main/java/org/tbk/lightning/playground/example/api/ErrorAttributesSchema.java
@@ -1,5 +1,6 @@
 package org.tbk.lightning.playground.example.api;
 
+import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
 import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.Builder;
 import lombok.Value;
@@ -27,6 +28,7 @@
 @Schema(
         name = "ApiError"
 )
+@SuppressFBWarnings(value = {"EI_EXPOSE_REP", "EI_EXPOSE_REP2"}, justification = "on purpose")
 public class ErrorAttributesSchema {
     @Schema(example = "2019-01-17T16:12:45.977+0000")
     String timestamp;

diff --git a/spotbugs-exclude.xml b/spotbugs-exclude.xml
@@ -35,8 +35,8 @@
     <Match>
         <!-- disable some known risks or minor warnings in example apps dto classes -->
         <Or>
-            <Class name="~org\.tbk\..*\.example\..*Dto"/>
-            <Class name="~org\.tbk\..*\.example\..*DtoBuilder"/>
+            <Class name="~org\.tbk\..*\.example\..*Dto(Impl)?"/>
+            <Class name="~org\.tbk\..*\.example\..*Dto(Impl)?Builder"/>
         </Or>
         <Or>
             <Bug pattern="EI_EXPOSE_REP"/>