depkit

README

Overview

This package provides a simple way to manage dependencies in a Go application. It allows you to register and retrieve dependencies using Go interfaces.

It simplifies the process of writing unit tests by providing a simple and easy-to-use interface for managing dependencies between different components of your application. It allows you to register dependencies and callbacks, and retrieve them whenever needed, making it easy to test your code in isolation. This results in more maintainable and reliable tests, as well as a faster development process.

Installation

To install this package, use the go get command:

go get github.com/kitstack/depkit

📚 Usage

To use this package, you must first register your dependency using the Register function :

package example

import "github.com/kitstack/depkit"

type MyService interface {
	DoSomething()
}

type myServiceImpl struct{}

func (s *myServiceImpl) DoSomething() {
	// Do something here...
}

func init() {
	depkit.Register[MyService](new(myServiceImpl))
}

You can now retrieve your service using the Get function :

package example

import "github.com/kitstack/depkit"

type MyService interface {
	DoSomething()
}

func main() {
	depkit.Get[MyService]().DoSomething()
}

You can also use the GetAfterRegister function to execute a callback once the service has been registered :

package example

import "github.com/kitstack/depkit"

type MyService interface {
	DoSomething()
}

func main() {
    depkit.GetAfterRegister[MyService](func(s MyService) {
        s.DoSomething()
    })
}

To reset all registered dependencies, use the Reset function :

package example

import "github.com/kitstack/depkit"

func main() {
	depkit.Reset()
}

Notes

• Services must be registered using interfaces or func, not concrete types.
• If you try to retrieve a dependency that has not been registered, an error will panic.

⚡️ Benchmark

goos: darwin
goarch: arm64
pkg: github.com/kitstack/depkit
BenchmarkGet
BenchmarkGet-10                 	 6982549	       170.8 ns/op
BenchmarkRegister
BenchmarkRegister-10            	 7061115	       164.9 ns/op
BenchmarkGetAfterRegister
BenchmarkGetAfterRegister-10    	 5401953	       223.9 ns/op

🤝 Contributions

Contributors to the package are encouraged to help improve the code.

If you have any questions or comments, don't hesitate to contact me.

I hope this package is helpful to you !

Documentation

Index

• func Dependencies() []string
• func Get[T any]() (module T)
• func GetAfterRegister[T any](fn func(module T))
• func Register[T any](module T)
• func Reset()
• func UnRegister[T any]()

Functions

func Dependencies

func Dependencies() []string

Dependencies returns the list of registered dependencies.

func Get

func Get[T any]() (module T)

Get returns the registered dependency associated with the given interface.

func GetAfterRegister

func GetAfterRegister[T any](fn func(module T))

GetAfterRegister is a special case for the init function, the callback is triggered after the dependency is registered. If the dependency has already been registered for the given interface, the callback is executed with the registered dependency as a parameter. If the dependency has not yet been registered, the callback is added to the list of registered callbacks for this interface.

func Register

func Register[T any](module T)

Register a dependency associated with the given interface. If a dependency is already registered for this interface, the function does nothing. If callbacks have been registered for this interface, they are executed with the registered dependency as a parameter.

func Reset

func Reset()

Reset resets all registered dependencies by creating new empty maps for the dependencies and callbacks.

func UnRegister

func UnRegister[T any]()

UnRegister removes the dependency associated with the given interface. If no dependency is registered for this interface, the function does nothing.