Skip to content

FINERACT-2769: Tax group – Start Date field validation/behavior issues on edit mode if the group is unlinked #6290

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rymghosn wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

FINERACT-2769: Tax group – Start Date field validation/behavior issues on edit mode if the group is unlinked #6290

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions ...ct-charge/src/main/java/org/apache/fineract/portfolio/charge/domain/ChargeRepository.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,7 @@ public interface ChargeRepository extends JpaRepository<Charge, Long>, JpaSpecif

@Query("select lc.id from WorkingCapitalLoanCharge lc where lc.charge.id = :chargeId and lc.active = true")
Optional<Long> isAnyWorkingCapitalLoansAssociateWithThisCharge(@Param("chargeId") Long chargeId);

@Query("select case when count(c) > 0 then true else false end from Charge c where c.taxGroup.id = :taxGroupId")
boolean existsByTaxGroupId(@Param("taxGroupId") Long taxGroupId);
}
17 changes: 14 additions & 3 deletions fineract-core/src/main/java/org/apache/fineract/portfolio/tax/data/TaxGroupData.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,21 +35,32 @@ public final class TaxGroupData implements Serializable {
@SuppressWarnings("unused")
private final Collection<TaxComponentData> taxComponents;

// Edit control flag: false if tax group is linked to charge products and none of its components has a
// not-yet-effective start date, true otherwise
@SuppressWarnings("unused")
private final Boolean groupEditable;

public static TaxGroupData lookup(final Long id, final String name) {
final Collection<TaxComponentData> taxComponents = null;
final Collection<TaxGroupMappingsData> taxAssociations = null;
return new TaxGroupData(id, name, taxAssociations, taxComponents);
return new TaxGroupData(id, name, taxAssociations, taxComponents, null);
}

public static TaxGroupData template(final Collection<TaxComponentData> taxComponents) {
final Long id = null;
final String name = null;
final Collection<TaxGroupMappingsData> taxAssociations = null;
return new TaxGroupData(id, name, taxAssociations, taxComponents);
return new TaxGroupData(id, name, taxAssociations, taxComponents, null);
}

public static TaxGroupData template(final TaxGroupData taxGroupData, final Collection<TaxComponentData> taxComponents) {
return new TaxGroupData(taxGroupData.id, taxGroupData.name, taxGroupData.taxAssociations, taxComponents);
return new TaxGroupData(taxGroupData.id, taxGroupData.name, taxGroupData.taxAssociations, taxComponents,
taxGroupData.groupEditable);
}

public static TaxGroupData template(final TaxGroupData taxGroupData, final Collection<TaxComponentData> taxComponents,
final Boolean groupEditable) {
return new TaxGroupData(taxGroupData.id, taxGroupData.name, taxGroupData.taxAssociations, taxComponents, groupEditable);
}

}
4 changes: 4 additions & 0 deletions fineract-core/src/main/java/org/apache/fineract/portfolio/tax/data/TaxGroupMappingsData.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,10 @@ public class TaxGroupMappingsData implements Serializable {
private final LocalDate startDate;
@SuppressWarnings("unused")
private final LocalDate endDate;
// Edit control flag: true if this component's start date is in the future, false otherwise.
// Only meaningful when the owning TaxGroupData's groupEditable is true.
@SuppressWarnings("unused")
private Boolean componentEditable;

public boolean occursOnDayFromAndUpToAndIncluding(final LocalDate target) {
return DateUtils.isAfter(target, startDate()) && (endDate == null || !DateUtils.isAfter(target, endDate()));
Expand Down
7 changes: 4 additions & 3 deletions fineract-provider/src/main/java/org/apache/fineract/portfolio/tax/service/TaxAssembler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,12 +131,13 @@ public Set<TaxGroupMappings> assembleTaxGroupMappingsFrom(final JsonCommand comm
dateFormat, locale);
final LocalDate endDate = this.fromApiJsonHelper.extractLocalDateNamed(TaxApiConstants.endDateParamName, taxComponent,
dateFormat, locale);
if (endDate == null && startDate == null) {
final boolean isExistingMapping = isUpdate && mappingId != null;
if (endDate == null && startDate == null && !isExistingMapping) {
startDate = DateUtils.getBusinessLocalDate();
}
TaxGroupMappings mappings = null;
if (isUpdate && mappingId != null) {
mappings = TaxGroupMappings.createTaxGroupMappings(mappingId, component, endDate);
if (isExistingMapping) {
mappings = TaxGroupMappings.createTaxGroupMappings(mappingId, component, startDate, endDate);
} else {
mappings = TaxGroupMappings.createTaxGroupMappings(component, startDate);
}
Expand Down
30 changes: 29 additions & 1 deletion ...r/src/main/java/org/apache/fineract/portfolio/tax/service/TaxReadPlatformServiceImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,16 @@
*/
package org.apache.fineract.portfolio.tax.service;

import java.time.LocalDate;
import java.util.Collection;
import java.util.List;
import lombok.RequiredArgsConstructor;
import org.apache.fineract.accounting.common.AccountingDropdownReadPlatformService;
import org.apache.fineract.infrastructure.core.service.DateUtils;
import org.apache.fineract.portfolio.charge.domain.ChargeRepository;
import org.apache.fineract.portfolio.tax.data.TaxComponentData;
import org.apache.fineract.portfolio.tax.data.TaxGroupData;
import org.apache.fineract.portfolio.tax.data.TaxGroupMappingsData;
import org.apache.fineract.portfolio.tax.domain.TaxComponentRepository;
import org.apache.fineract.portfolio.tax.domain.TaxComponentRepositoryWrapper;
import org.apache.fineract.portfolio.tax.domain.TaxGroupRepository;
Expand All @@ -41,6 +45,7 @@ public class TaxReadPlatformServiceImpl implements TaxReadPlatformService {
private final TaxGroupRepository taxGroupRepository;
private final TaxGroupRepositoryWrapper taxGroupRepositoryWrapper;
private final TaxGroupMapper taxGroupMapper;
private final ChargeRepository chargeRepository;

@Override
public List<TaxComponentData> retrieveAllTaxComponents() {
Expand Down Expand Up @@ -71,7 +76,30 @@ public TaxGroupData retrieveTaxGroupData(final Long id) {
@Override
public TaxGroupData retrieveTaxGroupWithTemplate(final Long id) {
TaxGroupData taxGroupData = retrieveTaxGroupData(id);
taxGroupData = TaxGroupData.template(taxGroupData, retrieveTaxComponentsForLookUp());

final boolean isLinked = chargeRepository.existsByTaxGroupId(id);
final LocalDate today = DateUtils.getBusinessLocalDate();

// A linked group is only editable if at least one of its components has not taken effect yet.
Boolean groupEditable = !isLinked;
if (isLinked && taxGroupData.getTaxAssociations() != null) {
for (TaxGroupMappingsData mapping : taxGroupData.getTaxAssociations()) {
if (mapping.getStartDate() != null && mapping.getStartDate().isAfter(today)) {
groupEditable = true;
break;
}
}
}

if (taxGroupData.getTaxAssociations() != null) {
for (TaxGroupMappingsData mapping : taxGroupData.getTaxAssociations()) {
final boolean componentEditable = Boolean.TRUE.equals(groupEditable) && mapping.getStartDate() != null
&& mapping.getStartDate().isAfter(today);
mapping.setComponentEditable(componentEditable);
}
}

taxGroupData = TaxGroupData.template(taxGroupData, retrieveTaxComponentsForLookUp(), groupEditable);
return taxGroupData;
}

Expand Down
6 changes: 4 additions & 2 deletions ...ct-provider/src/main/java/org/apache/fineract/portfolio/tax/starter/TaxConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
import org.apache.fineract.accounting.common.AccountingDropdownReadPlatformService;
import org.apache.fineract.accounting.glaccount.domain.GLAccountRepositoryWrapper;
import org.apache.fineract.infrastructure.core.serialization.FromJsonHelper;
import org.apache.fineract.portfolio.charge.domain.ChargeRepository;
import org.apache.fineract.portfolio.tax.domain.TaxComponentRepository;
import org.apache.fineract.portfolio.tax.domain.TaxComponentRepositoryWrapper;
import org.apache.fineract.portfolio.tax.domain.TaxGroupRepository;
Expand Down Expand Up @@ -52,9 +53,10 @@ public TaxAssembler taxAssembler(FromJsonHelper fromApiJsonHelper, GLAccountRepo
public TaxReadPlatformService taxReadPlatformService(final TaxComponentRepository taxComponentRepository,
final TaxComponentRepositoryWrapper taxComponentRepositoryWrapper, final TaxComponentMapper taxComponentMapper,
final TaxGroupRepository taxGroupRepository, final TaxGroupRepositoryWrapper taxGroupRepositoryWrapper,
final TaxGroupMapper taxGroupMapper, AccountingDropdownReadPlatformService accountingDropdownReadPlatformService) {
final TaxGroupMapper taxGroupMapper, AccountingDropdownReadPlatformService accountingDropdownReadPlatformService,
final ChargeRepository chargeRepository) {
return new TaxReadPlatformServiceImpl(accountingDropdownReadPlatformService, taxComponentRepository, taxComponentRepositoryWrapper,
taxComponentMapper, taxGroupRepository, taxGroupRepositoryWrapper, taxGroupMapper);
taxComponentMapper, taxGroupRepository, taxGroupRepositoryWrapper, taxGroupMapper, chargeRepository);
}

@Bean
Expand Down
8 changes: 8 additions & 0 deletions ...t-tax/src/main/java/org/apache/fineract/portfolio/tax/api/TaxGroupApiResourceSwagger.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,13 +54,17 @@ private GetTaxesGroupTaxComponent() {}
public GetTaxesGroupTaxComponent taxComponent;
@Schema(example = "[2016, 4, 11]")
public LocalDate startDate;
@Schema(example = "true", description = "Only present on the template response. True if this component's start date is in the future and can still be edited.")
public Boolean componentEditable;
}

@Schema(example = "7")
public Long id;
@Schema(example = "tax group 1")
public String name;
public Set<GetTaxesGroupTaxAssociations> taxAssociations;
@Schema(example = "true", description = "Only present on the template response. False if the group is linked to charge products and none of its components can still be edited.")
public Boolean groupEditable;
}

@Schema(description = "PostTaxesGroupRequest")
Expand Down Expand Up @@ -109,6 +113,8 @@ private PutTaxesGroupTaxComponents() {}
public Long id;
@Schema(example = "7")
public Long taxComponentId;
@Schema(example = "22 April 2016", description = "Only accepted when this component's current start date has not taken effect yet, i.e. is still in the future.")
public String startDate;
@Schema(example = "22 April 2016")
public String endDate;
}
Expand All @@ -135,6 +141,8 @@ static final class PutTaxesGroupModifiedComponents {

private PutTaxesGroupModifiedComponents() {}

@Schema(example = "Apr 22, 2016 12:00:00 AM")
public String startDate;
@Schema(example = "Apr 22, 2016 12:00:00 AM")
public String endDate;
@Schema(example = "7")
Expand Down
3 changes: 2 additions & 1 deletion fineract-tax/src/main/java/org/apache/fineract/portfolio/tax/domain/TaxGroup.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,10 +75,11 @@ public Map<String, Object> update(final JsonCommand command, final Set<TaxGroupM
for (TaxGroupMappings groupMappings : taxGroupMappings) {
TaxGroupMappings mappings = findOneBy(groupMappings);
if (mappings == null) {
groupMappings.setTaxGroup(this);
this.taxGroupMappings.add(groupMappings);
taxComponentList.add(groupMappings.getTaxComponent().getId());
} else {
mappings.update(groupMappings.getEndDate(), modifications);
mappings.update(groupMappings.getStartDate(), groupMappings.getEndDate(), modifications);
}
}

Expand Down
13 changes: 10 additions & 3 deletions fineract-tax/src/main/java/org/apache/fineract/portfolio/tax/domain/TaxGroupMappings.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,15 +65,22 @@ public static TaxGroupMappings createTaxGroupMappings(final TaxComponent taxComp

}

public static TaxGroupMappings createTaxGroupMappings(final Long id, final TaxComponent taxComponent, final LocalDate endDate) {
final LocalDate startDate = null;
public static TaxGroupMappings createTaxGroupMappings(final Long id, final TaxComponent taxComponent, final LocalDate startDate,
final LocalDate endDate) {
TaxGroupMappings groupMappings = new TaxGroupMappings(taxComponent, startDate, endDate);
groupMappings.setId(id);
return groupMappings;

}

public void update(final LocalDate endDate, final List<Map<String, Object>> changes) {
public void update(final LocalDate startDate, final LocalDate endDate, final List<Map<String, Object>> changes) {
if (startDate != null && !DateUtils.isEqual(startDate, this.startDate)) {
this.startDate = startDate;
Map<String, Object> map = new HashMap<>(2);
map.put(TaxApiConstants.startDateParamName, startDate);
map.put(TaxApiConstants.taxComponentIdParamName, this.getTaxComponent().getId());
changes.add(map);
}
if (endDate != null && this.endDate == null) {
this.endDate = endDate;
Map<String, Object> map = new HashMap<>(2);
Expand Down
1 change: 1 addition & 0 deletions fineract-tax/src/main/java/org/apache/fineract/portfolio/tax/mapper/TaxGroupMapper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ public interface TaxGroupMapper {

@Mapping(target = "taxAssociations", source = "taxGroup.taxGroupMappings")
@Mapping(target = "taxComponents", ignore = true)
@Mapping(target = "groupEditable", ignore = true)
TaxGroupData map(TaxGroup taxGroup);

List<TaxGroupData> map(List<TaxGroup> taxGroups);
Expand Down
2 changes: 2 additions & 0 deletions ...ct-tax/src/main/java/org/apache/fineract/portfolio/tax/mapper/TaxGroupMappingsMapper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,12 @@
import org.apache.fineract.portfolio.tax.data.TaxGroupMappingsData;
import org.apache.fineract.portfolio.tax.domain.TaxGroupMappings;
import org.mapstruct.Mapper;
import org.mapstruct.Mapping;

@Mapper(config = MapstructMapperConfig.class, uses = { TaxComponentMapper.class })
public interface TaxGroupMappingsMapper {

@Mapping(target = "componentEditable", ignore = true)
TaxGroupMappingsData map(TaxGroupMappings taxGroupMapping);

List<TaxGroupMappingsData> map(List<TaxGroupMappings> taxGroupMappings);
Expand Down
27 changes: 23 additions & 4 deletions fineract-tax/src/main/java/org/apache/fineract/portfolio/tax/serialization/TaxValidator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -247,8 +247,7 @@ public void validateForTaxGroupUpdate(final String json) {
SUPPORTED_TAX_GROUP_TAX_COMPONENTS_UPDATE_PARAMETERS);
final Long taxComponentId = this.fromApiJsonHelper.extractLongNamed(TaxApiConstants.taxComponentIdParamName,
taxComponent);
final Long taxMappingId = this.fromApiJsonHelper.extractLongNamed(TaxApiConstants.taxComponentIdParamName,
taxComponent);
final Long taxMappingId = this.fromApiJsonHelper.extractLongNamed(TaxApiConstants.idParamName, taxComponent);
if (taxMappingId == null) {
baseDataValidator.reset().parameter(
TaxApiConstants.taxComponentsParamName + DOT + TaxApiConstants.taxComponentIdParamName + AT_INDEX + i)
Expand All @@ -262,13 +261,17 @@ public void validateForTaxGroupUpdate(final String json) {
.value(taxMappingId).longGreaterThanZero();
}

final LocalDate today = DateUtils.getBusinessLocalDate();
final LocalDate endDate = this.fromApiJsonHelper.extractLocalDateNamed(TaxApiConstants.endDateParamName, taxComponent,
dateFormat, locale);
baseDataValidator.reset()
.parameter(TaxApiConstants.taxComponentsParamName + DOT + TaxApiConstants.endDateParamName + AT_INDEX + i)
.value(endDate).ignoreIfNull().validateDateAfter(DateUtils.getBusinessLocalDate());
.value(endDate).ignoreIfNull().validateDateAfter(today);
final LocalDate startDate = this.fromApiJsonHelper.extractLocalDateNamed(TaxApiConstants.startDateParamName,
taxComponent, dateFormat, locale);
baseDataValidator.reset()
.parameter(TaxApiConstants.taxComponentsParamName + DOT + TaxApiConstants.startDateParamName + AT_INDEX + i)
.value(startDate).ignoreIfNull().validateDateAfterOrEqual(today);
if (endDate != null && startDate != null) {
baseDataValidator.reset().parameter(TaxApiConstants.taxComponentsParamName + AT_INDEX + i)
.failWithCode("start.date.end.date.both.should.not.be.present", startDate, endDate);
Expand All @@ -282,16 +285,32 @@ public void validateForTaxGroupUpdate(final String json) {
public void validateTaxGroupEndDateAndTaxComponent(final TaxGroup taxGroup, final Set<TaxGroupMappings> groupMappings) {
final List<ApiParameterError> dataValidationErrors = new ArrayList<>();
final DataValidatorBuilder baseDataValidator = new DataValidatorBuilder(dataValidationErrors).resource(TAX_GROUP);
final LocalDate today = DateUtils.getBusinessLocalDate();

for (TaxGroupMappings mapping : groupMappings) {
if (mapping.getId() != null) {
TaxGroupMappings existing = taxGroup.findOneBy(mapping);

// Start date can only be changed while the existing mapping has not taken effect yet; once its
// start date is on or before today, it is locked and only the end date remains editable.
LocalDate effectiveStartDate = existing.startDate();
if (mapping.startDate() != null && !DateUtils.isEqual(mapping.startDate(), existing.startDate())) {
if (!DateUtils.isAfter(existing.startDate(), today)) {
baseDataValidator.reset().parameter(TaxApiConstants.startDateParamName)
.failWithCode("cannot.be.modified.after.activation");
} else {
baseDataValidator.reset().parameter(TaxApiConstants.startDateParamName).value(mapping.startDate())
.validateDateAfterOrEqual(today);
effectiveStartDate = mapping.startDate();
}
}

if (existing.endDate() != null && mapping.endDate() != null && !DateUtils.isEqual(existing.endDate(), mapping.endDate())) {
baseDataValidator.reset().parameter(TaxApiConstants.endDateParamName)
.failWithCode("can.not.modify.end.date.once.updated");
} else {
baseDataValidator.reset().parameter(TaxApiConstants.endDateParamName).value(mapping.endDate()).ignoreIfNull()
.validateDateAfter(existing.startDate());
.validateDateAfter(effectiveStartDate);
}
if (mapping.getTaxComponent() != null && !existing.getTaxComponent().getId().equals(mapping.getTaxComponent().getId())) {
baseDataValidator.reset().parameter(TaxApiConstants.taxComponentIdParamName).failWithCode("update.not.supported");
Expand Down
Loading