CHANGELOG.md

Change Log

Badges: [UPDATED], [FIXED], [ADDED], [DEPRECATED], [REMOVED], [BREAKING]

2.0.1

Android-ViewModel

• [ADDED] - debug logging for VM provider

AndroidX-ViewModel

• [ADDED] - debug logging for VM provider

Core

• [FIXED] - performances update - modules list loading & class naming
• [BREAKING] - modules(vararg modules: Module) in KoinApplication has been removed for performance reasons. Please use modules(modules: List<Module>)
• [BREAKING] - modules(modules: Iterable<Module>) in KoinApplication has been removed for performance reasons. Please use modules(modules: List<Module>)
• [BREAKING] - loadKoinModules(vararg modules: Module) in GlobalContext has been removed for performance reasons. Please use loadKoinModules(module: Module) or loadKoinModules(modules: List<Module>)
• [BREAKING] - unloadKoinModules(vararg modules: Module) in GlobalContext has been removed for performance reasons. Please use unloadKoinModules(module: Module)

2.0.0

Android

• [UPDATED] - rework startking DSL to add extension in startKoin (androidContext, androidLogger)

Android-Scope

• [UPDATED] - rework according to new Scope API (manage compelte Scope Lifecycle)
• [ADDED] - currentScope property scope tied to current Activity or Fragment
• [ADDED] - currentScope is aware of any KoinComponent & currentScope override
• [UPDATED] - ScopeID generation

Android-ViewModel

• [ADDED] - support for new Scope API
• [REMOVED] - removed koin-ext builder API
• [UPDATED] - make the API open to Koin instance isolation
• [FIXED] - InsertKoinIO#452 - Named qualifier does not work with view models - Now take qualifier as ViewModel's Tag
• [FIXED] - by viewModel & getViewModel with clazz version
• [FIXED] - ViewModel definition in scope

AndroidX-Scope

• [UPDATED] - update API regarding the changes in koin-android-scope
• [UPDATED] - ScopeID generation

AndroidX-ViewModel

• [UPDATED] - update API regarding the changes in koin-android-viewmodel
• [FIXED] - InsertKoinIO#452 - Named qualifier does not work with view models - Now take qualifier as ViewModel's Tag
• [FIXED] - by viewModel & getViewModel with clazz version
• [FIXED] - ViewModel definition in scope

Core

• [UPDATED] - startKoin replaced with startKoin DSL and koin in global context
• [UPDATED] - complete internals rewritten for performances optimisation (startup & injection)
• [UPDATED] - KoinComponent now can override getKoin() to target a custom Koin instance & currentScope() to target a Scope that is used for all injections
• [ADDED] - koinApplication function to help declare an instance for a local context, in ordoer to help isolated Koin instances
• [UPDATED] - rework Scope API (multiple instances definitions, properties, release, callback ...)
• [UPDATED] - rework Scope DSL (scope/scoped) & lock single/factory
• [UPDATED] - rework internals to use root Scope & separate Scope instances, with different bean registry
• [ADDED] - onClose, onRelease DSL on single/factory/scoped to execute code when releasing instance or stopping container
• [ADDED] - getProperty with default value
• [UPDATED] - Kotlin 1.3.21
• [ADDED] - Qualifiers with named() function to replace old string names. Allow to use Types
• [ADDED] - getOrNull() and injectOrNull() to safely resolve potential components and get null of not present
• [UPDATED] - additional binding API, with getAll<S>() & bind<P,S>() operator to look for instances regarding secondary type definition
• [ADDED] - declare() on Koin & Scope, to help declare an instance on the fly
• [FIXED] - Factory declaration in scope

Test

• [UPDATED] - rework testing API, codebase detached from internal core tests
• [UPDATED] - checkModules now rely on pure Kotlin & with create parameters DSL

Java

• [UPDATED] - updated KoinJavaComponent for the new API
• [FIXED] - InsertKoinIO#451 - No longer possible to get objects from a scope in Java code - scope parameter to allow resolve a dependency from this scope instance
• [FIXED] - Get access to scope instance

Ktor

• [UPDATED] - rework startking DSL to add extension in startKoin
• [ADDED] - Koin as a Ktor feature

Spark

• [REMOVED] project non ported to Koin 2.0

1.0.2

Android

• [FIXED] Fixed bug with appCompat v26 InsertKoinIO#268
• [ADDED] Android debug logs shut off InsertKoinIO#251

Android-Scope

• [UPDATED] Better scope management when associated to a lifecycle InsertKoinIO#235

Android-ViewModel

• [FIXED] Proguard Warning InsertKoinIO#267

Core

• [UPDATED] - Updated KoinComponent interface to allow easily add a custom Koin instance InsertKoinIO#224
• [UPDATED] - Allow nullable injection params InsertKoinIO#242
• [UPDATED] - Add instance for a dedicated scope InsertKoinIO#277
• [FIXED] Documentation Typo fixed InsertKoinIO#263
• [FIXED] Fixed Scope toString in debug InsertKoinIO#240

Core-Ext

• [FIXED] Add scopeId param in experimental API builder InsertKoinIO#252

Test

• [UPDATED] Review declareMock to add mock lambda expression InsertKoinIO#243
• [FIXED] Fixed params injection with checkModules InsertKoinIO#274

1.0.1

Android

• [FIXED] - koin-android-viewmodel & koin-androidx-viewmodel parameter & factory review - InsertKoinIO#236

1.0.0

Core_

• [UPDATED] - compilation with Kotlin 1.2.70
• [ADDED] - new Scope API
• [FIXED] - fixed scope visibility resolution - InsertKoinIO#228
• [FIXED] - koin-android-viewmodel parameters leak

Core-Ext

• [ADDED] - Renamed koin-reflect to koin-core-ext

Android

• [FIXED] - koin-android-viewmodel parameters leak fixed - InsertKoinIO#220
• [ADDED] - koin-android-viewmodel added viewModel automatic builder keyword
• [FIXED] - koin-android added back androidApplication()
• [ADDED] - koin-android-scope updated bindScope function now bind a Scope

Test

• [FIXED] - check() renamed to checkModules()

1.0.0-beta3

Scripts

• [UPDATED] - rework all gradle structure and scripts - #126
• [ADDED] - asciidoc integration - #127
• [ADDED] - CI integration with CircleCI

Core

• [UPDATED] - compilation with Kotlin 1.2.50
• [UPDATED] - Update DSL keywords: module & single (replaces applicationContext, context & bean) - #131
• [FIXED] - Fixed Scope API, aka module visibility resolution
• [ADDED] - SLF4J Logger implementation (koin-logger-slf4j), used by koin-spark & koin-ktor - #130
• [FIXED] - Resolution & error check/catch for display - #110
• [FIXED] - BeanDefinition equals()
• [FIXED] - Instance creation error display - #124
• [UPDATED] - logging tree resolution (with debug data if needed)
• [ADDED] - asciidoc doc updated - #121 - #100 - #102 - #103
• [UPDATED] - Injection parameter API with destructured declaration - #133
• [ADDED] - Preload instances with createAtStart - #141
• [UPDATED] - Explicit bean/module overide - #123
• [FIXED] - bind operator check assignable types

Test

• [ADDED] - asciidoc doc
• [ADDED] - check() feature to check all configuration (does not create instances like dryRun)
• [ADDED] - declare mock or other definition out of the box with declareMock & declare- #151 - #119

Android

• [BREAKING] - Package & project renaming -> koin-android,koin-android-scope & koin-android-viewmodel - #144
• [REMOVED] - bindString(), bindBool() & bindInt()
• [ADDED] - asciidoc doc
• [ADDED] - support AndroidX packages with koin-androidx-scope & koin-androidx-viewmodel - #138 - #122 - #154
• [ADDED] - scoping feature with Android lifecycle with koin-android-scope - #142
• [UPDATED]- Open startKoin() for other Android context & use Context instead of Application - #156
• [FIXED] - ViewModel factory instance creation bugfix - #145
• [FIXED] - ViewModel factory injection params leak - #149
• [UPDATED]- androix version to 2.0.0-beta01

Ktor

• [ADDED] - asciidoc doc
• [ADDED] - use koin-logger-slf4j
• [UPDATED] - ktor 0.9.2
• [ADDED]- add Route & Routing class extensions - #128

Spark

• [ADDED] - asciidoc doc
• [ADDED] - use koin-logger-slf4j
• [UPDATED] - controller keyword now need your class to extend SparkController

Java

• [ADDED] - add koin-java project - #106
• [ADDED] - asciidoc doc

Reflect

• [ADDED] - add koin-reflect project
• [ADDED] - add build() DSL function to allow smarter way of building definition
• [ADDED] - asciidoc doc

Website

• [ADDED] - Doc integration
• [ADDED] - Getting started integration
• [FIXED] - Kotlin slack URL - #125

Samples

• [ADDED] - Added examples folder, gathering examples application
• [ADDED] - Thermosiphon example - #116

0.9.3

Gradle & Continuous Integration

version published with new build chain

0.9.2

Core

• [UPDATED] build updated to Kotlin 1.2.31
• [UPDATED] dissociate overload with dynamic parameters on get() and inject() for better autocomplete suggestions
• [FIXED] fix startKoin() property loading from boolean loadProperties
• [FIXED] inject by name take now care of injected type #92

Android

• [FIXED] startKoin() doesn't break RestrictMode anymore and you can avoid properties load directly from koin.properties #96
• [UPDATED] dissociate overload with dynamic parameters on get() and inject() for better autocomplete suggestions

Android Architecture

• [UPDATED] dissociate overload with dynamic parameters on viewModel(), getViewModel()andgetSharedViewModel()` for better autocomplete suggestions
• [UPDATED] now exclude gradle dependency against LiveData

Samples

• FIXED Ktor hello appp sample

0.9.1

DSL

• [FIXED] Parameter propagation - You can now reuse params in get() to propagate it #66

Core

• [ADDED] Parameters are now expressed via Kotlin function to allow lazy evaluation #67
• [UPDATED] Parameter propagation #66
• [FIXED] Stack resolution engine fixed #72
• [FIXED] Better Logs, Error & Stacktraces
• [FIXED] Properties loading from external properties file can read values as String/Integer/Float

Android

• [ADDED] get() direct dependency eager fetching function for Activity/Fragment/Service #78

Android Architecture

• [ADDED] To help misuse the Koin ViewModel API, we introduce the getSharedViewModel() and sharedViewModel() from Fragment, to reuse ViewModel from parent Activity. getViewModel() and viewModel() now creates ViewModel instance (no FromActivity parameter anymore)
• [UPDATED] ViewModel factory logs to see what Activity/Fragment is getting ViewModel instance

0.9.0

DSL

• [DEPRECATED] - provide - can be directly replace with bean
• [UPDATED] - bean and factory can now use bind
• [ADDED] - defintion function inside bean or factory can now have parameters

Core

• [FIXED] Context resolution and modulePath isolation reworked - now fully functionnal
• [FIXED] Stack resolution
• [ADDED] StandAloneContext function loadKoinModules to load Koin modules wether Koin is already started
• [ADDED] StandAloneContext function loadProperties to load Koin properties wether Koin is already started
• [ADDED] by inject() function handle parameters to definition (#59)
• [FIXED] Logging with class name need introspection
• [ADDED] Context lifecycle notification callback - to allow a callback when releaseContext() is called on a context. You can register with StandAloneContext.registerContextCallBack() (#58)

Android

• [FIXED] StartKoin have a logger parameter, with default as AndroidLogger(), to allow specify logging implementation to use with Koin (#50) - allow no logging at startKoin of logger is set to EmptyLogger()
• [ADDED] by inject() function handle parameters to definition (#49)

Android Architecture

• [FIXED] fix viewModel extensions rewritten from LifecycleOwner interface
• [FIXED] fix by viewModel() API to allow use KClass object argument instead of type inference - offers now getViewModelByclass() and viewModelByClass() (#56)
• [ADDED] by viewModel() function handle parameters to definition (#49)
• [ADDED] by viewModel() function handle key instance for Android ViewModelFactory (#49)

0.8.2

Core

• fix internal instance registry due to compat error with Kolin 1.1.61 & 1.2.21 - broke Koin API for app using jdk 7 under the hood - issue #43

0.8.1

Android Architecture

Now declare your ViewModel lazyly in attributes, with by viewModel() like by inject()

• by viewModel() lazy function call the getViewModel() function and allow val attribute declaration of your ViewModel (like with by inject()) - (issue #37)
• Better support to share ViewModel between Activity and Fragments
• android.arch.lifecycle:extensions updated to 1.1.0

Spark

start and startKoin functions have been merged

• startSpark {} has been renamed to start {} and have a modules arguments to list all of your modules
• start() and startKoin has been merged to start( modules = <List of modules>)
• stopSpark{} has been renamed to stop {} and include closeKoin()

Core

• Kotlin 1.2.21
• Internal fixes around Bean definition lookup / Duplicated defintion (issue #39)
• Fixed loading from koin.properties (for embedded jar)

0.8.0

Introducing new modules: koin-spark and koin-android-architecture

Android Architecture

• viewModel DSL keyword (specialized provide alias for ViewModel), to declare an Architecture Components ViewModel
• getViewModel() function in Activities and Fragments, to get and bind ViewModel components

Spark

• controller {} DSL keyword (specialized provide alias), to declare Spark controllers classes
• start() {} function to start Spark server (optional port number) - lambda expression to allow the start of Koin and any controller instantiation
• runControllers() function to instantiate all spark controllers, declared with controller keyword DSL

Core

• Better logging and error display
• Some fixes about internals resolution for bound types

0.7.1

This 0.7.x branch brings great simplifications in DSL and API. Users from Koin 0.6.x may check the What's new in 0.7.x guide 👍

Kotlin compilation has been updated to 1.1.61

Core

• Simplified DSL modules: no more need of Module class. Now use directly the applicationContextfunction
• Default Koin Logger to PrintLogger instead of EmptyLogger
• a definition can be overriden (with a definition same name and type)
• DSL provide aliases with bean and factory
• direct interface binding writing style (avoid to use bind keyword)
• Koin instances resolution is now thread safe and compatible with coroutines
• starter chain reviewed to allow better extension of startKoin()
• better logs to display how instance and reoslution are made
• Context isolation disabled by default. Can be activitaed later

Android

Android ContextAware components have been dropped. Please, check the migration guide

• Default Koin Logger to AndroidLogger instead of EmptyLogger
• No need anymore of AndroidModule, just use applicationContext to declare a module
• Android extensions have been reworked to avoid need of support Library
• androidApplication() is a DSL extension to provide Android Application resolution (can also be done with get<Application>())

Samples

• Updated Android weather app, with multiple Activity and better demo for property usage
• Simple Kotlin app sample added

## [0.6.1]()

Core

• Added context/sub-contexts visibility checks
• startKoin() is now part of standAloenContext
• closeKoin() now close actual Koin context
• KoinComponent has get() and getProperty()

Android

• reworked starKoin() function
• reviewed android base extensions to find high-level extension point

Samples

• added kotlin-simpleapp - sample application for pure Kotlin
• added ktor-starter - for demoing Koin for Ktor web app development

Ktor

• koin-ktor module has been started

0.6.0

The target of this release was to simplify and make clearer the syntax of Koin.

DSL

• getProperties can now have a default value

Core

• Stand alone complex & KoinComponent have been reviewed

• renamed startContext functions to startKoin()

• KoinComponent

  • inject/property
  • setProperty
  • release context or properties
  • startKoin

• Koin can load properties from koin.properties file or system properties

• startKoin() have now a properties parameter to give additional properties at startup

No more getKoin() !

KoinTest

• directly extends KoinComponent
• context assert/test tools & extensions
• dryRun() is usable in a Kointest component, after a startKoin

Android

• fix/better extensions for Android
• bindProperty() renamed to setProperty()
• startAndroidContext() has been renamed to startKoin()
• ContextAware Components can be configured for drop stratgey (onDestroy or onPause). Default method is onPause
• load assets/koin.properties if present

0.5.2

Core

• getProperty() can provide a default value if key property is missing
• provide() can be use on a KoinContext directly, to declare on component

Android

• applicationContext has been renamed androidApplication

0.5.1

Core

• property value set does not allow Any? value
• starters builder have been moved to [test] & [android]
• removed base starter

Android

• starter builder extension for Application class only

Tests

• starter builder extension for KoinTest class only

javadoc is now generated with Dokka

0.5.0

Core

• Koin now provide a stand alone context support to provide koin context in an agnostic way
• startContext function to start a Koin context
• property injection/resolution is now strict. Property injection is not nullable anymore
• koinContext.removeProperties() remove properties by their keys
• Simple logger to help logging/debugging

Android

• startAndroidContext function to start an Android Koin context
• KoinContextAware interfaces have been removed
• Koin/Android extensions greatly simplified
• packages have been moved - need reimport for AndroidModule, by inject and by property
• ContextAwareActivity & ContextAwareFragment are components to help you automatically release contexts - don't hesitate to do it manually

Tests

• Creation of 'org.koin:koin-test:' module, provide testing feature about Koin

0.4.0

Koin DSL has been reviewed to be more easy to understand, and allow easy writing of modules. No need anymore of several module classes, you can now include subcontexts in one module. You can now provide factory components, and bind is simpler to write.

The dry run feature, allows to run all of you modules in order to check if dependency graph is complete.

DSL

• replaced declareContext{} has been renamed applicationContext{}, and behind gives a better idea that you are describing your application context (the root context of your app)
• Updated modulePath(){}has been dropped for context(){} - context describes a sub context of your application, has a a name and can have also sub context itself (sub contexts are hierarchicals)
• Updated bind{} doesn't need lambda anymore to declare your bound class, but just the class in argument: bind()
• Added provideFactory is a DSL keyword to provide a factory definition instead of singleton

Core

• Updated KoinContext.release() is now called with context's name, no owner class instance
• Added KoinContext.dryRun() help to run your modules and check if every dependency can be injected

Sample App & Android

• updated for the new core update

0.3.1

Core

• Kotlin 1.1.51
• Removed all loggers - rethinking of better Log/API

Android

• KoinContext function builders : newKoinContext & lazyKoinContext
• KoinContextAware interface now has a property, instead of a getter - better to overload

Sample App

• moved to folder koin-sample-app

0.3.0

Core

• Kotlin 1.1.50
• KoinContext / Context - simplified operator injection (removed all nullable inject/get)
• KoinContext.get() can make Injection by name
• Koin.build() can now build a list of Module

DSL

• Context.get() can now provide a definition with a name
• Context.get() operator have a bind property, to specify list of compatible interfaces to bind - is an alternative to bind {} operator

Android

• Merge android & android-support modules
• inject() can't be null anymore
• inject() can inject component by its name
• property() can do property injection - can be nullable data

Sample App

• Sample app (Weather demo application) has been reviewed to be more complete : Full MVP example, RxJava Scheduling, Unit Tests with partial modules loading & mocks

0.2.x

Koin & Koin-Android project has meen merged

DSL

• Module/AndroiModule class must now give a context() function implementation, to return a Context object. The declareContext function unlock the Koin DSL to describe dependencies and injection:

class MykModule : Module() {
    override fun context() = declareContext { ... }
}

• You can now bind additional types for provided definitions

class MykModule : Module() {
    override fun context() = declareContext { 
        provide { Processor() } bind { ProcessorInterface::class}
    }
}

Scope

• You can declare/reuse paths in your modules, with modulePath {} operator. See paths section
• Release modulePath instances with release() on a KoinContext

class MainActivityModule : Module() {
    override fun context() =
            declareContext {
                // Scope MainActivity
                modulePath { MainActivity::class }
                // provided WeatherService
                provide { WeatherService(get()) }
            }
}

Android

• KoinAwareContext interface used to setup Android application (KoinApplication & KoinMultidexApplication are removed)

class MainApplication : Application(), KoinContextAware {

     /**
     * Koin context
     */
    lateinit var context: KoinContext

    /**
     * KoinContextAware - Retrieve Koin Context
     */
    override fun getKoin(): KoinContext = context

    override fun onCreate() {
        super.onCreate()
        // insert Koin !
        context = Koin().init(this).build(MyModule()) 
        // ...
    }
}

• by inject<>() function operator to inject any dependency in any Activity or Fragment

class MainActivity : AppCompatActivity() {

    // inject my WeatherService 
    val weatherService by inject<WeatherService>()
}

Koin

• Koin builder takes module instances (instead of module classes):

// fill applicationContext for Koin context
val ctx = Koin().init(applicationContext).build(Module1(),Module2()...)

Internal rework for simpler use with Scopes:

• Koin().build() return KoinContext
• factory, stack operators have been removed, for the modulePath fatures
• delete/remove replcaed with release() Scope operation
• import is replaced with module instances load
• All reflection & kotlin-reflect code have been removed