README.md

builder

What is builder?

Code generating tool for initialize entity keep while keeping encapsulation. In order to lock our business logic into models, we need to use private fields, which makes it difficult for other packages to initialize models. So, builder generates model builder structs and funcs.

Installation

$ go get -u github.com/arabian9ts/builder

Example

This struct express user entity and is in ./entity package.

type User struct {
	id        string `build:"ID" get:"GetID" set:"SetID"`
	name      string `build:"" get:"" set:""`
	digest    string
	timestamp int64  `get:"" set:""`
}

To generate user builders, specify the target package(s).

$ builder entity

Then, user builder is generated as following.

user_builder.go

type UserBuilder struct {
	id        string
	name      string
	digest    string
	timestamp int64
}

func NewUserBuilder() *UserBuilder {
	return &UserBuilder{}
}

func (userBuilder *UserBuilder) ID(id string) *UserBuilder {
	userBuilder.id = id
	return userBuilder
}

func (userBuilder *UserBuilder) Name(name string) *UserBuilder {
	userBuilder.name = name
	return userBuilder
}

func (userBuilder *UserBuilder) Digest(digest string) *UserBuilder {
	userBuilder.digest = digest
	return userBuilder
}

func (userBuilder *UserBuilder) Timestamp(timestamp int64) *UserBuilder {
	userBuilder.timestamp = timestamp
	return userBuilder
}

func (userBuilder UserBuilder) Build() *User {
	return &User{
		digest:    userBuilder.digest,
		id:        userBuilder.id,
		name:      userBuilder.name,
		timestamp: userBuilder.timestamp,
	}
}

user_accessor.go

func (user *User) GetID() string {
	return user.id
}

func (user *User) GetName() string {
	return user.name
}

func (user *User) GetTimestamp() int64 {
	return user.timestamp
}

func (user *User) SetID(id string) {
	user.id = id
}

func (user *User) SetName(name string) {
	user.name = name
}

func (user *User) SetTimestamp(timestamp int64) {
	user.timestamp = timestamp
}

The Usage of these builder code is ...

user := NewUserBuilder().
    ID("id").
    Name("name").
    Timestamp(time.Now().Unix()).
    Build()

ToDo

• skip struct tag for ignore generating builder func.
• getter or setter func with struct tag