src: translator: renaming

Signed-off-by: Dmitrii Aleksandrov <goodmobiledevices@gmail.com>

Author: Insei

examples/translation/main.go

@@ -4,11 +4,12 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
+	"regexp"
+
 	"github.com/google/uuid"
 	"github.com/insei/valigo"
 	"github.com/insei/valigo/str"
 	"github.com/insei/valigo/translator"
-	"regexp"
 )
 
 type Sender struct {
@@ -32,7 +33,7 @@ const (
 func manualValidatorSettings() *valigo.Validator {
 	tStorage := translator.NewInMemStorage()
 	// if you want to add new translation for you custom validators
-	tStorage.AddTranslations("en", map[string]string{
+	tStorage.Add("en", map[string]string{
 		customRegexpLocaleKey: customRegexpLocaleMsg,
 	})
 	t := translator.New(translator.WithStorage(tStorage), translator.WithDefaultLang("en"))

options_test.go

@@ -15,7 +15,7 @@ const (
 
 func TestOptionApply(t *testing.T) {
 	tStorage := translator.NewInMemStorage()
-	tStorage.AddTranslations("en", map[string]string{
+	tStorage.Add("en", map[string]string{
 		customRegexpLocaleKey: customRegexpLocaleMsg,
 	})
 	tr := translator.New(translator.WithStorage(tStorage), translator.WithDefaultLang("en"))
@@ -60,7 +60,7 @@ func TestOptionApplyWithNilFieldLocationNamingFn(t *testing.T) {
 
 func TestOptionApplyWithMultipleOptions(t *testing.T) {
 	tStorage := translator.NewInMemStorage()
-	tStorage.AddTranslations("en", map[string]string{
+	tStorage.Add("en", map[string]string{
 		customRegexpLocaleKey: customRegexpLocaleMsg,
 	})
 	tr := translator.New(translator.WithStorage(tStorage), translator.WithDefaultLang("en"))

translator/inmem.go

@@ -11,7 +11,7 @@ type inMemTranslatorStorage struct {
 // NewInMemStorage creates a new in-memory translation storage.
 // It loads initial data from the embedded locales YAML file.
 // If an error occurs during loading, it panics.
-func NewInMemStorage(opts ...InMemStorageOption) TranslationStorage {
+func NewInMemStorage(opts ...InMemStorageOption) Storage {
 	data, err := LocalesFromFS(EmbedFSLocalesYAML)
 	if err != nil {
 		panic(err)
@@ -23,8 +23,8 @@ func NewInMemStorage(opts ...InMemStorageOption) TranslationStorage {
 	return storage
 }
 
-// AddTranslations adds new translations for a given language to the storage.
-func (t *inMemTranslatorStorage) AddTranslations(lang string, data map[string]string) {
+// Add adds new translations for a given language to the storage.
+func (t *inMemTranslatorStorage) Add(lang string, data map[string]string) {
 	if _, ok := t.translations[lang]; !ok {
 		t.translations[lang] = data
 	}
@@ -33,8 +33,8 @@ func (t *inMemTranslatorStorage) AddTranslations(lang string, data map[string]st
 	}
 }
 
-// GetTranslated returns the translated value for a given format and language preferences.
-func (t *inMemTranslatorStorage) GetTranslated(prefer []string, format string, args ...any) string {
+// Get returns the translated value for a given format and language preferences.
+func (t *inMemTranslatorStorage) Get(prefer []string, format string, args ...any) string {
 	translatedFormat := format
 	for _, preferLang := range prefer {
 		langFormat, ok := t.translations[preferLang][format]

translator/inmem_test.go

@@ -10,7 +10,7 @@ func TestInMemTranslatorStorage(t *testing.T) {
 	data := map[string]string{
 		"hello": "Hello, %s!",
 	}
-	storage.AddTranslations(lang, data)
+	storage.Add(lang, data)
 	if _, ok := storage.(*inMemTranslatorStorage).translations[lang]; !ok {
 		t.Errorf("expected translations to be added for lang %s", lang)
 	}
@@ -21,15 +21,15 @@ func TestInMemTranslatorStorage(t *testing.T) {
 	prefer := []string{"en", "fr"}
 	format := "hello"
 	args := []any{"John"}
-	translated := storage.GetTranslated(prefer, format, args...)
+	translated := storage.Get(prefer, format, args...)
 	if translated != "Hello, John!" {
 		t.Errorf("expected translated string to be 'Hello, John!', got '%s'", translated)
 	}
 
 	prefer = []string{"es", "fr"}
 	format = "hello"
 	args = []any{"John"}
-	translated = storage.GetTranslated(prefer, format, args...)
+	translated = storage.Get(prefer, format, args...)
 	if translated != "hello%!(EXTRA string=John)" {
 		t.Errorf("expected translated string to be empty, got '%s'", translated)
 	}
@@ -42,12 +42,12 @@ func TestInMemTranslatorStorageAddTranslations_ExistingLang(t *testing.T) {
 	data := map[string]string{
 		"hello": "Hello, %s!",
 	}
-	storage.AddTranslations(lang, data)
+	storage.Add(lang, data)
 
 	newData := map[string]string{
 		"goodbye": "Goodbye, %s!",
 	}
-	storage.AddTranslations(lang, newData)
+	storage.Add(lang, newData)
 
 	if _, ok := storage.(*inMemTranslatorStorage).translations[lang]["goodbye"]; !ok {
 		t.Errorf("expected new translation to be added for key 'goodbye' in lang %s", lang)
@@ -59,7 +59,7 @@ func TestInMemTranslatorStorage_GetTranslated_NoPrefer(t *testing.T) {
 
 	format := "hello"
 	args := []any{"John"}
-	translated := storage.GetTranslated(nil, format, args...)
+	translated := storage.Get(nil, format, args...)
 	if translated != "hello%!(EXTRA string=John)" {
 		t.Errorf("expected translated string to be empty, got '%s'", translated)
 	}

translator/options.go

@@ -4,7 +4,7 @@ import "context"
 
 // storageOption represents an option to set the storage for a translator.
 type storageOption struct {
-	storage TranslationStorageRO
+	storage StorageRO
 }
 
 // apply sets the storage for the given translator.
@@ -13,7 +13,7 @@ func (o *storageOption) apply(t *translator) {
 }
 
 // WithStorage returns an option to set the storage for a translator.
-func WithStorage(storage TranslationStorageRO) Option {
+func WithStorage(storage StorageRO) Option {
 	return &storageOption{storage}
 }
 

translator/options_test.go

@@ -12,7 +12,7 @@ const mockTranslatedString = "mock translated string"
 
 type mockStorage struct{}
 
-func (m *mockStorage) GetTranslated(prefer []string, format string, args ...any) string {
+func (m *mockStorage) Get(prefer []string, format string, args ...any) string {
 	return mockTranslatedString
 }
 

translator/translator.go

@@ -8,7 +8,7 @@ import (
 
 // Translator is a struct that handles translations.
 type translator struct {
-	storage               TranslationStorageRO
+	storage               StorageRO
 	getPreferredLanguages func(ctx context.Context) []string
 	defaultLang           string
 }
@@ -25,12 +25,12 @@ func (t *translator) getLanguages(ctx context.Context) []string {
 
 // ErrorT returns a translated error message.
 func (t *translator) ErrorT(ctx context.Context, format string, args ...any) error {
-	return fmt.Errorf(t.storage.GetTranslated(t.getLanguages(ctx), format, args...))
+	return fmt.Errorf(t.storage.Get(t.getLanguages(ctx), format, args...))
 }
 
 // T returns a translated string.
 func (t *translator) T(ctx context.Context, format string, args ...any) string {
-	return t.storage.GetTranslated(t.getLanguages(ctx), format, args...)
+	return t.storage.Get(t.getLanguages(ctx), format, args...)
 }
 
 // New returns a new Translator instance with default settings.

translator/types.go

@@ -13,18 +13,18 @@ type Translator interface {
 	T(ctx context.Context, format string, args ...any) string
 }
 
-// TranslationStorageRO interface defines a method for retrieving translated text.
-type TranslationStorageRO interface {
-	// GetTranslated returns a translated string based on the provided preferences, format, and arguments.
-	GetTranslated(prefer []string, format string, args ...any) string
+// StorageRO interface defines a method for retrieving translated text.
+type StorageRO interface {
+	// Get returns a translated string based on the provided preferences, format, and arguments.
+	Get(prefer []string, format string, args ...any) string
 }
 
-// TranslationStorage interface extends TranslationStorageRO and adds a method for adding new translations.
-type TranslationStorage interface {
-	TranslationStorageRO
+// Storage interface extends StorageRO and adds a method for adding new translations.
+type Storage interface {
+	StorageRO
 
-	// AddTranslations adds translations for a specific language.
-	AddTranslations(lang string, data map[string]string)
+	// Add adds translations for a specific language.
+	Add(lang string, data map[string]string)
 }
 
 // Option interface defines a method for applying options to a translator.