MLPAB-1757: Extract field name and options to YesNoForm (#965)

internal/form/names.go

@@ -10,11 +10,13 @@ var FieldNames = SharedFieldNames{
 		Postcode:   "address-postcode",
 		Action:     "action",
 	},
+	YesNo: "yes-no",
 }
 
 type SharedFieldNames struct {
 	Address            AddressFieldNames
 	LanguagePreference string
+	YesNo              string
 }
 
 type AddressFieldNames struct {

internal/form/yes_no.go

@@ -1,9 +1,10 @@
 package form
 
-//go:generate enumerator -type YesNo -linecomment -empty
+//go:generate enumerator -type YesNo -linecomment -trimprefix
 type YesNo uint8
 
 const (
-	Yes YesNo = iota + 1 // yes
-	No                   // no
+	YesNoUnknown YesNo = iota
+	Yes                // yes
+	No                 // no
 )

internal/form/yes_no_form.go

@@ -11,22 +11,23 @@ type YesNoForm struct {
 	YesNo      YesNo
 	Error      error
 	ErrorLabel string
+	Options    YesNoOptions
+	FieldName  string
 }
 
 func ReadYesNoForm(r *http.Request, errorLabel string) *YesNoForm {
-	yesNo, err := ParseYesNo(PostFormString(r, "yes-no"))
+	form := NewYesNoForm(YesNoUnknown)
 
-	return &YesNoForm{
-		YesNo:      yesNo,
-		Error:      err,
-		ErrorLabel: errorLabel,
-	}
+	form.YesNo, form.Error = ParseYesNo(PostFormString(r, form.FieldName))
+	form.ErrorLabel = errorLabel
+
+	return form
 }
 
 func (f *YesNoForm) Validate() validation.List {
 	var errors validation.List
 
-	errors.Error("yes-no", f.ErrorLabel, f.Error,
+	errors.Error(f.FieldName, f.ErrorLabel, f.Error,
 		validation.Selected())
 
 	return errors
@@ -35,3 +36,11 @@ func (f *YesNoForm) Validate() validation.List {
 func PostFormString(r *http.Request, name string) string {
 	return strings.TrimSpace(r.PostFormValue(name))
 }
+
+func NewYesNoForm(yesNo YesNo) *YesNoForm {
+	return &YesNoForm{
+		YesNo:     yesNo,
+		Options:   YesNoValues,
+		FieldName: FieldNames.YesNo,
+	}
+}

internal/form/yes_no_form_test.go

@@ -12,11 +12,11 @@ import (
 )
 
 func TestReadYesNoForm(t *testing.T) {
-	form := url.Values{"yes-no": {Yes.String()}}
+	form := url.Values{FieldNames.YesNo: {Yes.String()}}
 	r, _ := http.NewRequest(http.MethodPost, "/", strings.NewReader(form.Encode()))
 	r.Header.Add("Content-Type", "application/x-www-form-urlencoded")
 
-	assert.Equal(t, &YesNoForm{YesNo: Yes, ErrorLabel: "a-label"}, ReadYesNoForm(r, "a-label"))
+	assert.Equal(t, &YesNoForm{YesNo: Yes, ErrorLabel: "a-label", Options: YesNoValues, FieldName: FieldNames.YesNo}, ReadYesNoForm(r, "a-label"))
 }
 
 func TestYesNoFormValidate(t *testing.T) {
@@ -25,11 +25,11 @@ func TestYesNoFormValidate(t *testing.T) {
 		errors validation.List
 	}{
 		"valid": {
-			form: &YesNoForm{},
+			form: NewYesNoForm(YesNoUnknown),
 		},
 		"invalid": {
-			form:   &YesNoForm{Error: errors.New("err"), ErrorLabel: "a-label"},
-			errors: validation.With("yes-no", validation.SelectError{Label: "a-label"}),
+			form:   &YesNoForm{Error: errors.New("err"), ErrorLabel: "a-label", FieldName: FieldNames.YesNo},
+			errors: validation.With(FieldNames.YesNo, validation.SelectError{Label: "a-label"}),
 		},
 	}
 
@@ -39,3 +39,13 @@ func TestYesNoFormValidate(t *testing.T) {
 		})
 	}
 }
+
+func TestNewYesNoForm(t *testing.T) {
+	for _, yesNo := range []YesNo{Yes, No, YesNoUnknown} {
+		assert.Equal(t, &YesNoForm{
+			YesNo:     yesNo,
+			Options:   YesNoValues,
+			FieldName: "yes-no",
+		}, NewYesNoForm(yesNo))
+	}
+}

internal/page/attorney/would_like_second_signatory.go

@@ -12,18 +12,16 @@ import (
 )
 
 type wouldLikeSecondSignatoryData struct {
-	App     page.AppData
-	Errors  validation.List
-	YesNo   form.YesNo
-	Options form.YesNoOptions
+	App    page.AppData
+	Errors validation.List
+	Form   *form.YesNoForm
 }
 
 func WouldLikeSecondSignatory(tmpl template.Template, attorneyStore AttorneyStore, donorStore DonorStore, lpaStoreClient LpaStoreClient) Handler {
 	return func(appData page.AppData, w http.ResponseWriter, r *http.Request, attorneyProvidedDetails *actor.AttorneyProvidedDetails) error {
 		data := &wouldLikeSecondSignatoryData{
-			App:     appData,
-			YesNo:   attorneyProvidedDetails.WouldLikeSecondSignatory,
-			Options: form.YesNoValues,
+			App:  appData,
+			Form: form.NewYesNoForm(attorneyProvidedDetails.WouldLikeSecondSignatory),
 		}
 
 		if r.Method == http.MethodPost {

internal/page/attorney/would_like_second_signatory_test.go

@@ -23,8 +23,8 @@ func TestGetWouldLikeSecondSignatory(t *testing.T) {
 	template := newMockTemplate(t)
 	template.EXPECT().
 		Execute(w, &wouldLikeSecondSignatoryData{
-			App:     testAppData,
-			Options: form.YesNoValues,
+			App:  testAppData,
+			Form: form.NewYesNoForm(form.YesNoUnknown),
 		}).
 		Return(nil)
 
@@ -42,8 +42,8 @@ func TestGetWouldLikeSecondSignatoryWhenTemplateErrors(t *testing.T) {
 	template := newMockTemplate(t)
 	template.EXPECT().
 		Execute(w, &wouldLikeSecondSignatoryData{
-			App:     testAppData,
-			Options: form.YesNoValues,
+			App:  testAppData,
+			Form: form.NewYesNoForm(form.YesNoUnknown),
 		}).
 		Return(expectedError)
 
@@ -56,7 +56,7 @@ func TestGetWouldLikeSecondSignatoryWhenTemplateErrors(t *testing.T) {
 
 func TestPostWouldLikeSecondSignatoryWhenYes(t *testing.T) {
 	f := url.Values{
-		"yes-no": {form.Yes.String()},
+		form.FieldNames.YesNo: {form.Yes.String()},
 	}
 
 	w := httptest.NewRecorder()
@@ -89,7 +89,7 @@ func TestPostWouldLikeSecondSignatoryWhenNo(t *testing.T) {
 	}
 
 	f := url.Values{
-		"yes-no": {form.No.String()},
+		form.FieldNames.YesNo: {form.No.String()},
 	}
 
 	w := httptest.NewRecorder()
@@ -125,7 +125,7 @@ func TestPostWouldLikeSecondSignatoryWhenLpaStoreClientErrors(t *testing.T) {
 	donor := &actor.DonorProvidedDetails{SignedAt: time.Now()}
 
 	f := url.Values{
-		"yes-no": {form.No.String()},
+		form.FieldNames.YesNo: {form.No.String()},
 	}
 
 	w := httptest.NewRecorder()
@@ -153,7 +153,7 @@ func TestPostWouldLikeSecondSignatoryWhenLpaStoreClientErrors(t *testing.T) {
 
 func TestPostWouldLikeSecondSignatoryWhenDonorStoreErrors(t *testing.T) {
 	f := url.Values{
-		"yes-no": {form.No.String()},
+		form.FieldNames.YesNo: {form.No.String()},
 	}
 
 	w := httptest.NewRecorder()
@@ -176,7 +176,7 @@ func TestPostWouldLikeSecondSignatoryWhenDonorStoreErrors(t *testing.T) {
 
 func TestPostWouldLikeSecondSignatoryWhenAttorneyStoreErrors(t *testing.T) {
 	form := url.Values{
-		"yes-no": {form.No.String()},
+		form.FieldNames.YesNo: {form.No.String()},
 	}
 
 	w := httptest.NewRecorder()
@@ -193,15 +193,15 @@ func TestPostWouldLikeSecondSignatoryWhenAttorneyStoreErrors(t *testing.T) {
 }
 
 func TestPostWouldLikeSecondSignatoryWhenValidationError(t *testing.T) {
-	form := url.Values{
-		"yes-no": {""},
+	f := url.Values{
+		form.FieldNames.YesNo: {""},
 	}
 
 	w := httptest.NewRecorder()
-	r, _ := http.NewRequest(http.MethodPost, "/", strings.NewReader(form.Encode()))
+	r, _ := http.NewRequest(http.MethodPost, "/", strings.NewReader(f.Encode()))
 	r.Header.Add("Content-Type", page.FormUrlEncoded)
 
-	validationError := validation.With("yes-no", validation.SelectError{Label: "yesIfWouldLikeSecondSignatory"})
+	validationError := validation.With(form.FieldNames.YesNo, validation.SelectError{Label: "yesIfWouldLikeSecondSignatory"})
 
 	template := newMockTemplate(t)
 	template.EXPECT().

internal/page/data.go

@@ -80,7 +80,7 @@ func ChooseReplacementAttorneysState(donor *actor.DonorProvidedDetails) actor.Ta
 	}
 
 	if donor.ReplacementAttorneys.Len() == 0 {
-		if donor.WantReplacementAttorneys.Empty() {
+		if donor.WantReplacementAttorneys.IsUnknown() {
 			return actor.TaskNotStarted
 		}
 

internal/page/donor/are_you_applying_for_fee_discount_or_exemption.go

@@ -10,20 +10,19 @@ import (
 	"github.com/ministryofjustice/opg-modernising-lpa/internal/validation"
 )
 
-type areYouApplyingForFeeDiscountOrExemption struct {
+type areYouApplyingForFeeDiscountOrExemptionData struct {
 	App                 page.AppData
 	Errors              validation.List
 	CertificateProvider actor.CertificateProvider
-	Options             form.YesNoOptions
 	Form                *form.YesNoForm
 }
 
 func AreYouApplyingForFeeDiscountOrExemption(tmpl template.Template, payer Payer, donorStore DonorStore) Handler {
 	return func(appData page.AppData, w http.ResponseWriter, r *http.Request, donor *actor.DonorProvidedDetails) error {
-		data := &areYouApplyingForFeeDiscountOrExemption{
+		data := &areYouApplyingForFeeDiscountOrExemptionData{
 			App:                 appData,
 			CertificateProvider: donor.CertificateProvider,
-			Options:             form.YesNoValues,
+			Form:                form.NewYesNoForm(form.YesNoUnknown),
 		}
 
 		if r.Method == http.MethodPost {