FINERACT-2060: Accrual reverse replay logic and Handling

fineract-charge/src/main/java/org/apache/fineract/portfolio/charge/service/ChargeReadPlatformService.java

@@ -19,6 +19,7 @@
 package org.apache.fineract.portfolio.charge.service;
 
 import java.util.Collection;
+import java.util.List;
 import org.apache.fineract.portfolio.charge.data.ChargeData;
 import org.apache.fineract.portfolio.charge.domain.ChargeTimeType;
 
@@ -53,7 +54,7 @@ public interface ChargeReadPlatformService {
      *            Excludes Given List of Charge Types from the response
      * @return
      */
-    Collection<ChargeData> retrieveLoanAccountApplicableCharges(Long loanId, ChargeTimeType[] excludeChargeTimes);
+    List<ChargeData> retrieveLoanAccountApplicableCharges(Long loanId, ChargeTimeType[] excludeChargeTimes);
 
     /**
      * Returns all charges applicable for a given loan product (filter based on Currency of Selected Loan Product)

fineract-core/src/main/java/org/apache/fineract/infrastructure/core/service/DateUtils.java

@@ -193,11 +193,23 @@ public static int compare(OffsetDateTime first, OffsetDateTime second) {
     }
 
     public static int compare(OffsetDateTime first, OffsetDateTime second, ChronoUnit truncate) {
+        return compare(first, second, truncate, true);
+    }
+
+    public static int compareWithNullsLast(OffsetDateTime first, OffsetDateTime second) {
+        return compare(first, second, null, false);
+    }
+
+    public static int compareWithNullsLast(@NotNull Optional<OffsetDateTime> first, @NotNull Optional<OffsetDateTime> second) {
+        return compareWithNullsLast(first.orElse(null), second.orElse(null));
+    }
+
+    public static int compare(OffsetDateTime first, OffsetDateTime second, ChronoUnit truncate, boolean nullFirst) {
         if (first == null) {
-            return second == null ? 0 : -1;
+            return second == null ? 0 : (nullFirst ? -1 : 1);
         }
         if (second == null) {
-            return 1;
+            return nullFirst ? 1 : -1;
         }
         first = first.withOffsetSameInstant(ZoneOffset.UTC);
         second = second.withOffsetSameInstant(ZoneOffset.UTC);
@@ -291,7 +303,23 @@ public static boolean isDateInTheFuture(final LocalDate localDate) {
     }
 
     public static int compare(LocalDate first, LocalDate second) {
-        return first == null ? (second == null ? 0 : -1) : (second == null ? 1 : first.compareTo(second));
+        return compare(first, second, true);
+    }
+
+    /**
+     * Comparing dates. Null will be considered as last elements
+     *
+     * @param first
+     * @param second
+     * @return
+     */
+    public static int compareWithNullsLast(LocalDate first, LocalDate second) {
+        return compare(first, second, false);
+    }
+
+    public static int compare(LocalDate first, LocalDate second, boolean nullFirst) {
+        return first == null ? (second == null ? 0 : (nullFirst ? -1 : 1))
+                : (second == null ? (nullFirst ? 1 : -1) : first.compareTo(second));
     }
 
     public static boolean isEqual(LocalDate first, LocalDate second) {
@@ -426,23 +454,4 @@ private static DateTimeFormatter getDateTimeFormatter(String format, Locale loca
         }
         return formatter;
     }
-
-    /**
-     * Comparing dates. Null will be considered as last elements
-     *
-     * @param first
-     * @param second
-     * @return
-     */
-    public static int compareWithNullsLast(LocalDate first, LocalDate second) {
-        return first == null ? (second == null ? 0 : 1) : (second == null ? -1 : first.compareTo(second));
-    }
-
-    public static int compareWithNullsLast(@NotNull Optional<OffsetDateTime> first, @NotNull Optional<OffsetDateTime> second) {
-        return DateUtils.compareWithNullsLast(first.orElse(null), second.orElse(null));
-    }
-
-    public static int compareWithNullsLast(OffsetDateTime first, OffsetDateTime second) {
-        return first == null ? (second == null ? 0 : 1) : (second == null ? -1 : first.compareTo(second));
-    }
 }

fineract-core/src/main/java/org/apache/fineract/infrastructure/core/service/MathUtil.java

@@ -291,6 +291,11 @@ public static BigDecimal subtract(BigDecimal first, BigDecimal second) {
         return subtract(first, second, MoneyHelper.getMathContext());
     }
 
+    /** @return first minus the others considering null values, maybe negative */
+    public static BigDecimal subtract(BigDecimal first, BigDecimal second, BigDecimal third) {
+        return subtract(subtract(first, second), third);
+    }
+
     /** @return first minus second considering null values, maybe negative */
     public static BigDecimal subtract(BigDecimal first, BigDecimal second, MathContext mc) {
         return first == null ? null : second == null ? first : first.subtract(second, mc);
@@ -336,6 +341,10 @@ public static String formatToSql(BigDecimal amount) {
         return amount == null ? null : amount.toPlainString();
     }
 
+    public static Money toMoney(BigDecimal amount, @NotNull MonetaryCurrency currency) {
+        return amount == null ? null : Money.of(currency, amount);
+    }
+
     // ----------------- Money -----------------
 
     public static BigDecimal toBigDecimal(Money value) {
@@ -454,6 +463,16 @@ public static Money min(Money first, Money second, Money third, boolean notNull)
         return min(min(first, second, notNull), third, notNull);
     }
 
+    /** @return Money null safe negate */
+    public static Money negate(Money amount) {
+        return negate(amount, MoneyHelper.getMathContext());
+    }
+
+    /** @return Money null safe negate */
+    public static Money negate(Money amount, MathContext mc) {
+        return isEmpty(amount) ? amount : amount.negated(mc);
+    }
+
     /**
      * Calculate percentage of a value
      *

fineract-loan/src/main/java/org/apache/fineract/infrastructure/event/business/domain/loan/transaction/LoanAccrualAdjustmentTransactionBusinessEvent.java

@@ -0,0 +1,35 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.fineract.infrastructure.event.business.domain.loan.transaction;
+
+import org.apache.fineract.portfolio.loanaccount.domain.LoanTransaction;
+
+public class LoanAccrualAdjustmentTransactionBusinessEvent extends LoanTransactionBusinessEvent {
+
+    private static final String TYPE = "LoanAccrualAdjustmentTransactionBusinessEvent";
+
+    public LoanAccrualAdjustmentTransactionBusinessEvent(LoanTransaction value) {
+        super(value);
+    }
+
+    @Override
+    public String getType() {
+        return TYPE;
+    }
+}

fineract-loan/src/main/java/org/apache/fineract/portfolio/loanaccount/data/AccrualChargeData.java

@@ -0,0 +1,38 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.fineract.portfolio.loanaccount.data;
+
+import lombok.Data;
+import lombok.RequiredArgsConstructor;
+import lombok.experimental.Accessors;
+import org.apache.fineract.organisation.monetary.domain.Money;
+
+@Data
+@Accessors(chain = true)
+@RequiredArgsConstructor
+public class AccrualChargeData {
+
+    private final Long loanChargeId;
+    private final Long loanInstallmentChargeId;
+    private final boolean isPenalty;
+    private Money chargeAmount;
+    private Money chargeAccruable;
+    private Money chargeAccrued;
+
+}

fineract-loan/src/main/java/org/apache/fineract/portfolio/loanaccount/data/AccrualPeriodData.java

@@ -0,0 +1,86 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.fineract.portfolio.loanaccount.data;
+
+import java.time.LocalDate;
+import java.util.ArrayList;
+import java.util.List;
+import lombok.Data;
+import lombok.RequiredArgsConstructor;
+import lombok.experimental.Accessors;
+import org.apache.fineract.infrastructure.core.service.MathUtil;
+import org.apache.fineract.organisation.monetary.domain.Money;
+
+@Data
+@Accessors(chain = true)
+@RequiredArgsConstructor
+public class AccrualPeriodData {
+
+    private final Integer installmentNumber;
+    private final boolean isFirstPeriod;
+    private final LocalDate startDate;
+    private final LocalDate dueDate;
+    private Money interestAmount;
+    private Money interestAccruable;
+    private Money interestAccrued;
+    private final List<AccrualChargeData> charges = new ArrayList<>();
+
+    public AccrualPeriodData addCharge(AccrualChargeData charge) {
+        charges.add(charge);
+        return this;
+    }
+
+    public Money getChargeAmount() {
+        return charges.stream().map(AccrualChargeData::getChargeAmount).reduce(null, MathUtil::plus);
+    }
+
+    public Money getFeeAmount() {
+        return charges.stream().filter(charge -> !charge.isPenalty()).map(AccrualChargeData::getChargeAmount).reduce(null, MathUtil::plus);
+    }
+
+    public Money getPenaltyAmount() {
+        return charges.stream().filter(AccrualChargeData::isPenalty).map(AccrualChargeData::getChargeAmount).reduce(null, MathUtil::plus);
+    }
+
+    public Money getChargeAccrued() {
+        return charges.stream().map(AccrualChargeData::getChargeAccrued).reduce(null, MathUtil::plus);
+    }
+
+    public Money getFeeAccrued() {
+        return charges.stream().filter(charge -> !charge.isPenalty()).map(AccrualChargeData::getChargeAccrued).reduce(null, MathUtil::plus);
+    }
+
+    public Money getPenaltyAccrued() {
+        return charges.stream().filter(AccrualChargeData::isPenalty).map(AccrualChargeData::getChargeAccrued).reduce(null, MathUtil::plus);
+    }
+
+    public Money getChargeAccruable() {
+        return charges.stream().map(AccrualChargeData::getChargeAccruable).reduce(null, MathUtil::plus);
+    }
+
+    public Money getFeeAccruable() {
+        return charges.stream().filter(charge -> !charge.isPenalty()).map(AccrualChargeData::getChargeAccruable).reduce(null,
+                MathUtil::plus);
+    }
+
+    public Money getPenaltyAccruable() {
+        return charges.stream().filter(AccrualChargeData::isPenalty).map(AccrualChargeData::getChargeAccruable).reduce(null,
+                MathUtil::plus);
+    }
+}

fineract-loan/src/main/java/org/apache/fineract/portfolio/loanaccount/data/AccrualPeriodsData.java

@@ -0,0 +1,64 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.fineract.portfolio.loanaccount.data;
+
+import jakarta.validation.constraints.NotNull;
+import java.util.ArrayList;
+import java.util.List;
+import lombok.Data;
+import lombok.RequiredArgsConstructor;
+import lombok.experimental.Accessors;
+import org.apache.fineract.organisation.monetary.domain.MonetaryCurrency;
+import org.apache.fineract.portfolio.loanaccount.domain.LoanRepaymentScheduleInstallment;
+
+@Data
+@Accessors(chain = true)
+@RequiredArgsConstructor
+public class AccrualPeriodsData {
+
+    private final MonetaryCurrency currency;
+    private final List<AccrualPeriodData> periods = new ArrayList<>();
+
+    public AccrualPeriodsData addPeriod(AccrualPeriodData period) {
+        periods.add(period);
+        return this;
+    }
+
+    public static AccrualPeriodsData create(@NotNull List<LoanRepaymentScheduleInstallment> installments, Integer firstInstallmentNumber,
+            MonetaryCurrency currency) {
+        AccrualPeriodsData accrualPeriods = new AccrualPeriodsData(currency);
+        for (LoanRepaymentScheduleInstallment installment : installments) {
+            Integer installmentNumber = installment.getInstallmentNumber();
+            boolean isFirst = installmentNumber.equals(firstInstallmentNumber);
+            accrualPeriods
+                    .addPeriod(new AccrualPeriodData(installmentNumber, isFirst, installment.getFromDate(), installment.getDueDate()));
+        }
+        return accrualPeriods;
+    }
+
+    public AccrualPeriodData getPeriodByInstallmentNumber(Integer installmentNumber) {
+        return installmentNumber == null ? null
+                : periods.stream().filter(p -> installmentNumber.equals(p.getInstallmentNumber())).findFirst().orElse(null);
+    }
+
+    public Integer getFirstInstallmentNumber() {
+        return periods.stream().filter(AccrualPeriodData::isFirstPeriod).map(AccrualPeriodData::getInstallmentNumber).findFirst()
+                .orElse(null);
+    }
+}