Interactions (#114)

* Basic implementation of Ctrl-c, entity context menu and table actions to copy output data #74
Has to be double-verified as implementation done 30 days ago and might be non compliant with current branch state

* minor version upgrades
* fixed tests which were failing due AssertJ version update

* minor code improvements

Author: Sergejs Muromcevs

build.gradle

@@ -1,8 +1,8 @@
 plugins {
     id 'idea'
     id 'java'
-    id "org.jetbrains.intellij" version "0.3.12"
-    id 'net.researchgate.release' version '2.6.0'
+    id "org.jetbrains.intellij" version "0.4.8"
+    id 'net.researchgate.release' version '2.8.0'
 }
 
 apply plugin: 'idea'

database/api/src/main/java/com/neueda/jetbrains/plugin/graphdb/database/api/data/GraphEntity.java

@@ -2,7 +2,7 @@
 
 import java.util.List;
 
-public interface GraphEntity {
+public interface GraphEntity extends NoIdGraphEntity {
 
     String getId();
 
@@ -12,7 +12,4 @@ public interface GraphEntity {
 
     String getTypesName();
 
-    boolean isTypesSingle();
-
-    String getRepresentation();
 }

database/api/src/main/java/com/neueda/jetbrains/plugin/graphdb/database/api/data/GraphPath.java

@@ -2,10 +2,18 @@
 
 import java.util.List;
 
-public interface GraphPath {
+public interface GraphPath extends NoIdGraphEntity {
 
     /**
      * Return nodes and relationships.
      */
     List<Object> getComponents();
+
+    default boolean isTypesSingle() {
+        return true;
+    }
+
+    default String getRepresentation() {
+        return "Path";
+    }
 }

database/api/src/main/java/com/neueda/jetbrains/plugin/graphdb/database/api/data/NoIdGraphEntity.java

@@ -0,0 +1,9 @@
+package com.neueda.jetbrains.plugin.graphdb.database.api.data;
+
+public interface NoIdGraphEntity {
+
+    boolean isTypesSingle();
+
+    String getRepresentation();
+
+}

database/neo4j/build.gradle

@@ -1,4 +1,5 @@
 dependencies {
     compile project(':database:api')
     compile "org.neo4j.driver:neo4j-java-driver:$versionNeo4jJavaBoltDriver"
+    compile("com.fasterxml.jackson.core:jackson-annotations:$versionJacksonMapper")
 }

gradle.properties

@@ -1,16 +1,16 @@
 version=2.5.6
 
 # Intellij SDK
-intellijSdkVersion=2018.3
+intellijSdkVersion=2019.1.1
 
 # Versions
 versionJunit=4.12
-versionAssertj=3.8.0
-versionMockito=2.10.0
-versionNeo4jJavaBoltDriver=1.6.3
+versionAssertj=3.12.2
+versionMockito=2.27.0
+versionNeo4jJavaBoltDriver=1.6.4
 versionPrefuse=1.0.0
 versionGoogleAnalytics=1.1.2
-versionJacksonMapper=2.8.6
+versionJacksonMapper=2.9.8
 
 # Performance
 org.gradle.jvmargs=-Xmx512m

graph-database-support-plugin/src/main/resources/META-INF/plugin.xml

@@ -219,6 +219,12 @@
                     icon="/actions/refresh.png"
                     description="Clean canvas">
             </action>
+            <action id="GraphDatabaseConsoleToolWindowActions.CopyQueryOutput"
+                    class="com.neueda.jetbrains.plugin.graphdb.jetbrains.actions.ui.console.CopyQueryOutputAction"
+                    text="Copy query result to clipboard"
+                    icon="/actions/copy.png"
+                    description="Copy query result to clipboard">
+            </action>
         </group>
 
         <group id="GraphDatabaseFileActions"

language/cypher/src/main/java/com/neueda/jetbrains/plugin/graphdb/language/cypher/completion/metadata/atoms/CypherType.java

@@ -32,11 +32,7 @@ default boolean isAssignableTo(CypherType t) {
             return true;
         }
 
-        if (this instanceof CypherList && t instanceof CypherList) {
-            return true;
-        }
-
-        return false;
+        return this instanceof CypherList && t instanceof CypherList;
     }
 
 }

language/cypher/src/main/java/com/neueda/jetbrains/plugin/graphdb/language/cypher/completion/providers/ProceduresCompletionProvider.java

@@ -20,10 +20,8 @@ public final class ProceduresCompletionProvider extends BaseCompletionProvider {
     protected void addCompletions(@NotNull CompletionParameters parameters,
                                   ProcessingContext context,
                                   @NotNull CompletionResultSet result) {
-        withCypherMetadataProvider(parameters, (metadataProvider -> {
-            metadataProvider.getProcedures().stream()
-                       .map(CypherElement::getLookupElement)
-                       .forEach(result::addElement);
-        }));
+        withCypherMetadataProvider(parameters, (metadataProvider -> metadataProvider.getProcedures().stream()
+                   .map(CypherElement::getLookupElement)
+                   .forEach(result::addElement)));
     }
 }

language/cypher/src/main/java/com/neueda/jetbrains/plugin/graphdb/language/cypher/completion/providers/PropertyKeyCompletionProvider.java

@@ -19,10 +19,8 @@ public final class PropertyKeyCompletionProvider extends BaseCompletionProvider
     protected void addCompletions(@NotNull CompletionParameters parameters,
                                   ProcessingContext context,
                                   @NotNull CompletionResultSet result) {
-        withCypherMetadataProvider(parameters, (metadataProvider -> {
-            metadataProvider.getPropertyKeys().stream()
-                    .map(CypherElement::getLookupElement)
-                    .forEach(result::addElement);
-        }));
+        withCypherMetadataProvider(parameters, (metadataProvider -> metadataProvider.getPropertyKeys().stream()
+                .map(CypherElement::getLookupElement)
+                .forEach(result::addElement)));
     }
 }

language/cypher/src/main/java/com/neueda/jetbrains/plugin/graphdb/language/cypher/completion/providers/RelationshipTypeCompletionProvider.java

@@ -19,10 +19,8 @@ public final class RelationshipTypeCompletionProvider extends BaseCompletionProv
     protected void addCompletions(@NotNull CompletionParameters parameters,
                                   ProcessingContext context,
                                   @NotNull CompletionResultSet result) {
-        withCypherMetadataProvider(parameters, (metadataProvider -> {
-            metadataProvider.getRelationshipTypes().stream()
-                    .map(CypherElement::getLookupElement)
-                    .forEach(result::addElement);
-        }));
+        withCypherMetadataProvider(parameters, (metadataProvider -> metadataProvider.getRelationshipTypes().stream()
+                .map(CypherElement::getLookupElement)
+                .forEach(result::addElement)));
     }
 }

language/cypher/src/main/java/com/neueda/jetbrains/plugin/graphdb/language/cypher/completion/providers/UserFunctionsCompletionProvider.java

@@ -20,10 +20,8 @@ public class UserFunctionsCompletionProvider extends BaseCompletionProvider {
 
     @Override
     protected void addCompletions(@NotNull CompletionParameters parameters, ProcessingContext context, @NotNull CompletionResultSet result) {
-        withCypherMetadataProvider(parameters, (metadataProvider -> {
-            metadataProvider.getUserFunctions().stream()
-                    .map(CypherElement::getLookupElement)
-                    .forEach(result::addElement);
-        }));
+        withCypherMetadataProvider(parameters, (metadataProvider -> metadataProvider.getUserFunctions().stream()
+                .map(CypherElement::getLookupElement)
+                .forEach(result::addElement)));
     }
 }

language/cypher/src/main/java/com/neueda/jetbrains/plugin/graphdb/language/cypher/documentation/CypherDocumentationProvider.java

@@ -69,11 +69,8 @@ public String generateDoc(PsiElement element, @Nullable PsiElement originalEleme
         }
 
         Optional<String> userFunctionDocumentation = userFunctionDocumentation(element);
-        if (userFunctionDocumentation.isPresent()) {
-            return userFunctionDocumentation.get();
-        }
+        return userFunctionDocumentation.orElse(null);
 
-        return null;
     }
 
     private Optional<String> builtInFunctionDocumentation(PsiElement element) {

language/cypher/src/main/java/com/neueda/jetbrains/plugin/graphdb/language/cypher/editor/CypherParameterInfoHandler.java

@@ -31,7 +31,7 @@ public class CypherParameterInfoHandler
     @Override
     @SuppressWarnings("unchecked")
     public PsiElement[] getActualParameters(@NotNull CypherInvocation o) {
-        return ArrayUtil.toObjectArray((List) o.arguments(), PsiElement.class);
+        return ArrayUtil.toObjectArray(o.arguments(), PsiElement.class);
     }
 
     @NotNull

language/cypher/src/main/java/com/neueda/jetbrains/plugin/graphdb/language/cypher/references/CypherInvocation.java

@@ -62,7 +62,7 @@ default List<InvokableInformation> resolve() {
         if (this instanceof CypherProcedureInvocation) {
             svc.findProcedure(getFullName())
                 .map(CypherProcedureElement::getInvokableInformation)
-                .ifPresent(info -> matchedInvocations.add(info));
+                .ifPresent(matchedInvocations::add);
             return matchedInvocations;
         }
 
@@ -74,7 +74,7 @@ default List<InvokableInformation> resolve() {
         if (matchedInvocations.isEmpty()) {
             svc.findUserFunction(getFullName())
                 .map(CypherUserFunctionElement::getInvokableInformation)
-                .ifPresent(info -> matchedInvocations.add(info));
+                .ifPresent(matchedInvocations::add);
         }
         return matchedInvocations;
     }

language/cypher/src/main/java/com/neueda/jetbrains/plugin/graphdb/language/cypher/references/CypherReferenceBase.java

@@ -11,10 +11,7 @@
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
-import java.util.Collection;
-import java.util.HashMap;
-import java.util.List;
-import java.util.Map;
+import java.util.*;
 
 /**
  * TODO: Description
@@ -56,7 +53,7 @@ protected <T extends CypherNamedElement> Collection<T> uniqueVariants(List<T> da
         Map<String, T> variants = new HashMap<>();
 
         data.stream()
-                .filter(element -> element != null)
+                .filter(Objects::nonNull)
                 .forEach(element -> {
                     String name = element.getName();
                     if (name != null && name.length() > 0) {

language/cypher/src/main/java/com/neueda/jetbrains/plugin/graphdb/language/cypher/references/CypherReferenceContributor.java

@@ -54,7 +54,7 @@ public void registerReferenceProviders(@NotNull PsiReferenceRegistrar registrar)
     }
 
     private void register(PsiReferenceRegistrar registrar,
-                          @NotNull ElementPattern pattern,
+                          @NotNull ElementPattern<PsiElement> pattern,
                           CypherReferenceContributionPriority contributionPriority,
                           ReferenceFactory referenceFactory) {
         registrar.registerReferenceProvider(

testing/integration-neo4j/src/test/java/com/neueda/jetbrains/plugin/graphdb/test/integration/neo4j/tests/cypher/inspection/CypherFunctionCallInspectionTest.java

@@ -5,6 +5,7 @@
 import com.neueda.jetbrains.plugin.graphdb.language.cypher.inspections.CypherFunctionCallInspection;
 import com.neueda.jetbrains.plugin.graphdb.test.integration.neo4j.tests.cypher.util.BaseInspectionTest;
 
+import java.util.Collections;
 import java.util.List;
 import java.util.Objects;
 import java.util.Set;
@@ -125,7 +126,7 @@ private void generateTypeCompatibilityTests(String query, String expected, List<
 
     public void testStringTypeCheck() {
         String query = "MATCH p=(n)-[r]-() RETURN ltrim(%s)";
-        generateTypeCompatibilityTests(query, "STRING", asList("STRING"));
+        generateTypeCompatibilityTests(query, "STRING", Collections.singletonList("STRING"));
     }
 
     public void testNullableStringTypeCheck() {
@@ -145,7 +146,7 @@ public void testNullableNumberTypeCheck() {
 
     public void testIntegerTypeCheck() {
         String query = "MATCH p=(n)-[r]-() RETURN substring(\"a\", %s)";
-        generateTypeCompatibilityTests(query, "INTEGER", asList("INTEGER"));
+        generateTypeCompatibilityTests(query, "INTEGER", Collections.singletonList("INTEGER"));
     }
 
     public void testNullableIntegerTypeCheck() {
@@ -155,7 +156,7 @@ public void testNullableIntegerTypeCheck() {
 
     public void testBooleanTypeCheck() {
         String query = "MATCH p=(n)-[r]-() CALL test.bool(%s) RETURN p";
-        generateTypeCompatibilityTests(query, "BOOLEAN", asList("BOOLEAN"));
+        generateTypeCompatibilityTests(query, "BOOLEAN", Collections.singletonList("BOOLEAN"));
     }
 
     public void testNullableBooleanTypeCheck() {
@@ -175,17 +176,17 @@ public void testNullableFloatTypeCheck() {
 
     public void testPathTypeCheck() {
         String query = "MATCH p=(n)-[r]-() RETURN ufrpath(%s)";
-        generateTypeCompatibilityTests(query, "PATH", asList("PATH"));
+        generateTypeCompatibilityTests(query, "PATH", Collections.singletonList("PATH"));
     }
 
     public void testNodeTypeCheck() {
         String query = "MATCH p=(n)-[r]-() RETURN ufrnode(%s)";
-        generateTypeCompatibilityTests(query, "NODE", asList("NODE"));
+        generateTypeCompatibilityTests(query, "NODE", Collections.singletonList("NODE"));
     }
 
     public void testRelationshipTypeCheck() {
         String query = "MATCH p=(n)-[r]-() RETURN ufrrel(%s)";
-        generateTypeCompatibilityTests(query, "RELATIONSHIP", asList("RELATIONSHIP"));
+        generateTypeCompatibilityTests(query, "RELATIONSHIP", Collections.singletonList("RELATIONSHIP"));
     }
 
     public void testSizeArray() {

testing/manual/src/test/java/com/neueda/jetbrains/plugin/graphdb/TestSimpleGraph.java

@@ -18,7 +18,7 @@ public class TestSimpleGraph {
     public static void main(String[] argv) {
         PrefuseVisualization v = new PrefuseVisualization(new IdeaLookAndFeelService());
 
-        Map<String, String> config = new HashMap<String, String>();
+        Map<String, String> config = new HashMap<>();
         config.put(Neo4jBoltConfiguration.HOST, "localhost");
 //        config.put(Neo4jBoltConfiguration.PASSWORD)
 //        config.put(Neo4jBoltConfiguration.PORT)

ui/jetbrains/src/main/java/com/neueda/jetbrains/plugin/graphdb/jetbrains/actions/ui/console/CopyQueryOutputAction.java

@@ -0,0 +1,23 @@
+package com.neueda.jetbrains.plugin.graphdb.jetbrains.actions.ui.console;
+
+import com.intellij.openapi.actionSystem.AnAction;
+import com.intellij.openapi.actionSystem.AnActionEvent;
+import com.intellij.openapi.project.Project;
+import com.intellij.util.messages.MessageBus;
+import com.neueda.jetbrains.plugin.graphdb.jetbrains.ui.console.event.CopyQueryOutputEvent;
+import org.jetbrains.annotations.NotNull;
+
+public class CopyQueryOutputAction extends AnAction {
+
+    @Override
+    public void actionPerformed(@NotNull AnActionEvent e) {
+        Project project = getEventProject(e);
+
+        if (project == null) {
+            return;
+        }
+
+        MessageBus messageBus = project.getMessageBus();
+        messageBus.syncPublisher(CopyQueryOutputEvent.COPY_QUERY_OUTPUT_TOPIC).copyQueryOutputToClipboard();
+    }
+}

ui/jetbrains/src/main/java/com/neueda/jetbrains/plugin/graphdb/jetbrains/database/DiffService.java

@@ -20,12 +20,12 @@ public DiffService(Project project) {
     }
 
     public void updateNode(DataSourceApi api, GraphEntity oldNode, GraphEntity newNode) {
-        StringBuilder sb = new StringBuilder("MATCH (n) WHERE ID(n) = $id ")
-                .append(diffLabels(oldNode.getTypes(), newNode.getTypes()))
-                .append(" SET n = $props")
-                .append(" RETURN n");
 
-        service.executeQuery(api, new ExecuteQueryPayload(sb.toString(),
+        String query = "MATCH (n) WHERE ID(n) = $id " +
+                diffLabels(oldNode.getTypes(), newNode.getTypes()) +
+                " SET n = $props" +
+                " RETURN n";
+        service.executeQuery(api, new ExecuteQueryPayload(query,
                 ImmutableMap.of(
                         "id", Long.parseLong(oldNode.getId()),
                         "props", newNode.getPropertyContainer().getProperties()),
@@ -35,11 +35,11 @@ public void updateNode(DataSourceApi api, GraphEntity oldNode, GraphEntity newNo
 
     public void updateRelationShip(DataSourceApi api, GraphEntity relationship,
                                    GraphEntity updatedRel) {
-        StringBuilder sb = new StringBuilder("MATCH ()-[n]->() WHERE ID(n) = $id ")
-                .append(" SET n = $props")
-                .append(" RETURN n");
 
-        service.executeQuery(api, new ExecuteQueryPayload(sb.toString(),
+        String query = "MATCH ()-[n]->() WHERE ID(n) = $id " +
+                " SET n = $props" +
+                " RETURN n";
+        service.executeQuery(api, new ExecuteQueryPayload(query,
                 ImmutableMap.of(
                         "id", Long.parseLong(relationship.getId()),
                         "props", updatedRel.getPropertyContainer().getProperties()),

ui/jetbrains/src/main/java/com/neueda/jetbrains/plugin/graphdb/jetbrains/ui/console/event/CopyQueryOutputEvent.java

@@ -0,0 +1,10 @@
+package com.neueda.jetbrains.plugin.graphdb.jetbrains.ui.console.event;
+
+import com.intellij.util.messages.Topic;
+
+public interface CopyQueryOutputEvent {
+
+    Topic<CopyQueryOutputEvent> COPY_QUERY_OUTPUT_TOPIC = Topic.create("GraphDatabaseConsole.CopyQueryOutputTopic", CopyQueryOutputEvent.class);
+
+    void copyQueryOutputToClipboard();
+}