chore(git): Fix variable names + refactoring (moving the GitConflictResolver interface to the logic module) #12350

Author: wanling0000

jabgui/src/main/java/org/jabref/gui/LibraryTabContainer.java

@@ -27,7 +27,7 @@ public interface LibraryTabContainer {
      * Closes a designated libraryTab
      *
      * @param tab to be closed.
-     * @return true if closing the tab was isSuccessful
+     * @return true if closing the tab was successful
      */
     boolean closeTab(@Nullable LibraryTab tab);
 

jabgui/src/main/java/org/jabref/gui/autosaveandbackup/BackupManager.java

@@ -275,7 +275,7 @@ void performBackup(Path backupPath) {
         BibDatabaseContext bibDatabaseContextClone = new BibDatabaseContext(bibDatabaseClone, bibDatabaseContext.getMetaData());
 
         Charset encoding = bibDatabaseContext.getMetaData().getEncoding().orElse(StandardCharsets.UTF_8);
-        // We want to have isSuccessful backups only
+        // We want to have successful backups only
         // Thus, we do not use a plain "FileWriter", but the "AtomicFileWriter"
         // Example: What happens if one hard powers off the machine (or kills the jabref process) during writing of the backup?
         //          This MUST NOT create a broken backup file that then jabref wants to "restore" from?

jabgui/src/main/java/org/jabref/gui/desktop/os/Linux.java

@@ -47,10 +47,10 @@ private void nativeOpenFile(String filePath) {
                     String[] cmd = {"xdg-open", filePath};
                     Runtime.getRuntime().exec(cmd);
                 } catch (Exception e2) {
-                    LoggerFactory.getLogger(Linux.class).warn("Open operation not isSuccessful: ", e2);
+                    LoggerFactory.getLogger(Linux.class).warn("Open operation not successful: ", e2);
                 }
             } catch (IOException e) {
-                LoggerFactory.getLogger(Linux.class).warn("Native open operation not isSuccessful: ", e);
+                LoggerFactory.getLogger(Linux.class).warn("Native open operation not successful: ", e);
             }
         });
     }

jabgui/src/main/java/org/jabref/gui/exporter/SaveDatabaseAction.java

@@ -52,7 +52,7 @@
  * when closing a database or quitting the applications.
  * <p>
  * The save operation is loaded off of the GUI thread using {@link BackgroundTask}. Callers can query whether the
- * operation was canceled, or whether it was isSuccessful.
+ * operation was canceled, or whether it was successful.
  */
 public class SaveDatabaseAction {
     private static final Logger LOGGER = LoggerFactory.getLogger(SaveDatabaseAction.class);
@@ -134,8 +134,8 @@ public void saveSelectedAsPlain() {
 
     /**
      * @param file the new file name to save the database to. This is stored in the database context of the panel upon
-     *             isSuccessful save.
-     * @return true on isSuccessful save
+     *             successful save.
+     * @return true on successful save
      */
     boolean saveAs(Path file, SaveDatabaseMode mode) {
         BibDatabaseContext context = libraryTab.getBibDatabaseContext();

jabgui/src/main/java/org/jabref/gui/git/GitConflictResolverViaDialog.java renamed to jabgui/src/main/java/org/jabref/gui/git/GitConflictResolverDialog.java

@@ -8,18 +8,19 @@
 import org.jabref.gui.mergeentries.newmergedialog.diffhighlighter.DiffHighlighter;
 import org.jabref.gui.mergeentries.newmergedialog.toolbar.ThreeWayMergeToolbar;
 import org.jabref.gui.preferences.GuiPreferences;
+import org.jabref.logic.git.conflicts.GitConflictResolver;
 import org.jabref.logic.git.conflicts.ThreeWayEntryConflict;
 import org.jabref.model.entry.BibEntry;
 
 /**
  * UI wrapper
  * Receives a semantic conflict (ThreeWayEntryConflict), pops up an interactive GUI (belonging to mergeentries), and returns a user-confirmed BibEntry merge result.
  */
-public class GitConflictResolverViaDialog implements GitConflictResolver {
+public class GitConflictResolverDialog implements GitConflictResolver {
     private final DialogService dialogService;
     private final GuiPreferences preferences;
 
-    public GitConflictResolverViaDialog(DialogService dialogService, GuiPreferences preferences) {
+    public GitConflictResolverDialog(DialogService dialogService, GuiPreferences preferences) {
         this.dialogService = dialogService;
         this.preferences = preferences;
     }

jabgui/src/main/java/org/jabref/gui/git/GitPullAction.java

@@ -55,7 +55,7 @@ public void execute() {
         try {
             GitPullViewModel viewModel = new GitPullViewModel(
                     guiPreferences.getImportFormatPreferences(),
-                    new GitConflictResolverViaDialog(dialogService, guiPreferences),
+                    new GitConflictResolverDialog(dialogService, guiPreferences),
                     dialogService
             );
             MergeResult result = viewModel.pull(bibFilePath);

jabgui/src/main/java/org/jabref/gui/git/GitPullViewModel.java

@@ -9,7 +9,9 @@
 import org.jabref.gui.AbstractViewModel;
 import org.jabref.gui.DialogService;
 import org.jabref.logic.JabRefException;
+import org.jabref.logic.git.GitConflictResolver;
 import org.jabref.logic.git.GitHandler;
+import org.jabref.logic.git.conflicts.GitConflictResolver;
 import org.jabref.logic.git.conflicts.SemanticConflictDetector;
 import org.jabref.logic.git.conflicts.ThreeWayEntryConflict;
 import org.jabref.logic.git.io.GitBibParser;
@@ -29,31 +31,30 @@
 import org.eclipse.jgit.api.errors.GitAPIException;
 import org.eclipse.jgit.revwalk.RevCommit;
 
-/**
- * ViewModel responsible for coordinating UI-bound Git Pull workflow,
- * including conflict resolution.
- */
 public class GitPullViewModel extends AbstractViewModel {
     private final ImportFormatPreferences importFormatPreferences;
     private final GitConflictResolver conflictResolver;
     private final DialogService dialogService;
+    private final GitHandler gitHandler;
+    private final GitStatusViewModel gitStatusViewModel;
+    private final Path bibFilePath;
 
     public GitPullViewModel(ImportFormatPreferences importFormatPreferences,
-                             GitConflictResolver conflictResolver,
-                             DialogService dialogService) {
+                            GitConflictResolver conflictResolver,
+                            DialogService dialogService,
+                            GitHandler gitHandler,
+                            GitStatusViewModel gitStatusViewModel) {
         this.importFormatPreferences = importFormatPreferences;
         this.conflictResolver = conflictResolver;
         this.dialogService = dialogService;
+        this.gitHandler = gitHandler;
+        this.gitStatusViewModel = gitStatusViewModel;
+        this.bibFilePath = gitStatusViewModel.getCurrentBibFile();
     }
 
-    public MergeResult pull(Path bibFilePath) throws IOException, GitAPIException, JabRefException {
+    public MergeResult pull() throws IOException, GitAPIException, JabRefException {
         // Open the Git repository from the parent folder of the .bib file
-        Git git = Git.open(bibFilePath.getParent().toFile());
-
-        // Fetch latest changes from remote
-        // TODO: Temporary — GitHandler should be injected from GitStatusViewModel once centralized git status is implemented.
-        GitHandler gitHandler = GitHandler.fromAnyPath(bibFilePath)
-                                          .orElseThrow(() -> new IllegalStateException("Not inside a Git repository"));
+        Git git = Git.open(gitHandler.getRepositoryPathAsFile());
 
         gitHandler.fetchOnCurrentBranch();
 
@@ -66,12 +67,12 @@ public MergeResult pull(Path bibFilePath) throws IOException, GitAPIException, J
         RevCommit remoteCommit = triple.remote();
 
         // Ensure file is inside the Git working tree
-        Path bibPath = bibFilePath.toRealPath();
-        Path workTree = git.getRepository().getWorkTree().toPath().toRealPath();
-        if (!bibPath.startsWith(workTree)) {
-            throw new IllegalStateException("Given .bib file is not inside repository");
+        Path repoRoot = gitHandler.getRepositoryPathAsFile().toPath().toRealPath();
+        Path resolvedBibPath = bibFilePath.toRealPath();
+        if (!resolvedBibPath.startsWith(repoRoot)) {
+            throw new JabRefException("The provided .bib file is not inside the Git repository.");
         }
-        Path relativePath = workTree.relativize(bibPath);
+        Path relativePath = repoRoot.relativize(resolvedBibPath);
 
         // 1. Load three versions
         String baseContent = GitFileReader.readFileFromCommit(git, baseCommit, relativePath);
@@ -112,6 +113,8 @@ public MergeResult pull(Path bibFilePath) throws IOException, GitAPIException, J
 
         // Create Git commit for the merged result
         gitHandler.createCommitOnCurrentBranch("Auto-merged by JabRef", true);
+
+        gitStatusViewModel.updateStatusFromPath(bibFilePath);
         return MergeResult.success();
     }
 }

jabgui/src/main/java/org/jabref/gui/openoffice/OOBibBaseConnect.java

@@ -173,7 +173,7 @@ public String toString() {
      * <p>
      * If there is a single document to choose from, selects that. If there are more than one, shows selection dialog. If there are none, throws NoDocumentFoundException
      * <p>
-     * After isSuccessful selection connects to the selected document and extracts some frequently used parts (starting points for managing its content).
+     * After successful selection connects to the selected document and extracts some frequently used parts (starting points for managing its content).
      * <p>
      * Finally initializes this.xTextDocument with the selected document and parts extracted.
      */

jabgui/src/main/java/org/jabref/gui/shared/SharedDatabaseLoginDialogView.java

@@ -34,7 +34,7 @@
 
 /**
  * This offers the user to connect to a remove SQL database.
- * Moreover, it directly opens the shared database after isSuccessful connection.
+ * Moreover, it directly opens the shared database after successful connection.
  */
 public class SharedDatabaseLoginDialogView extends BaseDialog<Void> {
     @FXML private ComboBox<DBMSType> databaseType;

jablib/src/main/java/org/jabref/logic/bibtex/comparator/EntryComparator.java

@@ -86,7 +86,7 @@ public int compare(BibEntry e1, BibEntry e2) {
             try {
                 int i1 = Integer.parseInt((String) f1);
                 int i2 = Integer.parseInt((String) f2);
-                // Ok, parsing was isSuccessful. Update f1 and f2:
+                // Ok, parsing was successful. Update f1 and f2:
                 f1 = i1;
                 f2 = i2;
             } catch (NumberFormatException ex) {