Merge pull request #1 from patjackson52/feature/database

Feature/database

Author: patjackson52

.gitignore

@@ -5,7 +5,6 @@
 /.idea/modules.xml
 /.idea/workspace.xml
 /.idea
-/iOS/NameGame/.idea/
 .DS_Store
 /build
 /common/build

README.md

@@ -1,18 +1,14 @@
-# Open Library
+# Open Library Sample Project
 
-__Android Build & Tests__
 
 
-[![CircleCI](https://circleci.com/gh/patjackson52/NameGameKotlinMpp.svg?style=svg)](https://circleci.com/gh/patjackson52/NameGameKotlinMpp)
-
-__iOS Build & Tests____
-
-[![Bitrise](https://app.bitrise.io/app/3eaf4fa6c0750504/status.svg?token=N7jdGFn6dvfLcuKZaBMW1g)](https://app.bitrise.io/app/3eaf4fa6c0750504#/builds)
-
-A Kotlin multiplatform (Android/iOS) Library.   The app utilizes the following:
+A Kotlin multiplatform (Android/iOS) Library app.   The app utilizes the following:
  * [Ktor](https://ktor.io/clients/http-client.html) for networking
  * [Kotlinx Serialization](https://github.com/Kotlin/kotlinx.serialization)
  * [Multiplatform Settings](https://github.com/russhwolf/multiplatform-settings)
+ * [SqlDelight](https://github.com/square/sqldelight)
+ * [ReduxKotlin](https://reduxkotlin.org)
+ 
 
 
 ## Android
@@ -24,21 +20,21 @@ or opened and ran in Android Studio
 
 
 ## iOS
-The iOS workspace in `/iOS/NameGame` can be open and ran from xCode or AppCode.  A run script has been added to the build phase that will compile the common code into a framework which can be used for the project.
+iOS can be implemented quickly now that code is in a common module.  
 
 
 ## Architecture
 
-A `GameEngine` object holds the state of the app in a redux store and provides a methods for views (fragments/UIViewControllers) to "attach".  The `GameEngine` is initialized in the Application class on Android, and the AppDelegate on iOS.  Because this `GameEngine` and the store is created at the application scope, the application state survives between ViewControllers/Fragments and rotation.  Each view must attach/detach from the GameEngine when it is visible.  `GameEngine.attachView(view)` returns the appropriate presenter for the view.  
+A `LibraryApp` object holds the state of the app in a redux store and provides a methods for views (fragments/UIViewControllers) to "attach".  The `LibraryApp` is initialized in the Application class on Android, and the AppDelegate on iOS.  Because this `LibraryApp` and the store is created at the application scope, the application state survives between ViewControllers/Fragments and rotation.  Each view must attach/detach from the GameEngine when it is visible.  `LibraryApp.attachView(view)` returns the appropriate presenter for the view.  
 
-`BaseNameGameViewFragment` & `BaseNameGameViewController` handle attaching/detaching the presenter at the appropriate lifecycle methods.  Each Fragment/ViewController extends from these.
+`BaseLibraryViewFragment` & `BaseLibraryViewController` handle attaching/detaching the presenter at the appropriate lifecycle methods.  Each Fragment/ViewController extends from these.
 
-An MVP arch is used with a redux store as the 'Model'.  This approach allows maximum reuse of code and a simple contract for the platforms to satisfy.  Presenters send `ViewStates` (simple data classes with fields needed to render UI) to the View interface.  The View implementation has a reference to the presenter, and calls methods on the presetner for user interaction.  This creates a unidirectional dataflow:
+An MVP arch is used with a redux store as the 'Model'.  This approach allows maximum reuse of code and a simple contract for the platforms to satisfy.  Presenters send `ViewStates` (simple data classes with fields needed to render UI) to the View interface.  The View implementation has a reference to the presenter, and calls methods on the presenter for user interaction.  This creates a unidirectional dataflow:
 
     User interaction -> Dispatch Action -> new state (reduce) -> view rendered by presenter
 
 ## "Dumb Views"
-Views in this arch are truely 'dumb' - they should contain nearly no logic.  They are responsible for rendering the view based on the `ViewState` given to them by the presenter. They are implemented for each platform and utilize native UI SDKs and libs for each platform.  Android uses Fragments and iOS uses UIViewControllers.
+Views in this arch are truly 'dumb' - they should contain nearly no logic.  They are responsible for rendering the view based on the `ViewState` given to them by the presenter. They are implemented for each platform and utilize native UI SDKs and libs for each platform.  Android uses Fragments and iOS uses UIViewControllers.
 
 ## Presenters
 
@@ -52,9 +48,10 @@ Presenters give a layer of control between subscribing to the new state and the
 ![arch diagram](https://storage.googleapis.com/treestorage/Kotlin%20MPP%20Demo%20Arch.png)
 
 ## Async Actions
-In redux world there are many ways to handle creation of async actions.  `Thunks` have been used in this app.  `NetworkThunks`  both use coroutines to launch concurrent operations that dispatch actions.
+In the redux world there are many ways to handle creation of async actions.  `Thunks` have been used in this app.  `NetworkThunks`  both use coroutines to launch concurrent operations that dispatch actions.
 
 ## Navigation
-In this app, Navigation is considered a side effect of the AppState.  The `NavigationMiddleware` handles changing screens based on dispatched actions.  The `NavigationMiddleware` takes an implementation of `Navigator` which is implemeneted for each platform.
-
+In this app, Navigation is considered a side effect of the AppState.  The `NavigationMiddleware` handles changing screens based on dispatched actions.  The `NavigationMiddleware` takes an implementation of `Navigator` which is implemented for each platform.
 
+#Tests
+Unforntunately ran out of time and do not have tests.  Unit tests can be written in the common module and ran in JVM and native.  Reducers are very simple to tests and quick to run.

android/build.gradle

@@ -73,6 +73,8 @@ dependencies {
     implementation project(':common')
     implementation 'nl.dionsegijn:konfetti:1.1.2'
     implementation "com.russhwolf:multiplatform-settings:$multiplatformSettingsVersion"
+    implementation "com.squareup.sqldelight:android-driver:$sqldelightVersion"
+
 
     kapt 'com.github.bumptech.glide:compiler:4.8.0'
     testImplementation 'junit:junit:4.12'

android/google-services.json

@@ -11,18 +11,18 @@
         android:label="@string/app_name"
         android:roundIcon="@mipmap/ic_launcher_round"
         android:supportsRtl="true"
-        android:theme="@style/NameGameAppTheme">
+        android:theme="@style/LibraryAppTheme">
         <activity
             android:name=".MainActivity"
             android:label="@string/app_name"
-            android:screenOrientation="portrait"
-            android:theme="@style/NameGameAppTheme">
+            android:theme="@style/LibraryAppTheme">
             <intent-filter>
                 <action android:name="android.intent.action.MAIN" />
 
                 <category android:name="android.intent.category.LAUNCHER" />
             </intent-filter>
         </activity>
+        <activity android:name=".DetailsActivity"/>
     </application>
 
 </manifest>

android/src/androidTest/java/io/jackson/instacopy/ExampleInstrumentedTest.kt

@@ -2,6 +2,7 @@ package com.jackson.openlibrary
 
 import android.app.Activity
 import android.app.Application
+import android.content.Intent
 import android.os.Bundle
 import androidx.appcompat.app.AppCompatActivity
 import androidx.navigation.findNavController
@@ -26,11 +27,11 @@ class AndroidNavigator : Navigator, Application.ActivityLifecycleCallbacks {
         if (currentActivity == null) {
             cachedNavigationScreen = screen
         } else {
-            val navController = currentActivity!!.findNavController(R.id.nav_host_fragment)
+//            val navController = currentActivity!!.findNavController(R.id.nav_host_fragment)
             when (screen) {
-                Screen.QUESTION -> navController.navigate(R.id.action_startScreen_to_questionScreen)
-                Screen.GAME_COMPLETE -> navController.navigate(R.id.action_questionScreen_to_resultsFragment)
-                Screen.START -> navController.navigate(R.id.startScreen)
+//                Screen.QUESTION -> navController.navigate(R.id.action_startScreen_to_questionScreen)
+//                Screen.GAME_COMPLETE -> navController.navigate(R.id.action_questionScreen_to_resultsFragment)
+                Screen.BOOK_DETAILS -> currentActivity?.startActivity(Intent(currentActivity, DetailsActivity::class.java))
 //                Screen.START -> navController.navigate(R.id.action_resultsFragment_to_startScreen)
                 else -> throw IllegalArgumentException("Screen $screen is not handled in AndroidNavigator")
             }

android/src/main/AndroidManifest.xml

@@ -0,0 +1,25 @@
+package com.jackson.openlibrary
+
+import android.os.Bundle
+import androidx.appcompat.app.AppCompatActivity
+
+class DetailsActivity : AppCompatActivity() {
+
+    interface IOnBackPressed {
+        fun onBackPressed(): Boolean
+    }
+
+    override fun onCreate(savedInstanceState: Bundle?) {
+        super.onCreate(savedInstanceState)
+        setContentView(R.layout.activity_details)
+    }
+
+    override fun onBackPressed() {
+        val navHostFragment =
+                this.supportFragmentManager.findFragmentById(R.id.nav_host_fragment)
+        val currentFragment = navHostFragment?.childFragmentManager?.fragments?.get(0)
+        if (currentFragment is IOnBackPressed)
+            (currentFragment as IOnBackPressed).onBackPressed()
+        super.onBackPressed()
+    }
+}

android/src/main/java/com/jackson/openlibrary/AndroidNavigator.kt

@@ -2,42 +2,59 @@ package com.jackson.openlibrary
 
 import android.os.Bundle
 import android.os.Handler
+import android.view.MenuItem
 import android.view.MotionEvent
 import android.view.View
 import android.view.ViewConfiguration
 import androidx.appcompat.app.AppCompatActivity
+import androidx.fragment.app.Fragment
 import com.bumptech.glide.annotation.GlideModule
 import com.bumptech.glide.module.AppGlideModule
+import com.jackson.openlibrary.store.CompletedFragment
+import com.jackson.openlibrary.store.SearchFragment
+import com.jackson.openlibrary.store.ToReadFragment
 import com.willowtreeapps.hyperion.core.Hyperion
-import kotlinx.android.synthetic.main.app_bar_main.*
 import kotlinx.android.synthetic.main.activity_main.*
+import java.lang.IllegalArgumentException
 
 
 @GlideModule
 class MyAppGlideModule : AppGlideModule()
 
 class MainActivity : AppCompatActivity() {
 
-    companion object {
-        const val RECORD_REQUEST_CODE = 52
-    }
-
     interface IOnBackPressed {
         fun onBackPressed(): Boolean
     }
 
     override fun onCreate(savedInstanceState: Bundle?) {
         super.onCreate(savedInstanceState)
-        window.decorView.systemUiVisibility = View.SYSTEM_UI_FLAG_LAYOUT_FULLSCREEN.or(View.SYSTEM_UI_FLAG_LAYOUT_STABLE)
         setContentView(R.layout.activity_main)
-        scrimLayout.setOnInsetsCallback {
-            rootContent.setPadding(0, -it.top, 0, 0)
+        btmNavigation.setOnNavigationItemSelectedListener(::handleBtmNavTap)
+        btmNavigation.selectedItemId = R.id.toRead
+    }
+
+    private fun handleBtmNavTap(it: MenuItem): Boolean {
+        val fragment: Fragment = when (it.itemId) {
+            R.id.toRead -> {
+                supportFragmentManager.findFragmentByTag(ToReadFragment::class.java.name) ?: ToReadFragment()
+            }
+            R.id.completed -> {
+                supportFragmentManager.findFragmentByTag(CompletedFragment::class.java.name) ?: CompletedFragment()
+            }
+            R.id.search -> {
+                supportFragmentManager.findFragmentByTag(SearchFragment::class.java.name) ?: SearchFragment()
+            }
+            else -> throw IllegalArgumentException("Unhandled itemId in BottomNav $it")
         }
-        drawer_layout.setOnTouchListener(tripleTapDetector)
 
+        val fragTransaction = supportFragmentManager.beginTransaction()
+        fragTransaction.replace(R.id.nav_host_fragment, fragment, fragment::class.java.name)
+        fragTransaction.commit()
+
+        return true
     }
 
-//    override fun onSupportNavigateUp(): Boolean = Navigation.findNavController(this, R.id.nav_host_fragment).navigateUp()
 
     override fun onBackPressed() {
         val navHostFragment =

android/src/main/java/com/jackson/openlibrary/DetailsActivity.kt

@@ -3,34 +3,54 @@ package com.jackson.openlibrary
 import android.app.Activity
 import android.app.Application
 import android.os.Bundle
+import androidx.sqlite.db.SupportSQLiteDatabase
+import androidx.sqlite.db.SupportSQLiteOpenHelper
+import androidx.sqlite.db.framework.FrameworkSQLiteOpenHelperFactory
 import com.google.firebase.FirebaseApp
-import com.willowtreeapps.common.GameEngine
+import com.squareup.sqldelight.android.AndroidSqliteDriver
+import com.willowtree.common.LibraryDatabase
+import com.willowtreeapps.common.LibraryApp
 import com.willowtreeapps.common.Logger
 import kotlinx.coroutines.Dispatchers
 
 class OpenLibraryApp : Application() {
 
-    lateinit var gameEngine: GameEngine
+    lateinit var libraryApp: LibraryApp
 
     override fun onCreate() {
         super.onCreate()
         FirebaseApp.initializeApp(this)
         instance = this
-        val navigator = AndroidNavigator()
-        gameEngine = GameEngine(navigator, this, Dispatchers.IO, Dispatchers.Main)
+        val config = SupportSQLiteOpenHelper.Configuration.builder(this)
+                .name("database.db")
+                .callback(object : SupportSQLiteOpenHelper.Callback(1) {
+                    override fun onCreate(db: SupportSQLiteDatabase) {
+                        val driver = AndroidSqliteDriver(db)
+                        LibraryDatabase.Schema.create(driver)
+                    }
+
+                    override fun onUpgrade(db: SupportSQLiteDatabase?, oldVersion: Int, newVersion: Int) {
+                    }
+
+                })
+                .build()
 
+        val sqlHelper = FrameworkSQLiteOpenHelperFactory().create(config)
+
+        val navigator = AndroidNavigator()
+        libraryApp = LibraryApp(navigator, Dispatchers.IO, Dispatchers.Main, AndroidSqliteDriver(sqlHelper))
         registerActivityLifecycleCallbacks(navigator)
         registerActivityLifecycleCallbacks(LifeCycleLogger)
     }
 
     companion object {
         lateinit var instance: OpenLibraryApp
 
-        fun gameEngine() = instance.gameEngine
+        fun gameEngine() = instance.libraryApp
     }
 }
 
-object LifeCycleLogger: Application.ActivityLifecycleCallbacks {
+object LifeCycleLogger : Application.ActivityLifecycleCallbacks {
     override fun onActivityPaused(activity: Activity?) {
         Logger.d(activity?.javaClass?.simpleName + ": onActivityPaused")
     }