[#177] Add more default file types to analyze (#178)

RepoSense only tracks '.java' and '.adoc' file types for analyse.

This may not be sufficient for visualization as not many other projects that
are not mainly coded in Java or use asciidoctor for their documents.

Let's include more file types by default in the analysis.

Author: yamidark

src/functional/java/reposense/Entry.java

@@ -7,6 +7,7 @@
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.Paths;
+import java.util.Arrays;
 import java.util.List;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
@@ -27,6 +28,7 @@
 public class Entry {
     private static final String FT_TEMP_DIR = "ft_temp";
     private static final String EXPECTED_FOLDER = "expected";
+    private static final List<String> TESTING_FILE_FORMATS = Arrays.asList("java", "adoc");
 
     @Before
     public void setUp() throws IOException {
@@ -61,6 +63,7 @@ private void generateReport(String inputDates) throws IOException, URISyntaxExce
 
         CliArguments cliArguments = ArgsParser.parse(translateCommandline(input));
         List<RepoConfiguration> configs = CsvParser.parse(cliArguments.getConfigFilePath());
+        RepoConfiguration.setFormatsToRepoConfigs(configs, TESTING_FILE_FORMATS);
         RepoConfiguration.setDatesToRepoConfigs(configs, cliArguments.getSinceDate(), cliArguments.getUntilDate());
 
         ReportGenerator.generateReposReport(configs, FT_TEMP_DIR);

src/main/java/reposense/RepoSense.java

@@ -1,6 +1,7 @@
 package reposense;
 
 import java.io.IOException;
+import java.util.Arrays;
 import java.util.List;
 import java.util.logging.Level;
 import java.util.logging.Logger;
@@ -14,13 +15,17 @@
 import reposense.system.LogsManager;
 
 public class RepoSense {
+    public static final List<String> DEFAULT_FILE_FORMATS = Arrays.asList("java", "adoc", "js", "md", "css",
+            "html", "cs", "json", "xml", "py", "fxml", "tag", "jsp", "gradle");
+
     private static final Logger logger = LogsManager.getLogger(RepoSense.class);
 
     public static void main(String[] args) {
         try {
             CliArguments cliArguments = ArgsParser.parse(args);
 
             List<RepoConfiguration> configs = CsvParser.parse(cliArguments.getConfigFilePath());
+            RepoConfiguration.setFormatsToRepoConfigs(configs, DEFAULT_FILE_FORMATS);
             RepoConfiguration.setDatesToRepoConfigs(configs, cliArguments.getSinceDate(), cliArguments.getUntilDate());
 
             ReportGenerator.generateReposReport(

src/main/java/reposense/authorship/FileInfoExtractor.java

@@ -58,7 +58,7 @@ private static void getAllFileInfo(
                     getAllFileInfo(config, filePath, fileInfos);
                 }
 
-                if (relativePath.endsWith(".java") || relativePath.endsWith(".adoc")) {
+                if (isFileFormatInsideWhiteList(relativePath, config.getFileFormats())) {
                     fileInfos.add(generateFileInfo(config.getRepoRoot(), relativePath.replace('\\', '/')));
                 }
             }
@@ -92,4 +92,11 @@ public static FileInfo generateFileInfo(String repoRoot, String relativePath) {
     private static boolean shouldIgnore(String name, List<String> ignoreList) {
         return ignoreList.stream().anyMatch(name::contains);
     }
+
+    /**
+     * Returns true if the {@code relativePath}'s file type is inside {@code fileFormatsWhiteList}.
+     */
+    private static boolean isFileFormatInsideWhiteList(String relativePath, List<String> fileFormatsWhiteList) {
+        return fileFormatsWhiteList.stream().anyMatch(fileFormat -> relativePath.endsWith("." + fileFormat));
+    }
 }

src/main/java/reposense/commits/CommitInfoExtractor.java

@@ -32,7 +32,8 @@ public static List<CommitInfo> extractCommitInfos(RepoConfiguration config) {
      * Returns the git log information for the repo for the date range in {@code config}.
      */
     private static String getGitLogResult(RepoConfiguration config) {
-        return CommandRunner.gitLog(config.getRepoRoot(), config.getSinceDate(), config.getUntilDate());
+        return CommandRunner.gitLog(
+                config.getRepoRoot(), config.getSinceDate(), config.getUntilDate(), config.getFileFormats());
     }
 
     /**

src/main/java/reposense/model/RepoConfiguration.java

@@ -20,6 +20,7 @@ public class RepoConfiguration {
     private Date untilDate;
 
     private transient boolean needCheckStyle = false;
+    private transient List<String> fileFormats;
     private transient int commitNum = 1;
     private transient List<String> ignoreDirectoryList = new ArrayList<>();
     private transient List<Author> authorList = new ArrayList<>();
@@ -42,6 +43,13 @@ public static void setDatesToRepoConfigs(
         }
     }
 
+    /**
+     * Sets all {@code RepoConfiguration} in {@code configs} to have {@code fileFormats} set.
+     */
+    public static void setFormatsToRepoConfigs(List<RepoConfiguration> configs, List<String> fileFormats) {
+        configs.forEach(config -> config.setFileFormats(fileFormats));
+    }
+
     @Override
     public boolean equals(Object other) {
 
@@ -165,6 +173,14 @@ public String getDisplayName() {
         return displayName;
     }
 
+    public List<String> getFileFormats() {
+        return fileFormats;
+    }
+
+    public void setFileFormats(List<String> fileFormats) {
+        this.fileFormats = fileFormats;
+    }
+
     public void setAuthorDisplayName(Author author, String displayName) {
         authorDisplayNameMap.put(author, displayName);
     }

src/main/java/reposense/system/CommandRunner.java

@@ -7,22 +7,23 @@
 import java.text.DateFormat;
 import java.text.SimpleDateFormat;
 import java.util.Date;
+import java.util.List;
 
 import reposense.util.Constants;
 
 public class CommandRunner {
-
     private static final DateFormat GIT_LOG_SINCE_DATE_FORMAT = new SimpleDateFormat("yyyy-MM-dd'T'00:00:00+08:00");
     private static final DateFormat GIT_LOG_UNTIL_DATE_FORMAT = new SimpleDateFormat("yyyy-MM-dd'T'23:59:59+08:00");
 
     private static boolean isWindows = isWindows();
 
-    public static String gitLog(String root, Date sinceDate, Date untilDate) {
+    public static String gitLog(String root, Date sinceDate, Date untilDate, List<String> fileFormats) {
         Path rootPath = Paths.get(root);
 
         String command = "git log --no-merges ";
-        command += getGitDateRangeArgs(sinceDate, untilDate);
-        command += " --pretty=format:\"%h|%aN|%ad|%s\" --date=iso --shortstat -- \"*.java\" -- \"*.adoc\"";
+        command += convertToGitDateRangeArgs(sinceDate, untilDate);
+        command += " --pretty=format:\"%h|%aN|%ad|%s\" --date=iso --shortstat";
+        command += convertToGitFileFormatsArgs(fileFormats);
 
         return runCommand(rootPath, command);
     }
@@ -59,7 +60,7 @@ public static String blameRaw(String root, String fileDirectory, Date sinceDate,
         Path rootPath = Paths.get(root);
 
         String blameCommand = "git blame -w -C -C -M --line-porcelain";
-        blameCommand += getGitDateRangeArgs(sinceDate, untilDate);
+        blameCommand += convertToGitDateRangeArgs(sinceDate, untilDate);
         blameCommand += " " + addQuote(fileDirectory);
         blameCommand += getAuthorFilterCommand();
 
@@ -139,7 +140,7 @@ private static String getAuthorFilterCommand() {
     /**
      * Returns the {@code String} command to specify the date range of commits to analyze for `git` commands.
      */
-    private static String getGitDateRangeArgs(Date sinceDate, Date untilDate) {
+    private static String convertToGitDateRangeArgs(Date sinceDate, Date untilDate) {
         String gitDateRangeArgs = "";
 
         if (sinceDate != null) {
@@ -151,4 +152,18 @@ private static String getGitDateRangeArgs(Date sinceDate, Date untilDate) {
 
         return gitDateRangeArgs;
     }
+
+    /**
+     * Returns the {@code String} command to specify the file formats to analyze for `git` commands.
+     */
+    private static String convertToGitFileFormatsArgs(List<String> fileFormats) {
+        StringBuilder gitFileFormatsArgsBuilder = new StringBuilder();
+
+        final String cmdFormat = " -- " + addQuote("*.%s");
+        fileFormats.stream()
+                .map(format -> String.format(cmdFormat, format))
+                .forEach(gitFileFormatsArgsBuilder::append);
+
+        return gitFileFormatsArgsBuilder.toString();
+    }
 }

src/test/java/reposense/authorship/FileInfoExtractorTest.java

@@ -21,7 +21,7 @@ public void extractFileInfosTest() {
         config.getAuthorAliasMap().put(TestConstants.FAKE_AUTHOR_NAME, new Author(TestConstants.FAKE_AUTHOR_NAME));
         GitChecker.checkout(config.getRepoRoot(), TestConstants.TEST_COMMIT_HASH);
         List<FileInfo> files = FileInfoExtractor.extractFileInfos(config);
-        Assert.assertEquals(files.size(), 5);
+        Assert.assertEquals(files.size(), 6);
         Assert.assertTrue(isFileExistence(Paths.get("annotationTest.java"), files));
         Assert.assertTrue(isFileExistence(Paths.get("blameTest.java"), files));
         Assert.assertTrue(isFileExistence(Paths.get("newPos/movedFile.java"), files));

src/test/java/reposense/system/CommandRunnerTest.java

@@ -31,18 +31,21 @@ public void checkoutTest() {
 
     @Test
     public void logWithContentTest() {
-        String content = CommandRunner.gitLog(TestConstants.LOCAL_TEST_REPO_ADDRESS, null, null);
+        String content = CommandRunner.gitLog(
+                TestConstants.LOCAL_TEST_REPO_ADDRESS, null, null, config.getFileFormats());
         Assert.assertFalse(content.isEmpty());
     }
 
     @Test
     public void logWithoutContentTest() {
         Date date = TestUtil.getDate(2050, Calendar.JANUARY, 1);
-        String content = CommandRunner.gitLog(TestConstants.LOCAL_TEST_REPO_ADDRESS, date, null);
+        String content = CommandRunner.gitLog(
+                TestConstants.LOCAL_TEST_REPO_ADDRESS, date, null, config.getFileFormats());
         Assert.assertTrue(content.isEmpty());
 
         date = TestUtil.getDate(1950, Calendar.JANUARY, 1);
-        content = CommandRunner.gitLog(TestConstants.LOCAL_TEST_REPO_ADDRESS, null, date);
+        content = CommandRunner.gitLog(
+                TestConstants.LOCAL_TEST_REPO_ADDRESS, null, date, config.getFileFormats());
         Assert.assertTrue(content.isEmpty());
     }
 

src/test/java/reposense/template/GitTestTemplate.java

@@ -11,6 +11,7 @@
 import org.junit.Before;
 import org.junit.BeforeClass;
 
+import reposense.RepoSense;
 import reposense.authorship.FileInfoAnalyzer;
 import reposense.authorship.FileInfoExtractor;
 import reposense.authorship.model.FileInfo;
@@ -32,6 +33,7 @@ public class GitTestTemplate {
     @Before
     public void before() {
         config = new RepoConfiguration(TEST_ORG, TEST_REPO, "master");
+        config.setFileFormats(RepoSense.DEFAULT_FILE_FORMATS);
     }
 
     @BeforeClass