From 4d675da582a7873d514483b7cde82178367dd74a Mon Sep 17 00:00:00 2001
From: Debbie Mong'are <debbiearita96@gmail.com>
Date: Wed, 31 Jan 2024 19:07:05 +0300
Subject: [PATCH] Allow modification of Questionnaire submit action button text
 via configuration (#2319)

* Allow modification of Questionnaire submit action button text via configuration

* Run spotlessApply

* Update test to check that button text is editable

* Update test to check that button text is editable

* :art: Apply Spotless formatting

* Empty commit

* Resolve merge conflicts

---------

Co-authored-by: Allan Onchuru <a.onchuru@gmail.com>
Co-authored-by: Francis Odhiambo <4540684+f-odhiambo@users.noreply.github.com>
Co-authored-by: Benjamin Mwalimu <dubdabasoduba@gmail.com>
Co-authored-by: Allan Onchuru <16164649+allan-on@users.noreply.github.com>
---
 .../fhir/catalog/DemoQuestionnaireFragment.kt |  5 ++-
 .../fhir/datacapture/QuestionnaireFragment.kt | 38 ++++++++++++-------
 .../datacapture/QuestionnaireFragmentTest.kt  | 32 ++++++++++++++++
 .../android/fhir/demo/AddPatientFragment.kt   |  5 ++-
 4 files changed, 65 insertions(+), 15 deletions(-)

diff --git a/catalog/src/main/java/com/google/android/fhir/catalog/DemoQuestionnaireFragment.kt b/catalog/src/main/java/com/google/android/fhir/catalog/DemoQuestionnaireFragment.kt
index b9f8309e27..0af0417951 100644
--- a/catalog/src/main/java/com/google/android/fhir/catalog/DemoQuestionnaireFragment.kt
+++ b/catalog/src/main/java/com/google/android/fhir/catalog/DemoQuestionnaireFragment.kt
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 Google LLC
+ * Copyright 2023-2024 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -174,6 +174,9 @@ class DemoQuestionnaireFragment : Fragment() {
                 .encodeResourceToString(Patient().apply { id = "P1" })
                 .let { mapOf("patient" to it) },
             )
+            .setSubmitButtonText(
+              getString(com.google.android.fhir.datacapture.R.string.submit_questionnaire),
+            )
             .build(),
           QUESTIONNAIRE_FRAGMENT_TAG,
         )
diff --git a/datacapture/src/main/java/com/google/android/fhir/datacapture/QuestionnaireFragment.kt b/datacapture/src/main/java/com/google/android/fhir/datacapture/QuestionnaireFragment.kt
index 83841800c7..e93e4a704d 100644
--- a/datacapture/src/main/java/com/google/android/fhir/datacapture/QuestionnaireFragment.kt
+++ b/datacapture/src/main/java/com/google/android/fhir/datacapture/QuestionnaireFragment.kt
@@ -102,21 +102,28 @@ class QuestionnaireFragment : Fragment() {
         .show(requireActivity().supportFragmentManager, QuestionnaireCancelDialogFragment.TAG)
     }
 
-    view.findViewById<Button>(R.id.submit_questionnaire).setOnClickListener {
-      viewModel.validateQuestionnaireAndUpdateUI().let { validationMap ->
-        if (validationMap.values.flatten().filterIsInstance<Invalid>().isEmpty()) {
-          setFragmentResult(SUBMIT_REQUEST_KEY, Bundle.EMPTY)
-        } else {
-          val errorViewModel: QuestionnaireValidationErrorViewModel by activityViewModels()
-          errorViewModel.setQuestionnaireAndValidation(viewModel.questionnaire, validationMap)
-          QuestionnaireValidationErrorMessageDialogFragment()
-            .show(
-              requireActivity().supportFragmentManager,
-              QuestionnaireValidationErrorMessageDialogFragment.TAG,
-            )
+    view
+      .findViewById<Button>(R.id.submit_questionnaire)
+      .apply {
+        text =
+          requireArguments()
+            .getString(EXTRA_SUBMIT_BUTTON_TEXT, getString(R.string.submit_questionnaire))
+      }
+      .setOnClickListener {
+        viewModel.validateQuestionnaireAndUpdateUI().let { validationMap ->
+          if (validationMap.values.flatten().filterIsInstance<Invalid>().isEmpty()) {
+            setFragmentResult(SUBMIT_REQUEST_KEY, Bundle.EMPTY)
+          } else {
+            val errorViewModel: QuestionnaireValidationErrorViewModel by activityViewModels()
+            errorViewModel.setQuestionnaireAndValidation(viewModel.questionnaire, validationMap)
+            QuestionnaireValidationErrorMessageDialogFragment()
+              .show(
+                requireActivity().supportFragmentManager,
+                QuestionnaireValidationErrorMessageDialogFragment.TAG,
+              )
+          }
         }
       }
-    }
     val questionnaireProgressIndicator: LinearProgressIndicator =
       view.findViewById(R.id.questionnaire_progress_indicator)
     val questionnaireEditAdapter =
@@ -407,6 +414,9 @@ class QuestionnaireFragment : Fragment() {
      */
     fun setShowSubmitButton(value: Boolean) = apply { args.add(EXTRA_SHOW_SUBMIT_BUTTON to value) }
 
+    /** To accept a configurable text for the submit button */
+    fun setSubmitButtonText(text: String) = apply { args.add(EXTRA_SUBMIT_BUTTON_TEXT to text) }
+
     /**
      * A [Boolean] extra to show or hide the Cancel button in the questionnaire. Default is true.
      */
@@ -509,6 +519,8 @@ class QuestionnaireFragment : Fragment() {
 
     internal const val EXTRA_SHOW_REQUIRED_TEXT = "show-required-text"
 
+    internal const val EXTRA_SUBMIT_BUTTON_TEXT = "submit-button-text"
+
     fun builder() = Builder()
   }
 
diff --git a/datacapture/src/test/java/com/google/android/fhir/datacapture/QuestionnaireFragmentTest.kt b/datacapture/src/test/java/com/google/android/fhir/datacapture/QuestionnaireFragmentTest.kt
index b699b29597..07b5390553 100644
--- a/datacapture/src/test/java/com/google/android/fhir/datacapture/QuestionnaireFragmentTest.kt
+++ b/datacapture/src/test/java/com/google/android/fhir/datacapture/QuestionnaireFragmentTest.kt
@@ -32,6 +32,7 @@ import com.google.android.fhir.datacapture.QuestionnaireFragment.Companion.EXTRA
 import com.google.android.fhir.datacapture.testing.DataCaptureTestApplication
 import com.google.android.fhir.datacapture.views.factories.DateTimePickerViewHolderFactory
 import com.google.common.truth.Truth.assertThat
+import kotlin.test.assertEquals
 import org.hl7.fhir.r4.model.Questionnaire
 import org.junit.Before
 import org.junit.Test
@@ -139,6 +140,37 @@ class QuestionnaireFragmentTest {
       .isEqualTo(View.VISIBLE)
   }
 
+  @Test
+  fun `questionnaire submit button text should be editable`() {
+    val questionnaire =
+      Questionnaire().apply {
+        id = "a-questionnaire"
+        addItem(
+          Questionnaire.QuestionnaireItemComponent().apply {
+            linkId = "a-link-id"
+            type = Questionnaire.QuestionnaireItemType.BOOLEAN
+          },
+        )
+      }
+    val questionnaireJson = parser.encodeResourceToString(questionnaire)
+    val customButtonText = "Apply"
+    val scenario =
+      launchFragmentInContainer<QuestionnaireFragment>(
+        QuestionnaireFragment.builder()
+          .setQuestionnaire(questionnaireJson)
+          .setSubmitButtonText(customButtonText)
+          .buildArgs(),
+      )
+
+    scenario.moveToState(Lifecycle.State.RESUMED)
+
+    val button =
+      scenario.withFragment { this.requireView().findViewById<Button>(R.id.submit_questionnaire) }
+
+    val buttonText = button.text.toString()
+    assertEquals(buttonText, customButtonText)
+  }
+
   @Test
   fun `should hide next button on last page`() {
     val questionnaireJson =
diff --git a/demo/src/main/java/com/google/android/fhir/demo/AddPatientFragment.kt b/demo/src/main/java/com/google/android/fhir/demo/AddPatientFragment.kt
index 8712d12407..2d7b014b02 100644
--- a/demo/src/main/java/com/google/android/fhir/demo/AddPatientFragment.kt
+++ b/demo/src/main/java/com/google/android/fhir/demo/AddPatientFragment.kt
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 Google LLC
+ * Copyright 2023-2024 Google LLC
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -88,6 +88,9 @@ class AddPatientFragment : Fragment(R.layout.add_patient_fragment) {
         QuestionnaireFragment.builder()
           .setQuestionnaire(viewModel.questionnaireJson)
           .setShowCancelButton(true)
+          .setSubmitButtonText(
+            getString(com.google.android.fhir.datacapture.R.string.submit_questionnaire),
+          )
           .build(),
         QUESTIONNAIRE_FRAGMENT_TAG,
       )