Fixes #166: Story activity UI structure

app/build.gradle

@@ -75,6 +75,7 @@ dependencies {
       'androidx.test:core:1.2.0',
       'androidx.test.espresso:espresso-core:3.2.0',
       'androidx.test.espresso:espresso-intents:3.1.0',
+      'com.android.support.test.espresso:espresso-contrib:3.1.0',
       'androidx.test.ext:junit:1.1.1',
       'com.google.truth:truth:0.43',
       'org.robolectric:robolectric:4.3',
@@ -84,6 +85,7 @@ dependencies {
       'androidx.test:core:1.2.0',
       'androidx.test.espresso:espresso-core:3.2.0',
       'androidx.test.espresso:espresso-intents:3.1.0',
+      'com.android.support.test.espresso:espresso-contrib:3.1.0',
       'androidx.test.ext:junit:1.1.1',
       'androidx.test:runner:1.2.0',
       'com.google.truth:truth:0.43',

app/src/main/AndroidManifest.xml

@@ -11,16 +11,19 @@
     android:roundIcon="@mipmap/ic_launcher_round"
     android:supportsRtl="true"
     android:theme="@style/OppiaTheme">
-    <activity android:name=".topic.conceptcard.testing.ConceptCardFragmentTestActivity" />
-    <activity android:name=".player.state.testing.StateFragmentTestActivity" />
+    <activity android:name="org.oppia.app.topic.conceptcard.testing.ConceptCardFragmentTestActivity" />
+    <activity android:name="org.oppia.app.player.state.testing.StateFragmentTestActivity" />
     <activity android:name=".player.exploration.ExplorationActivity" />
     <activity android:name=".topic.questionplayer.QuestionPlayerActivity" />
     <activity android:name=".topic.TopicActivity" />
     <activity android:name=".player.audio.testing.AudioFragmentTestActivity" />
-    <activity android:name=".testing.InputInteractionViewTestActivity" />
+    <activity android:name="org.oppia.app.home.HomeActivity" />
     <activity android:name=".profile.ProfileActivity" />
-    <activity android:name=".story.StoryActivity" />
-    <activity android:name=".home.HomeActivity">
+    <activity android:name=".testing.InputInteractionViewTestActivity" />
+    <activity android:name=".story.StoryActivity"/>
+    <activity
+      android:name=".splash.SplashActivity"
+      android:theme="@style/SplashScreenTheme">
       <intent-filter>
         <action android:name="android.intent.action.MAIN" />
         <category android:name="android.intent.category.LAUNCHER" />
@@ -30,9 +33,6 @@
         <category android:name="android.intent.category.DEFAULT" />
       </intent-filter>
     </activity>
-    <activity
-      android:name=".splash.SplashActivity"
-      android:theme="@style/SplashScreenTheme" />
     <activity android:name=".testing.HtmlParserTestActivity" />
     <activity android:name=".testing.BindableAdapterTestActivity" />
   </application>

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

@@ -7,13 +7,13 @@ import org.oppia.app.fragment.FragmentComponent
 import org.oppia.app.home.HomeActivity
 import org.oppia.app.player.audio.testing.AudioFragmentTestActivity
 import org.oppia.app.player.exploration.ExplorationActivity
-import org.oppia.app.topic.conceptcard.testing.ConceptCardFragmentTestActivity
 import org.oppia.app.player.state.testing.StateFragmentTestActivity
 import org.oppia.app.profile.ProfileActivity
 import org.oppia.app.story.StoryActivity
 import org.oppia.app.testing.BindableAdapterTestActivity
 import org.oppia.app.testing.HtmlParserTestActivity
 import org.oppia.app.topic.TopicActivity
+import org.oppia.app.topic.conceptcard.testing.ConceptCardFragmentTestActivity
 import org.oppia.app.topic.questionplayer.QuestionPlayerActivity
 import javax.inject.Provider
 
@@ -23,7 +23,9 @@ import javax.inject.Provider
 interface ActivityComponent {
   @Subcomponent.Builder
   interface Builder {
-    @BindsInstance fun setActivity(appCompatActivity: AppCompatActivity): Builder
+    @BindsInstance
+    fun setActivity(appCompatActivity: AppCompatActivity): Builder
+
     fun build(): ActivityComponent
   }
 

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

@@ -0,0 +1,15 @@
+package org.oppia.app.databinding
+
+import android.graphics.drawable.GradientDrawable
+import android.view.View
+import androidx.annotation.ColorInt
+import androidx.databinding.BindingAdapter
+import org.oppia.app.R
+
+/** Used to set a rounded-rect background drawable with a data-bound color. */
+@BindingAdapter("app:roundedRectDrawableWithColor")
+fun setBackgroundDrawable(view: View, @ColorInt colorRgb: Int) {
+  view.setBackgroundResource(R.drawable.rounded_rect_background)
+  // The input color needs to have alpha channel prepended to it.
+  (view.background as GradientDrawable).setColor((0xff000000 or colorRgb.toLong()).toInt())
+}

app/src/main/java/org/oppia/app/fragment/FragmentComponent.kt

@@ -4,9 +4,9 @@ import androidx.fragment.app.Fragment
 import dagger.BindsInstance
 import dagger.Subcomponent
 import org.oppia.app.home.HomeFragment
+import org.oppia.app.player.audio.AudioFragment
 import org.oppia.app.player.exploration.ExplorationFragment
 import org.oppia.app.player.state.StateFragment
-import org.oppia.app.player.audio.AudioFragment
 import org.oppia.app.profile.AddProfileFragment
 import org.oppia.app.profile.AdminAuthFragment
 import org.oppia.app.profile.ProfileChooserFragment

app/src/main/java/org/oppia/app/home/HomeFragmentPresenter.kt

@@ -1,17 +1,22 @@
 package org.oppia.app.home
 
+import android.content.Context
+import android.content.Intent
 import android.view.LayoutInflater
 import android.view.View
 import android.view.ViewGroup
 import androidx.appcompat.app.AppCompatActivity
+import androidx.core.content.ContextCompat.startActivity
 import androidx.fragment.app.Fragment
 import androidx.lifecycle.Observer
 import org.oppia.app.databinding.HomeFragmentBinding
 import org.oppia.app.fragment.FragmentScope
+import org.oppia.app.story.StoryActivity
 import org.oppia.app.viewmodel.ViewModelProvider
 import org.oppia.domain.UserAppHistoryController
 import org.oppia.domain.exploration.ExplorationDataController
 import org.oppia.domain.exploration.TEST_EXPLORATION_ID_5
+import org.oppia.domain.topic.TEST_STORY_ID_1
 import org.oppia.util.data.AsyncResult
 import org.oppia.util.logging.Logger
 import javax.inject.Inject
@@ -64,4 +69,10 @@ class HomeFragmentPresenter @Inject constructor(
       }
     })
   }
+
+  // TODO(#134): Remove this method once it is possible to navigate to story activity in normal flow
+  fun openStory(v: View) {
+    val intent = StoryActivity.createStoryActivityIntent(fragment.activity as Context, TEST_STORY_ID_1)
+    fragment.activity?.startActivity(intent)
+  }
 }

app/src/main/java/org/oppia/app/recyclerview/BindableAdapter.kt

@@ -56,7 +56,7 @@ class BindableAdapter<T : Any> internal constructor(
     // when T1 is not assignable to T2). This likely won't have bad side effects since any time a
     // non-empty list is attempted to be bound, this crash will be correctly triggered.
     newDataList.firstOrNull()?.let {
-      check(it.javaClass.isAssignableFrom(dataClassType.java)) {
+      check(dataClassType.java.isAssignableFrom(it.javaClass)) {
         "Trying to bind incompatible data to adapter. Data class type: ${it.javaClass}, " +
             "expected adapter class type: $dataClassType."
       }
@@ -148,6 +148,18 @@ class BindableAdapter<T : Any> internal constructor(
       return this
     }
 
+    /** See [registerViewDataBinder]. */
+    fun <DB : ViewDataBinding> registerViewDataBinderWithSameModelType(
+      viewType: Int = DEFAULT_VIEW_TYPE,
+      inflateDataBinding: (LayoutInflater, ViewGroup, Boolean) -> DB,
+      setViewModel: (DB, T) -> Unit
+    ): Builder<T> {
+      return registerViewDataBinder(
+        viewType = viewType, inflateDataBinding = inflateDataBinding, setViewModel = setViewModel,
+        transformViewModel = { it }
+      )
+    }
+
     /**
      * Behaves in the same way as [registerViewBinder] except the inflate and bind methods correspond to a [View]
      * data-binding typed [DB].
@@ -158,12 +170,15 @@ class BindableAdapter<T : Any> internal constructor(
      * @param setViewModel a function that initializes the view model in the data-bound view (e.g.
      *     MyDataBinding::setSpecialViewModel). This may also be a function that initializes the view model & other
      *     view-accessible properties as necessary.
+     * @param transformViewModel a function that converts the input model to a model of another type (such as for cases
+     *     when subclassing is used to represent more complex lists of data).
      * @return this
      */
-    fun <DB : ViewDataBinding> registerViewDataBinder(
+    fun <DB : ViewDataBinding, T2 : T> registerViewDataBinder(
       viewType: Int = DEFAULT_VIEW_TYPE,
       inflateDataBinding: (LayoutInflater, ViewGroup, Boolean) -> DB,
-      setViewModel: (DB, T) -> Unit
+      setViewModel: (DB, T2) -> Unit,
+      transformViewModel: (T) -> T2
     ): Builder<T> {
       checkViewTypeIsUnique(viewType)
       val viewHolderFactory: ViewHolderFactory<T> = { viewGroup ->
@@ -176,7 +191,7 @@ class BindableAdapter<T : Any> internal constructor(
         )
         object : BindableViewHolder<T>(binding.root) {
           override fun bind(data: T) {
-            setViewModel(binding, data)
+            setViewModel(binding, transformViewModel(data))
           }
         }
       }
@@ -205,4 +220,4 @@ class BindableAdapter<T : Any> internal constructor(
       }
     }
   }
-}
+}

app/src/main/java/org/oppia/app/recyclerview/RecyclerViewBindingAdapter.kt

@@ -1,6 +1,7 @@
 package org.oppia.app.recyclerview
 
 import androidx.databinding.BindingAdapter
+import androidx.databinding.ObservableList
 import androidx.lifecycle.LiveData
 import androidx.recyclerview.widget.RecyclerView
 
@@ -10,11 +11,27 @@ import androidx.recyclerview.widget.RecyclerView
  * https://android.jlelse.eu/1bd08b4796b4.
  */
 @BindingAdapter("data")
-fun <T : Any> bindToRecyclerViewAdapter(recyclerView: RecyclerView, liveData: LiveData<List<T>>) {
+fun <T : Any> bindToRecyclerViewAdapterWithLiveData(
+  recyclerView: RecyclerView,
+  liveData: LiveData<List<T>>
+) {
   liveData.value?.let { data ->
-    val adapter = recyclerView.adapter
-    checkNotNull(adapter) { "Cannot bind data to a RecyclerView missing its adapter." }
-    check(adapter is BindableAdapter<*>) { "Can only bind data to a BindableAdapter." }
-    adapter.setDataUnchecked(data)
+    bindToRecyclerViewAdapter(recyclerView, data)
   }
 }
+
+/** A variant of [bindToRecyclerViewAdapterWithLiveData] that instead uses an observable list. */
+@BindingAdapter("data")
+fun <T : Any> bindToRecyclerViewAdapterWithObservableList(
+  recyclerView: RecyclerView,
+  dataList: ObservableList<T>
+) {
+  bindToRecyclerViewAdapter(recyclerView, dataList)
+}
+
+private fun <T : Any> bindToRecyclerViewAdapter(recyclerView: RecyclerView, dataList: List<T>) {
+  val adapter = recyclerView.adapter
+  checkNotNull(adapter) { "Cannot bind data to a RecyclerView missing its adapter." }
+  check(adapter is BindableAdapter<*>) { "Can only bind data to a BindableAdapter." }
+  adapter.setDataUnchecked(dataList)
+}

app/src/main/java/org/oppia/app/story/StoryActivity.kt

@@ -4,26 +4,41 @@ import android.content.Context
 import android.content.Intent
 import android.os.Bundle
 import org.oppia.app.activity.InjectableAppCompatActivity
+import org.oppia.app.player.exploration.ExplorationActivity
 import javax.inject.Inject
 
 /** Activity for stories. */
 class StoryActivity : InjectableAppCompatActivity() {
   @Inject lateinit var storyActivityPresenter: StoryActivityPresenter
 
+  init {
+    instance = this
+  }
+
   override fun onCreate(savedInstanceState: Bundle?) {
     super.onCreate(savedInstanceState)
     activityComponent.inject(this)
-    storyActivityPresenter.handleOnCreate()
+    val storyId = intent.getStringExtra(STORY_ACTIVITY_STORY_ID_ARGUMENT_KEY)
+    storyActivityPresenter.handleOnCreate(storyId)
+  }
+
+  override fun onSupportNavigateUp(): Boolean {
+    return storyActivityPresenter.handleOnSupportNavigationUp()
   }
 
   companion object {
     const val STORY_ACTIVITY_STORY_ID_ARGUMENT_KEY = "StoryActivity.story_id"
+    private var instance: StoryActivity? = null
 
     /** Returns a new [Intent] to route to [StoryActivity] for a specified story ID. */
     fun createStoryActivityIntent(context: Context, storyId: String): Intent {
       val intent = Intent(context, StoryActivity::class.java)
       intent.putExtra(STORY_ACTIVITY_STORY_ID_ARGUMENT_KEY, storyId)
       return intent
     }
+
+    fun routeToExploration(explorationId: String) {
+      instance?.startActivity(ExplorationActivity.createExplorationActivityIntent(instance!!, explorationId))
+    }
   }
 }

app/src/main/java/org/oppia/app/story/StoryActivityPresenter.kt

@@ -8,16 +8,22 @@ import javax.inject.Inject
 /** The presenter for [StoryActivity]. */
 @ActivityScope
 class StoryActivityPresenter @Inject constructor(private val activity: AppCompatActivity) {
-  fun handleOnCreate() {
+  fun handleOnCreate(storyId: String) {
     activity.setContentView(R.layout.story_activity)
+    activity.supportActionBar?.setDisplayHomeAsUpEnabled(true)
     if (getStoryFragment() == null) {
       activity.supportFragmentManager.beginTransaction().add(
         R.id.story_fragment_placeholder,
-        StoryFragment()
+        StoryFragment.newInstace(storyId)
       ).commitNow()
     }
   }
 
+  fun handleOnSupportNavigationUp(): Boolean {
+    activity.finish()
+    return true
+  }
+
   private fun getStoryFragment(): StoryFragment? {
     return activity.supportFragmentManager.findFragmentById(R.id.story_fragment_placeholder) as StoryFragment?
   }

app/src/main/java/org/oppia/app/story/StoryFragment.kt

@@ -8,17 +8,36 @@ import android.view.ViewGroup
 import org.oppia.app.fragment.InjectableFragment
 import javax.inject.Inject
 
-/** Fragment that displays story with chapter list. */
+private const val KEY_STORY_ID = "STORY_ID"
+
+/** Fragment for displaying a story. */
 class StoryFragment : InjectableFragment() {
-  @Inject
-  lateinit var storyFragmentPresenter: StoryFragmentPresenter
+
+  companion object {
+    /**
+     * Creates a new instance of story fragment.
+     * @param storyId Used in TopicController to get correct story information.
+     * @return [StoryFragment]
+     */
+    fun newInstace(storyId: String): StoryFragment {
+      val storyFragment = StoryFragment()
+      val args = Bundle()
+      args.putString(KEY_STORY_ID, storyId)
+      storyFragment.arguments = args
+      return storyFragment
+    }
+  }
+
+  @Inject lateinit var storyFragmentPresenter: StoryFragmentPresenter
 
   override fun onAttach(context: Context?) {
     super.onAttach(context)
     fragmentComponent.inject(this)
   }
 
   override fun onCreateView(inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle?): View? {
-    return storyFragmentPresenter.handleCreateView(inflater, container)
+    val args = checkNotNull(arguments) { "Expected arguments to be passed to StoryFragment" }
+    val storyId = checkNotNull(args.getString(KEY_STORY_ID)) { "Expected storyId to be passed to StoryFragment" }
+    return storyFragmentPresenter.handleCreateView(inflater, container, storyId)
   }
 }