HTML Search: Add test, refactoring to make that possible

Author: wlach

sphinx/themes/basic/static/searchtools.js

@@ -198,7 +198,8 @@ const Search = {
     if (Search._queued_query !== null) {
       const query = Search._queued_query;
       Search._queued_query = null;
-      Search.query(query);
+      let { results, searchTerms, highlightTerms } = Search.query(query);
+      _displayNextItem(results, results.length, searchTerms, highlightTerms);
     }
   },
 
@@ -246,8 +247,12 @@ const Search = {
     Search.startPulse();
 
     // index already loaded, the browser was quick!
-    if (Search.hasIndex()) Search.query(query);
-    else Search.deferQuery(query);
+    if (Search.hasIndex()) { 
+      let { results, searchTerms, highlightTerms } = Search.query(query);
+      _displayNextItem(results, results.length, searchTerms, highlightTerms);
+    } else {
+      Search.deferQuery(query);
+    }
   },
 
   /**
@@ -380,8 +385,7 @@ const Search = {
     //Search.lastresults = results.slice();  // a copy
     // console.info("search results:", Search.lastresults);
 
-    // print the results
-    _displayNextItem(results, results.length, searchTerms, highlightTerms);
+    return { results, searchTerms, highlightTerms };
   },
 
   /**
@@ -476,6 +480,7 @@ const Search = {
         { files: terms[word], score: Scorer.term },
         { files: titleTerms[word], score: Scorer.title },
       ];
+
       // add support for partial matches
       if (word.length > 2) {
         const escapedWord = _escapeRegExp(word);

tests/js/documentation_options.js

@@ -1 +1,9 @@
 const DOCUMENTATION_OPTIONS = {};
+
+// stub Stemmer / stopWords
+function Stemmer() {
+    this.stemWord = function (word) {
+        return word;
+    }
+};
+let stopwords = [];

tests/js/searchtools.js

@@ -56,6 +56,31 @@ describe('Basic html theme search', function() {
 
   });
 
+  describe('query', function() {
+    it("should not duplicate on title and content", function() {
+      index = {
+        alltitles: {
+          'Main Page': [[0, 'main-page']],
+        },
+        docnames:["index"],
+        filenames:["index.rst"],
+        indexentries:{},
+        objects:{},
+        objtypes: {},
+        objnames: {},
+        terms:{main:0, page:0},
+        titles:["Main Page"],
+        titleterms:{ main:0, page:0 }
+      }
+      Search.setIndex(index);
+      let { results } = Search.query('main page');
+      // should only be one result
+      expect(results).toEqual([
+        [ 'index', 'Main Page', '', null, 100, 'index.rst' ],
+      ]);
+    });
+  })
+
 });
 
 describe("htmlToText", function() {