Added InvokesDescriptor, InvokesManipulator

Author: Sebastian Höfer

src/main/java/org/jqassistant/contrib/plugin/javascript/api/model/ArrayDeclaresRelationshipDescriptor.java

@@ -1,7 +1,5 @@
 package org.jqassistant.contrib.plugin.javascript.api.model;
 
-import java.util.List;
-
 import com.buschmais.jqassistant.core.store.api.model.FullQualifiedNameDescriptor;
 import com.buschmais.xo.neo4j.api.annotation.Label;
 
@@ -19,11 +17,5 @@ public interface ArrayDescriptor extends BaseObjectDescriptor {
 	default String getFullQualifiedName() {
 		return ARRAY;
 	}
-	/**
-     * Returns all index {@link ArrayDeclaresRelationshipDescriptor} of this array.
-     *
-     * @return The elements of the array.
-     */
-	List<ArrayDeclaresRelationshipDescriptor> getArrayDeclares();
 }
 

src/main/java/org/jqassistant/contrib/plugin/javascript/api/model/ArrayDescriptor.java

@@ -3,32 +3,31 @@
 import java.util.List;
 
 import com.buschmais.jqassistant.core.store.api.model.FullQualifiedNameDescriptor;
+import com.buschmais.xo.neo4j.api.annotation.Label;
 import com.buschmais.xo.neo4j.api.annotation.Relation;
+import com.buschmais.xo.neo4j.api.annotation.Relation.Outgoing;
 
 /**
  * Interface to describe a JavaScript code artifact.
  * 
  * @author sh20xyqi
  */
 
+@Label("JavaScriptCode")
 public interface CodeArtifact extends FullQualifiedNameDescriptor, LineNumberDescriptor {
 
 	public static final String DECLARES = "DECLARES";
 
+	@Outgoing
+	List<InvokesDescriptor> getInvokes();
+	
 	/**
      * Contains all named and anonymous {@link FunctionDescriptor} that occur in this code artifact.
      * @return List of functions
      */
     @Relation(DECLARES)
     List<FunctionDescriptor> getFunctions();
 
-	/**
-     * Contains all functions that were called by another {@link FunctionDescriptor}.
-     * @return List of invoked functions 
-     */
-    @Relation("INVOKES")
-    List<FunctionDescriptor> getInvokes();
-    
     /**
      * Contains all named and anonymous {@link ClassDescriptor} that occur in this JavaScript code artifact.
      * @return List of classes

src/main/java/org/jqassistant/contrib/plugin/javascript/api/model/CodeArtifact.java

@@ -4,6 +4,8 @@
 import com.buschmais.xo.neo4j.api.annotation.Label;
 import com.buschmais.xo.neo4j.api.annotation.Property;
 import com.buschmais.xo.neo4j.api.annotation.Relation;
+import com.buschmais.xo.neo4j.api.annotation.Relation.Incoming;
+
 import java.util.List;
 
 /**
@@ -30,5 +32,7 @@ public interface FunctionDescriptor extends JsDescriptor, FullQualifiedNameDescr
      */
     @Relation("HAS")
     List<FunctionParameterDescriptor> getParameters();
-    
+ 
+    @Incoming
+    List<InvokesDescriptor> getInvokedBy();
 }

src/main/java/org/jqassistant/contrib/plugin/javascript/api/model/FunctionDescriptor.java

@@ -0,0 +1,22 @@
+package org.jqassistant.contrib.plugin.javascript.api.model;
+
+import java.util.List;
+
+import com.buschmais.jqassistant.core.store.api.model.Descriptor;
+import com.buschmais.xo.neo4j.api.annotation.Relation;
+import com.buschmais.xo.neo4j.api.annotation.Relation.Incoming;
+import com.buschmais.xo.neo4j.api.annotation.Relation.Outgoing;
+
+/**
+ * Defines an INVOKES relation between two methods.
+ */
+@Relation("INVOKES")
+public interface InvokesDescriptor extends Descriptor, LineNumberDescriptor {
+
+    @Outgoing
+    CodeArtifact getInvokingCodeArtifact();
+
+    @Incoming
+    List<FunctionDescriptor> getInvokedFunction();
+
+}

src/main/java/org/jqassistant/contrib/plugin/javascript/api/model/InvokesDescriptor.java

@@ -1,7 +1,5 @@
 package org.jqassistant.contrib.plugin.javascript.api.model;
 
-import java.util.List;
-
 import com.buschmais.jqassistant.core.store.api.model.Descriptor;
 import com.buschmais.xo.neo4j.api.annotation.Label;
 
@@ -11,10 +9,7 @@
  * @author sh20xyqi
  */
 
-@Label("JS")
+@Label("JavaScript")
 public interface JsDescriptor extends Descriptor {
-	List<ObjectDeclaresRelationshipDescriptor> getObjectDeclaresRelationshipDescriptor();
-	
-	List<ArrayDeclaresRelationshipDescriptor> getArrayDeclaresRelationshipDescriptor();
 
 }

src/main/java/org/jqassistant/contrib/plugin/javascript/api/model/JsDescriptor.java

@@ -1,7 +1,5 @@
 package org.jqassistant.contrib.plugin.javascript.api.model;
 
-import java.util.List;
-
 import com.buschmais.jqassistant.core.store.api.model.FullQualifiedNameDescriptor;
 import com.buschmais.xo.neo4j.api.annotation.Label;
 
@@ -19,11 +17,5 @@ public interface ObjectDescriptor extends BaseObjectDescriptor {
 	default String getFullQualifiedName() {
 		return OBJECT;
 	}
-	/**
-     * Returns all declared {@link ObjectDeclaresRelationshipDescriptor} of this object.
-     *
-     * @return The elements of the object.
-     */
-	List<ObjectDeclaresRelationshipDescriptor> getObjectDeclaresRelationshipDescriptor();
 }
 

src/main/java/org/jqassistant/contrib/plugin/javascript/api/model/ObjectDeclaresRelationshipDescriptor.java

@@ -27,17 +27,14 @@
 import org.jqassistant.contrib.plugin.javascript.api.model.ObjectDescriptor;
 import org.jqassistant.contrib.plugin.javascript.api.model.UndefinedDescriptor;
 import org.jqassistant.contrib.plugin.javascript.api.model.VariableDescriptor;
-import org.jqassistant.contrib.plugin.javascript.scanner.visitor.manipulators.ArrayDeclaresManipulator;
 import org.jqassistant.contrib.plugin.javascript.scanner.visitor.manipulators.ArrayStoreManipulator;
 import org.jqassistant.contrib.plugin.javascript.scanner.visitor.manipulators.ClassStoreManipulator;
 import org.jqassistant.contrib.plugin.javascript.scanner.visitor.manipulators.FunctionStoreManipulator;
+import org.jqassistant.contrib.plugin.javascript.scanner.visitor.manipulators.InvokesManipulator;
 import org.jqassistant.contrib.plugin.javascript.scanner.visitor.manipulators.LiteralStoreManipulator;
-import org.jqassistant.contrib.plugin.javascript.scanner.visitor.manipulators.ObjectDeclaresManipulator;
 import org.jqassistant.contrib.plugin.javascript.scanner.visitor.manipulators.ObjectStoreManipulator;
 import org.jqassistant.contrib.plugin.javascript.scanner.visitor.manipulators.ParameterStoreManipulator;
-import org.jqassistant.contrib.plugin.javascript.scanner.visitor.manipulators.StoreRelationManipulator;
 import org.jqassistant.contrib.plugin.javascript.scanner.visitor.manipulators.VariableStoreManipulator;
-import org.jruby.ext.ffi.FFIService;
 
 import com.buschmais.jqassistant.core.store.api.Store;
 
@@ -52,19 +49,13 @@ public class JavascriptVisitor extends JavaScriptParserBaseVisitor<Void> {
 	private String fqnBase;
 	private FqnCreator fqnCreator;
 	private CodeArtifact rootComp;
-	private Optional<StoreRelationManipulator<?>> relationCreator;
 
 	public JavascriptVisitor(Store store, String fqnBase, CodeArtifact basicComp) {
-		this(store, fqnBase, basicComp, null);
-	}
-
-	public JavascriptVisitor(Store store, String fqnBase, CodeArtifact basicComp, StoreRelationManipulator<?> relationCreator) {
 		super();
 		System.out.println("FQN: " + fqnBase);
 		this.store = store;
 		this.fqnBase = fqnBase;
 		this.rootComp = basicComp;
-		this.relationCreator = Optional.ofNullable(relationCreator);
 		this.fqnCreator = new FqnCreator(fqnBase);
 	}
 
@@ -93,7 +84,6 @@ String createFqn(String varName) {
 	public Void visitFunctionExpression(FunctionExpressionContext ctx) {
 		FunctionDescriptor ecmaFunc = new FunctionStoreManipulator().createNodeIn(store, ctx, fqnCreator);
 		rootComp.getFunctions().add(ecmaFunc);
-		relationCreator.map((a) -> a.createRelation(ctx, rootComp, ecmaFunc));
 		JavascriptVisitor subTreeVistor = new JavascriptVisitor(store, createFqn(ecmaFunc.getName()), ecmaFunc);
 		ctx.children.forEach((c) -> c.accept(subTreeVistor));
 		return VISITOR_DOES_NOT_GO_DEEPER_INTO_AST;
@@ -103,7 +93,6 @@ public Void visitFunctionExpression(FunctionExpressionContext ctx) {
 	public Void visitArrowFunctionExpression(ArrowFunctionExpressionContext ctx) {
 		FunctionDescriptor ecmaFunc = new FunctionStoreManipulator().createNodeIn(store, ctx, fqnCreator);
 		rootComp.getFunctions().add(ecmaFunc);
-		relationCreator.map((a) -> a.createRelation(ctx, rootComp, ecmaFunc));
 		JavascriptVisitor subTreeVistor = new JavascriptVisitor(store, createFqn(ecmaFunc.getName()), ecmaFunc);
 		ctx.children.forEach((c) -> c.accept(subTreeVistor));
 		return VISITOR_DOES_NOT_GO_DEEPER_INTO_AST;
@@ -115,7 +104,6 @@ public Void visitFunctionDeclaration(FunctionDeclarationContext ctx) {
 		FunctionDescriptor ecmaFunc = new FunctionStoreManipulator(funcName).createNodeIn(store, ctx, fqnCreator);
 		rootComp.getFunctions().add(ecmaFunc);
 		JavascriptVisitor subTreeVistor = new JavascriptVisitor(store, createFqn(funcName), ecmaFunc);
-		relationCreator.map((a) -> a.createRelation(ctx, rootComp, ecmaFunc));
 		ctx.children.forEach((c) -> c.accept(subTreeVistor));
 		return VISITOR_DOES_NOT_GO_DEEPER_INTO_AST;
 	}
@@ -127,7 +115,6 @@ public Void visitMethodDefinition(MethodDefinitionContext ctx) {
 		FunctionDescriptor ecmaFunc = new FunctionStoreManipulator(funcName).createNodeIn(store, ctx, fqnCreator);
 		rootComp.getFunctions().add(ecmaFunc);
 		JavascriptVisitor subTreeVistor = new JavascriptVisitor(store, createFqn(funcName), ecmaFunc);
-		relationCreator.map((a) -> a.createRelation(ctx, rootComp, ecmaFunc));
 		ctx.children.forEach((c) -> c.accept(subTreeVistor));
 		return VISITOR_DOES_NOT_GO_DEEPER_INTO_AST;
 	}
@@ -154,8 +141,7 @@ public Void visitLiteral(LiteralContext ctx) {
 			rootComp.getLiterals().add(d);
 			d.setLine(ctx.getStart().getLine());
 			d.setFullQualifiedName(createFqn(Integer.toString(d.hashCode())));
-			// set relation
-			return relationCreator.map((a) -> a.createRelation(ctx, rootComp, d));
+			return d;
 		});
 
 		return super.visitLiteral(ctx);
@@ -164,19 +150,17 @@ public Void visitLiteral(LiteralContext ctx) {
 	@Override
 	public Void visitObjectLiteral(ObjectLiteralContext ctx) {
 		ObjectDescriptor ecmaObj = new ObjectStoreManipulator().createNodeIn(store, ctx, fqnCreator);
-		relationCreator.map((a) -> a.createRelation(ctx, rootComp, ecmaObj));
-		JavascriptVisitor subTreeVistor = new JavascriptVisitor(store,  fqnCreator.createFqn(ObjectDescriptor.OBJECT), ecmaObj, new ObjectDeclaresManipulator(store));
+		JavascriptVisitor subTreeVistor = new JavascriptVisitor(store,  fqnCreator.createFqn(ObjectDescriptor.OBJECT), ecmaObj);
 		ctx.children.forEach((c) -> c.accept(subTreeVistor));
 		return VISITOR_DOES_NOT_GO_DEEPER_INTO_AST;
 	}
 
 	@Override
 	public Void visitArrayLiteralExpression(ArrayLiteralExpressionContext ctx) {
 		ArrayDescriptor ecmaArray = new ArrayStoreManipulator().createNodeIn(store, ctx, fqnCreator);
-		relationCreator.map((a) -> a.createRelation(ctx, rootComp, ecmaArray));
 		rootComp.getObjects().add(ecmaArray);
 
-		JavascriptVisitor subTreeVistor = new JavascriptVisitor(store, fqnCreator.createFqn(ArrayDescriptor.ARRAY), ecmaArray, new ArrayDeclaresManipulator(store));
+		JavascriptVisitor subTreeVistor = new JavascriptVisitor(store, fqnCreator.createFqn(ArrayDescriptor.ARRAY), ecmaArray);
 		ctx.children.forEach((c) -> c.accept(subTreeVistor));
 		return VISITOR_DOES_NOT_GO_DEEPER_INTO_AST;
 	}
@@ -186,7 +170,6 @@ public Void visitClassDeclaration(ClassDeclarationContext ctx) {
 		ClassDescriptor ecmaClass = new ClassStoreManipulator().createNodeIn(store, ctx, fqnCreator);
 		rootComp.getClasses().add(ecmaClass);
 		JavascriptVisitor subTreeVistor = new JavascriptVisitor(store, fqnCreator.createFqn(ecmaClass.getName()), ecmaClass);
-		relationCreator.map((a) -> a.createRelation(ctx, rootComp, ecmaClass));
 		ctx.children.forEach((c) -> c.accept(subTreeVistor));
 		return VISITOR_DOES_NOT_GO_DEEPER_INTO_AST;
 	}
@@ -228,8 +211,7 @@ public Void visitArgumentsExpression(ArgumentsExpressionContext ctx) {
 						fd.setName(funcName);
 						return fd;
 					});
-					rootComp.getInvokes().add(func);
-					System.out.println(funcName);
+					new InvokesManipulator(store).createRelation(ctx, rootComp, func);
 			}
 		}
 
@@ -244,8 +226,6 @@ public Optional<FunctionDescriptor> findFunctioninStore(String funcName) {
 				  .map((String s) ->  Optional.ofNullable(store.find(FunctionDescriptor.class, s)))
 				  .filter((Optional<FunctionDescriptor> curFd) -> curFd.isPresent())
 				  .findFirst().orElse(Optional.empty());
-				 
-		
 	}