Weaver v1.0.0 Release Notes

Release Date: 2019-12-15 // over 4 years ago
  • ๐Ÿฑ First stable version of Weaver ๐ŸŽ‰

    Foundations rework

    • Dependency Graph: The dependency graph representation has been entirely reworked in order to allow for more flexibility at use. Basically, it is now linked using hash keys rather than direct object references.
    • ๐Ÿ”— Linker/Inspector: Since the dependency graph changed, the linker & Inspector naturally changed as well. Accessing to data through the graph can now throw, giving a more precise error handling. The visitor algorithm for resolving and building remains fairly the same, but now supports new features, which I will describe a bit below.
    • ๐Ÿ‘ Generator: The generator has been entirely rewritten using Meta. It also supports new features which I will describe below.

    Optimizations

    • โšก๏ธ Lexer: A cache (LexerCache) has been added in order to avoid SourceKitten to parse the source files every time (~1s for ~30 files). This cache stores one token list per file. A token list is invalidated once its file has changed after it was stored. The format for storing is an optimized JSON where every key is only one or two characters.
    • ๐Ÿ‘ Generator: The generated Swift code is now relying a lot more on runtime, which brings more flexibility for supporting new features, but also allows Weaver to generate one single dependency container per project instead of one per injectable type
    • Misc optimizations as a result of profiling the binary (~0.5s instead of ~2s for ~30 files when cache is complete).

    ๐Ÿ†• New Features

    • ๐Ÿ‘ Property wrapper support. With Swift 5.1, Weaver is now able to detect property wrappers named @Weaver(...) as annotations.
    • Dependencies can now be resolved by name and/or by type.
    • Abstract types can be composite (eg. A & B) and still be resolved correctly as soon as a registration is declared up the tree with a super set abstract type (eg. A & B & C).
    • Some new (more specific) errors are now thrown. Eg. type mismatch, ambiguous type, ambiguous dependency name, etc...
    • โž• Added generation of a stub implementation of the main dependency resolver to facilitate testing. The code is generated in a separated file WeaverTests.swift.
    • โž• Added scope lazy which activates a lazy loading mechanism for a given dependency.
    • โž• Added configuration attribute setter which makes Weaver generate a setter for a given dependency.
    • An injectable type can now reference itself. The stored reference is weak, avoiding retain cycles. The optionality of that reference is abstracted away by Weaver though.

    ๐Ÿ’ฅ Breaking changes

    • โœ… Only one unique file per target (app/tests) can be generated while Weaver used to offer an option to generate multiple files.
    • ๐Ÿšš Naturally, the xcfilelist command has been removed since its necessity was very limited by the fact that only one file is generated now.
    • Detailed resolvers are always on, which means the option doesn't exist anymore.
    • ๐Ÿ‘ Custom stencil templates aren't supported anymore, since Stencil has been replaced by Meta.