Show Git @author as mining for Java method and class

See original issue at https://bugs.eclipse.org/bugs/show_bug.cgi?id=532803

Here a demo :

@vogella, @mickaelistria please give me feedback. Thanks!

When preferences are changed the minings are not updated, only when the text is reconciled again.

Steps to reproduce:

• Open a Java file
• Open Code Mining preferences
• Enable or disable something
• Press Apply
  => Expected: The minings appear or disappear

When I double-click on a parameter name or the parameter itself, the selection is set incorrectly.
It seems that the parameter name codemining is overlapping with the parameter itself by one character:

I also changed the background color with an org.eclipse.swt.custom.LineBackgroundListener for the attached screenshot.

This may already be possible, if that is the case, please close.

It would be nice to register a popup menu on a code mining. For example, this could allow to jump to the preference to configure the code mining or to select that a test should run as PDE test.

If I add a new method the code mining are wrong:

E.g., open org.eclipse.core.commands.AbstractHandler in source and add a new execute method overriding the Interface method.

It would be nice to have line numbers and collapse/expand icons aligned with the "real code", so the user can immediately understand where is "real code", and where is "meta-information" looking at the ruler on the left side.

Currently, the line number and the collapse/expand icon are vertically aligned in the middle of the area contanining both code and meta-annotation.

If I only activate code mining for debugging they are not shown.

See screenshot.

Tested with Eclipse SDK
Version: Photon (4.8)
Build id: I20180322-0645
OS: Linux, v.4.13.0-36-generic, x86_64 / gtk 3.22.25, WebKit 2.18.6

As one can see the first letter/char after the label is strangely aligned (the d of dir after the directory:-label and the t of true after the create:-label)

Eclipse: Eclipse Photon 4.8.0, Build id: 20180619-1200
OS: Windows 10
JDT CodeMining: 1.0.0.201806221018

Here the current result:

@vogella please give me feedback. Thanks!

Error:
Cannot complete the install because one or more required items could not be found.
Software being installed: JDT CodeMining 1.0.0.201806221018 (jdt-codemining-feature.feature.group 1.0.0.201806221018)
Missing requirement: Egit CodeMining 1.0.0.201806221018 (org.eclipse.egit.codemining 1.0.0.201806221018) requires 'osgi.bundle; org.eclipse.egit.core 0.0.0' but it could not be found
Cannot satisfy dependency:
From: JDT CodeMining 1.0.0.201806221018 (jdt-codemining-feature.feature.group 1.0.0.201806221018)
To: org.eclipse.equinox.p2.iu; org.eclipse.egit.codemining [1.0.0.201806221018,1.0.0.201806221018]

I'd like to have a possiblity to restrict "Show method parameter names" in a way that the names are only displayed on primitives (boolean,int,long...) and strings.

I think mostly by passing complex objects one can derive their meaning from the type.
Assume the following editor-view:

File dir = new File(pathname: "/tmp/test/");
doSomething(directory: dir, create: true);

The "directory:" parameter-name does not provide any useful additional information but uses a lot of space.
With the suggested feature enabled it would look like:

File dir = new File(pathname: "/tmp/test/");
doSomething(dir, create: true);

The mouse pointer seems to react delayed. I need to position the mouse and wait a while before the mouse pointer changes. This is irritating and prevents me from moving and clicking immediately.

I captured this screenshot during a debug session. Without executing any particular command, the editor split in two. I was just in the middle of a debug session, and I edited the code under debug.
(The below screenshot is not what happens when you open a split editor)

On the opposite, this screenshot shows what happens when you open a split editor. The split editor seems not working. (tested via Window > Editor > Vertical Split Editor)

Attached, you can see the stack trace for the reproducible issue: when you open a split editor.

split-editor-stack-trace.txt

IMHO it would be really nice to have the option to draw the opening statement of closing curley brackets:

For example:

if (parent != null) {
//lots of code here
} (-> draw this via code mining) //if (parent != null) {

Show variable values inline while debugging. See https://bugs.eclipse.org/bugs/show_bug.cgi?id=507546

@vogella I'm working on this issue and it starts working, but there is again several bugs. Please play with it and give me feedback. Thanks!

If I have a merge conflict adding coding mining about the authors would be nice.

<<<<<< HEAD
-Stacy
-Alexander

Marketing team

• Collins
• Linda
• Patricia
• Morgan
• Amanda
  =======

master

If code mining are active, I cannot select the first letter of the work via the mouse. See screencast.

I think it would be nice to allow to hide 0 reference. I think it would also make a good default to only show the reference is there is one.

During my Eclipse RCP training sessions I'm using typically a very small resolution, e.g., 1024 x 768
Code mining annotations are not drawn correctly, see screenshot.

I'm using Eclipse SDK
Version: Photon (4.8)
Build id: I20180513-2000
OS: Linux, v.4.15.0-20-generic, x86_64 / gtk 3.22.30, WebKit 2.20.2
and JDT CodeMining 1.0.0.201805120953
To test, create the following test classes and activate code minining.

package com.example.e4.rcp.todo;

import javax.annotation.PostConstruct;

import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Composite;

import com.example.e4.rcp.todo.model.ITodoService;


public class TodoOverviewPart {

	@PostConstruct
	public void name(Composite parent, ITodoService todoService) {
		parent.setLayout(new GridLayout(1, false));
		int i = 0;
		i++;
		LabelAndText.create(parent).setTextForLabel("Hello").setTextForText("This is a text");
		LabelAndText.create(parent).setTextForLabel("Hello").setTextForText("This is a text");
		LabelAndText.create(parent).setTextForLabel("Hello").setTextForText("This is a text");
		LabelAndText.create(parent).setTextForLabel("Hello").setTextForText("This is a text");
		LabelAndText.create(parent).setTextForLabel("Hello").setTextForText("This is a text");
		LabelAndText.create(parent).setTextForLabel("Hello").setTextForText("This is a text");

	}

}

package com.example.e4.rcp.todo;

import org.eclipse.swt.SWT;
import org.eclipse.swt.layout.GridData;
import org.eclipse.swt.layout.GridLayout;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.swt.widgets.Label;
import org.eclipse.swt.widgets.Text;

public class LabelAndText extends Composite {

	private Label label;
	private Text text;

	private LabelAndText(Composite parent, int style) {
		super(parent, style);
		GridLayout gridLayout = new GridLayout(2, true);
		gridLayout.marginWidth = 5;
		gridLayout.marginHeight = 5;
		gridLayout.verticalSpacing = 0;
		gridLayout.horizontalSpacing = 0;
		this.setLayout(gridLayout);

		label = new Label(this, SWT.NONE);
		label.setLayoutData(new GridData(SWT.BEGINNING, SWT.CENTER, false, false));

		text = new Text(this, SWT.SINGLE | SWT.LEAD | SWT.BORDER);
		text.setLayoutData(new GridData(SWT.FILL, SWT.CENTER, true, false));
	}

	public static LabelAndText create(Composite parent, int style) {
		return new LabelAndText(parent, style);
	}

	public static LabelAndText create(Composite parent) {
		return new LabelAndText(parent, SWT.NONE);
	}

	public LabelAndText setTextForLabel(String labelText) {
		label.setText(labelText);
		GridData gridData = new GridData(SWT.NONE, SWT.FILL, true, true);
		return this;
	}

	public LabelAndText setTextForText(String textText) {
		text.setText(textText);
		return this;
	}
}

Using latest and greatest code mininig I still have to close the editor to see the end brackets
JDT CodeMining 1.0.0.201805161036 jdt-codemining-feature.feature.group Angelo ZERR

Example editor after activating the setting.

If I close and re-open I see the code mininig

Junit Jupiter (Junit 5) supports methods with out access modifier or default access modifier scope (same package).

looks like the Access Specifier for junit 5 test should be public for code mining to show Run|Debug options.

Working:

Not Wortking:

Junit 5 allows to write unit tests with out access specifier.

By showing the Run | Debug on the same line next to @test would reduce the line hence reducing the chance for performance issues with large test files.

See Screenshot, no Run for the class.

I think a bit more empty space before the debugging info would be helpful. Compare currently Eclipse with IntelliJ and IntelliJ looks better.

https://www.jetbrains.com/help/idea/inline-debugging.html

The no command code minining information looks wrong also the empty underline.

During the fix of Bug 533156, I noticed that the type for varargs is shown as array.

See animated Gif.

Show run/debug mining for main method

I love this plugin! (starred now)

But I think I would like to have the option to only see the parameter names for the line the cursor is currently placed in (or maybe also the surrounding lines, if a method call spans multiple lines).

Adding a sample project for testing.
https://github.com/Ravisankar-Challa/meecrowave_test/blob/master/src/main/java/meecrowave/model/MiscellaneousInfo.java

Note: Lombok needs to be configured in the eclipse ide
https://projectlombok.org/downloads/lombok.jar
place the lombok file in the same folder of eclipse.exe file and update the eclipse.ini file

-vmargs
-javaagent:lombok.jar
-Dosgi.requiredJavaVersion=1.8

I think the current JDT icons are not very nice. I suggest that code mining uses better icons. See https://bugs.eclipse.org/bugs/show_bug.cgi?id=534165 for the reported issue with JDT For example Gradles uses really nice ones.

If @angelozerr agrees to better icons I can try to find time to provide a PR for replacing the icons.

I tried to test your plugin today with Photon M6 and it did not work at all. Not sure what the cause is, but I have found the following exception in the workspace logs:

java.lang.NullPointerException
at org.eclipse.jdt.junit.codemining.JUnitCodeMiningProvider$CodeMiningTestRunListener.sessionFinished(JUnitCodeMiningProvider.java:59)
at org.eclipse.jdt.internal.junit.model.TestRunListenerAdapter.fireSessionFinished(TestRunListenerAdapter.java:45)
at org.eclipse.jdt.internal.junit.model.TestRunListenerAdapter.sessionEnded(TestRunListenerAdapter.java:69)
at org.eclipse.jdt.internal.junit.model.TestRunSession$TestSessionNotifier.testRunEnded(TestRunSession.java:656)
at org.eclipse.jdt.internal.junit.model.RemoteTestRunnerClient$3.run(RemoteTestRunnerClient.java:516)
at org.eclipse.core.runtime.SafeRunner.run(SafeRunner.java:42)
at org.eclipse.jdt.internal.junit.model.RemoteTestRunnerClient.testRunEnded(RemoteTestRunnerClient.java:513)
at org.eclipse.jdt.internal.junit.model.RemoteTestRunnerClient.access$9(RemoteTestRunnerClient.java:508)
at org.eclipse.jdt.internal.junit.model.RemoteTestRunnerClient$DefaultProcessingState.readMessage(RemoteTestRunnerClient.java:106)
at org.eclipse.jdt.internal.junit.model.RemoteTestRunnerClient.receiveMessage(RemoteTestRunnerClient.java:381)
at org.eclipse.jdt.internal.junit.model.RemoteTestRunnerClient.access$27(RemoteTestRunnerClient.java:380)
at org.eclipse.jdt.internal.junit.model.RemoteTestRunnerClient$ServerConnection.run(RemoteTestRunnerClient.java:278)

Maybe it helps you in fixing some issues.

Junit Jupiter(Junit 5) @test annotation is moved to a new package org.junit.jupiter.api.Test. Code mining should be able to handle new Junit 5 @test annotation

When I startup Eclipse, or after setting the preferences to enable codemining, I see strange overlappings in the text, as you can see in the left of the attached image. The issue is fixed after clicking on the TextArea. (I obseved this behavior on Mac)

Is this something we should fix on jdt.codemining or in eclipse.text ?

IJ supports this feature. Here IJ editor (see last print which have no parameter name lens):

@vogella I think it's a cool feature. Do you think we need a preferences for that?

If I press "Run" I cannot select to run a plug-in JUnit test.

Not sure how this can be better handled.

Sometimes when browsing through the code it would be good to disable the code mining temporarily.
Having toolbar button e.g. next to 'Toggle Breadcrumb' buttonto quickly switch it on and off would be a realy nice feature.

I'm not 100 % sure here but I think the code mining annotations should show the last changed date of the whole method and the last changer. AFAICS it currently shows the author and date of the change for the method signature which is less useful to me.

If I refactor the method name of a test method, I see a strange drawing artifact, see screenshot.

If I have code mining active and refactor a method in a longer class the scroll position jumps. I have not seen that without code mining active.

Do you also see that? See animated gif.

Show Git number of authors as mining for Java method and class

The currently used color for inline debugging information (yellow) is too strong. I suggest using the same color as for the other code mininings (light gray I think it is).

It would be great if I could also see the names and types for constructor calls:

GridData gridData = new GridData(SWT.NONE, SWT.FILL, true, true);	

Closing statement annotation is wrong if brackets are missing.

Example:

In org.eclipse.ui.texteditor.MarkerRulerAction#markersUserEditable

private boolean markersUserEditable(List<IMarker> markers) {
		Iterator<IMarker> iter= markers.iterator();
		while (iter.hasNext()) {
			if (!isUserEditable(iter.next()))
				return false;
		}
		return true;
	}

For the if statement close comment I see:

\\ if (!isUserEditable(iter.next())) return false;

It should be

\\ if (!isUserEditable(iter.next()))

I had an editor open and activated the preferences.

After apply and close the code minining annotations are not shown.

If I close and reopen the editor they are shown.

I would expect to see them after I press "Apply and Close" in the preferences.

The end statement is rendered slightly below the line which contains the end statement. The problem gets more visible if you increase the font size.