Merge pull request #4034 from hypothesis/tag-suggestions

Tag suggestions

gulpfile.js

@@ -58,9 +58,10 @@ var vendorBundles = {
   jquery: ['jquery'],
   bootstrap: ['bootstrap'],
   raven: ['raven-js'],
+  unorm: ['unorm'],
 };
-var vendorModules = ['jquery', 'bootstrap', 'raven-js'];
-var vendorNoParseModules = ['jquery'];
+var vendorModules = ['jquery', 'bootstrap', 'raven-js', 'unorm'];
+var vendorNoParseModules = ['jquery', 'unorm'];
 
 // Builds the bundles containing vendor JS code
 gulp.task('build-vendor-js', function () {
@@ -252,7 +253,7 @@ function runKarma(baseConfig, opts, done) {
     client: {
       mocha: {
         grep: taskArgs.grep,
-      }
+      },
     },
   };
 

h/assets.ini

@@ -22,6 +22,9 @@ site_js =
 header_js =
   scripts/header.bundle.js
 
+search_js =
+  scripts/unorm.bundle.js
+
 site_css =
   styles/site.css
   styles/icomoon.css

h/static/scripts/controllers/autosuggest-dropdown-controller.js

@@ -84,6 +84,10 @@ class AutosuggestDropdownController extends Controller {
     });
 
     this._setList(configOptions.list);
+
+
+    // Public API
+    this.setHeader = this._setHeader;
   }
 
   update(newState, prevState){
@@ -206,7 +210,7 @@ class AutosuggestDropdownController extends Controller {
 
     if (selection){
       this.options.onSelect(selection);
-      this._toggleSuggestionsVisibility(/*show*/false);
+      this._filterAndToggleVisibility();
       this.setState({
         activeId: null,
       });

h/static/scripts/controllers/search-bar-controller.js

@@ -1,9 +1,16 @@
 'use strict';
 
+var escapeHtml = require('escape-html');
+
 var Controller = require('../base/controller');
 var LozengeController = require('./lozenge-controller');
 var AutosuggestDropdownController = require('./autosuggest-dropdown-controller');
 var SearchTextParser = require('../util/search-text-parser');
+var stringUtil = require('../util/string');
+
+const FACET_TYPE = 'FACET';
+const TAG_TYPE = 'TAG';
+const MAX_SUGGESTIONS = 5;
 
 /**
  * Controller for the search bar.
@@ -15,107 +22,11 @@ class SearchBarController extends Controller {
     this._input = this.refs.searchBarInput;
     this._lozengeContainer = this.refs.searchBarLozenges;
 
-    let explanationList = [
-      {
-        title: 'user:',
-        explanation: 'search by username',
-      },
-      {
-        title: 'tag:',
-        explanation: 'search for annotations with a tag',
-      },
-      {
-        title: 'url:',
-        explanation: 'see all annotations on a page',
-      },
-      {
-        title: 'group:',
-        explanation: 'show annotations created in a group you are a member of',
-      },
-    ];
-
-    var selectFacet = facet => {
-      this._input.value = facet;
-
-      setTimeout(()=>{
-        this._input.focus();
-      }, 0);
-    };
-
 
     var getTrimmedInputValue = () => {
       return this._input.value.trim();
     };
 
-    new AutosuggestDropdownController( this._input, {
-
-      list: explanationList,
-
-      header: 'Narrow your search',
-
-      classNames: {
-        container: 'search-bar__dropdown-menu-container',
-        header: 'search-bar__dropdown-menu-header',
-        list: 'search-bar__dropdown-menu',
-        item: 'search-bar__dropdown-menu-item',
-        activeItem: 'js-search-bar-dropdown-menu-item--active',
-      },
-
-      renderListItem: (listItem)=>{
-
-        let itemContents = `<span class="search-bar__dropdown-menu-title"> ${listItem.title} </span>`;
-
-        if (listItem.explanation){
-          itemContents += `<span class="search-bar__dropdown-menu-explanation"> ${listItem.explanation} </span>`;
-        }
-
-        return itemContents;
-      },
-
-      listFilter: function(list, currentInput){
-
-        currentInput = (currentInput || '').trim();
-
-        return list.filter((item)=>{
-
-          if (!currentInput){
-            return item;
-          } else if (currentInput.indexOf(':') > -1) {
-            return false;
-          }
-          return item.title.toLowerCase().indexOf(currentInput) >= 0;
-
-        }).sort((a,b)=>{
-
-          // this sort functions intention is to
-          // sort partial matches as lower index match
-          // value first. Then let natural sort of the
-          // original list take effect if they have equal
-          // index values or there is no current input value
-
-          if (!currentInput){
-            return 0;
-          }
-
-          let aIndex = a.title.indexOf(currentInput);
-          let bIndex = b.title.indexOf(currentInput);
-
-          if (aIndex > bIndex){
-            return 1;
-          } else if (aIndex < bIndex){
-            return -1;
-          }
-          return 0;
-        });
-      },
-
-      onSelect: (itemSelected)=>{
-        selectFacet(itemSelected.title);
-      },
-
-    });
-
-
     /**
      * Insert a hidden <input> with an empty value into the search <form>.
      *
@@ -207,12 +118,184 @@ class SearchBarController extends Controller {
       }
     };
 
+
     this._hiddenInput = insertHiddenInput(this.refs.searchBarForm);
 
+    let explanationList = [
+      {
+        matchOn: 'user',
+        title: 'user:',
+        explanation: 'search by username',
+      },
+      {
+        matchOn: 'tag',
+        title: 'tag:',
+        explanation: 'search for annotations with a tag',
+      },
+      {
+        matchOn: 'url',
+        title: 'url:',
+        explanation: 'see all annotations on a page',
+      },
+      {
+        matchOn: 'group',
+        title: 'group:',
+        explanation: 'show annotations created in a group you are a member of',
+      },
+    ].map((item)=>{ return Object.assign(item, { type: FACET_TYPE}); });
+
+    // tagSuggestions are made available by the scoped template data.
+    // see search.html.jinja2 for definition
+    const tagSuggestionJSON = document.querySelector('.js-tag-suggestions');
+    let tagSuggestions = [];
+
+    if(tagSuggestionJSON){
+      try{
+        tagSuggestions = JSON.parse(tagSuggestionJSON.innerHTML.trim());
+      }catch(e){
+        console.error('Could not parse .js-tag-suggestions JSON content', e);
+      }
+    }
+
+    let tagsList = ((tagSuggestions) || []).map((item)=>{
+      return Object.assign(item, {
+        type: TAG_TYPE,
+        title: escapeHtml(item.tag), // make safe
+        matchOn: stringUtil.fold(stringUtil.normalize(item.tag)),
+        usageCount: item.count || 0,
+      });
+    });
+
+
+    this._suggestionsHandler = new AutosuggestDropdownController( this._input, {
+
+      list: explanationList.concat(tagsList),
+
+      header: 'Narrow your search',
+
+      classNames: {
+        container: 'search-bar__dropdown-menu-container',
+        header: 'search-bar__dropdown-menu-header',
+        list: 'search-bar__dropdown-menu',
+        item: 'search-bar__dropdown-menu-item',
+        activeItem: 'js-search-bar-dropdown-menu-item--active',
+      },
+
+      renderListItem: (listItem)=>{
+
+        let itemContents = `<span class="search-bar__dropdown-menu-title"> ${listItem.title} </span>`;
+
+        if (listItem.explanation){
+          itemContents += `<span class="search-bar__dropdown-menu-explanation"> ${listItem.explanation} </span>`;
+        }
+
+        return itemContents;
+      },
+
+      listFilter: (list, currentInput)=>{
+
+        currentInput = (currentInput || '').trim();
+
+        let typeFilter = currentInput.indexOf('tag:') === 0 ? TAG_TYPE : FACET_TYPE;
+        let inputFilter = stringUtil.fold(stringUtil.normalize(currentInput));
+
+        if(typeFilter === TAG_TYPE){
+          inputFilter = inputFilter.substr(/*'tag:' len*/4);
+
+          // remove the initial quote for comparisons if it exists
+          if(inputFilter[0] === '\'' || inputFilter[0] === '"'){
+            inputFilter = inputFilter.substr(1);
+          }
+        }
+
+        if(this.state.suggestionsType !== typeFilter){
+          this.setState({
+            suggestionsType: typeFilter,
+          });
+        }
+
+        return list.filter((item)=>{
+          return item.type === typeFilter && item.matchOn.toLowerCase().indexOf(inputFilter.toLowerCase()) >= 0;
+        }).sort((a,b)=>{
+
+          // this sort functions intention is to
+          // sort partial matches as lower index match
+          // value first. Then let natural sort of the
+          // original list take effect if they have equal
+          // index values or there is no current input value
+
+          if (inputFilter){
+            let aIndex = a.matchOn.indexOf(inputFilter);
+            let bIndex = b.matchOn.indexOf(inputFilter);
+
+            // match score
+            if (aIndex > bIndex){
+              return 1;
+            } else if (aIndex < bIndex){
+              return -1;
+            }
+          }
+
+
+          // If we are filtering on tags, we need to arrange
+          // by popularity
+          if(typeFilter === TAG_TYPE){
+            if(a.usageCount > b.usageCount){
+              return -1;
+            }else if(a.usageCount < b.usageCount) {
+              return 1;
+            }
+          }
+
+          return 0;
+
+        }).slice(0, MAX_SUGGESTIONS);
+      },
+
+      onSelect: (itemSelected)=>{
+
+        if (itemSelected.type === TAG_TYPE){
+          let tagSelection = itemSelected.title;
+
+          // wrap multi word phrases with quotes to keep
+          // autosuggestions consistent with what user needs to do
+          if(tagSelection.indexOf(' ') > -1){
+            tagSelection = `"${tagSelection}"`;
+          }
+
+          addLozenge('tag:' + tagSelection);
+          this._input.value = '';
+        } else {
+          this._input.value = itemSelected.title;
+          setTimeout(()=>{
+            this._input.focus();
+          }, 0);
+        }
+        updateHiddenInput();
+      },
+
+    });
+
     this._input.addEventListener('keydown', onInputKeyDown);
     this._input.addEventListener('input', updateHiddenInput);
     lozengifyInput();
   }
+
+  update(newState, prevState){
+
+    if(!this._suggestionsHandler){
+      return;
+    }
+
+    if(newState.suggestionsType !== prevState.suggestionsType){
+      if(newState.suggestionsType === TAG_TYPE){
+        this._suggestionsHandler.setHeader('Popular tags');
+      }else {
+        this._suggestionsHandler.setHeader('Narrow your search');
+      }
+    }
+
+  }
 }
 
 module.exports = SearchBarController;

h/static/scripts/tests/controllers/autosuggest-dropdown-controller-test.js

@@ -341,8 +341,6 @@ describe('AutosuggestDropdownController', function () {
           assert.propertyVal(selectedItem, 'title', 'tag:');
           assert.propertyVal(selectedItem, 'explanation', 'search for annotations with a tag');
 
-          assert.isFalse(isSuggestionContainerVisible(), 'post select hide');
-
           assert.isFalse(form.onsubmit.called, 'should not submit the form on enter');
 
           done();