Improve search results for terms like “restModel”

This improves the search results for queries such as restModel, QueryLogic, and DefineMap. This is done by:

1) Concatenating the module’s name (e.g. `can-define/map/map` is converted to `definemapmap`) and indexing the result
2) Giving preference to packages over other pages/results

Fixes #499

Author: Chasen Le Hara

static/search-logic.js

@@ -13,14 +13,18 @@ module.exports = {
 
 			this.ref('name');
 			this.field('title');
+			this.field('concatenatedName');
 			this.field('description');
+			this.field('isPackage');
 			this.field('name');
 			this.field('url');
 
 			items.forEach(function(item) {
 				if (!item.title) {
 					item.title = item.name;
 				}
+				item.concatenatedName = item.name.replace('can-', '').replace(/-/g, '').replace(/\//g, '');
+				item.isPackage = (item.collection !== undefined).toString();
 				this.add(item);
 			}.bind(this));
 		});
@@ -47,9 +51,16 @@ module.exports = {
 				q.term('can-' + searchTerm, { boost: 12 });
 
 				// look for terms that match the beginning or end of this query
+				q.term(searchTerm, { wildcard: lunr.Query.wildcard.LEADING | lunr.Query.wildcard.TRAILING });
+
 				// look in the title field specifically to boost matches in it
 				q.term(searchTerm, { fields: ['title'], wildcard: lunr.Query.wildcard.LEADING | lunr.Query.wildcard.TRAILING });
-				q.term(searchTerm, { wildcard: lunr.Query.wildcard.LEADING | lunr.Query.wildcard.TRAILING });
+
+				// support searches for strings like “restModel”
+				q.term(searchTerm, { fields: ['concatenatedName'], wildcard: lunr.Query.wildcard.TRAILING });
+
+				// favor modules
+				q.term('true', { boost: 6, fields: ['isPackage'] });
 			}
 
 			// look for matches in any of the fields and apply a medium positive boost

static/search.js

@@ -4,7 +4,7 @@ var Control = require("can-control");
 var LoadingBar = require('./loading-bar');
 var searchResultsRenderer = require("../templates/search-results.stache!steal-stache");
 var joinURIs = require("can-util/js/join-uris/");
-var currentIndexVersion = 4;// Bump this whenever the index code is changed
+var currentIndexVersion = 5;// Bump this whenever the index code is changed
 
 var Search = Control.extend({
 

test/search.js

@@ -141,6 +141,46 @@ QUnit.test('Search for “define/map”', function(assert) {
   });
 });
 
+QUnit.test('Search for “restModel”', function(assert) {
+  var done = assert.async();
+  setUpSearchControl.then(function() {
+    var results = searchLogic.search('restModel');
+    assert.equal(results.length > 1, true, 'got more than 1 result');
+    assert.equal(indexOfPageInResults('can-rest-model', results), 0, 'first result is the can-rest-model page');
+    done();
+  });
+});
+
+QUnit.test('Search for “QueryLogic”', function(assert) {
+  var done = assert.async();
+  setUpSearchControl.then(function() {
+    var results = searchLogic.search('QueryLogic');
+    assert.equal(results.length > 1, true, 'got more than 1 result');
+    assert.equal(indexOfPageInResults('can-query-logic', results), 0, 'first result is the can-query-logic page');
+    done();
+  });
+});
+
+QUnit.test('Search for “DefineList”', function(assert) {
+  var done = assert.async();
+  setUpSearchControl.then(function() {
+    var results = searchLogic.search('DefineList');
+    assert.equal(results.length > 1, true, 'got more than 1 result');
+    assert.equal(indexOfPageInResults('can-define/list/list', results), 0, 'first result is the can-define/list/list page');
+    done();
+  });
+});
+
+QUnit.test('Search for “DefineMap”', function(assert) {
+  var done = assert.async();
+  setUpSearchControl.then(function() {
+    var results = searchLogic.search('DefineMap');
+    assert.equal(results.length > 1, true, 'got more than 1 result');
+    assert.equal(indexOfPageInResults('can-define/map/map', results), 0, 'first result is the can-define/map/map page');
+    done();
+  });
+});
+
 QUnit.test('Speed while searching for can-*', function(assert) {
   var done = assert.async();
   setUpSearchControl.then(function() {