Merge pull request #19 from refactoring-ai/feature/CommitCount

Feature/commit count

Author: jan-gerling

src/main/java/refactoringml/App.java

@@ -140,6 +140,7 @@ public Project run () throws Exception {
 			log.info("Start mining project " + gitUrl + "(clone at " + clonePath + ")");
 
 			boolean firstCommitFound = firstCommitToProcess == null;
+			int commitNumber = 1;
 			// we only analyze commits that have one parent or the first commit with 0 parents
 			for (boolean endFound = false; currentCommit!=null && !endFound; currentCommit = walk.next()) {
 				String commitHash = currentCommit.getId().getName();
@@ -158,7 +159,8 @@ public Project run () throws Exception {
 				if (currentCommit.getParentCount() > 1)
 					continue;
 
-				processCommit(currentCommit, miner, handler, refactoringAnalyzer, processMetrics);
+				processCommit(currentCommit, commitNumber, miner, handler, refactoringAnalyzer, processMetrics);
+				commitNumber += 1;
 			}
 			walk.close();
 
@@ -207,7 +209,7 @@ private Project initProject(Git git) throws GitAPIException, IOException {
 				numberOfCommits, getProperty("stableCommitThresholds"), lastCommitHash, counterResult, projectSize);
 	}
 
-	private void processCommit(RevCommit currentCommit, GitHistoryRefactoringMiner miner, RefactoringHandler handler, RefactoringAnalyzer refactoringAnalyzer, ProcessMetricsCollector processMetrics){
+	private void processCommit(RevCommit currentCommit, int commitNumber, GitHistoryRefactoringMiner miner, RefactoringHandler handler, RefactoringAnalyzer refactoringAnalyzer, ProcessMetricsCollector processMetrics){
 		long startCommitTime = System.currentTimeMillis();
 		String commitHash = currentCommit.getId().getName();
 		try{
@@ -219,7 +221,7 @@ private void processCommit(RevCommit currentCommit, GitHistoryRefactoringMiner m
 			//stores all the ck metrics for the current commit
 			List<RefactoringCommit> allRefactoringCommits = new ArrayList<>();
 			// stores the commit meta data
-			CommitMetaData superCommitMetaData = new CommitMetaData(currentCommit, project);
+			CommitMetaData superCommitMetaData = new CommitMetaData(currentCommit, commitNumber, project);
 			List<DiffEntry> entries = calculateDiffEntries(currentCommit);
 			// Note that we only run it if the commit has a parent, i.e, skip the first commit of the repo
 			if (!isFirst(currentCommit)){

src/main/java/refactoringml/ProcessMetricsCollector.java

@@ -141,7 +141,7 @@ private void collectProcessMetricsOfStableCommits(RevCommit commit, CommitMetaDa
 					if(pmTracker.getCommitCountThreshold() == project.getMaxCommitThreshold()){
 						log.debug("Reset pmTracker for class " + pmTracker.getFileName() + " with threshold: " + pmTracker.getCommitCountThreshold() +
 								" because it is the max threshold(" + project.getMaxCommitThreshold() + ").");
-						pmTracker.resetCounter(new CommitMetaData(commit, project));
+						pmTracker.resetCounter(new CommitMetaData(commit, superCommitMetaData.getCommitNumber(), project));
 					}
 				}
 			}

src/main/java/refactoringml/db/CommitMetaData.java

@@ -30,6 +30,9 @@ public class CommitMetaData {
     @Temporal(TemporalType.TIMESTAMP)
     private Calendar commitDate;
 
+    //Number of this commit (number of previous commits plus 1)
+    private int commitNumber;
+
     //id of the parent commit, if none exists:
     // the parent commit points to the commit that we calculate the code metrics
     // (we calculate the metrics in the version of file *before* the refactoring)
@@ -42,14 +45,16 @@ public class CommitMetaData {
     public CommitMetaData(String commitId, String fullMessage, String url, String parentId) {
         this.commitId = commitId.trim();
         this.commitDate = new GregorianCalendar();
+        this.commitNumber = -1;
         this.commitMessage = fullMessage.trim();
         this.commitUrl = url;
         this.parentCommitId = parentId.trim();
     }
 
-    public CommitMetaData(RevCommit commit, Project project){
+    public CommitMetaData(RevCommit commit, int commitNumber, Project project){
         this.commitId = commit.getName().trim();
         this.commitDate = JGitUtils.getGregorianCalendar(commit);
+        this.commitNumber = commitNumber;
         this.commitMessage = commit.getFullMessage().trim();
         this.commitUrl = JGitUtils.generateCommitUrl(project.getGitUrl(), commitId, project.isLocal());
         this.parentCommitId = commit.getParentCount() == 0 ? "Null" : commit.getParent(0).getName().trim();
@@ -67,11 +72,14 @@ public long getId() {
         return id;
     }
 
+    public int getCommitNumber(){ return commitNumber; }
+
     @Override
     public String toString() {
         return "CommitMetaData{" +
                 "commit=" + commitId +
                 ", commitDate=" + commitDate +
+                ", commitNumber=" + commitNumber +
                 ", commitMessage=" + commitMessage +
                 ", commitUrl=" + commitUrl +
                 ", parentCommit='" + parentCommitId + '\'' +

src/test/java/integration/IntegrationBaseTest.java

@@ -198,23 +198,24 @@ protected void assertStableCommit(List<StableCommit> stableCommitList, String...
 		Assert.assertEquals(stableCommits, assertCommits);
 	}
 
-	protected void assertMetaDataRefactoring(String commit, String commitMessage, String refactoringSummary, String commitUrl, String parentCommit){
+	protected void assertMetaDataRefactoring(String commit, String commitMessage, String refactoringSummary, String commitUrl, int commitNumber, String parentCommit){
 		RefactoringCommit refactoringCommit = (RefactoringCommit) filterCommit(getRefactoringCommits(), commit).get(0);
 
 		Assert.assertEquals(refactoringSummary, refactoringCommit.getRefactoringSummary());
-		assertMetaData(refactoringCommit.getCommitMetaData(), commitUrl, parentCommit, commitMessage);
+		assertMetaData(refactoringCommit.getCommitMetaData(), commitUrl, commitNumber, parentCommit, commitMessage);
 	}
 
-	protected void assertMetaDataStable(String commit, String commitUrl, String parentCommit, String commitMessage) {
+	protected void assertMetaDataStable(String commit, String commitUrl, int commitNumber, String parentCommit, String commitMessage) {
 		StableCommit stableCommit = (StableCommit) filterCommit(getStableCommits(), commit).get(0);
 
-		assertMetaData(stableCommit.getCommitMetaData(), commitUrl, parentCommit, commitMessage);
+		assertMetaData(stableCommit.getCommitMetaData(), commitUrl, commitNumber, parentCommit, commitMessage);
 	}
 
-	private void assertMetaData(CommitMetaData commitMetaData, String commitUrl, String parentCommit, String commitMessage){
+	private void assertMetaData(CommitMetaData commitMetaData, String commitUrl, int commitNumber, String parentCommit, String commitMessage){
 		Assert.assertEquals(commitUrl, commitMetaData.getCommitUrl());
 		Assert.assertEquals(parentCommit, commitMetaData.getParentCommitId());
 		Assert.assertEquals(commitMessage, commitMetaData.getCommitMessage());
+		Assert.assertEquals(commitNumber, commitMetaData.getCommitNumber());
 	}
 
 	protected void assertProcessMetrics(Instance instance, String truth) {

src/test/java/integration/realprojects/ApacheCommonsCliIntegrationTest.java

@@ -151,6 +151,7 @@ public void commitMetaDataRefactoring(){
 						"git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/cli/trunk@129803 13f79535-47bb-0310-9956-ffa450edef68",
 				"Extract Variable\tkey : String in method package setOpt(opt Option) : void from class org.apache.commons.cli.CommandLine",
 				"@local/repos/commons-cli/" + renameCommit,
+				37,
 				"469e71799a438ccb2d0925e50d4bb9dce37cdba2");
 
 		String moveCommit = "347bbeb8f98a49744501ac50850457ba8751d545";
@@ -162,6 +163,7 @@ public void commitMetaDataRefactoring(){
 						"git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/cli/trunk@129846 13f79535-47bb-0310-9956-ffa450edef68",
 				"Rename Parameter\topts : Options to options : Options in method public parse(options Options, arguments String[], stopAtNonOption boolean) : CommandLine in class org.apache.commons.cli.Parser",
 				"@local/repos/commons-cli/" + moveCommit,
+				76,
 				"3b8e3de5b7599a6165d48103f94f3a830361188d");
 	}
 
@@ -171,6 +173,7 @@ public void commitMetaDataStable(){
 		assertMetaDataStable(
 				stableCommit1,
 				"@local/repos/commons-cli/" + stableCommit1,
+				2,
 				"4868ac5e7c2afd428de74a6dcbec07dc6541a1ea",
 				"moved cli over from the sandbox to commons proper\n" +
 						"\n" +
@@ -181,6 +184,7 @@ public void commitMetaDataStable(){
 		assertMetaDataStable(
 				stableCommit2,
 				"@local/repos/commons-cli/" + stableCommit2,
+				39,
 				"dde69934d7f0bee13e4cd1fc99a7d60ce95a0c78",
 				"javadoc updates\n" +
 						"\n" +

src/test/java/integration/toyprojects/R1ToyProjectTest.java

@@ -7,6 +7,8 @@
 import org.junit.jupiter.api.TestInstance;
 import refactoringml.db.RefactoringCommit;
 
+import java.util.stream.Collectors;
+
 @TestInstance(TestInstance.Lifecycle.PER_CLASS)
 public class R1ToyProjectTest extends IntegrationBaseTest {
 
@@ -40,6 +42,7 @@ public void commitMetaData(){
 				"inline method",
 				"Inline Method\tprivate convert(a int) : int inlined to public m1() : void in class a.Example1",
 				"@local/repos/toyrepo-r1/" + commit,
+				6,
 				"a6d21e18c680431b0d4a09374e31a72144a728dc");
 	}
 

src/test/java/integration/toyprojects/R2ToyProjectTest.java

@@ -71,6 +71,7 @@ public void commitMetaData(){
 				"rename class",
 				"Rename Class\tPerson renamed to People",
 				"@local/repos/toyrepo-r2/" + commit,
+				2,
 				"d56acf6b23d646528b4b04779b0fe64d74811052");
 	}
 

src/test/java/integration/toyprojects/R3ToyProjectTest.java

@@ -77,6 +77,7 @@ public void stableCommits() {
 		assertMetaDataStable(
 				lastRefactoring,
 				"@local/repos/toyrepo-r3/" + lastRefactoring,
+				5,
 				"0e094a734239b1bcc6d6bce1436200c0e45b1e8d",
 				"rename");
 
@@ -112,16 +113,29 @@ public void stableThresholds() {
 	}
 
 	@Test
-	public void commitMetaData(){
+	public void commitMetaData1(){
 		String commit = "376304b51193e5fade802be2cbd7523d6a5ba664";
 		assertMetaDataRefactoring(
 				commit,
 				"Move and Rename Class testing",
 				"Move And Rename Class\tAnimal moved and renamed to inheritance.superinfo.AnimalSuper",
 				"@local/repos/toyrepo-r3/" + commit,
+				6,
 				"061febd820977f2b00c4926634f09908cc5b8b08");
 	}
 
+	@Test
+	public void commitMetaData2(){
+		String commit = "061febd820977f2b00c4926634f09908cc5b8b08";
+		assertMetaDataRefactoring(
+				commit,
+				"rename",
+				"Rename Parameter\tinfo : String to noise : String in method package abstract sound(noise String) : void in class Animal",
+				"@local/repos/toyrepo-r3/" + commit,
+				5,
+				"0e094a734239b1bcc6d6bce1436200c0e45b1e8d");
+	}
+
 	@Test
 	public void projectMetrics() {
 		assertProjectMetrics(3, 3, 0, 23, 23, 0);

src/test/java/integration/toyprojects/R4ToyProjectTest.java

@@ -151,6 +151,7 @@ public void commitMetaData(){
 				"extract method",
 				"Extract Method\tprivate print(a int, b int, c int) : void extracted from public bark() : void in class a.Animal.Dog",
 				"@local/repos/toyrepo-r4/" + commit,
+				2,
 				"4bab290609c8d60e96ad2fa094793edc2cba023a");
 	}
 

src/test/java/integration/toyprojects/R5ToyProjectTest.java

@@ -47,6 +47,7 @@ public void commitMetaData(){
 				"extract method",
 				"Extract Method\tprivate print2() : void extracted from public print() : void in class a.Test",
 				"@local/repos/toyrepo-r5/" + commit,
+				2,
 				"3f56031b1be69cb8db1779ef79645c2ab93a1616");
 	}