Update comments

Author: davedavis

Readme.md

@@ -2,31 +2,13 @@
 An android app that lets you use Jira like a basic to-do app, keeping
 all your personal and work tasks in one interface.
 
-# API
-https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues/#api-rest-api-3-issue-issueidorkey-get
+# Sample Data to test app
+Name: Any
+Email: dave@davedavis.io
+Jira subdomain: davedavis
+Jira project ID: TODORA
+Jira API key: MpkWzHiXp3QdnrtdSZdqF38A
+Annex 2 - Supervisor Emails
 
-# API Token
-https://developer.atlassian.com/cloud/jira/platform/basic-auth-for-rest-apis/
-MpkWzHiXp3QdnrtdSZdqF38A
-
-# Sample API Queries
-
-curl -D- \
-   -u dave@davedavis.io:MpkWzHiXp3QdnrtdSZdqF38A \
-   -X GET \
-   -H "Content-Type: application/json" \
-   https://davedavis.atlassian.net/rest/api/2/issue/createmeta
-
-
-
-   curl -D- \
-   -u dave@davedavis.io:MpkWzHiXp3QdnrtdSZdqF38A \
-   -X GET \
-   -H "Content-Type: application/json" \
-   https://davedavis.atlassian.net/rest/api/2/search?jql=project="TODORA"
-
-
-# Sample API Response
-sampleresponse.json
 
 

app/src/main/java/io/davedavis/todora/model/ParcelableIssue.kt

@@ -7,27 +7,6 @@ import com.squareup.moshi.Json
 import com.squareup.moshi.JsonClass
 import kotlinx.android.parcel.Parcelize
 
-//@SuppressLint("ParcelCreator")
-//@Parcelize
-//@JsonClass(generateAdapter = true)
-//data class ParcelableIssue(
-//    @Json(name = "summary")
-//    val summary: String?,
-//    @Json(name = "description")
-//    val description: String?,
-//    @Json(name = "id")
-//    val id: String?,
-//    @Json(name = "key")
-//    val key: String?,
-//    @Json(name = "priority")
-//    val priority: String?,
-//    @Json(name = "timespent")
-//    val timespent: Long?,
-//    @Json(name = "self")
-//    val self: String?
-//
-//) : Parcelable
-
 
 @SuppressLint("ParcelCreator")
 @Parcelize

app/src/main/java/io/davedavis/todora/ui/create/CreateFragment.kt

@@ -20,17 +20,29 @@ import timber.log.Timber
 
 class CreateFragment : Fragment() {
 
-
+    /**
+     * Grab instances of our [CreateViewModel] and [viewModelFactory] so we can build the viewModel
+     * with a factory (we're not actually using it yet in this fragment.
+     */
     private lateinit var viewModel: CreateViewModel
     private lateinit var viewModelFactory: CreateViewModelFactory
 
+    /**
+     * Hide keyboard helper function that hides the keyboard when focus is lost on the edit text
+     * items. Prevents keyboard from staying on screen.
+     * @param view which the system removes input focus from.
+     */
     fun hideKeyboard(view: View) {
         view.apply {
             val imm = context.getSystemService(Context.INPUT_METHOD_SERVICE) as InputMethodManager
             imm.hideSoftInputFromWindow(view.windowToken, 0)
         }
     }
 
+    /**
+     * IInflates the fragment, databinds it,  sets its lifecycle owner to the OverviewFragment
+     * to enable Data Binding to observe LiveData (for state maintenance)
+     */
     override fun onCreateView(
         inflater: LayoutInflater, container: ViewGroup?,
         savedInstanceState: Bundle?

app/src/main/java/io/davedavis/todora/ui/create/CreateViewModel.kt

@@ -6,18 +6,21 @@ import androidx.lifecycle.MutableLiveData
 import androidx.lifecycle.ViewModel
 import androidx.lifecycle.viewModelScope
 import io.davedavis.todora.model.*
-import io.davedavis.todora.network.Auth
-import io.davedavis.todora.network.JiraApi
+import io.davedavis.todora.network.*
 import io.davedavis.todora.utils.SharedPreferencesManager
 import kotlinx.coroutines.launch
 import retrofit2.Response
 import timber.log.Timber
 
+/**
+ * ViewModel class that holds all the data and logic for the create issue flow.
+ */
 class CreateViewModel : ViewModel() {
 
+    // Response from the API as a string as it's only in English so can't be localized.
     var responseMessage: String = "No response yet"
 
-    // The internal MutableLiveData for the selected property
+    // The internal MutableLiveData for the selected issue
     private val _newIssue = MutableLiveData<NewIssue>()
     val newIssue: LiveData<NewIssue>
         get() = _newIssue
@@ -60,8 +63,11 @@ class CreateViewModel : ViewModel() {
 
 
     // Set up the edit fields on changed listeners (Bound in the XML)
-    // Thanks https://stackoverflow.com/questions/33798426/how-to-databind-to-ontextchanged-for-an-edittext-on-android
-    // ToDo: Move this to the Binding Adapter Class.
+
+    /**
+     * When the description is changed, set the livedata of [newSummary] to the updated value
+     * so when there's a lifecycle change, the user won't lose any input.
+     */
     fun onSummaryTextChange(newSummary: Editable?) {
         _newIssue.value?.fields?.summary = newSummary.toString()
         if (!_newIssue.value?.fields?.description?.content?.get(0)?.content?.get(0)?.actualDescriptionText.isNullOrEmpty()) {
@@ -70,6 +76,10 @@ class CreateViewModel : ViewModel() {
 
     }
 
+    /**
+     * When the description is changed, set the livedata of [newDescription] to the updated value
+     * so when there's a lifecycle change, the user won't lose any input.
+     */
     fun onDescriptionTextChange(newDescription: Editable?) {
         _newIssue.value?.fields?.description?.content?.get(0)?.content?.get(0)?.actualDescriptionText =
             newDescription.toString()
@@ -79,20 +89,28 @@ class CreateViewModel : ViewModel() {
 
     }
 
+    /**
+     * When the issue/to-do is updated, set the [priority] [MutableLiveData]
+     * @param updatedPriority to the updated one in the view.
+     */
     fun updatePriority(updatedPriority: Int) {
         _newIssue.value?.fields?.priority?.name =
             PriorityOptions.values()[updatedPriority].toString()
 
     }
 
-
+    /**
+     * Submits new issue to the [JiraApiService] by calling [newJiraIssue] through a coroutine.
+     * @param filter on the [JiraApiFilter]
+     * @param [newIssue] that goes along with the post request
+     * Returns a string response.
+     */
     fun submitNewJiraIssue() {
         Timber.i(">>> updateJiraIssue in ViewModel Called")
         viewModelScope.launch {
             _status.value = JiraAPIStatus.LOADING
             try {
                 Timber.i(">>> Trying ...")
-                Timber.i(newIssue.value.toString())
                 val response: Response<Unit> = JiraApi.retrofitService.newJiraIssue(
                     Auth.getAuthHeaders(),
                     newIssue.value

app/src/main/java/io/davedavis/todora/ui/create/CreateViewModelFactory.kt

@@ -3,7 +3,9 @@ package io.davedavis.todora.ui.create
 import androidx.lifecycle.ViewModel
 import androidx.lifecycle.ViewModelProvider
 
-
+/**
+ * This factory isn't actually doing anything custom yet. But it will in V2.
+ */
 class CreateViewModelFactory :
     ViewModelProvider.Factory {
     @Suppress("unchecked_cast")