https://github.com/arabian9ts/builder
struct builder written in golang
https://github.com/arabian9ts/builder
builder builder-generator builder-pattern cli golang
Last synced: about 1 month ago
JSON representation
struct builder written in golang
- Host: GitHub
- URL: https://github.com/arabian9ts/builder
- Owner: arabian9ts
- License: mit
- Created: 2020-05-20T12:18:47.000Z (about 5 years ago)
- Default Branch: dev
- Last Pushed: 2020-05-31T11:33:49.000Z (almost 5 years ago)
- Last Synced: 2025-04-15T23:09:38.519Z (about 1 month ago)
- Topics: builder, builder-generator, builder-pattern, cli, golang
- Language: Go
- Homepage:
- Size: 30.3 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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
```sh
$ go get -u github.com/arabian9ts/builder
```
## Example
This struct express user entity and is in `./entity` package.
```go
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).
```sh
$ builder entity
```
Then, user builder is generated as following.
**user_builder.go**
```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**
```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 ...
```go
user := NewUserBuilder().
ID("id").
Name("name").
Timestamp(time.Now().Unix()).
Build()
```
## ToDo
- [x] skip struct tag for ignore generating builder func.
- [x] getter or setter func with struct tag