@jetbrains/ring-ui 4.1.3 → 5.0.0-beta.0

package/components/hub-source/hub-source.js

@@ -1,123 +0,0 @@
-const defaultOptions = {
-  searchMax: 20,
-  searchSideThreshold: 100,
-  queryFormatter: query => `${query} or ${query}*`
-};
-
-/**
- * HubSource is designed to speed up search requests for small installations.
- * If there are less than "searchSideThreshold" items, it uses client-side filtering
- * of cached results to greatly increase search speed. Useful for completion and
- * select data source.
- */
-export default class HubSource {
-  static TOP_ALL = -1;
-
-  constructor(auth, relativeUrl, options) {
-    this.http = auth.http;
-    this.relativeUrl = relativeUrl;
-    this.options = Object.assign({}, defaultOptions, options);
-
-
-    this.storedData = null;
-    this.isClientSideSearch = null;
-    this.filterFn = null;
-  }
-
-  makeRequest(queryParams) {
-    return this.http.get(this.relativeUrl, {query: queryParams});
-  }
-
-  async makeCachedRequest(params) {
-    if (this.storedData) {
-      return this.storedData;
-    }
-    const res = await this.makeRequest(params);
-    this.storedData = res;
-    return res;
-  }
-
-  static mergeParams(params, toMerge) {
-    return Object.assign({}, params, toMerge);
-  }
-
-  checkIsClientSideSearch(res) {
-    return res.total <= this.options.searchSideThreshold;
-  }
-
-  getDefaultFilterFn(query) {
-    if (!query) {
-      return () => true;
-    }
-    return it => it.name.toLowerCase().indexOf(query.toLowerCase()) !== -1;
-  }
-
-  formatQuery(query) {
-    return query ? this.options.queryFormatter(query) : '';
-  }
-
-  static validateInputParams(params) {
-    if (params.top) {
-      throw new Error('HubSource: params.top should not be filled, configure "options.searchMax" instead');
-    }
-    if (params.query) {
-      throw new Error('HubSource: params.query should not be filled, configure "options.queryFormatter" instead');
-    }
-  }
-
-  processResults(res) {
-    const items = res[this.relativeUrl] || [];
-
-    if (this.isClientSideSearch) {
-      return items.
-        filter(it => this.filterFn(it)).
-        slice(0, this.options.searchMax);
-    }
-    return items;
-  }
-
-  async sideDetectionRequest(params, query) {
-    const res = await this.makeCachedRequest(HubSource.mergeParams(params, {
-      $top: this.options.searchSideThreshold
-    }));
-    this.isClientSideSearch = this.checkIsClientSideSearch(res);
-
-    if (!this.isClientSideSearch) {
-      return this.doServerSideSearch(params, query);
-    }
-
-    return res;
-  }
-
-  doClientSideSearch(params) {
-    return this.makeCachedRequest(HubSource.mergeParams(params, {$top: this.constructor.TOP_ALL}));
-  }
-
-  doServerSideSearch(params, query) {
-    return this.makeRequest(HubSource.mergeParams(params, {
-      query: this.formatQuery(query),
-      $top: this.options.searchMax
-    }));
-  }
-
-  getValueFromSuitableSource(query, params) {
-    if (this.isClientSideSearch === null) {
-      return this.sideDetectionRequest(params, query);
-    }
-
-    if (this.isClientSideSearch) {
-      return this.doClientSideSearch(params);
-    }
-
-    return this.doServerSideSearch(params, query);
-  }
-
-  async get(query, params, filterFn) {
-    HubSource.validateInputParams(params);
-
-    this.filterFn = filterFn || this.getDefaultFilterFn(query);
-
-    const res = await this.getValueFromSuitableSource(query, params);
-    return this.processResults(res);
-  }
-}

package/components/hub-source/hub-source.test.js

@@ -1,200 +0,0 @@
-import HubSource from './hub-source';
-
-describe('Hub Source', () => {
-  let httpMock;
-  let fakeAuth;
-  beforeEach(() => {
-    httpMock = {
-      get: sandbox.stub().returns(Promise.resolve({}))
-    };
-    fakeAuth = {
-      requestToken: sandbox.stub().returns(Promise.resolve('testToken')),
-      http: httpMock
-    };
-  });
-
-  it('Should initialize', () => {
-    const source = new HubSource(fakeAuth);
-    source.should.exist;
-  });
-
-  it('Should merge objects', () => {
-    HubSource.mergeParams({foo: 'bar'}, {test: 'foo'}).
-      should.be.deep.equal({foo: 'bar', test: 'foo'});
-  });
-
-  it('Should make request', async () => {
-    const source = new HubSource(fakeAuth, 'test');
-    await source.makeRequest({test: 'foo'});
-    httpMock.get.should.have.been.calledWith('test', {query: {test: 'foo'}});
-  });
-
-  it('Should not make cached request if data is already requested', async () => {
-    const source = new HubSource(fakeAuth, 'test');
-    source.storedData = {};
-
-    await source.makeCachedRequest({test: 'foo'});
-    httpMock.get.should.not.have.been.called;
-  });
-
-  it('Should detect client-side threshold', () => {
-    const source = new HubSource(fakeAuth, 'test', {searchSideThreshold: 142});
-    source.checkIsClientSideSearch({total: 143}).should.be.false;
-  });
-
-  it('Should detect server-side threshold', () => {
-    const source = new HubSource(fakeAuth, 'test', {searchSideThreshold: 142});
-    source.checkIsClientSideSearch({total: 142}).should.be.true;
-  });
-
-  it('Should provide filter by name function by default', () => {
-    const source = new HubSource(fakeAuth, 'test');
-    const defaultFilterFn = source.getDefaultFilterFn('testQuery');
-
-    defaultFilterFn({name: 'testQuery name'}).should.be.true;
-  });
-
-  it('Should filter on client-side while processing results if client-side is used', () => {
-    const source = new HubSource(fakeAuth, 'testItems');
-    source.isClientSideSearch = true;
-    source.filterFn = source.getDefaultFilterFn('testQuery');
-
-    const res = source.
-      processResults({testItems: [{name: 'not test query'}, {name: 'contain testQuery'}]});
-
-    res.should.deep.equal([{name: 'contain testQuery'}]);
-  });
-
-  it('Should not filter on client-side if server-side is used', () => {
-    const source = new HubSource(fakeAuth, 'testItems');
-    source.isClientSideSearch = false;
-    source.filterFn = source.getDefaultFilterFn('testQuery');
-
-    const res = source.
-      processResults({testItems: [{name: 'not test query'}, {name: 'contain testQuery'}]});
-
-    res.should.deep.equal([{name: 'not test query'}, {name: 'contain testQuery'}]);
-  });
-
-  it('Should return empty array if result field is not presented (no results)', () => {
-    const source = new HubSource(fakeAuth, 'testItems');
-    source.isClientSideSearch = false;
-    source.filterFn = source.getDefaultFilterFn('testQuery');
-
-    const res = source.processResults({});
-
-    res.should.deep.equal([]);
-  });
-
-  it('Should detect client-side filtering if total is smaller than threshold', async () => {
-    httpMock.get = sandbox.stub().
-      returns(Promise.resolve({total: 10, testItems: []}));
-
-    const source = new HubSource(fakeAuth, 'testItems', {searchSideThreshold: 15});
-
-    await source.sideDetectionRequest({});
-    source.isClientSideSearch.should.be.true;
-  });
-
-  it('Should detect server-side filtering if total is smaller than threshold', async () => {
-    httpMock.get = sandbox.stub().
-      returns(Promise.resolve({total: 20, testItems: []}));
-
-    const source = new HubSource(fakeAuth, 'testItems', {searchSideThreshold: 15});
-
-    await source.sideDetectionRequest({});
-    source.isClientSideSearch.should.be.false;
-  });
-
-  it('Should do cached request and filter on client-side', async () => {
-    const source = new HubSource(fakeAuth, 'testItems');
-    source.makeCachedRequest = sandbox.stub().returns(Promise.resolve({
-      total: 20,
-      testItems: []
-    }));
-
-
-    await source.doClientSideSearch();
-    source.makeCachedRequest.should.have.been.calledWith({$top: -1});
-  });
-
-  it('Should do not cached request to server-side', async () => {
-    const source = new HubSource(fakeAuth, 'testItems', {searchMax: 142});
-    source.makeRequest = sandbox.stub().returns(Promise.resolve({
-      total: 20,
-      testItems: []
-    }));
-
-
-    await source.doServerSideSearch({}, 'test-query');
-    source.makeRequest.should.have.been.calledWith({
-      $top: 142,
-      query: sinon.match.string
-    });
-  });
-
-  it('Should produce empty query if no filter string provided', () => {
-    const source = new HubSource(fakeAuth, 'testItems');
-    source.formatQuery('').should.equal('');
-  });
-
-  it('Should construct default query', () => {
-    const source = new HubSource(fakeAuth, 'testItems');
-    source.formatQuery('foo').should.equal('foo or foo*');
-  });
-
-  it('Should construct multi-word query', () => {
-    const source = new HubSource(fakeAuth, 'testItems');
-    source.formatQuery('foo bar').should.equal('foo bar or foo bar*');
-  });
-
-  it('Should support custom queryFormatter', () => {
-    const source = new HubSource(fakeAuth, 'testItems', {
-      queryFormatter: query => `${query} custom format`
-    });
-    source.formatQuery('foo').should.equal('foo custom format');
-  });
-
-  describe('Public interface', () => {
-    it('Should store filterFn', () => {
-      const filterFn = sandbox.spy();
-      const source = new HubSource(fakeAuth, 'testItems');
-
-      source.get('testQuery', {}, filterFn);
-
-      source.filterFn.should.be.equal(filterFn);
-    });
-
-    it('Should do side detection request first', () => {
-      const source = new HubSource(fakeAuth, 'testItems');
-      source.sideDetectionRequest = sandbox.stub().
-        returns(Promise.resolve({total: 20, testItems: []}));
-
-      source.get('testQuery', {testParams: 'test'});
-
-      source.sideDetectionRequest.should.have.been.calledWith({testParams: 'test'}, 'testQuery');
-    });
-
-    it('Should do client-side filtering if previously detected', () => {
-      const source = new HubSource(fakeAuth, 'testItems');
-      source.doClientSideSearch = sandbox.stub().
-        returns(Promise.resolve({total: 20, testItems: []}));
-      source.isClientSideSearch = true;
-
-      source.get('testQuery', {testParams: 'test'});
-
-      source.doClientSideSearch.should.have.been.calledWith({testParams: 'test'});
-    });
-
-    it('Should do server-side filtering if previously detected', () => {
-      const source = new HubSource(fakeAuth, 'testItems');
-      source.doServerSideSearch = sandbox.stub().
-        returns(Promise.resolve({total: 20, testItems: []}));
-      source.isClientSideSearch = false;
-
-      source.get('testQuery', {testParams: 'test'});
-
-      source.doServerSideSearch.should.have.been.calledWith({testParams: 'test'}, 'testQuery');
-    });
-  });
-});

package/components/hub-source/hub-source__user.js

@@ -1,27 +0,0 @@
-import HTTP from '../http/http';
-
-const DEFAULT_FIELDS = 'id,name,login,banned,banReason,profile(email/email,avatar/url)';
-
-export function convertUserForCard(hubUser, serverUri = '') {
-  return {
-    name: hubUser.name,
-    login: hubUser.login,
-    banned: hubUser.banned,
-    banReason: hubUser.banReason,
-    email: hubUser.profile.email && hubUser.profile.email.email,
-    avatarUrl: hubUser.profile.avatar.url,
-    href: `${serverUri}users/${hubUser.id}`
-  };
-}
-
-export function createHubUserCardSource(auth, userId, fields = DEFAULT_FIELDS) {
-  const http = new HTTP(auth);
-
-  return async function getHubUser() {
-    const hubUser = await http.get(
-      `${auth.config.serverUri}api/rest/users/${userId}?fields=${fields}`
-    );
-
-    return convertUserForCard(hubUser, auth.config.serverUri);
-  };
-}

package/components/hub-source/hub-source__users-groups.js

@@ -1,60 +0,0 @@
-import HubSource from './hub-source';
-
-const defaultOptions = {
-  searchMax: 20,
-  searchSideThreshold: 200
-};
-
-export default class HubSourceUsersGroups {
-  constructor(auth, options) {
-    this.auth = auth;
-    this.options = Object.assign({}, defaultOptions, options);
-
-    this.usersSource = new HubSource(auth, 'users', {
-      searchMax: this.options.searchMax,
-      searchSideThreshold: this.options.searchSideThreshold,
-      queryFormatter: query => `nameStartsWith: ${HubSourceUsersGroups.wrapMultiwordQuery(query)} or loginStartsWith: ${HubSourceUsersGroups.wrapMultiwordQuery(query)}`
-    });
-    this.groupsSource = new HubSource(auth, 'usergroups', {
-      searchMax: this.options.searchMax,
-      searchSideThreshold: this.options.searchSideThreshold
-    });
-  }
-
-  static wrapMultiwordQuery(query) {
-    if (query && query.indexOf(' ') !== -1) {
-      return `{${query}}`;
-    }
-    return query;
-  }
-
-  createUsersFilterFn(query) {
-    if (!query) {
-      return () => true;
-    }
-    const normalizedQuery = query.toLowerCase();
-
-    return it => (
-      it.name.toLowerCase().indexOf(normalizedQuery) !== -1 ||
-      it.login.toLowerCase().indexOf(normalizedQuery) !== -1
-    );
-  }
-
-  getUsers(query = '') {
-    return this.usersSource.get(query, {
-      fields: 'id,name,login,total,profile/avatar/url',
-      orderBy: 'name'
-    }, this.createUsersFilterFn(query));
-  }
-
-  getGroups(query = '') {
-    return this.groupsSource.get(query, {
-      fields: 'id,name,total,userCount,iconUrl',
-      orderBy: 'name'
-    });
-  }
-
-  getUserAndGroups(query) {
-    return Promise.all([this.getUsers(query), this.getGroups(query)]);
-  }
-}

package/components/hub-source/hub-source__users-groups.test.js

@@ -1,91 +0,0 @@
-import HubSourceUsersGroups from './hub-source__users-groups';
-
-const SEARCH_THRESHOLD = 123;
-
-describe('Hub Users Groups Source', () => {
-  let httpMock;
-  let fakeAuth;
-
-  beforeEach(() => {
-    httpMock = {
-      get: sandbox.stub().returns(Promise.resolve({}))
-    };
-    fakeAuth = {
-      requestToken: sandbox.stub().returns(Promise.resolve('testToken')),
-      http: httpMock
-    };
-  });
-
-  it('Should pass searchSideThreshold to HubSource', () => {
-    const source = new HubSourceUsersGroups(fakeAuth, {searchSideThreshold: SEARCH_THRESHOLD});
-    source.usersSource.options.searchSideThreshold.should.equal(SEARCH_THRESHOLD);
-    source.groupsSource.options.searchSideThreshold.should.equal(SEARCH_THRESHOLD);
-  });
-
-  it('Should make request for users', async () => {
-    const source = new HubSourceUsersGroups(fakeAuth);
-    sandbox.stub(source.usersSource, 'get').returns(Promise.resolve([]));
-
-    await source.getUsers();
-    source.usersSource.get.should.have.been.calledWith('', {
-      fields: 'id,name,login,total,profile/avatar/url',
-      orderBy: 'name'
-    });
-  });
-
-  it('Should pass query for users', async () => {
-    const source = new HubSourceUsersGroups(fakeAuth);
-    sandbox.stub(source.usersSource, 'get').returns(Promise.resolve([]));
-
-    await source.getUsers('nam');
-    source.usersSource.get.should.have.been.calledWith('nam', {
-      fields: sinon.match.string,
-      orderBy: sinon.match.string
-    });
-  });
-
-  it('Should construct multi-word query for users', () => {
-    const source = new HubSourceUsersGroups(fakeAuth);
-
-    const formatted = source.usersSource.options.queryFormatter('two words');
-    formatted.should.equal('nameStartsWith: {two words} or loginStartsWith: {two words}');
-  });
-
-  it('Should filter user by login on the client side', async () => {
-    const source = new HubSourceUsersGroups(fakeAuth);
-    const user1 = {name: 'some-name1', login: 'login1'};
-    sandbox.stub(source.usersSource, 'makeRequest').returns(Promise.resolve({
-      total: 2,
-      users: [
-        user1,
-        {name: 'some-name2', login: 'login2'}
-      ]
-    }));
-
-    const res = await source.getUsers('login1');
-    res.length.should.equal(1);
-    res[0].should.equal(user1);
-  });
-
-  it('Should make request for groups', async () => {
-    const source = new HubSourceUsersGroups(fakeAuth);
-    sandbox.stub(source.groupsSource, 'get').returns(Promise.resolve([]));
-
-    await source.getGroups();
-    source.groupsSource.get.should.have.been.calledWith('', {
-      fields: 'id,name,total,userCount,iconUrl',
-      orderBy: 'name'
-    });
-  });
-
-  it('Should cache request for groups', async () => {
-    httpMock.get = sandbox.stub().
-      returns(Promise.resolve({total: 1, usergroups: []}));
-
-    const source = new HubSourceUsersGroups(fakeAuth);
-    await source.getGroups();
-    source.getGroups();
-    source.getGroups();
-    httpMock.get.should.have.been.calledOnce;
-  });
-});

package/components/icon/icon.examples.js

@@ -1,146 +0,0 @@
-import React from 'react';
-import searchIcon from '@jetbrains/icons/search';
-import checkmarkIcon from '@jetbrains/icons/checkmark';
-import pencilIcon from '@jetbrains/icons/pencil';
-import add10pxIcon from '@jetbrains/icons/add-10px';
-import add20pxIcon from '@jetbrains/icons/add-20px';
-import chevronDownIcon from '@jetbrains/icons/chevron-down';
-import starFilledIcon from '@jetbrains/icons/star-filled';
-import okIcon from '@jetbrains/icons/ok';
-
-import reactDecorator from '../../.storybook/react-decorator';
-
-import Icon from '@jetbrains/ring-ui/components/icon/icon';
-
-const allIcons = require.context('../../node_modules/@jetbrains/icons', false, /\.js$/);
-const allLogos = require.context('../../node_modules/@jetbrains/logos', true, /\.svg$/);
-
-export default {
-  title: 'Components/Icon',
-  decorators: [reactDecorator()],
-
-  parameters: {
-    notes: 'Displays an icon.'
-  }
-};
-
-export const basic = () => (
-  <div>
-    <Icon
-      glyph={checkmarkIcon}
-      className="additional-class ring-icon"
-      color={Icon.Color.MAGENTA}
-    />
-    <Icon glyph={searchIcon} className="ring-icon"/>
-    <Icon glyph={pencilIcon} className="ring-icon"/>
-  </div>
-);
-
-basic.storyName = 'basic';
-
-basic.parameters = {
-  storyStyles: `
-<style>
-  .ring-icon {
-    display: inline-block;
-    margin: 8px;
-    padding: 8px;
-  }
-</style>`
-};
-
-export const inText = () => (
-  <div className="icons">
-    {'Some text '}
-    <Icon glyph={chevronDownIcon}/>
-    {' Text '}
-    <Icon glyph={add10pxIcon}/>
-    {' text '}
-    <Icon glyph={starFilledIcon}/>
-    {' text '}
-    <Icon glyph={okIcon}/>
-    {' Text '}
-    <Icon glyph={add20pxIcon}/>
-    <div className="underline"/>
-  </div>
-);
-
-inText.storyName = 'in text';
-
-inText.parameters = {
-  storyStyles: `
-<style>
-  .icons {
-    position: relative;
-  }
-
-  .icons svg {
-    background-color: #eeea;
-  }
-
-  .underline {
-    position: absolute;
-    width: 100%;
-    left: 0;
-    border-bottom: 0.1em solid rgba(0, 255, 0, 0.4);
-    bottom: 0.3em;
-  }
-</style>`
-};
-
-export const allIconsList = () => (
-  <div className="icon-example__container">
-    {allIcons.keys().filter(key => !key.includes('index.js')).map(key => {
-      const iconName = key.replace('./', '').replace('.js', '');
-
-      return (
-        <Icon glyph={allIcons(key)} key={key} title={iconName} className="ring-icon"/>
-      );
-    })}
-  </div>
-);
-
-allIconsList.storyName = 'all icons list';
-
-allIconsList.parameters = {
-  storyStyles: `
-<style>
-  .icon-example__container {
-    margin-left: -16px;
-  }
-
-  .ring-icon {
-    display: inline-block;
-    margin: 8px;
-    padding: 8px;
-    color: var(--ring-link-color);
-  }
-
-  .secondary {
-    fill: var(--ring-link-hover-color);
-  }
-</style>`
-};
-
-export const jetBrainsProductLogosList = () => (
-  <div>
-    {allLogos.keys().map(key => (
-      <Icon glyph={allLogos(key)} key={key} title={key.slice(2)} className="ring-icon"/>
-    ))}
-  </div>
-);
-
-jetBrainsProductLogosList.storyName = 'JetBrains product logos list';
-
-jetBrainsProductLogosList.parameters = {
-  hermione: {skip: true}, // Logos example is too big and have no much sense to test
-  storyStyles: `
-<style>
-  .ring-icon {
-    display: inline-block;
-    color: black;
-    margin: 8px;
-    padding: 8px;
-  }
-</style>`
-};