Git Product home page Git Product logo

coi's Introduction

coi

CoI is a dependency injector for Go.

Typically components wire up their own dependencies.

func NewCoffeeApp() *CoffeeApp {
  return &CoffeeApp{
    Heater: &ElectricHeater{},
    Pump: &Thermosiphon{},
  }
}

Dependency injection inverses this flow, and makes it easy to create reusable, interchangeable modules.

func NewCoffeeApp(heater *Heater, pump Pump) *CoffeeApp {
  return &CoffeeApp{
    Heater: heater,
    Pump: pump,
  }
}

Dependency injection facilitates creating different environments, and makes it easy to swap out your ProdLogger for an in-memory TestLogger. Or swap it for DevLogger during development.

Wiring up this graph throughout your app is tedious and boring. CoI eliminates the clumsy duct that wires your dependencies. Simply declare your dependencies, specify how to satisfy them, and profit!

Providing Dependencies

Provider methods satisfy dependencies. A provider method is an exported method beginning with Provide.

 // ProvideHeater is invoked whenever a heater is required.
 func (*module) ProvideHeater() *Heater {
   return &ElectricHeater{}
 }

Provider methods can have dependencies of their own.

// ProvidePump is invoked with a thermosiphon whenever a pump is required.
func (*DripCoffeeModule) ProvidePump(pump *Thermosiphon) Pump {
  return pump
}

Modules

Modules are reusable components that logically group provider methods.

type DripCoffeeModule struct {}

func (*DripCoffeeModule) ProvideHeater() *Heater {
  return &ElectricHeater{}
}

func (*DripCoffeeModule) ProvidePump(pump *Thermosiphon) Pump {
  return pump
}

ObjectGraph

The ObjectGraph forms a graph of dependencies. It composes modules and their provider methods to satisfy dependencies when requested.

objectGraph := coi.NewObjectGraph(&DripCoffeeModule{})

coffeeApp := &CoffeeApp{}
objectGraph.Inject(coffeeApp)

coi's People

Contributors

f2prateek avatar

Watchers

 avatar  avatar

Forkers

digideskio

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.