donutloop / toolkit

Collection of useful patterns

toolkit

Introduction

These patterns can you use to solve common problems when designing an application or system.

Requirements

• golang >=1.11.x - The Go Programming Language

Installation

go get github.com/donutloop/toolkit/{any_package}

Example

go get github.com/donutloop/toolkit/worker

Patterns

• Worker
• Job schedule
• Singleton
• Retry
• Promise
• Multierror
• Loop
• Lease
• Event-system
• Debugutil
• Concurrent runner
• Bus-system

Examples

In each sub directory is a set of examples

Code generation

Currently, it's only compatiable with version 2.x.x

The code generation tool generates for a pattern an none generic version for spefici type

Supported pattern

• Worker

Build

mkdir -p $GOPATH/src/github.com/donutloop/ && cd $GOPATH/src/github.com/donutloop/

git clone [email protected]:donutloop/toolkit.git

cd toolkit

go install ./cmd/xcode

Usage

USAGE
  xcode [flags]

FLAGS
  -in     input file
  -out    output file
  -pkg    package name
  -type   type

Example generation

xcode -in $GOPATH/src/github.com/donutloop/toolkit/worker/worker.go -out $GOPATH/src/github.com/donutloop/toolkit/worker/new_worker.go -pkg test -type int32 

Example call for generated code

workerHandler := func(v int32) {
    fmt.Println(v)
}

queue := worker.New(2, workerHandler, 10)

queue <- int32(3)

Contribution

Thank you for considering to help out with the source code! We welcome contributions from anyone on the internet, and are grateful for even the smallest of fixes!

If you'd like to contribute to toolkit, please fork, fix, commit and send a pull request for the maintainers to review and merge into the main code base to ensure those changes are in line with the general philosophy of the project and/or get some early feedback which can make both your efforts much lighter as well as our review and merge procedures quick and simple.

Please read and follow our Contributing.

Code of Conduct

Please read and follow our Code of Conduct.

toolkit's Issues

Implementation of retryFunc

Retry which automatically handles failures when they occur by performing retries for a specific time.

Implement a basic promise

Write a good understandable documentation for promise
Implementation business logic of promise
Implementation of testing and benchmark

Implement a event looper (Do one thing once in a while)

Runner executes the provided function in a specific interval

Write a good understandable documentation for event looper
Creation of workflow diagram, to simplify explanation of event looper
Implementation business logic of event looper
Implementation of testing and benchmark

Implement a FIFO work scheduler

• Write a good understandable documentation for FIFO scheduler
• Creation of workflow diagram, to simplify explanation of FIFO scheduler
• Implementation business logic of FIFO scheduler
• Implementation of testing and benchmark

Implement a Hook system

Hooks holds a list of functions (func error) to call whenever the set is
triggered.

Implement a runner

Runner executes the provided functions in concurrent and collects any errors they return

• Write a good understandable documentation for Runner
• Creation of workflow diagram, to simplify explanation of Runner
• Implementation business logic of Runner
• Implementation of testing and benchmark

Marco response

It might be good to create Marco (response and request)

Ref: https://laravel.com/docs/7.x/responses#response-macros

<?php

namespace App\Providers;

use Illuminate\Support\Facades\Response;
use Illuminate\Support\ServiceProvider;

class ResponseMacroServiceProvider extends ServiceProvider
{
    /**
     * Register the application's response macros.
     *
     * @return void
     */
    public function boot()
    {
        Response::macro('caps', function ($value) {
            return Response::make(strtoupper($value));
        });
    }
}

Debugging of any values and consider fmt.Stringer interface

Currently, it isn't possible to create a proper string representation of big.Float values with debug.PrettyPrint

Implementation of singleton pattern

the singleton pattern is a software design pattern that restricts the instantiation of a type to one object.

Write a good understandable documentation for singleton
Implementation business logic of singleton
Implementation of testing and benchmark

Create for each sub package a set of idiomatic example tests

Read more about example test here -> https://blog.golang.org/examples

Write a useful README for this project (Purpose, Contribution guideline)

That Headline of this ticket explains exactly we need.