#226: Reference only accessible qualified methods

Author: thunderhook

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

@@ -18,6 +18,7 @@
 import com.intellij.psi.PsiClass;
 import com.intellij.psi.PsiElement;
 import com.intellij.psi.PsiMethod;
+import com.intellij.psi.PsiModifier;
 import com.intellij.psi.PsiParameter;
 import com.intellij.psi.PsiReference;
 import com.intellij.psi.PsiType;
@@ -113,12 +114,41 @@ private Stream<PsiMethod> findAllNamedMethodsFromThisAndReferencedMappers(@NotNu
         Stream<PsiMethod> internalMethods = Stream.of( containingClass.getMethods() )
             .filter( MapstructUtil::isNamedMethod );
 
-        Stream<PsiMethod> externalMethods = findNamedMethodsInUsedMappers( containingClass );
+        Stream<PsiMethod> externalMethods = findNamedMethodsInUsedMappers( containingClass )
+            .filter( method -> methodIsAccessibleFrom( method, containingClass ) );
 
         return Stream.concat( internalMethods, externalMethods )
             .filter( this::methodHasReturnType );
     }
 
+    private boolean methodIsAccessibleFrom(PsiMethod method, PsiClass containingClass) {
+        PsiClass methodClass = method.getContainingClass();
+        if ( methodClass == null ) {
+            return false;
+        }
+
+        if ( method.hasModifierProperty( PsiModifier.PRIVATE ) ) {
+            return false;
+        }
+
+        if ( method.hasModifierProperty( PsiModifier.PUBLIC ) ) {
+            return true;
+        }
+
+        if ( method.hasModifierProperty( PsiModifier.PROTECTED ) ) {
+            return methodClass.equals( containingClass );
+        }
+
+        return haveSamePackage( containingClass, methodClass );
+    }
+
+    private boolean haveSamePackage(PsiClass firstClass, PsiClass secondClass) {
+        return Objects.equals(
+            StringUtil.getPackageName( Objects.requireNonNull( firstClass.getQualifiedName() ) ),
+            StringUtil.getPackageName( Objects.requireNonNull( secondClass.getQualifiedName() ) )
+        );
+    }
+
     @NotNull
     private Stream<PsiMethod> findNamedMethodsInUsedMappers(@Nullable PsiClass containingClass) {
 

src/test/java/org/mapstruct/intellij/completion/MappingQualifiedByNameCompletionTestCase.java

@@ -83,10 +83,59 @@ private void assertQualifiedByNameInsideMapperConfigAutoComplete() {
         assertThat( myItems )
             .extracting( LookupElementPresentation::renderElement )
             .usingRecursiveFieldByFieldElementComparator()
+            .describedAs( "methods of mappers from @MapperConfig(uses = ...)" )
             .containsOnly(
-                // methods of mappers from @MapperConfig(uses = ...)
                 createMethod( "unwrapOptional", "T", " OptionalMapper#unwrapOptional(Optional<T>)" )
             );
     }
 
+    public void testMappingQualifiedByNameWithAllPossibleVisibilities() {
+        configureByTestName();
+        assertAutoCompleteOfValidVisibilities();
+    }
+
+    private void assertAutoCompleteOfValidVisibilities() {
+
+        assertThat( myItems )
+            .extracting( LookupElement::getLookupString )
+            .containsExactlyInAnyOrder(
+                "internalModifierPackagePrivate",
+                "internalModifierPrivate",
+                "internalModifierProtected",
+                "internalModifierPublic",
+                "samePackageModifierPackagePrivate",
+                "samePackageModifierPublic",
+                "externalPackageModifierPublic"
+            );
+
+        assertThat( myItems )
+            .extracting( LookupElementPresentation::renderElement )
+            .usingRecursiveFieldByFieldElementComparator()
+            .containsExactlyInAnyOrder(
+                createMethod(
+                    "internalModifierPackagePrivate",
+                    "String",
+                    " CarMapper#internalModifierPackagePrivate(String)"
+                ),
+                createMethod( "internalModifierPrivate", "String", " CarMapper#internalModifierPrivate(String)" ),
+                createMethod( "internalModifierProtected", "String", " CarMapper#internalModifierProtected(String)" ),
+                createMethod( "internalModifierPublic", "String", " CarMapper#internalModifierPublic(String)" ),
+                createMethod(
+                    "samePackageModifierPackagePrivate",
+                    "String",
+                    " SamePackageMapper#samePackageModifierPackagePrivate(String)"
+                ),
+                createMethod(
+                    "samePackageModifierPublic",
+                    "String",
+                    " SamePackageMapper#samePackageModifierPublic(String)"
+                ),
+                createMethod(
+                    "externalPackageModifierPublic",
+                    "String",
+                    " ExternalMapper#externalPackageModifierPublic(String)"
+                )
+            );
+    }
+
 }

testData/completion/qualifiedbyname/MappingQualifiedByNameWithAllPossibleVisibilities.java

@@ -0,0 +1,42 @@
+/*
+ * Copyright MapStruct Authors.
+ *
+ * Licensed under the Apache License version 2.0, available at https://www.apache.org/licenses/LICENSE-2.0
+ */
+package org.mapstruct.ap.test.complex;
+
+import org.example.dto.Car;
+import org.example.dto.CarDto;
+import org.mapstruct.Mapper;
+import org.mapstruct.Mapping;
+import org.mapstruct.Named;
+import org.mapstruct.ap.test.complex.SamePackageMapper;
+import org.mapstruct.helper.qualifiedbyname.external.ExternalMapper;
+
+@Mapper(uses = { ExternalMapper.class, SamePackageMapper.class })
+public interface CarMapper {
+
+    @Mapping(target = "make", qualifiedByName = "<caret>")
+    CarDto carToCarDto(Car car);
+
+    @Named("internalModifierPackagePrivate")
+    String internalModifierPackagePrivate(String value) {
+        return "";
+    }
+
+    @Named("internalModifierPrivate")
+    private String internalModifierPrivate(String value) {
+        return "";
+    }
+
+    @Named("internalModifierProtected")
+    protected String internalModifierProtected(String value) {
+        return "";
+    }
+
+    @Named("internalModifierPublic")
+    public String internalModifierPublic(String value) {
+        return "";
+    }
+
+}

testData/completion/qualifiedbyname/mapper/ExternalMapper.java

@@ -0,0 +1,34 @@
+/*
+ * Copyright MapStruct Authors.
+ *
+ * Licensed under the Apache License version 2.0, available at https://www.apache.org/licenses/LICENSE-2.0
+ */
+package org.mapstruct.helper.qualifiedbyname.external;
+
+import org.mapstruct.Mapper;
+import org.mapstruct.Named;
+
+@Mapper
+public abstract class ExternalMapper {
+
+    @Named("externalPackageModifierPackagePrivate")
+    String externalPackageModifierPackagePrivate(String value) {
+        return "";
+    }
+
+    @Named("externalPackageModifierPrivate")
+    private String externalPackageModifierPrivate(String value) {
+        return "";
+    }
+
+    @Named("externalPackageModifierProtected")
+    protected String externalPackageModifierProtected(String value) {
+        return "";
+    }
+
+    @Named("externalPackageModifierPublic")
+    public String externalPackageModifierPublic(String value) {
+        return "";
+    }
+
+}

testData/completion/qualifiedbyname/mapper/SamePackageMapper.java

@@ -0,0 +1,34 @@
+/*
+ * Copyright MapStruct Authors.
+ *
+ * Licensed under the Apache License version 2.0, available at https://www.apache.org/licenses/LICENSE-2.0
+ */
+package org.mapstruct.ap.test.complex;
+
+import org.mapstruct.Mapper;
+import org.mapstruct.Named;
+
+@Mapper
+public abstract class SamePackageMapper {
+
+    @Named("samePackageModifierPackagePrivate")
+    String samePackageModifierPackagePrivate(String value) {
+        return "";
+    }
+
+    @Named("samePackageModifierPrivate")
+    private String samePackageModifierPrivate(String value) {
+        return "";
+    }
+
+    @Named("samePackageModifierProtected")
+    protected String samePackageModifierProtected(String value) {
+        return "";
+    }
+
+    @Named("samePackageModifierPublic")
+    public String samePackageModifierPublic(String value) {
+        return "";
+    }
+
+}