Fix #159: Introduce question player UI structure

.gitignore

@@ -11,6 +11,7 @@ app/build
 data/build
 domain/build
 model/build
+testing/build
 utility/build
 .DS_Store
 /build

app/build.gradle

@@ -97,6 +97,7 @@ dependencies {
       'androidx.test.espresso:espresso-intents:3.1.0',
       'androidx.test.ext:junit:1.1.1',
       'com.google.truth:truth:0.43',
+      'org.robolectric:annotations:4.3',
       'org.robolectric:robolectric:4.3',
       'org.jetbrains.kotlinx:kotlinx-coroutines-test:1.2.2',
       'org.mockito:mockito-core:2.7.22',
@@ -111,6 +112,7 @@ dependencies {
       'com.google.truth:truth:0.43',
       'org.jetbrains.kotlinx:kotlinx-coroutines-test:1.2.2',
       'org.mockito:mockito-android:2.7.22',
+      'org.robolectric:annotations:4.3',
   )
   androidTestUtil(
       'androidx.test:orchestrator:1.2.0',
@@ -127,6 +129,8 @@ dependencies {
   // TODO (#59): Remove this once Bazel is introduced
   api project(':data')
   implementation project(":model")
+  testImplementation project(":model")
+  androidTestImplementation project(":model")
   implementation project(":domain")
   implementation project(":utility")
 }

app/src/main/AndroidManifest.xml

@@ -1,7 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <manifest xmlns:android="http://schemas.android.com/apk/res/android"
   package="org.oppia.app">
-
   <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
   <uses-permission android:name="android.permission.INTERNET" />
   <!-- TODO(#56): Reenable landscape support. -->
@@ -64,6 +63,7 @@
       android:name=".player.exploration.ExplorationActivity"
       android:theme="@style/OppiaThemeWithoutActionBar"
       android:windowSoftInputMode="adjustResize" />
+    <activity android:name=".player.state.testing.StateFragmentTestActivity" />
     <activity
       android:name=".profile.AddProfileActivity"
       android:theme="@style/OppiaThemeNoActionBarColorAccentColorPrimary" />
@@ -116,7 +116,6 @@
     <activity android:name=".testing.AudioFragmentTestActivity" />
     <activity android:name=".testing.BindableAdapterTestActivity" />
     <activity android:name=".testing.ConceptCardFragmentTestActivity" />
-    <activity android:name=".testing.ContentCardTestActivity" />
     <activity android:name=".testing.ExplorationInjectionActivity" />
     <activity android:name=".testing.ExplorationTestActivity" />
     <activity android:name=".testing.HomeInjectionActivity" />
@@ -140,7 +139,8 @@
       android:theme="@style/OppiaThemeWithoutActionBar" />
     <activity
       android:name=".topic.questionplayer.QuestionPlayerActivity"
-      android:screenOrientation="portrait" />
+      android:screenOrientation="portrait"
+      android:label="@string/question_player_title" />
     <activity
       android:name=".topic.revisioncard.RevisionCardActivity"
       android:theme="@style/OppiaThemeWithoutActionBar" />

app/src/main/java/org/oppia/app/activity/ActivityComponent.kt

@@ -20,6 +20,7 @@ import org.oppia.app.options.DefaultAudioActivity
 import org.oppia.app.options.OptionsActivity
 import org.oppia.app.options.StoryTextSizeActivity
 import org.oppia.app.player.exploration.ExplorationActivity
+import org.oppia.app.player.state.testing.StateFragmentTestActivity
 import org.oppia.app.profile.AddProfileActivity
 import org.oppia.app.profile.AdminAuthActivity
 import org.oppia.app.profile.AdminPinActivity
@@ -36,7 +37,6 @@ import org.oppia.app.story.StoryActivity
 import org.oppia.app.testing.AudioFragmentTestActivity
 import org.oppia.app.testing.BindableAdapterTestActivity
 import org.oppia.app.testing.ConceptCardFragmentTestActivity
-import org.oppia.app.testing.ContentCardTestActivity
 import org.oppia.app.testing.ExplorationInjectionActivity
 import org.oppia.app.testing.ExplorationTestActivity
 import org.oppia.app.testing.HomeInjectionActivity
@@ -77,7 +77,6 @@ interface ActivityComponent {
   fun inject(bindableAdapterTestActivity: BindableAdapterTestActivity)
   fun inject(completedStoryListActivity: CompletedStoryListActivity)
   fun inject(conceptCardFragmentTestActivity: ConceptCardFragmentTestActivity)
-  fun inject(contentCardTestActivity: ContentCardTestActivity)
   fun inject(defaultAudioActivity: DefaultAudioActivity)
   fun inject(explorationActivity: ExplorationActivity)
   fun inject(explorationInjectionActivity: ExplorationInjectionActivity)
@@ -107,6 +106,7 @@ interface ActivityComponent {
   fun inject(recentlyPlayedActivity: RecentlyPlayedActivity)
   fun inject(revisionCardActivity: RevisionCardActivity)
   fun inject(splashActivity: SplashActivity)
+  fun inject(stateFragmentTestActivity: StateFragmentTestActivity)
   fun inject(storyActivity: StoryActivity)
   fun inject(storyTextSizeActivity: StoryTextSizeActivity)
   fun inject(topicActivity: TopicActivity)

app/src/main/java/org/oppia/app/application/ApplicationComponent.kt

@@ -13,6 +13,7 @@ import org.oppia.domain.classify.rules.multiplechoiceinput.MultipleChoiceInputMo
 import org.oppia.domain.classify.rules.numberwithunits.NumberWithUnitsRuleModule
 import org.oppia.domain.classify.rules.numericinput.NumericInputRuleModule
 import org.oppia.domain.classify.rules.textinput.TextInputRuleModule
+import org.oppia.domain.question.QuestionModule
 import org.oppia.util.caching.CachingModule
 import org.oppia.util.gcsresource.GcsResourceModule
 import org.oppia.util.logging.LoggerModule
@@ -30,7 +31,7 @@ import javax.inject.Singleton
   ContinueModule::class, FractionInputModule::class, ItemSelectionInputModule::class, MultipleChoiceInputModule::class,
   NumberWithUnitsRuleModule::class, NumericInputRuleModule::class, TextInputRuleModule::class,
   InteractionsModule::class, GcsResourceModule::class, GlideImageLoaderModule::class, ImageParsingModule::class,
-  HtmlParserEntityTypeModule::class, CachingModule::class
+  HtmlParserEntityTypeModule::class, CachingModule::class, QuestionModule::class
 ])
 interface ApplicationComponent {
   @Component.Builder

app/src/main/java/org/oppia/app/databinding/DrawableBindingAdapters.kt

@@ -2,7 +2,9 @@ package org.oppia.app.databinding
 
 import android.graphics.drawable.GradientDrawable
 import android.view.View
+import android.widget.Button
 import androidx.annotation.ColorInt
+import androidx.annotation.DrawableRes
 import androidx.databinding.BindingAdapter
 import org.oppia.app.R
 
@@ -34,3 +36,8 @@ fun setRectangleBackgroundDrawable(view: View, @ColorInt colorRgb: Int) {
   // The input color needs to have alpha channel prepended to it.
   (view.background as GradientDrawable).setColor((0xff000000 or colorRgb.toLong()).toInt())
 }
+
+@BindingAdapter("android:button")
+fun setBackgroundResource(button: Button, @DrawableRes resource: Int) {
+  button.setBackgroundResource(resource)
+}

app/src/main/java/org/oppia/app/player/audio/AudioFragment.kt

@@ -41,6 +41,16 @@ class AudioFragment : InjectableFragment(), LanguageInterface, AudioUiManager, C
     audioFragmentPresenter.handleOnDestroy()
   }
 
+  override fun enableAudioPlayback(contentId: String?) {
+    audioFragmentPresenter.handleAudioClick(
+      shouldEnableAudioPlayback = true, feedbackId = contentId
+    )
+  }
+
+  override fun disableAudioPlayback() {
+    audioFragmentPresenter.handleAudioClick(shouldEnableAudioPlayback = false, feedbackId = null)
+  }
+
   override fun setStateAndExplorationId(newState: State, explorationId: String) =
     audioFragmentPresenter.setStateAndExplorationId(newState, explorationId)
 
@@ -65,7 +75,4 @@ class AudioFragment : InjectableFragment(), LanguageInterface, AudioUiManager, C
 
   /** Used in data binding to know position of user's touch */
   fun getUserPosition() = audioFragmentPresenter.userProgress
-
-  fun handleAudioClick(isShowing: Boolean, feedbackId: String?) =
-    audioFragmentPresenter.handleAudioClick(isShowing, feedbackId)
 }

app/src/main/java/org/oppia/app/player/audio/AudioFragmentPresenter.kt

@@ -147,11 +147,9 @@ class AudioFragmentPresenter @Inject constructor(
     }
   }
 
-  fun handleAudioClick(isShowing: Boolean, feedbackId: String?) {
+  fun handleAudioClick(shouldEnableAudioPlayback: Boolean, feedbackId: String?) {
     this.feedbackId = feedbackId
-    if (isShowing) {
-      setAudioFragmentVisible(false)
-    } else {
+    if (shouldEnableAudioPlayback) {
       when (networkConnectionUtil.getCurrentConnectionStatus()) {
         NetworkConnectionUtil.ConnectionStatus.LOCAL -> setAudioFragmentVisible(true)
         NetworkConnectionUtil.ConnectionStatus.CELLULAR -> {
@@ -171,6 +169,8 @@ class AudioFragmentPresenter @Inject constructor(
           setAudioFragmentVisible(false)
         }
       }
+    } else {
+      setAudioFragmentVisible(false)
     }
   }
 

app/src/main/java/org/oppia/app/player/audio/AudioUiManager.kt

@@ -4,6 +4,16 @@ import org.oppia.app.model.State
 
 /** Manager for updating audio state within the state player. */
 interface AudioUiManager {
+  /**
+   * Enables audio playback with the specified content ID as the initial content to play. Note that
+   * this corresponds to a response to the UI which means the action may fail with a dialog
+   * notifying the user why they can't enable audio playback right now.
+   */
+  fun enableAudioPlayback(contentId: String?)
+
+  /** Disables audio playback, stopping any currently playing tracks. */
+  fun disableAudioPlayback();
+
   /**
    * Used to set the state and explorationId for the audio player
    *

app/src/main/java/org/oppia/app/player/audio/AudioViewModel.kt

@@ -13,7 +13,7 @@ import org.oppia.domain.audio.AudioPlayerController
 import org.oppia.domain.audio.AudioPlayerController.PlayProgress
 import org.oppia.domain.audio.AudioPlayerController.PlayStatus
 import org.oppia.util.data.AsyncResult
-import org.oppia.util.gcsresource.DefaultResource
+import org.oppia.util.gcsresource.DefaultResourceBucketName
 import java.util.Locale
 import javax.inject.Inject
 
@@ -22,7 +22,7 @@ import javax.inject.Inject
 class AudioViewModel @Inject constructor(
   private val audioPlayerController: AudioPlayerController,
   private val fragment: Fragment,
-  @DefaultResource private val gcsResource: String
+  @DefaultResourceBucketName private val gcsResource: String
 ) : ViewModel() {
 
   private lateinit var state: State

app/src/main/java/org/oppia/app/player/exploration/ExplorationActivity.kt

@@ -13,15 +13,15 @@ import org.oppia.app.player.state.hintsandsolution.RevealHintListener
 import org.oppia.app.player.state.hintsandsolution.RevealSolutionInterface
 import org.oppia.app.player.state.listener.RouteToHintsAndSolutionListener
 import org.oppia.app.player.state.listener.StateKeyboardButtonListener
-import org.oppia.app.player.stopexploration.StopExplorationDialogFragment
-import org.oppia.app.player.stopexploration.StopExplorationInterface
+import org.oppia.app.player.stopplaying.StopExplorationDialogFragment
+import org.oppia.app.player.stopplaying.StopStatePlayingSessionListener
 import javax.inject.Inject
 
 private const val TAG_STOP_EXPLORATION_DIALOG = "STOP_EXPLORATION_DIALOG"
 const val TAG_HINTS_AND_SOLUTION_DIALOG = "HINTS_AND_SOLUTION_DIALOG"
 
 /** The starting point for exploration. */
-class ExplorationActivity : InjectableAppCompatActivity(), StopExplorationInterface, StateKeyboardButtonListener,
+class ExplorationActivity : InjectableAppCompatActivity(), StopStatePlayingSessionListener, StateKeyboardButtonListener,
   AudioButtonListener, HintsAndSolutionListener, RouteToHintsAndSolutionListener, RevealHintListener,
   RevealSolutionInterface {
 
@@ -77,7 +77,7 @@ class ExplorationActivity : InjectableAppCompatActivity(), StopExplorationInterf
     dialogFragment.showNow(supportFragmentManager, TAG_STOP_EXPLORATION_DIALOG)
   }
 
-  override fun stopExploration() {
+  override fun stopSession() {
     explorationActivityPresenter.stopExploration()
   }
 

app/src/main/java/org/oppia/app/player/exploration/ExplorationActivityPresenter.kt

@@ -103,6 +103,15 @@ class ExplorationActivityPresenter @Inject constructor(
     })
   }
 
+  fun onKeyboardAction(actionCode: Int) {
+    if (actionCode == EditorInfo.IME_ACTION_DONE) {
+      val explorationFragment = activity.supportFragmentManager.findFragmentByTag(
+        TAG_EXPLORATION_FRAGMENT
+      ) as? ExplorationFragment
+      explorationFragment?.onKeyboardAction()
+    }
+  }
+
   private fun updateToolbarTitle(explorationId: String) {
     subscribeToExploration(explorationDataController.getExplorationById(explorationId))
   }
@@ -131,14 +140,6 @@ class ExplorationActivityPresenter @Inject constructor(
     return ephemeralStateResult.getOrDefault(Exploration.getDefaultInstance())
   }
 
-  fun onKeyboardAction(actionCode: Int) {
-    if (actionCode == EditorInfo.IME_ACTION_DONE) {
-      val explorationFragment =
-        activity.supportFragmentManager.findFragmentByTag(TAG_EXPLORATION_FRAGMENT) as ExplorationFragment
-      explorationFragment.onKeyboardAction()
-    }
-  }
-
   fun revealHint(saveUserChoice: Boolean, hintIndex: Int) {
     val explorationFragment =
       activity.supportFragmentManager.findFragmentByTag(TAG_EXPLORATION_FRAGMENT) as ExplorationFragment

app/src/main/java/org/oppia/app/player/exploration/ExplorationFragmentPresenter.kt

@@ -44,10 +44,6 @@ class ExplorationFragmentPresenter @Inject constructor(
 
   fun scrollToTop() = getStateFragment()?.scrollToTop()
 
-  private fun getStateFragment(): StateFragment? {
-    return fragment.childFragmentManager.findFragmentById(R.id.state_fragment_placeholder) as StateFragment?
-  }
-
   fun onKeyboardAction() {
     getStateFragment()?.handleKeyboardAction()
   }
@@ -59,4 +55,8 @@ class ExplorationFragmentPresenter @Inject constructor(
   fun revealSolution(saveUserChoice: Boolean){
     getStateFragment()?.revealSolution(saveUserChoice)
   }
+
+  private fun getStateFragment(): StateFragment? {
+    return fragment.childFragmentManager.findFragmentById(R.id.state_fragment_placeholder) as StateFragment?
+  }
 }

app/src/main/java/org/oppia/app/player/state/SelectionInteractionView.kt

@@ -12,6 +12,7 @@ import org.oppia.app.databinding.MultipleChoiceInteractionItemsBinding
 import org.oppia.app.fragment.InjectableFragment
 import org.oppia.app.player.state.itemviewmodel.SelectionInteractionContentViewModel
 import org.oppia.app.recyclerview.BindableAdapter
+import org.oppia.util.gcsresource.DefaultResourceBucketName
 import org.oppia.util.parser.ExplorationHtmlParserEntityType
 import org.oppia.util.parser.HtmlParser
 import javax.inject.Inject
@@ -37,7 +38,11 @@ class SelectionInteractionView @JvmOverloads constructor(
   @Inject
   @field:ExplorationHtmlParserEntityType
   lateinit var entityType: String
-  private lateinit var explorationId: String
+  @Inject
+  @field:DefaultResourceBucketName
+  lateinit var resourceBucketName: String
+
+  private lateinit var entityId: String
 
   override fun onAttachedToWindow() {
     super.onAttachedToWindow()
@@ -55,8 +60,8 @@ class SelectionInteractionView @JvmOverloads constructor(
 
   // TODO(#264): Clean up HTML parser such that it can be handled completely through a binding adapter, allowing
   //  TextViews that require custom Oppia HTML parsing to be fully automatically bound through data-binding.
-  fun setExplorationId(explorationId: String) {
-    this.explorationId = explorationId
+  fun setEntityId(entityId: String) {
+    this.entityId = entityId
   }
 
   private fun createAdapter(): BindableAdapter<SelectionInteractionContentViewModel> {
@@ -72,7 +77,9 @@ class SelectionInteractionView @JvmOverloads constructor(
           bindView = { view, viewModel ->
             val binding = DataBindingUtil.findBinding<ItemSelectionInteractionItemsBinding>(view)!!
             binding.htmlContent =
-              htmlParserFactory.create(entityType, explorationId, /* imageCenterAlign= */ false).parseOppiaHtml(
+              htmlParserFactory.create(
+                resourceBucketName, entityType, entityId, /* imageCenterAlign= */ false
+              ).parseOppiaHtml(
                 viewModel.htmlContent, binding.itemSelectionContentsTextView
               )
             binding.viewModel = viewModel
@@ -90,7 +97,9 @@ class SelectionInteractionView @JvmOverloads constructor(
           bindView = { view, viewModel ->
             val binding = DataBindingUtil.findBinding<MultipleChoiceInteractionItemsBinding>(view)!!
             binding.htmlContent =
-              htmlParserFactory.create(entityType, explorationId, /* imageCenterAlign= */ false).parseOppiaHtml(
+              htmlParserFactory.create(
+                resourceBucketName, entityType, entityId, /* imageCenterAlign= */ false
+              ).parseOppiaHtml(
                 viewModel.htmlContent, binding.multipleChoiceContentTextView
               )
             binding.viewModel = viewModel
@@ -108,7 +117,7 @@ fun setAllOptionsItemInputType(
 ) = selectionInteractionView.setAllOptionsItemInputType(selectionItemInputType)
 
 /** Sets the exploration ID for a specific [SelectionInteractionView] via data-binding. */
-@BindingAdapter("explorationId")
-fun setExplorationId(
-  selectionInteractionView: SelectionInteractionView, explorationId: String
-) = selectionInteractionView.setExplorationId(explorationId)
+@BindingAdapter("entityId")
+fun setEntityId(
+  selectionInteractionView: SelectionInteractionView, entityId: String
+) = selectionInteractionView.setEntityId(entityId)