Easier form and form submission handling.

pkg/controller/form.go

@@ -1,104 +0,0 @@
-package controller
-
-import (
-	"github.com/go-playground/validator/v10"
-
-	"github.com/labstack/echo/v4"
-)
-
-// FormSubmission represents the state of the submission of a form, not including the form itself
-type FormSubmission struct {
-	// IsSubmitted indicates if the form has been submitted
-	IsSubmitted bool
-
-	// Errors stores a slice of error message strings keyed by form struct field name
-	Errors map[string][]string
-}
-
-// Process processes a submission for a form
-func (f *FormSubmission) Process(ctx echo.Context, form any) error {
-	f.Errors = make(map[string][]string)
-	f.IsSubmitted = true
-
-	// Validate the form
-	if err := ctx.Validate(form); err != nil {
-		f.setErrorMessages(err)
-	}
-
-	return nil
-}
-
-// HasErrors indicates if the submission has any validation errors
-func (f FormSubmission) HasErrors() bool {
-	if f.Errors == nil {
-		return false
-	}
-	return len(f.Errors) > 0
-}
-
-// FieldHasErrors indicates if a given field on the form has any validation errors
-func (f FormSubmission) FieldHasErrors(fieldName string) bool {
-	return len(f.GetFieldErrors(fieldName)) > 0
-}
-
-// SetFieldError sets an error message for a given field name
-func (f *FormSubmission) SetFieldError(fieldName string, message string) {
-	if f.Errors == nil {
-		f.Errors = make(map[string][]string)
-	}
-	f.Errors[fieldName] = append(f.Errors[fieldName], message)
-}
-
-// GetFieldErrors gets the errors for a given field name
-func (f FormSubmission) GetFieldErrors(fieldName string) []string {
-	if f.Errors == nil {
-		return []string{}
-	}
-	return f.Errors[fieldName]
-}
-
-// GetFieldStatusClass returns an HTML class based on the status of the field
-func (f FormSubmission) GetFieldStatusClass(fieldName string) string {
-	if f.IsSubmitted {
-		if f.FieldHasErrors(fieldName) {
-			return "is-danger"
-		}
-		return "is-success"
-	}
-	return ""
-}
-
-// IsDone indicates if the submission is considered done which is when it has been submitted
-// and there are no errors.
-func (f FormSubmission) IsDone() bool {
-	return f.IsSubmitted && !f.HasErrors()
-}
-
-// setErrorMessages sets errors messages on the submission for all fields that failed validation
-func (f *FormSubmission) setErrorMessages(err error) {
-	// Only this is supported right now
-	ves, ok := err.(validator.ValidationErrors)
-	if !ok {
-		return
-	}
-
-	for _, ve := range ves {
-		var message string
-
-		// Provide better error messages depending on the failed validation tag
-		// This should be expanded as you use additional tags in your validation
-		switch ve.Tag() {
-		case "required":
-			message = "This field is required."
-		case "email":
-			message = "Enter a valid email address."
-		case "eqfield":
-			message = "Does not match."
-		default:
-			message = "Invalid value."
-		}
-
-		// Add the error
-		f.SetFieldError(ve.Field(), message)
-	}
-}

pkg/controller/form_test.go

@@ -1,36 +0,0 @@
-package controller
-
-import (
-	"testing"
-
-	"github.com/mikestefanello/pagoda/pkg/tests"
-
-	"github.com/stretchr/testify/assert"
-	"github.com/stretchr/testify/require"
-)
-
-func TestFormSubmission(t *testing.T) {
-	type formTest struct {
-		Name       string `validate:"required"`
-		Email      string `validate:"required,email"`
-		Submission FormSubmission
-	}
-
-	ctx, _ := tests.NewContext(c.Web, "/")
-	form := formTest{
-		Name:  "",
-		Email: "a@a.com",
-	}
-	err := form.Submission.Process(ctx, form)
-	assert.NoError(t, err)
-
-	assert.True(t, form.Submission.HasErrors())
-	assert.True(t, form.Submission.FieldHasErrors("Name"))
-	assert.False(t, form.Submission.FieldHasErrors("Email"))
-	require.Len(t, form.Submission.GetFieldErrors("Name"), 1)
-	assert.Len(t, form.Submission.GetFieldErrors("Email"), 0)
-	assert.Equal(t, "This field is required.", form.Submission.GetFieldErrors("Name")[0])
-	assert.Equal(t, "is-danger", form.Submission.GetFieldStatusClass("Name"))
-	assert.Equal(t, "is-success", form.Submission.GetFieldStatusClass("Email"))
-	assert.False(t, form.Submission.IsDone())
-}