Add an enum for the known MapStruct versions to simplify different configuration options

Author: filiphr

src/main/java/org/mapstruct/intellij/codeinsight/references/MapstructTargetReference.java

@@ -24,6 +24,7 @@
 import com.intellij.psi.util.PsiUtil;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
+import org.mapstruct.intellij.util.MapStructVersion;
 import org.mapstruct.intellij.util.MapstructUtil;
 
 import static org.mapstruct.intellij.util.MapstructUtil.asLookup;
@@ -39,7 +40,7 @@
  */
 class MapstructTargetReference extends MapstructBaseReference {
 
-    private final boolean builderSupportPresent;
+    private final MapStructVersion mapStructVersion;
 
     /**
      * Create a new {@link MapstructTargetReference} with the provided parameters
@@ -51,12 +52,13 @@ class MapstructTargetReference extends MapstructBaseReference {
     private MapstructTargetReference(PsiLiteral element, MapstructTargetReference previousReference,
         TextRange rangeInElement) {
         super( element, previousReference, rangeInElement );
-        builderSupportPresent = MapstructUtil.isMapStructBuilderSupportPresent( element.getContainingFile()
+        mapStructVersion = MapstructUtil.resolveMapStructProjectVersion( element.getContainingFile()
             .getOriginalFile() );
     }
 
     @Override
     PsiElement resolveInternal(@NotNull String value, @NotNull PsiType psiType) {
+        boolean builderSupportPresent = mapStructVersion.isBuilderSupported();
         Pair<PsiClass, PsiType> pair = resolveBuilderOrSelfClass( psiType, builderSupportPresent );
         if ( pair == null ) {
             return null;
@@ -113,7 +115,7 @@ PsiElement resolveInternal(@NotNull String value, @NotNull PsiMethod mappingMeth
     @Override
     Object[] getVariantsInternal(@NotNull PsiType psiType) {
         return asLookup(
-            publicWriteAccessors( psiType, builderSupportPresent ),
+            publicWriteAccessors( psiType, mapStructVersion ),
             MapstructTargetReference::memberPsiType
         );
     }

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

@@ -33,6 +33,7 @@
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 import org.mapstruct.intellij.MapStructBundle;
+import org.mapstruct.intellij.util.MapStructVersion;
 import org.mapstruct.intellij.util.MapstructUtil;
 import org.mapstruct.intellij.util.TargetUtils;
 
@@ -52,16 +53,16 @@ public class UnmappedTargetPropertiesInspection extends InspectionBase {
     @NotNull
     @Override
     PsiElementVisitor buildVisitorInternal(@NotNull ProblemsHolder holder, boolean isOnTheFly) {
-        return new MyJavaElementVisitor( holder, MapstructUtil.isMapStructBuilderSupportPresent( holder.getFile() ) );
+        return new MyJavaElementVisitor( holder, MapstructUtil.resolveMapStructProjectVersion( holder.getFile() ) );
     }
 
     private static class MyJavaElementVisitor extends JavaElementVisitor {
         private final ProblemsHolder holder;
-        private final boolean builderSupportPresent;
+        private final MapStructVersion mapStructVersion;
 
-        private MyJavaElementVisitor(ProblemsHolder holder, boolean builderSupportPresent) {
+        private MyJavaElementVisitor(ProblemsHolder holder, MapStructVersion mapStructVersion) {
             this.holder = holder;
-            this.builderSupportPresent = builderSupportPresent;
+            this.mapStructVersion = mapStructVersion;
         }
 
         @Override
@@ -73,7 +74,7 @@ public void visitMethod(PsiMethod method) {
                 return;
             }
 
-            Set<String> allTargetProperties = findAllTargetProperties( targetType, builderSupportPresent );
+            Set<String> allTargetProperties = findAllTargetProperties( targetType, mapStructVersion );
 
             // find and remove all defined mapping targets
             Set<String> definedTargets = TargetUtils.findAllDefinedMappingTargets( method )

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

@@ -0,0 +1,32 @@
+/*
+ * 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.util;
+
+/**
+ * @author Filip Hrisafov
+ */
+public enum MapStructVersion {
+
+    V1_2_O( false, false ),
+    V1_3_O( true, false ),
+    V1_4_O( true, true );
+
+    private final boolean builderSupported;
+    private final boolean constructorSupported;
+
+    MapStructVersion(boolean builderSupported, boolean constructorSupported) {
+        this.builderSupported = builderSupported;
+        this.constructorSupported = constructorSupported;
+    }
+
+    public boolean isBuilderSupported() {
+        return builderSupported;
+    }
+
+    public boolean isConstructorSupported() {
+        return constructorSupported;
+    }
+}

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

@@ -86,6 +86,7 @@ public final class MapstructUtil {
     private static final String CONTEXT_ANNOTATION_FQN = "org.mapstruct.Context";
     private static final String INHERIT_INVERSE_CONFIGURATION = InheritInverseConfiguration.class.getName();
     private static final String BUILDER_ANNOTATION_FQN = "org.mapstruct.Builder";
+    private static final String ENUM_MAPPING_ANNOTATION_FQN = "org.mapstruct.EnumMapping";
 
     /**
      * Hide constructor.
@@ -457,22 +458,30 @@ private static boolean isMapStructPresent(@NotNull Module module) {
     }
 
     /**
-     * Checks if MapStruct 1.3.0 is within the module of the provided psi file.
-     *
+     * Resolve the MapStruct project version with the module of the provided psi file
      * @param psiFile that needs to be checked
-     *
-     * @return {@code true} if MapStruct is present within the {@code psiFIle}, {@code false} otherwise
+     * @return the MapStruct project version
      */
-    public static boolean isMapStructBuilderSupportPresent(@NotNull PsiFile psiFile) {
+    public static MapStructVersion resolveMapStructProjectVersion(@NotNull PsiFile psiFile) {
         Module module = ModuleUtilCore.findModuleForFile( psiFile.getVirtualFile(), psiFile.getProject() );
         if ( module == null ) {
-            return false;
+            return MapStructVersion.V1_2_O;
         }
         return CachedValuesManager.getManager( module.getProject() ).getCachedValue( module, () -> {
-            boolean foundMarkerClass = JavaPsiFacade.getInstance( module.getProject() )
-                .findClass( BUILDER_ANNOTATION_FQN, module.getModuleRuntimeScope( false ) ) != null;
+            MapStructVersion mapStructVersion;
+            if ( JavaPsiFacade.getInstance( module.getProject() )
+                .findClass( ENUM_MAPPING_ANNOTATION_FQN, module.getModuleRuntimeScope( false ) ) != null ) {
+                mapStructVersion = MapStructVersion.V1_4_O;
+            }
+            else if ( JavaPsiFacade.getInstance( module.getProject() )
+                .findClass( BUILDER_ANNOTATION_FQN, module.getModuleRuntimeScope( false ) ) != null ) {
+                mapStructVersion = MapStructVersion.V1_3_O;
+            }
+            else {
+                mapStructVersion = MapStructVersion.V1_2_O;
+            }
             return CachedValueProvider.Result.createSingleDependency(
-                foundMarkerClass,
+                mapStructVersion,
                 ProjectRootManager.getInstance( module.getProject() )
             );
         } );

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

@@ -80,11 +80,13 @@ public static PsiType getRelevantType(@NotNull PsiMethod mappingMethod) {
      * with their psi substitutors from the given {@code psiType}
      *
      * @param psiType to use to extract the accessors
+     * @param mapStructVersion the MapStruct project version
      *
      * @return a stream that holds all public write accessors for the given {@code psiType}
      */
     public static Map<String, Pair<? extends PsiMember, PsiSubstitutor>> publicWriteAccessors(@NotNull PsiType psiType,
-        boolean builderSupportPresent) {
+        MapStructVersion mapStructVersion) {
+        boolean builderSupportPresent = mapStructVersion.isBuilderSupported();
         Pair<PsiClass, PsiType> classAndType = resolveBuilderOrSelfClass( psiType, builderSupportPresent );
         if ( classAndType == null ) {
             return Collections.emptyMap();
@@ -106,7 +108,7 @@ public static Map<String, Pair<? extends PsiMember, PsiSubstitutor>> publicWrite
      *
      * @param psiClass to use to extract the setters
      * @param typeToUse the type in which the methods are located (needed for fluent setters)
-     * @param builderSupportPresent whether MapStruct (1.3) with builder suppot is present
+     * @param builderSupportPresent whether MapStruct (1.3) with builder support is present
      *
      * @return a stream that holds all public setters for the given {@code psiType}
      */
@@ -290,11 +292,11 @@ private static boolean isMappingAnnotation(PsiAnnotation psiAnnotation) {
      * Find all target properties from the {@code targetClass} that can be used for mapping
      *
      * @param targetType that needs to be used
-     * @param builderSupportPresent whether MapStruct (1.3) with builder support is present
+     * @param mapStructVersion the MapStruct project version
      *
      * @return all target properties for the given {@code targetClass}
      */
-    public static Set<String> findAllTargetProperties(@NotNull PsiType targetType, boolean builderSupportPresent) {
-        return publicWriteAccessors( targetType, builderSupportPresent ).keySet();
+    public static Set<String> findAllTargetProperties(@NotNull PsiType targetType, MapStructVersion mapStructVersion) {
+        return publicWriteAccessors( targetType, mapStructVersion ).keySet();
     }
 }