https://github.com/modocache/gory

Factories for your Go structs. Think factory_girl.
https://github.com/modocache/gory

Last synced: 15 days ago
JSON representation

Factories for your Go structs. Think factory_girl.

• Host: GitHub
• URL: https://github.com/modocache/gory
• Owner: modocache
• License: mit
• Created: 2014-05-10T16:11:26.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2018-02-26T22:41:12.000Z (over 6 years ago)
• Last Synced: 2024-10-13T17:46:05.081Z (29 days ago)
• Language: Go
• Size: 9.77 KB
• Stars: 87
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# gory

[![Build Status](https://drone.io/github.com/modocache/gory/status.png?refresh=1)](https://drone.io/github.com/modocache/gory/latest)

[![Coverage Status](https://coveralls.io/repos/modocache/gory/badge.png?branch=master)](https://coveralls.io/r/modocache/gory?branch=master)

[![GoDoc](https://godoc.org/github.com/modocache/gory?status.png)](https://godoc.org/github.com/modocache/gory)

Factories for your Go structs. Think [factory_girl](https://github.com/thoughtbot/factory_girl).

## Usage

To install, just `go get` it:

```sh

go get github.com/modocache/gory

```

gory is [fully documented](https://godoc.org/github.com/modocache/gory), but

below are some examples to get you started.

### Defining Factories

Define factories that may be used during any test. Works great in

a [global setup hook](http://onsi.github.io/ginkgo/#global_setup_and_teardown__and_).

```go

gory.Define("user", User{}, func(factory gory.Factory) {

    factory["FirstName"] = "John"

    factory["LastName"] = "Doe"

    factory["Admin"] = false

    // 'n' in email is incremented each time the factory is built

    factory["Email"] = gory.Sequence(func(n int) interface{} {

        return fmt.Sprintf("john-doe-%[email protected]", n)

    })

    // time.Now() is evaluated when the factory is built

    factory["Created"] = gory.Lazy(func() interface{} {

        return time.Now()

    })

})

```

See `gory_suite_test.go` for more examples of defining factories.

### Using Factories

```go

john := gory.Build("user").(*User)

fmt.Println(john.FirstName) // "John"

jane := gory.BuildWithParams("user", gory.Factory{

    "FirstName": "Jane"

}).(*User)

fmt.Println(jane.FirstName) // "Jane"

```

See `gory_test.go` for more examples of using factories.

## Coming Soon

- Aliases

- Dependent attributes

- Transient attributes

- Associations

- Inheritance

- Traits

- Callbacks

- ...and pretty much [anything else factory_girl can do](https://github.com/thoughtbot/factory_girl/blob/master/GETTING_STARTED.md).