polystruct
v0.7.0
Published
Make configuration convenient with Polystruct, a tiny utility that derives a common data structure from varying input representations.
Downloads
11
Readme
Polystruct
Make configuration convenient with Polystruct, a tiny utility that derives a common data structure from varying input representations.
Table of Contents
Install
https://www.npmjs.com/package/polystruct
npm install polystruct
Usage
const polystruct = require('polystruct');
const result = polystruct(inputValueOrArrayOrObject, referenceArrayOrObject, optionsObject);
Scenarios
./tests/scenarios.js
module.exports = [
{
name: 'all enabled',
expected: {
foo: { key: 'foo', enabled: true },
bar: { key: 'bar', enabled: true }
},
referenceObject: ['foo', 'bar'],
inputs: [
true,
['foo', 'bar'],
[['foo', true], ['bar', true]],
[['foo', 1], ['bar', 1]],
[['foo', { enabled: true }], ['bar', { enabled: true }]],
[['foo', { enabled: 1 }], ['bar', { enabled: 1 }]],
{ foo: true, bar: true },
{ foo: 1, bar: 1 },
{ foo: {}, bar: {} },
{ foo: { enabled: true }, bar: { enabled: true } },
{ foo: { enabled: 1 }, bar: { enabled: 1 } }
]
},
{
name: 'all disabled',
expected: {},
referenceObject: ['foo', 'bar'],
inputs: [
false,
null,
undefined,
0,
[],
[['foo', false], ['bar', false]],
[['foo', null], ['bar', null]],
[['foo', undefined], ['bar', undefined]],
[['foo', 0], ['bar', 0]],
[['foo', { enabled: false }], ['bar', { enabled: false }]],
[['foo', { enabled: null }], ['bar', { enabled: null }]],
[['foo', { enabled: undefined }], ['bar', { enabled: undefined }]],
[['foo', { enabled: 0 }], ['bar', { enabled: 0 }]],
{ foo: false, bar: false },
{ foo: null, bar: null },
{ foo: undefined, bar: undefined },
{ foo: 0, bar: 0 },
{ foo: { enabled: false }, bar: { enabled: false } },
{ foo: { enabled: null }, bar: { enabled: null } },
{ foo: { enabled: undefined }, bar: { enabled: undefined } },
{ foo: { enabled: 0 }, bar: { enabled: 0 } }
]
},
{
name: 'enable one of two',
expected: {
bar: { key: 'bar', enabled: true }
},
referenceObject: ['foo', 'bar'],
inputs: [
['bar']
]
},
{
name: 'reference object is array',
expected: {
foo: { key: 'foo', enabled: true }
},
referenceObject: ['foo'],
inputs: [
['foo']
]
},
{
name: 'reference object is literal object',
expected: {
foo: { key: 'foo', enabled: true }
},
referenceObject: {
foo: {}
},
inputs: [
['foo']
]
},
{
name: 'merging when reference object is literal object',
expected: {
foo: { key: 'foo', enabled: true, a: 1, b: 22, c: 3 }
},
referenceObject: {
foo: { a: 1, b: 2 }
},
inputs: [
[['foo', { b: 22, c: 3 }]]
]
},
{
name: 'option to rename key',
options: { keyNames: { key: 'id' } },
expected: {
foo: { id: 'foo', enabled: true }
},
referenceObject: ['foo'],
inputs: [
['foo']
]
},
{
name: 'option to omit key',
options: { keyNames: { key: null } },
expected: {
foo: { enabled: true }
},
referenceObject: ['foo'],
inputs: [
['foo']
]
},
{
name: 'option to rename enabled',
options: { keyNames: { enabled: 'on' } },
expected: {
foo: { key: 'foo', on: true }
},
referenceObject: ['foo'],
inputs: [
['foo']
]
},
{
name: 'option to not filter',
options: { filter: false },
expected: {
foo: { key: 'foo', enabled: true },
bar: { key: 'bar', enabled: false }
},
referenceObject: ['foo', 'bar'],
inputs: [
['foo']
]
}
];