Skip to content

#3574 Respect only explicit mappings but fail on unmapped source fields #3632

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

Merged
filiphr merged 2 commits into from
Jul 6, 2024
Merged

#3574 Respect only explicit mappings but fail on unmapped source fields #3632

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
73fc5ed
#3574 Respect only explicit mappings but fail on unmapped source fields
filiphr Jun 30, 2024
8ff2e0d
Apply review feedback
filiphr Jul 6, 2024
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
4 changes: 4 additions & 0 deletions NEXT_RELEASE_CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

### Enhancements

* Breaking change:g (#3574) -
This reverts #2560, because we've decided that `@BeanMapping(ignoreByDefault = true)` should only be applied to target properties and not to source properties.
Source properties are ignored anyway, the `BeanMapping#unmappedSourcePolicy` should be used to control what should happen with unmapped source policy

### Bugs

### Documentation
Expand Down
4 changes: 0 additions & 4 deletions processor/src/main/java/org/mapstruct/ap/internal/model/BeanMappingMethod.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1764,10 +1764,6 @@ private ReportingPolicyGem getUnmappedSourcePolicy() {
if ( mappingReferences.isForForgedMethods() ) {
return ReportingPolicyGem.IGNORE;
}
// If we have ignoreByDefault = true, unprocessed source properties are not an issue.
if ( method.getOptions().getBeanMapping().isignoreByDefault() ) {
return ReportingPolicyGem.IGNORE;
}
return method.getOptions().getBeanMapping().unmappedSourcePolicy();
}

Expand Down
5 changes: 3 additions & 2 deletions ...rebydefaultsource/SourceTargetMapper.java → ...ourceTargetMapperWithIgnoreByDefault.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,9 @@
@Mapper(
unmappedTargetPolicy = ReportingPolicy.IGNORE,
unmappedSourcePolicy = ReportingPolicy.ERROR)
public interface SourceTargetMapper {
SourceTargetMapper INSTANCE = Mappers.getMapper( SourceTargetMapper.class );
public interface ErroneousSourceTargetMapperWithIgnoreByDefault {
ErroneousSourceTargetMapperWithIgnoreByDefault INSTANCE = Mappers.getMapper(
ErroneousSourceTargetMapperWithIgnoreByDefault.class );

@Mapping(source = "one", target = "one")
@BeanMapping(ignoreByDefault = true)
Expand Down
13 changes: 11 additions & 2 deletions ...src/test/java/org/mapstruct/ap/test/ignorebydefaultsource/IgnoreByDefaultSourcesTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,17 @@
public class IgnoreByDefaultSourcesTest {

@ProcessorTest
@WithClasses({ SourceTargetMapper.class, Source.class, Target.class })
public void shouldSucceed() {
@WithClasses({ ErroneousSourceTargetMapperWithIgnoreByDefault.class, Source.class, Target.class })
@ExpectedCompilationOutcome(
value = CompilationResult.FAILED,
diagnostics = {
@Diagnostic(type = ErroneousSourceTargetMapperWithIgnoreByDefault.class,
kind = Kind.ERROR,
line = 23,
message = "Unmapped source property: \"other\".")
}
)
public void shouldRaiseErrorDueToNonIgnoredSourcePropertyWithBeanMappingIgnoreByDefault() {
}

@ProcessorTest
Expand Down