Selected SLR catalogs: maintain preferences abstraction level (JabRef#11667)

* Attempt: Persist selection of databases

* Use ObservableSet

* ObservableList

* set fetchers

* Revise architecture

* Revise test

* Fix indent

* Fix indent 2

* Add changelog entry

* Fix indent

* Update CHANGELOG.md

* Chris' update

Co-authored-by: Christoph <siedlerkiller@gmail.com>

* Update src/main/java/org/jabref/preferences/WorkspacePreferences.java

Co-authored-by: Christoph <siedlerkiller@gmail.com>

* Update src/main/java/org/jabref/preferences/JabRefPreferences.java

Co-authored-by: Christoph <siedlerkiller@gmail.com>

* !Remove duplicated line

* Return ObservableList

* Remove unused import

* Rename foreach loop variable

* Rename foreach loop variable

* Rename fetcher->catalog

* Fix overwriting of existing study catalogs

* Merge upstream/main

* Fix merge issue

* Persist for edits on existing studies

* Save preferences only on a "new run" or "save".

* Maintain abstraction

---------

Co-authored-by: Christoph <siedlerkiller@gmail.com>
Co-authored-by: Oliver Kopp <kopp.dev@gmail.com>

Author: 3 people

src/main/java/org/jabref/gui/slr/ManageStudyDefinitionView.java

@@ -159,16 +159,16 @@ private void initialize() {
             viewModel = new ManageStudyDefinitionViewModel(
                     prefs.getImportFormatPreferences(),
                     prefs.getImporterPreferences(),
-                    dialogService,
-                    prefs);
+                    prefs.getWorkspacePreferences(),
+                    dialogService);
         } else {
             viewModel = new ManageStudyDefinitionViewModel(
                     study.get(),
                     pathToStudyDataDirectory,
                     prefs.getImportFormatPreferences(),
                     prefs.getImporterPreferences(),
-                    dialogService,
-                    prefs);
+                    prefs.getWorkspacePreferences(),
+                    dialogService);
 
             // The directory of the study cannot be changed
             studyDirectory.setEditable(false);

src/main/java/org/jabref/gui/slr/ManageStudyDefinitionViewModel.java

@@ -32,7 +32,7 @@
 import org.jabref.model.study.Study;
 import org.jabref.model.study.StudyDatabase;
 import org.jabref.model.study.StudyQuery;
-import org.jabref.preferences.PreferencesService;
+import org.jabref.preferences.WorkspacePreferences;
 
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -61,15 +61,15 @@ public class ManageStudyDefinitionViewModel {
 
     private final DialogService dialogService;
 
-    private final PreferencesService preferencesService;
+    private final WorkspacePreferences workspacePreferences;
 
     /**
      * Constructor for a new study
      */
     public ManageStudyDefinitionViewModel(ImportFormatPreferences importFormatPreferences,
                                           ImporterPreferences importerPreferences,
-                                          DialogService dialogService,
-                                          PreferencesService preferencesService) {
+                                          WorkspacePreferences workspacePreferences,
+                                          DialogService dialogService) {
         databases.addAll(WebFetchers.getSearchBasedFetchers(importFormatPreferences, importerPreferences)
                                     .stream()
                                     .map(SearchBasedFetcher::getName)
@@ -82,7 +82,7 @@ public ManageStudyDefinitionViewModel(ImportFormatPreferences importFormatPrefer
                                     })
                                     .toList());
         this.dialogService = Objects.requireNonNull(dialogService);
-        this.preferencesService = Objects.requireNonNull(preferencesService);
+        this.workspacePreferences = Objects.requireNonNull(workspacePreferences);
     }
 
     /**
@@ -95,8 +95,8 @@ public ManageStudyDefinitionViewModel(Study study,
                                           Path studyDirectory,
                                           ImportFormatPreferences importFormatPreferences,
                                           ImporterPreferences importerPreferences,
-                                          DialogService dialogService,
-                                          PreferencesService preferencesService) {
+                                          WorkspacePreferences workspacePreferences,
+                                          DialogService dialogService) {
         // copy the content of the study object into the UI fields
         authors.addAll(Objects.requireNonNull(study).getAuthors());
         title.setValue(study.getTitle());
@@ -117,7 +117,7 @@ public ManageStudyDefinitionViewModel(Study study,
 
         this.directory.set(Objects.requireNonNull(studyDirectory).toString());
         this.dialogService = Objects.requireNonNull(dialogService);
-        this.preferencesService = Objects.requireNonNull(preferencesService);
+        this.workspacePreferences = Objects.requireNonNull(workspacePreferences);
     }
 
     public StringProperty getTitle() {
@@ -226,7 +226,7 @@ public void deleteQuery(String item) {
     }
 
     public void initializeSelectedCatalogs() {
-        List<String> selectedCatalogs = preferencesService.getWorkspacePreferences().getSelectedSlrCatalogs();
+        List<String> selectedCatalogs = workspacePreferences.getSelectedSlrCatalogs();
         for (StudyCatalogItem catalog : databases) {
             catalog.setEnabled(selectedCatalogs.contains(catalog.getName()));
         }
@@ -238,6 +238,6 @@ public void updateSelectedCatalogs() {
                                                      .map(StudyCatalogItem::getName)
                                                      .collect(Collectors.toList());
 
-        preferencesService.getWorkspacePreferences().setSelectedSlrCatalogs(selectedCatalogsList);
+        workspacePreferences.setSelectedSlrCatalogs(selectedCatalogsList);
     }
 }

src/test/java/org/jabref/gui/slr/ManageStudyDefinitionViewModelTest.java

@@ -8,7 +8,7 @@
 import org.jabref.logic.importer.ImporterPreferences;
 import org.jabref.model.study.Study;
 import org.jabref.model.study.StudyDatabase;
-import org.jabref.preferences.PreferencesService;
+import org.jabref.preferences.WorkspacePreferences;
 
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
@@ -21,21 +21,21 @@
 class ManageStudyDefinitionViewModelTest {
     private ImportFormatPreferences importFormatPreferences;
     private ImporterPreferences importerPreferences;
+    private WorkspacePreferences workspacePreferences;
     private DialogService dialogService;
-    private PreferencesService preferencesService;
 
     @BeforeEach
     void setUp() {
         // code taken from org.jabref.logic.importer.WebFetchersTest.setUp
         importFormatPreferences = mock(ImportFormatPreferences.class, Answers.RETURNS_DEEP_STUBS);
         importerPreferences = mock(ImporterPreferences.class, Answers.RETURNS_DEEP_STUBS);
+        workspacePreferences = mock(WorkspacePreferences.class, Answers.RETURNS_DEEP_STUBS);
         dialogService = mock(DialogService.class);
-        preferencesService = mock(PreferencesService.class);
     }
 
     @Test
     void emptyStudyConstructorFillsDatabasesCorrectly() {
-        ManageStudyDefinitionViewModel manageStudyDefinitionViewModel = new ManageStudyDefinitionViewModel(importFormatPreferences, importerPreferences, dialogService, preferencesService);
+        ManageStudyDefinitionViewModel manageStudyDefinitionViewModel = new ManageStudyDefinitionViewModel(importFormatPreferences, importerPreferences, workspacePreferences, dialogService);
         assertEquals(List.of(
                 new StudyCatalogItem("ACM Portal", true),
                 new StudyCatalogItem("ArXiv", false),
@@ -106,7 +106,7 @@ private ManageStudyDefinitionViewModel getManageStudyDefinitionViewModel(Path te
                 tempDir,
                 importFormatPreferences,
                 importerPreferences,
-                dialogService,
-                preferencesService);
+                workspacePreferences,
+                dialogService);
     }
 }