Rename SearchInterpreter to Searcher

cozydev-pink · Feb 23, 2025 · c0c66d1 · c0c66d1
1 parent 8921e13
commit c0c66d1
Show file tree

Hide file tree

Showing 6 changed files with 13 additions and 13 deletions.
diff --git a/...zydev/protosearch/SearchInterpreter.scala → ...a/pink/cozydev/protosearch/Searcher.scala b/...zydev/protosearch/SearchInterpreter.scala → ...a/pink/cozydev/protosearch/Searcher.scala
@@ -20,7 +20,7 @@ import pink.cozydev.protosearch.highlight.FirstMatchHighlighter
 import pink.cozydev.protosearch.highlight.FragmentFormatter
 import pink.cozydev.protosearch.internal.IndexSearcher
 
-final case class SearchInterpreter(
+final case class Searcher(
     multiIndex: MultiIndex,
     highlighter: FirstMatchHighlighter,
 ) {
@@ -64,10 +64,10 @@ final case class SearchInterpreter(
     }
   }
 }
-object SearchInterpreter {
+object Searcher {
   private val defaultHighlighter =
     FirstMatchHighlighter(FragmentFormatter(100, "<b>", "</b>"))
 
-  def default(index: MultiIndex): SearchInterpreter =
-    SearchInterpreter(index, defaultHighlighter)
+  def default(index: MultiIndex): Searcher =
+    Searcher(index, defaultHighlighter)
 }
diff --git a/.../protosearch/SearchInterpreterSuite.scala → ...k/cozydev/protosearch/SearcherSuite.scala b/.../protosearch/SearchInterpreterSuite.scala → ...k/cozydev/protosearch/SearcherSuite.scala
@@ -19,7 +19,7 @@ package pink.cozydev.protosearch
 import pink.cozydev.protosearch.analysis.{Analyzer, QueryAnalyzer}
 import fixtures.BookIndex
 
-class SearchInterpreterSuite extends munit.FunSuite {
+class SearcherSuite extends munit.FunSuite {
   import BookIndex._
 
   val analyzer = Analyzer.default.withLowerCasing
@@ -32,7 +32,7 @@ class SearchInterpreterSuite extends munit.FunSuite {
 
   val qAnalyzer = QueryAnalyzer("title", ("title", analyzer), ("author", analyzer))
 
-  val searcher = SearchInterpreter.default(index)
+  val searcher = Searcher.default(index)
 
   def search(q: String): Either[String, List[Book]] = {
     val req = SearchRequest.default(q)

diff --git a/core/src/test/scala/pink/cozydev/protosearch/WriteReadLoopSuite.scala b/core/src/test/scala/pink/cozydev/protosearch/WriteReadLoopSuite.scala
@@ -35,7 +35,7 @@ class WriteReadLoopSuite extends munit.FunSuite {
     val indexBytes = MultiIndex.codec.encode(index).map(_.bytes)
 
     def search(index: MultiIndex)(qs: String): Either[String, List[Book]] = {
-      val searcher = SearchInterpreter.default(index)
+      val searcher = Searcher.default(index)
       val req = SearchRequest.default(qs)
       val result = searcher.search(req)
       result.toEither.map(hits => hits.map(h => allBooks(h.id)))

diff --git a/docs/02-tutorial/02-querying.md b/docs/02-tutorial/02-querying.md
@@ -23,12 +23,12 @@ val index = IndexBuilder.of[Book](
 
 ## Searching
 
-In order to search our index with various queries we need to setup a `SearchInterpreter`.
+In order to search our index with various queries we need to setup a `Searcher`.
 
 ```scala mdoc:silent
-import pink.cozydev.protosearch.SearchInterpreter
+import pink.cozydev.protosearch.Searcher
 
-val searcher = SearchInterpreter.default(index)
+val searcher = Searcher.default(index)
 ```
 
 And now we can define our search function

diff --git a/jsinterop/src/main/scala/pink/cozydev/protosearch/JsInterop.scala b/jsinterop/src/main/scala/pink/cozydev/protosearch/JsInterop.scala
@@ -35,7 +35,7 @@ class Querier(val mIndex: MultiIndex) {
   import js.JSConverters._
   val highlighter =
     FirstMatchHighlighter(FragmentFormatter(150, "<mark>", "</mark>"))
-  val searcher = SearchInterpreter(mIndex, highlighter)
+  val searcher = Searcher(mIndex, highlighter)
   val highlightFields = List("title", "body")
   val resultFields = List("body", "path", "title")
 

diff --git a/scaladoc/src/test/scala/pink/cozydev/protosearch/scaladoc/ScaladocSuite.scala b/scaladoc/src/test/scala/pink/cozydev/protosearch/scaladoc/ScaladocSuite.scala
@@ -16,7 +16,7 @@
 
 package pink.cozydev.protosearch.scaladoc
 import munit.FunSuite
-import pink.cozydev.protosearch.{SearchInterpreter, SearchRequest}
+import pink.cozydev.protosearch.{Searcher, SearchRequest}
 
 class ScaladocSuite extends FunSuite {
 
@@ -119,7 +119,7 @@ final case class IndexBuilder[A] private (
   def searchScaladoc(source: String, queries: List[String]): List[ScaladocInfo] = {
     val scaladocInfoList = ParseScaladoc.parseAndExtractInfo(source)
     val index = ScaladocIndexer.indexBuilder.fromList(scaladocInfoList)
-    val searcher = SearchInterpreter.default(index)
+    val searcher = Searcher.default(index)
     def search(q: String): List[ScaladocInfo] = {
       val req = SearchRequest.default(q)
       val searchResults = searcher.search(req)