JarCasting
JarCasting JarCasting

Kotlin ToothPick

'Kotlin extensions for toothpick'

License

License
GroupId

GroupId

com.github.stephanenicolas.toothpick
ArtifactId

ArtifactId

ktp
Last Version

Last Version

3.1.0
Release Date

Release Date
Type

Type

jar
Description

Description

Kotlin ToothPick
'Kotlin extensions for toothpick'
Project URL

Project URL

https://github.com/stephanenicolas/toothpick.git
Source Code Management

Source Code Management

https://github.com/stephanenicolas/toothpick.git

Download ktp

Filename Size
ktp-3.1.0.pom
ktp-3.1.0.jar 27 KB
ktp-3.1.0-sources.jar 8 KB
ktp-3.1.0-javadoc.jar 65 KB
Browse

How to add to project

<!-- https://jarcasting.com/artifacts/com.github.stephanenicolas.toothpick/ktp/ -->
<dependency>
    <groupId>com.github.stephanenicolas.toothpick</groupId>
    <artifactId>ktp</artifactId>
    <version>3.1.0</version>
</dependency>
// https://jarcasting.com/artifacts/com.github.stephanenicolas.toothpick/ktp/
implementation 'com.github.stephanenicolas.toothpick:ktp:3.1.0'
// https://jarcasting.com/artifacts/com.github.stephanenicolas.toothpick/ktp/
implementation ("com.github.stephanenicolas.toothpick:ktp:3.1.0")
'com.github.stephanenicolas.toothpick:ktp:jar:3.1.0'
<dependency org="com.github.stephanenicolas.toothpick" name="ktp" rev="3.1.0">
  <artifact name="ktp" type="jar" />
</dependency>
@Grapes(
@Grab(group='com.github.stephanenicolas.toothpick', module='ktp', version='3.1.0')
)
libraryDependencies += "com.github.stephanenicolas.toothpick" % "ktp" % "3.1.0"
[com.github.stephanenicolas.toothpick/ktp "3.1.0"]

Dependencies

compile (1)

Group / Artifact Type Version
com.github.stephanenicolas.toothpick : toothpick-runtime jar 3.1.0

runtime (1)

Group / Artifact Type Version
org.jetbrains.kotlin : kotlin-stdlib jar 1.3.41

test (5)

Group / Artifact Type Version
com.github.stephanenicolas.toothpick : toothpick-testing-junit5 jar 3.1.0
org.junit.jupiter : junit-jupiter-api jar 5.5.0
com.nhaarman.mockitokotlin2 : mockito-kotlin jar 2.1.0
org.mockito : mockito-junit-jupiter jar 2.23.0
org.amshove.kluent : kluent-android jar 1.51

Project Modules

There are no modules declared in this project.

Toothpick (a.k.a T.P. like a teepee)

Visit TP wiki !

What is Toothpick ?

Toothpick is a scope tree based Dependency Injection (DI) library for Java.

It is a full-featured, runtime based, but reflection free, implementation of JSR 330.

What does Toothpick offer ?

//a typical Toothpick scope tree during the execution of an Android app.

           @ApplicationScope 
             /          |    \  
            /           |     \
           /            |      \
   @ViewModelScope      |   Service 2
         /              | 
        /            Service 1  
       /            
 @Activity1Scope
      /
     /
Activity 1
   /   \
  /   Fragment 2
 /
Fragment 1

Scopes offer to compartmentalize memory during the runtime of an app and prevent memory leaks. All dependencies created via Toothpick, and available for injections, will be fully garbage collected when this scope is closed. To learn more about scopes, read TP wiki.

Toothpick is :

Examples

This is the example:

Setup

The latest version of TP is provided by a badge at the top of this page.

For Android :

#android setup using gradle 5.5.1
buildscript {
  repositories {
    google()
    jcenter()
  }
  dependencies {
    classpath 'com.android.tools.build:gradle:3.4.x'
  }
}

...
#for java
dependencies {
  implementation 'com.github.stephanenicolas.toothpick:toothpick-runtime:3.x'
  // and for android -> implementation 'com.github.stephanenicolas.toothpick:smoothie-androidx:3.x'
  annotationProcessor 'com.github.stephanenicolas.toothpick:toothpick-compiler:3.x'

  //highly recommended
  testImplementation 'com.github.stephanenicolas.toothpick:toothpick-testing-junit5:3.x'
  testImplementation 'mockito or easymock'
}

#for kotlin
dependencies {
  implementation 'com.github.stephanenicolas.toothpick:ktp:3.x'
  kapt 'com.github.stephanenicolas.toothpick:toothpick-compiler:3.x'

  //highly recommended
  testImplementation 'com.github.stephanenicolas.toothpick:toothpick-testing-junit5:3.x'
  testImplementation 'mockito or easymock'
}

For java:

<!--java setup with maven -->
  <dependencies>
    <dependency>
      <groupId>com.github.stephanenicolas.toothpick</groupId>
      <artifactId>toothpick-compiler</artifactId>
      <version>3.x</version>
      <scope>compile</scope>
    </dependency>
    <dependency>
      <groupId>com.github.stephanenicolas.toothpick</groupId>
      <artifactId>toothpick-runtime</artifactId>
      <version>3.x</version>
      <scope>compile</scope>
    </dependency>
    
    <!-- highly recommended-->
    <dependency> 
      <groupId>com.github.stephanenicolas.toothpick</groupId>
      <artifactId>toothpick-testing</artifactId>
      <version>3.x</version>
      <scope>test</scope>
    </dependency>
    <dependency>
    <easymock or mockito>
    </dependency>
  </dependencies>

Support

TP is actively maintained and we provide support to questions via the Toothpick-di tag on Stack Over Flow.

Ask questions on Stack Over Flow while keeping the GitHub issue board for real issues. Thx in advance !

Talks & Articles

Wanna know more ?

Visit Toothpick's wiki !

Alternative Dependency Injection (DI) engines for Android

Libs / Apps using TP 2

  • Okuki is a simple, hierarchical navigation bus and back stack for Android, with optional Rx bindings, and Toothpick DI integration.
  • KotlinWeather is a simple example of using ToothPick with Kotlin and gradle integration using kapt.

Credits

TP 1 & 3 have been developped by Stephane Nicolas and Daniel Molinero Reguera. Most of the effort on version 2 has been actively supported by Groupon. Thanks for this awesome OSS commitment !

Versions

Version
3.1.0
3.0.2
3.0.1
3.0.0
3.0.0-RC1