Skip to content

Commit 3062944

Browse files
author
joeybloggs
committed
Renamed ImportExport Enum
- renamed from ExportFormat to ImportExportFormat. - renamed enum JSON to FormatJSON for clarity.
1 parent a51506c commit 3062944

File tree

3 files changed

+29
-29
lines changed

3 files changed

+29
-29
lines changed

‎examples/full-with-files/main.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,7 @@ func translatorMiddleware(next http.HandlerFunc) http.HandlerFunc {
195195

196196
func setup() {
197197

198-
err := utrans.Import(ut.JSON, "translations")
198+
err := utrans.Import(ut.FormatJSON, "translations")
199199
if err != nil {
200200
log.Fatal(err)
201201
}

‎import_export.go

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -27,18 +27,18 @@ const (
2727
rangeType = "Range"
2828
)
2929

30-
// ExportFormat is the format of the file import or export
31-
type ExportFormat uint8
30+
// ImportExportFormat is the format of the file import or export
31+
type ImportExportFormat uint8
3232

3333
// supported Export Formats
3434
const (
35-
JSON ExportFormat = iota
35+
FormatJSON ImportExportFormat = iota
3636
)
3737

3838
// Export writes the translations out to a file on disk.
3939
//
4040
// NOTE: this currently only works with string or int translations keys.
41-
func (t *UniversalTranslator) Export(format ExportFormat, dirname string) error {
41+
func (t *UniversalTranslator) Export(format ImportExportFormat, dirname string) error {
4242

4343
_, err := os.Stat(dirname)
4444
fmt.Println(dirname, err, os.IsNotExist(err))
@@ -129,7 +129,7 @@ func (t *UniversalTranslator) Export(format ExportFormat, dirname string) error
129129
}
130130

131131
switch format {
132-
case JSON:
132+
case FormatJSON:
133133
b, err = json.MarshalIndent(trans, "", " ")
134134
ext = ".json"
135135
}
@@ -152,7 +152,7 @@ func (t *UniversalTranslator) Export(format ExportFormat, dirname string) error
152152
// Import reads the translations out of a file or directory on disk.
153153
//
154154
// NOTE: this currently only works with string or int translations keys.
155-
func (t *UniversalTranslator) Import(format ExportFormat, dirnameOrFilename string) error {
155+
func (t *UniversalTranslator) Import(format ImportExportFormat, dirnameOrFilename string) error {
156156

157157
fi, err := os.Stat(dirnameOrFilename)
158158
if err != nil {
@@ -182,7 +182,7 @@ func (t *UniversalTranslator) Import(format ExportFormat, dirnameOrFilename stri
182182
}
183183

184184
switch format {
185-
case JSON:
185+
case FormatJSON:
186186
// skip non JSON files
187187
if filepath.Ext(info.Name()) != ".json" {
188188
return nil
@@ -198,7 +198,7 @@ func (t *UniversalTranslator) Import(format ExportFormat, dirnameOrFilename stri
198198
// ImportByReader imports the the translations found within the contents read from the supplied reader.
199199
//
200200
// NOTE: generally used when assets have been embedded into the binary and are already in memory.
201-
func (t *UniversalTranslator) ImportByReader(format ExportFormat, reader io.Reader) error {
201+
func (t *UniversalTranslator) ImportByReader(format ImportExportFormat, reader io.Reader) error {
202202

203203
b, err := ioutil.ReadAll(reader)
204204
if err != nil {
@@ -208,7 +208,7 @@ func (t *UniversalTranslator) ImportByReader(format ExportFormat, reader io.Read
208208
var trans []translation
209209

210210
switch format {
211-
case JSON:
211+
case FormatJSON:
212212
err = json.Unmarshal(b, &trans)
213213
}
214214

‎import_export_test.go

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -101,14 +101,14 @@ func TestExportImportBasic(t *testing.T) {
101101
dirname := "testdata/translations"
102102
defer os.RemoveAll(dirname)
103103

104-
err := uni.Export(JSON, dirname)
104+
err := uni.Export(FormatJSON, dirname)
105105
if err != nil {
106106
t.Fatalf("Expected '%v' Got '%s'", nil, err)
107107
}
108108

109109
uni = New(e, e)
110110

111-
err = uni.Import(JSON, dirname)
111+
err = uni.Import(FormatJSON, dirname)
112112
if err != nil {
113113
t.Fatalf("Expected '%v' Got '%s'", nil, err)
114114
}
@@ -230,14 +230,14 @@ func TestExportImportCardinal(t *testing.T) {
230230
dirname := "testdata/translations"
231231
defer os.RemoveAll(dirname)
232232

233-
err := uni.Export(JSON, dirname)
233+
err := uni.Export(FormatJSON, dirname)
234234
if err != nil {
235235
t.Fatalf("Expected '%v' Got '%s'", nil, err)
236236
}
237237

238238
uni = New(e, e)
239239

240-
err = uni.Import(JSON, dirname)
240+
err = uni.Import(FormatJSON, dirname)
241241
if err != nil {
242242
t.Fatalf("Expected '%v' Got '%s'", nil, err)
243243
}
@@ -367,14 +367,14 @@ func TestExportImportOrdinal(t *testing.T) {
367367
dirname := "testdata/translations"
368368
defer os.RemoveAll(dirname)
369369

370-
err := uni.Export(JSON, dirname)
370+
err := uni.Export(FormatJSON, dirname)
371371
if err != nil {
372372
t.Fatalf("Expected '%v' Got '%s'", nil, err)
373373
}
374374

375375
uni = New(e, e)
376376

377-
err = uni.Import(JSON, dirname)
377+
err = uni.Import(FormatJSON, dirname)
378378
if err != nil {
379379
t.Fatalf("Expected '%v' Got '%s'", nil, err)
380380
}
@@ -530,14 +530,14 @@ func TestExportImportRange(t *testing.T) {
530530
dirname := "testdata/translations"
531531
defer os.RemoveAll(dirname)
532532

533-
err := uni.Export(JSON, dirname)
533+
err := uni.Export(FormatJSON, dirname)
534534
if err != nil {
535535
t.Fatalf("Expected '%v' Got '%s'", nil, err)
536536
}
537537

538538
uni = New(n, n)
539539

540-
err = uni.Import(JSON, dirname)
540+
err = uni.Import(FormatJSON, dirname)
541541
if err != nil {
542542
t.Fatalf("Expected '%v' Got '%s'", nil, err)
543543
}
@@ -623,7 +623,7 @@ func TestImportRecursive(t *testing.T) {
623623
uni := New(e, e)
624624

625625
dirname := "testdata/nested1"
626-
err := uni.Import(JSON, dirname)
626+
err := uni.Import(FormatJSON, dirname)
627627
if err != nil {
628628
t.Fatalf("Expected '%v' Got '%s'", nil, err)
629629
}
@@ -687,55 +687,55 @@ func TestBadImport(t *testing.T) {
687687

688688
filename := "testdata/non-existant-file.json"
689689
expected := "stat testdata/non-existant-file.json: no such file or directory"
690-
err := uni.Import(JSON, filename)
690+
err := uni.Import(FormatJSON, filename)
691691
if err == nil || err.Error() != expected {
692692
t.Fatalf("Expected '%s' Got '%s'", expected, err)
693693
}
694694

695695
// test bad parameter basic translation
696696
filename = "testdata/bad-translation1.json"
697697
expected = "error: bad parameter syntax, missing parameter '{0}' in translation. locale: 'en' key: 'test_trans3' text: 'Welcome {lettersnotpermitted} to the {1}'"
698-
err = uni.Import(JSON, filename)
698+
err = uni.Import(FormatJSON, filename)
699699
if err == nil || err.Error() != expected {
700700
t.Fatalf("Expected '%s' Got '%s'", expected, err)
701701
}
702702

703703
// test missing bracket basic translation
704704
filename = "testdata/bad-translation2.json"
705705
expected = "error: missing bracket '{}', in translation. locale: 'en' key: 'test_trans3' text: 'Welcome {0 to the {1}'"
706-
err = uni.Import(JSON, filename)
706+
err = uni.Import(FormatJSON, filename)
707707
if err == nil || err.Error() != expected {
708708
t.Fatalf("Expected '%s' Got '%s'", expected, err)
709709
}
710710

711711
// test missing locale basic translation
712712
filename = "testdata/bad-translation3.json"
713713
expected = "error: locale 'nl' not registered."
714-
err = uni.Import(JSON, filename)
714+
err = uni.Import(FormatJSON, filename)
715715
if err == nil || err.Error() != expected {
716716
t.Fatalf("Expected '%s' Got '%s'", expected, err)
717717
}
718718

719719
// test bad plural definition
720720
filename = "testdata/bad-translation4.json"
721721
expected = "error: bad plural definition 'ut.translation{Locale:\"en\", Key:\"cardinal_test\", Translation:\"You have {0} day left.\", PluralType:\"NotAPluralType\", PluralRule:\"One\", OverrideExisting:false}'"
722-
err = uni.Import(JSON, filename)
722+
err = uni.Import(FormatJSON, filename)
723723
if err == nil || err.Error() != expected {
724724
t.Fatalf("Expected '%s' Got '%s'", expected, err)
725725
}
726726

727727
// test bad plural rule for locale
728728
filename = "testdata/bad-translation5.json"
729729
expected = "error: cardinal plural rule 'Many' does not exist for locale 'en' key: 'cardinal_test' text: 'You have {0} day left.'"
730-
err = uni.Import(JSON, filename)
730+
err = uni.Import(FormatJSON, filename)
731731
if err == nil || err.Error() != expected {
732732
t.Fatalf("Expected '%s' Got '%s'", expected, err)
733733
}
734734

735735
// test invalid JSON
736736
filename = "testdata/bad-translation6.json"
737737
expected = "invalid character ']' after object key:value pair"
738-
err = uni.Import(JSON, filename)
738+
err = uni.Import(FormatJSON, filename)
739739
if err == nil || err.Error() != expected {
740740
t.Fatalf("Expected '%s' Got '%s'", expected, err)
741741
}
@@ -748,7 +748,7 @@ func TestBadImport(t *testing.T) {
748748
f.Close()
749749

750750
expected = "read testdata/bad-translation6.json: bad file descriptor"
751-
err = uni.ImportByReader(JSON, f)
751+
err = uni.ImportByReader(FormatJSON, f)
752752
if err == nil || err.Error() != expected {
753753
t.Fatalf("Expected '%s' Got '%s'", expected, err)
754754
}
@@ -775,14 +775,14 @@ func TestBadExport(t *testing.T) {
775775
en.Add("day", "this is a day", false)
776776

777777
expected := "open testdata/readonly/en.json: permission denied"
778-
err = uni.Export(JSON, dirname)
778+
err = uni.Export(FormatJSON, dirname)
779779
if err == nil || err.Error() != expected {
780780
t.Fatalf("Expected '%s' Got '%s'", expected, err)
781781
}
782782

783783
// test exporting into directory inside readonly directory
784784
expected = "stat testdata/readonly/inner: permission denied"
785-
err = uni.Export(JSON, filepath.Join(dirname, "inner"))
785+
err = uni.Export(FormatJSON, filepath.Join(dirname, "inner"))
786786
if err == nil || err.Error() != expected {
787787
t.Fatalf("Expected '%s' Got '%s'", expected, err)
788788
}

0 commit comments

Comments
 (0)