v1.0.0

Author: vardius

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at vardius@gmail.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

.github/CONTRIBUTING.md

@@ -0,0 +1,53 @@
+# Contributing
+
+We are open to, and grateful for, any contributions made by the community. By contributing to **gollback**, you agree to abide by the [code of conduct](https://github.com/vardius/gollback/blob/master/CODE_OF_CONDUCT.md).
+
+## Reporting Issues and Asking Questions
+
+Before opening an issue, please search the [issue tracker](https://github.com/vardius/gollback/issues) to make sure your issue hasn't already been reported.
+
+### Bugs and Improvements
+
+We use the issue tracker to keep track of bugs and improvements to **gollback** itself, its examples, and the documentation. We encourage you to open issues to discuss improvements, architecture, theory, internal implementation, etc. If a topic has been discussed before, we will ask you to join the previous discussion.
+
+Any pull requests that involve breaking changes should be made against the `next` branch.
+
+### Getting Help
+
+For support or usage questions like “how do I do X with **gollback**” and “my code doesn't work”, we encourage you to post an issue.
+
+Please be considerate when doing this as this is not the primary purpose of the issue tracker.
+
+## Development
+
+Visit the [issue tracker](https://github.com/vardius/gollback/issues) to find a list of open issues that need attention.
+
+Fork, then clone the repo:
+
+```
+git clone https://github.com/your-username/gollback.git
+```
+
+### Docs
+
+Improvements to the documentation are always welcome. In the docs we abide by typographic rules, so instead of ' you should use '. Same goes for “ ” and dashes (—) where appropriate. These rules only apply to the text, not to code blocks.
+
+### Sending a Pull Request
+
+For non-trivial changes, please open an issue with a proposal for a new feature or refactoring before starting on the work. We don't want you to waste your efforts on a pull request that we won't want to accept.
+
+On the other hand, sometimes the best way to start a conversation *is* to send a pull request. Use your best judgement!
+
+In general, the contribution workflow looks like this:
+
+* Open a new issue in the [Issue tracker](https://github.com/vardius/gollback/issues).
+* Fork the repo.
+* Create a new feature branch based off the `master` branch.
+* Make sure all tests pass and there are no linting errors.
+* Submit a pull request, referencing any issues it addresses.
+
+Please try to keep your pull request focused in scope and avoid including unrelated commits.
+
+After you have submitted your pull request, we'll try to get back to you as soon as possible. We may suggest some changes or improvements.
+
+Thank you for contributing!

.gitignore

@@ -0,0 +1,14 @@
+# Binaries for programs and plugins
+*.exe
+*.dll
+*.so
+*.dylib
+
+# Test binary, build with `go test -c`
+*.test
+
+# Output of the go coverage tool, specifically when used with LiteIDE
+*.out
+
+# Project-local glide cache, RE: https://github.com/Masterminds/glide/issues/736
+.glide/

.hound.yml

@@ -0,0 +1,2 @@
+go:
+  enabled: true

.travis.yml

@@ -0,0 +1,10 @@
+language: go
+go:
+  - 1.8
+  - 1.9
+  - tip
+script:
+  - go build
+  - go test -v -cover -race -coverprofile=coverage.txt -covermode=atomic
+after_script:
+  - bash <(curl -s https://codecov.io/bash)

LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019-present Rafał Lorenz
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,122 @@
+Vardius - gollback
+================
+[![Build Status](https://travis-ci.org/vardius/gollback.svg?branch=master)](https://travis-ci.org/vardius/gollback)
+[![Go Report Card](https://goreportcard.com/badge/github.com/vardius/gollback)](https://goreportcard.com/report/github.com/vardius/gollback)
+[![codecov](https://codecov.io/gh/vardius/gollback/branch/master/graph/badge.svg)](https://codecov.io/gh/vardius/gollback)
+[![](https://godoc.org/github.com/vardius/gollback?status.svg)](http://godoc.org/github.com/vardius/gollback)
+[![license](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/vardius/gollback/blob/master/LICENSE.md)
+
+gollback - Go asynchronous function simple utilities, for managing execution of closure, callbacks.
+
+ABOUT
+==================================================
+Contributors:
+
+* [Rafał Lorenz](http://rafallorenz.com)
+
+Want to contribute ? Feel free to send pull requests!
+
+Have problems, bugs, feature ideas?
+We are using the github [issue tracker](https://github.com/vardius/gollback/issues) to manage them.
+
+HOW TO USE
+==================================================
+
+1. [GoDoc](http://godoc.org/github.com/vardius/gollback)
+
+## Benchmark
+**CPU: 3,3 GHz Intel Core i7**
+
+**RAM: 16 GB 2133 MHz LPDDR3**
+
+```bash
+➜  gollback git:(master) ✗ go test -bench=. -cpu=4 -benchmem
+goos: darwin
+goarch: amd64
+pkg: github.com/vardius/gollback
+BenchmarkRace-4          5000000               240 ns/op               0 B/op          0 allocs/op
+BenchmarkAll-4           1000000              2387 ns/op             464 B/op          2 allocs/op
+PASS
+ok      github.com/vardius/gollback     10.572s
+```
+
+## All example
+```go
+package main
+
+import (
+	"context"
+	"errors"
+	"fmt"
+	"time"
+
+    "github.com/vardius/gollback"
+)
+
+func main() {
+	g := gollback.New(context.Background())
+
+	rs, errs := g.Race(
+		func(ctx context.Context) (interface{}, error) {
+			time.Sleep(3 * time.Second)
+			return 1, nil
+		},
+		func(ctx context.Context) (interface{}, error) {
+			return nil, errors.New("failed")
+		},
+		func(ctx context.Context) (interface{}, error) {
+			return 3, nil
+		},
+	)
+
+	fmt.Println(rs)
+	fmt.Println(errs)
+	// Output:
+	// [1 <nil> 3]
+	// [<nil> failed <nil>]
+}
+```
+
+## Race example
+```go
+package main
+
+import (
+	"context"
+	"errors"
+	"fmt"
+	"time"
+
+    "github.com/vardius/gollback"
+)
+
+func main() {
+	g := gollback.New(context.Background())
+
+	r, err := g.Race(
+		func(ctx context.Context) (interface{}, error) {
+			time.Sleep(3 * time.Second)
+			return 1, nil
+		},
+		func(ctx context.Context) (interface{}, error) {
+			return nil, errors.New("failed")
+		},
+		func(ctx context.Context) (interface{}, error) {
+			return 3, nil
+		},
+	)
+
+	fmt.Println(r)
+	fmt.Println(err)
+	// Output:
+	// 3
+	// <nil>
+}
+```
+
+License
+-------
+
+This package is released under the MIT license. See the complete license in the package:
+
+[LICENSE](LICENSE.md)

benchmark_test.go

@@ -0,0 +1,35 @@
+package gollback
+
+import (
+	"context"
+	"testing"
+)
+
+func BenchmarkRace(b *testing.B) {
+	g := New(context.Background())
+	cbs := getCallbacks(b)
+
+	b.ResetTimer()
+
+	g.Race(cbs...)
+}
+
+func BenchmarkAll(b *testing.B) {
+	g := New(context.Background())
+	cbs := getCallbacks(b)
+
+	b.ResetTimer()
+
+	g.All(cbs...)
+}
+
+func getCallbacks(b *testing.B) []AsyncFunc {
+	cbs := make([]AsyncFunc, b.N)
+	for n := 0; n < b.N; n++ {
+		cbs[n] = func(ctx context.Context) (interface{}, error) {
+			return n, nil
+		}
+	}
+
+	return cbs
+}

doc.go

@@ -0,0 +1,4 @@
+/*
+Package gollback provides asynchronous function simple utilities, for managing execution of closure, callbacks
+*/
+package gollback

example_test.go

@@ -0,0 +1,56 @@
+package gollback_test
+
+import (
+	"context"
+	"errors"
+	"fmt"
+	"time"
+
+	gollback "github.com/vardius/gollback"
+)
+
+func Example_race() {
+	g := gollback.New(context.Background())
+
+	r, err := g.Race(
+		func(ctx context.Context) (interface{}, error) {
+			time.Sleep(3 * time.Second)
+			return 1, nil
+		},
+		func(ctx context.Context) (interface{}, error) {
+			return nil, errors.New("failed")
+		},
+		func(ctx context.Context) (interface{}, error) {
+			return 3, nil
+		},
+	)
+
+	fmt.Println(r)
+	fmt.Println(err)
+	// Output:
+	// 3
+	// <nil>
+}
+
+func Example_all() {
+	g := gollback.New(context.Background())
+
+	rs, errs := g.All(
+		func(ctx context.Context) (interface{}, error) {
+			time.Sleep(3 * time.Second)
+			return 1, nil
+		},
+		func(ctx context.Context) (interface{}, error) {
+			return nil, errors.New("failed")
+		},
+		func(ctx context.Context) (interface{}, error) {
+			return 3, nil
+		},
+	)
+
+	fmt.Println(rs)
+	fmt.Println(errs)
+	// Output:
+	// [1 <nil> 3]
+	// [<nil> failed <nil>]
+}