Merge pull request #2439 from jplag/feature/suffix-extension-conflict

Enforce consistent terminology regarding file extensions

Author: tsaglam

README.md

@@ -113,8 +113,8 @@ Parameter descriptions:
                           against.
       -r, --result-file=<resultFile>
                         Name of the file in which the comparison results will
-                          be stored (default: results). Missing .jplag endings
-                          will be automatically added.
+                          be stored (default: results). Missing .jplag
+                          extension will be automatically added.
       -t, --min-tokens=<minTokenMatch>
                         Tunes the comparison sensitivity by adjusting the
                           minimum token required to be counted as a matching

cli/src/main/java/de/jplag/cli/CLI.java

@@ -31,7 +31,7 @@ public final class CLI {
     private static final String DEFAULT_FILE_EXTENSION = ".jplag";
     private static final int NAME_COLLISION_ATTEMPTS = 4;
 
-    private static final String OUTPUT_FILE_EXISTS = "The output file (also with suffixes e.g. results(1).jplag) already exists. You can use --overwrite to overwrite the file.";
+    private static final String OUTPUT_FILE_EXISTS = "The output file already exists. You can use --overwrite to overwrite the file.";
     private static final String OUTPUT_FILE_NOT_WRITABLE = "The output file (%s) cannot be written to.";
 
     private static final String ZIP_FILE_EXTENSION = ".zip";

cli/src/main/java/de/jplag/cli/options/CliOptions.java

@@ -50,7 +50,7 @@ public class CliOptions implements Runnable {
     public int shownComparisons = JPlagOptions.DEFAULT_SHOWN_COMPARISONS;
 
     @Option(names = {"-r",
-            "--result-file"}, description = "Name of the file in which the comparison results will be stored (default: ${DEFAULT-VALUE}). Missing .jplag endings will be automatically added.")
+            "--result-file"}, description = "Name of the file in which the comparison results will be stored (default: ${DEFAULT-VALUE}). Missing .jplag extension will be automatically added.")
     public String resultFile = "results";
 
     @Option(names = {"-M",

cli/src/main/java/de/jplag/cli/server/ContentType.java

@@ -26,14 +26,14 @@ public String getValue() {
     }
 
     /**
-     * Guesses the type from the given path using the suffix after the last '.'.
+     * Guesses the type from the given path using the extension after the last dot.
      * @param path The path to guess from
      * @return The guessed type
      */
     public static ContentType fromPath(String path) {
-        String suffix = path.substring(path.lastIndexOf('.'));
+        String extension = path.substring(path.lastIndexOf('.'));
         for (ContentType value : ContentType.values()) {
-            if (suffix.equals(value.nameSuffix)) {
+            if (extension.equals(value.nameSuffix)) {
                 return value;
             }
         }

cli/src/test/java/de/jplag/cli/FileExtensionTest.java

@@ -4,7 +4,6 @@
 import static org.junit.jupiter.api.Assertions.assertIterableEquals;
 
 import java.io.IOException;
-import java.util.Arrays;
 import java.util.List;
 
 import org.junit.jupiter.api.Test;
@@ -22,7 +21,7 @@ class FileExtensionTest extends CliTest {
     void testDefaultExtensions() throws IOException, ExitException {
         JPlagOptions options = runCliForOptions();
 
-        List<String> expectedExtensions = Arrays.asList(new JavaLanguage().suffixes());
+        List<String> expectedExtensions = new JavaLanguage().fileExtensions();
         assertIterableEquals(expectedExtensions, options.fileSuffixes());
     }
 

cli/src/test/java/de/jplag/cli/LanguageTest.java

@@ -3,7 +3,6 @@
 import static org.junit.jupiter.api.Assertions.assertEquals;
 
 import java.io.IOException;
-import java.util.Arrays;
 import java.util.Collection;
 import java.util.List;
 
@@ -49,7 +48,7 @@ void testValidLanguages(Language language) throws ExitException, IOException {
         JPlagOptions options = runCliForOptions(args -> args.with(CliArgument.LANGUAGE, language.getIdentifier()));
 
         assertEquals(language.getIdentifier(), options.language().getIdentifier());
-        assertEquals(Arrays.asList(language.suffixes()), options.fileSuffixes());
+        assertEquals(language.fileExtensions(), options.fileSuffixes());
     }
 
     @Test

core/src/main/java/de/jplag/SubmissionSetBuilder.java

@@ -167,7 +167,7 @@ private Optional<Submission> loadBaseCode() throws ExitException {
             throw new BasecodeException("Exclude submission: " + baseCodeSubmissionDirectory.getName());
         }
         if (baseCodeSubmissionDirectory.isFile() && !hasValidSuffix(baseCodeSubmissionDirectory)) {
-            throw new BasecodeException("Ignore submission with invalid suffix: " + baseCodeSubmissionDirectory.getName());
+            throw new BasecodeException("Ignore submission with invalid extension or suffix: " + baseCodeSubmissionDirectory.getName());
         }
 
         Submission baseCodeSubmission = processSubmission(baseCodeSubmissionDirectory.getName(), baseCodeSubmissionDirectory, false);
@@ -233,7 +233,7 @@ private void processSubmissionFile(SubmissionFileData file, boolean multipleRoot
         if (isFileExcluded(file.submissionFile())) {
             logger.error("Exclude submission: {}", file.submissionFile().getName());
         } else if (file.submissionFile().isFile() && !hasValidSuffix(file.submissionFile())) {
-            logger.error("Ignore submission with invalid suffix: {}", file.submissionFile().getName());
+            logger.error("Ignore submission with invalid extension or suffix: {}", file.submissionFile().getName());
         } else {
             String rootDirectoryPrefix = multipleRoots ? file.rootDirectory().getName() + File.separator : "";
             String submissionName = rootDirectoryPrefix + file.submissionFile().getName();
@@ -243,9 +243,9 @@ private void processSubmissionFile(SubmissionFileData file, boolean multipleRoot
     }
 
     /**
-     * Checks if a file has a valid suffix for the current language.
+     * Checks if a file has a valid file extension for the current language or ends in a specified suffix.
      * @param file is the file to check.
-     * @return true if the file suffix matches the language.
+     * @return true if the file matches the file extension or suffix.
      */
     private boolean hasValidSuffix(File file) {
         List<String> validSuffixes = options.fileSuffixes();
@@ -265,7 +265,8 @@ private boolean isFileExcluded(File file) {
     }
 
     /**
-     * Recursively scan the given directory for nested files. Excluded files and files with an invalid suffix are ignored.
+     * Recursively scan the given directory for nested files. Excluded files and files with an invalid extension or suffix
+     * are ignored.
      * <p>
      * If the given file is not a directory, the input will be returned as a singleton list.
      * @param file - File to start the scan from.

core/src/main/java/de/jplag/options/JPlagOptions.java

@@ -3,7 +3,6 @@
 import java.io.BufferedReader;
 import java.io.File;
 import java.io.IOException;
-import java.util.Arrays;
 import java.util.Collections;
 import java.util.List;
 import java.util.Optional;
@@ -35,7 +34,7 @@
  * @param baseCodeSubmissionDirectory Directory containing the base code.
  * @param subdirectoryName Example: If the subdirectoryName is 'src', only the code inside submissionDir/src of each
  * submission will be used for comparison.
- * @param fileSuffixes List of file suffixes that should be included.
+ * @param fileSuffixes List of file extensions or custom suffixes that should be included.
  * @param exclusionFileName Name of the file that contains the names of files to exclude from comparison.
  * @param similarityMetric The similarity metric determines how the minimum similarity threshold required for a
  * comparison (of two submissions) is calculated. This affects which comparisons are stored and thus make it into the
@@ -113,7 +112,7 @@ public Set<String> excludedFiles() {
     public List<String> fileSuffixes() {
         var language = language();
         if ((fileSuffixes == null || fileSuffixes.isEmpty()) && language != null) {
-            return Arrays.stream(language.suffixes()).toList();
+            return language.fileExtensions();
         }
         return fileSuffixes == null ? null : Collections.unmodifiableList(fileSuffixes);
     }

core/src/main/java/de/jplag/reporting/reportobject/ReportObjectFactory.java

@@ -133,7 +133,7 @@ private void copySubmissionFilesToReport(JPlagResult result) {
     }
 
     private File getFileToCopy(Language language, File file) {
-        return language.useViewFiles() ? new File(file.getPath() + language.viewFileSuffix()) : file;
+        return language.useViewFiles() ? new File(file.getPath() + language.viewFileExtension()) : file;
     }
 
     private void writeComparisons(JPlagResult result) {

docs/1.-How-to-Use-JPlag.md

@@ -48,8 +48,8 @@ Parameter descriptions:
                           against.
       -r, --result-file=<resultFile>
                         Name of the file in which the comparison results will
-                          be stored (default: results). Missing .jplag endings
-                          will be automatically added.
+                          be stored (default: results). Missing .jplag
+                          extension will be automatically added.
       -t, --min-tokens=<minTokenMatch>
                         Tunes the comparison sensitivity by adjusting the
                           minimum token required to be counted as a matching