69 lines
1.7 KiB
Markdown
69 lines
1.7 KiB
Markdown
# Builder - fluent immutable builders for Go
|
|
|
|
[](https://godoc.org/github.com/lann/builder)
|
|
[](https://travis-ci.org/lann/builder)
|
|
|
|
Builder was originally written for
|
|
[Squirrel](https://github.com/lann/squirrel), a fluent SQL generator. It
|
|
is probably the best example of Builder in action.
|
|
|
|
Builder helps you write **fluent** DSLs for your libraries with method chaining:
|
|
|
|
```go
|
|
resp := ReqBuilder.
|
|
Url("http://golang.org").
|
|
Header("User-Agent", "Builder").
|
|
Get()
|
|
```
|
|
|
|
Builder uses **immutable** persistent data structures
|
|
([these](https://github.com/mndrix/ps), specifically)
|
|
so that each step in your method chain can be reused:
|
|
|
|
```go
|
|
build := WordBuilder.AddLetters("Build")
|
|
builder := build.AddLetters("er")
|
|
building := build.AddLetters("ing")
|
|
```
|
|
|
|
Builder makes it easy to **build** structs using the **builder** pattern
|
|
(*surprise!*):
|
|
|
|
```go
|
|
import "github.com/lann/builder"
|
|
|
|
type Muppet struct {
|
|
Name string
|
|
Friends []string
|
|
}
|
|
|
|
type muppetBuilder builder.Builder
|
|
|
|
func (b muppetBuilder) Name(name string) muppetBuilder {
|
|
return builder.Set(b, "Name", name).(muppetBuilder)
|
|
}
|
|
|
|
func (b muppetBuilder) AddFriend(friend string) muppetBuilder {
|
|
return builder.Append(b, "Friends", friend).(muppetBuilder)
|
|
}
|
|
|
|
func (b muppetBuilder) Build() Muppet {
|
|
return builder.GetStruct(b).(Muppet)
|
|
}
|
|
|
|
var MuppetBuilder = builder.Register(muppetBuilder{}, Muppet{}).(muppetBuilder)
|
|
```
|
|
```go
|
|
MuppetBuilder.
|
|
Name("Beaker").
|
|
AddFriend("Dr. Honeydew").
|
|
Build()
|
|
|
|
=> Muppet{Name:"Beaker", Friends:[]string{"Dr. Honeydew"}}
|
|
```
|
|
|
|
## License
|
|
|
|
Builder is released under the
|
|
[MIT License](http://www.opensource.org/licenses/MIT).
|