perform basic weighting of results

Author: sethladd

lib/resources/script.js

@@ -59,26 +59,66 @@ function shiftWindow() {
 }
 
 function initSearch() {
-  var index;  // the JSON data
+  var searchIndex;  // the JSON data
+
+  var weights = {
+    'library' : 2,
+    'class' : 2,
+    'typedef' : 3,
+    'method' : 4,
+    'accessor' : 4,
+    'operator' : 4,
+    'property' : 4,
+    'constructor' : 4
+  };
 
   function findMatches(q, cb) {
-    var matches, substringRegex;
-
-    // an array that will be populated with substring matches
-    matches = [];
+    var allMatches = []; // ist of matches
 
-    // regex used to determine if a string contains the substring `q`
-    substrRegex = new RegExp(q, 'i');
+    function score(element, num) {
+      var weightFactor = weights[element.type] || 4;
+      return {e: element, score: (num / weightFactor) >> 0};
+    }
 
     // iterate through the pool of strings and for any string that
     // contains the substring `q`, add it to the `matches` array
-    $.each(index, function(i, element) {
-      if (substrRegex.test(element.name)) {
-        matches.push(element);
+    $.each(searchIndex, function(i, element) {
+      // TODO: prefer matches in the current library
+      // TODO: help prefer a named constructor
+
+      var lowerName = element.name.toLowerCase();
+      var lowerQ = q.toLowerCase();
+
+      if (element.name === q) {
+        // exact match, maximum score
+        allMatches.push(score(element, 1000));
+      } else if (lowerName === lowerQ) {
+        // case-insensitive exact match
+        allMatches.push(score(element, 900));
+      } else if (element.name.indexOf(q) === 0) {
+        // starts with
+        allMatches.push(score(element, 750));
+      } else if (lowerName.indexOf(lowerQ) === 0) {
+        // case-insensitive starts with
+        allMatches.push(score(element, 650));
+      } else if (element.name.indexOf(q) >= 0) {
+        // contains
+        allMatches.push(score(element, 500));
+      } else if (lowerName.indexOf(lowerQ) >= 0) {
+        allMatches.push(score(element, 400));
       }
     });
 
-    cb(matches);
+    allMatches.sort(function(a, b) {
+      return b.score - a.score;
+    });
+
+    var sortedMatches = [];
+    for (var i = 0; i < allMatches.length; i++) {
+      sortedMatches.push(allMatches[i].e);
+    }
+
+    cb(sortedMatches);
   };
 
   function initTypeahead() {
@@ -119,7 +159,7 @@ function initSearch() {
   var jsonReq = new XMLHttpRequest();
   jsonReq.open('GET', 'index.json', true);
   jsonReq.addEventListener('load', function() {
-    index = JSON.parse(jsonReq.responseText);
+    searchIndex = JSON.parse(jsonReq.responseText);
     initTypeahead();
   });
   jsonReq.send();