Various code style fixes and styles.xml improvements

Author: melihaksoy

README.md

@@ -1,12 +1,12 @@
-# Rocket Science
+# Android-Kotlin-Modulerized-CleanArchitecture
 
 [![Actions](https://github.com/melihaksoy/Android-Kotlin-Modulerized-CleanArchitecture/workflows/Android%20CI/badge.svg)](https://github.com/melihaksoy/Android-Kotlin-Modulerized-CleanArchitecture/actions) [![CircleCI](https://circleci.com/gh/melihaksoy/Android-Kotlin-Modulerized-CleanArchitecture/tree/master.svg?style=svg)](https://circleci.com/gh/melihaksoy/Android-Kotlin-Modulerized-CleanArchitecture/tree/master) [![codebeat badge](https://codebeat.co/badges/542fb08a-b3cc-4ff8-b1bb-35a66932f12f)](https://codebeat.co/projects/github-com-melihaksoy-rocketscience-master) [![codecov](https://codecov.io/gh/melihaksoy/RocketScience/branch/master/graph/badge.svg?token=pXPKpV5dz6)](https://codecov.io/gh/melihaksoy/RocketScience) [![Awesome Kotlin Badge](https://kotlin.link/awesome-kotlin.svg)](https://github.com/KotlinBy/awesome-kotlin)
 
-RocketScience is a prototype application tries to serve an example for modularization & clean architecture in Android.
+This is a prototype application tries to serve an example for modularization & clean architecture in Android.
 
 While there are many blogs about good practices, it's hard to come by a complete example that merges these different popular topics & approaches.
 
-RocketScience takes popular approaches and libraries to create an example on how to actually bind these components with each other.
+This project takes popular approaches and libraries to create an example on how to actually bind these components with each other.
 
 I'll soon be writing small series about roadmap, challanges, alternatives and try - fails I've encountered during development in [Medium](https://medium.com/@aksoymelihcan).
 

app/build.gradle

@@ -4,7 +4,6 @@ apply plugin: 'kotlin-kapt'
 
 apply from: "$rootProject.projectDir/scripts/default_android_config.gradle"
 apply from: "$rootProject.projectDir/scripts/sources.gradle"
-apply from: "$rootProject.projectDir/scripts/flavors.gradle"
 
 android {
  defaultConfig {

core/build.gradle

@@ -4,7 +4,6 @@ apply plugin: 'kotlin-kapt'
 
 apply from: "$rootProject.projectDir/scripts/default_android_config.gradle"
 apply from: "$rootProject.projectDir/scripts/sources.gradle"
-apply from: "$rootProject.projectDir/scripts/flavors.gradle"
 
 android {
  dataBinding {

core/src/main/kotlin/com/melih/core/base/lifecycle/BaseDaggerFragment.kt

@@ -14,30 +14,30 @@ import javax.inject.Inject
  * Parent of fragments which has injections. Aim is to seperate [BaseFragment] functionality for fragments which
  * won't need any injection.
  *
- * Note that fragments that extends from [BaseDaggerFragment] should contribute android injector.
+ * Note that fragments that extends from [BaseDaggerFragment] should contribute their injector.
  *
  * This class provides [viewModelFactory] which serves as factory for view models
  * in the project. It's injected by map of view models that this app is serving. Check [ViewModelFactory]
  * to see how it works.
  */
 abstract class BaseDaggerFragment<T : ViewDataBinding> : BaseFragment<T>(), HasAndroidInjector {
 
- // region Properties
+ //region Properties
 
  @get:Inject
  internal var androidInjector: DispatchingAndroidInjector<Any>? = null
 
  @Inject
  lateinit var viewModelFactory: ViewModelFactory
- // endregion
+ //endregion
 
- // region Functions
+ //region Functions
 
  override fun onAttach(context: Context) {
  AndroidSupportInjection.inject(this)
  super.onAttach(context)
  }
 
  override fun androidInjector(): AndroidInjector<Any>? = androidInjector
- // endregion
+ //endregion
 }

core/src/main/kotlin/com/melih/core/base/lifecycle/BaseFragment.kt

@@ -20,12 +20,18 @@ import com.melih.repository.interactors.base.Reason
  */
 abstract class BaseFragment<T : ViewDataBinding> : Fragment() {
 
- // region Properties
+ //region Abstractions
+
+ @LayoutRes
+ abstract fun getLayoutId(): Int
+ //endregion
+
+ //region Properties
 
  protected lateinit var binding: T
- // endregion
+ //endregion
 
- // region Functions
+ //region Functions
 
  override fun onCreateView(
  inflater: LayoutInflater,
@@ -46,8 +52,5 @@ abstract class BaseFragment<T : ViewDataBinding> : Fragment() {
  block()
  }.show()
  }
-
- @LayoutRes
- abstract fun getLayoutId(): Int
- // endregion
+ //endregion
 }

core/src/main/kotlin/com/melih/core/base/paging/BasePagingDataSource.kt

@@ -37,12 +37,12 @@ const val INITIAL_PAGE = 0
 @UseExperimental(ExperimentalCoroutinesApi::class)
 abstract class BasePagingDataSource<T> : PageKeyedDataSource<Int, T>() {
 
- // region Abstractions
+ //region Abstractions
 
  abstract fun loadDataForPage(page: Int): Flow<Result<List<T>>> // Load next page(s)
- // endregion
+ //endregion
 
- // region Properties
+ //region Properties
 
  private val _stateData = MutableLiveData<State>()
  private val _reasonData = MutableLiveData<Reason>()
@@ -59,9 +59,9 @@ abstract class BasePagingDataSource<T> : PageKeyedDataSource<Int, T>() {
  */
  val reasonData: LiveData<Reason>
  get() = _reasonData
- // endregion
+ //endregion
 
- // region Functions
+ //region Functions
 
  override fun loadInitial(params: LoadInitialParams<Int>, callback: LoadInitialCallback<Int, T>) {
  // Looping through channel as we'll receive any state, error or data here
@@ -136,5 +136,5 @@ abstract class BasePagingDataSource<T> : PageKeyedDataSource<Int, T>() {
  coroutineScope.cancel()
  super.invalidate()
  }
- // endregion
+ //endregion
 }

core/src/main/kotlin/com/melih/core/base/paging/BasePagingFactory.kt

@@ -16,20 +16,20 @@ import androidx.paging.DataSource
  */
 abstract class BasePagingFactory<T> : DataSource.Factory<Int, T>() {
 
- // region Abstractions
+ //region Abstractions
 
  abstract fun createSource(): BasePagingDataSource<T>
- // endregion
+ //endregion
 
- // region Properties
+ //region Properties
 
  private val _currentSource = MutableLiveData<BasePagingDataSource<T>>()
 
  val currentSource: LiveData<BasePagingDataSource<T>>
  get() = _currentSource
- // endregion
+ //endregion
 
- // region Functions
+ //region Functions
 
  override fun create(): DataSource<Int, T> = createSource().apply { _currentSource.postValue(this) }
 
@@ -38,5 +38,5 @@ abstract class BasePagingFactory<T> : DataSource.Factory<Int, T>() {
  * by calling [BasePagingDataSource.invalidate]
  */
  fun invalidateDataSource() = currentSource.value?.invalidate()
- // endregion
+ //endregion
 }

core/src/main/kotlin/com/melih/core/base/recycler/BasePagingListAdapter.kt

@@ -15,6 +15,8 @@ abstract class BasePagingListAdapter<T>(
  private val clickListener: (T) -> Unit
 ) : PagedListAdapter<T, BaseViewHolder<T>>(callback) {
 
+ //region Abstractions
+
  /**
  * This method will be called to create view holder to obfuscate layout inflation creation / process
  *
@@ -27,6 +29,9 @@ abstract class BasePagingListAdapter<T>(
  parent: ViewGroup,
  viewType: Int
  ): BaseViewHolder<T>
+ //endregion
+
+ //region Functions
 
  /**
  * [createViewHolder] will provide holders, no need to override this
@@ -51,18 +56,22 @@ abstract class BasePagingListAdapter<T>(
  holder.bind(item)
  }
  }
+ //endregion
 }
 
 /**
  * Base view holder takes view data binding
  */
 abstract class BaseViewHolder<T>(binding: ViewDataBinding) : RecyclerView.ViewHolder(binding.root) {
 
+ //region Functions
+
  /**
  * Items are delivered to [bind] via [BaseListAdapter.onBindViewHolder]
  *
  * @param item entity
  * @param position position from adapter
  */
  abstract fun bind(item: T)
+ //endregion
 }

core/src/main/kotlin/com/melih/core/base/viewmodel/BasePagingViewModel.kt

@@ -1,7 +1,7 @@
 package com.melih.core.base.viewmodel
 
 import androidx.lifecycle.LiveData
-import androidx.lifecycle.Transformations
+import androidx.lifecycle.Transformations.switchMap
 import androidx.lifecycle.ViewModel
 import androidx.paging.PagedList
 import androidx.paging.toLiveData
@@ -20,19 +20,19 @@ import com.melih.repository.interactors.base.State
  */
 abstract class BasePagingViewModel<T> : ViewModel() {
 
- // region Abstractions
+ //region Abstractions
 
  abstract val factory: BasePagingFactory<T>
  abstract val config: PagedList.Config
- // endregion
+ //endregion
 
- // region Properties
+ //region Properties
 
  /**
  * Observe [stateData] to get notified of state of data
  */
  val stateData: LiveData<State> by lazy {
- Transformations.switchMap(factory.currentSource) {
+ switchMap(factory.currentSource) {
  it.stateData
  }
  }
@@ -41,7 +41,7 @@ abstract class BasePagingViewModel<T> : ViewModel() {
  * Observe [errorData] to get notified if an error occurs
  */
  val errorData: LiveData<Reason> by lazy {
- Transformations.switchMap(factory.currentSource) {
+ switchMap(factory.currentSource) {
  it.reasonData
  }
  }
@@ -52,9 +52,9 @@ abstract class BasePagingViewModel<T> : ViewModel() {
  val pagedList: LiveData<PagedList<T>> by lazy {
  factory.toLiveData(config)
  }
- // endregion
+ //endregion
 
- // region Functions
+ //region Functions
 
  fun refresh() {
  factory.currentSource.value?.invalidate()
@@ -66,5 +66,5 @@ abstract class BasePagingViewModel<T> : ViewModel() {
  fun retry() {
  factory.currentSource.value?.invalidate()
  }
- // endregion
+ //endregion
 }

core/src/main/kotlin/com/melih/core/base/viewmodel/BaseViewModel.kt

@@ -15,18 +15,18 @@ import kotlinx.coroutines.launch
  */
 abstract class BaseViewModel<T> : ViewModel() {
 
- // region Abstractions
+ //region Abstractions
 
  abstract suspend fun loadData()
- // endregion
+ //endregion
 
  init {
  viewModelScope.launch {
  loadData()
  }
  }
 
- // region Properties
+ //region Properties
 
  private val _successData = MutableLiveData<T>()
  private val _stateData = MutableLiveData<State>()
@@ -49,9 +49,9 @@ abstract class BaseViewModel<T> : ViewModel() {
  */
  val errorData: LiveData<Reason>
  get() = _errorData
- // endregion
+ //endregion
 
- // region Functions
+ //region Functions
 
  /**
  * Default success handler which assigns given [data] to [successData]
@@ -97,5 +97,5 @@ abstract class BaseViewModel<T> : ViewModel() {
  loadData()
  }
  }
- // endregion
+ //endregion
 }