10298555325

Committed 08 Aug 2024 08:22AM UTC coverage: 25.376% (+2.5%) from 22.889%

Build # 10298555325

Build Type

Pull #641

github

Committed by

web-flow

Commit Message

Merge 8b67ca91f into 9398226d6

Pull Request Pull Request #641: Re-factory of the Search By Sequence area

Run Details

521 of 2519 branches covered (20.68%)

Branch coverage included in aggregate %.

7 of 9 new or added lines in 4 files covered. (77.78%)

6 existing lines in 2 files now uncovered.

1131 of 3991 relevant lines covered (28.34%)

92.24 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

89.73

/src/utils/processDescription/handlers/index.js

// @flow
import { get, set } from 'lodash-es';

/*:: type PossibleMain = (
  'entry' |
  'protein' |
  'structure' |
  'taxonomy' |
  'proteome' |
  'set' |
  'search' |
  'result'
); */

/*:: export type DescriptionMain = {|
    key: ?PossibleMain,
    numberOfFilters: number,
|} */
/*:: export type Description = {|
  main: DescriptionMain,
  entry: {|
    isFilter: ?boolean,
    integration: ?string,
    db: ?string,
    accession: ?string,
    memberDB: ?string,
    memberDBAccession: ?string,
    detail: ?string,
    order: ?number,
  |},
  protein: {|
    isFilter: ?boolean,
    db: ?string,
    accession: ?string,
    detail: ?string,
    order: ?number,
  |},
  structure: {|
    isFilter: ?boolean,
    db: ?string,
    accession: ?string,
    chain: ?string,
    detail: ?string,
    order: ?number,
  |},
  taxonomy: {|
    isFilter: ?boolean,
    db: ?string,
    accession: ?string,
    detail: ?string,
    order: ?number,
  |},
  proteome: {|
    isFilter: ?boolean,
    db: ?string,
    accession: ?string,
    detail: ?string,
    order: ?number,
  |},
  set: {|
    isFilter: ?boolean,
    db: ?string,
    accession: ?string,
    detail: ?string,
    order: ?number,
  |},
  search: {|
    type: ?string,
    value: ?string,
  |},
  result: {|
    type: ?string,
    accession: ?string,
    detail: ?string,
  |},
  other: Array<string>,
|}; */

/*:: export type Handler = {|
  name: string,
  children: Set<Handler>,
  key: ?Array<string>,
  getKey: Description => ?Array<string>,
  cleanedUp: ?string,
  cleanUp: (string, ?Description) => ?string,
  regexp: RegExp,
  match: (string, Description) => ?boolean,
  handle: (Description, ?string, ?string, ...args: Array<string>) => Description,
|}; */

/*:: type PropertiesObject = {
  [key: string]: PropertyDescriptor<any>,
}; */

// node templates
const templateHandler /*: Handler */ = {
  // can be used for debugging
  name: 'templateHandler',
  // set of all possible chil handlers
  children: new Set(),
  // accession key in the description object for this handler
  key: null,
  // return accession key depending on current state of description
  getKey: (_description) => null,
  // cleaned up version of the value for this handler
  cleanedUp: null,
  // returns cleaned up value
  cleanUp: (value, _description) => value.toLowerCase(),
  regexp: /.*/,
  // match function for this handler,
  // used after processing parent handler to choose which child
  // can handle the next value
  match(current, _description) {
    // $FlowFixMe object-this-reference
    return this.regexp.test(current);
  },
  // main handle function, mutates description object, setting the cleaned up
  // value to the key in description
  handle(description, current, next, ...rest) {
    // $FlowFixMe object-this-reference
    const key = this.key || this.getKey(description);
    if (key && current) {
      set(
        description,
        key,
        // $FlowFixMe object-this-reference
        this.cleanedUp || this.cleanUp(current, description),
      );
      if (key[1] && key[1] === 'isFilter') {
        description.main.numberOfFilters++;
        description[key[0]].order = description.main.numberOfFilters;
      }
    }
    if (!next) return description;
    // $FlowFixMe object-this-reference
    for (const child of this.children) {
      if (child.match(next, description)) {
        return child.handle(description, next, ...rest);
      }
    }
    throw new Error('404');
  },
};

// nodes
const memberDB = new Set([
  {
    name: 'cathgene3d',
    re: /^G3DSA:[0-9]{1}\.[0-9]{2,3}\.[0-9]{1,4}\.[0-9]{1,5}$/i,
  },
  { name: 'cdd', re: /^(?:[cs])d[0-9]{5}$/i },
  { name: 'hamap', re: /^MF_[0-9]{5}(_([AB]){1})?$/i },
  { name: 'panther', re: /^PTHR[0-9]{5}(:SF[0-9]{1,4})?$/i },
  { name: 'pfam', re: /^PF[0-9]{5}$/i },
  { name: 'pirsf', re: /^PIRSF[0-9]{6}$/i },
  { name: 'prints', re: /^PR[0-9]{5}$/i },
  { name: 'prosite', re: /^PS[0-9]{5}$/i },
  { name: 'profile', re: /^PS[0-9]{5}$/i },
  { name: 'sfld', re: /^sfld[gfs]\d{5}$/i },
  { name: 'smart', re: /^SM[0-9]{5}$/i },
  { name: 'ssf', re: /^SSF[0-9]{5,6}$/i },
  // { name: 'tigrfams', re: /^TIGR[0-9]{5}$/i },
  { name: 'tigrfams', re: /^(TIGR[0-9]{5})|(NF[0-9]{6})$/i },
  { name: 'ncbifam', re: /^(TIGR[0-9]{5})|(NF[0-9]{6})$/i },
  { name: 'mobidblt', re: /^(\w|-)+$/ },
  { name: 'elm', re: /^ELME[0-9]{6}$/ },
  { name: 'antifam', re: /^ANF[0-9]{5}$/ },
]);
const interPro = { name: 'InterPro', re: /IPR[0-9]{6}/i };

export const setDBs /*: Set<Object> */ = new Set([
  {
    name: 'pfam',
    dbName: 'Pfam',
    re: /^[Cc][lL][0-9]{4}$/,
  },
  {
    name: 'cdd',
    dbName: 'CDD',
    re: /^[Cc][lL][0-9]{5}$/,
    url_template:
      'https://www.ncbi.nlm.nih.gov/Structure/cdd/cddsrv.cgi?uid={id}',
  },
  {
    name: 'pirsf',
    dbName: 'PIRSF',
    re: /^[Pp][Ii][Rr][Ss][Ff][0-9]{6}$/,
    url_template: 'https://pir.georgetown.edu/cgi-bin/pf_sf_tree.pl?id={id}',
  },
  {
    name: 'panther',
    dbName: 'PANTHER',
    re: /^PTHR[0-9]{5}(:SF[0-9]{1,3})?$/i,
    url_template:
      'http://www.pantherdb.org/panther/family.do?clsAccession={id}',
  },
]);

const isEmpty = (object) => !Object.values(object).some(Boolean);

// Constructors
// prettier-ignore
const handlerConstructor = (
  propertiesObject /*: PropertiesObject */,
) /*: Handler */ => Object.create(templateHandler, propertiesObject);

// prettier-ignore
const typeConstructor = (type /*: PossibleMain */) /*: Handler */ =>
  handlerConstructor({
    name: {
      value: `${type}Handler`,
    },
    getKey: {
      value: ({ main: { key } }) => (key ? [type, 'isFilter'] : ['main', 'key']),
    },
    cleanUp: {
      value: (_, description) => get(description, ['main', 'key']) ? true : type,
    },
    match: {
      value: (current, { main: { key }, [type]: typeObject }) => {
        switch (typeof current) {
          case 'string':
            return current.toLowerCase() === type && isEmpty(typeObject);
          case 'boolean':
            return !!key && key !== type;
          default:
            return false;
        }
      },
    },
  });

// Entry handlers
export const entryHandler /*: Handler */ = typeConstructor('entry');

export const integrationHandler /*: Handler */ = handlerConstructor({
  name: {
    value: 'integrationHandler',
  },
  key: {
    value: ['entry', 'integration'],
  },
  regexp: {
    value: /^((un)?integrated|all)$/i,
  },
});

export const interProHandler /*: Handler */ = handlerConstructor({
  name: {
    value: 'interProHandler',
  },
  key: {
    value: ['entry', 'db'],
  },
  cleanedUp: {
    value: 'InterPro',
  },
  regexp: {
    value: /^interpro$/i,
  },
});

export const memberDBHandler /*: Handler */ = handlerConstructor({
  name: {
    value: 'memberDBHandler',
  },
  getKey: {
    value: ({ entry: { db } }) => [
      'entry',
      db === 'InterPro' ? 'memberDB' : 'db',
    ],
  },
  match: {
    value(current) {
      // $FlowFixMe object-this-reference
      const _current = this.cleanUp(current);
      for (const { name } of memberDB) {
        if (name === _current) return true;
      }
    },
  },
});

export const allEntriesHandler /*: Handler */ = handlerConstructor({
  name: {
    value: 'allEntriesHandler',
  },
  key: {
    value: ['entry', 'db'],
  },
  cleanedUp: {
    value: 'all',
  },
  regexp: {
    value: /^all$/i,
  },
});

export const interProAccessionHandler /*: Handler */ = handlerConstructor({
  name: {
    value: 'interProAccessionHandler',
  },
  key: {
    value: ['entry', 'accession'],
  },
  cleanUp: {
    value: (value) => value.toUpperCase(),
  },
  regexp: {
    value: interPro.re,
  },
});

export const memberDBAccessionHandler /*: Handler */ = handlerConstructor({
  name: {
    value: 'memberDBAccessionHandler',
  },
  getKey: {
    value: ({ entry: { db } }) => [
      'entry',
      db === 'InterPro' ? 'memberDBAccession' : 'accession',
    ],
  },
  cleanUp: {
    value: (value) => value.toUpperCase(),
  },
  match: {
    value(current, { entry: { db, memberDB: mdb } }) {
      const _mdb = db === 'InterPro' ? mdb : db;
      // $FlowFixMe object-this-reference
      const _current = this.cleanUp(current);
      for (const { name, re } of memberDB) {
        if (name === _mdb && re.test(_current)) return true;
      }
    },
  },
});

// Protein handlers
export const proteinHandler /*: Handler */ = typeConstructor('protein');

export const proteinDBHandler /*: Handler */ = handlerConstructor({
  name: {
    value: 'proteinDBHandler',
  },
  key: {
    value: ['protein', 'db'],
  },
  cleanUp: {
    value: (value) => value.toLowerCase().replace('uniprot', 'UniProt'),
  },
  regexp: {
    value: /^((un)?reviewed|uniprot)$/i,
  },
});

export const proteinAccessionHandler /*: Handler */ = handlerConstructor({
  name: {
    value: 'proteinAccessionHandler',
  },
  key: {
    value: ['protein', 'accession'],
  },
  cleanUp: {
    value: (value) => value.toUpperCase(),
  },
  regexp: {
    value:
      /^([OPQ][0-9][A-Z0-9]{3}[0-9]|[A-NR-Z][0-9]([A-Z][A-Z0-9]{2}[0-9]){1,2})$/i,
  },
});
export const orderHandler /*: Handler */ = handlerConstructor({
  name: {
    value: 'orderHandler',
  },
  getKey: {
    value: ({ main: { key } }) => (key ? [key, 'order'] : null),
  },
  cleanUp: {
    value: (value, _description) => value,
  },
  regexp: {
    value: /^(\d+)$/i,
  },
});

// Structure handlers
export const structureHandler /*: Handler */ = typeConstructor('structure');

export const structureDBHandler /*: Handler */ = handlerConstructor({
  name: {
    value: 'structureDBHandler',
  },
  key: {
    value: ['structure', 'db'],
  },
  cleanedUp: {
    value: 'PDB',
  },
  match: {
    value(current) {
      // $FlowFixMe object-this-reference
      return current.toUpperCase() === this.cleanedUp;
    },
  },
});

export const structureAccessionHandler /*: Handler */ = handlerConstructor({
  name: {
    value: 'structureAccessionHandler',
  },
  key: {
    value: ['structure', 'accession'],
  },
  regexp: {
    value: /^[1-9][A-Za-z0-9]{3}$/i,
  },
});

export const structureChainHandler /*: Handler */ = handlerConstructor({
  name: {
    value: 'structureChainHandler',
  },
  key: {
    value: ['structure', 'chain'],
  },
  cleanUp: {
    value: (value) => value.toUpperCase(),
  },
  regexp: {
    value: /^[A-Z0-9]+$/i,
  },
});

// taxonomy handlers
export const taxonomyHandler /*: Handler */ = typeConstructor('taxonomy');

export const taxonomyDBHandler /*: Handler */ = handlerConstructor({
  name: {
    value: 'taxonomyDBHandler',
  },
  key: {
    value: ['taxonomy', 'db'],
  },
  cleanedUp: {
    value: 'uniprot',
  },
  match: {
    value(current) {
      // $FlowFixMe object-this-reference
      return current.toLowerCase() === this.cleanedUp;
    },
  },
});

export const taxonomyAccessionHandler /*: Handler */ = handlerConstructor({
  name: {
    value: 'taxonomyAccessionHandler',
  },
  key: {
    value: ['taxonomy', 'accession'],
  },
  cleanUp: {
    value: (value) => value,
  },
  regexp: {
    value: /^[1-9]\d*$/,
  },
});

// proteome handlers
export const proteomeHandler /*: Handler */ = typeConstructor('proteome');

export const proteomeDBHandler /*: Handler */ = handlerConstructor({
  name: {
    value: 'proteomeDBHandler',
  },
  key: {
    value: ['proteome', 'db'],
  },
  cleanedUp: {
    value: 'uniprot',
  },
  match: {
    value(current) {
      // $FlowFixMe object-this-reference
      return current.toLowerCase() === this.cleanedUp;
    },
  },
});

export const proteomeAccessionHandler /*: Handler */ = handlerConstructor({
  name: {
    value: 'proteomeAccessionHandler',
  },
  key: {
    value: ['proteome', 'accession'],
  },
  cleanUp: {
    value: (value) => value.toUpperCase(),
  },
  regexp: {
    value: /^UP\d{9}$/i,
  },
});

// Set handlers
export const setHandler /*: Handler */ = typeConstructor('set');

export const setDBHandler /*: Handler */ = handlerConstructor({
  name: {
    value: 'setDBHandler',
  },
  key: {
    value: ['set', 'db'],
  },
  cleanUp: {
    value: (value) => value.toLowerCase().replace('interpro', 'InterPro'),
  },
  match: {
    value(current) {
      // $FlowFixMe object-this-reference
      const _current = this.cleanUp(current);
      for (const { name } of setDBs) {
        if (name === _current) return true;
      }
      return _current === 'all' || _current === 'InterPro';
    },
  },
});

export const setAccessionHandler /*: Handler */ = handlerConstructor({
  name: {
    value: 'setAccessionHandler',
  },
  key: {
    value: ['set', 'accession'],
  },
  cleanUp: {
    value: (value) => value,
  },
  match: {
    value(current) {
      // $FlowFixMe object-this-reference
      const _current = this.cleanUp(current);
      for (const { re } of setDBs) {
        if (re.test(_current)) return true;
      }
    },
  },
});

// Search handlers
export const searchHandler /*: Handler */ = typeConstructor('search');

export const searchTypeHandler /*: Handler */ = handlerConstructor({
  name: {
    value: 'searchTypeHandler',
  },
  key: {
    value: ['search', 'type'],
  },
  regexp: {
    value: /^(text|sequence|ida)$/i,
  },
});

export const searchValueHandler /*: Handler */ = handlerConstructor({
  name: {
    value: 'searchValueHandler',
  },
  key: {
    value: ['search', 'value'],
  },
  cleanUp: {
    value: (value) => value,
  },
});

// result handlers
export const resultHandler /*: Handler */ = typeConstructor('result');

export const resultTypeHandler /*: Handler */ = handlerConstructor({
  name: {
    value: 'resultTypeHandler',
  },
  key: {
    value: ['result', 'type'],
  },
  cleanUp: {
    value: (value) =>
      /^InterProScan$/i.test(value) ? 'InterProScan' : 'download',
  },
  regexp: {
    value: /^(interproscan|download)$/i,
  },
});
export const IPscanRegex =
  /^(iprscan5-[SRI]\d{8}-\d{6}-\d{4}-\d+-\w{2,4}(-\d+)?|internal-[1-9]\d*-[1-9]\d*)|imported_file-.+(-\d+)?$/;
export const resultIPScanJobHandler /*: Handler */ = handlerConstructor({
  name: {
    value: 'resultIPScanJobHandler',
  },
  key: {
    value: ['result', 'job'],
  },
  cleanUp: {
    value: (value) => value,
  },
  regexp: {
    value: IPscanRegex,
  },
});
export const resultIPScanAccessionHandler /*: Handler */ = handlerConstructor({
  name: {
    value: 'resultIPScanAccessionHandler',
  },
  key: {
    value: ['result', 'accession'],
  },
  cleanUp: {
    value: (value) => value,
  },
  regexp: {
    value: IPscanRegex,
  },
});

export const resultDownloadAccessionHandler /*: Handler */ = handlerConstructor(
  {
    name: {
      value: 'resultDownloadAccessionHandler',
    },
    key: {
      value: ['result', 'accession'],
    },
    cleanUp: {
      value: (value) => value,
    },
    regexp: {
      value: /^download-[1-9]\d*-\d+$/,
    },
  },
);

// Common and other handlers
export const detailHandler /*: Handler */ = handlerConstructor({
  name: {
    value: 'detailHandler',
  },
  getKey: {
    value: ({ main: { key } }) => [key, 'detail'],
  },
});

export const otherHandler /*: Handler */ = handlerConstructor({
  name: {
    value: 'otherHandler',
  },
  getKey: {
    value: ({ other }) => ['other', other.length],
  },
  cleanUp: {
    value: (value, { other }) =>
      other?.[0] === 'potm' ? value : value.toLowerCase(),
  },
});

export const rootHandler /*: Handler */ = handlerConstructor({
  name: {
    value: 'rootHandler',
  },
  handle: {
    value(description /*: Description */, ...rest /*: Array<string> */) {
      // $FlowFixMe object-this-reference
      return templateHandler.handle.call(this, description, null, ...rest);
    },
  },
});

// Define edges of the directed graph of path part handlers
// -> link all handlers to their possible children

// Entry
entryHandler.children = new Set([
  integrationHandler,
  interProHandler,
  memberDBHandler,
  proteinHandler,
  structureHandler,
  taxonomyHandler,
  proteomeHandler,
  setHandler,
]);

integrationHandler.children = new Set([
  memberDBHandler,
  proteinHandler,
  structureHandler,
  taxonomyHandler,
  proteomeHandler,
  setHandler,
]);

interProHandler.children = new Set([
  proteinHandler,
  structureHandler,
  taxonomyHandler,
  proteomeHandler,
  setHandler,
  interProAccessionHandler,
]);

memberDBHandler.children = new Set([
  proteinHandler,
  structureHandler,
  taxonomyHandler,
  proteomeHandler,
  setHandler,
  memberDBAccessionHandler,
]);

interProAccessionHandler.children = new Set([
  proteinHandler,
  structureHandler,
  taxonomyHandler,
  proteomeHandler,
  setHandler,
  memberDBHandler,
  detailHandler,
]);

memberDBAccessionHandler.children = new Set([
  proteinHandler,
  structureHandler,
  taxonomyHandler,
  proteomeHandler,
  setHandler,
  detailHandler,
]);

// Protein
proteinHandler.children = new Set([
  proteinDBHandler,
  entryHandler,
  structureHandler,
  taxonomyHandler,
  proteomeHandler,
  setHandler,
]);

proteinDBHandler.children = new Set([
  entryHandler,
  structureHandler,
  taxonomyHandler,
  proteomeHandler,
  setHandler,
  proteinAccessionHandler,
]);

proteinAccessionHandler.children = new Set([
  entryHandler,
  structureHandler,
  taxonomyHandler,
  proteomeHandler,
  setHandler,
  detailHandler,
]);

// Structure
structureHandler.children = new Set([
  structureDBHandler,
  entryHandler,
  proteinHandler,
  taxonomyHandler,
  proteomeHandler,
  setHandler,
]);

structureDBHandler.children = new Set([
  entryHandler,
  proteinHandler,
  taxonomyHandler,
  proteomeHandler,
  setHandler,
  structureAccessionHandler,
]);

structureAccessionHandler.children = new Set([
  entryHandler,
  proteinHandler,
  taxonomyHandler,
  proteomeHandler,
  setHandler,
  structureChainHandler,
  detailHandler,
]);

structureChainHandler.children = new Set([
  entryHandler,
  proteinHandler,
  taxonomyHandler,
  proteomeHandler,
  setHandler,
  detailHandler,
]);

// Taxonomy
taxonomyHandler.children = new Set([
  taxonomyDBHandler,
  entryHandler,
  proteinHandler,
  structureHandler,
  proteomeHandler,
  setHandler,
]);

taxonomyDBHandler.children = new Set([
  entryHandler,
  proteinHandler,
  structureHandler,
  proteomeHandler,
  setHandler,
  taxonomyAccessionHandler,
]);

taxonomyAccessionHandler.children = new Set([
  entryHandler,
  proteinHandler,
  proteomeHandler,
  structureHandler,
  setHandler,
  detailHandler,
]);

// Poteome
proteomeHandler.children = new Set([
  proteomeDBHandler,
  entryHandler,
  proteinHandler,
  structureHandler,
  taxonomyHandler,
  setHandler,
]);

proteomeDBHandler.children = new Set([
  entryHandler,
  proteinHandler,
  structureHandler,
  taxonomyHandler,
  setHandler,
  proteomeAccessionHandler,
]);

proteomeAccessionHandler.children = new Set([
  entryHandler,
  proteinHandler,
  structureHandler,
  taxonomyHandler,
  setHandler,
  detailHandler,
]);

// Set
setHandler.children = new Set([
  setDBHandler,
  entryHandler,
  proteinHandler,
  structureHandler,
  taxonomyHandler,
  proteomeHandler,
]);

setDBHandler.children = new Set([
  entryHandler,
  proteinHandler,
  structureHandler,
  taxonomyHandler,
  proteomeHandler,
  setAccessionHandler,
]);

setAccessionHandler.children = new Set([
  entryHandler,
  proteinHandler,
  structureHandler,
  taxonomyHandler,
  proteomeHandler,
  detailHandler,
]);

// Search
searchHandler.children = new Set([searchTypeHandler]);

searchTypeHandler.children = new Set([searchValueHandler]);

// result
resultHandler.children = new Set([resultTypeHandler]);

resultTypeHandler.children = new Set([resultIPScanJobHandler]);

resultIPScanJobHandler.children = new Set([resultIPScanAccessionHandler]);

resultIPScanAccessionHandler.children = new Set([entryHandler, detailHandler]);

// Common and other
otherHandler.children = new Set([otherHandler]);

rootHandler.children = new Set([
  entryHandler,
  proteinHandler,
  structureHandler,
  taxonomyHandler,
  proteomeHandler,
  setHandler,
  searchHandler,
  resultHandler,
  otherHandler,
]);

ProteinsWebTeam / interpro7-client / 10298555325

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous