Add reusable project_selector component

This commit adds a resuable UI component that allows a user to search
for a project name, shows the search results, and allows the user to
select one or more projects.  This component communicates with its
parent using props and events.

This component was originally created for use in the EE-specific
"Operations Dashboard" page, but it is applicable for CE use cases as
well, and so was added as a CE shared component.

In addition, some logic was extracted from the frequent_items_list_item
component into shared filters to avoid logic duplication.

5 files changed, 365 insertions, 10 deletions

diff --git a/spec/frontend/lib/utils/text_utility_spec.js b/spec/frontend/lib/utils/text_utility_spec.js
index 0a266b19ea5..3f331055a32 100644
--- a/spec/frontend/lib/utils/text_utility_spec.js
+++ b/spec/frontend/lib/utils/text_utility_spec.js
@@ -151,4 +151,31 @@ describe('text_utility', () => {
       );
     });
   });
+
+  describe('truncateNamespace', () => {
+    it(`should return the root namespace if the namespace only includes one level`, () => {
+      expect(textUtils.truncateNamespace('a / b')).toBe('a');
+    });
+
+    it(`should return the first 2 namespaces if the namespace inlcudes exactly 2 levels`, () => {
+      expect(textUtils.truncateNamespace('a / b / c')).toBe('a / b');
+    });
+
+    it(`should return the first and last namespaces, separated by "...", if the namespace inlcudes more than 2 levels`, () => {
+      expect(textUtils.truncateNamespace('a / b / c / d')).toBe('a / ... / c');
+      expect(textUtils.truncateNamespace('a / b / c / d / e / f / g / h / i')).toBe('a / ... / h');
+    });
+
+    it(`should return an empty string for invalid inputs`, () => {
+      [undefined, null, 4, {}, true, new Date()].forEach(input => {
+        expect(textUtils.truncateNamespace(input)).toBe('');
+      });
+    });
+
+    it(`should not alter strings that aren't formatted as namespaces`, () => {
+      ['', ' ', '\t', 'a', 'a \\ b'].forEach(input => {
+        expect(textUtils.truncateNamespace(input)).toBe(input);
+      });
+    });
+  });
 });
diff --git a/spec/javascripts/frequent_items/components/frequent_items_list_item_spec.js b/spec/javascripts/frequent_items/components/frequent_items_list_item_spec.js
index 7deed985219..92554bd9a69 100644
--- a/spec/javascripts/frequent_items/components/frequent_items_list_item_spec.js
+++ b/spec/javascripts/frequent_items/components/frequent_items_list_item_spec.js
@@ -1,6 +1,7 @@
 import Vue from 'vue';
 import frequentItemsListItemComponent from '~/frequent_items/components/frequent_items_list_item.vue';
 import mountComponent from 'spec/helpers/vue_mount_component_helper';
+import { trimText } from 'spec/helpers/vue_component_helper';
 import { mockProject } from '../mock_data'; // can also use 'mockGroup', but not useful to test here
 
 const createComponent = () => {
@@ -40,30 +41,58 @@ describe('FrequentItemsListItemComponent', () => {
     });
 
     describe('highlightedItemName', () => {
-      it('should enclose part of project name in <b> & </b> which matches with `matcher` prop', () => {
+      it('should enclose part of project name in <b> & </b> which matches with `matcher` prop', done => {
         vm.matcher = 'lab';
 
-        expect(vm.highlightedItemName).toContain('<b>Lab</b>');
+        vm.$nextTick()
+          .then(() => {
+            expect(vm.$el.querySelector('.js-frequent-items-item-title').innerHTML).toContain(
+              '<b>L</b><b>a</b><b>b</b>',
+            );
+          })
+          .then(done)
+          .catch(done.fail);
       });
 
-      it('should return project name as it is if `matcher` is not available', () => {
+      it('should return project name as it is if `matcher` is not available', done => {
         vm.matcher = null;
 
-        expect(vm.highlightedItemName).toBe(mockProject.name);
+        vm.$nextTick()
+          .then(() => {
+            expect(vm.$el.querySelector('.js-frequent-items-item-title').innerHTML).toBe(
+              mockProject.name,
+            );
+          })
+          .then(done)
+          .catch(done.fail);
       });
     });
 
     describe('truncatedNamespace', () => {
-      it('should truncate project name from namespace string', () => {
+      it('should truncate project name from namespace string', done => {
         vm.namespace = 'platform / nokia-3310';
 
-        expect(vm.truncatedNamespace).toBe('platform');
+        vm.$nextTick()
+          .then(() => {
+            expect(
+              trimText(vm.$el.querySelector('.js-frequent-items-item-namespace').innerHTML),
+            ).toBe('platform');
+          })
+          .then(done)
+          .catch(done.fail);
       });
 
-      it('should truncate namespace string from the middle if it includes more than two groups in path', () => {
+      it('should truncate namespace string from the middle if it includes more than two groups in path', done => {
         vm.namespace = 'platform / hardware / broadcom / Wifi Group / Mobile Chipset / nokia-3310';
 
-        expect(vm.truncatedNamespace).toBe('platform / ... / Mobile Chipset');
+        vm.$nextTick()
+          .then(() => {
+            expect(
+              trimText(vm.$el.querySelector('.js-frequent-items-item-namespace').innerHTML),
+            ).toBe('platform / ... / Mobile Chipset');
+          })
+          .then(done)
+          .catch(done.fail);
       });
     });
   });
@@ -74,8 +103,8 @@ describe('FrequentItemsListItemComponent', () => {
       expect(vm.$el.querySelectorAll('a').length).toBe(1);
       expect(vm.$el.querySelectorAll('.frequent-items-item-avatar-container').length).toBe(1);
       expect(vm.$el.querySelectorAll('.frequent-items-item-metadata-container').length).toBe(1);
-      expect(vm.$el.querySelectorAll('.frequent-items-item-title').length).toBe(1);
-      expect(vm.$el.querySelectorAll('.frequent-items-item-namespace').length).toBe(1);
+      expect(vm.$el.querySelectorAll('.js-frequent-items-item-title').length).toBe(1);
+      expect(vm.$el.querySelectorAll('.js-frequent-items-item-namespace').length).toBe(1);
     });
   });
 });
diff --git a/spec/javascripts/lib/utils/higlight_spec.js b/spec/javascripts/lib/utils/higlight_spec.js
new file mode 100644
index 00000000000..638bbf65ae9
--- /dev/null
+++ b/spec/javascripts/lib/utils/higlight_spec.js
@@ -0,0 +1,43 @@
+import highlight from '~/lib/utils/highlight';
+
+describe('highlight', () => {
+  it(`should appropriately surround substring matches`, () => {
+    const expected = 'g<b>i</b><b>t</b>lab';
+
+    expect(highlight('gitlab', 'it')).toBe(expected);
+  });
+
+  it(`should return an empty string in the case of invalid inputs`, () => {
+    [null, undefined].forEach(input => {
+      expect(highlight(input, 'match')).toBe('');
+    });
+  });
+
+  it(`should return the original value if match is null, undefined, or ''`, () => {
+    [null, undefined].forEach(match => {
+      expect(highlight('gitlab', match)).toBe('gitlab');
+    });
+  });
+
+  it(`should highlight matches in non-string inputs`, () => {
+    const expected = '123<b>4</b><b>5</b>6';
+
+    expect(highlight(123456, 45)).toBe(expected);
+  });
+
+  it(`should sanitize the input string before highlighting matches`, () => {
+    const expected = 'hello <b>w</b>orld';
+
+    expect(highlight('hello <b>world</b>', 'w')).toBe(expected);
+  });
+
+  it(`should not highlight anything if no matches are found`, () => {
+    expect(highlight('gitlab', 'hello')).toBe('gitlab');
+  });
+
+  it(`should allow wrapping elements to be customized`, () => {
+    const expected = '1<hello>2</hello>3';
+
+    expect(highlight('123', '2', '<hello>', '</hello>')).toBe(expected);
+  });
+});
diff --git a/spec/javascripts/vue_shared/components/project_selector/project_list_item_spec.js b/spec/javascripts/vue_shared/components/project_selector/project_list_item_spec.js
new file mode 100644
index 00000000000..8dbdfe97f8f
--- /dev/null
+++ b/spec/javascripts/vue_shared/components/project_selector/project_list_item_spec.js
@@ -0,0 +1,104 @@
+import _ from 'underscore';
+import ProjectListItem from '~/vue_shared/components/project_selector/project_list_item.vue';
+import { shallowMount, createLocalVue } from '@vue/test-utils';
+import { trimText } from 'spec/helpers/vue_component_helper';
+
+const localVue = createLocalVue();
+
+describe('ProjectListItem component', () => {
+  let wrapper;
+  let vm;
+  loadJSONFixtures('projects.json');
+  const project = getJSONFixture('projects.json')[0];
+
+  beforeEach(() => {
+    wrapper = shallowMount(localVue.extend(ProjectListItem), {
+      propsData: {
+        project,
+        selected: false,
+      },
+      sync: false,
+      localVue,
+    });
+
+    ({ vm } = wrapper);
+  });
+
+  afterEach(() => {
+    vm.$destroy();
+  });
+
+  it('does not render a check mark icon if selected === false', () => {
+    expect(vm.$el.querySelector('.js-selected-icon.js-unselected')).toBeTruthy();
+  });
+
+  it('renders a check mark icon if selected === true', done => {
+    wrapper.setProps({ selected: true });
+
+    vm.$nextTick(() => {
+      expect(vm.$el.querySelector('.js-selected-icon.js-selected')).toBeTruthy();
+      done();
+    });
+  });
+
+  it(`emits a "clicked" event when clicked`, () => {
+    spyOn(vm, '$emit');
+    vm.onClick();
+
+    expect(vm.$emit).toHaveBeenCalledWith('click');
+  });
+
+  it(`renders the project avatar`, () => {
+    expect(vm.$el.querySelector('.js-project-avatar')).toBeTruthy();
+  });
+
+  it(`renders a simple namespace name with a trailing slash`, done => {
+    project.name_with_namespace = 'a / b';
+    wrapper.setProps({ project: _.clone(project) });
+
+    vm.$nextTick(() => {
+      const renderedNamespace = trimText(vm.$el.querySelector('.js-project-namespace').textContent);
+
+      expect(renderedNamespace).toBe('a /');
+      done();
+    });
+  });
+
+  it(`renders a properly truncated namespace with a trailing slash`, done => {
+    project.name_with_namespace = 'a / b / c / d / e / f';
+    wrapper.setProps({ project: _.clone(project) });
+
+    vm.$nextTick(() => {
+      const renderedNamespace = trimText(vm.$el.querySelector('.js-project-namespace').textContent);
+
+      expect(renderedNamespace).toBe('a / ... / e /');
+      done();
+    });
+  });
+
+  it(`renders the project name`, done => {
+    project.name = 'my-test-project';
+    wrapper.setProps({ project: _.clone(project) });
+
+    vm.$nextTick(() => {
+      const renderedName = trimText(vm.$el.querySelector('.js-project-name').innerHTML);
+
+      expect(renderedName).toBe('my-test-project');
+      done();
+    });
+  });
+
+  it(`renders the project name with highlighting in the case of a search query match`, done => {
+    project.name = 'my-test-project';
+    wrapper.setProps({ project: _.clone(project), matcher: 'pro' });
+
+    vm.$nextTick(() => {
+      const renderedName = trimText(vm.$el.querySelector('.js-project-name').innerHTML);
+
+      const expected = 'my-test-<b>p</b><b>r</b><b>o</b>ject';
+
+      expect(renderedName).toBe(expected);
+      done();
+    });
+  });
+});
diff --git a/spec/javascripts/vue_shared/components/project_selector/project_selector_spec.js b/spec/javascripts/vue_shared/components/project_selector/project_selector_spec.js
new file mode 100644
index 00000000000..88c1dff76a1
--- /dev/null
+++ b/spec/javascripts/vue_shared/components/project_selector/project_selector_spec.js
@@ -0,0 +1,152 @@
+import Vue from 'vue';
+import _ from 'underscore';
+import ProjectSelector from '~/vue_shared/components/project_selector/project_selector.vue';
+import ProjectListItem from '~/vue_shared/components/project_selector/project_list_item.vue';
+import { shallowMount } from '@vue/test-utils';
+import { trimText } from 'spec/helpers/vue_component_helper';
+
+describe('ProjectSelector component', () => {
+  let wrapper;
+  let vm;
+  loadJSONFixtures('projects.json');
+  const allProjects = getJSONFixture('projects.json');
+  const searchResults = allProjects.slice(0, 5);
+  let selected = [];
+  selected = selected.concat(allProjects.slice(0, 3)).concat(allProjects.slice(5, 8));
+
+  beforeEach(() => {
+    jasmine.clock().install();
+
+    wrapper = shallowMount(Vue.extend(ProjectSelector), {
+      propsData: {
+        projectSearchResults: searchResults,
+        selectedProjects: selected,
+        showNoResultsMessage: false,
+        showMinimumSearchQueryMessage: false,
+        showLoadingIndicator: false,
+        showSearchErrorMessage: false,
+      },
+      attachToDocument: true,
+    });
+
+    ({ vm } = wrapper);
+  });
+
+  afterEach(() => {
+    jasmine.clock().uninstall();
+    vm.$destroy();
+  });
+
+  it('renders the search results', () => {
+    expect(vm.$el.querySelectorAll('.js-project-list-item').length).toBe(5);
+  });
+
+  it(`triggers a (debounced) search when the search input value changes`, done => {
+    spyOn(vm, '$emit');
+    const query = 'my test query!';
+    const searchInput = vm.$el.querySelector('.js-project-selector-input');
+    searchInput.value = query;
+    searchInput.dispatchEvent(new Event('input'));
+
+    vm.$nextTick(() => {
+      expect(vm.$emit).not.toHaveBeenCalledWith();
+      jasmine.clock().tick(501);
+
+      expect(vm.$emit).toHaveBeenCalledWith('searched', query);
+      done();
+    });
+  });
+
+  it(`debounces the search input`, done => {
+    spyOn(vm, '$emit');
+    const searchInput = vm.$el.querySelector('.js-project-selector-input');
+
+    const updateSearchQuery = (count = 0) => {
+      if (count === 10) {
+        jasmine.clock().tick(101);
+
+        expect(vm.$emit).toHaveBeenCalledTimes(1);
+        expect(vm.$emit).toHaveBeenCalledWith('searched', `search query #9`);
+        done();
+      } else {
+        searchInput.value = `search query #${count}`;
+        searchInput.dispatchEvent(new Event('input'));
+
+        vm.$nextTick(() => {
+          jasmine.clock().tick(400);
+          updateSearchQuery(count + 1);
+        });
+      }
+    };
+
+    updateSearchQuery();
+  });
+
+  it(`includes a placeholder in the search box`, () => {
+    expect(vm.$el.querySelector('.js-project-selector-input').placeholder).toBe(
+      'Search your projects',
+    );
+  });
+
+  it(`triggers a "projectClicked" event when a project is clicked`, () => {
+    spyOn(vm, '$emit');
+    wrapper.find(ProjectListItem).vm.$emit('click', _.first(searchResults));
+
+    expect(vm.$emit).toHaveBeenCalledWith('projectClicked', _.first(searchResults));
+  });
+
+  it(`shows a "no results" message if showNoResultsMessage === true`, done => {
+    wrapper.setProps({ showNoResultsMessage: true });
+
+    vm.$nextTick(() => {
+      const noResultsEl = vm.$el.querySelector('.js-no-results-message');
+
+      expect(noResultsEl).toBeTruthy();
+
+      expect(trimText(noResultsEl.textContent)).toEqual('Sorry, no projects matched your search');
+
+      done();
+    });
+  });
+
+  it(`shows a "minimum seach query" message if showMinimumSearchQueryMessage === true`, done => {
+    wrapper.setProps({ showMinimumSearchQueryMessage: true });
+
+    vm.$nextTick(() => {
+      const minimumSearchEl = vm.$el.querySelector('.js-minimum-search-query-message');
+
+      expect(minimumSearchEl).toBeTruthy();
+
+      expect(trimText(minimumSearchEl.textContent)).toEqual(
+        'Enter at least three characters to search',
+      );
+
+      done();
+    });
+  });
+
+  it(`shows a error message if showSearchErrorMessage === true`, done => {
+    wrapper.setProps({ showSearchErrorMessage: true });
+
+    vm.$nextTick(() => {
+      const errorMessageEl = vm.$el.querySelector('.js-search-error-message');
+
+      expect(errorMessageEl).toBeTruthy();
+
+      expect(trimText(errorMessageEl.textContent)).toEqual(
+        'Something went wrong, unable to search projects',
+      );
+
+      done();
+    });
+  });
+
+  it(`focuses the input element when the focusSearchInput() method is called`, () => {
+    const input = vm.$el.querySelector('.js-project-selector-input');
+
+    expect(document.activeElement).not.toBe(input);
+    vm.focusSearchInput();
+
+    expect(document.activeElement).toBe(input);
+  });
+});