Implement route to add words to dictionary

Author: cyradin

internal/routes/dictionary_item.go

@@ -0,0 +1,64 @@
+package routes
+
+import (
+	"context"
+	"errors"
+
+	"github.com/f1monkey/spellchecker-web/internal/spellchecker"
+	"github.com/swaggest/usecase"
+	"github.com/swaggest/usecase/status"
+)
+
+type DictionaryItemAddRequest struct {
+	Code string `path:"code" minLength:"1"`
+
+	Phrases []DictionaryItemPhrase `json:"phrases" minLength:"1"`
+}
+
+type DictionaryItemPhrase struct {
+	Text   string `json:"text" description:"The word or phrase to be added to the dictionary."`
+	Weight uint   `json:"weight" min:"1" description:"A numeric value indicating the importance or influence of this entry in spellchecking or suggestions."`
+}
+
+type DictionaryItemAddResponse struct {
+	Words int `json:"words" description:"Number of phrases successfully added."`
+}
+
+func dictionaryItemAdd(registry *spellchecker.Registry) usecase.Interactor {
+	u := usecase.NewInteractor(func(ctx context.Context, input DictionaryItemAddRequest, output *DictionaryItemAddResponse) error {
+		sc, err := registry.Get(input.Code)
+		if errors.Is(spellchecker.ErrNotFound, err) {
+			return status.Wrap(err, status.NotFound)
+		} else if err != nil {
+			return status.Wrap(err, status.Internal)
+		}
+
+		wordCnt := 0
+
+		for i := range input.Phrases {
+
+			words := wordSymbols.FindAllString(input.Phrases[i].Text, -1)
+			if len(words) == 0 {
+				continue
+			}
+
+			weight := input.Phrases[i].Weight
+			if weight == 0 {
+				weight = 1
+			}
+
+			sc.AddWeight(weight, words...)
+			wordCnt += len(words)
+		}
+
+		output.Words = wordCnt
+
+		return nil
+	})
+
+	u.SetTitle("Add phrases/words to spellchecker")
+	u.SetDescription("Adds one or more custom phrases or words to the spellchecker dictionary. Each phrase can have an optional weight to influence matching or prioritization.")
+	u.SetExpectedErrors(status.Internal)
+
+	return u
+}

internal/routes/routes.go

@@ -29,5 +29,9 @@ func dictionaryRoutes(registry *spellchecker.Registry) func(r chi.Router) {
 		r.Method(http.MethodPost, "/{code}/save", nethttp.NewHandler(
 			dictionarySave(registry)),
 		)
+
+		r.Method(http.MethodPost, "/{code}/add", nethttp.NewHandler(
+			dictionaryItemAdd(registry)),
+		)
 	}
 }

internal/spellchecker/registry.go

@@ -110,11 +110,16 @@ func (r *Registry) Add(code string, options Options) (*spellchecker.Spellchecker
 	return result, nil
 }
 
-func (r *Registry) Get(code string) *spellchecker.Spellchecker {
+func (r *Registry) Get(code string) (*spellchecker.Spellchecker, error) {
 	r.mu.RLock()
 	defer r.mu.RUnlock()
 
-	return r.items[code].Spellchecker
+	v, ok := r.items[code]
+	if !ok {
+		return nil, ErrNotFound
+	}
+
+	return v.Spellchecker, nil
 }
 
 func (r *Registry) Delete(code string) error {

internal/spellchecker/registry_test.go

@@ -148,15 +148,21 @@ func Test_Registry_Get(t *testing.T) {
 		_, err = r.Add("code", Options{Alphabet: "abc"})
 		require.NoError(t, err)
 
-		require.NotNil(t, r.Get("code"))
+		v, err := r.Get("code")
+		require.NoError(t, err)
+
+		require.NotNil(t, v)
 	})
 
 	t.Run("not found", func(t *testing.T) {
 		t.Parallel()
 
 		r, err := NewRegistry(context.Background(), t.TempDir())
 		require.NoError(t, err)
-		require.Nil(t, r.Get("code"))
+
+		v, err := r.Get("code")
+		require.ErrorIs(t, err, ErrNotFound)
+		require.Nil(t, v)
 	})
 }