Skip to content

Commit

Permalink
Fix part of #1587: Made some intent/bundle/saved/tags instance keys c…
Browse files Browse the repository at this point in the history
…onsistent. (#3350)

* renamed some keys consistent

* renamed some more keys consistent

* consistent-keys fixed PR issues

* consistent-keys added EOF
  • Loading branch information
ayush0402 committed Jun 28, 2021
1 parent 45e0bcb commit be570f4
Show file tree
Hide file tree
Showing 33 changed files with 128 additions and 115 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ import android.view.Menu
import org.oppia.android.R
import org.oppia.android.app.activity.InjectableAppCompatActivity
import org.oppia.android.app.administratorcontrols.appversion.AppVersionActivity
import org.oppia.android.app.drawer.KEY_NAVIGATION_PROFILE_ID
import org.oppia.android.app.drawer.NAVIGATION_PROFILE_ID_ARGUMENT_KEY
import org.oppia.android.app.settings.profile.ProfileListActivity
import javax.inject.Inject

const val SELECTED_CONTROLS_TITLE_SAVED_KEY =
"AdministratorControlsActivity.selected_controls_title"
const val LAST_LOADED_FRAGMENT_KEY = "LAST_LOADED_FRAGMENT_KEY"
const val LAST_LOADED_FRAGMENT_EXTRA_KEY = "AdministratorControlsActivity.last_loaded_fragment"
const val PROFILE_LIST_FRAGMENT = "PROFILE_LIST_FRAGMENT"
const val APP_VERSION_FRAGMENT = "APP_VERSION_FRAGMENT"

Expand All @@ -34,7 +34,7 @@ class AdministratorControlsActivity :
activityComponent.inject(this)
val extraControlsTitle = savedInstanceState?.getString(SELECTED_CONTROLS_TITLE_SAVED_KEY)
lastLoadedFragment = if (savedInstanceState != null) {
savedInstanceState.get(LAST_LOADED_FRAGMENT_KEY) as String
savedInstanceState.get(LAST_LOADED_FRAGMENT_EXTRA_KEY) as String
} else {
// TODO(#661): Change the default fragment in the right hand side to be EditAccount fragment in the case of multipane controls.
PROFILE_LIST_FRAGMENT
Expand All @@ -59,12 +59,12 @@ class AdministratorControlsActivity :
companion object {
fun createAdministratorControlsActivityIntent(context: Context, profileId: Int?): Intent {
val intent = Intent(context, AdministratorControlsActivity::class.java)
intent.putExtra(KEY_NAVIGATION_PROFILE_ID, profileId)
intent.putExtra(NAVIGATION_PROFILE_ID_ARGUMENT_KEY, profileId)
return intent
}

fun getIntentKey(): String {
return KEY_NAVIGATION_PROFILE_ID
return NAVIGATION_PROFILE_ID_ARGUMENT_KEY
}
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,6 @@ class AdministratorControlsActivityPresenter @Inject constructor(
if (titleTextView != null) {
outState.putString(SELECTED_CONTROLS_TITLE_SAVED_KEY, titleTextView.text.toString())
}
outState.putString(LAST_LOADED_FRAGMENT_KEY, lastLoadedFragment)
outState.putString(LAST_LOADED_FRAGMENT_EXTRA_KEY, lastLoadedFragment)
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@ class AdministratorControlsFragment : InjectableFragment() {
lateinit var administratorControlsFragmentPresenter: AdministratorControlsFragmentPresenter

companion object {
private const val IS_MULTIPANE_KEY = "IS_MULTIPANE_KEY"
private const val IS_MULTIPANE_ARGUMENT_KEY = "AdministratorControlsFragment.is_multipane"
fun newInstance(isMultipane: Boolean): AdministratorControlsFragment {
val args = Bundle()
args.putBoolean(IS_MULTIPANE_KEY, isMultipane)
args.putBoolean(IS_MULTIPANE_ARGUMENT_KEY, isMultipane)
val fragment = AdministratorControlsFragment()
fragment.arguments = args
return fragment
Expand All @@ -38,7 +38,7 @@ class AdministratorControlsFragment : InjectableFragment() {
checkNotNull(arguments) {
"Expected arguments to be passed to AdministratorControlsFragment"
}
val isMultipane = args.getBoolean(IS_MULTIPANE_KEY)
val isMultipane = args.getBoolean(IS_MULTIPANE_ARGUMENT_KEY)
return administratorControlsFragmentPresenter
.handleCreateView(inflater, container, isMultipane)
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import org.oppia.android.app.administratorcontrols.administratorcontrolsitemview
import org.oppia.android.app.administratorcontrols.administratorcontrolsitemviewmodel.AdministratorControlsGeneralViewModel
import org.oppia.android.app.administratorcontrols.administratorcontrolsitemviewmodel.AdministratorControlsItemViewModel
import org.oppia.android.app.administratorcontrols.administratorcontrolsitemviewmodel.AdministratorControlsProfileViewModel
import org.oppia.android.app.drawer.KEY_NAVIGATION_PROFILE_ID
import org.oppia.android.app.drawer.NAVIGATION_PROFILE_ID_ARGUMENT_KEY
import org.oppia.android.app.fragment.FragmentScope
import org.oppia.android.app.model.ProfileId
import org.oppia.android.app.recyclerview.BindableAdapter
Expand Down Expand Up @@ -52,7 +52,7 @@ class AdministratorControlsFragmentPresenter @Inject constructor(
/* attachToRoot= */ false
)

internalProfileId = activity.intent.getIntExtra(KEY_NAVIGATION_PROFILE_ID, -1)
internalProfileId = activity.intent.getIntExtra(NAVIGATION_PROFILE_ID_ARGUMENT_KEY, -1)
profileId = ProfileId.newBuilder().setInternalId(internalProfileId).build()
administratorControlsViewModel.setProfileId(profileId)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,8 @@ import org.oppia.android.util.data.DataProviders.Companion.toLiveData
import org.oppia.android.util.statusbar.StatusBarColor
import javax.inject.Inject

const val KEY_NAVIGATION_PROFILE_ID = "KEY_NAVIGATION_PROFILE_ID"
const val NAVIGATION_PROFILE_ID_ARGUMENT_KEY =
"NavigationDrawerFragmentPresenter.navigation_profile_id"
const val TAG_SWITCH_PROFILE_DIALOG = "SWITCH_PROFILE_DIALOG"

/** The presenter for [NavigationDrawerFragment]. */
Expand All @@ -67,7 +68,7 @@ class NavigationDrawerFragmentPresenter @Inject constructor(

fragment.setHasOptionsMenu(true)

internalProfileId = activity.intent.getIntExtra(KEY_NAVIGATION_PROFILE_ID, -1)
internalProfileId = activity.intent.getIntExtra(NAVIGATION_PROFILE_ID_ARGUMENT_KEY, -1)
profileId = ProfileId.newBuilder().setInternalId(internalProfileId).build()

val headerBinding =
Expand Down
6 changes: 3 additions & 3 deletions app/src/main/java/org/oppia/android/app/help/HelpActivity.kt
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import android.content.Intent
import android.os.Bundle
import org.oppia.android.R
import org.oppia.android.app.activity.InjectableAppCompatActivity
import org.oppia.android.app.drawer.KEY_NAVIGATION_PROFILE_ID
import org.oppia.android.app.drawer.NAVIGATION_PROFILE_ID_ARGUMENT_KEY
import org.oppia.android.app.help.faq.FAQListActivity
import javax.inject.Inject

Expand All @@ -28,15 +28,15 @@ class HelpActivity : InjectableAppCompatActivity(), RouteToFAQListListener {
companion object {
// TODO(#1655): Re-restrict access to fields in tests post-Gradle.
const val BOOL_IS_FROM_NAVIGATION_DRAWER_EXTRA_KEY =
"BOOL_IS_FROM_NAVIGATION_DRAWER_EXTRA_KEY"
"HelpActivity.bool_is_from_navigation_drawer"

fun createHelpActivityIntent(
context: Context,
profileId: Int?,
isFromNavigationDrawer: Boolean
): Intent {
val intent = Intent(context, HelpActivity::class.java)
intent.putExtra(KEY_NAVIGATION_PROFILE_ID, profileId)
intent.putExtra(NAVIGATION_PROFILE_ID_ARGUMENT_KEY, profileId)
intent.putExtra(BOOL_IS_FROM_NAVIGATION_DRAWER_EXTRA_KEY, isFromNavigationDrawer)
return intent
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,11 @@ class HintsAndSolutionDialogFragment :

companion object {

internal const val ID_ARGUMENT_KEY = "ID"
internal const val NEW_AVAILABLE_HINT_INDEX_ARGUMENT_KEY = "NEW_AVAILABLE_HINT_INDEX"
internal const val ALL_HINTS_EXHAUSTED_ARGUMENT_KEY = "ALL_HINTS_EXHAUSTED"
internal const val ID_ARGUMENT_KEY = "HintsAndSolutionDialogFragment.id"
internal const val NEW_AVAILABLE_HINT_INDEX_ARGUMENT_KEY =
"HintsAndSolutionDialogFragment.new_available_hint_index"
internal const val ALL_HINTS_EXHAUSTED_ARGUMENT_KEY =
"HintsAndSolutionDialogFragment.all_hints_exhausted"

/**
* Creates a new instance of a DialogFragment to display hints and solution
Expand Down
6 changes: 3 additions & 3 deletions app/src/main/java/org/oppia/android/app/home/HomeActivity.kt
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import android.os.Bundle
import org.oppia.android.R
import org.oppia.android.app.activity.InjectableAppCompatActivity
import org.oppia.android.app.drawer.ExitProfileDialogFragment
import org.oppia.android.app.drawer.KEY_NAVIGATION_PROFILE_ID
import org.oppia.android.app.drawer.NAVIGATION_PROFILE_ID_ARGUMENT_KEY
import org.oppia.android.app.drawer.TAG_SWITCH_PROFILE_DIALOG
import org.oppia.android.app.home.recentlyplayed.RecentlyPlayedActivity
import org.oppia.android.app.model.ExitProfileDialogArguments
Expand All @@ -27,15 +27,15 @@ class HomeActivity :
companion object {
fun createHomeActivity(context: Context, profileId: Int?): Intent {
val intent = Intent(context, HomeActivity::class.java)
intent.putExtra(KEY_NAVIGATION_PROFILE_ID, profileId)
intent.putExtra(NAVIGATION_PROFILE_ID_ARGUMENT_KEY, profileId)
return intent
}
}

override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
activityComponent.inject(this)
internalProfileId = intent?.getIntExtra(KEY_NAVIGATION_PROFILE_ID, -1)!!
internalProfileId = intent?.getIntExtra(NAVIGATION_PROFILE_ID_ARGUMENT_KEY, -1)!!
homeActivityPresenter.handleOnCreate()
title = getString(R.string.menu_home)
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import androidx.appcompat.app.AppCompatActivity
import androidx.fragment.app.Fragment
import androidx.recyclerview.widget.GridLayoutManager
import org.oppia.android.R
import org.oppia.android.app.drawer.KEY_NAVIGATION_PROFILE_ID
import org.oppia.android.app.drawer.NAVIGATION_PROFILE_ID_ARGUMENT_KEY
import org.oppia.android.app.fragment.FragmentScope
import org.oppia.android.app.home.promotedlist.ComingSoonTopicListViewModel
import org.oppia.android.app.home.promotedlist.PromotedStoryListViewModel
Expand Down Expand Up @@ -51,7 +51,7 @@ class HomeFragmentPresenter @Inject constructor(
// NB: Both the view model and lifecycle owner must be set in order to correctly bind LiveData elements to
// data-bound view models.

internalProfileId = activity.intent.getIntExtra(KEY_NAVIGATION_PROFILE_ID, -1)
internalProfileId = activity.intent.getIntExtra(NAVIGATION_PROFILE_ID_ARGUMENT_KEY, -1)
logHomeActivityEvent()

val homeViewModel = HomeViewModel(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import android.content.Context
import android.content.Intent
import android.os.Bundle
import org.oppia.android.app.activity.InjectableAppCompatActivity
import org.oppia.android.app.drawer.KEY_NAVIGATION_PROFILE_ID
import org.oppia.android.app.drawer.NAVIGATION_PROFILE_ID_ARGUMENT_KEY
import org.oppia.android.app.home.HomeActivity
import javax.inject.Inject

Expand All @@ -18,18 +18,18 @@ class MyDownloadsActivity : InjectableAppCompatActivity() {
super.onCreate(savedInstanceState)
activityComponent.inject(this)
myDownloadsActivityPresenter.handleOnCreate()
internalProfileId = intent.getIntExtra(KEY_NAVIGATION_PROFILE_ID, -1)
internalProfileId = intent.getIntExtra(NAVIGATION_PROFILE_ID_ARGUMENT_KEY, -1)
}

companion object {
fun createMyDownloadsActivityIntent(context: Context, profileId: Int?): Intent {
val intent = Intent(context, MyDownloadsActivity::class.java)
intent.putExtra(KEY_NAVIGATION_PROFILE_ID, profileId)
intent.putExtra(NAVIGATION_PROFILE_ID_ARGUMENT_KEY, profileId)
return intent
}

fun getIntentKey(): String {
return KEY_NAVIGATION_PROFILE_ID
return NAVIGATION_PROFILE_ID_ARGUMENT_KEY
}
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ class AppLanguageActivity : InjectableAppCompatActivity() {
prefSummaryValue = if (savedInstanceState == null) {
intent.getStringExtra(APP_LANGUAGE_PREFERENCE_SUMMARY_VALUE_EXTRA_KEY)
} else {
savedInstanceState.get(KEY_SELECTED_LANGUAGE) as String
savedInstanceState.get(SELECTED_LANGUAGE_EXTRA_KEY) as String
}
appLanguageActivityPresenter.handleOnCreate(prefKey, prefSummaryValue)
}
Expand All @@ -30,7 +30,7 @@ class AppLanguageActivity : InjectableAppCompatActivity() {
"AppLanguageActivity.app_language_preference_title"
const val APP_LANGUAGE_PREFERENCE_SUMMARY_VALUE_EXTRA_KEY =
"AppLanguageActivity.app_language_preference_summary_value"
internal const val KEY_SELECTED_LANGUAGE = "SELECTED_LANGUAGE"
internal const val SELECTED_LANGUAGE_EXTRA_KEY = "AppLanguageActivity.selected_language"

/** Returns a new [Intent] to route to [AppLanguageActivity]. */
fun createAppLanguageActivityIntent(
Expand Down Expand Up @@ -63,6 +63,9 @@ class AppLanguageActivity : InjectableAppCompatActivity() {

override fun onSaveInstanceState(outState: Bundle) {
super.onSaveInstanceState(outState)
outState.putString(KEY_SELECTED_LANGUAGE, appLanguageActivityPresenter.getLanguageSelected())
outState.putString(
SELECTED_LANGUAGE_EXTRA_KEY,
appLanguageActivityPresenter.getLanguageSelected()
)
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,10 @@ import android.view.ViewGroup
import org.oppia.android.app.fragment.InjectableFragment
import javax.inject.Inject

private const val KEY_APP_LANGUAGE_PREFERENCE_TITLE = "APP_LANGUAGE_PREFERENCE"
private const val KEY_APP_LANGUAGE_PREFERENCE_SUMMARY_VALUE =
"APP_LANGUAGE_PREFERENCE_SUMMARY_VALUE"
private const val APP_LANGUAGE_PREFERENCE_TITLE_ARGUMENT_KEY =
"AppLanguageFragment.app_language_preference_title"
private const val APP_LANGUAGE_PREFERENCE_SUMMARY_VALUE_ARGUMENT_KEY =
"AppLanguageFragment.app_language_preference_summary_value"
private const val SELECTED_LANGUAGE_SAVED_KEY = "AppLanguageFragment.selected_language"

/** The fragment to change the language of the app. */
Expand All @@ -25,8 +26,8 @@ class AppLanguageFragment :
fun newInstance(prefsKey: String, prefsSummaryValue: String): AppLanguageFragment {
val fragment = AppLanguageFragment()
val args = Bundle()
args.putString(KEY_APP_LANGUAGE_PREFERENCE_TITLE, prefsKey)
args.putString(KEY_APP_LANGUAGE_PREFERENCE_SUMMARY_VALUE, prefsSummaryValue)
args.putString(APP_LANGUAGE_PREFERENCE_TITLE_ARGUMENT_KEY, prefsKey)
args.putString(APP_LANGUAGE_PREFERENCE_SUMMARY_VALUE_ARGUMENT_KEY, prefsSummaryValue)
fragment.arguments = args
return fragment
}
Expand All @@ -44,9 +45,9 @@ class AppLanguageFragment :
): View? {
val args =
checkNotNull(arguments) { "Expected arguments to be passed to AppLanguageFragment" }
val prefsKey = args.getString(KEY_APP_LANGUAGE_PREFERENCE_TITLE)
val prefsKey = args.getString(APP_LANGUAGE_PREFERENCE_TITLE_ARGUMENT_KEY)
val prefsSummaryValue = if (savedInstanceState == null) {
args.getString(KEY_APP_LANGUAGE_PREFERENCE_SUMMARY_VALUE)
args.getString(APP_LANGUAGE_PREFERENCE_SUMMARY_VALUE_ARGUMENT_KEY)
} else {
savedInstanceState.get(SELECTED_LANGUAGE_SAVED_KEY) as String
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,44 +17,46 @@ class AudioLanguageActivity : InjectableAppCompatActivity() {
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
activityComponent.inject(this)
prefKey = intent.getStringExtra(KEY_AUDIO_LANGUAGE_PREFERENCE_TITLE)
prefKey = intent.getStringExtra(AUDIO_LANGUAGE_PREFERENCE_TITLE_EXTRA_KEY)
prefSummaryValue = if (savedInstanceState != null) {
savedInstanceState.get(KEY_AUDIO_LANGUAGE_PREFERENCE_SUMMARY_VALUE) as String
savedInstanceState.get(AUDIO_LANGUAGE_PREFERENCE_SUMMARY_VALUE_EXTRA_KEY) as String
} else {
intent.getStringExtra(KEY_AUDIO_LANGUAGE_PREFERENCE_SUMMARY_VALUE)
intent.getStringExtra(AUDIO_LANGUAGE_PREFERENCE_SUMMARY_VALUE_EXTRA_KEY)
}
audioLanguageActivityPresenter.handleOnCreate(prefKey, prefSummaryValue)
}

companion object {
internal const val KEY_AUDIO_LANGUAGE_PREFERENCE_TITLE = "AUDIO_LANGUAGE_PREFERENCE"
const val KEY_AUDIO_LANGUAGE_PREFERENCE_SUMMARY_VALUE =
"AUDIO_LANGUAGE_PREFERENCE_SUMMARY_VALUE"
internal const val AUDIO_LANGUAGE_PREFERENCE_TITLE_EXTRA_KEY =
"AudioLanguageActivity.audio_language_preference_title"
const val AUDIO_LANGUAGE_PREFERENCE_SUMMARY_VALUE_EXTRA_KEY =
"AudioLanguageActivity.audio_language_preference_summary_value"

/** Returns a new [Intent] to route to [AudioLanguageActivity]. */
fun createAudioLanguageActivityIntent(
context: Context,
prefKey: String,
summaryValue: String?
): Intent {
val intent = Intent(context, AudioLanguageActivity::class.java)
intent.putExtra(KEY_AUDIO_LANGUAGE_PREFERENCE_TITLE, prefKey)
intent.putExtra(KEY_AUDIO_LANGUAGE_PREFERENCE_SUMMARY_VALUE, summaryValue)
intent.putExtra(AUDIO_LANGUAGE_PREFERENCE_TITLE_EXTRA_KEY, prefKey)
intent.putExtra(AUDIO_LANGUAGE_PREFERENCE_SUMMARY_VALUE_EXTRA_KEY, summaryValue)
return intent
}

fun getKeyAudioLanguagePreferenceTitle(): String {
return KEY_AUDIO_LANGUAGE_PREFERENCE_TITLE
return AUDIO_LANGUAGE_PREFERENCE_TITLE_EXTRA_KEY
}

fun getKeyAudioLanguagePreferenceSummaryValue(): String {
return KEY_AUDIO_LANGUAGE_PREFERENCE_SUMMARY_VALUE
return AUDIO_LANGUAGE_PREFERENCE_SUMMARY_VALUE_EXTRA_KEY
}
}

override fun onSaveInstanceState(outState: Bundle) {
super.onSaveInstanceState(outState)
outState.putString(
KEY_AUDIO_LANGUAGE_PREFERENCE_SUMMARY_VALUE,
AUDIO_LANGUAGE_PREFERENCE_SUMMARY_VALUE_EXTRA_KEY,
audioLanguageActivityPresenter.getLanguageSelected()
)
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,10 @@ import android.view.ViewGroup
import org.oppia.android.app.fragment.InjectableFragment
import javax.inject.Inject

private const val KEY_AUDIO_LANGUAGE_PREFERENCE_TITLE = "AUDIO_LANGUAGE_PREFERENCE"
private const val KEY_AUDIO_LANGUAGE_PREFERENCE_SUMMARY_VALUE =
"AUDIO_LANGUAGE_PREFERENCE_SUMMARY_VALUE"
private const val AUDIO_LANGUAGE_PREFERENCE_TITLE_ARGUMENT_KEY =
"AudioLanguageFragment.audio_language_preference_title"
private const val AUDIO_LANGUAGE_PREFERENCE_SUMMARY_VALUE_ARGUMENT_KEY =
"AudioLanguageFragment.audio_language_preference_summary_value"
private const val SELECTED_AUDIO_LANGUAGE_SAVED_KEY =
"AudioLanguageFragment.selected_audio_language"

Expand All @@ -25,8 +26,8 @@ class AudioLanguageFragment :
companion object {
fun newInstance(prefsKey: String, prefsSummaryValue: String): AudioLanguageFragment {
val args = Bundle()
args.putString(KEY_AUDIO_LANGUAGE_PREFERENCE_TITLE, prefsKey)
args.putString(KEY_AUDIO_LANGUAGE_PREFERENCE_SUMMARY_VALUE, prefsSummaryValue)
args.putString(AUDIO_LANGUAGE_PREFERENCE_TITLE_ARGUMENT_KEY, prefsKey)
args.putString(AUDIO_LANGUAGE_PREFERENCE_SUMMARY_VALUE_ARGUMENT_KEY, prefsSummaryValue)
val fragment = AudioLanguageFragment()
fragment.arguments = args
return fragment
Expand All @@ -45,9 +46,9 @@ class AudioLanguageFragment :
): View? {
val args =
checkNotNull(arguments) { "Expected arguments to be passed to AudioLanguageFragment" }
val prefsKey = args.getString(KEY_AUDIO_LANGUAGE_PREFERENCE_TITLE)
val prefsKey = args.getString(AUDIO_LANGUAGE_PREFERENCE_TITLE_ARGUMENT_KEY)
val audioLanguageDefaultSummary = checkNotNull(
args.getString(KEY_AUDIO_LANGUAGE_PREFERENCE_SUMMARY_VALUE)
args.getString(AUDIO_LANGUAGE_PREFERENCE_SUMMARY_VALUE_ARGUMENT_KEY)
)
val prefsSummaryValue = if (savedInstanceState == null) {
audioLanguageDefaultSummary
Expand Down
Loading

0 comments on commit be570f4

Please sign in to comment.