Changeset 10 in code


Ignore:
Timestamp:
Sep 30, 2022, 8:16:23 PM (3 years ago)
Author:
fattalion
Message:

Make some identifiers more concise

See ​https://go.dev/doc/effective_go#package-names, specifically:

The importer of a package will use the name to refer to its contents,
so exported names in the package can use that fact to avoid
repetition.

For example, engines.GoogleTranslateEngine needlessly repeats
"engine," so just get rid of that duplication by renaming it to
engines.GoogleTranslate.

Renaming engines.TranslationEngine to engines.Engine may be
debatable, so if somebody disagrees, feel free to leave a comment
stating your disagreement and with an explanation of why you disagree.

Location:
trunk
Files:
5 edited

Legend:

Unmodified
Added
Removed

  • trunk/engines/engine.go

    r9 r10  
    66}
    77
    8 type TranslationEngine interface {
     8type Engine interface {
    99        InternalName() string
    1010        DisplayName() string

  • trunk/engines/google.go

    r9 r10  
    99)
    1010
    11 type GoogleTranslateEngine struct{}
     11type GoogleTranslate struct{}
    1212
    13 func (_ *GoogleTranslateEngine) InternalName() string { return "google" }
     13func (_ *GoogleTranslate) InternalName() string { return "google" }
    1414
    15 func (_ *GoogleTranslateEngine) DisplayName() string { return "Google" }
     15func (_ *GoogleTranslate) DisplayName() string { return "Google" }
    1616
    17 func (_ *GoogleTranslateEngine) getLangs(type_ string) ([]Language, error) {
     17func (_ *GoogleTranslate) getLangs(type_ string) ([]Language, error) {
    1818        var langsType string
    1919        switch type_ {
    … …  
    8484}
    8585
    86 func (e *GoogleTranslateEngine) SourceLanguages() ([]Language, error) {
     86func (e *GoogleTranslate) SourceLanguages() ([]Language, error) {
    8787        return e.getLangs("source")
    8888}
    8989
    90 func (e *GoogleTranslateEngine) TargetLanguages() ([]Language, error) {
     90func (e *GoogleTranslate) TargetLanguages() ([]Language, error) {
    9191        return e.getLangs("target")
    9292}
    9393
    94 func (_ *GoogleTranslateEngine) SupportsAutodetect() bool { return true }
     94func (_ *GoogleTranslate) SupportsAutodetect() bool { return true }
    9595
    96 func (_ *GoogleTranslateEngine) DetectLanguage(text string) (Language, error) { return Language{}, nil }
     96func (_ *GoogleTranslate) DetectLanguage(text string) (Language, error) { return Language{}, nil }
    9797
    98 func (_ *GoogleTranslateEngine) Translate(text string, from Language, to Language) (TranslationResult, error) {
     98func (_ *GoogleTranslate) Translate(text string, from Language, to Language) (TranslationResult, error) {
    9999        requestURL, err := url.Parse("https://translate.google.com/m")
    100100

  • trunk/engines/iciba.go

    r9 r10  
    1010)
    1111
    12 // ICIBAEngine is an engine that fetches data from https://www.iciba.com.
    13 type ICIBAEngine struct{}
    14 
    15 func (_ *ICIBAEngine) InternalName() string { return "iciba" }
    16 
    17 func (_ *ICIBAEngine) DisplayName() string { return "iCIBA" }
     12// ICIBA is an engine that fetches data from https://www.iciba.com.
     13type ICIBA struct{}
     14
     15func (_ *ICIBA) InternalName() string { return "iciba" }
     16
     17func (_ *ICIBA) DisplayName() string { return "iCIBA" }
    1818
    1919var icibaLanguages = []Language{
    … …  
    212212}
    213213
    214 func (_ *ICIBAEngine) SourceLanguages() ([]Language, error) { return icibaLanguages, nil }
    215 
    216 func (_ *ICIBAEngine) TargetLanguages() ([]Language, error) { return icibaLanguages, nil }
    217 
    218 func (_ *ICIBAEngine) SupportsAutodetect() bool { return true }
    219 
    220 func (_ *ICIBAEngine) DetectLanguage(text string) (Language, error) { return Language{}, nil }
     214func (_ *ICIBA) SourceLanguages() ([]Language, error) { return icibaLanguages, nil }
     215
     216func (_ *ICIBA) TargetLanguages() ([]Language, error) { return icibaLanguages, nil }
     217
     218func (_ *ICIBA) SupportsAutodetect() bool { return true }
     219
     220func (_ *ICIBA) DetectLanguage(text string) (Language, error) { return Language{}, nil }
    221221
    222222type icibaTranslateResponse struct {
    … …  
    227227}
    228228
    229 func (_ *ICIBAEngine) Translate(text string, from Language, to Language) (TranslationResult, error) {
     229func (_ *ICIBA) Translate(text string, from Language, to Language) (TranslationResult, error) {
    230230        requestURL, err := url.Parse("https://ifanyi.iciba.com/index.php")
    231231

  • trunk/engines/libretranslate.go

    r9 r10  
    88)
    99
    10 // LibreTranslateEngine is an engine that interfaces with any
     10// LibreTranslate is an engine that interfaces with any
    1111// [LibreTranslate](https://github.com/LibreTranslate/LibreTranslate) instance.
    12 type LibreTranslateEngine struct {
     12type LibreTranslate struct {
    1313        // InstanceURL is the URL to a LibreTranslate instance, for instance
    1414        // "https://libretranslate.com".
    … …  
    2424}
    2525
    26 func (_ *LibreTranslateEngine) InternalName() string { return "libre" }
     26func (_ *LibreTranslate) InternalName() string { return "libre" }
    2727
    28 func (_ *LibreTranslateEngine) DisplayName() string { return "LibreTranslate" }
     28func (_ *LibreTranslate) DisplayName() string { return "LibreTranslate" }
    2929
    3030type libreLanguagesResponse []struct {
    … …  
    3333}
    3434
    35 func (e *LibreTranslateEngine) getLangs() ([]Language, error) {
     35func (e *LibreTranslate) getLangs() ([]Language, error) {
    3636        response, err := http.Get(e.InstanceURL + "/languages")
    3737
    … …  
    6262}
    6363
    64 func (e *LibreTranslateEngine) SourceLanguages() ([]Language, error) { return e.getLangs() }
     64func (e *LibreTranslate) SourceLanguages() ([]Language, error) { return e.getLangs() }
    6565
    66 func (e *LibreTranslateEngine) TargetLanguages() ([]Language, error) { return e.getLangs() }
     66func (e *LibreTranslate) TargetLanguages() ([]Language, error) { return e.getLangs() }
    6767
    68 func (_ *LibreTranslateEngine) SupportsAutodetect() bool { return true }
     68func (_ *LibreTranslate) SupportsAutodetect() bool { return true }
    6969
    7070type libreDetectResponse []struct {
    … …  
    7373}
    7474
    75 func (e *LibreTranslateEngine) DetectLanguage(text string) (Language, error) {
     75func (e *LibreTranslate) DetectLanguage(text string) (Language, error) {
    7676        formData := map[string]string{"q": text}
    7777
    … …  
    131131}
    132132
    133 func (e *LibreTranslateEngine) Translate(text string, from Language, to Language) (TranslationResult, error) {
     133func (e *LibreTranslate) Translate(text string, from Language, to Language) (TranslationResult, error) {
    134134        formData := map[string]string{
    135135                "q":      text,

  • trunk/web/main.go

    r9 r10  
    88
    99func main() {
    10         engine := &engines.GoogleTranslateEngine{}
     10        engine := &engines.GoogleTranslate{}
    1111        print(engine.DisplayName())
    1212}
Note: See TracChangeset for help on using the changeset viewer.