advanced-search-query
Version:
Another parser for advanced search query syntax.
371 lines • 14.8 kB
JavaScript
"use strict";
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
const index_1 = __importDefault(require("../src/index"));
const getNumberOfKeywords = (parsedAdvancedSearchQuery) => {
return Object.keys(parsedAdvancedSearchQuery.getKeywords()).length;
};
describe('searchString', () => {
test('empty', () => {
expect(index_1.default().getKeywords()).toEqual({});
expect(index_1.default('').getKeywords()).toEqual({});
expect(index_1.default(' ').getKeywords()).toEqual({});
expect(index_1.default('').getKeywords()).toEqual({});
expect(index_1.default('').toObject()).toEqual({
text: {
include: [],
exclude: [],
},
keywords: {},
});
});
test('bad input', () => {
expect(index_1.default('to:').getKeywords()).toEqual({
to: [{ value: '', isNegated: false }],
});
expect(index_1.default('quoted text"').getTexts()[0]).toEqual({
value: 'quoted',
isNegated: false,
});
expect(index_1.default('quoted text"').getTexts()[1]).toEqual({
value: 'text"',
isNegated: false,
});
});
test('basic', () => {
const input = 'to:me -from:joe@acme.com foobar';
const parsed = index_1.default(input);
expect(parsed.getTexts()).toEqual([{ value: 'foobar', isNegated: false }]);
expect(getNumberOfKeywords(parsed)).toEqual(2);
expect(parsed.getKeyword('to')).toEqual([
{
value: 'me',
isNegated: false,
},
]);
expect(parsed.getKeyword('from')).toEqual([
{
value: 'joe@acme.com',
isNegated: true,
},
]);
});
test('multiple texts', () => {
const input = 'to:me foobar zoobar';
const parsed = index_1.default(input);
expect(parsed.getTexts()).toEqual([
{ value: 'foobar', isNegated: false },
{ value: 'zoobar', isNegated: false },
]);
expect(getNumberOfKeywords(parsed)).toEqual(1);
expect(parsed.getKeyword('to')).toEqual([
{
value: 'me',
isNegated: false,
},
]);
});
test('quoted value with space', () => {
const input = 'to:"Marcus Ericsson" foobar';
const parsed = index_1.default(input);
expect(parsed.getTexts()).toEqual([{ value: 'foobar', isNegated: false }]);
expect(getNumberOfKeywords(parsed)).toEqual(1);
expect(parsed.getKeyword('to')).toEqual([
{
value: 'Marcus Ericsson',
isNegated: false,
},
]);
});
test('date example', () => {
const input = 'from:hi@mericsson.com,foo@gmail.com to:me subject:vacations date:1/10/2013-15/04/2014 photos';
const parsed = index_1.default(input);
expect(getNumberOfKeywords(parsed)).toEqual(4);
expect(parsed.getKeyword('from')).toEqual([
{ value: 'hi@mericsson.com', isNegated: false },
{ value: 'foo@gmail.com', isNegated: false },
]);
expect(parsed.getKeyword('date')).toEqual([
{
value: '1/10/2013-15/04/2014',
isNegated: false,
},
]);
});
test('negated texts', () => {
const input = 'hello -big -fat is:condition world';
const parsed = index_1.default(input);
expect(parsed.getTexts()).toEqual([
{
value: 'hello',
isNegated: false,
},
{ value: 'big', isNegated: true },
{ value: 'fat', isNegated: true },
{ value: 'world', isNegated: false },
]);
expect(getNumberOfKeywords(parsed)).toEqual(1);
});
test('complex use case', () => {
const input = 'op1:value op1:value2 op2:"multi, \'word\', value" sometext -op3:value more -text';
const parsed = index_1.default(input);
expect(parsed.getTexts()).toEqual([
{ value: 'sometext', isNegated: false },
{ value: 'more', isNegated: false },
{ value: 'text', isNegated: true },
]);
expect(getNumberOfKeywords(parsed)).toEqual(3);
expect(parsed.getKeyword('op1')).toEqual([
{
value: 'value',
isNegated: false,
},
{
value: 'value2',
isNegated: false,
},
]);
expect(parsed.getKeyword('op2')).toEqual([
{
value: "multi, 'word', value",
isNegated: false,
},
]);
expect(parsed.getKeyword('op3')).toEqual([
{
value: 'value',
isNegated: true,
},
]);
expect(parsed.getKeywords()).toEqual({
op1: [
{ value: 'value', isNegated: false },
{ value: 'value2', isNegated: false },
],
op2: [{ value: "multi, 'word', value", isNegated: false }],
op3: [{ value: 'value', isNegated: true }],
});
expect(parsed.toString()).toEqual('op1:value,value2 op2:"multi, \'word\', value" -op3:value sometext more -text');
parsed.removeKeyword('op1');
expect(parsed.toString()).toEqual('op2:"multi, \'word\', value" -op3:value sometext more -text');
// Check once more to see if cached copy returns correctly.
expect(parsed.toString()).toEqual('op2:"multi, \'word\', value" -op3:value sometext more -text');
parsed.removeKeyword('op3', undefined, false);
expect(parsed.toString()).toEqual('op2:"multi, \'word\', value" -op3:value sometext more -text');
parsed.removeKeyword('op3', 'value');
expect(parsed.toString()).toEqual('op2:"multi, \'word\', value" sometext more -text');
parsed.removeText('sometext');
expect(parsed.toString()).toEqual('op2:"multi, \'word\', value" more -text');
parsed.removeText('text', false);
expect(parsed.toString()).toEqual('op2:"multi, \'word\', value" more -text');
parsed.removeText('text', true);
expect(parsed.toString()).toEqual('op2:"multi, \'word\', value" more');
parsed.removeTexts();
expect(parsed.toString()).toEqual('op2:"multi, \'word\', value"');
parsed.removeKeywords();
expect(parsed.toString()).toEqual('');
});
test('several quoted strings', () => {
const input = '"string one" "string two"';
const parsed = index_1.default(input);
expect(parsed.getTexts()).toEqual([
{
value: 'string one',
isNegated: false,
},
{ value: 'string two', isNegated: false },
]);
expect(getNumberOfKeywords(parsed)).toEqual(0);
});
test('dash in text', () => {
const input = 'my-string op1:val';
const parsed = index_1.default(input);
expect(parsed.getTexts()[0]).toEqual({
value: 'my-string',
isNegated: false,
});
expect(parsed.getKeyword('op1')).toEqual([
{
value: 'val',
isNegated: false,
},
]);
});
test('quoted semicolon string', () => {
const input = 'op1:value "semi:string"';
const parsed = index_1.default(input);
expect(parsed.getTexts()).toEqual([
{ value: 'semi:string', isNegated: false },
]);
expect(getNumberOfKeywords(parsed)).toEqual(1);
expect(parsed.getKeyword('op1')).toEqual([
{
value: 'value',
isNegated: false,
},
]);
});
test('comma in condition value', () => {
const input = 'from:hello@mixmax.com template:"recruiting: reject email, inexperience"';
const parsed = index_1.default(input);
expect(parsed.getTexts()).toEqual([]);
expect(getNumberOfKeywords(parsed)).toEqual(2);
expect(parsed.getKeyword('template')).toEqual([
{
value: 'recruiting: reject email, inexperience',
isNegated: false,
},
]);
});
test('intentional quote in text', () => {
const input = "foo'bar from:aes";
const parsed = index_1.default(input);
expect(parsed.getTexts()).toEqual([{ value: "foo'bar", isNegated: false }]);
expect(getNumberOfKeywords(parsed)).toEqual(1);
expect(parsed.getKeyword('from')).toEqual([
{
value: 'aes',
isNegated: false,
},
]);
});
test('intentional quote in operand', () => {
const input = "foobar from:ae's";
const parsed = index_1.default(input);
expect(parsed.getTexts()).toEqual([{ value: 'foobar', isNegated: false }]);
expect(getNumberOfKeywords(parsed)).toEqual(1);
expect(parsed.getKeyword('from')).toEqual([
{
value: "ae's",
isNegated: false,
},
]);
expect(parsed.toString()).toEqual("from:ae's foobar");
});
test('quote in condition value', () => {
const input = 'foobar template:" hello \'there\': other"';
const parsed = index_1.default(input);
expect(parsed.getTexts()).toEqual([{ value: 'foobar', isNegated: false }]);
expect(getNumberOfKeywords(parsed)).toEqual(1);
expect(parsed.getKeyword('template')).toEqual([
{
value: " hello 'there': other",
isNegated: false,
},
]);
expect(parsed.toString()).toEqual('template:" hello \'there\': other" foobar');
});
test('double quote in double quote condition value', () => {
const input = 'foobar template:" hello \\"there\\": other"';
const parsed = index_1.default(input);
expect(parsed.getTexts()).toEqual([{ value: 'foobar', isNegated: false }]);
expect(getNumberOfKeywords(parsed)).toEqual(1);
expect(parsed.getKeyword('template')).toEqual([
{
value: ' hello "there": other',
isNegated: false,
},
]);
expect(parsed.toString()).toEqual('template:" hello \\"there\\": other" foobar');
});
test('two negative conditions concat toString', () => {
const input = '-to:foo@foo.com,foo2@foo.com text -notext';
const parsed = index_1.default(input);
expect(parsed.toObject().keywords.to.exclude).toEqual([
'foo@foo.com',
'foo2@foo.com',
]);
expect(parsed.toObject().text.include).toEqual(['text']);
expect(parsed.toObject().text.exclude).toEqual(['notext']);
expect(parsed.toString()).toEqual('-to:foo@foo.com,foo2@foo.com text -notext');
});
test('two negative conditions separate toString', () => {
const input = '-to:foo@foo.com -to:foo2@foo.com text';
const parsed = index_1.default(input);
expect(parsed.toObject().keywords.to.exclude).toEqual([
'foo@foo.com',
'foo2@foo.com',
]);
expect(parsed.toString()).toEqual('-to:foo@foo.com,foo2@foo.com text');
});
test('transformTextToCondition', () => {
const input = '<a@b.com> to:c@d.com';
const parsed = index_1.default(input, [
(text) => {
return text === '<a@b.com>'
? { name: 'to', value: 'a@b.com', isNegated: true }
: null;
},
]);
expect(parsed.getTexts()).toEqual([]);
expect(getNumberOfKeywords(parsed)).toEqual(1);
expect(parsed.toObject().keywords.to.include).toEqual([
'a@b.com',
'c@d.com',
]);
});
test('removeKeyword simple case', () => {
const input = 'foo:bar,baz';
const parsed = index_1.default(input);
expect(parsed.toObject().keywords.foo.include).toEqual(['bar', 'baz']);
parsed.removeKeyword('foo', 'baz', false);
expect(parsed.toObject().keywords.foo.include).toEqual(['bar']);
});
test('removeKeyword should remove all occurences', () => {
const input = '-foo:bar,baz,bar,bar,bar';
const parsed = index_1.default(input);
expect(parsed.toObject().keywords.foo.exclude).toEqual([
'bar',
'baz',
'bar',
'bar',
'bar',
]);
parsed.removeKeyword('foo', 'bar', true);
expect(parsed.toObject().keywords.foo.exclude).toEqual(['baz']);
});
test('removeKeyword should be noop if entry is not found', () => {
const input = 'foo:bar';
const parsed = index_1.default(input);
expect(parsed.toObject().keywords.foo.include).toEqual(['bar']);
expect(parsed.toString()).toEqual('foo:bar');
expect(parsed.isDirty).toEqual(false);
parsed.removeKeyword('foo', 'qux', false);
expect(parsed.toObject().keywords.foo.include).toEqual(['bar']);
expect(parsed.isDirty).toEqual(false);
});
test('removeText simple case', () => {
const input = 'bar baz';
const parsed = index_1.default(input);
expect(parsed.toObject().text.include).toEqual(['bar', 'baz']);
parsed.removeText('baz');
expect(parsed.toObject().text.include).toEqual(['bar']);
});
test('removeText should remove all occurences', () => {
const input = 'bar baz bar bar bar';
const parsed = index_1.default(input);
expect(parsed.toObject().text.include).toEqual([
'bar',
'baz',
'bar',
'bar',
'bar',
]);
parsed.removeText('bar');
expect(parsed.toObject().text.include).toEqual(['baz']);
});
test('removeText should be noop if entry is not found', () => {
const input = 'test -notest';
const parsed = index_1.default(input);
expect(parsed.toObject().text.include).toEqual(['test']);
expect(parsed.toObject().text.exclude).toEqual(['notest']);
expect(parsed.toString()).toEqual('test -notest');
expect(parsed.isDirty).toEqual(false);
parsed.removeText('test', true);
expect(parsed.toObject().text.include).toEqual(['test']);
expect(parsed.isDirty).toEqual(false);
});
});
//# sourceMappingURL=index.test.js.map