Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(rulesets): add multiple xor #2614

Merged
merged 2 commits into from
May 3, 2024
Merged

feat(rulesets): add multiple xor #2614

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2fae6ec
feat(rulesets): add multiple xor
JeanArhancet Apr 25, 2024
faa066f
Merge branch 'develop' into feat/add-multiple-xor
mnaumanali94 May 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
34 changes: 21 additions & 13 deletions packages/functions/src/__tests__/xor.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,24 @@ describe('Core Functions / Xor', () => {
]);
});

it('given multiple properties that do not match, should return an error message', async () => {
expect(
await runXor(
{
version: '1.0.0',
title: 'Swagger Petstore',
termsOfService: 'http://swagger.io/terms/',
},
{ properties: ['yada-yada', 'whatever', 'foo'] },
),
).toEqual([
{
message: '"yada-yada", "whatever" and "foo" must not be both defined or both undefined',
path: [],
},
]);
});

it('given both properties, should return an error message', async () => {
expect(
await runXor(
Expand Down Expand Up @@ -99,22 +117,12 @@ describe('Core Functions / Xor', () => {
]),
],
],
[
{ properties: ['foo', 'bar', 'baz'] },
[
new RulesetValidationError(
'invalid-function-options',
'"xor" and its "properties" option support 2-item tuples, i.e. ["id", "name"]',
['rules', 'my-rule', 'then', 'functionOptions', 'properties'],
),
],
],
[
{ properties: ['foo', {}] },
[
new RulesetValidationError(
'invalid-function-options',
'"xor" and its "properties" option support 2-item tuples, i.e. ["id", "name"]',
'"xor" and its "properties" option require at least 2-item tuples, i.e. ["id", "name"]',
['rules', 'my-rule', 'then', 'functionOptions', 'properties'],
),
],
Expand All @@ -124,7 +132,7 @@ describe('Core Functions / Xor', () => {
[
new RulesetValidationError(
'invalid-function-options',
'"xor" and its "properties" option support 2-item tuples, i.e. ["id", "name"]',
'"xor" and its "properties" option require at least 2-item tuples, i.e. ["id", "name"]',
['rules', 'my-rule', 'then', 'functionOptions', 'properties'],
),
],
Expand All @@ -134,7 +142,7 @@ describe('Core Functions / Xor', () => {
[
new RulesetValidationError(
'invalid-function-options',
'"xor" and its "properties" option support 2-item tuples, i.e. ["id", "name"]',
'"xor" and its "properties" option require at least 2-item tuples, i.e. ["id", "name"]',
['rules', 'my-rule', 'then', 'functionOptions', 'properties'],
),
],
Expand Down
3 changes: 1 addition & 2 deletions packages/functions/src/optionSchemas.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,8 +207,7 @@ export const optionSchemas: Record<string, CustomFunctionOptionsSchema> = {
type: 'string',
},
minItems: 2,
maxItems: 2,
errorMessage: `"xor" and its "properties" option support 2-item tuples, i.e. ["id", "name"]`,
errorMessage: `"xor" and its "properties" option require at least 2-item tuples, i.e. ["id", "name"]`,
description: 'The properties to check.',
},
},
Expand Down
16 changes: 10 additions & 6 deletions packages/functions/src/xor.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,20 @@ export default createRulesetFunction<Record<string, unknown>, Options>(
options: optionSchemas.xor,
},
function xor(targetVal, { properties }) {
if (properties.length !== 2) return;

const results: IFunctionResult[] = [];

const intersection = Object.keys(targetVal).filter(value => -1 !== properties.indexOf(value));
const intersection = Object.keys(targetVal).filter(key => properties.includes(key));

if (intersection.length !== 1) {
const formattedProperties = properties.map(prop => printValue(prop));

const lastProperty = formattedProperties.pop();
let message = formattedProperties.join(', ') + (lastProperty != undefined ? ` and ${lastProperty}` : '');

message += ' must not be both defined or both undefined';

results.push({
message: `${printValue(properties[0])} and ${printValue(
properties[1],
)} must not be both defined or both undefined`,
message,
});
}

Expand Down