Merge pull request #14 from felipecastilhos/refact/concerns_division

Melhorando a divisão de responsabilidades

README.md

@@ -40,7 +40,8 @@ Libraries Used
 * [Espresso](https://developer.android.com/training/testing/espresso/) - UI test
 * [Junit](https://junit.org/junit4/) - unit tests
 * [Truth](https://github.com/google/truth) - Makes your test assertions and failure messages more readable
+* [Mockk](https://mockk.io/) - Mocking library for kotlin
 * [Detekt](https://github.com/detekt/detekt) - a static code analysis tool for the Kotlin programming language
 * [KTLint](https://github.com/pinterest/ktlint) - Kotlin linter in spirit of feross/standard (JavaScript) and gofmt (Go).
 * [Gradle Kotlin Plugin](https://kotlinlang.org/docs/gradle.html) - Gradle scripts in Kotlin
-* [Timber](https://github.com/JakeWharton/timber) - Small log library based on Android SDK log
+* [Timber](https://github.com/JakeWharton/timber) - Small log library based on Android SDK log

app/build.gradle.kts

@@ -62,7 +62,7 @@ android {
 
 dependencies {
     // Common libraries
-    jetpackUtilLibraries()
+    jetpackCoreLibraries()
     jetpackKotlinExtensionsLibraries()
     jetpackAndroidLifecycleLibraries()
 
@@ -83,4 +83,5 @@ dependencies {
     // Add Tests
     unitTestsLibraries()
     instrumentationTestsLibraries()
+    mockLibraries()
 }

app/src/main/AndroidManifest.xml

@@ -13,7 +13,7 @@
         android:supportsRtl="true"
         android:theme="@style/Theme.Pokedexandroid">
         <activity
-            android:name=".MainActivity"
+            android:name=".features.home.HomeActivity"
             android:exported="true"
             android:label="@string/app_name"
             android:theme="@style/Theme.Pokedexandroid.NoActionBar">

app/src/main/java/com/github/felipecastilhos/pokedexandroid/PokedexApplication.kt

@@ -1,9 +1,12 @@
 package com.github.felipecastilhos.pokedexandroid
 
 import android.app.Application
-import com.github.felipecastilhos.pokedexandroid.logs.LogHandler
+import com.github.felipecastilhos.pokedexandroid.commun.logs.LogHandler
 import dagger.hilt.android.HiltAndroidApp
 
+/**
+ * Create an application for the pokedex app to extends adding needed behaviours
+ */
 @HiltAndroidApp
 class PokedexApplication : Application() {
     override fun onCreate() {

app/src/main/java/com/github/felipecastilhos/pokedexandroid/coroutines/AppDispatchersProvider.kt → app/src/main/java/com/github/felipecastilhos/pokedexandroid/commun/coroutines/AppDispatchersProvider.kt

@@ -1,4 +1,4 @@
-package com.github.felipecastilhos.pokedexandroid.coroutines
+package com.github.felipecastilhos.pokedexandroid.commun.coroutines
 
 import kotlinx.coroutines.CoroutineDispatcher
 import kotlinx.coroutines.Dispatchers

app/src/main/java/com/github/felipecastilhos/pokedexandroid/coroutines/DispatcherProvider.kt → app/src/main/java/com/github/felipecastilhos/pokedexandroid/commun/coroutines/DispatcherProvider.kt

@@ -1,4 +1,4 @@
-package com.github.felipecastilhos.pokedexandroid.coroutines
+package com.github.felipecastilhos.pokedexandroid.commun.coroutines
 
 import kotlinx.coroutines.CoroutineDispatcher
 

app/src/main/java/com/github/felipecastilhos/pokedexandroid/coroutines/ScopedContextDispatcher.kt → app/src/main/java/com/github/felipecastilhos/pokedexandroid/commun/coroutines/ScopedContextDispatcher.kt

@@ -1,4 +1,4 @@
-package com.github.felipecastilhos.pokedexandroid.coroutines
+package com.github.felipecastilhos.pokedexandroid.commun.coroutines
 
 import kotlinx.coroutines.CoroutineScope
 import kotlin.coroutines.CoroutineContext

app/src/main/java/com/github/felipecastilhos/pokedexandroid/logs/LogHandler.kt → app/src/main/java/com/github/felipecastilhos/pokedexandroid/commun/logs/LogHandler.kt

@@ -1,4 +1,4 @@
-package com.github.felipecastilhos.pokedexandroid.logs
+package com.github.felipecastilhos.pokedexandroid.commun.logs
 
 import com.github.felipecastilhos.pokedexandroid.BuildConfig
 import timber.log.Timber

app/src/main/java/com/github/felipecastilhos/pokedexandroid/network/NetworkModule.kt → app/src/main/java/com/github/felipecastilhos/pokedexandroid/commun/network/NetworkModule.kt

@@ -1,14 +1,12 @@
-package com.github.felipecastilhos.pokedexandroid.network
+package com.github.felipecastilhos.pokedexandroid.commun.network
 
 import com.apollographql.apollo.ApolloClient
-import com.github.felipecastilhos.pokedexandroid.Enviroment
-import com.github.felipecastilhos.pokedexandroid.PokedexApolloClient
+import com.github.felipecastilhos.pokedexandroid.datasource.remote.Enviroment
 import dagger.Module
 import dagger.Provides
 import dagger.hilt.InstallIn
 import dagger.hilt.components.SingletonComponent
 import okhttp3.OkHttpClient
-import okhttp3.logging.HttpLoggingInterceptor
 import javax.inject.Singleton
 
 /**
@@ -28,9 +26,7 @@ class NetworkModule {
      */
     @Provides
     @Singleton
-    fun provideOkHttpClient(): OkHttpClient = OkHttpClient.Builder()
-        .addInterceptor(PokedexApolloClient.buildLogInterceptor(HttpLoggingInterceptor.Level.BODY))
-        .build()
+    fun provideOkHttpClient(): OkHttpClient = PokedexOkHttpBuilder.buildOkHttp()
 
     /**
      * Provides an ApolloClient setup
@@ -40,8 +36,5 @@ class NetworkModule {
     @Provides
     @Singleton
     fun provideApolloClient(okHttpClient: OkHttpClient, apiUrl: String): ApolloClient =
-        ApolloClient.builder()
-            .serverUrl(apiUrl)
-            .okHttpClient(okHttpClient)
-            .build()
+        PokedexApolloBuilder.buildApollo(okHttpClient = okHttpClient, apiUrl = apiUrl)
 }

app/src/main/java/com/github/felipecastilhos/pokedexandroid/commun/network/PokedexApolloBuilder.kt

@@ -0,0 +1,20 @@
+package com.github.felipecastilhos.pokedexandroid.commun.network
+
+import com.apollographql.apollo.ApolloClient
+import okhttp3.OkHttpClient
+
+/**
+ * Application builder for [ApolloClient] the abstraction of GraphQl Client
+ */
+object PokedexApolloBuilder {
+    /**
+     * Builds an [ApolloClient]
+     * @param okHttpClient to be used on [ApolloClient] for making network requests
+     * @param apiUrl is the server url to be used on [ApolloClient]
+     */
+    fun buildApollo(okHttpClient: OkHttpClient, apiUrl: String): ApolloClient =
+        ApolloClient.builder()
+            .serverUrl(apiUrl)
+            .okHttpClient(okHttpClient)
+            .build()
+}

app/src/main/java/com/github/felipecastilhos/pokedexandroid/commun/network/PokedexOkHttpBuilder.kt

@@ -0,0 +1,23 @@
+package com.github.felipecastilhos.pokedexandroid.commun.network
+
+import com.github.felipecastilhos.pokedexandroid.commun.logs.LogHandler
+import okhttp3.OkHttpClient
+import okhttp3.logging.HttpLoggingInterceptor
+
+/**
+ *
+ */
+object PokedexOkHttpBuilder {
+    fun buildOkHttp(): OkHttpClient {
+        return OkHttpClient.Builder()
+            .addInterceptor(buildLogInterceptor(HttpLoggingInterceptor.Level.BODY))
+            .build()
+    }
+
+    private fun buildLogInterceptor(level: HttpLoggingInterceptor.Level): HttpLoggingInterceptor {
+        val logger = HttpLoggingInterceptor.Logger { message -> LogHandler.d(message) }
+        val logging = HttpLoggingInterceptor(logger)
+        logging.level = level
+        return logging
+    }
+}

app/src/main/java/com/github/felipecastilhos/pokedexandroid/ui/theme/Color.kt → app/src/main/java/com/github/felipecastilhos/pokedexandroid/commun/ui/theme/Color.kt

@@ -1,8 +1,8 @@
-package com.github.felipecastilhos.pokedexandroid.ui.theme
+package com.github.felipecastilhos.pokedexandroid.commun.ui.theme
 
 import androidx.compose.ui.graphics.Color
 
 val Purple200 = Color(0xFFBB86FC)
 val Purple500 = Color(0xFF6200EE)
 val Purple700 = Color(0xFF3700B3)
-val Teal200 = Color(0xFF03DAC5)
+val Teal200 = Color(0xFF03DAC5)

app/src/main/java/com/github/felipecastilhos/pokedexandroid/ui/theme/Shape.kt → app/src/main/java/com/github/felipecastilhos/pokedexandroid/commun/ui/theme/Shape.kt

@@ -1,4 +1,4 @@
-package com.github.felipecastilhos.pokedexandroid.ui.theme
+package com.github.felipecastilhos.pokedexandroid.commun.ui.theme
 
 import androidx.compose.foundation.shape.RoundedCornerShape
 import androidx.compose.material.Shapes
@@ -8,4 +8,4 @@ val Shapes = Shapes(
     small = RoundedCornerShape(4.dp),
     medium = RoundedCornerShape(4.dp),
     large = RoundedCornerShape(0.dp)
-)
+)

app/src/main/java/com/github/felipecastilhos/pokedexandroid/ui/theme/Theme.kt → app/src/main/java/com/github/felipecastilhos/pokedexandroid/commun/ui/theme/Theme.kt

@@ -1,4 +1,4 @@
-package com.github.felipecastilhos.pokedexandroid.ui.theme
+package com.github.felipecastilhos.pokedexandroid.commun.ui.theme
 
 import androidx.compose.foundation.isSystemInDarkTheme
 import androidx.compose.material.MaterialTheme
@@ -44,4 +44,4 @@ fun PokedexandroidTheme(
         shapes = Shapes,
         content = content
     )
-}
+}

app/src/main/java/com/github/felipecastilhos/pokedexandroid/ui/theme/Type.kt → app/src/main/java/com/github/felipecastilhos/pokedexandroid/commun/ui/theme/Type.kt

@@ -1,4 +1,4 @@
-package com.github.felipecastilhos.pokedexandroid.ui.theme
+package com.github.felipecastilhos.pokedexandroid.commun.ui.theme
 
 import androidx.compose.material.Typography
 import androidx.compose.ui.text.TextStyle
@@ -25,4 +25,4 @@ val Typography = Typography(
         fontSize = 12.sp
     )
     */
-)
+)

app/src/main/java/com/github/felipecastilhos/pokedexandroid/datasource/Resource.kt

@@ -0,0 +1,49 @@
+package com.github.felipecastilhos.pokedexandroid.datasource
+
+import com.github.felipecastilhos.pokedexandroid.datasource.remote.DataSourceException
+
+/**
+ * Resource is an abstraction for data fetch
+ */
+sealed class Resource<out T> {
+    /**
+     * Resource data fetch was successful
+     * @param data was the result of data fetch
+     */
+    data class Success<out T>(val data: T) : Resource<T>()
+
+    /**
+     * Resource data fetch didn't work
+     * @param exception was the error that occurred fetching data
+     */
+    data class Error(val exception: DataSourceException) : Resource<Nothing>()
+
+    /**
+     * Resource is loading, none result was returned yet.
+     */
+    object Loading : Resource<Nothing>()
+}
+
+/**
+ * Extension to handle resouce on success data fetch
+ */
+inline fun <T : Any> Resource<T>.onSuccess(action: (T) -> Unit): Resource<T> {
+    if (this is Resource.Success) action(data)
+    return this
+}
+
+/**
+ * Extension to handle resouce on error data fetch
+ */
+inline fun <T : Any> Resource<T>.onError(action: (DataSourceException) -> Unit): Resource<T> {
+    if (this is Resource.Error) action(exception)
+    return this
+}
+
+/**
+ * Extension to handle resouce when is loading
+ */
+inline fun <T : Any> Resource<T>.onLoading(action: () -> Unit): Resource<T> {
+    if (this is Resource.Loading) action()
+    return this
+}

app/src/main/java/com/github/felipecastilhos/pokedexandroid/datasource/remote/DataSourceException.kt

@@ -0,0 +1,23 @@
+package com.github.felipecastilhos.pokedexandroid.datasource.remote
+
+import com.apollographql.apollo.api.Error
+
+/**
+ * Data source exception
+ * @param messageResource message for the error
+ */
+sealed class DataSourceException(
+    val messageResource: Any?
+) : RuntimeException() {
+    /**
+     * Unexpected error
+     * @param messageResource resource for the message
+     */
+    class Unexpected(messageResource: Int) : DataSourceException(messageResource)
+
+    /**
+     * Server error
+     * @param error that occurred
+     */
+    class Server(error: Error?) : DataSourceException(error)
+}

app/src/main/java/com/github/felipecastilhos/pokedexandroid/datasource/remote/Enviroment.kt

@@ -0,0 +1,8 @@
+package com.github.felipecastilhos.pokedexandroid.datasource.remote
+
+/**
+ * Configurations of enviroments of the data sources
+ */
+sealed class Enviroment(val graphQlUrl: String) {
+    object Production : Enviroment("https://graphqlpokemon.favware.tech/")
+}

app/src/main/java/com/github/felipecastilhos/pokedexandroid/datasource/remote/RemoteDataSource.kt

@@ -0,0 +1,3 @@
+package com.github.felipecastilhos.pokedexandroid.datasource.remote
+
+interface RemoteDataSource

app/src/main/java/com/github/felipecastilhos/pokedexandroid/di/AppModule.kt

@@ -0,0 +1,20 @@
+package com.github.felipecastilhos.pokedexandroid.di
+
+import com.github.felipecastilhos.pokedexandroid.commun.coroutines.AppDispatchersProvider
+import com.github.felipecastilhos.pokedexandroid.commun.coroutines.DispatcherProvider
+import dagger.Module
+import dagger.Provides
+import dagger.hilt.InstallIn
+import dagger.hilt.components.SingletonComponent
+
+/**
+ * [AppModule] provides communs components for the architecture over the application
+ */
+@Module
+@InstallIn(SingletonComponent::class)
+class AppModule {
+    @Provides
+    fun providesDispatcherProvider(): DispatcherProvider {
+        return AppDispatchersProvider
+    }
+}

app/src/main/java/com/github/felipecastilhos/pokedexandroid/viewmodels/CoroutineViewModel.kt → app/src/main/java/com/github/felipecastilhos/pokedexandroid/domain/viewmodels/CoroutineViewModel.kt

@@ -1,9 +1,9 @@
-package com.github.felipecastilhos.pokedexandroid.viewmodels
+package com.github.felipecastilhos.pokedexandroid.domain.viewmodels
 
 import androidx.lifecycle.ViewModel
 import androidx.lifecycle.viewModelScope
-import com.github.felipecastilhos.pokedexandroid.coroutines.DispatcherProvider
-import com.github.felipecastilhos.pokedexandroid.coroutines.ScopedContextDispatcher
+import com.github.felipecastilhos.pokedexandroid.commun.coroutines.DispatcherProvider
+import com.github.felipecastilhos.pokedexandroid.commun.coroutines.ScopedContextDispatcher
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.CoroutineStart
 import kotlinx.coroutines.launch