Merge pull request #84 from Siva-2707/chore/refactoring

chore: Refactor to solve smells
tushartushar · Dec 31, 2024 · 47fb30c · 47fb30c
2 parents 3c99396 + afa4661
commit 47fb30c
Show file tree

Hide file tree

Showing 17 changed files with 407 additions and 266 deletions.
diff --git a/src/Designite/SourceModel/Parsable.java b/src/Designite/SourceModel/Parsable.java
@@ -0,0 +1,5 @@
+package Designite.SourceModel;
+
+public interface Parsable {
+    void parse();
+}
diff --git a/src/Designite/SourceModel/SM_EntitiesWithType.java b/src/Designite/SourceModel/SM_EntitiesWithType.java
@@ -54,8 +54,8 @@ public String getTypeOverallToString() {
 //			return "generic";
 	}
 
-	@Override
-	public void parse() {
-		
-	}
+//	@Override
+//	public void parse() {
+//
+//	}
 }
diff --git a/src/Designite/SourceModel/SM_Method.java b/src/Designite/SourceModel/SM_Method.java
@@ -17,7 +17,7 @@
 import Designite.visitors.InstanceOfVisitor;
 import Designite.visitors.ThrowVisitor;
 
-public class SM_Method extends SM_SourceItem implements Vertex {
+public class SM_Method extends SM_SourceItem implements Vertex, Parsable {
 
 	private boolean abstractMethod;
 	private boolean finalMethod;
@@ -103,17 +103,56 @@ public MethodDeclaration getMethodDeclaration() {
 		return methodDeclaration;
 	}
 
-	private void parseParameters() {
-		for (SM_Parameter param : parameterList) {
-			param.parse();
+	private void prepareCalledMethodsList() {
+		MethodInvVisitor invVisitor = new MethodInvVisitor(methodDeclaration);
+		methodDeclaration.accept(invVisitor);
+		List<MethodInvocation> invList = invVisitor.getCalledMethods();
+		if (invList.size() > 0) {
+			calledMethods.addAll(invList);
 		}
 	}
 
-	private void parseLocalVar() {
-		for (SM_LocalVar var : localVarList) {
-			var.parse();
+	private void prepareInstanceOfVisitorList() {
+		InstanceOfVisitor instanceOfVisitor = new InstanceOfVisitor();
+		methodDeclaration.accept(instanceOfVisitor);
+		List<Type> instanceOfTypes = instanceOfVisitor.getTypesInInstanceOf();
+		if (instanceOfTypes.size() > 0) {
+			typesInInstanceOf.addAll(instanceOfTypes);
+		}
+	}
+
+	private void prepareParametersList(SingleVariableDeclaration var) {
+		VariableVisitor parameterVisitor = new VariableVisitor(this);
+		// methodDeclaration.accept(parameterVisitor);
+		var.accept(parameterVisitor);
+		List<SM_Parameter> pList = parameterVisitor.getParameterList();
+		if (pList.size() > 0) {
+			parameterList.addAll(pList);
+		}
+	}
+
+	//SM_Parameter uses an empty parse method. So commenting this.
+//	private void parseParameters() {
+//		for (SM_Parameter param : parameterList) {
+//			param.parse();
+//		}
+//	}
+
+	private void prepareLocalVarList() {
+		LocalVarVisitor localVarVisitor = new LocalVarVisitor(this);
+		methodDeclaration.accept(localVarVisitor);
+		List<SM_LocalVar> lList = localVarVisitor.getLocalVarList();
+		if (lList.size() > 0) {
+			localVarList.addAll(lList);
 		}
 	}
+
+//SM_LocalVar inherits SM_EntitiesWithType which inter uses an empty parse method. So, commenting this.
+//	private void parseLocalVar() {
+//		for (SM_LocalVar var : localVarList) {
+//			var.parse();
+//		}
+//	}
 
 	public String getMethodBody() {
 		if (this.hasBody())
@@ -145,32 +184,16 @@ public void printDebugLog(PrintWriter writer) {
 	//TODO: Modularize parser with private functions
 	@Override
 	public void parse() {
-		MethodInvVisitor invVisitor = new MethodInvVisitor(methodDeclaration);
-		methodDeclaration.accept(invVisitor);
-		List<MethodInvocation> invList = invVisitor.getCalledMethods();
-		if (invList.size() > 0) {
-			calledMethods.addAll(invList);
-		}
+		prepareCalledMethodsList();
 
 		List<SingleVariableDeclaration> variableList = methodDeclaration.parameters();
 		for (SingleVariableDeclaration var : variableList) {
-			VariableVisitor parameterVisitor = new VariableVisitor(this);
-			// methodDeclaration.accept(parameterVisitor);
-			var.accept(parameterVisitor);
-			List<SM_Parameter> pList = parameterVisitor.getParameterList();
-			if (pList.size() > 0) {
-				parameterList.addAll(pList);
-			}
-			parseParameters();
+			prepareParametersList(var);
+//			parseParameters();
 		}
 
-		LocalVarVisitor localVarVisitor = new LocalVarVisitor(this);
-		methodDeclaration.accept(localVarVisitor);
-		List<SM_LocalVar> lList = localVarVisitor.getLocalVarList();
-		if (lList.size() > 0) {
-			localVarList.addAll(lList);
-		}
-		parseLocalVar();
+		prepareLocalVarList();
+//		parseLocalVar();
 
 		DirectAceessFieldVisitor directAceessFieldVisitor = new DirectAceessFieldVisitor();
 		methodDeclaration.accept(directAceessFieldVisitor);
@@ -182,14 +205,8 @@ public void parse() {
 		if (thisAccesses.size() > 0) {
 			thisAccessesInMethod.addAll(thisAccesses);
 		}
-
-		InstanceOfVisitor instanceOfVisitor = new InstanceOfVisitor();
-		methodDeclaration.accept(instanceOfVisitor);
-		List<Type> instanceOfTypes = instanceOfVisitor.getTypesInInstanceOf();
-		if (instanceOfTypes.size() > 0) {
-			typesInInstanceOf.addAll(instanceOfTypes);
-		}
-
+		prepareInstanceOfVisitorList();
+
 		ThrowVisitor throwVisithor = new ThrowVisitor();
 		methodDeclaration.accept(throwVisithor);
 		throwsException = throwVisithor.throwsException();

diff --git a/src/Designite/SourceModel/SM_Package.java b/src/Designite/SourceModel/SM_Package.java
@@ -7,6 +7,7 @@
 import java.util.List;
 import java.util.Map;
 
+import Designite.metrics.TypeMetricsExtractor;
 import org.eclipse.jdt.core.dom.CompilationUnit;
 
 import Designite.InputArgs;
@@ -17,7 +18,7 @@
 import Designite.utils.Constants;
 import Designite.utils.models.Edge;
 
-public class SM_Package extends SM_SourceItem {
+public class SM_Package extends SM_SourceItem implements Parsable{
 	private List<CompilationUnit> compilationUnitList;
 	private List<SM_Type> typeList = new ArrayList<>();
 	private SM_Project parentProject;
@@ -117,8 +118,7 @@ public void resolve() {
 	public void extractTypeMetrics() {
 		for (SM_Type type : typeList) {
 			type.extractMethodMetrics();
-			TypeMetrics metrics = new TypeMetrics(type);
-			metrics.extractMetrics();
+			TypeMetrics metrics = new TypeMetricsExtractor(type).extractMetrics();
 			metricsMapping.put(type, metrics);
 			exportMetricsToCSV(metrics, type.getName());
 			updateDependencyGraph(type);

diff --git a/src/Designite/SourceModel/SM_Parameter.java b/src/Designite/SourceModel/SM_Parameter.java
@@ -58,9 +58,9 @@ public String toString() {
 				+ ", is=" + getTypeBinding().getNodeType();
 	}
 
-	@Override
-	public void parse() {
-		
-	}
+//	@Override
+//	public void parse() {
+//
+//	}
 
 }
diff --git a/src/Designite/SourceModel/SM_Project.java b/src/Designite/SourceModel/SM_Project.java
@@ -20,7 +20,7 @@
 import Designite.utils.Logger;
 import Designite.utils.models.Graph;
 
-public class SM_Project extends SM_SourceItem {
+public class SM_Project extends SM_SourceItem implements Parsable {
 
 	private InputArgs inputArgs;
 	private List<String> sourceFileList;

diff --git a/src/Designite/SourceModel/SM_SourceItem.java b/src/Designite/SourceModel/SM_SourceItem.java
@@ -19,7 +19,7 @@ public abstract class SM_SourceItem {
 	/**
 	 * This is the first pass of parsing a source code entity.
 	 */
-	public abstract void parse();
+//	public abstract void parse();
 
 	/**
 	 * This method establishes relationships among source-code entities. Such

diff --git a/src/Designite/SourceModel/SM_Type.java b/src/Designite/SourceModel/SM_Type.java
@@ -7,6 +7,7 @@
 import java.util.List;
 import java.util.Map;
 
+import Designite.metrics.MethodMetricsExtractor;
 import org.eclipse.jdt.core.dom.CompilationUnit;
 import org.eclipse.jdt.core.dom.ImportDeclaration;
 import org.eclipse.jdt.core.dom.Modifier;
@@ -25,7 +26,7 @@
 import Designite.visitors.StaticFieldAccessVisitor;
 
 //TODO check EnumDeclaration, AnnotationTypeDeclaration and nested classes
-public class SM_Type extends SM_SourceItem implements Vertex {
+public class SM_Type extends SM_SourceItem implements Vertex, Parsable {
 
 
 	private boolean isAbstract = false;
@@ -221,11 +222,12 @@ private void parseMethods() {
 		}
 	}
 
-	private void parseFields() {
-		for (SM_Field field : fieldList) {
-			field.parse();
-		}
-	}
+	//SM_Field inherits SM_EntitiesWithType which inter uses an empty parse method. So, commenting this.
+//	private void parseFields() {
+//		for (SM_Field field : fieldList) {
+//			field.parse();
+//		}
+//	}
 
 	@Override
 	public void printDebugLog(PrintWriter writer) {
@@ -263,7 +265,7 @@ public void parse() {
 		List<SM_Field> fList = fieldVisitor.getFields();
 		if (fList.size() > 0)
 			fieldList.addAll(fList);
-		parseFields();
+//		parseFields();
 
 		StaticFieldAccessVisitor fieldAccessVisitor = new StaticFieldAccessVisitor();
 		typeDeclaration.accept(fieldAccessVisitor);
@@ -349,8 +351,7 @@ private void addUniqueReference(SM_Type type, SM_Type typeToAdd, boolean invardR
 
 	public void extractMethodMetrics() {
 		for (SM_Method method : methodList) {
-			MethodMetrics metrics = new MethodMetrics(method);
-			metrics.extractMetrics();
+			MethodMetrics metrics = new MethodMetricsExtractor(method).extractMetrics();
 			metricsMapping.put(method, metrics);
 			exportMethodMetricsToCSV(metrics, method.getName());
 		}

diff --git a/src/Designite/SourceModel/TypeInfo.java b/src/Designite/SourceModel/TypeInfo.java
@@ -11,6 +11,8 @@ public class TypeInfo {
 	private boolean parametrizedType;
 	private List<SM_Type> nonPrimitiveTypeParameters = new ArrayList<>();
 
+	private static final int COMMA_LENGTH = 2;
+
 	public SM_Type getTypeObj() {
 		return typeObj;
 	}
@@ -56,7 +58,7 @@ public String getStringOfNonPrimitiveParameters() {
 	}
 
 	private String removeLastComma(String str) {
-		return (str.length() > 2) ? str.substring(0, str.length() - 2) : str;
+		return (str.length() > COMMA_LENGTH) ? str.substring(0, str.length() - COMMA_LENGTH) : str;
 	}
 
 	public int getNumOfNonPrimitiveParameters() {

diff --git a/src/Designite/metrics/MethodMetrics.java b/src/Designite/metrics/MethodMetrics.java
@@ -5,60 +5,14 @@
 import Designite.SourceModel.SM_Field;
 import Designite.SourceModel.SM_Method;
 import Designite.SourceModel.SM_Type;
-import Designite.visitors.MethodControlFlowVisitor;
 
-public class MethodMetrics implements MetricExtractor {
+public class MethodMetrics extends Metrics {
 
 	private int numOfParameters;
 	private int cyclomaticComplexity;
 	private int numOfLines;
-
 	private SM_Method method;
-
-	public MethodMetrics(SM_Method method) {
-		this.method = method;
-	}
-
-	@Override
-	public void extractMetrics() {
-		extractNumOfParametersMetrics();
-		extractCyclomaticComplexity();
-		extractNumberOfLines();
-	}
-
-	private void extractNumOfParametersMetrics() {
-		numOfParameters = method.getParameterList().size();
-	}
-
-	private void extractCyclomaticComplexity() {
-		cyclomaticComplexity = calculateCyclomaticComplexity();
-	}
-
-	private int calculateCyclomaticComplexity() {
-		MethodControlFlowVisitor visitor = new MethodControlFlowVisitor();
-		method.getMethodDeclaration().accept(visitor);
-		return visitor.getNumOfIfStatements()
-			 + visitor.getNumOfSwitchCaseStatementsWitoutDefault()
-			 + visitor.getNumOfForStatements()
-			 + visitor.getNumOfWhileStatements()
-		     + visitor.getNumOfDoStatements()
-			 + visitor.getNumOfForeachStatements()
-			 + 1;
-	}
-
-	private void extractNumberOfLines() {
-		if (methodHasBody()) {
-			String body = method.getMethodDeclaration().getBody().toString();
-			int length = body.length();
-//			long newlines = body.lines().count();
-			numOfLines = length - body.replace("\n", "").length();
-		}
-	}
-
-	private boolean methodHasBody() {
-		return method.getMethodDeclaration().getBody() != null;
-	}
-
+
 	public int getNumOfParameters() {
 		return numOfParameters;
 	}
@@ -71,16 +25,32 @@ public int getNumOfLines() {
 		return numOfLines;
 	}
 
+	public void setNumOfParameters(int numOfParameters) {
+		this.numOfParameters = numOfParameters;
+	}
+
+	public void setCyclomaticComplexity(int cyclomaticComplexity) {
+		this.cyclomaticComplexity = cyclomaticComplexity;
+	}
+
+	public void setNumOfLines(int numOfLines) {
+		this.numOfLines = numOfLines;
+	}
+
+	public void setMethod(SM_Method method){
+		this.method = method;
+	}
+
+	public SM_Method getMethod() {
+		return method;
+	}
+
 	public List<SM_Field> getDirectFieldAccesses() {
 		return method.getDirectFieldAccesses();
 	}
-	
+
 	public List<SM_Type> getSMTypesInInstanceOf() {
 		return method.getSMTypesInInstanceOf();
 	}
-
-	public SM_Method getMethod() {
-		return method;
-	}
 
 }