#3202 Improve line location report for invalid qualifier for SubclassMapping

EvaristeGalois11 · EvaristeGalois11 · commit feaf19056fc8 · 2023-03-18T13:01:49.000+01:00
diff --git a/processor/src/main/java/org/mapstruct/ap/internal/model/BeanMappingMethod.java b/processor/src/main/java/org/mapstruct/ap/internal/model/BeanMappingMethod.java
@@ -412,7 +412,7 @@ private SubclassMapping createSubclassMapping(SubclassMappingOptions subclassMap
                                        FormattingParameters.EMPTY,
                                        criteria,
                                        rightHandSide,
-                                       null,
+                                       subclassMappingOptions.getMirror(),
                                            () -> forgeSubclassMapping(
                                                rightHandSide,
                                                sourceType,
diff --git a/processor/src/main/java/org/mapstruct/ap/internal/model/source/SubclassMappingOptions.java b/processor/src/main/java/org/mapstruct/ap/internal/model/source/SubclassMappingOptions.java
@@ -7,7 +7,9 @@
 
 import java.util.ArrayList;
 import java.util.List;
+import java.util.Optional;
 import java.util.Set;
+import javax.lang.model.element.AnnotationMirror;
 import javax.lang.model.element.ExecutableElement;
 import javax.lang.model.type.TypeMirror;
 
@@ -34,14 +36,16 @@ public class SubclassMappingOptions extends DelegatingOptions {
     private final TypeMirror target;
     private final TypeUtils typeUtils;
     private final SelectionParameters selectionParameters;
+    private final SubclassMappingGem subclassMappingGem;
 
     public SubclassMappingOptions(TypeMirror source, TypeMirror target, TypeUtils typeUtils, DelegatingOptions next,
-                                  SelectionParameters selectionParameters) {
+                                  SelectionParameters selectionParameters, SubclassMappingGem subclassMappingGem) {
         super( next );
         this.source = source;
         this.target = target;
         this.typeUtils = typeUtils;
         this.selectionParameters = selectionParameters;
+        this.subclassMappingGem = subclassMappingGem;
     }
 
     @Override
@@ -124,6 +128,10 @@ public SelectionParameters getSelectionParameters() {
         return selectionParameters;
     }
 
+    public AnnotationMirror getMirror() {
+        return Optional.ofNullable( subclassMappingGem ).map( SubclassMappingGem::mirror ).orElse( null );
+    }
+
     public static void addInstances(SubclassMappingsGem gem, ExecutableElement method,
                                     BeanMappingOptions beanMappingOptions, FormattingMessager messager,
                                     TypeUtils typeUtils, Set<SubclassMappingOptions> mappings,
@@ -143,13 +151,13 @@ public static void addInstances(SubclassMappingsGem gem, ExecutableElement metho
         }
     }
 
-    public static void addInstance(SubclassMappingGem subclassMapping, ExecutableElement method,
+    public static void addInstance(SubclassMappingGem subclassMappingGem, ExecutableElement method,
                                    BeanMappingOptions beanMappingOptions, FormattingMessager messager,
                                    TypeUtils typeUtils, Set<SubclassMappingOptions> mappings,
                                    List<Parameter> sourceParameters, Type resultType,
                                    SubclassValidator subclassValidator) {
         if ( !isConsistent(
-            subclassMapping,
+            subclassMappingGem,
             method,
             messager,
             typeUtils,
@@ -159,11 +167,11 @@ public static void addInstance(SubclassMappingGem subclassMapping, ExecutableEle
             return;
         }
 
-        TypeMirror sourceSubclass = subclassMapping.source().getValue();
-        TypeMirror targetSubclass = subclassMapping.target().getValue();
+        TypeMirror sourceSubclass = subclassMappingGem.source().getValue();
+        TypeMirror targetSubclass = subclassMappingGem.target().getValue();
         SelectionParameters selectionParameters = new SelectionParameters(
-            subclassMapping.qualifiedBy().get(),
-            subclassMapping.qualifiedByName().get(),
+            subclassMappingGem.qualifiedBy().get(),
+            subclassMappingGem.qualifiedByName().get(),
             targetSubclass,
             typeUtils
         );
@@ -175,7 +183,8 @@ public static void addInstance(SubclassMappingGem subclassMapping, ExecutableEle
                         targetSubclass,
                         typeUtils,
                         beanMappingOptions,
-                        selectionParameters
+                        selectionParameters,
+                        subclassMappingGem
                     ) );
     }
 
@@ -190,7 +199,8 @@ public static List<SubclassMappingOptions> copyForInverseInheritance(Set<Subclas
                     subclassMapping.source,
                     subclassMapping.typeUtils,
                     beanMappingOptions,
-                    subclassMapping.selectionParameters
+                    subclassMapping.selectionParameters,
+                    subclassMapping.subclassMappingGem
                 ) );
         }
         return mappings;
diff --git a/processor/src/test/java/org/mapstruct/ap/test/subclassmapping/qualifier/ErroneousSubclassQualifiedByMapper.java b/processor/src/test/java/org/mapstruct/ap/test/subclassmapping/qualifier/ErroneousSubclassQualifiedByMapper.java
@@ -11,6 +11,5 @@
 @Mapper(uses = { RossiniMapper.class, VivaldiMapper.class })
 public interface ErroneousSubclassQualifiedByMapper {
     @SubclassMapping(source = Rossini.class, target = RossiniDto.class, qualifiedBy = NonExistent.class)
-    @SubclassMapping(source = Vivaldi.class, target = VivaldiDto.class)
     ComposerDto toDto(Composer composer);
 }
diff --git a/processor/src/test/java/org/mapstruct/ap/test/subclassmapping/qualifier/ErroneousSubclassQualifiedByNameMapper.java b/processor/src/test/java/org/mapstruct/ap/test/subclassmapping/qualifier/ErroneousSubclassQualifiedByNameMapper.java
@@ -11,6 +11,5 @@
 @Mapper(uses = { RossiniMapper.class, VivaldiMapper.class })
 public interface ErroneousSubclassQualifiedByNameMapper {
     @SubclassMapping(source = Rossini.class, target = RossiniDto.class, qualifiedByName = "non-existent")
-    @SubclassMapping(source = Vivaldi.class, target = VivaldiDto.class)
     ComposerDto toDto(Composer composer);
 }
diff --git a/processor/src/test/java/org/mapstruct/ap/test/subclassmapping/qualifier/SubclassQualifierMapperTest.java b/processor/src/test/java/org/mapstruct/ap/test/subclassmapping/qualifier/SubclassQualifierMapperTest.java
@@ -230,7 +230,7 @@ void subclassQualifiedByNameDoesNotContainUnused() {
         diagnostics = @Diagnostic(
             type = ErroneousSubclassQualifiedByMapper.class,
             kind = javax.tools.Diagnostic.Kind.ERROR,
-            line = 15,
+            line = 13,
             message = "Qualifier error. No method found annotated with: [ @NonExistent ]. " +
                 "See https://mapstruct.org/faq/#qualifier for more info."
         )
@@ -245,7 +245,7 @@ void subclassQualifiedByErroneous() {
         diagnostics = @Diagnostic(
             type = ErroneousSubclassQualifiedByNameMapper.class,
             kind = javax.tools.Diagnostic.Kind.ERROR,
-            line = 15,
+            line = 13,
             message = "Qualifier error. No method found annotated with @Named#value: [ non-existent ]. " +
                 "See https://mapstruct.org/faq/#qualifier for more info."
         )

Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,5 @@`
`11`	`11`	`@Mapper(uses = { RossiniMapper.class, VivaldiMapper.class })`
`12`	`12`	`public interface ErroneousSubclassQualifiedByMapper {`
`13`	`13`	`@SubclassMapping(source = Rossini.class, target = RossiniDto.class, qualifiedBy = NonExistent.class)`
`14`		`- @SubclassMapping(source = Vivaldi.class, target = VivaldiDto.class)`
`15`	`14`	`ComposerDto toDto(Composer composer);`
`16`	`15`	`}`