improving the implementation of the AbstractSmell class, removing rep…

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>edu.rit.se.testsmells</groupId>
     <artifactId>TestSmellDetector</artifactId>
-    <version>0.1</version>
+    <version>0.2</version>
     <build>
         <plugins>
             <plugin>

src/main/java/edu/rit/se/testsmells/AbstractSmell.java

@@ -0,0 +1,34 @@
+package edu.rit.se.testsmells;
+
+import com.github.javaparser.ast.CompilationUnit;
+
+import java.io.FileNotFoundException;
+import java.util.ArrayList;
+import java.util.List;
+
+public abstract class AbstractSmell {
+
+    protected List<SmellyElement> smellyElementList;
+
+    public AbstractSmell() {
+        smellyElementList = new ArrayList<>();
+    }
+
+    /**
+     * Returns true if any of the elements has a smell
+     */
+    public boolean getHasSmell() {
+        return smellyElementList.stream().filter(x -> x.getHasSmell()).count() >= 1;
+    }
+
+    /**
+     * Returns the set of analyzed elements (i.e. test methods)
+     */
+    public List<SmellyElement> getSmellyElements() {
+        return smellyElementList;
+    }
+
+    public abstract String getSmellName();
+
+    public abstract void runAnalysis(CompilationUnit testFileCompilationUnit,CompilationUnit productionFileCompilationUnit, String testFileName, String productionFileName) throws FileNotFoundException;
+}

src/main/java/Main.java → src/main/java/edu/rit/se/testsmells/Main.java

@@ -1,7 +1,4 @@
-import testsmell.AbstractSmell;
-import testsmell.ResultsWriter;
-import testsmell.TestFile;
-import testsmell.TestSmellDetector;
+package edu.rit.se.testsmells;
 
 import java.io.BufferedReader;
 import java.io.File;

src/main/java/testsmell/ResultsWriter.java → src/main/java/edu/rit/se/testsmells/ResultsWriter.java

@@ -1,4 +1,4 @@
-package testsmell;
+package edu.rit.se.testsmells;
 
 import java.io.FileWriter;
 import java.io.IOException;

src/main/java/testsmell/SmellyElement.java → src/main/java/edu/rit/se/testsmells/SmellyElement.java

@@ -1,4 +1,4 @@
-package testsmell;
+package edu.rit.se.testsmells;
 
 import java.util.Map;
 

src/main/java/testsmell/TestClass.java → src/main/java/edu/rit/se/testsmells/TestClass.java

@@ -1,4 +1,4 @@
-package testsmell;
+package edu.rit.se.testsmells;
 
 import java.util.HashMap;
 import java.util.Map;

src/main/java/testsmell/TestFile.java → src/main/java/edu/rit/se/testsmells/TestFile.java

@@ -1,4 +1,4 @@
-package testsmell;
+package edu.rit.se.testsmells;
 
 import org.apache.commons.lang3.StringUtils;
 

src/main/java/testsmell/TestMethod.java → src/main/java/edu/rit/se/testsmells/TestMethod.java

@@ -1,4 +1,4 @@
-package testsmell;
+package edu.rit.se.testsmells;
 
 import java.util.HashMap;
 import java.util.Map;

src/main/java/testsmell/TestSmellDetector.java → src/main/java/edu/rit/se/testsmells/TestSmellDetector.java

@@ -1,9 +1,9 @@
-package testsmell;
+package edu.rit.se.testsmells;
 
 import com.github.javaparser.JavaParser;
 import com.github.javaparser.ast.CompilationUnit;
 import org.apache.commons.lang3.StringUtils;
-import testsmell.smell.*;
+import edu.rit.se.testsmells.smell.*;
 
 import java.io.FileInputStream;
 import java.io.FileNotFoundException;

src/main/java/testsmell/Util.java → src/main/java/edu/rit/se/testsmells/Util.java

@@ -1,4 +1,4 @@
-package testsmell;
+package edu.rit.se.testsmells;
 
 import com.github.javaparser.ast.Modifier;
 import com.github.javaparser.ast.body.MethodDeclaration;

src/main/java/testsmell/smell/AssertionRoulette.java → src/main/java/edu/rit/se/testsmells/smell/AssertionRoulette.java

@@ -1,17 +1,14 @@
-package testsmell.smell;
+package edu.rit.se.testsmells.smell;
 
 import com.github.javaparser.ast.CompilationUnit;
 import com.github.javaparser.ast.body.MethodDeclaration;
 import com.github.javaparser.ast.expr.MethodCallExpr;
 import com.github.javaparser.ast.visitor.VoidVisitorAdapter;
-import testsmell.AbstractSmell;
-import testsmell.SmellyElement;
-import testsmell.TestMethod;
-import testsmell.Util;
+import edu.rit.se.testsmells.AbstractSmell;
+import edu.rit.se.testsmells.TestMethod;
+import edu.rit.se.testsmells.Util;
 
 import java.io.FileNotFoundException;
-import java.util.ArrayList;
-import java.util.List;
 
 /**
  * "Guess what's wrong?" This smell comes from having a number of assertions in a test method that have no explanation.
@@ -20,12 +17,6 @@
  */
 public class AssertionRoulette extends AbstractSmell {
 
-    private List<SmellyElement> smellyElementList;
-
-    public AssertionRoulette() {
-        smellyElementList = new ArrayList<>();
-    }
-
     /**
      * Checks of 'Assertion Roulette' smell
      */
@@ -34,14 +25,6 @@ public String getSmellName() {
         return "Assertion Roulette";
     }
 
-    /**
-     * Returns true if any of the elements has a smell
-     */
-    @Override
-    public boolean getHasSmell() {
-        return smellyElementList.stream().filter(x -> x.getHasSmell()).count() >= 1;
-    }
-
     /**
      * Analyze the test file for test methods for multiple assert statements without an explanation/message
      */
@@ -52,15 +35,6 @@ public void runAnalysis(CompilationUnit testFileCompilationUnit, CompilationUnit
         classVisitor.visit(testFileCompilationUnit, null);
     }
 
-    /**
-     * Returns the set of analyzed elements (i.e. test methods)
-     */
-    @Override
-    public List<SmellyElement> getSmellyElements() {
-        return smellyElementList;
-    }
-
-
     private class ClassVisitor extends VoidVisitorAdapter<Void> {
         private MethodDeclaration currentMethod = null;
         private int assertNoMessageCount = 0;

src/main/java/testsmell/smell/ConditionalTestLogic.java → src/main/java/edu/rit/se/testsmells/smell/ConditionalTestLogic.java

@@ -1,28 +1,20 @@
-package testsmell.smell;
+package edu.rit.se.testsmells.smell;
 
 import com.github.javaparser.ast.CompilationUnit;
 import com.github.javaparser.ast.body.MethodDeclaration;
 import com.github.javaparser.ast.expr.ConditionalExpr;
 import com.github.javaparser.ast.stmt.*;
 import com.github.javaparser.ast.visitor.VoidVisitorAdapter;
-import testsmell.AbstractSmell;
-import testsmell.SmellyElement;
-import testsmell.TestMethod;
-import testsmell.Util;
+import edu.rit.se.testsmells.AbstractSmell;
+import edu.rit.se.testsmells.TestMethod;
+import edu.rit.se.testsmells.Util;
 
 import java.io.FileNotFoundException;
-import java.util.ArrayList;
-import java.util.List;
 
 /*
 This class check a test method for the existence of loops and conditional statements in the methods body
  */
 public class ConditionalTestLogic extends AbstractSmell {
-    private List<SmellyElement> smellyElementList;
-
-    public ConditionalTestLogic() {
-        smellyElementList = new ArrayList<>();
-    }
 
     /**
      * Checks of 'Conditional Test Logic' smell
@@ -32,14 +24,6 @@ public String getSmellName() {
         return "Conditional Test Logic";
     }
 
-    /**
-     * Returns true if any of the elements has a smell
-     */
-    @Override
-    public boolean getHasSmell() {
-        return smellyElementList.stream().filter(x -> x.getHasSmell()).count() >= 1;
-    }
-
     /**
      * Analyze the test file for test methods that use conditional statements
      */
@@ -50,15 +34,6 @@ public void runAnalysis(CompilationUnit testFileCompilationUnit, CompilationUnit
         classVisitor.visit(testFileCompilationUnit, null);
     }
 
-    /**
-     * Returns the set of analyzed elements (i.e. test methods)
-     */
-    @Override
-    public List<SmellyElement> getSmellyElements() {
-        return smellyElementList;
-    }
-
-
     private class ClassVisitor extends VoidVisitorAdapter<Void> {
         private MethodDeclaration currentMethod = null;
         private int conditionCount, ifCount, switchCount, forCount, foreachCount, whileCount = 0;

src/main/java/testsmell/smell/ConstructorInitialization.java → src/main/java/edu/rit/se/testsmells/smell/ConstructorInitialization.java

@@ -1,17 +1,14 @@
-package testsmell.smell;
+package edu.rit.se.testsmells.smell;
 
 import com.github.javaparser.ast.CompilationUnit;
 import com.github.javaparser.ast.body.ClassOrInterfaceDeclaration;
 import com.github.javaparser.ast.body.ConstructorDeclaration;
 import com.github.javaparser.ast.type.ClassOrInterfaceType;
 import com.github.javaparser.ast.visitor.VoidVisitorAdapter;
-import testsmell.AbstractSmell;
-import testsmell.SmellyElement;
-import testsmell.TestClass;
+import edu.rit.se.testsmells.AbstractSmell;
+import edu.rit.se.testsmells.TestClass;
 
 import java.io.FileNotFoundException;
-import java.util.ArrayList;
-import java.util.List;
 
 
 /*
@@ -20,13 +17,8 @@ This class checks if the code file contains a Constructor. Ideally, the test sui
  */
 public class ConstructorInitialization extends AbstractSmell {
 
-    private List<SmellyElement> smellyElementList;
     private String testFileName;
 
-    public ConstructorInitialization() {
-        smellyElementList = new ArrayList<>();
-    }
-
     /**
      * Checks of 'Constructor Initialization' smell
      */
@@ -35,14 +27,6 @@ public String getSmellName() {
         return "Constructor Initialization";
     }
 
-    /**
-     * Returns true if any of the elements has a smell
-     */
-    @Override
-    public boolean getHasSmell() {
-        return smellyElementList.stream().filter(x -> x.getHasSmell()).count() >= 1;
-    }
-
     /**
      * Analyze the test file for Constructor Initialization smell
      */
@@ -54,15 +38,6 @@ public void runAnalysis(CompilationUnit testFileCompilationUnit,CompilationUnit
         classVisitor.visit(testFileCompilationUnit, null);
     }
 
-    /**
-     * Returns the set of analyzed elements (i.e. test methods)
-     */
-    @Override
-    public List<SmellyElement> getSmellyElements() {
-        return smellyElementList;
-    }
-
-
     private class ClassVisitor extends VoidVisitorAdapter<Void> {
         TestClass testClass;
         boolean constructorAllowed=false;

src/main/java/testsmell/smell/DefaultTest.java → src/main/java/edu/rit/se/testsmells/smell/DefaultTest.java

@@ -1,28 +1,19 @@
-package testsmell.smell;
+package edu.rit.se.testsmells.smell;
 
 import com.github.javaparser.ast.CompilationUnit;
 import com.github.javaparser.ast.body.ClassOrInterfaceDeclaration;
 import com.github.javaparser.ast.visitor.VoidVisitorAdapter;
-import testsmell.AbstractSmell;
-import testsmell.SmellyElement;
-import testsmell.TestClass;
+import edu.rit.se.testsmells.AbstractSmell;
+import edu.rit.se.testsmells.TestClass;
 
 import java.io.FileNotFoundException;
-import java.util.ArrayList;
-import java.util.List;
 
 /*
 By default Android Studio creates default test classes when a project is created. These classes are meant to serve as an example for developers when wring unit tests
 This code marks the class as smelly if the class name corresponds to the name of the default test classes
  */
 public class DefaultTest extends AbstractSmell {
 
-    private List<SmellyElement> smellyElementList;
-
-    public DefaultTest() {
-        smellyElementList = new ArrayList<>();
-    }
-
     /**
      * Checks of 'Default Test' smell
      */
@@ -31,29 +22,13 @@ public String getSmellName() {
         return "Default Test";
     }
 
-    /**
-     * Returns true if any of the elements has a smell
-     */
-    @Override
-    public boolean getHasSmell() {
-        return smellyElementList.stream().filter(x -> x.getHasSmell()).count() >= 1;
-    }
-
     @Override
     public void runAnalysis(CompilationUnit testFileCompilationUnit,CompilationUnit productionFileCompilationUnit, String testFileName, String productionFileName) throws FileNotFoundException {
         DefaultTest.ClassVisitor classVisitor;
         classVisitor = new DefaultTest.ClassVisitor();
         classVisitor.visit(testFileCompilationUnit, null);
     }
 
-    /**
-     * Returns the set of analyzed elements (i.e. test methods)
-     */
-    @Override
-    public List<SmellyElement> getSmellyElements() {
-        return smellyElementList;
-    }
-
     private class ClassVisitor extends VoidVisitorAdapter<Void> {
         TestClass testClass;