gotify

README

gotify

a library to generate Goish variables, fields and package names from regular words

Installation

go get -u github.com/sirkon/gotify

or

dep ensure -add github.com/sirkon/gotify

Usage

package main

import (
	"fmt"

	"github.com/sirkon/gotify"
)

func main() {
	g := gotify.New(map[string]string{
		"uid": "UID",
	})
	fmt.Println(g.Public("user_id"))
	fmt.Println(g.Private("uid_1"))
	fmt.Println(g.Private("uniqId"))
	fmt.Println(g.Package("string_sum"))
	fmt.Println(g.Goimports("string_sum"))
	fmt.Println(g.True("userID"))
	fmt.Println(g.True("1userID"))
}

will output

UserID
uid1
uniqID
stringsum
string-sum
true
false

Documentation

Index

• type Gotify
  • func New(src map[string]string) *Gotify
  • func Pure() *Gotify
  • func (g *Gotify) Goimports(data string) string
  • func (g *Gotify) Package(name string) string
  • func (g *Gotify) Private(name string) string
  • func (g *Gotify) Public(name string) string
  • func (g *Gotify) True(name string) bool

Types

type Gotify

type Gotify struct {
	// contains filtered or unexported fields
}

Gotify provides "gotification" of domain specific identifier names:

underscored names translates into camel case ones.

How the translation is done:

idenitifier name is splitted into chunks and each chunk is to be lowered, samples:
abc_def -> [abc, def]
AbdDef  -> [abd, def]
userId  -> [user, id]

Then there are choice:

package name (just concat)
private identifiers (first chunk is kept lowered, the rest is treated as for public identifiers)
public identifiers:

Eeach chunk is looked up in provided dictionary (id -> ID translation is always here) and is replaced with either found translation or just with titled word and then concatenated into the string

abc_def -> AbdDef
AbdDef  -> AbdDef
userId  -> UserID

func New

func New(src map[string]string) *Gotify

New constructs Gotify object

func Pure

func Pure() *Gotify

Pure чистый преобразователь без трюков

func (*Gotify) Goimports

func (g *Gotify) Goimports(data string) string

Goimports generates directory name that can be consumed by goformat utility

func (*Gotify) Package

func (g *Gotify) Package(name string) string

Package generates acceptable package name

func (*Gotify) Private

func (g *Gotify) Private(name string) string

Private translates identifier into Go private identifier name

func (*Gotify) Public

func (g *Gotify) Public(name string) string

Public translates identifier into Go public identifier name

func (*Gotify) True

func (g *Gotify) True(name string) bool

True checks if this a goish identifier