-
Notifications
You must be signed in to change notification settings - Fork 488
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added DataFileCategoryService to manage data file categories configur…
…ation
- Loading branch information
Showing
5 changed files
with
228 additions
and
26 deletions.
There are no files selected for viewing
81 changes: 81 additions & 0 deletions
81
src/main/java/edu/harvard/iq/dataverse/DataFileCategoryService.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,81 @@ | ||
| package edu.harvard.iq.dataverse; | ||
|
|
||
| import edu.harvard.iq.dataverse.settings.SettingsServiceBean; | ||
| import edu.harvard.iq.dataverse.util.BundleUtil; | ||
|
|
||
| import javax.ejb.EJB; | ||
| import javax.ejb.Stateless; | ||
| import java.util.ArrayList; | ||
| import java.util.Arrays; | ||
| import java.util.Collections; | ||
| import java.util.List; | ||
| import java.util.Optional; | ||
| import java.util.stream.Collectors; | ||
|
|
||
| @Stateless | ||
| public class DataFileCategoryService { | ||
|
|
||
| public static final String FILE_CATEGORIES_KEY = ":FileCategories"; | ||
|
|
||
| @EJB | ||
| private SettingsServiceBean settingsService; | ||
|
|
||
| public List<String> mergeDatasetFileCategories(List<DataFileCategory> datasetFileCategories) { | ||
| List<DataFileCategory> fileCategories = Optional.ofNullable(datasetFileCategories).orElse(Collections.emptyList()); | ||
| List<String> defaultFileCategories = getFileCategories(); | ||
|
|
||
| //avoid resizing | ||
| List<String> mergedFileCategories = new ArrayList<>(defaultFileCategories.size() + fileCategories.size()); | ||
|
|
||
| for(DataFileCategory category: fileCategories) { | ||
| mergedFileCategories.add(category.getName()); | ||
| } | ||
|
|
||
| for(String defaultCategory: defaultFileCategories) { | ||
| if (!mergedFileCategories.contains(defaultCategory)) { | ||
| mergedFileCategories.add(defaultCategory); | ||
| } | ||
| } | ||
|
|
||
| return mergedFileCategories; | ||
| } | ||
|
|
||
| public List<String> getFileCategories() { | ||
| List<String> fileCategoriesOverride = getFileCategoriesOverride(); | ||
| return fileCategoriesOverride.isEmpty() ? getFileCategoriesDefault() : fileCategoriesOverride; | ||
| } | ||
|
|
||
| private List<String> getFileCategoriesDefault() { | ||
| // "Documentation", "Data" and "Code" are the 3 default categories that we | ||
| // present by default | ||
| return Arrays.asList( | ||
| BundleUtil.getStringFromBundle("dataset.category.documentation"), | ||
| BundleUtil.getStringFromBundle("dataset.category.data"), | ||
| BundleUtil.getStringFromBundle("dataset.category.code") | ||
| ); | ||
| } | ||
|
|
||
| private List<String> getFileCategoriesOverride() { | ||
| String applicationLanguage = BundleUtil.getCurrentLocale().getLanguage(); | ||
| Optional<String> fileCategoriesOverride = Optional.ofNullable(settingsService.get(FILE_CATEGORIES_KEY)); | ||
|
|
||
| if (fileCategoriesOverride.isPresent()) { | ||
| // There is an override, check if there is language specific value | ||
| String overrideValue = settingsService.get(FILE_CATEGORIES_KEY, applicationLanguage, fileCategoriesOverride.get()); | ||
|
|
||
| return parseCategoriesString(overrideValue); | ||
| } | ||
|
|
||
| return Collections.emptyList(); | ||
| } | ||
|
|
||
| private List<String> parseCategoriesString(String categoriesString) { | ||
| if (categoriesString == null) { | ||
| return Collections.emptyList(); | ||
| } | ||
|
|
||
| String[] categories = categoriesString.split(","); | ||
| return Arrays.stream(categories).map(item -> item.trim()).filter(item -> !item.isBlank()).collect(Collectors.toUnmodifiableList()); | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
139 changes: 139 additions & 0 deletions
139
src/test/java/edu/harvard/iq/dataverse/DataFileCategoryServiceTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,139 @@ | ||
| package edu.harvard.iq.dataverse; | ||
|
|
||
| import edu.harvard.iq.dataverse.settings.SettingsServiceBean; | ||
| import edu.harvard.iq.dataverse.util.BundleUtil; | ||
| import org.hamcrest.MatcherAssert; | ||
| import org.hamcrest.Matchers; | ||
| import org.junit.Test; | ||
| import org.junit.runner.RunWith; | ||
| import org.mockito.InjectMocks; | ||
| import org.mockito.Mock; | ||
| import org.mockito.Mockito; | ||
| import org.mockito.junit.MockitoJUnitRunner; | ||
|
|
||
| import java.util.Arrays; | ||
| import java.util.List; | ||
| import java.util.stream.Collectors; | ||
|
|
||
| @RunWith(MockitoJUnitRunner.class) | ||
| public class DataFileCategoryServiceTest { | ||
|
|
||
| @Mock | ||
| private SettingsServiceBean settingsServiceBean; | ||
| @InjectMocks | ||
| private DataFileCategoryService target; | ||
|
|
||
| @Test | ||
| public void getFileCategories_should_return_default_file_categories_in_expected_order_when_no_override_configured() { | ||
| Mockito.when(settingsServiceBean.get(DataFileCategoryService.FILE_CATEGORIES_KEY)).thenReturn(null); | ||
|
|
||
| List<String> result = target.getFileCategories(); | ||
|
|
||
| MatcherAssert.assertThat(result.size(), Matchers.is(3)); | ||
| MatcherAssert.assertThat(result.get(0), Matchers.is("Documentation")); | ||
| MatcherAssert.assertThat(result.get(1), Matchers.is("Data")); | ||
| MatcherAssert.assertThat(result.get(2), Matchers.is("Code")); | ||
| } | ||
|
|
||
| @Test | ||
| public void getFileCategories_should_return_override_file_categories_from_settings_service() { | ||
| setup_override("Override01, Override02"); | ||
|
|
||
| List<String> result = target.getFileCategories(); | ||
|
|
||
| MatcherAssert.assertThat(result.size(), Matchers.is(2)); | ||
| MatcherAssert.assertThat(result.get(0), Matchers.is("Override01")); | ||
| MatcherAssert.assertThat(result.get(1), Matchers.is("Override02")); | ||
| } | ||
|
|
||
| @Test | ||
| public void getFileCategories_should_trim_override_values() { | ||
| setup_override(" Test Value 01 , Test Value 02 "); | ||
|
|
||
| List<String> result = target.getFileCategories(); | ||
|
|
||
| MatcherAssert.assertThat(result.size(), Matchers.is(2)); | ||
| MatcherAssert.assertThat(result.get(0), Matchers.is("Test Value 01")); | ||
| MatcherAssert.assertThat(result.get(1), Matchers.is("Test Value 02")); | ||
| } | ||
|
|
||
| @Test | ||
| public void getFileCategories_should_ignore_empty_override_values() { | ||
| setup_override(",value01,,value02,,value03,,"); | ||
|
|
||
| List<String> result = target.getFileCategories(); | ||
|
|
||
| MatcherAssert.assertThat(result.size(), Matchers.is(3)); | ||
| MatcherAssert.assertThat(result.get(0), Matchers.is("value01")); | ||
| MatcherAssert.assertThat(result.get(1), Matchers.is("value02")); | ||
| MatcherAssert.assertThat(result.get(2), Matchers.is("value03")); | ||
| } | ||
|
|
||
| @Test | ||
| public void mergeDatasetFileCategories_should_handle_null_datafile_categories() { | ||
| Mockito.when(settingsServiceBean.get(DataFileCategoryService.FILE_CATEGORIES_KEY)).thenReturn(null); | ||
|
|
||
| List<String> result = target.mergeDatasetFileCategories(null); | ||
|
|
||
| MatcherAssert.assertThat(result.size(), Matchers.is(3)); | ||
| MatcherAssert.assertThat(result.get(0), Matchers.is("Documentation")); | ||
| MatcherAssert.assertThat(result.get(1), Matchers.is("Data")); | ||
| MatcherAssert.assertThat(result.get(2), Matchers.is("Code")); | ||
| } | ||
|
|
||
| @Test | ||
| public void mergeDatasetFileCategories_should_add_dataset_values_first_then_default_categories() { | ||
| Mockito.when(settingsServiceBean.get(DataFileCategoryService.FILE_CATEGORIES_KEY)).thenReturn(null); | ||
|
|
||
| List<String> result = target.mergeDatasetFileCategories(setup_data_file_categories("dataset01", "dataset02")); | ||
|
|
||
| MatcherAssert.assertThat(result.size(), Matchers.is(5)); | ||
| MatcherAssert.assertThat(result.get(0), Matchers.is("dataset01")); | ||
| MatcherAssert.assertThat(result.get(1), Matchers.is("dataset02")); | ||
| MatcherAssert.assertThat(result.get(2), Matchers.is("Documentation")); | ||
| MatcherAssert.assertThat(result.get(3), Matchers.is("Data")); | ||
| MatcherAssert.assertThat(result.get(4), Matchers.is("Code")); | ||
| } | ||
|
|
||
| @Test | ||
| public void mergeDatasetFileCategories_should_add_dataset_values_first_then_override_categories() { | ||
| setup_override("override01, override02"); | ||
|
|
||
| List<String> result = target.mergeDatasetFileCategories(setup_data_file_categories("dataset01", "dataset02")); | ||
|
|
||
| MatcherAssert.assertThat(result.size(), Matchers.is(4)); | ||
| MatcherAssert.assertThat(result.get(0), Matchers.is("dataset01")); | ||
| MatcherAssert.assertThat(result.get(1), Matchers.is("dataset02")); | ||
| MatcherAssert.assertThat(result.get(2), Matchers.is("override01")); | ||
| MatcherAssert.assertThat(result.get(3), Matchers.is("override02")); | ||
| } | ||
|
|
||
| @Test | ||
| public void mergeDatasetFileCategories_should_ignore_duplicates() { | ||
| Mockito.when(settingsServiceBean.get(DataFileCategoryService.FILE_CATEGORIES_KEY)).thenReturn(null); | ||
|
|
||
| List<String> result = target.mergeDatasetFileCategories(setup_data_file_categories("Code", "Data", "Custom")); | ||
|
|
||
| MatcherAssert.assertThat(result.size(), Matchers.is(4)); | ||
| MatcherAssert.assertThat(result.get(0), Matchers.is("Code")); | ||
| MatcherAssert.assertThat(result.get(1), Matchers.is("Data")); | ||
| MatcherAssert.assertThat(result.get(2), Matchers.is("Custom")); | ||
| MatcherAssert.assertThat(result.get(3), Matchers.is("Documentation")); | ||
| } | ||
|
|
||
| private void setup_override(String overrideValue) { | ||
| String currentLang = BundleUtil.getCurrentLocale().getLanguage(); | ||
|
|
||
| Mockito.when(settingsServiceBean.get(DataFileCategoryService.FILE_CATEGORIES_KEY)).thenReturn(overrideValue); | ||
| Mockito.when(settingsServiceBean.get(DataFileCategoryService.FILE_CATEGORIES_KEY, currentLang, overrideValue)).thenReturn(overrideValue); | ||
| } | ||
|
|
||
| private List<DataFileCategory> setup_data_file_categories(String... names) { | ||
| return Arrays.stream(names).map(name -> { | ||
| DataFileCategory dataFileCategory = new DataFileCategory(); | ||
| dataFileCategory.setName(name); | ||
| return dataFileCategory; | ||
| }).collect(Collectors.toList()); | ||
| } | ||
|
|
||
| } |