feat: 1976 modifying notice description for invalid currency amount (#1988)

Author: qcdyx

core/src/main/java/org/mobilitydata/gtfsvalidator/notice/InvalidCurrencyAmountNotice.java

@@ -11,32 +11,34 @@
  * A currency amount field has a value that does not match the format of its corresponding currency
  * code field.
  *
- * <p>Typically, this means the amount did not have the expected number of decimal places. The
- * number of decimal places is specified by <a
- * href="https://en.wikipedia.org/wiki/ISO_4217#Active_codes">ISO 4217</a>.
- *
- * @see org.mobilitydata.gtfsvalidator.annotation.CurrencyAmount
+ * <p>Typically, this means the amount did not have the expected number of decimal places. Check the
+ * formatting of your amount field so it matches the number of decimal places specified by the <a
+ * href="https://en.wikipedia.org/wiki/ISO_4217#Active_codes">currency_code value</a>.
  */
 @GtfsValidationNotice(severity = ERROR, sections = @SectionRefs(FILED_TYPES))
 public class InvalidCurrencyAmountNotice extends ValidationNotice {
 
   /** The name of the faulty file. */
   private final String filename;
 
-  /** Faulty record's field name. */
-  private final String fieldName;
-
   /** The row of the faulty record. */
   private final int csvRowNumber;
 
-  /** Faulty currency amount value. */
-  private final String amount;
+  /** Faulty record's currency code. */
+  private final String currencyCode;
+
+  /** Faulty record's field name. */
+  private final String fieldName;
+
+  /** Faulty currency field amount value. */
+  private final String fieldValue;
 
   public InvalidCurrencyAmountNotice(
-      String filename, String fieldName, int csvRowNumber, BigDecimal amount) {
+      String filename, int csvRowNumber, String currencyCode, String fieldName, BigDecimal amount) {
     this.filename = filename;
-    this.fieldName = fieldName;
     this.csvRowNumber = csvRowNumber;
-    this.amount = amount.toPlainString();
+    this.currencyCode = currencyCode;
+    this.fieldName = fieldName;
+    this.fieldValue = amount.toPlainString();
   }
 }

main/src/test/java/org/mobilitydata/gtfsvalidator/validator/NoticeFieldsTest.java

@@ -227,7 +227,8 @@ public void testNoticeClassFieldNames() {
             "validator",
             "value",
             "duplicatedElement",
-            "unknownElement");
+            "unknownElement",
+            "currencyCode");
   }
 
   private static List<String> discoverValidationNoticeFieldNames() {

processor/src/main/java/org/mobilitydata/gtfsvalidator/processor/CurrencyAmountValidatorGenerator.java

@@ -93,7 +93,7 @@ private static TypeSpec generateValidator(GtfsFileDescriptor fileDescriptor) {
           .addStatement("$T currency = entity.$L()", Currency.class, currencyField.name())
           .beginControlFlow("if (amount.scale() != currency.getDefaultFractionDigits())")
           .addStatement(
-              "noticeContainer.addValidationNotice(new $T(\"$L\", \"$L\", entity.csvRowNumber(),"
+              "noticeContainer.addValidationNotice(new $T(\"$L\", entity.csvRowNumber(), currency.getCurrencyCode(),  \"$L\", "
                   + " amount))",
               InvalidCurrencyAmountNotice.class,
               fileDescriptor.filename(),

processor/tests/src/test/java/org/mobilitydata/gtfsvalidator/processor/tests/CurrencyAmountSchemaTest.java

@@ -60,7 +60,7 @@ public void testInvalidCurrencyUSD() throws ValidatorLoaderException {
     assertThat(helper.getValidationNotices())
         .containsExactly(
             new InvalidCurrencyAmountNotice(
-                "currency_amount.txt", "amount", 2, new BigDecimal("1.5")));
+                "currency_amount.txt", 2, "USD", "amount", new BigDecimal("1.5")));
   }
 
   @Test
@@ -79,6 +79,6 @@ public void testInvalidCurrencyISK() throws ValidatorLoaderException {
     assertThat(helper.getValidationNotices())
         .containsExactly(
             new InvalidCurrencyAmountNotice(
-                "currency_amount.txt", "amount", 2, new BigDecimal("5.0")));
+                "currency_amount.txt", 2, "ISK", "amount", new BigDecimal("5.0")));
   }
 }