Add auto-generated user function documentation

FylmTM · FylmTM · commit 039614ee2114 · 2016-12-01T22:53:56.000+02:00
diff --git a/language/cypher/src/main/java/com/neueda/jetbrains/plugin/graphdb/language/cypher/completion/metadata/CypherMetadataProviderService.java b/language/cypher/src/main/java/com/neueda/jetbrains/plugin/graphdb/language/cypher/completion/metadata/CypherMetadataProviderService.java
@@ -7,6 +7,8 @@
 
 public interface CypherMetadataProviderService {
 
+    void wipeAll();
+
     void wipeContainer(String sourceId);
 
     CypherMetadataContainer getContainer(String sourceId);
@@ -22,4 +24,6 @@ public interface CypherMetadataProviderService {
     List<CypherUserFunctionElement> getUserFunctions();
 
     Optional<CypherProcedureElement> findProcedure(String fullName);
+
+    Optional<CypherUserFunctionElement> findUserFunction(String fullName);
 }
diff --git a/language/cypher/src/main/java/com/neueda/jetbrains/plugin/graphdb/language/cypher/completion/metadata/CypherMetadataProviderServiceImpl.java b/language/cypher/src/main/java/com/neueda/jetbrains/plugin/graphdb/language/cypher/completion/metadata/CypherMetadataProviderServiceImpl.java
@@ -16,6 +16,11 @@ public CypherMetadataProviderServiceImpl() {
         sourceData = new HashMap<>();
     }
 
+    @Override
+    public void wipeAll() {
+        sourceData.clear();
+    }
+
     @Override
     public void wipeContainer(String sourceId) {
         sourceData.remove(sourceId);
@@ -77,4 +82,13 @@ public Optional<CypherProcedureElement> findProcedure(String name) {
                 .filter((procedureElement) -> procedureElement.getName().equals(name))
                 .findFirst();
     }
+
+    @Override
+    public Optional<CypherUserFunctionElement> findUserFunction(String name) {
+        return sourceData.entrySet().stream()
+                .map(Map.Entry::getValue)
+                .flatMap((container) -> container.getUserFunctions().stream())
+                .filter((userFunctionElement) -> userFunctionElement.getName().equals(name))
+                .findFirst();
+    }
 }
diff --git a/language/cypher/src/main/java/com/neueda/jetbrains/plugin/graphdb/language/cypher/completion/metadata/elements/CypherProcedureElement.java b/language/cypher/src/main/java/com/neueda/jetbrains/plugin/graphdb/language/cypher/completion/metadata/elements/CypherProcedureElement.java
@@ -6,7 +6,10 @@
 import com.neueda.jetbrains.plugin.graphdb.platform.GraphIcons;
 import org.jetbrains.annotations.Nullable;
 
-public class CypherProcedureElement implements CypherElement, CypherElementWithSignature, CypherElementWithDocumentation {
+public class CypherProcedureElement implements
+        CypherElement,
+        CypherElementWithSignature,
+        CypherElementWithDocumentation {
 
     private final String name;
     @Nullable
@@ -32,7 +35,7 @@ public InvokableInformation getInvokableInformation() {
     public String getDocumentation() {
         if (documentation == null) {
             documentation = ""
-                    + "<b>" + name + "</b><br>"
+                    + "procedure <b>" + name + "</b><br>"
                     + "Arguments:<br>"
                     + "&nbsp;&nbsp;&nbsp;&nbsp;" + invokableInformation.getSignature() + "<br>"
                     + "Return:<br>"
diff --git a/language/cypher/src/main/java/com/neueda/jetbrains/plugin/graphdb/language/cypher/completion/metadata/elements/CypherUserFunctionElement.java b/language/cypher/src/main/java/com/neueda/jetbrains/plugin/graphdb/language/cypher/completion/metadata/elements/CypherUserFunctionElement.java
@@ -6,20 +6,50 @@
 import com.neueda.jetbrains.plugin.graphdb.platform.GraphIcons;
 import org.jetbrains.annotations.Nullable;
 
-public class CypherUserFunctionElement implements CypherElement, CypherElementWithSignature {
+public class CypherUserFunctionElement implements
+        CypherElement,
+        CypherElementWithSignature,
+        CypherElementWithDocumentation {
+
     private final String name;
+    @Nullable
+    private final String description;
     private final InvokableInformation invokableInformation;
+    private String documentation;
 
     public CypherUserFunctionElement(String name, String signature, @Nullable String description) {
         this.name = name;
+        this.description = description;
         this.invokableInformation = extractInformation(signature, name);
     }
 
+    public String getName() {
+        return name;
+    }
+
     @Override
     public InvokableInformation getInvokableInformation() {
         return invokableInformation;
     }
 
+    @Override
+    public String getDocumentation() {
+        if (documentation == null) {
+            documentation = ""
+                    + "function <b>" + name + "</b><br>"
+                    + "Arguments:<br>"
+                    + "&nbsp;&nbsp;&nbsp;&nbsp;" + invokableInformation.getSignature() + "<br>"
+                    + "Return:<br>"
+                    + "&nbsp;&nbsp;&nbsp;&nbsp;" + invokableInformation.getReturnType();
+
+            if (description != null) {
+                documentation += "<br><br>"
+                        + description;
+            }
+        }
+        return documentation;
+    }
+
     @Override
     public LookupElement getLookupElement() {
         return LookupElementBuilder
diff --git a/language/cypher/src/main/java/com/neueda/jetbrains/plugin/graphdb/language/cypher/documentation/CypherDocumentationProvider.java b/language/cypher/src/main/java/com/neueda/jetbrains/plugin/graphdb/language/cypher/documentation/CypherDocumentationProvider.java
@@ -9,6 +9,7 @@
 import com.intellij.psi.tree.IElementType;
 import com.neueda.jetbrains.plugin.graphdb.language.cypher.completion.metadata.CypherMetadataProviderService;
 import com.neueda.jetbrains.plugin.graphdb.language.cypher.completion.metadata.elements.CypherProcedureElement;
+import com.neueda.jetbrains.plugin.graphdb.language.cypher.completion.metadata.elements.CypherUserFunctionElement;
 import com.neueda.jetbrains.plugin.graphdb.language.cypher.documentation.database.CypherDocumentation;
 import com.neueda.jetbrains.plugin.graphdb.language.cypher.psi.*;
 import com.neueda.jetbrains.plugin.graphdb.language.cypher.util.TraverseUtil;
@@ -61,6 +62,11 @@ public String generateDoc(PsiElement element, @Nullable PsiElement originalEleme
             return storedProcedureDocumentation.get();
         }
 
+        Optional<String> userFunctionDocumentation = userFunctionDocumentation(element);
+        if (userFunctionDocumentation.isPresent()) {
+            return userFunctionDocumentation.get();
+        }
+
         return null;
     }
 
@@ -118,6 +124,16 @@ private Optional<String> storedProcedureDocumentation(PsiElement element) {
         return Optional.empty();
     }
 
+    private Optional<String> userFunctionDocumentation(PsiElement element) {
+        if (element instanceof CypherFunctionInvocation) {
+            CypherFunctionInvocation cypherFunctionInvocation = (CypherFunctionInvocation) element;
+            return getMetadataService(element)
+                    .findUserFunction(cypherFunctionInvocation.getFullName())
+                    .map(CypherUserFunctionElement::getDocumentation);
+        }
+        return Optional.empty();
+    }
+
     private CypherMetadataProviderService getMetadataService(PsiElement element) {
         return ServiceManager.getService(element.getProject(), CypherMetadataProviderService.class);
     }
diff --git a/testing/integration-neo4j/src/test/java/com/neueda/jetbrains/plugin/graphdb/test/integration/neo4j/tests/cypher/documentation/AutoGeneratedProcedureDocumentationTest.java b/testing/integration-neo4j/src/test/java/com/neueda/jetbrains/plugin/graphdb/test/integration/neo4j/tests/cypher/documentation/AutoGeneratedProcedureDocumentationTest.java
@@ -19,6 +19,7 @@ public void testExistingProcedureDocumentationWithoutDescription() throws Except
         metadata.addProcedure("test.procedureName", "(signature)", null);
         configure("CALL test.proce<caret>dureName(42);");
         assertThat(verify())
+                .contains("procedure")
                 .contains("test.procedureName")
                 .contains("Arguments")
                 .contains("(signature)")
@@ -30,6 +31,7 @@ public void testExistingProcedureDocumentationWithDescription() throws Exception
         metadata.addProcedure("test.procedureName", "(signature)", "My cool description");
         configure("CALL test.proce<caret>dureName(42);");
         assertThat(verify())
+                .contains("procedure")
                 .contains("test.procedureName")
                 .contains("Arguments")
                 .contains("(signature)")
@@ -38,7 +40,7 @@ public void testExistingProcedureDocumentationWithDescription() throws Exception
                 .contains("My cool description");
     }
 
-    public void testNonExistingProcudureNoDocumentation() throws Exception {
+    public void testNonExistingProcedureNoDocumentation() throws Exception {
         configure("CALL test.proce<caret>dureName(42);");
         verify(null);
     }
diff --git a/testing/integration-neo4j/src/test/java/com/neueda/jetbrains/plugin/graphdb/test/integration/neo4j/tests/cypher/documentation/AutoGeneratedUserFunctionDocumentationTest.java b/testing/integration-neo4j/src/test/java/com/neueda/jetbrains/plugin/graphdb/test/integration/neo4j/tests/cypher/documentation/AutoGeneratedUserFunctionDocumentationTest.java
@@ -0,0 +1,47 @@
+package com.neueda.jetbrains.plugin.graphdb.test.integration.neo4j.tests.cypher.documentation;
+
+import com.neueda.jetbrains.plugin.graphdb.language.cypher.completion.metadata.CypherMetadataContainer;
+import com.neueda.jetbrains.plugin.graphdb.test.integration.neo4j.tests.cypher.util.BaseDocumentationTest;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+public class AutoGeneratedUserFunctionDocumentationTest extends BaseDocumentationTest {
+
+    private CypherMetadataContainer metadata;
+
+    @Override
+    public void setUp() throws Exception {
+        super.setUp();
+        metadata = services().cypherMetadataProvider().getContainer("documentationTest");
+    }
+
+    public void testExistingUserFunctionDocumentationWithoutDescription() throws Exception {
+        metadata.addUserFunction("test.userFunctionName", "(functionSignature)", null);
+        configure("RETURN test.user<caret>FunctionName(42);");
+        assertThat(verify())
+                .contains("function")
+                .contains("test.userFunctionName")
+                .contains("Arguments")
+                .contains("(functionSignature)")
+                .contains("Return")
+                .contains("<?>");
+    }
+
+    public void testExistingUserFunctionDocumentationWithDescription() throws Exception {
+        metadata.addUserFunction("test.userFunctionName", "(functionSignature)", "My cool description");
+        configure("RETURN test.user<caret>FunctionName(42);");
+        assertThat(verify())
+                .contains("function")
+                .contains("test.userFunctionName")
+                .contains("Arguments")
+                .contains("(functionSignature)")
+                .contains("Return")
+                .contains("<?>")
+                .contains("My cool description");
+    }
+
+    public void testNonExistingUserFunctionNoDocumentation() throws Exception {
+        configure("RETURN test.user<caret>FunctionName(42);");
+        verify(null);
+    }
+}
diff --git a/testing/integration-neo4j/src/test/java/com/neueda/jetbrains/plugin/graphdb/test/integration/neo4j/util/base/BaseIntegrationTest.java b/testing/integration-neo4j/src/test/java/com/neueda/jetbrains/plugin/graphdb/test/integration/neo4j/util/base/BaseIntegrationTest.java
@@ -33,7 +33,7 @@ public void setUp() throws Exception {
         // Clean up any data sources & their information
         List<DataSourceApi> dataSources = new ArrayList<>(component().dataSources().getDataSourceContainer().getDataSources());
         component().dataSources().getDataSourceContainer().removeDataSources(dataSources);
-        dataSources.forEach(dataSource -> services().cypherMetadataProvider().wipeContainer(dataSource.getName()));
+        services().cypherMetadataProvider().wipeAll();
     }
 
     public Services services() {

Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ public void setUp() throws Exception {`
`33`	`33`	`// Clean up any data sources & their information`
`34`	`34`	`List<DataSourceApi> dataSources = new ArrayList<>(component().dataSources().getDataSourceContainer().getDataSources());`
`35`	`35`	`component().dataSources().getDataSourceContainer().removeDataSources(dataSources);`
`36`		`- dataSources.forEach(dataSource -> services().cypherMetadataProvider().wipeContainer(dataSource.getName()));`
	`36`	`+ services().cypherMetadataProvider().wipeAll();`
`37`	`37`	`}`
`38`	`38`
`39`	`39`	`public Services services() {`