├── app
├── .gitignore
├── src
│ ├── main
│ │ ├── res
│ │ │ ├── mipmap-hdpi
│ │ │ │ ├── ic_launcher.png
│ │ │ │ └── ic_launcher_round.png
│ │ │ ├── mipmap-mdpi
│ │ │ │ ├── ic_launcher.png
│ │ │ │ └── ic_launcher_round.png
│ │ │ ├── mipmap-xhdpi
│ │ │ │ ├── ic_launcher.png
│ │ │ │ └── ic_launcher_round.png
│ │ │ ├── mipmap-xxhdpi
│ │ │ │ ├── ic_launcher.png
│ │ │ │ └── ic_launcher_round.png
│ │ │ ├── mipmap-xxxhdpi
│ │ │ │ ├── ic_launcher.png
│ │ │ │ └── ic_launcher_round.png
│ │ │ ├── values
│ │ │ │ ├── strings.xml
│ │ │ │ ├── colors.xml
│ │ │ │ └── styles.xml
│ │ │ ├── mipmap-anydpi-v26
│ │ │ │ ├── ic_launcher.xml
│ │ │ │ └── ic_launcher_round.xml
│ │ │ ├── layout
│ │ │ │ ├── activity_splash.xml
│ │ │ │ ├── fragment_random_joke.xml
│ │ │ │ └── activity_main.xml
│ │ │ ├── drawable-v24
│ │ │ │ └── ic_launcher_foreground.xml
│ │ │ └── drawable
│ │ │ │ └── ic_launcher_background.xml
│ │ ├── java
│ │ │ └── com
│ │ │ │ └── sucho
│ │ │ │ └── kodeinexample
│ │ │ │ ├── DataObject.kt
│ │ │ │ ├── data
│ │ │ │ ├── model
│ │ │ │ │ ├── JokeResponse.kt
│ │ │ │ │ ├── JokeListResponse.kt
│ │ │ │ │ ├── Joke.kt
│ │ │ │ │ └── GithubUser.kt
│ │ │ │ └── services
│ │ │ │ │ ├── GithubApiService.kt
│ │ │ │ │ └── ApiService.kt
│ │ │ │ ├── utils
│ │ │ │ ├── IRxSchedulers.kt
│ │ │ │ ├── ViewModelFactory.kt
│ │ │ │ └── PrefsUtils.kt
│ │ │ │ ├── di
│ │ │ │ ├── FragmentModule.kt
│ │ │ │ ├── ActivityModule.kt
│ │ │ │ ├── ServiceModule.kt
│ │ │ │ ├── AppModule.kt
│ │ │ │ └── NetworkModule.kt
│ │ │ │ ├── feature
│ │ │ │ ├── base
│ │ │ │ │ ├── navigator
│ │ │ │ │ │ ├── ActivityNavigator.kt
│ │ │ │ │ │ └── Navigator.kt
│ │ │ │ │ ├── BaseViewModel.kt
│ │ │ │ │ ├── BaseActivity.kt
│ │ │ │ │ └── BaseDialogFragment.kt
│ │ │ │ ├── main
│ │ │ │ │ ├── randomjoke
│ │ │ │ │ │ ├── RandomJokeViewModel.kt
│ │ │ │ │ │ └── RandomJokeFragment.kt
│ │ │ │ │ ├── MainActivity.kt
│ │ │ │ │ └── MainViewModel.kt
│ │ │ │ └── splash
│ │ │ │ │ ├── SplashViewModel.kt
│ │ │ │ │ └── SplashActivity.kt
│ │ │ │ └── CustomApplication.kt
│ │ └── AndroidManifest.xml
│ └── test
│ │ └── java
│ │ └── com
│ │ └── sucho
│ │ └── kodeinexample
│ │ ├── IherbTestRunner.java
│ │ ├── mock
│ │ ├── MockApplication.kt
│ │ ├── MockServiceModule.kt
│ │ ├── MockAppModule.kt
│ │ └── MockNetworkModule.kt
│ │ └── activity
│ │ └── MainActivityTest.kt
├── proguard-rules.pro
└── build.gradle
├── settings.gradle
├── .DS_Store
├── gradle
└── wrapper
│ ├── gradle-wrapper.jar
│ └── gradle-wrapper.properties
├── gradle.properties
├── .gitignore
├── README.md
├── gradlew.bat
├── gradlew
└── LICENSE
/app/.gitignore:
--------------------------------------------------------------------------------
1 | /build
2 |
--------------------------------------------------------------------------------
/settings.gradle:
--------------------------------------------------------------------------------
1 | include ':app'
2 |
--------------------------------------------------------------------------------
/.DS_Store:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/suchoX/Kodein-MVVM/HEAD/.DS_Store
--------------------------------------------------------------------------------
/gradle/wrapper/gradle-wrapper.jar:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/suchoX/Kodein-MVVM/HEAD/gradle/wrapper/gradle-wrapper.jar
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-hdpi/ic_launcher.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/suchoX/Kodein-MVVM/HEAD/app/src/main/res/mipmap-hdpi/ic_launcher.png
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-mdpi/ic_launcher.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/suchoX/Kodein-MVVM/HEAD/app/src/main/res/mipmap-mdpi/ic_launcher.png
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-xhdpi/ic_launcher.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/suchoX/Kodein-MVVM/HEAD/app/src/main/res/mipmap-xhdpi/ic_launcher.png
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-xxhdpi/ic_launcher.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/suchoX/Kodein-MVVM/HEAD/app/src/main/res/mipmap-xxhdpi/ic_launcher.png
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-xxxhdpi/ic_launcher.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/suchoX/Kodein-MVVM/HEAD/app/src/main/res/mipmap-xxxhdpi/ic_launcher.png
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-hdpi/ic_launcher_round.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/suchoX/Kodein-MVVM/HEAD/app/src/main/res/mipmap-hdpi/ic_launcher_round.png
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-mdpi/ic_launcher_round.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/suchoX/Kodein-MVVM/HEAD/app/src/main/res/mipmap-mdpi/ic_launcher_round.png
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-xhdpi/ic_launcher_round.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/suchoX/Kodein-MVVM/HEAD/app/src/main/res/mipmap-xhdpi/ic_launcher_round.png
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-xxhdpi/ic_launcher_round.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/suchoX/Kodein-MVVM/HEAD/app/src/main/res/mipmap-xxhdpi/ic_launcher_round.png
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/suchoX/Kodein-MVVM/HEAD/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.png
--------------------------------------------------------------------------------
/app/src/main/java/com/sucho/kodeinexample/DataObject.kt:
--------------------------------------------------------------------------------
1 | package com.sucho.kodeinexample
2 |
3 | data class DataObject(
4 | val name: String,
5 | val id: Long
6 | )
--------------------------------------------------------------------------------
/app/src/main/java/com/sucho/kodeinexample/data/model/JokeResponse.kt:
--------------------------------------------------------------------------------
1 | package com.sucho.kodeinexample.data.model
2 |
3 | data class JokeResponse(
4 | val type: String,
5 | val value: Joke
6 | )
7 |
8 |
--------------------------------------------------------------------------------
/app/src/main/res/values/strings.xml:
--------------------------------------------------------------------------------
1 |
2 | Kodein Example
3 | Kodein-MVVM
4 | Random Joke
5 |
6 |
--------------------------------------------------------------------------------
/app/src/main/java/com/sucho/kodeinexample/utils/IRxSchedulers.kt:
--------------------------------------------------------------------------------
1 | package com.sucho.kodeinexample.utils
2 |
3 | import io.reactivex.Scheduler
4 |
5 | interface IRxSchedulers {
6 | fun main(): Scheduler
7 | fun io(): Scheduler
8 | }
--------------------------------------------------------------------------------
/gradle/wrapper/gradle-wrapper.properties:
--------------------------------------------------------------------------------
1 | #Mon Aug 27 13:33:35 IST 2018
2 | distributionBase=GRADLE_USER_HOME
3 | distributionPath=wrapper/dists
4 | zipStoreBase=GRADLE_USER_HOME
5 | zipStorePath=wrapper/dists
6 | distributionUrl=https\://services.gradle.org/distributions/gradle-4.4-all.zip
7 |
--------------------------------------------------------------------------------
/app/src/main/java/com/sucho/kodeinexample/di/FragmentModule.kt:
--------------------------------------------------------------------------------
1 | package com.sucho.kodeinexample.di
2 |
3 | import org.kodein.di.Kodein.Module
4 |
5 | private const val MODULE_NAME = "Fragment Module"
6 |
7 | val fragmentModule = Module(MODULE_NAME, false) {
8 | //Add Fragment Dependencies
9 |
10 | }
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-anydpi-v26/ic_launcher.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
--------------------------------------------------------------------------------
/app/src/main/res/mipmap-anydpi-v26/ic_launcher_round.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
--------------------------------------------------------------------------------
/app/src/main/res/values/colors.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 | #3F51B5
4 | #303F9F
5 | #FF4081
6 | #ffffff
7 | #009688
8 |
9 |
--------------------------------------------------------------------------------
/app/src/main/java/com/sucho/kodeinexample/data/services/GithubApiService.kt:
--------------------------------------------------------------------------------
1 | package com.sucho.kodeinexample.data.services
2 |
3 | import com.sucho.kodeinexample.data.model.GithubUser
4 | import io.reactivex.Observable
5 | import retrofit2.http.GET
6 |
7 | interface GithubApiService {
8 | @GET("/users/octocat") fun getOctocatProfile(): Observable
9 | }
--------------------------------------------------------------------------------
/app/src/main/java/com/sucho/kodeinexample/data/model/JokeListResponse.kt:
--------------------------------------------------------------------------------
1 | package com.sucho.kodeinexample.data.model
2 |
3 | import com.google.gson.annotations.SerializedName
4 | import com.sucho.kodeinexample.data.model.Joke
5 |
6 | data class JokeListResponse(
7 | @SerializedName("type")
8 | val type: String,
9 | @SerializedName("value")
10 | val value: ArrayList)
--------------------------------------------------------------------------------
/app/src/main/java/com/sucho/kodeinexample/data/model/Joke.kt:
--------------------------------------------------------------------------------
1 | package com.sucho.kodeinexample.data.model
2 |
3 | import android.os.Parcelable
4 | import com.google.gson.annotations.SerializedName
5 | import kotlinx.android.parcel.Parcelize
6 |
7 | @Parcelize
8 | data class Joke(
9 | @SerializedName("id")
10 | val id: Int,
11 | @SerializedName("joke")
12 | val joke: String): Parcelable
--------------------------------------------------------------------------------
/app/src/main/java/com/sucho/kodeinexample/feature/base/navigator/ActivityNavigator.kt:
--------------------------------------------------------------------------------
1 | package com.sucho.kodeinexample.feature.base.navigator
2 |
3 | import android.app.Activity
4 | import com.sucho.kodeinexample.feature.base.navigator.Navigator
5 |
6 | class ActivityNavigator constructor(private val activity: Activity) : Navigator() {
7 |
8 | override fun getActivity(): Activity = activity
9 |
10 | }
--------------------------------------------------------------------------------
/app/src/main/res/values/styles.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
10 |
11 |
12 |
--------------------------------------------------------------------------------
/app/src/main/java/com/sucho/kodeinexample/data/services/ApiService.kt:
--------------------------------------------------------------------------------
1 | package com.sucho.kodeinexample.data.services
2 |
3 | import com.sucho.kodeinexample.data.model.JokeListResponse
4 | import com.sucho.kodeinexample.data.model.JokeResponse
5 | import io.reactivex.Single
6 | import retrofit2.http.GET
7 |
8 | interface ApiService {
9 | @GET("/jokes/random/") fun getRandomJoke(): Single
10 | @GET("/jokes/random/5") fun getFiveRandomJokes(): Single
11 |
12 | }
--------------------------------------------------------------------------------
/app/src/main/java/com/sucho/kodeinexample/feature/main/randomjoke/RandomJokeViewModel.kt:
--------------------------------------------------------------------------------
1 | package com.sucho.kodeinexample.feature.main.randomjoke
2 |
3 | import android.content.Context
4 | import com.sucho.kodeinexample.feature.base.BaseViewModel
5 | import org.kodein.di.KodeinAware
6 | import org.kodein.di.android.closestKodein
7 | import org.kodein.di.generic.kcontext
8 |
9 | class RandomJokeViewModel constructor(context: Context): BaseViewModel(), KodeinAware {
10 | override val kodein by closestKodein(context)
11 | override val kodeinContext = kcontext(context)
12 |
13 | }
--------------------------------------------------------------------------------
/gradle.properties:
--------------------------------------------------------------------------------
1 | # Project-wide Gradle settings.
2 | # IDE (e.g. Android Studio) users:
3 | # Gradle settings configured through the IDE *will override*
4 | # any settings specified in this file.
5 | # For more details on how to configure your build environment visit
6 | # http://www.gradle.org/docs/current/userguide/build_environment.html
7 | # Specifies the JVM arguments used for the daemon process.
8 | # The setting is particularly useful for tweaking memory settings.
9 | org.gradle.jvmargs=-Xmx1536m
10 | # When configured, Gradle will run in incubating parallel mode.
11 | # This option should only be used with decoupled projects. More details, visit
12 | # http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects
13 | # org.gradle.parallel=true
14 |
--------------------------------------------------------------------------------
/app/src/main/java/com/sucho/kodeinexample/di/ActivityModule.kt:
--------------------------------------------------------------------------------
1 | package com.sucho.kodeinexample.di
2 |
3 | import android.arch.lifecycle.ViewModelProvider
4 | import com.sucho.kodeinexample.feature.base.navigator.ActivityNavigator
5 | import com.sucho.kodeinexample.feature.base.navigator.Navigator
6 | import com.sucho.kodeinexample.utils.ViewModelFactory
7 | import org.kodein.di.Kodein.Module
8 | import org.kodein.di.generic.bind
9 | import org.kodein.di.generic.instance
10 | import org.kodein.di.generic.singleton
11 |
12 | private const val MODULE_NAME = "Activity Module"
13 |
14 | val activityModule = Module(MODULE_NAME, false) {
15 | bind() with singleton { ActivityNavigator(instance()) }
16 | bind() with singleton { ViewModelFactory(instance("ActivityContext")) }
17 | }
--------------------------------------------------------------------------------
/app/src/test/java/com/sucho/kodeinexample/IherbTestRunner.java:
--------------------------------------------------------------------------------
1 | package com.sucho.kodeinexample;
2 |
3 | import android.os.Build;
4 |
5 | import com.sucho.kodeinexample.mock.MockApplication;
6 |
7 | import org.junit.runners.model.InitializationError;
8 | import org.robolectric.RobolectricTestRunner;
9 | import org.robolectric.annotation.Config;
10 |
11 | public class IherbTestRunner extends RobolectricTestRunner{
12 | public IherbTestRunner(Class> testClass) throws InitializationError {
13 | super(testClass);
14 | }
15 |
16 |
17 | @Override
18 | protected Config buildGlobalConfig() {
19 | return new Config.Builder()
20 | .setSdk(Build.VERSION_CODES.M)
21 | .setApplication(MockApplication.class)
22 | .build();
23 | }
24 | }
25 |
--------------------------------------------------------------------------------
/app/proguard-rules.pro:
--------------------------------------------------------------------------------
1 | # Add project specific ProGuard rules here.
2 | # You can control the set of applied configuration files using the
3 | # proguardFiles setting in build.gradle.
4 | #
5 | # For more details, see
6 | # http://developer.android.com/guide/developing/tools/proguard.html
7 |
8 | # If your project uses WebView with JS, uncomment the following
9 | # and specify the fully qualified class name to the JavaScript interface
10 | # class:
11 | #-keepclassmembers class fqcn.of.javascript.interface.for.webview {
12 | # public *;
13 | #}
14 |
15 | # Uncomment this to preserve the line number information for
16 | # debugging stack traces.
17 | #-keepattributes SourceFile,LineNumberTable
18 |
19 | # If you keep the line number information, uncomment this to
20 | # hide the original source file name.
21 | #-renamesourcefileattribute SourceFile
22 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | # Built application files
2 | *.apk
3 | *.ap_
4 |
5 | # Files for the ART/Dalvik VM
6 | *.dex
7 |
8 | # Java class files
9 | *.class
10 |
11 | # Generated files
12 | bin/
13 | gen/
14 | out/
15 |
16 | # Gradle files
17 | .gradle/
18 | build/
19 |
20 | # Local configuration file (sdk path, etc)
21 | local.properties
22 |
23 | # Test Files
24 | accusdk/test
25 |
26 | # Proguard folder generated by Eclipse
27 | proguard/
28 |
29 | # Log Files
30 | *.log
31 |
32 | # Android Studio Navigation editor temp files
33 | .navigation/
34 |
35 | # Android Studio captures folder
36 | captures/
37 |
38 | # Intellij
39 | *.iml
40 | .idea/
41 |
42 | # Keystore files
43 | *.jks
44 |
45 | # External native build folder generated in Android Studio 2.2 and later
46 | .externalNativeBuild
47 |
48 | # Google Services (e.g. APIs or Firebase)
49 | google-services.json
50 |
51 | # Freeline
52 | freeline.py
53 | freeline/
54 | freeline_project_description.json
--------------------------------------------------------------------------------
/app/src/main/res/layout/activity_splash.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
8 |
9 |
14 |
15 |
25 |
26 |
27 |
--------------------------------------------------------------------------------
/app/src/main/AndroidManifest.xml:
--------------------------------------------------------------------------------
1 |
2 |
4 |
5 |
6 |
7 |
15 |
16 |
17 |
18 |
19 |
20 |
21 |
22 |
23 |
24 |
25 |
26 |
--------------------------------------------------------------------------------
/app/src/main/res/layout/fragment_random_joke.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
8 |
9 |
14 |
15 |
26 |
27 |
28 |
--------------------------------------------------------------------------------
/app/src/test/java/com/sucho/kodeinexample/mock/MockApplication.kt:
--------------------------------------------------------------------------------
1 | package com.sucho.kodeinexample.mock
2 |
3 | import android.app.Application
4 | import android.content.Context
5 | import org.kodein.di.Kodein
6 | import org.kodein.di.KodeinAware
7 | import org.kodein.di.generic.bind
8 | import org.kodein.di.generic.singleton
9 | import org.robolectric.TestLifecycleApplication
10 | import java.lang.reflect.Method
11 |
12 | class MockApplication : Application(), KodeinAware, TestLifecycleApplication {
13 |
14 | override val kodein = Kodein.lazy {
15 | bind("ApplicationContext") with singleton { this@MockApplication.applicationContext }
16 | bind() with singleton { this@MockApplication }
17 | import(mockAppModule)
18 | import(mockNetworkModule)
19 | import(mockServiceModule)
20 | }
21 |
22 |
23 | override fun beforeTest(method: Method) {}
24 | override fun prepareTest(o: Any) {}
25 | override fun afterTest(method: Method) {}
26 | }
27 |
--------------------------------------------------------------------------------
/app/src/main/java/com/sucho/kodeinexample/feature/splash/SplashViewModel.kt:
--------------------------------------------------------------------------------
1 | package com.sucho.kodeinexample.feature.splash
2 |
3 | import android.content.Context
4 | import android.os.Handler
5 | import com.sucho.kodeinexample.feature.base.BaseViewModel
6 | import com.sucho.kodeinexample.feature.base.navigator.Navigator
7 | import com.sucho.kodeinexample.feature.main.MainActivity
8 | import com.sucho.kodeinexample.utils.PrefsUtils
9 | import org.kodein.di.KodeinAware
10 | import org.kodein.di.android.closestKodein
11 | import org.kodein.di.generic.instance
12 | import org.kodein.di.generic.kcontext
13 |
14 | class SplashViewModel constructor(context: Context) : BaseViewModel(), KodeinAware {
15 | override val kodein by closestKodein(context)
16 | override val kodeinContext = kcontext(context)
17 |
18 | private val navigator: Navigator by instance()
19 |
20 | fun gotoMainActivity() {
21 | Handler().postDelayed({
22 | navigator.startActivityAndFinish(MainActivity::class.java)
23 | }, 2000)
24 | }
25 | }
--------------------------------------------------------------------------------
/app/src/main/java/com/sucho/kodeinexample/CustomApplication.kt:
--------------------------------------------------------------------------------
1 | package com.sucho.kodeinexample
2 |
3 | import android.app.Application
4 | import android.content.Context
5 | import com.sucho.kodeinexample.di.appModule
6 | import com.sucho.kodeinexample.di.networkModule
7 | import com.sucho.kodeinexample.di.serviceModule
8 | import org.kodein.di.Kodein
9 | import org.kodein.di.KodeinAware
10 | import org.kodein.di.generic.bind
11 | import org.kodein.di.generic.singleton
12 | import timber.log.Timber
13 |
14 | class CustomApplication : Application(), KodeinAware {
15 | override val kodein = Kodein.lazy {
16 | bind("ApplicationContext") with singleton { this@CustomApplication.applicationContext }
17 | bind() with singleton { this@CustomApplication }
18 | import(appModule)
19 | import(networkModule)
20 | import(serviceModule)
21 | }
22 |
23 | override fun onCreate() {
24 | super.onCreate()
25 |
26 | if (BuildConfig.DEBUG) {
27 | Timber.plant(Timber.DebugTree())
28 | }
29 | }
30 | }
--------------------------------------------------------------------------------
/app/src/main/java/com/sucho/kodeinexample/feature/splash/SplashActivity.kt:
--------------------------------------------------------------------------------
1 | package com.sucho.kodeinexample.feature.splash
2 |
3 | import android.os.Bundle
4 | import android.view.Window
5 | import android.view.WindowManager
6 | import com.sucho.kodeinexample.R
7 | import com.sucho.kodeinexample.databinding.SplashActivityBinding
8 | import com.sucho.kodeinexample.feature.base.BaseActivity
9 |
10 | class SplashActivity : BaseActivity() {
11 | override fun getViewModelClass(): Class = SplashViewModel::class.java
12 |
13 | override fun layoutId(): Int = R.layout.activity_splash
14 |
15 | override fun onCreate(savedInstanceState: Bundle?) {
16 | fullScreen()
17 | super.onCreate(savedInstanceState)
18 | viewModel.gotoMainActivity()
19 | }
20 |
21 | private fun fullScreen() {
22 | requestWindowFeature(Window.FEATURE_NO_TITLE)
23 | this.window.setFlags(
24 | WindowManager.LayoutParams.FLAG_FULLSCREEN,
25 | WindowManager.LayoutParams.FLAG_FULLSCREEN
26 | )
27 | }
28 | }
--------------------------------------------------------------------------------
/app/src/main/java/com/sucho/kodeinexample/di/ServiceModule.kt:
--------------------------------------------------------------------------------
1 | package com.sucho.kodeinexample.di
2 |
3 | import com.sucho.kodeinexample.data.model.GithubUser
4 | import com.sucho.kodeinexample.data.services.ApiService
5 | import com.sucho.kodeinexample.data.services.GithubApiService
6 | import io.reactivex.Observable
7 | import io.reactivex.schedulers.Schedulers
8 | import org.kodein.di.Kodein
9 | import org.kodein.di.generic.bind
10 | import org.kodein.di.generic.instance
11 | import org.kodein.di.generic.singleton
12 |
13 | private const val MODULE_NAME = "Service Module"
14 |
15 | val serviceModule = Kodein.Module(MODULE_NAME, false) {
16 | bind() with singleton { GithubService(instance(),instance()) }
17 | }
18 |
19 | interface IGithubService {
20 | fun getUserProfile(): Observable
21 | }
22 |
23 | class GithubService(val apiService: ApiService, val githubApiService: GithubApiService): IGithubService{
24 | override fun getUserProfile(): Observable {
25 | return githubApiService.getOctocatProfile().subscribeOn(Schedulers.io())
26 | }
27 | }
28 |
--------------------------------------------------------------------------------
/app/src/main/java/com/sucho/kodeinexample/utils/ViewModelFactory.kt:
--------------------------------------------------------------------------------
1 | package com.sucho.kodeinexample.utils
2 |
3 | import android.arch.lifecycle.ViewModel
4 | import android.arch.lifecycle.ViewModelProvider
5 | import android.content.Context
6 | import com.sucho.kodeinexample.feature.main.MainViewModel
7 | import com.sucho.kodeinexample.feature.main.randomjoke.RandomJokeViewModel
8 | import com.sucho.kodeinexample.feature.splash.SplashViewModel
9 |
10 | @Suppress("UNCHECKED_CAST")
11 | class ViewModelFactory constructor(private val context: Context): ViewModelProvider.Factory {
12 | override fun create(modelClass: Class): T {
13 | if(modelClass.isAssignableFrom(MainViewModel::class.java)) {
14 | return MainViewModel(context) as T
15 | } else if(modelClass.isAssignableFrom(SplashViewModel::class.java)) {
16 | return SplashViewModel(context) as T
17 | }else if(modelClass.isAssignableFrom(RandomJokeViewModel::class.java)) {
18 | return RandomJokeViewModel(context) as T
19 | }
20 | throw IllegalArgumentException("Unknown class name")
21 | }
22 | }
--------------------------------------------------------------------------------
/app/src/main/java/com/sucho/kodeinexample/utils/PrefsUtils.kt:
--------------------------------------------------------------------------------
1 | package com.sucho.kodeinexample.utils
2 |
3 | import android.content.SharedPreferences
4 | import android.util.Log
5 |
6 | class PrefsUtils constructor(private val prefs: SharedPreferences) {
7 | companion object {
8 | private const val PREFS_LOCATION_PERMISSION_REQUESTED = "Location permission requested"
9 | private const val PREFS_STORAGE_PERMISSION_REQUESTED = "Storage permission requested"
10 | }
11 |
12 | fun getLocationPermissionRequested(): Boolean {
13 | return prefs.getBoolean(PREFS_LOCATION_PERMISSION_REQUESTED, false)
14 | }
15 |
16 | fun setLocationPermissionRequested(b: Boolean) {
17 | prefs.edit().putBoolean(PREFS_LOCATION_PERMISSION_REQUESTED, b).apply()
18 | }
19 |
20 | fun getStoragePermissionRequested(): Boolean {
21 | return prefs.getBoolean(PREFS_STORAGE_PERMISSION_REQUESTED, false)
22 | }
23 |
24 | fun setStoragePermissionRequested(b: Boolean) {
25 | prefs.edit().putBoolean(PREFS_STORAGE_PERMISSION_REQUESTED, b).apply()
26 | }
27 |
28 | fun test() {
29 | Log.e("DDDD", "DDDD")
30 | }
31 | }
32 |
--------------------------------------------------------------------------------
/app/src/main/java/com/sucho/kodeinexample/feature/base/BaseViewModel.kt:
--------------------------------------------------------------------------------
1 | package com.sucho.kodeinexample.feature.base
2 |
3 | import android.arch.lifecycle.LifecycleObserver
4 | import android.arch.lifecycle.ViewModel
5 | import android.content.Context
6 | import io.reactivex.disposables.CompositeDisposable
7 | import io.reactivex.disposables.Disposable
8 | import org.kodein.di.Kodein
9 | import org.kodein.di.KodeinAware
10 | import org.kodein.di.generic.kcontext
11 | import timber.log.Timber
12 |
13 | abstract class BaseViewModel : ViewModel(), LifecycleObserver {
14 |
15 | private var compositeDisposable: CompositeDisposable? = null
16 |
17 | override fun onCleared() {
18 | super.onCleared()
19 | Timber.d("unsubscribeFromDataStore(): ")
20 | if (compositeDisposable != null) {
21 | compositeDisposable!!.dispose()
22 | compositeDisposable!!.clear()
23 | compositeDisposable = null
24 | }
25 | }
26 |
27 | protected fun addDisposable(disposable: Disposable) {
28 | if (compositeDisposable == null) {
29 | compositeDisposable = CompositeDisposable()
30 | }
31 | compositeDisposable!!.add(disposable)
32 | }
33 |
34 | }
--------------------------------------------------------------------------------
/app/src/test/java/com/sucho/kodeinexample/mock/MockServiceModule.kt:
--------------------------------------------------------------------------------
1 | package com.sucho.kodeinexample.mock
2 |
3 | import com.sucho.kodeinexample.data.model.GithubUser
4 | import com.sucho.kodeinexample.data.services.ApiService
5 | import com.sucho.kodeinexample.data.services.GithubApiService
6 | import com.sucho.kodeinexample.di.IGithubService
7 | import io.reactivex.Observable
8 | import org.kodein.di.Kodein
9 | import org.kodein.di.generic.bind
10 | import org.kodein.di.generic.instance
11 | import org.kodein.di.generic.singleton
12 |
13 | private const val MODULE_NAME = "Service Module"
14 |
15 | val mockServiceModule = Kodein.Module(MODULE_NAME, false) {
16 | bind() with singleton { GithubService(instance(), instance()) }
17 | }
18 |
19 | class GithubService(val apiService: ApiService,val githubApiService: GithubApiService) : IGithubService {
20 | override fun getUserProfile(): Observable {
21 | return Observable.just(GithubUser("","","","Github","","",
22 | "",12,"",123,"","","","",
23 | "",123,"","","","","",123,
24 | 123,"","",true,"","",
25 | "","",""))
26 | }
27 | }
28 |
--------------------------------------------------------------------------------
/app/src/main/java/com/sucho/kodeinexample/data/model/GithubUser.kt:
--------------------------------------------------------------------------------
1 | package com.sucho.kodeinexample.data.model
2 |
3 | data class GithubUser(
4 | val avatar_url: String,
5 | val bio: Any?,
6 | val blog: String,
7 | val company: String,
8 | val created_at: String,
9 | val email: Any?,
10 | val events_url: String,
11 | val followers: Int,
12 | val followers_url: String,
13 | val following: Int,
14 | val following_url: String,
15 | val gists_url: String,
16 | val gravatar_id: String,
17 | val hireable: Any?,
18 | val html_url: String,
19 | val id: Int,
20 | val location: String,
21 | val login: String,
22 | val name: String,
23 | val node_id: String,
24 | val organizations_url: String,
25 | val public_gists: Int,
26 | val public_repos: Int,
27 | val received_events_url: String,
28 | val repos_url: String,
29 | val site_admin: Boolean,
30 | val starred_url: String,
31 | val subscriptions_url: String,
32 | val type: String,
33 | val updated_at: String,
34 | val url: String
35 | )
--------------------------------------------------------------------------------
/app/src/test/java/com/sucho/kodeinexample/activity/MainActivityTest.kt:
--------------------------------------------------------------------------------
1 | package com.sucho.kodeinexample.activity
2 |
3 |
4 | import androidx.test.core.app.ActivityScenario
5 | import com.sucho.kodeinexample.IherbTestRunner
6 | import com.sucho.kodeinexample.feature.main.MainActivity
7 | import org.junit.Assert
8 | import org.junit.Before
9 | import org.junit.Test
10 | import org.junit.runner.RunWith
11 | import java.lang.Thread.sleep
12 |
13 |
14 | /**
15 | * Example local unit test, which will execute on the development machine (host).
16 | *
17 | * See [testing documentation](http://d.android.com/tools/testing).
18 | */
19 |
20 | @RunWith(IherbTestRunner::class)
21 | class MainActivityTest {
22 | private lateinit var testObj: ActivityScenario
23 |
24 | @Before
25 | fun setup() {
26 | testObj = ActivityScenario.launch(MainActivity::class.java)
27 | }
28 |
29 | @Test
30 | fun testCompanyName() {
31 | testObj.onActivity {
32 | it.viewModel.fetchRandomJoke()
33 | sleep(10000)
34 | val companyName = it.viewModel.stringLiveData.value
35 | Assert.assertTrue(companyName == "Github")
36 | }
37 | }
38 | }
39 |
--------------------------------------------------------------------------------
/app/src/main/res/layout/activity_main.xml:
--------------------------------------------------------------------------------
1 |
2 |
6 |
7 |
11 |
12 |
16 |
26 |
27 |
34 |
35 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | Kodein-MVVM
2 | ======
3 |
4 | This is a simple sample Android app written in **Kotlin**, to showcase how to use **Kodein** dependency injection in your app. It uses **MVVM Architecture**, **Architecture Components** and **Kodein** to provide a robust base to the app. The **Retrofit** library is used to fetch jokes along with the **RxJava 2** and **RxAndroid 2** which handles connections asynchronously and makes the app more reliable.
5 |
6 | Dependency Injection has been layered into 3 separate Modules for better structure: AppModule, ActivityModule and FragmentModule
7 |
8 | SupportFragment has been used to support Architecture Component ViewModel. (Fragment has also been deprecated since Android P)
9 |
10 | Kodein is a viable replacement over Dagger 2 which is less complex and easier to setup (But requires more Boilerplate and needs Context for injection). Personally I feel, Kodein is suitable for smaller projects
11 |
12 | **Setup**
13 |
14 | - [Kodein](https://github.com/Kodein-Framework/Kodein-DI) for Dependency Injection
15 | - MVVM pattern using Architecture Components
16 | - [Retrofit](https://github.com/square/retrofit), [RxJava 2, RxAndroid 2](https://github.com/ReactiveX/RxJava) for API calls
17 |
18 | This app can be used as a base template for yor Android Apps and can be used as a template for your apps.
19 |
--------------------------------------------------------------------------------
/app/src/test/java/com/sucho/kodeinexample/mock/MockAppModule.kt:
--------------------------------------------------------------------------------
1 | package com.sucho.kodeinexample.mock
2 |
3 | import android.content.Context
4 | import android.content.res.Resources
5 | import android.preference.PreferenceManager
6 | import com.sucho.kodeinexample.DataObject
7 | import com.sucho.kodeinexample.utils.IRxSchedulers
8 | import com.sucho.kodeinexample.utils.PrefsUtils
9 | import io.reactivex.Scheduler
10 | import io.reactivex.android.schedulers.AndroidSchedulers
11 | import io.reactivex.schedulers.Schedulers
12 | import org.kodein.di.Kodein.Module
13 | import org.kodein.di.generic.bind
14 | import org.kodein.di.generic.instance
15 | import org.kodein.di.generic.singleton
16 |
17 | private const val MODULE_NAME = "App Module"
18 |
19 | val mockAppModule = Module(MODULE_NAME, false) {
20 | bind() with singleton { injectDataObject() }
21 | bind() with singleton { getPrefsUtils(instance("ApplicationContext")) }
22 | bind() with singleton { instance().resources }
23 | bind() with singleton { getIRxSchedulers() }
24 | }
25 |
26 | private fun injectDataObject(): DataObject = DataObject("Name", 100L)
27 |
28 | private fun getPrefsUtils(context: Context): PrefsUtils = PrefsUtils(PreferenceManager.getDefaultSharedPreferences(context))
29 |
30 | private fun getIRxSchedulers(): IRxSchedulers = object : IRxSchedulers {
31 | override fun main(): Scheduler = AndroidSchedulers.mainThread()
32 | override fun io(): Scheduler = Schedulers.io()
33 |
34 | }
--------------------------------------------------------------------------------
/app/src/main/java/com/sucho/kodeinexample/feature/main/randomjoke/RandomJokeFragment.kt:
--------------------------------------------------------------------------------
1 | package com.sucho.kodeinexample.feature.main.randomjoke
2 |
3 | import android.arch.lifecycle.Lifecycle
4 | import android.arch.lifecycle.LifecycleOwner
5 | import android.content.Context
6 | import android.os.Bundle
7 | import android.view.LayoutInflater
8 | import android.view.View
9 | import android.view.ViewGroup
10 | import com.sucho.kodeinexample.R
11 | import com.sucho.kodeinexample.databinding.RandomJokeFragmentBinding
12 | import com.sucho.kodeinexample.feature.base.BaseDialogFragment
13 |
14 | class RandomJokeFragment : BaseDialogFragment(), LifecycleOwner {
15 |
16 | override fun getViewModelClass(): Class = RandomJokeViewModel::class.java
17 |
18 | override fun layoutId(): Int = R.layout.fragment_random_joke
19 |
20 | companion object {
21 | private const val JOKE_INTENT = "JOKE_INTENT"
22 |
23 | fun newInstance(joke: String): RandomJokeFragment {
24 | val fragment = RandomJokeFragment()
25 | val args = Bundle()
26 | args.putString(JOKE_INTENT, joke)
27 | fragment.arguments = args
28 | return fragment
29 | }
30 | }
31 |
32 |
33 | override fun fragmentInitialized() {
34 | binding.jokeTextView.text = arguments?.getString(JOKE_INTENT)
35 | }
36 |
37 | override fun getLifecycle(): Lifecycle {
38 | TODO("not implemented") //To change body of created functions use File | Settings | File Templates.
39 | }
40 |
41 | }
--------------------------------------------------------------------------------
/app/src/main/java/com/sucho/kodeinexample/di/AppModule.kt:
--------------------------------------------------------------------------------
1 | package com.sucho.kodeinexample.di
2 |
3 | import android.content.Context
4 | import android.content.res.Resources
5 | import android.preference.PreferenceManager
6 | import com.sucho.kodeinexample.CustomApplication
7 | import com.sucho.kodeinexample.DataObject
8 | import com.sucho.kodeinexample.utils.IRxSchedulers
9 | import com.sucho.kodeinexample.utils.PrefsUtils
10 | import io.reactivex.Scheduler
11 | import io.reactivex.android.schedulers.AndroidSchedulers
12 | import io.reactivex.schedulers.Schedulers
13 | import org.kodein.di.Kodein.Module
14 | import org.kodein.di.generic.bind
15 | import org.kodein.di.generic.instance
16 | import org.kodein.di.generic.singleton
17 |
18 | private const val MODULE_NAME = "App Module"
19 |
20 | val appModule = Module(MODULE_NAME, false) {
21 | bind() with singleton { injectDataObject() }
22 | bind() with singleton { getPrefsUtils(instance("ApplicationContext")) }
23 | bind() with singleton { instance().resources }
24 | bind() with singleton { getIRxSchedulers() }
25 | }
26 |
27 | private fun injectDataObject(): DataObject = DataObject("Name", 100L)
28 |
29 | private fun getPrefsUtils(context: Context): PrefsUtils = PrefsUtils(PreferenceManager.getDefaultSharedPreferences(context))
30 |
31 | private fun getIRxSchedulers(): IRxSchedulers = object : IRxSchedulers {
32 | override fun main(): Scheduler = AndroidSchedulers.mainThread()
33 | override fun io(): Scheduler = Schedulers.io()
34 |
35 | }
--------------------------------------------------------------------------------
/app/src/main/java/com/sucho/kodeinexample/feature/main/MainActivity.kt:
--------------------------------------------------------------------------------
1 | package com.sucho.kodeinexample.feature.main
2 |
3 | import android.arch.lifecycle.Observer
4 | import android.os.Bundle
5 | import android.util.Log
6 | import android.view.View
7 | import com.sucho.kodeinexample.R
8 | import com.sucho.kodeinexample.databinding.MainActivityBinding
9 | import com.sucho.kodeinexample.feature.base.BaseActivity
10 | import com.sucho.kodeinexample.feature.main.randomjoke.RandomJokeFragment
11 | import timber.log.Timber
12 |
13 | class MainActivity : BaseActivity() {
14 | override fun getViewModelClass(): Class = MainViewModel::class.java
15 |
16 | override fun layoutId(): Int = R.layout.activity_main
17 |
18 | override fun onCreate(savedInstanceState: Bundle?) {
19 | super.onCreate(savedInstanceState)
20 |
21 | viewModel.dataLoading.observe(this, Observer { handleDataLoadingUi(it!!) })
22 | viewModel.joke.observe(this, Observer { showRandomJokeFragment(it!!) })
23 |
24 | binding.randomJokeButton.setOnClickListener {
25 | viewModel.fetchRandomJoke()
26 | }
27 |
28 | }
29 |
30 |
31 | private fun handleDataLoadingUi(loading: Boolean) {
32 | binding.progressbar.visibility = if (loading) View.VISIBLE else View.INVISIBLE
33 | binding.randomJokeButton.isEnabled = !loading
34 | }
35 |
36 | private fun showRandomJokeFragment(joke: String) {
37 | Timber.d(joke)
38 | val fragment = RandomJokeFragment.newInstance(joke)
39 | fragment.show(supportFragmentManager, "dialog")
40 | }
41 | }
42 |
--------------------------------------------------------------------------------
/app/src/main/java/com/sucho/kodeinexample/feature/main/MainViewModel.kt:
--------------------------------------------------------------------------------
1 | package com.sucho.kodeinexample.feature.main
2 |
3 | import android.arch.lifecycle.MutableLiveData
4 | import android.content.Context
5 | import android.util.Log
6 | import com.sucho.kodeinexample.data.services.ApiService
7 | import com.sucho.kodeinexample.di.GithubService
8 | import com.sucho.kodeinexample.di.IGithubService
9 | import com.sucho.kodeinexample.feature.base.BaseViewModel
10 | import com.sucho.kodeinexample.utils.IRxSchedulers
11 | import org.kodein.di.KodeinAware
12 | import org.kodein.di.android.closestKodein
13 | import org.kodein.di.generic.instance
14 | import org.kodein.di.generic.kcontext
15 | import timber.log.Timber
16 |
17 | class MainViewModel constructor(context: Context) : BaseViewModel(), KodeinAware {
18 | override val kodein by closestKodein(context)
19 | override val kodeinContext = kcontext(context)
20 |
21 | private val apiService: ApiService by instance()
22 | private val schedulers: IRxSchedulers by instance()
23 |
24 | private val githubService: IGithubService by instance()
25 |
26 | var dataLoading: MutableLiveData = MutableLiveData()
27 | var joke: MutableLiveData = MutableLiveData()
28 | var stringLiveData: MutableLiveData = MutableLiveData()
29 |
30 | fun fetchRandomJoke() {
31 | dataLoading.postValue(true)
32 | addDisposable(apiService.getRandomJoke()
33 | .subscribeOn(schedulers.io())
34 | .observeOn(schedulers.main())
35 | .doFinally { dataLoading.postValue(false) }
36 | .subscribe({response -> joke.postValue(response.value.joke)}, {Timber.e(it)})
37 | )
38 |
39 | addDisposable(githubService.getUserProfile().observeOn(schedulers.main()).subscribe({
40 | Log.i("githubService","user $it")
41 | stringLiveData.postValue(it.company)
42 | },{
43 |
44 | }))
45 |
46 | }
47 | }
--------------------------------------------------------------------------------
/app/src/main/res/drawable-v24/ic_launcher_foreground.xml:
--------------------------------------------------------------------------------
1 |
7 |
12 |
13 |
19 |
22 |
25 |
26 |
27 |
28 |
34 |
35 |
--------------------------------------------------------------------------------
/app/src/main/java/com/sucho/kodeinexample/feature/base/BaseActivity.kt:
--------------------------------------------------------------------------------
1 | package com.sucho.kodeinexample.feature.base
2 |
3 | import android.app.Activity
4 | import android.arch.lifecycle.ViewModel
5 | import android.arch.lifecycle.ViewModelProvider
6 | import android.arch.lifecycle.ViewModelProviders
7 | import android.content.Context
8 | import android.databinding.DataBindingUtil
9 | import android.databinding.ViewDataBinding
10 | import android.os.Bundle
11 | import android.support.annotation.LayoutRes
12 | import android.support.v7.app.AppCompatActivity
13 | import com.sucho.kodeinexample.di.activityModule
14 | import org.kodein.di.Copy
15 | import org.kodein.di.Kodein
16 | import org.kodein.di.KodeinAware
17 | import org.kodein.di.android.closestKodein
18 | import org.kodein.di.android.retainedKodein
19 | import org.kodein.di.generic.bind
20 | import org.kodein.di.generic.instance
21 | import org.kodein.di.generic.singleton
22 |
23 | abstract class BaseActivity: AppCompatActivity(), KodeinAware {
24 | protected lateinit var binding: B
25 | lateinit var viewModel: VM
26 |
27 | private val _parentKodein by closestKodein()
28 | override val kodein: Kodein by retainedKodein {
29 | extend(_parentKodein, copy = Copy.All)
30 | bind() with singleton { this@BaseActivity }
31 | bind("ActivityContext") with singleton { this@BaseActivity }
32 | import(activityModule)
33 | }
34 |
35 | private val viewModelFactory: ViewModelProvider.Factory by instance()
36 |
37 | override fun onCreate(savedInstanceState: Bundle?) {
38 | super.onCreate(savedInstanceState)
39 | bindContentView(layoutId())
40 | }
41 |
42 | private fun bindContentView(layoutId: Int) {
43 | binding = DataBindingUtil.setContentView(this, layoutId)
44 | viewModel = ViewModelProviders.of(this, viewModelFactory).get(getViewModelClass())
45 | }
46 |
47 | abstract fun getViewModelClass(): Class
48 |
49 | @LayoutRes protected abstract fun layoutId(): Int
50 | }
--------------------------------------------------------------------------------
/app/src/test/java/com/sucho/kodeinexample/mock/MockNetworkModule.kt:
--------------------------------------------------------------------------------
1 | package com.sucho.kodeinexample.mock
2 |
3 | import com.sucho.kodeinexample.BuildConfig
4 | import com.sucho.kodeinexample.data.services.ApiService
5 | import com.sucho.kodeinexample.data.services.GithubApiService
6 | import okhttp3.OkHttpClient
7 | import okhttp3.logging.HttpLoggingInterceptor
8 | import org.kodein.di.Kodein.Module
9 | import org.kodein.di.generic.bind
10 | import org.kodein.di.generic.instance
11 | import org.kodein.di.generic.singleton
12 | import retrofit2.Retrofit
13 | import retrofit2.adapter.rxjava2.RxJava2CallAdapterFactory
14 | import retrofit2.converter.gson.GsonConverterFactory
15 |
16 | private const val MODULE_NAME = "Network Module"
17 |
18 | val mockNetworkModule = Module(MODULE_NAME, false) {
19 | bind() with singleton { getOkHttpClient() }
20 | bind() with singleton { getRetrofit(instance()) }
21 | bind() with singleton { getApiService(instance()) }
22 | bind() with singleton { getGithubApiService(instance()) }
23 | }
24 |
25 |
26 | private fun getOkHttpClient(): OkHttpClient {
27 | val httpBuilder = OkHttpClient.Builder()
28 | if (BuildConfig.ENABLE_LOGGING) {
29 | val httpLoggingInterceptor = HttpLoggingInterceptor()
30 | httpLoggingInterceptor.level = HttpLoggingInterceptor.Level.BODY
31 | httpBuilder.interceptors()
32 | .add(httpLoggingInterceptor)
33 | }
34 | return httpBuilder.build()
35 | }
36 |
37 | private fun getRetrofit(okHttpClient: OkHttpClient): Retrofit = Retrofit.Builder()
38 | .baseUrl(BuildConfig.BASE_URL)
39 | .addConverterFactory(GsonConverterFactory.create())
40 | .addCallAdapterFactory(RxJava2CallAdapterFactory.create())
41 | .client(okHttpClient)
42 | .build()
43 |
44 | private fun getApiService(retrofit: Retrofit): ApiService = retrofit.create(ApiService::class.java)
45 |
46 | private fun getGithubApiService(retrofit: Retrofit): GithubApiService = retrofit.newBuilder()
47 | .baseUrl("https://api.github.com").build().create(GithubApiService::class.java)
--------------------------------------------------------------------------------
/app/src/main/java/com/sucho/kodeinexample/di/NetworkModule.kt:
--------------------------------------------------------------------------------
1 | package com.sucho.kodeinexample.di
2 |
3 | import com.sucho.kodeinexample.BuildConfig
4 | import com.sucho.kodeinexample.data.services.ApiService
5 | import com.sucho.kodeinexample.data.services.GithubApiService
6 | import okhttp3.OkHttpClient
7 | import okhttp3.logging.HttpLoggingInterceptor
8 | import org.kodein.di.Kodein.Module
9 | import org.kodein.di.generic.bind
10 | import org.kodein.di.generic.instance
11 | import org.kodein.di.generic.singleton
12 | import retrofit2.Retrofit
13 | import retrofit2.adapter.rxjava2.RxJava2CallAdapterFactory
14 | import retrofit2.converter.gson.GsonConverterFactory
15 |
16 | private const val MODULE_NAME = "Network Module"
17 |
18 | val networkModule = Module(MODULE_NAME, false) {
19 | bind() with singleton { getMockOkHttpClient() }
20 | bind() with singleton { getMockRetrofit(instance()) }
21 | bind() with singleton { getMockApiService(instance()) }
22 | bind() with singleton { getMockeGithubApiService(instance()) }
23 | }
24 |
25 | private fun getMockOkHttpClient(): OkHttpClient {
26 | val httpBuilder = OkHttpClient.Builder()
27 | if (BuildConfig.ENABLE_LOGGING) {
28 | val httpLoggingInterceptor = HttpLoggingInterceptor()
29 | httpLoggingInterceptor.level = HttpLoggingInterceptor.Level.BODY
30 | httpBuilder.interceptors()
31 | .add(httpLoggingInterceptor)
32 | }
33 | return httpBuilder.build()
34 | }
35 |
36 | private fun getMockRetrofit(okHttpClient: OkHttpClient): Retrofit = Retrofit.Builder()
37 | .baseUrl(BuildConfig.BASE_URL)
38 | .addConverterFactory(GsonConverterFactory.create())
39 | .addCallAdapterFactory(RxJava2CallAdapterFactory.create())
40 | .client(okHttpClient)
41 | .build()
42 |
43 | private fun getMockApiService(retrofit: Retrofit): ApiService = retrofit.create(ApiService::class.java)
44 |
45 | private fun getMockeGithubApiService(retrofit: Retrofit): GithubApiService = retrofit.newBuilder()
46 | .baseUrl("https://api.github.com").build().create(GithubApiService::class.java)
--------------------------------------------------------------------------------
/app/src/main/java/com/sucho/kodeinexample/feature/base/BaseDialogFragment.kt:
--------------------------------------------------------------------------------
1 | package com.sucho.kodeinexample.feature.base
2 |
3 | import android.arch.lifecycle.ViewModel
4 | import android.arch.lifecycle.ViewModelProvider
5 | import android.arch.lifecycle.ViewModelProviders
6 | import android.databinding.DataBindingUtil
7 | import android.databinding.ViewDataBinding
8 | import android.os.Bundle
9 | import android.support.annotation.LayoutRes
10 | import android.support.v4.app.DialogFragment
11 | import android.view.LayoutInflater
12 | import android.view.View
13 | import android.view.ViewGroup
14 | import com.sucho.kodeinexample.di.fragmentModule
15 | import org.kodein.di.Kodein
16 | import org.kodein.di.KodeinAware
17 | import org.kodein.di.KodeinContext
18 | import org.kodein.di.android.support.closestKodein
19 | import org.kodein.di.generic.instance
20 | import org.kodein.di.generic.kcontext
21 |
22 | abstract class BaseDialogFragment : DialogFragment(), KodeinAware {
23 | protected lateinit var binding: B
24 | lateinit var viewModel: VM
25 |
26 | override val kodeinContext: KodeinContext<*> get() = kcontext(activity)
27 | private val _parentKodein by closestKodein()
28 |
29 | override val kodein: Kodein = Kodein.lazy {
30 | extend(_parentKodein)
31 | import(fragmentModule)
32 | }
33 |
34 | private val viewModelFactory: ViewModelProvider.Factory by instance()
35 |
36 | override fun onCreateView(
37 | inflater: LayoutInflater,
38 | container: ViewGroup?,
39 | savedInstanceState: Bundle?
40 | ): View? {
41 | bindContentView(inflater, layoutId(), container)
42 | fragmentInitialized()
43 | return binding.root
44 | }
45 |
46 | private fun bindContentView(inflater: LayoutInflater, layoutId: Int, container: ViewGroup?) {
47 | binding = DataBindingUtil.inflate(inflater, layoutId, container, false)
48 | viewModel = ViewModelProviders.of(this, viewModelFactory).get(getViewModelClass())
49 | }
50 |
51 | abstract fun getViewModelClass(): Class
52 |
53 | @LayoutRes protected abstract fun layoutId(): Int
54 |
55 | abstract fun fragmentInitialized()
56 | }
--------------------------------------------------------------------------------
/app/src/main/java/com/sucho/kodeinexample/feature/base/navigator/Navigator.kt:
--------------------------------------------------------------------------------
1 | package com.sucho.kodeinexample.feature.base.navigator
2 |
3 | import android.app.Activity
4 | import android.content.Intent
5 | import android.os.Bundle
6 | import android.support.v7.app.AppCompatActivity
7 |
8 | abstract class Navigator {
9 | abstract fun getActivity(): Activity
10 |
11 | fun startActivity(activityClass: Class) {
12 | val activity = getActivity()
13 | val intent = Intent(activity, activityClass)
14 | activity.startActivity(intent)
15 | }
16 |
17 | fun startActivityAndFinish(activityClass: Class) {
18 | val activity = getActivity()
19 | val intent = Intent(activity, activityClass)
20 | activity.startActivity(intent)
21 | activity.finish()
22 | }
23 |
24 | fun startActivityWithAnimation(activityClass: Class,
25 | inAnimation: Int, outAnimation: Int) {
26 | val activity = getActivity()
27 | val intent = Intent(activity, activityClass)
28 | activity.startActivity(intent)
29 | getActivity().overridePendingTransition(inAnimation, outAnimation)
30 | }
31 |
32 | fun startActivityWithAnimation(activityClass: Class,
33 | inAnimation: Int, outAnimation: Int, args: Bundle) {
34 | val activity = getActivity()
35 | val intent = Intent(activity, activityClass)
36 | intent.putExtras(args)
37 | activity.startActivity(intent)
38 | getActivity().overridePendingTransition(inAnimation, outAnimation)
39 | }
40 |
41 | fun startActivityWithAnimationForResult(activityClass: Class,
42 | inAnimation: Int, outAnimation: Int, args: Bundle, requestCode: Int) {
43 | val activity = getActivity()
44 | val intent = Intent(activity, activityClass)
45 | intent.putExtras(args)
46 | getActivity().startActivityForResult(intent, requestCode)
47 | getActivity().overridePendingTransition(inAnimation, outAnimation)
48 | }
49 |
50 | fun finishActivityWithAnimation(inAnimation: Int, outAnimation: Int) {
51 | getActivity().finish()
52 | getActivity().overridePendingTransition(inAnimation, outAnimation)
53 | }
54 |
55 | fun finishActivityWithAnimationForResult(inAnimation: Int, outAnimation: Int, resultCode: Int) {
56 | val returnIntent = Intent()
57 | getActivity().setResult(resultCode, returnIntent)
58 | getActivity().finish()
59 | getActivity().overridePendingTransition(inAnimation, outAnimation)
60 | }
61 | }
--------------------------------------------------------------------------------
/gradlew.bat:
--------------------------------------------------------------------------------
1 | @if "%DEBUG%" == "" @echo off
2 | @rem ##########################################################################
3 | @rem
4 | @rem Gradle startup script for Windows
5 | @rem
6 | @rem ##########################################################################
7 |
8 | @rem Set local scope for the variables with windows NT shell
9 | if "%OS%"=="Windows_NT" setlocal
10 |
11 | set DIRNAME=%~dp0
12 | if "%DIRNAME%" == "" set DIRNAME=.
13 | set APP_BASE_NAME=%~n0
14 | set APP_HOME=%DIRNAME%
15 |
16 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
17 | set DEFAULT_JVM_OPTS=
18 |
19 | @rem Find java.exe
20 | if defined JAVA_HOME goto findJavaFromJavaHome
21 |
22 | set JAVA_EXE=java.exe
23 | %JAVA_EXE% -version >NUL 2>&1
24 | if "%ERRORLEVEL%" == "0" goto init
25 |
26 | echo.
27 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
28 | echo.
29 | echo Please set the JAVA_HOME variable in your environment to match the
30 | echo location of your Java installation.
31 |
32 | goto fail
33 |
34 | :findJavaFromJavaHome
35 | set JAVA_HOME=%JAVA_HOME:"=%
36 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe
37 |
38 | if exist "%JAVA_EXE%" goto init
39 |
40 | echo.
41 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
42 | echo.
43 | echo Please set the JAVA_HOME variable in your environment to match the
44 | echo location of your Java installation.
45 |
46 | goto fail
47 |
48 | :init
49 | @rem Get command-line arguments, handling Windows variants
50 |
51 | if not "%OS%" == "Windows_NT" goto win9xME_args
52 |
53 | :win9xME_args
54 | @rem Slurp the command line arguments.
55 | set CMD_LINE_ARGS=
56 | set _SKIP=2
57 |
58 | :win9xME_args_slurp
59 | if "x%~1" == "x" goto execute
60 |
61 | set CMD_LINE_ARGS=%*
62 |
63 | :execute
64 | @rem Setup the command line
65 |
66 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
67 |
68 | @rem Execute Gradle
69 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS%
70 |
71 | :end
72 | @rem End local scope for the variables with windows NT shell
73 | if "%ERRORLEVEL%"=="0" goto mainEnd
74 |
75 | :fail
76 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
77 | rem the _cmd.exe /c_ return code!
78 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
79 | exit /b 1
80 |
81 | :mainEnd
82 | if "%OS%"=="Windows_NT" endlocal
83 |
84 | :omega
85 |
--------------------------------------------------------------------------------
/app/build.gradle:
--------------------------------------------------------------------------------
1 | apply plugin: 'com.android.application'
2 | apply plugin: 'kotlin-android'
3 | apply plugin: 'kotlin-android-extensions'
4 | apply plugin: 'kotlin-kapt'
5 |
6 | android {
7 | compileSdkVersion COMPILE_SDK_VERSION
8 | buildToolsVersion BUILD_TOOLS_VERSION
9 |
10 | defaultConfig {
11 | applicationId "com.sucho.kodeinexample"
12 | minSdkVersion MIN_SDK_VERSION
13 | targetSdkVersion TARGET_SDK_VERSION
14 | versionCode 1
15 | versionName "1.0"
16 | testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
17 |
18 | vectorDrawables.useSupportLibrary = true
19 | }
20 |
21 | buildTypes {
22 | release {
23 | debuggable false
24 | versionNameSuffix '-release'
25 |
26 | minifyEnabled true
27 | shrinkResources true
28 |
29 | proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-common.txt', 'proguard-specific.txt'
30 |
31 | buildConfigField 'boolean', "ENABLE_LOGGING", 'false'
32 | buildConfigField 'String', "BASE_URL", "http://api.icndb.com"
33 | }
34 | debug {
35 | debuggable true
36 |
37 | versionNameSuffix '-debug'
38 | applicationIdSuffix '.debug'
39 |
40 | buildConfigField 'boolean', "ENABLE_LOGGING", 'true'
41 | buildConfigField 'String', "BASE_URL", '"http://api.icndb.com"'
42 | }
43 | }
44 |
45 |
46 | androidExtensions {
47 | experimental = true
48 | }
49 |
50 | dataBinding {
51 | enabled = true
52 | }
53 |
54 | testOptions {
55 | unitTests {
56 | includeAndroidResources = true
57 | }
58 | }
59 | }
60 |
61 | dependencies {
62 | implementation fileTree(dir: 'libs', include: ['*.jar'])
63 | // Kotlin
64 | implementation deps.kotlinsdk
65 |
66 | // Android Support Libs
67 | implementation deps.appcompatv7
68 | implementation deps.design
69 |
70 | // Retrofit 2
71 | implementation deps.retrofit
72 | implementation deps.retrofitgson
73 | implementation deps.retrofitrx
74 | implementation deps.okhttplogger
75 |
76 | // Rx
77 | implementation deps.rxjava2
78 | implementation deps.rxandroid2
79 |
80 | // Rx Plugins
81 | implementation deps.rxpermissions
82 |
83 | // Timber
84 | implementation deps.timber
85 |
86 | //Architecture Components
87 | implementation deps.archExtenstion
88 | implementation deps.archViewmmodel
89 | implementation deps.archLivdata
90 | implementation deps.reactiveStreams
91 | kapt deps.archCompiler
92 |
93 | //Kodein
94 | implementation deps.kodein
95 | implementation deps.kodeinAndroidSupport
96 | testImplementation 'org.robolectric:robolectric:4.3'
97 | testImplementation 'junit:junit:4.12'
98 | testImplementation 'androidx.test:core:1.1.0'
99 | }
100 |
--------------------------------------------------------------------------------
/app/src/main/res/drawable/ic_launcher_background.xml:
--------------------------------------------------------------------------------
1 |
2 |
8 |
11 |
16 |
21 |
26 |
31 |
36 |
41 |
46 |
51 |
56 |
61 |
66 |
71 |
76 |
81 |
86 |
91 |
96 |
101 |
106 |
111 |
116 |
121 |
126 |
131 |
136 |
141 |
146 |
151 |
156 |
161 |
166 |
171 |
172 |
--------------------------------------------------------------------------------
/gradlew:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env sh
2 |
3 | ##############################################################################
4 | ##
5 | ## Gradle start up script for UN*X
6 | ##
7 | ##############################################################################
8 |
9 | # Attempt to set APP_HOME
10 | # Resolve links: $0 may be a link
11 | PRG="$0"
12 | # Need this for relative symlinks.
13 | while [ -h "$PRG" ] ; do
14 | ls=`ls -ld "$PRG"`
15 | link=`expr "$ls" : '.*-> \(.*\)$'`
16 | if expr "$link" : '/.*' > /dev/null; then
17 | PRG="$link"
18 | else
19 | PRG=`dirname "$PRG"`"/$link"
20 | fi
21 | done
22 | SAVED="`pwd`"
23 | cd "`dirname \"$PRG\"`/" >/dev/null
24 | APP_HOME="`pwd -P`"
25 | cd "$SAVED" >/dev/null
26 |
27 | APP_NAME="Gradle"
28 | APP_BASE_NAME=`basename "$0"`
29 |
30 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
31 | DEFAULT_JVM_OPTS=""
32 |
33 | # Use the maximum available, or set MAX_FD != -1 to use that value.
34 | MAX_FD="maximum"
35 |
36 | warn () {
37 | echo "$*"
38 | }
39 |
40 | die () {
41 | echo
42 | echo "$*"
43 | echo
44 | exit 1
45 | }
46 |
47 | # OS specific support (must be 'true' or 'false').
48 | cygwin=false
49 | msys=false
50 | darwin=false
51 | nonstop=false
52 | case "`uname`" in
53 | CYGWIN* )
54 | cygwin=true
55 | ;;
56 | Darwin* )
57 | darwin=true
58 | ;;
59 | MINGW* )
60 | msys=true
61 | ;;
62 | NONSTOP* )
63 | nonstop=true
64 | ;;
65 | esac
66 |
67 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
68 |
69 | # Determine the Java command to use to start the JVM.
70 | if [ -n "$JAVA_HOME" ] ; then
71 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
72 | # IBM's JDK on AIX uses strange locations for the executables
73 | JAVACMD="$JAVA_HOME/jre/sh/java"
74 | else
75 | JAVACMD="$JAVA_HOME/bin/java"
76 | fi
77 | if [ ! -x "$JAVACMD" ] ; then
78 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
79 |
80 | Please set the JAVA_HOME variable in your environment to match the
81 | location of your Java installation."
82 | fi
83 | else
84 | JAVACMD="java"
85 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
86 |
87 | Please set the JAVA_HOME variable in your environment to match the
88 | location of your Java installation."
89 | fi
90 |
91 | # Increase the maximum file descriptors if we can.
92 | if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
93 | MAX_FD_LIMIT=`ulimit -H -n`
94 | if [ $? -eq 0 ] ; then
95 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
96 | MAX_FD="$MAX_FD_LIMIT"
97 | fi
98 | ulimit -n $MAX_FD
99 | if [ $? -ne 0 ] ; then
100 | warn "Could not set maximum file descriptor limit: $MAX_FD"
101 | fi
102 | else
103 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
104 | fi
105 | fi
106 |
107 | # For Darwin, add options to specify how the application appears in the dock
108 | if $darwin; then
109 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
110 | fi
111 |
112 | # For Cygwin, switch paths to Windows format before running java
113 | if $cygwin ; then
114 | APP_HOME=`cygpath --path --mixed "$APP_HOME"`
115 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
116 | JAVACMD=`cygpath --unix "$JAVACMD"`
117 |
118 | # We build the pattern for arguments to be converted via cygpath
119 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
120 | SEP=""
121 | for dir in $ROOTDIRSRAW ; do
122 | ROOTDIRS="$ROOTDIRS$SEP$dir"
123 | SEP="|"
124 | done
125 | OURCYGPATTERN="(^($ROOTDIRS))"
126 | # Add a user-defined pattern to the cygpath arguments
127 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then
128 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
129 | fi
130 | # Now convert the arguments - kludge to limit ourselves to /bin/sh
131 | i=0
132 | for arg in "$@" ; do
133 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
134 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option
135 |
136 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
137 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
138 | else
139 | eval `echo args$i`="\"$arg\""
140 | fi
141 | i=$((i+1))
142 | done
143 | case $i in
144 | (0) set -- ;;
145 | (1) set -- "$args0" ;;
146 | (2) set -- "$args0" "$args1" ;;
147 | (3) set -- "$args0" "$args1" "$args2" ;;
148 | (4) set -- "$args0" "$args1" "$args2" "$args3" ;;
149 | (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
150 | (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
151 | (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
152 | (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
153 | (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
154 | esac
155 | fi
156 |
157 | # Escape application args
158 | save () {
159 | for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
160 | echo " "
161 | }
162 | APP_ARGS=$(save "$@")
163 |
164 | # Collect all arguments for the java command, following the shell quoting and substitution rules
165 | eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
166 |
167 | # by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
168 | if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
169 | cd "$(dirname "$0")"
170 | fi
171 |
172 | exec "$JAVACMD" "$@"
173 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | Apache License
2 | Version 2.0, January 2004
3 | http://www.apache.org/licenses/
4 |
5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6 |
7 | 1. Definitions.
8 |
9 | "License" shall mean the terms and conditions for use, reproduction,
10 | and distribution as defined by Sections 1 through 9 of this document.
11 |
12 | "Licensor" shall mean the copyright owner or entity authorized by
13 | the copyright owner that is granting the License.
14 |
15 | "Legal Entity" shall mean the union of the acting entity and all
16 | other entities that control, are controlled by, or are under common
17 | control with that entity. For the purposes of this definition,
18 | "control" means (i) the power, direct or indirect, to cause the
19 | direction or management of such entity, whether by contract or
20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
21 | outstanding shares, or (iii) beneficial ownership of such entity.
22 |
23 | "You" (or "Your") shall mean an individual or Legal Entity
24 | exercising permissions granted by this License.
25 |
26 | "Source" form shall mean the preferred form for making modifications,
27 | including but not limited to software source code, documentation
28 | source, and configuration files.
29 |
30 | "Object" form shall mean any form resulting from mechanical
31 | transformation or translation of a Source form, including but
32 | not limited to compiled object code, generated documentation,
33 | and conversions to other media types.
34 |
35 | "Work" shall mean the work of authorship, whether in Source or
36 | Object form, made available under the License, as indicated by a
37 | copyright notice that is included in or attached to the work
38 | (an example is provided in the Appendix below).
39 |
40 | "Derivative Works" shall mean any work, whether in Source or Object
41 | form, that is based on (or derived from) the Work and for which the
42 | editorial revisions, annotations, elaborations, or other modifications
43 | represent, as a whole, an original work of authorship. For the purposes
44 | of this License, Derivative Works shall not include works that remain
45 | separable from, or merely link (or bind by name) to the interfaces of,
46 | the Work and Derivative Works thereof.
47 |
48 | "Contribution" shall mean any work of authorship, including
49 | the original version of the Work and any modifications or additions
50 | to that Work or Derivative Works thereof, that is intentionally
51 | submitted to Licensor for inclusion in the Work by the copyright owner
52 | or by an individual or Legal Entity authorized to submit on behalf of
53 | the copyright owner. For the purposes of this definition, "submitted"
54 | means any form of electronic, verbal, or written communication sent
55 | to the Licensor or its representatives, including but not limited to
56 | communication on electronic mailing lists, source code control systems,
57 | and issue tracking systems that are managed by, or on behalf of, the
58 | Licensor for the purpose of discussing and improving the Work, but
59 | excluding communication that is conspicuously marked or otherwise
60 | designated in writing by the copyright owner as "Not a Contribution."
61 |
62 | "Contributor" shall mean Licensor and any individual or Legal Entity
63 | on behalf of whom a Contribution has been received by Licensor and
64 | subsequently incorporated within the Work.
65 |
66 | 2. Grant of Copyright License. Subject to the terms and conditions of
67 | this License, each Contributor hereby grants to You a perpetual,
68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69 | copyright license to reproduce, prepare Derivative Works of,
70 | publicly display, publicly perform, sublicense, and distribute the
71 | Work and such Derivative Works in Source or Object form.
72 |
73 | 3. Grant of Patent License. Subject to the terms and conditions of
74 | this License, each Contributor hereby grants to You a perpetual,
75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76 | (except as stated in this section) patent license to make, have made,
77 | use, offer to sell, sell, import, and otherwise transfer the Work,
78 | where such license applies only to those patent claims licensable
79 | by such Contributor that are necessarily infringed by their
80 | Contribution(s) alone or by combination of their Contribution(s)
81 | with the Work to which such Contribution(s) was submitted. If You
82 | institute patent litigation against any entity (including a
83 | cross-claim or counterclaim in a lawsuit) alleging that the Work
84 | or a Contribution incorporated within the Work constitutes direct
85 | or contributory patent infringement, then any patent licenses
86 | granted to You under this License for that Work shall terminate
87 | as of the date such litigation is filed.
88 |
89 | 4. Redistribution. You may reproduce and distribute copies of the
90 | Work or Derivative Works thereof in any medium, with or without
91 | modifications, and in Source or Object form, provided that You
92 | meet the following conditions:
93 |
94 | (a) You must give any other recipients of the Work or
95 | Derivative Works a copy of this License; and
96 |
97 | (b) You must cause any modified files to carry prominent notices
98 | stating that You changed the files; and
99 |
100 | (c) You must retain, in the Source form of any Derivative Works
101 | that You distribute, all copyright, patent, trademark, and
102 | attribution notices from the Source form of the Work,
103 | excluding those notices that do not pertain to any part of
104 | the Derivative Works; and
105 |
106 | (d) If the Work includes a "NOTICE" text file as part of its
107 | distribution, then any Derivative Works that You distribute must
108 | include a readable copy of the attribution notices contained
109 | within such NOTICE file, excluding those notices that do not
110 | pertain to any part of the Derivative Works, in at least one
111 | of the following places: within a NOTICE text file distributed
112 | as part of the Derivative Works; within the Source form or
113 | documentation, if provided along with the Derivative Works; or,
114 | within a display generated by the Derivative Works, if and
115 | wherever such third-party notices normally appear. The contents
116 | of the NOTICE file are for informational purposes only and
117 | do not modify the License. You may add Your own attribution
118 | notices within Derivative Works that You distribute, alongside
119 | or as an addendum to the NOTICE text from the Work, provided
120 | that such additional attribution notices cannot be construed
121 | as modifying the License.
122 |
123 | You may add Your own copyright statement to Your modifications and
124 | may provide additional or different license terms and conditions
125 | for use, reproduction, or distribution of Your modifications, or
126 | for any such Derivative Works as a whole, provided Your use,
127 | reproduction, and distribution of the Work otherwise complies with
128 | the conditions stated in this License.
129 |
130 | 5. Submission of Contributions. Unless You explicitly state otherwise,
131 | any Contribution intentionally submitted for inclusion in the Work
132 | by You to the Licensor shall be under the terms and conditions of
133 | this License, without any additional terms or conditions.
134 | Notwithstanding the above, nothing herein shall supersede or modify
135 | the terms of any separate license agreement you may have executed
136 | with Licensor regarding such Contributions.
137 |
138 | 6. Trademarks. This License does not grant permission to use the trade
139 | names, trademarks, service marks, or product names of the Licensor,
140 | except as required for reasonable and customary use in describing the
141 | origin of the Work and reproducing the content of the NOTICE file.
142 |
143 | 7. Disclaimer of Warranty. Unless required by applicable law or
144 | agreed to in writing, Licensor provides the Work (and each
145 | Contributor provides its Contributions) on an "AS IS" BASIS,
146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 | implied, including, without limitation, any warranties or conditions
148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 | PARTICULAR PURPOSE. You are solely responsible for determining the
150 | appropriateness of using or redistributing the Work and assume any
151 | risks associated with Your exercise of permissions under this License.
152 |
153 | 8. Limitation of Liability. In no event and under no legal theory,
154 | whether in tort (including negligence), contract, or otherwise,
155 | unless required by applicable law (such as deliberate and grossly
156 | negligent acts) or agreed to in writing, shall any Contributor be
157 | liable to You for damages, including any direct, indirect, special,
158 | incidental, or consequential damages of any character arising as a
159 | result of this License or out of the use or inability to use the
160 | Work (including but not limited to damages for loss of goodwill,
161 | work stoppage, computer failure or malfunction, or any and all
162 | other commercial damages or losses), even if such Contributor
163 | has been advised of the possibility of such damages.
164 |
165 | 9. Accepting Warranty or Additional Liability. While redistributing
166 | the Work or Derivative Works thereof, You may choose to offer,
167 | and charge a fee for, acceptance of support, warranty, indemnity,
168 | or other liability obligations and/or rights consistent with this
169 | License. However, in accepting such obligations, You may act only
170 | on Your own behalf and on Your sole responsibility, not on behalf
171 | of any other Contributor, and only if You agree to indemnify,
172 | defend, and hold each Contributor harmless for any liability
173 | incurred by, or claims asserted against, such Contributor by reason
174 | of your accepting any such warranty or additional liability.
175 |
176 | END OF TERMS AND CONDITIONS
177 |
178 | APPENDIX: How to apply the Apache License to your work.
179 |
180 | To apply the Apache License to your work, attach the following
181 | boilerplate notice, with the fields enclosed by brackets "[]"
182 | replaced with your own identifying information. (Don't include
183 | the brackets!) The text should be enclosed in the appropriate
184 | comment syntax for the file format. We also recommend that a
185 | file or class name and description of purpose be included on the
186 | same "printed page" as the copyright notice for easier
187 | identification within third-party archives.
188 |
189 | Copyright [yyyy] [name of copyright owner]
190 |
191 | Licensed under the Apache License, Version 2.0 (the "License");
192 | you may not use this file except in compliance with the License.
193 | You may obtain a copy of the License at
194 |
195 | http://www.apache.org/licenses/LICENSE-2.0
196 |
197 | Unless required by applicable law or agreed to in writing, software
198 | distributed under the License is distributed on an "AS IS" BASIS,
199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 | See the License for the specific language governing permissions and
201 | limitations under the License.
202 |
--------------------------------------------------------------------------------