Bastard Go

A collection of terrible things in I felt like writing in Go

Most of the things in this repository use genny to generate code, so to really play with any of this horrible stuff, you should run

go get github.com/cheekybits/genny
go install github.com/cheekybits/genny

go get github.com/johnmurray/bastard-go

For more details on Genny and how the generation works and options to use with the command, head on over to their GitHub page. For examples, see the examples folder.

Fair Warning: This code is just me playing around with what it would look like if Go has some sort of generic programming capability and/or me just feeling like writing something ridiculous in Go. You likely shouldn't use any of this in production code. If you really want to, feel free but I make absolutely no promises that any of this code is correct or safe.

TOC

• Concurrent Types
  • Future
• Data Structures
  • coll.Ringbuffer
• Functional Types
  • Either
  • Maybe
  • Try
• Contributing
• License

Concurrent Types

Future

// TODO: write docs

Data Structures

coll.Ringbuffer

While writing a scheduler for Futures, I needed a way to distribute work amongst workers for my scheduling code and wanted to use a ring-buffer because it sounded like it would be fun to write. What follows was a non-thread-safe ring-buffer that is poorly tested. Either way the API is rather simple. Create a new one with a fixed size, push and pop, or empty the buffer.

The ring-buffer uses genny to generate templates which allow it to work very similar to a version using generics. To use in your own projects:

cd $YOUR_PROJECT
mkdir buffer

// Generate for as many types as you like. Simply including a comma-delimited list for `Type` will
// cause genny to generate multiple templates.
//
//go:generate genny -in=$GOPATH/src/github.com/johnmurray/bastard-go/coll/ringbuffer.go.tmp -out=buffer/ringbuffer.go gen "Type=int,string,float"

Functional Types

Either

This is a right-bias Either type that uses genny to generate templates which allow it to work very vimilar to a version using generics. However, this is probably the clearest example (in this project) where generics would greatly simplify the boilerplate of code-generation as it is a multi-type container that has the ability to map to other Either types with different underlying "generic" types. Creating a many-to-many mapping that makes generation tricky and cumbersome.

To use in your own projects:

cd $YOUR_PROJECT
mkdir either

// Generate for as many types as you like. Simply including a comma-delimited list for
// `TypeA` and `TypeB` will cause genny to generate multiple templates. Note that providing
// multiple for both inputs will create every possible combination.
//
//go:generate genny -in=$GOPATH/src/github.com/johnmurray/bastard-go/either/either_base.go.tmp -out=either/either_base.go gen "TypeA=int,string,bool TypeB=int,string,bool"

// Another command will generate the "composition" functions which allow you to convert
// from one type to another // when using Map, FlatMap, etc. This is also necessary for
// generating same-type conversions. Such as:
//   eitherStringOrInt.MapRightToInt(func (i int) int { return i * 2 })
//
// Note that to avoid generating duplicate functions (due to so many input types and overlapping
// righ/left combinations) the `ToTypeA` and `ToTypeB` should be done one at a time, using the same
// value for each:
//
//go:generate genny -in=$GOPATH/src/github.com/johnmurray/bastard-go/either/either_compose.go.tmp -out=either/either_compose_1.go gen "FromTypeA=int,string,bool FromTypeB=int,string,bool ToTypeA=int ToTypeB=int"
//go:generate genny -in=$GOPATH/src/github.com/johnmurray/bastard-go/either/either_compose.go.tmp -out=either/either_compose_2.go gen "FromTypeA=int,string,bool FromTypeB=int,string,bool ToTypeA=string ToTypeB=string"
//go:generate genny -in=$GOPATH/src/github.com/johnmurray/bastard-go/either/either_compose.go.tmp -out=either/either_compose_3.go gen "FromTypeA=int,string,bool FromTypeB=int,string,bool ToTypeA=bool ToTypeB=bool"

Maybe

This is a Scala/Haskell like Some/Maybe object that uses genny to generate templates which allow it to work very similar to a version using generics. To use in your own projects:

cd $YOUR_PROJECT
mkdir maybe

// Generate for as many types as you like. Simply including a comma-delimited list for
// `Type` will cause genny to generate multiple templates.
//
//go:generate genny -in=$GOPATH/src/github.com/johnmurray/bastard-go/maybe/maybe_base.go.tmp -out=maybe/maybe_base.go gen "Type=int,string,bool"

// Another command will generate the "composition" functions which allow you to convert
// from one type to another // when using Map, FlatMap, etc. This is also necessary for
// generating same-type conversions. Such as:
//   IntMaybe.MapToInt(func (i int) int { return i * 2 })
//
// Note that by providing multiple input types, all permutations will be generated.
//
//go:generate genny -in=$GOPATH/src/github.com/johnmurray/bastard-go/maybe/maybe_compose.go.tmp -out=maybe/maybe_compose.go gen "FromType=int,string,bool ToType=int,string,bool"

Try

This is a Scala-like Try object that uses genny to generate templates which allow it to work very similar to the Scala version with composition functions (Map, FlatMap, Recover, etc). To use in your own projects:

cd $YOUR_PROJECT
mkdir try

// Generate for as many types as you like. Simply including a comma-delimited list for
// `Type` will cause genny to generate multiple templates.
//
//go:generate genny -in=$GOPATH/src/github.com/johnmurray/bastard-go/try/try_base.go.tmp -out=try/try_base.go gen "Type=int,string,bool"

// Another command will generate the "composition" functions which allow you to convert
// from one type to another // when using Map, FlatMap, etc. This is also necessary for
// generating same-type conversions. Such as:
//   IntTry.MapToTry(func (i int) int { return i * 2 })
//
// Note that by providing multiple input types, all permutations will be generated.
//
//go:generate genny -in=$GOPATH/src/github.com/johnmurray/bastard-go/try/try_compose.go.tmp -out=try/try_compose.go gen "FromType=int,string,bool ToType=int,string,bool"

Of course you can use genny to generate it in a different package, so read more about genny if you're not familiar. See my blog post for more details.

Contributing

Have you'd like to implement that you think belongs in this repository? Feel free to open a PR to talk about your idea, or to present some code you think would fit in. The more the merrier! :-D

License

Project is licensed under MIT license. Please see LICENSE file for full details.