bug: bug in comment association and pretty-printing

[tempuser1909]

Hi, I am not sure if this is a bug for printing the source code with the comments.

Original:

public final class test{

    
// ------------------------------------ //
// test / test test     //
// ------------------------------------ //

    /**
     * test2
     *
     */   
    public interface testInterface {
        /**
         * test3
         * 
         */
        public void mytest(short a, short b);
    }
    private static class myInterface implements testInterface {
        public void mytest(short a, short b){
            
        }
    }
    
}//end class test

Pretty-printed by Spoon Launcher:

public final class test {
    // ------------------------------------ //
    public interface testInterface {
        // test / test test     //
        // ------------------------------------ //
        /**
         * test2
         */
        /**
         * test3
         */
        public void mytest(short a, short b);
    }

    private static class myInterface implements test.testInterface {
        public void mytest(short a, short b) {
        }
    }
}

So the problem is:

1. the test comment is printed inside of the interface class instead of being outside
2. the comment that marks the end of the class is gone

[pvojtechovsky]

It is a bug in JDTCommentBuilder which assigns comments and AST nodes together. it looks like it assigns correctly only first single line comment. Next are assigned wrong.

[tempuser1909]

I checked via the GUI mode too.

It seems that the "end class" comment is detected but not printed.

And the two comments that were printed wrongly inside the interface class were detected wrongly as part of the method that is within the interface class.

[pvojtechovsky]

@tempuser1909 could you make a pull request with failing test? It is then much easier/faster to fix the problem.

[tempuser1909]

@pvojtechovsky, sorry, I do not understand what do you mean by a pull request with failing test.

Do you mean to include a unit test for this with a pull request?

Is it under src/test/java/spoon/test/comment/CommentTest.java

[pvojtechovsky]

Do you mean to include a unit test for this with a pull request?

yes

Is it under src/test/java/spoon/test/comment/CommentTest.java

yes 👍

[tempuser1909]

Sorry for the late pull request. This is my first time writing a unit test.

Please let me know if writing a more specific unit test is required. I just compared the original file with the prettyprint-ed file.

[monperrus]

closed by #2636

Thanks a lot @tempuser1909 for the bug report and the failing test case!

[rihou]

The comments in the lambda expression are reported to have errors.

An example code:

import java.util.Arrays;
import java.util.List;
import java.util.stream.Collectors;

public class CommentInLambdaExpressionTest {

public static void main(String[] args) {
	CommentInLambdaExpressionTest test = new CommentInLambdaExpressionTest();
	List<Integer> lst = test.setup();
	System.out.println(lst);
}

public List<Integer> setup() {
	List<Integer> messages = Arrays.asList(1, 2, 3, 4, 5, 6, 7, 8, 9, 10);
	return messages.stream().filter( num -> 
	// comment in lambda expression
	num > 5
	).collect(Collectors.toList());
}

}
The code triggers the error:
2018-11-08 10:11:15,847 ERROR spoon.support.compiler.jdt.JDTCommentBuilder - "// comment in lambda expression" cannot be added into the AST, with parent class spoon.support.reflect.code.CtLambdaImplplease report the bug by posting on #2482