Giter VIP home page Giter VIP logo

multiply's Introduction

Automatic dependency injection, similar to .NET's Managed Extensibility Framework, but with (hopefully) less boilerplate.

Usage

Declaring an interface

trait MyTrait

Exporting a class

@export
case class Exported extends MyTrait

Exporting a singleton

@export
object ExportedSingleton extends MyTrait

Importing

assert(Try(Import.one[MyTrait]).isFailure)
assert(Try(Import.optional[MyTrait]).isFailure)
assert(Import.all[MyTrait] == Set(Exported(), ExportedSingleton))
assert(Import.atLeastOne[MyTrait] == Set(Exported(), ExportedSingleton))

Verifying all imports on startup

It's suggested (but not required) that imports are verified on application startup, this can be done like the following. Note that this will cause issues if combined with the testing techniques detailed below.

try {
    Import.verify()
} catch {
    case ex => println(s"Imports will fail: $ex")
}

Mocking

Importer is an interface that, roughly, takes an interface and then returns a list of implementations. The system importer is global, but can be overridden thread-locally, which is primarily suited for testing.

Replacing exports by type

You can force a specific set of exports by trait.

trait OtherTrait

object TestExported extends MyTrait with OtherTrait

Importer.withReplacedExports(typeTag[MyTrait] -> Set(TestExported)) {
    assert(Import.one[MyTrait] == TestExported)
    assert(Import.optional[OtherTrait] == None)
}

Adding exports by type

You can add a specific export by trait.

Importer.withExportsByType(typeTag[MyTrait] -> Set(TestExported)) {
    assert(Import.all[MyTrait] == Set(Exported(), ExportedSingleton, TestExported))
    assert(Import.optional[OtherTrait] == None)
}

Adding exports

You can also add a specific export for all it's traits (as if it had been marked with @export)

Importer.withExports(TestExported) {
    assert(Import.all[MyTrait] == Set(Exported(), ExportedSingleton, TestExported))
    assert(Import.one[OtherTrait] == TestExported)
}

Clearing exports

Importer.withNoExports {
    assert(Import.optional[MyTrait] == None)
}

Gotchas

Using singletons that store imported mocked objects will cause these mocks to leak. This can be resolved in two ways, either by not storing permanent references to imports in singletons (use def instead of val), or by manually forcing a specific importer (use Import(Importer.default) instead of Import, with the side effect of that mocks are ignored completely).

multiply's People

Contributors

nightkr avatar

Watchers

 avatar James Cloos avatar  avatar

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.