added location information to class-level stereotype nodes

Author: martinlippert

headless-services/spring-boot-language-server/src/main/java/org/springframework/ide/vscode/boot/java/commands/ToolsJsonNodeHandler.java

@@ -23,8 +23,6 @@
 import java.util.function.BiConsumer;
 import java.util.function.Consumer;
 
-import org.eclipse.lsp4j.Location;
-import org.eclipse.lsp4j.Range;
 import org.jmolecules.stereotype.api.Stereotype;
 import org.jmolecules.stereotype.tooling.LabelProvider;
 import org.jmolecules.stereotype.tooling.MethodNodeContext;
@@ -41,7 +39,7 @@
  * @author Oliver Drotbohm
  * @author Martin Lippert
  */
-class ToolsJsonNodeHandler implements NodeHandler<StereotypePackageElement, StereotypePackageElement, StereotypeClassElement, StereotypeMethodElement, Object> {
+public class ToolsJsonNodeHandler implements NodeHandler<StereotypePackageElement, StereotypePackageElement, StereotypeClassElement, StereotypeMethodElement, Object> {
 
 	public static final String ICON = "icon";
 	public static final String TEXT = "text";
@@ -58,21 +56,13 @@ public ToolsJsonNodeHandler(LabelProvider<StereotypePackageElement, StereotypePa
 		this.current = root;
 	}
 
-	/*
-	 * (non-Javadoc)
-	 * @see org.jmolecules.stereotype.tooling.NodeHandler#handleApplication(java.lang.Object)
-	 */
 	@Override
 	public void handleApplication(StereotypePackageElement application) {
 		this.root
 			.withAttribute(TEXT, labels.getApplicationLabel(application))
 			.withAttribute(ICON, "fa-application");
 	}
 
-	/*
-	 * (non-Javadoc)
-	 * @see org.jmolecules.stereotype.tooling.NodeHandler#handlePackage(java.lang.Object, org.jmolecules.stereotype.tooling.NodeContext)
-	 */
 	@Override
 	public void handlePackage(StereotypePackageElement pkg, NodeContext context) {
 
@@ -81,55 +71,35 @@ public void handlePackage(StereotypePackageElement pkg, NodeContext context) {
 				.withAttribute(TEXT, labels.getPackageLabel(pkg)));
 	}
 
-	/*
-	 * (non-Javadoc)
-	 * @see org.jmolecules.stereotype.tooling.NodeHandler#handleStereotype(org.jmolecules.stereotype.api.Stereotype, org.jmolecules.stereotype.tooling.NestingLevel)
-	 */
 	@Override
 	public void handleStereotype(Stereotype stereotype, NodeContext context) {
 
 		addChild(node -> node.withAttribute(ICON, "fa-stereotype")
 				.withAttribute(TEXT, labels.getSterotypeLabel(stereotype)));
 	}
 
-	/*
-	 * (non-Javadoc)
-	 * @see org.jmolecules.stereotype.tooling.NodeHandler#handleType(java.lang.Object, org.jmolecules.stereotype.tooling.NestingLevel)
-	 */
 	@Override
 	public void handleType(StereotypeClassElement type, NodeContext context) {
 		addChild(node -> node
 			.withAttribute(TEXT, labels.getTypeLabel(type))
-			.withAttribute("location", new Location("sampleUri", new Range()))
+			.withAttribute("location", type.getLocation())
 		);
 	}
 
 	public Node createNested() {
 		return new Node(this.current);
 	}
 
-	/*
-	 * (non-Javadoc)
-	 * @see org.jmolecules.stereotype.tooling.NodeHandler#handleMethod(java.lang.Object, org.jmolecules.stereotype.tooling.NestingLevel, boolean)
-	 */
 	@Override
 	public void handleMethod(StereotypeMethodElement method, MethodNodeContext<StereotypeClassElement> context) {
 		addChildFoo(node -> node.withAttribute("title", labels.getMethodLabel(method, context.getContextualType())));
 	}
 
-	/*
-	 * (non-Javadoc)
-	 * @see org.jmolecules.stereotype.tooling.NodeHandler#handleCustom(java.lang.Object, org.jmolecules.stereotype.tooling.NodeContext)
-	 */
 	@Override
 	public void handleCustom(Object custom, NodeContext context) {
 		addChild(node -> customHandler.accept(node, custom));
 	}
 
-	/*
-	 * (non-Javadoc)
-	 * @see org.jmolecules.stereotype.tooling.NodeHandler#postGroup()
-	 */
 	@Override
 	public void postGroup() {
 		this.current = this.current.parent;

headless-services/spring-boot-language-server/src/main/java/org/springframework/ide/vscode/boot/java/stereotypes/StereotypeClassElement.java

@@ -13,23 +13,31 @@
 import java.util.List;
 import java.util.Set;
 
+import org.eclipse.lsp4j.Location;
 import org.springframework.ide.vscode.commons.protocol.spring.AbstractSpringIndexElement;
 
 public class StereotypeClassElement extends AbstractSpringIndexElement implements StereotypeAnnotatedElement {
 
 	private final String type;
+	private final Location location;
+	
 	private final Set<String> supertypes;
 	private List<String> annotationTypes;
 
-	public StereotypeClassElement(String type, Set<String> supertypes, List<String> annotationTypes) {
+	public StereotypeClassElement(String type, Location location, Set<String> supertypes, List<String> annotationTypes) {
 		this.type = type;
+		this.location = location;
 		this.supertypes = supertypes;
 		this.annotationTypes = annotationTypes;
 	}
 
 	public String getType() {
 		return type;
 	}
+	
+	public Location getLocation() {
+		return location;
+	}
 
 	public boolean doesImplement(String fqn) {
 		if (type.equals(fqn)) {

headless-services/spring-boot-language-server/src/main/java/org/springframework/ide/vscode/boot/java/stereotypes/StereotypesIndexer.java

@@ -26,7 +26,9 @@
 import org.eclipse.jdt.core.dom.ITypeBinding;
 import org.eclipse.jdt.core.dom.MethodDeclaration;
 import org.eclipse.jdt.core.dom.PackageDeclaration;
+import org.eclipse.jdt.core.dom.SimpleName;
 import org.eclipse.jdt.core.dom.TypeDeclaration;
+import org.eclipse.lsp4j.Location;
 import org.jmolecules.stereotype.catalog.StereotypeDefinition.Assignment.Type;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -36,6 +38,7 @@
 import org.springframework.ide.vscode.boot.java.handlers.SymbolProvider;
 import org.springframework.ide.vscode.boot.java.utils.ASTUtils;
 import org.springframework.ide.vscode.boot.java.utils.SpringIndexerJavaContext;
+import org.springframework.ide.vscode.commons.util.BadLocationException;
 import org.springframework.ide.vscode.commons.util.text.TextDocument;
 
 import com.google.common.collect.Streams;
@@ -68,8 +71,7 @@ public void addSymbols(Annotation node, ITypeBinding typeBinding, Collection<ITy
 
 	@Override
 	public void addSymbols(MethodDeclaration methodDeclaration, SpringIndexerJavaContext context, TextDocument doc) {
-		// TODO Auto-generated method stub
-		SymbolProvider.super.addSymbols(methodDeclaration, context, doc);
+		// TODO
 	}
 
 	@Override
@@ -98,6 +100,15 @@ public void addSymbols(PackageDeclaration packageDeclaration, SpringIndexerJavaC
 
 	@Override
 	public void addSymbols(TypeDeclaration typeDeclaration, SpringIndexerJavaContext context, TextDocument doc) {
+		try {
+			createStereotypeElementForType(typeDeclaration, context, doc);
+		}
+		catch (BadLocationException e) {
+			log.error("error identifying location of type declaration", e);
+		}
+	}
+	
+	private void createStereotypeElementForType(TypeDeclaration typeDeclaration, SpringIndexerJavaContext context, TextDocument doc) throws BadLocationException {
 		ITypeBinding typeBinding = typeDeclaration.resolveBinding();
 		if (typeBinding == null) {
 			return;
@@ -141,10 +152,11 @@ public void addSymbols(TypeDeclaration typeDeclaration, SpringIndexerJavaContext
 				.map(binding -> binding.getAnnotationType().getQualifiedName())
 				.toList();
 
-		context.getBeans().add(new CachedBean(context.getDocURI(), new StereotypeClassElement(qualifiedName, supertypes, annotationTypes)));
-		
+		SimpleName astNodeForLocation = typeDeclaration.getName();
+		Location location = new Location(doc.getUri(), doc.toRange(astNodeForLocation.getStartPosition(), astNodeForLocation.getLength()));
 
-//		}
+		StereotypeClassElement indexElement = new StereotypeClassElement(qualifiedName, location, supertypes, annotationTypes);
+		context.getBeans().add(new CachedBean(context.getDocURI(), indexElement));
 	}
 
 	private boolean isStereotype(TypeDeclaration typeDeclaration, ITypeBinding binding) {

headless-services/spring-boot-language-server/src/main/java/org/springframework/ide/vscode/boot/java/utils/SpringIndexerJava.java

@@ -93,7 +93,7 @@ public class SpringIndexerJava implements SpringIndexer {
 
 	// whenever the implementation of the indexer changes in a way that the stored data in the cache is no longer valid,
 	// we need to change the generation - this will result in a re-indexing due to no up-to-date cache data being found
-	private static final String GENERATION = "GEN-22";
+	private static final String GENERATION = "GEN-23";
 	private static final String INDEX_FILES_TASK_ID = "index-java-source-files-task-";
 
 	private static final String SYMBOL_KEY = "symbols";

headless-services/spring-boot-language-server/src/test/java/org/springframework/ide/vscode/boot/java/stereotypes/StereotypesIndexerTest.java

@@ -12,6 +12,7 @@
 
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertTrue;
+import static org.junit.jupiter.api.Assertions.assertNotNull;
 
 import java.io.File;
 import java.util.Collection;
@@ -21,6 +22,7 @@
 import java.util.concurrent.TimeUnit;
 import java.util.function.BiConsumer;
 
+import org.eclipse.lsp4j.Location;
 import org.eclipse.lsp4j.TextDocumentIdentifier;
 import org.jmolecules.stereotype.api.Stereotype;
 import org.jmolecules.stereotype.catalog.StereotypeDefinition;
@@ -82,6 +84,31 @@ void testStuff() throws Exception {
 //    	assertEquals(1, stereotypeNodes.size());
     }
 
+    @Test
+    void testPackageElement() throws Exception {
+    	List<StereotypePackageElement> packages = springIndex.getNodesOfType(StereotypePackageElement.class);
+    	assertEquals(2, packages.size()); // package nodes are created for package declarations in package-info.java files only
+    }
+    
+    @Test
+    void testLocationInformationForTypeElement() throws Exception {
+		String docUri = directory.toPath().resolve("src/main/java/example/application/SampleController.java").toUri().toString();
+    	
+    	StereotypeClassElement element = springIndex.getNodesOfType(StereotypeClassElement.class).stream()
+    			.filter(node -> node.getType().equals("example.application.SampleController"))
+    			.findFirst()
+    			.get();
+    	
+    	assertNotNull(element);
+    	assertEquals("example.application.SampleController", element.getType());
+    	
+    	Location location = element.getLocation();
+    	assertNotNull(location);
+    	assertEquals(docUri, location.getUri());
+    	assertEquals(7, location.getRange().getStart().getLine());
+    	assertEquals(7, location.getRange().getEnd().getLine());
+    }
+    
 	@Test
 	void testFromPackageIndexBasedFactory() {
 

headless-services/spring-boot-language-server/src/test/java/org/springframework/ide/vscode/boot/java/stereotypes/ToolsJsonNodeHandler.java

@@ -16,23 +16,21 @@
 
 package org.springframework.ide.vscode.boot.java.stereotypes;
 
-import net.minidev.json.JSONObject;
-
 import java.util.ArrayList;
 import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.function.BiConsumer;
 import java.util.function.Consumer;
 
-import org.eclipse.lsp4j.Location;
-import org.eclipse.lsp4j.Range;
 import org.jmolecules.stereotype.api.Stereotype;
 import org.jmolecules.stereotype.tooling.LabelProvider;
 import org.jmolecules.stereotype.tooling.MethodNodeContext;
 import org.jmolecules.stereotype.tooling.NodeContext;
 import org.jmolecules.stereotype.tooling.NodeHandler;
 
+import net.minidev.json.JSONObject;
+
 /**
  * @author Oliver Drotbohm
  * @author Martin Lippert
@@ -94,7 +92,7 @@ public void handleStereotype(Stereotype stereotype, NodeContext context) {
 	public void handleType(StereotypeClassElement type, NodeContext context) {
 		addChild(node -> node
 			.withAttribute(TEXT, labels.getTypeLabel(type))
-			.withAttribute("location", new Location("sampleUri", new Range()))
+			.withAttribute("location", type.getLocation())
 		);
 	}
 

headless-services/spring-boot-language-server/src/test/resources/test-projects/test-stereotypes-support/src/main/java/example/application/empty/EmptyClass.java

@@ -0,0 +1,5 @@
+package example.application.empty;
+
+public class EmptyClass {
+
+}