Support BeanMapping#ignoreByDefault for the unmapped target properties inspection

Fixes #54

Author: filiphr

change-notes.html

@@ -2,6 +2,7 @@
 <h2>1.2.2</h2>
 <ul>
     <li>Support for mapping nested bean properties to current target</li>
+    <li>Support <code>@BeanMapping#ignoreByDefault</code> for the unmapped target properties inspection</li>
     <li>Bug fix: ClassCastException in language injection in expressions</li>
 </ul>
 <h2>1.2.1</h2>

src/main/java/org/mapstruct/intellij/inspection/UnmappedTargetPropertiesInspection.java

@@ -37,6 +37,8 @@
 import org.mapstruct.intellij.util.MapstructUtil;
 import org.mapstruct.intellij.util.TargetUtils;
 
+import static com.intellij.codeInsight.AnnotationUtil.findAnnotation;
+import static com.intellij.codeInsight.AnnotationUtil.getBooleanAttributeValue;
 import static org.mapstruct.intellij.util.MapstructAnnotationUtils.addMappingAnnotation;
 import static org.mapstruct.intellij.util.MapstructUtil.isInheritInverseConfiguration;
 import static org.mapstruct.intellij.util.MapstructUtil.isMapper;
@@ -75,6 +77,10 @@ public void visitMethod(PsiMethod method) {
                 return;
             }
 
+            if ( isBeanMappingIgnoreByDefault( method ) ) {
+                return;
+            }
+
             Set<String> allTargetProperties = findAllTargetProperties( targetType, mapStructVersion );
 
             // find and remove all defined mapping targets
@@ -134,6 +140,18 @@ public void visitMethod(PsiMethod method) {
             }
         }
 
+        private static boolean isBeanMappingIgnoreByDefault(PsiMethod method) {
+            PsiAnnotation beanMapping = findAnnotation( method, true, MapstructUtil.BEAN_MAPPING_FQN );
+            if ( beanMapping != null ) {
+                Boolean ignoreByDefault = getBooleanAttributeValue( beanMapping, "ignoreByDefault" );
+                if ( ignoreByDefault != null ) {
+                    return ignoreByDefault;
+                }
+            }
+
+            return false;
+        }
+
         /**
          * @param method the method to be used
          *

src/main/java/org/mapstruct/intellij/util/MapstructUtil.java

@@ -46,6 +46,7 @@
 import org.jetbrains.annotations.NonNls;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
+import org.mapstruct.BeanMapping;
 import org.mapstruct.InheritInverseConfiguration;
 import org.mapstruct.Mapper;
 import org.mapstruct.MapperConfig;
@@ -78,6 +79,8 @@ public final class MapstructUtil {
     public static final String MAPPING_ANNOTATION_FQN = Mapping.class.getName();
     public static final String MAPPERS_FQN = Mappers.class.getName();
 
+    public static final String BEAN_MAPPING_FQN = BeanMapping.class.getName();
+
     static final String MAPPINGS_ANNOTATION_FQN = Mappings.class.getName();
     static final String VALUE_MAPPING_ANNOTATION_FQN = ValueMapping.class.getName();
     static final String VALUE_MAPPINGS_ANNOTATION_FQN = ValueMappings.class.getName();

src/test/java/org/mapstruct/intellij/inspection/UnmappedTargetPropertiesWithBeanMappingIgnoreByDefaultInspectionTest.java

@@ -0,0 +1,56 @@
+/*
+ * Copyright MapStruct Authors.
+ *
+ * Licensed under the Apache License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
+ */
+package org.mapstruct.intellij.inspection;
+
+import java.util.List;
+
+import com.intellij.codeInsight.intention.IntentionAction;
+import org.jetbrains.annotations.NotNull;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * @author Filip Hrisafov
+ */
+public class UnmappedTargetPropertiesWithBeanMappingIgnoreByDefaultInspectionTest extends BaseInspectionTest {
+
+    @NotNull
+    @Override
+    protected Class<UnmappedTargetPropertiesInspection> getInspection() {
+        return UnmappedTargetPropertiesInspection.class;
+    }
+
+    @Override
+    protected void setUp() throws Exception {
+        super.setUp();
+        myFixture.copyFileToProject(
+            "UnmappedTargetPropertiesData.java",
+            "org/example/data/UnmappedTargetPropertiesData.java"
+        );
+    }
+
+    public void testUnmappedTargetPropertiesWithBeanMappingIgnoreByDefault() {
+        doTest();
+        String testName = getTestName( false );
+        List<IntentionAction> allQuickFixes = myFixture.getAllQuickFixes();
+
+        assertThat( allQuickFixes )
+            .extracting( IntentionAction::getText )
+            .as( "Intent Text" )
+            .containsExactly(
+                // For SingleMappingMapper
+                "Ignore unmapped target property: 'moreTarget'",
+                "Add unmapped target property: 'moreTarget'",
+
+                // For UpdateMapper
+                "Ignore unmapped target property: 'testName'",
+                "Add unmapped target property: 'testName'"
+            );
+
+        allQuickFixes.forEach( myFixture::launchAction );
+        myFixture.checkResultByFile( testName + "_after.java" );
+    }
+}

testData/inspection/UnmappedTargetPropertiesWithBeanMappingIgnoreByDefault.java

@@ -0,0 +1,42 @@
+/*
+ * Copyright MapStruct Authors.
+ *
+ * Licensed under the Apache License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
+ */
+
+import org.mapstruct.BeanMapping;
+import org.mapstruct.Mapper;
+import org.mapstruct.Mapping;
+import org.mapstruct.MappingTarget;
+import org.example.data.UnmappedTargetPropertiesData.Target;
+import org.example.data.UnmappedTargetPropertiesData.Source;
+
+@Mapper
+interface SingleMappingMapper {
+
+    @Mapping(target = "testName", source = "name")
+    Target <warning descr="Unmapped target property: moreTarget">map</warning>(Source source);
+}
+
+@Mapper
+interface SingleMappingMapperWithIgnoreByDefault {
+
+    @Mapping(target = "testName", source = "name")
+    @BeanMapping(ignoreByDefault = true)
+    Target map(Source source);
+}
+
+@Mapper
+interface UpdateMapper {
+
+    @Mapping(target = "moreTarget", source = "moreSource")
+    void <warning descr="Unmapped target property: testName">update</warning>(@MappingTarget Target target, Source source);
+}
+
+@Mapper
+interface UpdateMapperWithIgnoreByDefault {
+
+    @Mapping(target = "moreTarget", source = "moreSource")
+    @BeanMapping(ignoreByDefault = true)
+    void update(@MappingTarget Target target, Source source);
+}

testData/inspection/UnmappedTargetPropertiesWithBeanMappingIgnoreByDefault_after.java

@@ -0,0 +1,46 @@
+/*
+ * Copyright MapStruct Authors.
+ *
+ * Licensed under the Apache License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
+ */
+
+import org.mapstruct.BeanMapping;
+import org.mapstruct.Mapper;
+import org.mapstruct.Mapping;
+import org.mapstruct.MappingTarget;
+import org.example.data.UnmappedTargetPropertiesData.Target;
+import org.example.data.UnmappedTargetPropertiesData.Source;
+
+@Mapper
+interface SingleMappingMapper {
+
+    @Mapping(target = "moreTarget", source = "")
+    @Mapping(target = "moreTarget", ignore = true)
+    @Mapping(target = "testName", source = "name")
+    Target map(Source source);
+}
+
+@Mapper
+interface SingleMappingMapperWithIgnoreByDefault {
+
+    @Mapping(target = "testName", source = "name")
+    @BeanMapping(ignoreByDefault = true)
+    Target map(Source source);
+}
+
+@Mapper
+interface UpdateMapper {
+
+    @Mapping(target = "testName", source = "")
+    @Mapping(target = "testName", ignore = true)
+    @Mapping(target = "moreTarget", source = "moreSource")
+    void update(@MappingTarget Target target, Source source);
+}
+
+@Mapper
+interface UpdateMapperWithIgnoreByDefault {
+
+    @Mapping(target = "moreTarget", source = "moreSource")
+    @BeanMapping(ignoreByDefault = true)
+    void update(@MappingTarget Target target, Source source);
+}