refactor query suggestions guide

Author: aallam

guide/guides/src/main/AndroidManifest.xml

@@ -34,7 +34,7 @@
             android:parentActivityName=".directory.DirectoryActivity" />
 
         <activity
-            android:name=".querysuggestion.QuerySuggestionGuide"
+            android:name=".querysuggestion.QuerySuggestionActivity"
             android:parentActivityName=".directory.DirectoryActivity" />
 
     </application>

guide/guides/src/main/kotlin/com/algolia/instantsearch/guides/directory/Directory.kt

@@ -2,12 +2,12 @@ package com.algolia.instantsearch.guides.directory
 
 import com.algolia.instantsearch.guides.gettingstarted.GettingStartedGuide
 import com.algolia.instantsearch.guides.places.PlacesActivity
-import com.algolia.instantsearch.guides.querysuggestion.QuerySuggestionGuide
+import com.algolia.instantsearch.guides.querysuggestion.QuerySuggestionActivity
 import com.algolia.search.model.ObjectID
 
 
 val guides = mapOf(
     ObjectID("guide_getting_started") to GettingStartedGuide::class,
     ObjectID("guide_places") to PlacesActivity::class,
-    ObjectID("guide_query_suggestion") to QuerySuggestionGuide::class
+    ObjectID("guide_query_suggestion") to QuerySuggestionActivity::class
 )

guide/guides/src/main/kotlin/com/algolia/instantsearch/guides/querysuggestion/QuerySuggestionGuide.kt renamed to guide/guides/src/main/kotlin/com/algolia/instantsearch/guides/querysuggestion/QuerySuggestionActivity.kt

@@ -13,7 +13,7 @@ import com.algolia.instantsearch.guides.querysuggestion.product.ProductFragment
 import com.algolia.instantsearch.guides.querysuggestion.suggestion.SuggestionFragment
 import com.algolia.instantsearch.searchbox.connectView
 
-class QuerySuggestionGuide : AppCompatActivity() {
+class QuerySuggestionActivity : AppCompatActivity() {
 
     private val viewModel by viewModels<QuerySuggestionViewModel>()
     private val connection = ConnectionHandler()
@@ -32,10 +32,9 @@ class QuerySuggestionGuide : AppCompatActivity() {
         }
 
         // Observe suggestions
-        viewModel.suggestions.observe(this) {
-            searchBoxView.setText(it.query, true)
-        }
+        viewModel.suggestions.observe(this) { searchBoxView.setText(it.query, true) }
 
+        // Show products view
         showProducts()
     }
 

guide/guides/src/main/kotlin/com/algolia/instantsearch/guides/querysuggestion/QuerySuggestionViewModel.kt

@@ -2,6 +2,7 @@ package com.algolia.instantsearch.guides.querysuggestion
 
 import androidx.lifecycle.MutableLiveData
 import androidx.lifecycle.ViewModel
+import com.algolia.instantsearch.core.connection.ConnectionHandler
 import com.algolia.instantsearch.guides.querysuggestion.suggestion.Suggestion
 import com.algolia.instantsearch.searchbox.SearchBoxConnector
 import com.algolia.instantsearch.searcher.hits.addHitsSearcher
@@ -23,11 +24,13 @@ class QuerySuggestionViewModel : ViewModel() {
     val productSearcher = multiSearcher.addHitsSearcher(indexName = IndexName("instant_search"))
     val suggestionSearcher = multiSearcher.addHitsSearcher(indexName = IndexName("instantsearch_query_suggestions"))
     val searchBox = SearchBoxConnector(multiSearcher)
+    private val connection = ConnectionHandler(searchBox)
+
     val suggestions = MutableLiveData<Suggestion>()
 
     override fun onCleared() {
         multiSearcher.cancel()
-        searchBox.disconnect()
+        connection.clear()
         client.close()
     }
 }

guide/guides/src/main/kotlin/com/algolia/instantsearch/guides/querysuggestion/extension/RecyclerView.kt

@@ -1,6 +1,8 @@
 package com.algolia.instantsearch.guides.querysuggestion.extension
 
+import android.content.Context
 import android.view.View
+import android.view.ViewGroup
 import androidx.recyclerview.widget.LinearLayoutManager
 import androidx.recyclerview.widget.RecyclerView
 import com.algolia.instantsearch.android.list.autoScrollToStart
@@ -12,3 +14,10 @@ internal fun RecyclerView.configure(recyclerViewAdapter: RecyclerView.Adapter<*>
     itemAnimator = null
     autoScrollToStart(recyclerViewAdapter)
 }
+
+internal fun createRecyclerView(context: Context) = RecyclerView(context).apply {
+    layoutParams = ViewGroup.LayoutParams(
+        ViewGroup.LayoutParams.MATCH_PARENT,
+        ViewGroup.LayoutParams.MATCH_PARENT
+    )
+}

guide/guides/src/main/kotlin/com/algolia/instantsearch/guides/querysuggestion/product/ProductAdapter.kt

@@ -1,37 +1,45 @@
 package com.algolia.instantsearch.guides.querysuggestion.product
 
-import android.view.LayoutInflater
+import android.view.View
 import android.view.ViewGroup
+import android.widget.TextView
 import androidx.recyclerview.widget.DiffUtil
 import androidx.recyclerview.widget.ListAdapter
+import androidx.recyclerview.widget.RecyclerView
+import com.algolia.instantsearch.android.highlighting.toSpannedString
+import com.algolia.instantsearch.android.inflate
 import com.algolia.instantsearch.core.hits.HitsView
-import com.algolia.instantsearch.guides.databinding.ListItemLargeBinding
+import com.algolia.instantsearch.guides.R
+import com.algolia.instantsearch.guides.querysuggestion.product.ProductAdapter.ProductViewHolder
+import com.bumptech.glide.Glide
 
-class ProductAdapter : ListAdapter<Product, ProductViewHolder>(ProductAdapter),
-    HitsView<Product> {
+class ProductAdapter : ListAdapter<Product, ProductViewHolder>(ProductAdapter), HitsView<Product> {
 
-    override fun onCreateViewHolder(parent: ViewGroup, viewType: Int): ProductViewHolder {
-        return ProductViewHolder(
-            ListItemLargeBinding.inflate(LayoutInflater.from(parent.context), parent, false)
-        )
-    }
+    override fun onCreateViewHolder(parent: ViewGroup, viewType: Int) =
+        ProductViewHolder(parent.inflate(R.layout.list_item_large))
 
-    override fun onBindViewHolder(holder: ProductViewHolder, position: Int) {
+    override fun onBindViewHolder(holder: ProductViewHolder, position: Int) =
         holder.bind(getItem(position))
-    }
 
-    override fun setHits(hits: List<Product>) {
-        submitList(hits)
-    }
+    override fun setHits(hits: List<Product>) = submitList(hits)
 
-    companion object : DiffUtil.ItemCallback<Product>() {
+    class ProductViewHolder(private val view: View) : RecyclerView.ViewHolder(view) {
 
-        override fun areItemsTheSame(oldItem: Product, newItem: Product): Boolean {
-            return oldItem.objectID == newItem.objectID
+        fun bind(item: Product) {
+            view.findViewById<TextView>(R.id.itemTitle).text =
+                item.highlightedName?.toSpannedString() ?: item.name
+            view.findViewById<TextView>(R.id.itemSubtitle).text = item.price.toString()
+            Glide
+                .with(view.context)
+                .load(item.image)
+                .into(view.findViewById(R.id.itemImage))
         }
+    }
 
-        override fun areContentsTheSame(oldItem: Product, newItem: Product): Boolean {
-            return oldItem == newItem
-        }
+    companion object : DiffUtil.ItemCallback<Product>() {
+        override fun areItemsTheSame(oldItem: Product, newItem: Product) =
+            oldItem.objectID == newItem.objectID
+
+        override fun areContentsTheSame(oldItem: Product, newItem: Product) = oldItem == newItem
     }
 }

guide/guides/src/main/kotlin/com/algolia/instantsearch/guides/querysuggestion/product/ProductViewHolder.kt

@@ -1,39 +1,44 @@
 package com.algolia.instantsearch.guides.querysuggestion.suggestion
 
-import android.view.LayoutInflater
+import android.view.View
 import android.view.ViewGroup
+import android.widget.TextView
 import androidx.recyclerview.widget.DiffUtil
 import androidx.recyclerview.widget.ListAdapter
+import androidx.recyclerview.widget.RecyclerView
+import com.algolia.instantsearch.android.highlighting.toSpannedString
+import com.algolia.instantsearch.android.inflate
 import com.algolia.instantsearch.core.hits.HitsView
-import com.algolia.instantsearch.guides.databinding.ListItemSuggestionBinding
+import com.algolia.instantsearch.guides.R
+import com.algolia.instantsearch.guides.querysuggestion.suggestion.SuggestionAdapter.SuggestionViewHolder
 
-class SuggestionAdapter(private val onSuggestionClick: ((Suggestion) -> Unit)? = null) :
+class SuggestionAdapter(private val onSuggestionClick: ((Suggestion) -> Unit)) :
     ListAdapter<Suggestion, SuggestionViewHolder>(SuggestionAdapter),
     HitsView<Suggestion> {
 
-    override fun onCreateViewHolder(parent: ViewGroup, viewType: Int): SuggestionViewHolder {
-        return SuggestionViewHolder(
-            ListItemSuggestionBinding.inflate(LayoutInflater.from(parent.context), parent, false)
-        )
-    }
+    override fun onCreateViewHolder(parent: ViewGroup, viewType: Int) =
+        SuggestionViewHolder(parent.inflate(R.layout.list_item_suggestion))
 
     override fun onBindViewHolder(holder: SuggestionViewHolder, position: Int) {
         val item = getItem(position)
         holder.bind(item, onSuggestionClick)
     }
 
-    override fun setHits(hits: List<Suggestion>) {
-        submitList(hits)
-    }
+    override fun setHits(hits: List<Suggestion>) = submitList(hits)
 
-    companion object : DiffUtil.ItemCallback<Suggestion>() {
+    class SuggestionViewHolder(private val view: View) : RecyclerView.ViewHolder(view) {
 
-        override fun areItemsTheSame(oldItem: Suggestion, newItem: Suggestion): Boolean {
-            return oldItem.objectID == newItem.objectID
+        fun bind(item: Suggestion, onClick: ((Suggestion) -> Unit)) {
+            view.setOnClickListener { onClick(item) }
+            view.findViewById<TextView>(R.id.itemName).text = item.highlightedQuery?.toSpannedString() ?: item.query
         }
+    }
 
-        override fun areContentsTheSame(oldItem: Suggestion, newItem: Suggestion): Boolean {
-            return oldItem == newItem
-        }
+    companion object : DiffUtil.ItemCallback<Suggestion>() {
+        override fun areItemsTheSame(oldItem: Suggestion, newItem: Suggestion) =
+            oldItem.objectID == newItem.objectID
+
+        override fun areContentsTheSame(oldItem: Suggestion, newItem: Suggestion): Boolean =
+            oldItem == newItem
     }
 }

guide/guides/src/main/kotlin/com/algolia/instantsearch/guides/querysuggestion/suggestion/SuggestionAdapter.kt

@@ -20,7 +20,10 @@ class SuggestionFragment : Fragment(R.layout.fragment_items) {
     override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
         super.onViewCreated(view, savedInstanceState)
         // Configure suggestions view
-        val suggestionAdapter = SuggestionAdapter { viewModel.suggestions.value = it }
+        val suggestionAdapter = SuggestionAdapter {
+            // On suggestion click, update the
+            viewModel.suggestions.value = it
+        }
         view.findViewById<RecyclerView>(R.id.items).configure(suggestionAdapter)
         connection += viewModel.suggestionSearcher.connectHitsView(suggestionAdapter) {
             it.hits.deserialize(Suggestion.serializer())

guide/guides/src/main/kotlin/com/algolia/instantsearch/guides/querysuggestion/suggestion/SuggestionFragment.kt

@@ -1,7 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
 <androidx.recyclerview.widget.RecyclerView xmlns:android="http://schemas.android.com/apk/res/android"
-    xmlns:tools="http://schemas.android.com/tools"
     android:id="@+id/items"
     android:layout_width="match_parent"
-    android:layout_height="match_parent"
-    tools:listitem="@layout/list_item_large" />
+    android:layout_height="match_parent" />