feat(#122): additional fields data synchronization is optional

README.md

@@ -99,14 +99,15 @@ Example:
 ### Parameters description
 
 | Parameter                          | UI      | Description                                                                                        | Default value |
-| ---------------------------------- | ------- | -------------------------------------------------------------------------------------------------- | ------------- |
+|------------------------------------| ------- |----------------------------------------------------------------------------------------------------| ------------- |
 | `area_observation_duration`        | ☐ | Area observation duration period (in days)                                                         | 365           |
 | `sync`                             | ☐ | Data synchronization settings (cf. https://github.com/PnX-SI/gn_mobile_core/tree/develop/datasync) |               |
 | `map`                              | ☐ | Maps settings (cf. https://github.com/PnX-SI/gn_mobile_maps/tree/develop/maps)                     |               |
 | `input`                            | ☐ | Input form settings                                                                                |               |
 | `input/date`                       | ☐ | Date settings                                                                                      |               |
 | `nomenclature`                     | ☐ | Nomenclature settings                                                                              |               |
 | `nomenclature/save_default_values` | ☐ | Save default nomenclature values                                                                   | false         |
+| `nomenclature/additional_fields`   | ☐ | Show additional fields                                                                             | false         |
 | `nomenclature/information`         | ☐ | Information settings (as array)                                                                    |               |
 | `nomenclature/counting`            | ☐ | Counting settings (as array)                                                                       |               |
 

occtax/src/main/java/fr/geonature/occtax/features/nomenclature/NomenclatureModule.kt

@@ -1,10 +1,8 @@
 package fr.geonature.occtax.features.nomenclature
 
-import android.content.Context
 import dagger.Module
 import dagger.Provides
 import dagger.hilt.InstallIn
-import dagger.hilt.android.qualifiers.ApplicationContext
 import dagger.hilt.components.SingletonComponent
 import fr.geonature.commons.data.GeoNatureModuleName
 import fr.geonature.commons.data.LocalDatabase
@@ -14,8 +12,6 @@ import fr.geonature.commons.features.nomenclature.data.AdditionalFieldLocalDataS
 import fr.geonature.commons.features.nomenclature.data.IAdditionalFieldLocalDataSource
 import fr.geonature.commons.features.nomenclature.data.INomenclatureLocalDataSource
 import fr.geonature.commons.features.nomenclature.data.NomenclatureLocalDataSourceImpl
-import fr.geonature.datasync.api.IGeoNatureAPIClient
-import fr.geonature.datasync.sync.repository.ISynchronizeAdditionalDataRepository
 import fr.geonature.occtax.features.nomenclature.data.INomenclatureSettingsLocalDataSource
 import fr.geonature.occtax.features.nomenclature.data.IPropertyValueLocalDataSource
 import fr.geonature.occtax.features.nomenclature.data.InMemoryPropertyValueLocalDataSourceImpl
@@ -26,7 +22,6 @@ import fr.geonature.occtax.features.nomenclature.repository.IAdditionalFieldRepo
 import fr.geonature.occtax.features.nomenclature.repository.IDefaultPropertyValueRepository
 import fr.geonature.occtax.features.nomenclature.repository.INomenclatureRepository
 import fr.geonature.occtax.features.nomenclature.repository.NomenclatureRepositoryImpl
-import fr.geonature.occtax.features.nomenclature.repository.SynchronizeAdditionalFieldRepositoryImpl
 import javax.inject.Singleton
 
 /**
@@ -107,20 +102,4 @@ object NomenclatureModule {
     ): IAdditionalFieldRepository {
         return AdditionalFieldRepositoryImpl(additionalFieldLocalDataSource)
     }
-
-    @Singleton
-    @Provides
-    fun provideSynchronizeAdditionalFieldRepository(
-        @ApplicationContext appContext: Context,
-        @GeoNatureModuleName moduleName: String,
-        additionalFieldLocalDataSource: IAdditionalFieldLocalDataSource,
-        geoNatureAPIClient: IGeoNatureAPIClient,
-    ): ISynchronizeAdditionalDataRepository {
-        return SynchronizeAdditionalFieldRepositoryImpl(
-            appContext,
-            moduleName,
-            additionalFieldLocalDataSource,
-            geoNatureAPIClient
-        )
-    }
 }

occtax/src/main/java/fr/geonature/occtax/features/nomenclature/presentation/NomenclatureViewModel.kt

@@ -39,13 +39,15 @@ class NomenclatureViewModel @Inject constructor(
      */
     fun getEditableFields(
         datasetId: Long? = null,
+        withAdditionalFields: Boolean = false,
         type: EditableField.Type,
         defaultPropertySettings: List<PropertySettings> = listOf(),
         taxonomy: Taxonomy? = null
     ) {
         getEditableFieldsUseCase(
             GetEditableFieldsUseCase.Params(
                 datasetId,
+                withAdditionalFields,
                 type,
                 defaultPropertySettings,
                 taxonomy

occtax/src/main/java/fr/geonature/occtax/features/nomenclature/usecase/GetEditableFieldsUseCase.kt

@@ -35,11 +35,12 @@ class GetEditableFieldsUseCase @Inject constructor(
                     )
                 }
             } +
-            additionalFieldRepository.getAllAdditionalFields(
+            if (params.withAdditionalFields) additionalFieldRepository.getAllAdditionalFields(
                 params.datasetId,
                 params.type
             )
-                .getOrDefault(emptyList()))
+                .getOrDefault(emptyList()) else emptyList())
+
             // set media type at last position
             .sortedWith { a, b ->
                 if (a.viewType == EditableField.ViewType.MEDIA) 1
@@ -69,6 +70,7 @@ class GetEditableFieldsUseCase @Inject constructor(
 
     data class Params(
         val datasetId: Long? = null,
+        val withAdditionalFields: Boolean = false,
         val type: EditableField.Type,
         val settings: List<PropertySettings> = listOf(),
         val taxonomy: Taxonomy? = null

occtax/src/main/java/fr/geonature/occtax/features/record/presentation/ObservationRecordViewModel.kt

@@ -175,12 +175,19 @@ class ObservationRecordViewModel @Inject constructor(
      * Start edit the given [ObservationRecord].
      *
      * @param observationRecord the [ObservationRecord] to edit
+     * @param withAdditionalFields whether we want to manage additional fields
      */
-    fun startEdit(observationRecord: ObservationRecord) {
+    fun startEdit(
+        observationRecord: ObservationRecord,
+        withAdditionalFields: Boolean = false
+    ) {
         Logger.info { "loading default nomenclature values from record '${observationRecord.internalId}'..." }
 
         editObservationRecordUseCase(
-            EditObservationRecordUseCase.Params(observationRecord),
+            EditObservationRecordUseCase.Params(
+                observationRecord,
+                withAdditionalFields
+            ),
             viewModelScope
         ) {
             it.fold(

occtax/src/main/java/fr/geonature/occtax/features/record/usecase/EditObservationRecordUseCase.kt

@@ -23,7 +23,12 @@ class EditObservationRecordUseCase @Inject constructor(
         Logger.info { "loading default nomenclature values from record '${params.observationRecord.internalId}'..." }
 
         var result =
-            setDefaultNomenclatureValuesUseCase.run(SetDefaultNomenclatureValuesUseCase.Params(params.observationRecord))
+            setDefaultNomenclatureValuesUseCase.run(
+                SetDefaultNomenclatureValuesUseCase.Params(
+                    params.observationRecord,
+                    params.withAdditionalFields
+                )
+            )
 
         if (result.isFailure) {
             Logger.error { "failed to load default nomenclature values from record '${params.observationRecord.internalId}" }
@@ -48,5 +53,8 @@ class EditObservationRecordUseCase @Inject constructor(
         return result
     }
 
-    data class Params(val observationRecord: ObservationRecord)
+    data class Params(
+        val observationRecord: ObservationRecord,
+        val withAdditionalFields: Boolean = false
+    )
 }

occtax/src/main/java/fr/geonature/occtax/features/record/usecase/SetDefaultNomenclatureValuesUseCase.kt

@@ -47,11 +47,11 @@ class SetDefaultNomenclatureValuesUseCase @Inject constructor(
 
         val editableFieldsInformation =
             nomenclatureRepository.getEditableFields(EditableField.Type.INFORMATION)
-                .getOrElse { emptyList() } + additionalFieldRepository.getAllAdditionalFields(
+                .getOrElse { emptyList() } + if (params.withAdditionalFields) additionalFieldRepository.getAllAdditionalFields(
                 observationRecord.dataset.datasetId,
                 EditableField.Type.INFORMATION
             )
-                .getOrElse { emptyList() }
+                .getOrElse { emptyList() } else emptyList()
 
         if (editableFieldsInformation.isEmpty()) {
             Logger.warn {
@@ -67,11 +67,11 @@ class SetDefaultNomenclatureValuesUseCase @Inject constructor(
 
         val editableFieldsCounting =
             nomenclatureRepository.getEditableFields(EditableField.Type.COUNTING)
-                .getOrElse { emptyList() } + additionalFieldRepository.getAllAdditionalFields(
+                .getOrElse { emptyList() } + if (params.withAdditionalFields) additionalFieldRepository.getAllAdditionalFields(
                 observationRecord.dataset.datasetId,
                 EditableField.Type.COUNTING
             )
-                .getOrElse { emptyList() }
+                .getOrElse { emptyList() } else emptyList()
 
         if (editableFieldsCounting.isEmpty()) {
             Logger.warn {
@@ -162,5 +162,8 @@ class SetDefaultNomenclatureValuesUseCase @Inject constructor(
         }
     }
 
-    data class Params(val observationRecord: ObservationRecord)
+    data class Params(
+        val observationRecord: ObservationRecord,
+        val withAdditionalFields: Boolean = false
+    )
 }

occtax/src/main/java/fr/geonature/occtax/settings/NomenclatureSettings.kt

@@ -10,7 +10,17 @@ import kotlinx.parcelize.Parcelize
  */
 @Parcelize
 data class NomenclatureSettings(
+    /**
+     * Whether we want to save locally and only during a session of use selected nomenclature values
+     * as default values.
+     */
     val saveDefaultValues: Boolean = false,
+
+    /**
+     * Whether we want to show additional fields
+     */
+    val withAdditionalFields: Boolean = false,
+
     val information: List<PropertySettings>,
     val counting: List<PropertySettings>
 ) : Parcelable

occtax/src/main/java/fr/geonature/occtax/settings/io/OnAppSettingsJsonReaderListenerImpl.kt

@@ -126,6 +126,7 @@ class OnAppSettingsJsonReaderListenerImpl :
         }
 
         var saveDefaultValues = false
+        var withAdditionalFields = false
         val information = mutableListOf<PropertySettings>()
         val counting = mutableListOf<PropertySettings>()
 
@@ -134,6 +135,7 @@ class OnAppSettingsJsonReaderListenerImpl :
         while (reader.hasNext()) {
             when (reader.nextName()) {
                 "save_default_values" -> saveDefaultValues = reader.nextBooleanOrElse { false }
+                "additional_fields" -> withAdditionalFields = reader.nextBooleanOrElse { false }
                 "information" -> information.addAll(readPropertySettingsAsList(reader))
                 "counting" -> counting.addAll(readPropertySettingsAsList(reader))
                 else -> reader.skipValue()
@@ -144,6 +146,7 @@ class OnAppSettingsJsonReaderListenerImpl :
 
         return NomenclatureSettings(
             saveDefaultValues = saveDefaultValues,
+            withAdditionalFields = withAdditionalFields,
             information = information,
             counting = counting
         )
@@ -206,11 +209,13 @@ class OnAppSettingsJsonReaderListenerImpl :
                     default
                 )
             }
+
             JsonToken.STRING -> PropertySettings(
                 reader.nextString(),
                 visible = true,
                 default = true
             )
+
             else -> {
                 reader.skipValue()
                 null

occtax/src/main/java/fr/geonature/occtax/ui/home/HomeActivity.kt

@@ -147,6 +147,7 @@ class HomeActivity : AppCompatActivity(),
                 appSettings?.dataSyncSettings?.also { dataSyncSettings ->
                     dataSyncViewModel.startSync(
                         dataSyncSettings,
+                        appSettings?.nomenclatureSettings?.withAdditionalFields ?: false,
                         HomeActivity::class.java,
                         MainApplication.CHANNEL_DATA_SYNCHRONIZATION
                     )
@@ -201,6 +202,7 @@ class HomeActivity : AppCompatActivity(),
                         } else {
                             dataSyncViewModel.startSync(
                                 dataSyncSettings,
+                                appSettings?.nomenclatureSettings?.withAdditionalFields ?: false,
                                 HomeActivity::class.java,
                                 MainApplication.CHANNEL_DATA_SYNCHRONIZATION
                             )
@@ -402,13 +404,15 @@ class HomeActivity : AppCompatActivity(),
                     it.dataSyncSettings?.also { dataSyncSettings ->
                         dataSyncViewModel.configurePeriodicSync(
                             dataSyncSettings,
+                            appSettings?.nomenclatureSettings?.withAdditionalFields ?: false,
                             HomeActivity::class.java,
                             MainApplication.CHANNEL_DATA_SYNCHRONIZATION
                         )
 
                         if (dataSyncViewModel.lastSynchronizedDate.value?.second == null) {
                             dataSyncViewModel.startSync(
                                 dataSyncSettings,
+                                appSettings?.nomenclatureSettings?.withAdditionalFields ?: false,
                                 HomeActivity::class.java,
                                 MainApplication.CHANNEL_DATA_SYNCHRONIZATION
                             )
@@ -434,6 +438,8 @@ class HomeActivity : AppCompatActivity(),
 
                                             dataSyncViewModel.startSync(
                                                 dataSyncSettings,
+                                                appSettings?.nomenclatureSettings?.withAdditionalFields
+                                                    ?: false,
                                                 HomeActivity::class.java,
                                                 MainApplication.CHANNEL_DATA_SYNCHRONIZATION
                                             )
@@ -446,6 +452,8 @@ class HomeActivity : AppCompatActivity(),
 
                                     dataSyncViewModel.startSync(
                                         dataSyncSettings,
+                                        appSettings?.nomenclatureSettings?.withAdditionalFields
+                                            ?: false,
                                         HomeActivity::class.java,
                                         MainApplication.CHANNEL_DATA_SYNCHRONIZATION
                                     )

occtax/src/main/java/fr/geonature/occtax/ui/input/InputPagerFragmentActivity.kt

@@ -184,11 +184,15 @@ class InputPagerFragmentActivity : AbstractPagerFragmentActivity(),
             R.string.pager_fragment_taxa_title to TaxaFragment.newInstance(appSettings.areaObservationDuration),
             R.string.pager_fragment_information_title to InformationFragment.newInstance(
                 saveDefaultValues = appSettings.nomenclatureSettings?.saveDefaultValues ?: false,
+                withAdditionalFields = appSettings.nomenclatureSettings?.withAdditionalFields
+                    ?: false,
                 *appSettings.nomenclatureSettings?.information?.toTypedArray()
                     ?: emptyArray()
             ),
             R.string.pager_fragment_counting_title to CountingFragment.newInstance(
                 saveDefaultValues = appSettings.nomenclatureSettings?.saveDefaultValues ?: false,
+                withAdditionalFields = appSettings.nomenclatureSettings?.withAdditionalFields
+                    ?: false,
                 *appSettings.nomenclatureSettings?.counting?.toTypedArray()
                     ?: emptyArray()
             ),