Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
Prastiwar committed Oct 4, 2023
2 parents 28218e2 + 9f806e6 commit c069047
Show file tree
Hide file tree
Showing 7 changed files with 7 additions and 14 deletions.
9 changes: 1 addition & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
# Go-flow

[![Go Reference](https://pkg.go.dev/badge/github.com/Prastiwar/go-flow.svg)](https://pkg.go.dev/github.com/Prastiwar/Go-flow)
[![Go Report Card](https://goreportcard.com/badge/github.com/oklahomer/go-sarah)](https://goreportcard.com/report/github.com/Prastiwar/Go-flow)
[![Go Report Card](https://goreportcard.com/badge/github.com/Prastiwar/go-flow)](https://goreportcard.com/report/github.com/Prastiwar/Go-flow)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=Prastiwar_Go-flow&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=Prastiwar_Go-flow)
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=Prastiwar_Go-flow&metric=coverage)](https://sonarcloud.io/summary/new_code?id=Prastiwar_Go-flow)

Backend framework library written in Go for Gophers who want to focus on building great quality backend. It mostly provides dependency inversion to most common built systems to allow easily modularize our application and change implementation without changing our business logic. This is very cost-effective for organizations moving forward from MVP. The framework is viable for both personal and organization level usage where there are multiple products, APIs and development consistency is needed.

- [Go-flow](#go-flow)
- [Production readiness](#production-readiness)
- [Download](#download)
- [Library purpose](#library-purpose)
- [Packages](#packages)
Expand All @@ -28,12 +27,6 @@ Backend framework library written in Go for Gophers who want to focus on buildin
- [Contributing](#contributing)
- [License](#license)

## Production readiness

The library is in final phase before the stable version release. The phase consist of private project released to production. Though it can be already used in production until a stable v1 version release you should keep in mind that some breaking changes can still happen and will not increase the major version. Every breaking change will be noted either in the version release or pull request description.

For release information see https://github.com/Prastiwar/Go-flow/discussions/27

## Download

See latest version: https://github.com/Prastiwar/Go-flow/releases/latest
Expand Down
2 changes: 1 addition & 1 deletion di/constructor.go
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ type Constructor interface {
// Dependencies returns an array of reflect.Type defining type of dependencies for object to construct.
Dependencies() []reflect.Type

// Life returns LifeTime which defines scope of existance for constructed object.
// Life returns LifeTime which defines scope of existence for constructed object.
Life() LifeTime
}

Expand Down
2 changes: 1 addition & 1 deletion httpf/rate.go
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ func ComposeRateKeyFactories(factories ...RateHttpKeyFactory) RateHttpKeyFactory

// RateLimitMiddleware returns httpf.Handler which uses rate-limiting feature to decide if h Handler can be requested.
// If rate limit exceeds maximum value, the error is returned and should be handled by ErrorHandler to actually
// return 429 status code with appropiate body. This middleware writes all of
// return 429 status code with appropriate body. This middleware writes all of
// "X-Rate-Limit-Limit", "X-Rate-Limit-Remaining" and "X-Rate-Limit-Reset" headers with correct values.
func RateLimitMiddleware(h Handler, store rate.LimiterStore, keyFactory RateHttpKeyFactory) Handler {
if store == nil {
Expand Down
2 changes: 1 addition & 1 deletion rate/limiter.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
// The package does contain example alghoritm most often used in Web API's but there are much more algorithms already implemented
// in Go which are open-sourced by the Golang community. Use this package to abstract away the specific implementations
// provided by third party libraries. This requires to write an adapter for implementation to fulfill rate interfaces
// in your infrastracture layer.
// in your infrastructure layer.
package rate

import "context"
Expand Down
2 changes: 1 addition & 1 deletion rate/memory/store.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ var (
)

var (
ErrCleanupFailure = errors.New("at least one error occured at cleanup")
ErrCleanupFailure = errors.New("at least one error occurred at cleanup")
ErrMissingAlgorithm = errors.New("nil LimiterAlgorithm was passed to constructor")
)

Expand Down
2 changes: 1 addition & 1 deletion rate/wait.go
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ func Wait(ctx context.Context, deadline time.Time) error {
}
}

// ConsumeAndWait calls Take() on Limiter and immedietely Use the Token. If ErrRateLimitExceeded error occurs
// ConsumeAndWait calls Take() on Limiter and immediately Use the Token. If ErrRateLimitExceeded error occurs
// it pauses the current goroutine until Limiter's ResetsAt() time deadline exceeds. If Take() returns any
// other error it'll immediately return this error. When ctx is canceled or ctx deadline exceeds before
// reset time it'll return this error.
Expand Down
2 changes: 1 addition & 1 deletion tests/assert/slices_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ func TestElementsMatch(t *testing.T) {
fails: false,
},
{
name: "not-matches-similiar",
name: "not-matches-similar",
arrA: []any{
1, 2, 3,
},
Expand Down

0 comments on commit c069047

Please sign in to comment.