Light

lann / builder Goto Github PK

View Code? Open in Web Editor NEW

219.0 3.0 17.0 18 KB

Fluent immutable builders for golang

License: MIT License

Go 100.00%

builder's Introduction

Builder - fluent immutable builders for Go

Builder was originally written for 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:

resp := ReqBuilder.
    Url("http://golang.org").
    Header("User-Agent", "Builder").
    Get()

Builder uses immutable persistent data structures (these, specifically) so that each step in your method chain can be reused:

build := WordBuilder.AddLetters("Build")
builder := build.AddLetters("er")
building := build.AddLetters("ing")

Builder makes it easy to build structs using the builder pattern (surprise!):

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)

MuppetBuilder.
    Name("Beaker").
    AddFriend("Dr. Honeydew").
    Build()

=> Muppet{Name:"Beaker", Friends:[]string{"Dr. Honeydew"}}

License

Builder is released under the MIT License.

builder's People

Contributors

Stargazers

Watchers

Forkers

talbright venumeda abrahambotros etsangsplk schmaluk danmeyers alan-ma-umg kc1116 adityabh tespeletacab geoeee qktrzrj slavabobik mannharleen peczenyj s5364733

builder's Issues

Error occor when I run go get

go get -u github.com/lann/squirrel

and the reply:

lann/builder/builder.go:149: cannot use func literal (type func(string, ps.Any)) as type func(string, interface {}) in argument to m.ForEach
lann/builder/builder.go:203: cannot use func literal (type func(string, ps.Any)) as type func(string, interface {}) in argument to getBuilderMap(builder).ForEach

Create a twitter account

omg, srsly

Re-using builder across structs that build the same way

I'm new to go, and working on a rest API client implementation. I came across your builder and thought it would be a great way to make it easier for users to create structs used in making requests. I've been trying to find a way to use the same builder across different structs, but can't figure out how. Is this possible?

See the following gist:

https://gist.github.com/talbright/3e4b99ec870c416e61b8

Thanks in advance...

Support go module

Would you support go module in this repo?

ps.Any is gone

This commit broke builder:

mndrix/ps@c047077

Get order of operations the user has entered

Is it possible to get the order of operations the user has entered? I am trying to port the hapijs/Joi object schema validation to Go. Here is how the Joi library in NodeJS is used. Joi modifies and returns the final value as it is being validated; for example, if it says the value has to be in uppercase, the input value is uppercased and if a default value is specified, Joi sets the default value if there is none specified. In NodeJS, I use it for everything including URL query values, form input values, outgoing data, etc. I decided to attempt to port this as I could not find a good solution already available in Go.


var schema = Joi.object().keys({
    username: Joi.string().alphanum().min(3).max(30).required(),
    password: Joi.string().regex(/^[a-zA-Z0-9]{3,30}$/),
    access_token: [Joi.string(), Joi.number()],
    birthyear: Joi.number().integer().min(1900).max(2013),
    email: Joi.string().email()
}).with('username', 'birthyear').without('password', 'access_token');

Joi.validate({ username: 'abc', birthyear: 1994 }, schema, function (err, value) { });  // err === null -> valid

Goroutine issues

Hey I am using builder in a few different spots in my application as well as in multiple different goroutines. Is this package thread safe? I see that the registry.go map always panics about concurrent map writes

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.