feature #64: Track doc changes (Ydocchange)

- Add a new change type Ydocchange which extends Ysignaturechange - Rename everywhere reference of *javaDoc* -> Doc to keep things consistent with python and typescript implementation TODO list: - Implement `getInitialDoc` in `com/felixgrund/codeshovel/parser/impl/PythonFunction.java` - Implement `getInitialDoc` in `com/felixgrund/codeshovel/parser/impl/TypeScriptFunction.java` - Handle `Ydocchange` in `src/main/java/com/felixgrund/codeshovel/parser/impl/TypeScriptParser.java` - Handle `Ydocchange` in `src/main/java/com/felixgrund/codeshovel/parser/impl/PythonParser.java` - Get the diff for doc changes
ataraxie · Feb 23, 2021 · 0d642eb · 0d642eb
1 parent 3ce998e
commit 0d642eb
Show file tree

Hide file tree

Showing 15 changed files with 59 additions and 21 deletions.
diff --git a/src/main/java/com/felixgrund/codeshovel/changes/Ycomparefunctionchange.java b/src/main/java/com/felixgrund/codeshovel/changes/Ycomparefunctionchange.java
@@ -78,7 +78,7 @@ public JsonObject toJsonObject() {
 		obj.addProperty("functionStartLine", newFunction.getNameLineNumber());
 		obj.addProperty("functionName", newFunction.getName());
 		obj.addProperty("functionAnnotation", newFunction.getAnnotation());
-		obj.addProperty("functionJavaDoc", newFunction.getJavaDoc());
+		obj.addProperty("functionDoc", newFunction.getFunctionDoc());
 		obj.addProperty("diff", getDiffAsString());
 		obj.add("extendedDetails", getExtendedDetailsJsonObject());
 		return obj;

diff --git a/src/main/java/com/felixgrund/codeshovel/changes/Ydocchange.java b/src/main/java/com/felixgrund/codeshovel/changes/Ydocchange.java
@@ -0,0 +1,21 @@
+package com.felixgrund.codeshovel.changes;
+
+import com.felixgrund.codeshovel.parser.Yfunction;
+import com.felixgrund.codeshovel.wrappers.StartEnvironment;
+
+public class Ydocchange extends  Ysignaturechange{
+
+    public Ydocchange(StartEnvironment startEnv, Yfunction newFunction, Yfunction oldFunction) {
+        super(startEnv, newFunction, oldFunction);
+    }
+
+    @Override
+    protected Object getOldValue() {
+        return oldFunction.getFunctionDoc();
+    }
+
+    @Override
+    protected Object getNewValue() {
+        return newFunction.getFunctionDoc();
+    }
+}
diff --git a/src/main/java/com/felixgrund/codeshovel/changes/Yintroduced.java b/src/main/java/com/felixgrund/codeshovel/changes/Yintroduced.java
@@ -42,7 +42,7 @@ public JsonObject toJsonObject() {
 		obj.addProperty("functionStartLine", newFunction.getNameLineNumber());
 		obj.addProperty("functionName", newFunction.getName());
 		obj.addProperty("functionAnnotation", newFunction.getAnnotation());
-		obj.addProperty("functionJavaDoc", newFunction.getJavaDoc());
+		obj.addProperty("functionDoc", newFunction.getFunctionDoc());
 		return obj;
 	}
 

diff --git a/src/main/java/com/felixgrund/codeshovel/execution/ShovelExecution.java b/src/main/java/com/felixgrund/codeshovel/execution/ShovelExecution.java
@@ -101,7 +101,7 @@ private static Yresult runForMethod(StartEnvironment startEnv, String filePath,
 		task.setFunctionName(name);
 		task.setFunctionStartLine(lineNumber);
 		task.setFunctionAnnotation(method.getAnnotation());
-		task.setFunctionJavaDoc(method.getJavaDoc());
+		task.setFunctionDoc(method.getFunctionDoc());
 
 		RecursiveAnalysisTask recursiveAnalysisTask = new RecursiveAnalysisTask(startEnv, task);
 		recursiveAnalysisTask.run();

diff --git a/src/main/java/com/felixgrund/codeshovel/json/JsonResult.java b/src/main/java/com/felixgrund/codeshovel/json/JsonResult.java
@@ -23,7 +23,7 @@ public class JsonResult {
 	private String functionId;
 	private String sourceFilePath;
 	private String functionAnnotation;
-	private String functionJavaDoc;
+	private String functionDoc;
 	private int functionStartLine;
 	private int functionEndLine;
 	private int numCommitsSeen;
@@ -47,7 +47,7 @@ public JsonResult(String origin, AnalysisTask startTask, List<String> changeHist
 		this.functionName = startTask.getFunctionName();
 		this.functionStartLine = startTask.getFunctionStartLine();
 		this.functionAnnotation = startTask.getFunctionAnnotation();
-		this.functionJavaDoc = startTask.getFunctionJavaDoc();
+		this.functionDoc = startTask.getFunctionDoc();
 		this.functionEndLine = startTask.getFunctionEndLine();
 		this.functionId = startTask.getStartFunction().getId();
 

diff --git a/src/main/java/com/felixgrund/codeshovel/parser/AbstractFunction.java b/src/main/java/com/felixgrund/codeshovel/parser/AbstractFunction.java
@@ -48,8 +48,8 @@ public abstract class AbstractFunction<E> implements Yfunction {
 	private String annotation;
 	protected abstract String getInitialAnnotation(E rawMethod);
 	private String sourceFragment;
-	private String javaDoc;
-	protected abstract String getInitialJavaDoc(E rawMethod);
+	private String functionDoc;
+	protected abstract String getInitialDoc(E rawMethod);
 
 	public AbstractFunction(E rawMethod, Commit commit, String sourceFilePath, String sourceFileContent) {
 		this.commit = commit;
@@ -72,7 +72,7 @@ public AbstractFunction(E rawMethod, Commit commit, String sourceFilePath, Strin
 		this.returnStmt = getInitialReturnStmt(rawMethod); // Must be called after getInitialType
 		this.annotation = getInitialAnnotation(rawMethod);
 		this.sourceFragment = getInitialSourceFragment(rawMethod); // Must be called after begin/endLine
-		this.javaDoc = getInitialJavaDoc(rawMethod);
+		this.functionDoc = getInitialDoc(rawMethod);
 	}
 
 	protected String getIdParameterString() {
@@ -205,7 +205,7 @@ public String getAnnotation() {
 	}
 
 	@Override
-	public String getJavaDoc() {
-		return this.javaDoc;
+	public String getFunctionDoc() {
+		return this.functionDoc;
 	}
 }
diff --git a/src/main/java/com/felixgrund/codeshovel/parser/AbstractParser.java b/src/main/java/com/felixgrund/codeshovel/parser/AbstractParser.java
@@ -44,6 +44,16 @@ public AbstractParser(StartEnvironment startEnv, String filePath, String fileCon
 
     protected abstract List<Yfunction> parseMethods() throws ParseException;
 
+    protected Ydocchange getDocChange(Ycommit commit, Yfunction compareFunction) {
+        Ydocchange ret = null;
+        String docA = compareFunction.getFunctionDoc();
+        String docB = commit.getMatchedFunction().getFunctionDoc();
+        if(!docA.equals(docB)) {
+            ret = new Ydocchange(this.startEnv, commit.getMatchedFunction(), compareFunction);
+        }
+        return ret;
+    }
+
     protected Yannotationchange getAnnotationChange(Ycommit commit, Yfunction compareFunction) {
         Yannotationchange ret = null;
         String annotationA = compareFunction.getAnnotation();

diff --git a/src/main/java/com/felixgrund/codeshovel/parser/Yfunction.java b/src/main/java/com/felixgrund/codeshovel/parser/Yfunction.java
@@ -107,6 +107,6 @@ public interface Yfunction {
 	/**
 	 * @return java documentation of a method if present
 	 * */
-	String getJavaDoc();
+	String getFunctionDoc();
 
 }
diff --git a/src/main/java/com/felixgrund/codeshovel/parser/impl/JavaFunction.java b/src/main/java/com/felixgrund/codeshovel/parser/impl/JavaFunction.java
@@ -200,7 +200,7 @@ private boolean isNestedMethod(MethodDeclaration method) {
 	}
 
 	@Override
-	protected String getInitialJavaDoc(MethodDeclaration method) {
-		return method.hasJavaDocComment() ? method.getJavadoc().get().toText() : null ;
+	protected String getInitialDoc(MethodDeclaration method) {
+		return method.hasJavaDocComment() ? method.getJavadoc().get().toText() : "" ;
 	}
 }
diff --git a/src/main/java/com/felixgrund/codeshovel/parser/impl/JavaParser.java b/src/main/java/com/felixgrund/codeshovel/parser/impl/JavaParser.java
@@ -73,6 +73,8 @@ public List<Ychange> getMinorChanges(Ycommit commit, Yfunction compareFunction)
         Ybodychange ybodychange = getBodyChange(commit, compareFunction);
         Yparametermetachange yparametermetachange = getParametersMetaChange(commit, compareFunction);
         Yannotationchange yannotationchange = getAnnotationChange(commit, compareFunction);
+        Ydocchange ydocchange = getDocChange(commit, compareFunction);
+
         if (yreturntypechange != null) {
             changes.add(yreturntypechange);
         }
@@ -91,6 +93,9 @@ public List<Ychange> getMinorChanges(Ycommit commit, Yfunction compareFunction)
         if (yannotationchange != null) {
             changes.add(yannotationchange);
         }
+        if (ydocchange != null) {
+            changes.add(ydocchange);
+        }
         return changes;
     }
 

diff --git a/src/main/java/com/felixgrund/codeshovel/parser/impl/PythonFunction.java b/src/main/java/com/felixgrund/codeshovel/parser/impl/PythonFunction.java
@@ -156,7 +156,7 @@ protected String getInitialAnnotation(PythonParser.FuncdefContext rawMethod) {
     }
 
     @Override
-    protected String getInitialJavaDoc(PythonParser.FuncdefContext rawMethod) {
+    protected String getInitialDoc(PythonParser.FuncdefContext rawMethod) {
         // TODO: implement function for python
         return null;
     }

diff --git a/src/main/java/com/felixgrund/codeshovel/parser/impl/PythonParser.java b/src/main/java/com/felixgrund/codeshovel/parser/impl/PythonParser.java
@@ -71,6 +71,7 @@ public List<Ychange> getMinorChanges(Ycommit commit, Yfunction compareFunction)
         Ybodychange ybodychange = getBodyChange(commit, compareFunction);
         Ymodifierchange ymodifierchange = getModifiersChange(commit, compareFunction);
         Yannotationchange yannotationchange = getAnnotationChange(commit, compareFunction);
+        // TODO handle Ydocchange
 
         if (yparametermetachange != null) {
             changes.add(yparametermetachange);

diff --git a/src/main/java/com/felixgrund/codeshovel/parser/impl/TypeScriptFunction.java b/src/main/java/com/felixgrund/codeshovel/parser/impl/TypeScriptFunction.java
@@ -161,7 +161,7 @@ protected String getInitialAnnotation(V8Object rawMethod) {
     }
 
     @Override
-    protected String getInitialJavaDoc(V8Object rawMethod) {
+    protected String getInitialDoc(V8Object rawMethod) {
         // TODO: implement function for typescript
         return null;
     }

diff --git a/src/main/java/com/felixgrund/codeshovel/parser/impl/TypeScriptParser.java b/src/main/java/com/felixgrund/codeshovel/parser/impl/TypeScriptParser.java
@@ -61,6 +61,7 @@ public List<Ychange> getMinorChanges(Ycommit commit, Yfunction compareFunction)
         Ymodifierchange ymodifierchange = getModifiersChange(commit, compareFunction);
         Ybodychange ybodychange = getBodyChange(commit, compareFunction);
         Yannotationchange yannotationchange = getAnnotationChange(commit, compareFunction);
+        // TODO: handle Ydocchange
         if (yreturntypechange != null) {
             changes.add(yreturntypechange);
         }

diff --git a/src/main/java/com/felixgrund/codeshovel/tasks/AnalysisTask.java b/src/main/java/com/felixgrund/codeshovel/tasks/AnalysisTask.java
@@ -44,7 +44,7 @@ public class AnalysisTask {
 	private String functionAnnotation;
 	private int functionStartLine;
 	private int functionEndLine;
-	private String functionJavaDoc;
+	private String functionDoc;
 
 	private boolean wasBuilt;
 
@@ -84,7 +84,7 @@ public AnalysisTask(StartEnvironment startEnv, Yfunction oldFunction) throws Exc
 		this.setFunctionStartLine(oldFunction.getNameLineNumber());
 		this.setFunctionEndLine(oldFunction.getEndLineNumber());
 		this.setFunctionAnnotation(oldFunction.getAnnotation());
-		this.setFunctionJavaDoc(oldFunction.getJavaDoc());
+		this.setFunctionDoc(oldFunction.getFunctionDoc());
 		this.buildAndValidate();
 	}
 
@@ -342,11 +342,11 @@ public String getFunctionAnnotation() {
 		return functionAnnotation;
 	}
 
-	public String getFunctionJavaDoc() {
-		return functionJavaDoc;
+	public String getFunctionDoc() {
+		return functionDoc;
 	}
 
-	public void setFunctionJavaDoc(String functionJavaDoc) {
-		this.functionJavaDoc = functionJavaDoc;
+	public void setFunctionDoc(String functionDoc) {
+		this.functionDoc = functionDoc;
 	}
 }