Return correct words list in /fix route

Author: cyradin

README.md

@@ -72,7 +72,7 @@ Response:
             "suggestions": [
                 {
                     "text": "weapon",
-                    "score": 2.7081884344831684
+                    "score": 0.8239592165010822
                 }
             ],
             "error": "invalid_word"
@@ -83,7 +83,7 @@ Response:
             "suggestions": [
                 {
                     "text": "before",
-                    "score": 2.339371734389815
+                    "score": 0.7797905781299383
                 }
             ],
             "error": "invalid_word"
@@ -94,11 +94,37 @@ Response:
             "suggestions": [
                 {
                     "text": "battle",
-                    "score": 2.339371734389815
+                    "score": 0.7797905781299383
                 }
             ],
             "error": "invalid_word"
         }
+    ],
+    "correct": [
+        {
+            "start": 0,
+            "end": 3
+        },
+        {
+            "start": 4,
+            "end": 10
+        },
+        {
+            "start": 11,
+            "end": 17
+        },
+        {
+            "start": 18,
+            "end": 21
+        },
+        {
+            "start": 35,
+            "end": 43
+        },
+        {
+            "start": 44,
+            "end": 48
+        }
     ]
 }
 ```

internal/routes/dictionary_fix.go

@@ -24,7 +24,8 @@ type DictionaryFixRequest struct {
 }
 
 type DictionaryFixResponse struct {
-	Fixes []Fix `json:"fixes" description:"List of detected issues."`
+	Fixes   []Fix     `json:"fixes" description:"List of detected issues."`
+	Correct []Correct `json:"correct" description:"List of correct words."`
 }
 
 type Fix struct {
@@ -34,6 +35,11 @@ type Fix struct {
 	Error       string                   `json:"error" enum:"unknown_word,invalid_word" description:"Type of detected error. unknown_word - no possible corrections found; invalid_word - the word can be corrected using one of the provided suggestions"`
 }
 
+type Correct struct {
+	Start int `json:"start" description:"Starting character index of the word in the input."`
+	End   int `json:"end" description:"Ending character index."`
+}
+
 type SpellcheckerSuggestion struct {
 	Text  string  `json:"text" descrption:"Suggested corrected word."`
 	Score float64 `json:"score" description:"Confidence score of the suggestion."`
@@ -60,6 +66,7 @@ func dictionaryFix(registry dictionaryGetter, splitter *regexp.Regexp) usecase.I
 
 		matches := splitter.FindAllStringIndex(input.Text, -1)
 		fixes := make([]Fix, 0, len(matches))
+		correct := make([]Correct, 0, len(matches))
 
 		for _, match := range matches {
 			startByte, endByte := match[0], match[1]
@@ -76,6 +83,11 @@ func dictionaryFix(registry dictionaryGetter, splitter *regexp.Regexp) usecase.I
 			suggestions := sc.SuggestScore(word, input.Limit)
 
 			if suggestions.ExactMatch {
+				correct = append(correct, Correct{
+					Start: startRune,
+					End:   endRune,
+				})
+
 				continue
 			}
 
@@ -97,6 +109,7 @@ func dictionaryFix(registry dictionaryGetter, splitter *regexp.Regexp) usecase.I
 		}
 
 		output.Fixes = fixes
+		output.Correct = correct
 
 		return nil
 	})

internal/routes/dictionary_fix_test.go

@@ -37,19 +37,21 @@ func Test_DictionaryFix(t *testing.T) {
 	sc.Add("hello")
 
 	tests := []struct {
-		name      string
-		getter    dictionaryGetter
-		input     DictionaryFixRequest
-		wantErr   bool
-		wantCode  status.Code
-		wantFixes []Fix
+		name        string
+		getter      dictionaryGetter
+		input       DictionaryFixRequest
+		wantErr     bool
+		wantCode    status.Code
+		wantFixes   []Fix
+		wantCorrect []Correct
 	}{
 		{
-			name:      "empty text",
-			getter:    &testDictionaryGetter{sc: &f1mspellchecker.Spellchecker{}},
-			input:     DictionaryFixRequest{Code: "en", Text: "", Limit: 5},
-			wantErr:   false,
-			wantFixes: []Fix{},
+			name:        "empty text",
+			getter:      &testDictionaryGetter{sc: &f1mspellchecker.Spellchecker{}},
+			input:       DictionaryFixRequest{Code: "en", Text: "", Limit: 5},
+			wantErr:     false,
+			wantFixes:   []Fix{},
+			wantCorrect: []Correct{},
 		},
 		{
 			name: "exact match word",
@@ -59,6 +61,9 @@ func Test_DictionaryFix(t *testing.T) {
 			input:     DictionaryFixRequest{Code: "en", Text: "hello", Limit: 5},
 			wantErr:   false,
 			wantFixes: []Fix{},
+			wantCorrect: []Correct{
+				{Start: 0, End: 5},
+			},
 		},
 		{
 			name: "word with suggestions",
@@ -76,6 +81,7 @@ func Test_DictionaryFix(t *testing.T) {
 					},
 				},
 			},
+			wantCorrect: []Correct{},
 		},
 		{
 			name: "word without suggestions",
@@ -90,6 +96,7 @@ func Test_DictionaryFix(t *testing.T) {
 					Error: "unknown_word",
 				},
 			},
+			wantCorrect: []Correct{},
 		},
 		{
 			name:     "dictionary not found",
@@ -136,6 +143,13 @@ func Test_DictionaryFix(t *testing.T) {
 					assert.Equal(t, f.End, out.Fixes[i].End)
 					assert.Equal(t, f.Error, out.Fixes[i].Error)
 				}
+
+				require.Len(t, out.Correct, len(tt.wantCorrect))
+
+				for i, f := range tt.wantCorrect {
+					assert.Equal(t, f.Start, out.Correct[i].Start)
+					assert.Equal(t, f.End, out.Correct[i].End)
+				}
 			}
 		})
 	}