Skip to content

Add generics support #273

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

Open
maybetm wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add generics support #273

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion build.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ licenseFormat.dependsOn licenseFormatForKotlin
licenseTest.dependsOn licenseTestData

checkstyle {
toolVersion = '8.36.1'
toolVersion = '10.12.0'
Comment thread
hduelme marked this conversation as resolved.
config = resources.text.fromUri("https://raw.githubusercontent.com/mapstruct/mapstruct/master/build-config/src/main/resources/build-config/checkstyle.xml")
configProperties = [
'checkstyle.cache.file': layout.buildDirectory.get().asFile.toPath( ).resolve( 'checkstyle-cachefile').toString(),
Expand Down
5 changes: 5 additions & 0 deletions src/main/java/org/mapstruct/intellij/codeinsight/references/MapstructBaseReference.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,11 @@ public String getValue() {
return super.getValue();
}

@Nullable
public MapstructBaseReference getPrevious() {
return this.previous;
}

@Nullable
@Override
public final PsiElement resolve() {
Expand Down
38 changes: 25 additions & 13 deletions src/main/java/org/mapstruct/intellij/codeinsight/references/MapstructSourceReference.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
package org.mapstruct.intellij.codeinsight.references;

import java.util.Objects;
import java.util.Optional;
import java.util.stream.Stream;

import com.intellij.codeInsight.lookup.LookupElement;
Expand All @@ -23,6 +24,7 @@
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import org.mapstruct.intellij.util.MapstructUtil;
import org.mapstruct.intellij.util.SourceUtils;

import static org.mapstruct.intellij.util.MapstructUtil.asLookup;
import static org.mapstruct.intellij.util.MapstructUtil.findRecordComponent;
Expand Down Expand Up @@ -133,21 +135,31 @@ Object[] getVariantsInternal(@NotNull PsiMethod mappingMethod) {
@Override
PsiType resolvedType() {
PsiElement element = resolve();

if ( element instanceof PsiMethod psiMethod ) {
return psiMethod.getReturnType();
}
else if ( element instanceof PsiParameter psiParameter ) {
return psiParameter.getType();
}
else if ( element instanceof PsiRecordComponent psiRecordComponent ) {
return psiRecordComponent.getType();
}
else if ( element instanceof PsiField psiField ) {
return psiField.getType();
PsiType elementType = switch ( element ) {
case PsiMethod psiMethod -> psiMethod.getReturnType();
case PsiParameter psiParameter -> psiParameter.getType();
case PsiRecordComponent psiRecordComponent -> psiRecordComponent.getType();
case PsiField psiField -> psiField.getType();
case null, default -> null;
};

if ( elementType == null ) {
return null;
}

return null;
PsiType contextType = Optional.ofNullable( getPrevious() )
.map( MapstructBaseReference::resolvedType )
.or( () -> Optional.ofNullable( this.getMappingMethod() )
.map( MapstructUtil::getSourceParameters )
.filter( params -> params.length == 1 )
.map( psiParameters -> psiParameters[0] )
.map( SourceUtils::getParameterType )
)
.orElse( null );

Comment on lines +150 to +159

@hduelme hduelme Sep 25, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is this only supported for one source parameter?

@maybetm maybetm Sep 26, 2026

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, it's been so long, but I finally remembered why it was done this way🥹

  • getPrevious – if we have already selected a source type, then we get a PsiType. Otherwise, we get null, because typing has just started and no argument is chosen yet (in the multiple argument case);

  • then we fall back to the or block – if we have multiple arguments, then users need to select from the list, and we return null, so that the user can choose from the available parameters. See the example screenshot below.

image

Accordingly, if we have only one argument, then the user can immediately choose the fields of that object.
image

By the way, I personally prefer to always explicitly type the argument name. In this case, I will get "No suggestions", but this is the plugin's standard behavior, and it might be an open question for discussion – whether we should change it or not?(But not in this PR)
image

return PsiUtil.resolveGenericsClassInType( contextType )
.getSubstitutor()
.substitute( elementType );
}

/**
Expand Down
35 changes: 21 additions & 14 deletions src/main/java/org/mapstruct/intellij/codeinsight/references/MapstructTargetReference.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@

import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.stream.Stream;

import com.intellij.codeInsight.AnnotationUtil;
Expand All @@ -27,7 +28,6 @@
import com.intellij.psi.util.PsiUtil;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import org.mapstruct.Mapping;
import org.mapstruct.intellij.util.MapStructVersion;
import org.mapstruct.intellij.util.MapstructUtil;
import org.mapstruct.intellij.util.TargetType;
Expand Down Expand Up @@ -203,21 +203,28 @@ Object[] getVariantsInternal(@NotNull PsiMethod mappingMethod) {
@Override
PsiType resolvedType() {
PsiElement element = resolve();

if ( element instanceof PsiMethod psiMethod ) {
return firstParameterPsiType( psiMethod );
}
else if ( element instanceof PsiParameter psiParameter ) {
return psiParameter.getType();
}
else if ( element instanceof PsiRecordComponent psiRecordComponent ) {
return psiRecordComponent.getType();
}
else if ( element instanceof PsiField psiField ) {
return psiField.getType();
PsiType elementType = switch ( element ) {
case PsiMethod psiMethod -> firstParameterPsiType( psiMethod );
case PsiParameter psiParameter -> psiParameter.getType();
case PsiRecordComponent psiRecordComponent -> psiRecordComponent.getType();
case PsiField psiField -> psiField.getType();
case null, default -> null;
};

if ( elementType == null ) {
return null;
}

return null;
PsiType contextType = Optional.ofNullable( getPrevious() )
.map( MapstructBaseReference::resolvedType )
.or( () -> Optional.ofNullable( getMappingMethod() )
.map( TargetUtils::getRelevantType )
)
.orElse( null );

return PsiUtil.resolveGenericsClassInType( contextType )
.getSubstitutor()
.substitute( elementType );
}

/**
Expand Down
9 changes: 7 additions & 2 deletions src/test/java/org/mapstruct/intellij/MapstructBaseCompletionTestCase.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@

import com.intellij.codeInsight.completion.LightFixtureCompletionTestCase;
import com.intellij.openapi.util.text.StringUtil;
import com.intellij.openapi.vfs.newvfs.impl.VfsRootAccess;
import com.intellij.testFramework.LightProjectDescriptor;
import com.intellij.testFramework.PsiTestUtil;
import com.intellij.util.PathUtil;
Expand All @@ -29,7 +28,13 @@ protected void setUp() throws Exception {
super.setUp();
final String mapstructLibPath = PathUtil.toSystemIndependentName( new File( BUILD_LIBS_DIRECTORY )
.getAbsolutePath() );
VfsRootAccess.allowRootAccess( getTestRootDisposable(), mapstructLibPath );

allowAccessToDirsIfExists(
BUILD_LIBS_DIRECTORY,
"testData",
"build/test-libs"
);

Comment thread
hduelme marked this conversation as resolved.
PsiTestUtil.addLibrary(
myFixture.getProjectDisposable(),
myFixture.getModule(),
Expand Down
109 changes: 109 additions & 0 deletions src/test/java/org/mapstruct/intellij/MapstructCompletionTestCase.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -488,6 +488,115 @@ public void testFluentGenericTargetMapper() {
);
}

public void testGenericCarWrapperSourceAutoCompleteAfterCar() {
configureByTestName();

assertThat( myItems )
.extracting( LookupElement::getLookupString )
.containsExactlyInAnyOrder(
"winCode"
);

assertThat( myItems )
.extracting( LookupElementPresentation::renderElement )
.usingRecursiveFieldByFieldElementComparator()
.containsExactlyInAnyOrder(
createVariable( "winCode", "String" )
);
}

public void testGenericCarWrapperTargetAutoCompleteAfterCar() {
configureByTestName();

assertThat( myItems )
.extracting( LookupElement::getLookupString )
.containsExactlyInAnyOrder( "winCode" );

assertThat( myItems )
.extracting( LookupElementPresentation::renderElement )
.usingRecursiveFieldByFieldElementComparator()
.containsExactlyInAnyOrder( createVariable( "winCode", "String" ) );
}

public void testGenericCarWrapperSourceAutoCompleteAfterCarWithoutParameterPrefix() {
configureByTestName();

assertThat( myItems )
.extracting( LookupElement::getLookupString )
.containsExactlyInAnyOrder( "winCode" );

assertThat( myItems )
.extracting( LookupElementPresentation::renderElement )
.usingRecursiveFieldByFieldElementComparator()
.containsExactlyInAnyOrder( createVariable( "winCode", "String" ) );
}

public void testGenericConstructorCarMapper() {
configureByTestName();

assertThat( myItems )
.extracting( LookupElement::getLookupString )
.containsExactlyInAnyOrder( "winCode" );

assertThat( myItems )
.extracting( LookupElementPresentation::renderElement )
.usingRecursiveFieldByFieldElementComparator()
.containsExactlyInAnyOrder( createVariable( "winCode", "String" ) );
}

public void testGenericRecordConstructorTargetMapper() {
configureByTestName();

assertThat( myItems )
.extracting( LookupElement::getLookupString )
.containsExactlyInAnyOrder( "winCode" );

assertThat( myItems )
.extracting( LookupElementPresentation::renderElement )
.usingRecursiveFieldByFieldElementComparator()
.usingElementComparatorIgnoringFields( "myIcon", "myTail" )
.containsExactlyInAnyOrder( createParameter( "winCode", "String" ) );
}

public void testGenericConstructorMappingTargetUpdateMapper() {
configureByTestName();

assertThat( myItems )
.extracting( LookupElement::getLookupString )
.containsExactlyInAnyOrder( "winCode" );

assertThat( myItems )
.extracting( LookupElementPresentation::renderElement )
.usingRecursiveFieldByFieldElementComparator()
.containsExactlyInAnyOrder( createVariable( "winCode", "String" ) );
}

public void testGenericTwoTypeParamsConstructorTargetMapper() {
configureByTestName();

assertThat( myItems )
.extracting( LookupElement::getLookupString )
.containsExactlyInAnyOrder( "serial" );

assertThat( myItems )
.extracting( LookupElementPresentation::renderElement )
.usingRecursiveFieldByFieldElementComparator()
.containsExactlyInAnyOrder( createVariable( "serial", "String" ) );
}

public void testGenericNestedGenericTargetMapper() {
configureByTestName();

assertThat( myItems )
.extracting( LookupElement::getLookupString )
.containsExactlyInAnyOrder( "winCode" );

assertThat( myItems )
.extracting( LookupElementPresentation::renderElement )
.usingRecursiveFieldByFieldElementComparator()
.containsExactlyInAnyOrder( createVariable( "winCode", "String" ) );
}

public void testVariantsCarMapperNoSourceClass() {
myFixture.configureByFile( "CarMapperNoSourceClass.java" );
complete();
Expand Down
56 changes: 56 additions & 0 deletions testData/mapping/GenericCarWrapperSourceAutoCompleteAfterCar.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
/*
* 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.Mapping;

@Mapper
public interface GenericCarWrapperMapper {

@Mapping(target = "id", source = "wrapper.car.<caret>winCode")
CarEntity toCarDto(CarWrapper<Car> wrapper);
}

class CarEntity {

private String id;

public String getId() {
return id;
}

public void setId(String id) {
this.id = id;
}

}

class Car {

private String winCode;

public String getWinCode() {
return winCode;
}

public void setWinCode(String winCode) {
this.winCode = winCode;
}
}

class CarWrapper<T> {

private T car;

public T getCar() {
return car;
}

public void setCar(T car) {
this.car = car;
}
}
45 changes: 45 additions & 0 deletions testData/mapping/GenericCarWrapperSourceAutoCompleteAfterCarWithoutParameterPrefix.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
/*
* 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.Mapping;

@Mapper
public interface GenericCarWrapperSourceAutoCompleteAfterCarWithoutParameterPrefix {
@Mapping(target = "id", source = "car.<caret>winCode")
CarEntity toCarDto(CarWrapper<Car> wrapper);
}

class CarEntity {
private String id;
public String getId() {
return id;
}
public void setId(String id) {
this.id = id;
}
}

class Car {
private String winCode;
public String getWinCode() {
return winCode;
}
public void setWinCode(String winCode) {
this.winCode = winCode;
}
}

class CarWrapper<T> {
private T car;
public T getCar() {
return car;
}
public void setCar(T car) {
this.car = car;
}
}
Loading