table 3.7.9 → 3.8.3

package/test/configSamples.js

@@ -0,0 +1,153 @@
+export default {
+    valid: [
+        {
+            columns: {
+                0: {
+                    alignment: 'left',
+                    // minWidth: 10,
+                    width: 10
+                },
+                1: {
+                    alignment: 'center',
+                    // minWidth: 10,
+                    width: 10
+                },
+                2: {
+                    alignment: 'right',
+                    // minWidth: 10,
+                    width: 10
+                }
+            }
+        },
+        {
+            border: {
+                topBody: `─`,
+                topJoin: `┬`,
+                topLeft: `┌`,
+                topRight: `┐`,
+
+                bottomBody: `─`,
+                bottomJoin: `┴`,
+                bottomLeft: `└`,
+                bottomRight: `┘`,
+
+                bodyLeft: `│`,
+                bodyRight: `│`,
+                bodyJoin: `│`,
+
+                joinBody: `─`,
+                joinLeft: `├`,
+                joinRight: `┤`,
+                joinJoin: `┼`
+            }
+        },
+        {
+            columns: {
+                0: {
+                    paddingLeft: 3
+                },
+                1: {
+                    width: 2,
+                    paddingRight: 3
+                }
+            }
+        },
+        {
+            border: {},
+            columnDefault: {
+                paddingLeft: 0,
+                paddingRight: 1
+            },
+            // drawJoin: () => {
+            //     return false
+            // }
+        },
+        {
+            columnDefault: {
+                width: 50
+            },
+            // columnCount: 3,
+            columns: {
+                0: {
+                    width: 10,
+                    alignment: 'right'
+                },
+                1: {
+                    alignment: 'center',
+                },
+                2: {
+                    width: 10
+                }
+            }
+        },
+        { border: { topBody: '-' } },
+        { border: { topJoin: '-' } },
+        { border: { topLeft: '-' } },
+        { border: { topRight: '-' } },
+        { border: { bottomBody: '-' } },
+        { border: { bottomJoin: '-' } },
+        { border: { bottomLeft: '-' } },
+        { border: { bottomRight: '-' } },
+        { border: { bodyLeft: '-' } },
+        { border: { bodyRight: '-' } },
+        { border: { bodyJoin: '-' } },
+        { border: { joinBody: '-' } },
+        { border: { joinLeft: '-' } },
+        { border: { joinRight: '-' } },
+        { border: { joinJoin: '-' } },
+        { columns: { '1': { alignment: 'left' } } },
+        { columns: { '1': { width: 5 } } },
+        { columns: { '1': { wrapWord: true } } },
+        { columns: { '1': { truncate: 1 } } },
+        { columns: { '1': { paddingLeft: 1 } } },
+        { columns: { '1': { paddingRight: 1 } } },
+        { columnDefault: { alignment: 'left' } },
+        { columnDefault: { width: 5 } },
+        { columnDefault: { wrapWord: true } },
+        { columnDefault: { truncate: 1 } },
+        { columnDefault: { paddingLeft: 1 } },
+        { columnDefault: { paddingRight: 1 } },
+        { drawHorizontalLine: function(){} }
+    ],
+    invalid: [
+        { border: 1 },
+        { border: { unknown: '-' } },
+        { border: { topBody: 1 } },
+        { border: { topJoin: 1 } },
+        { border: { topLeft: 1 } },
+        { border: { topRight: 1 } },
+        { border: { bottomBody: 1 } },
+        { border: { bottomJoin: 1 } },
+        { border: { bottomLeft: 1 } },
+        { border: { bottomRight: 1 } },
+        { border: { bodyLeft: 1 } },
+        { border: { bodyRight: 1 } },
+        { border: { bodyJoin: 1 } },
+        { border: { joinBody: 1 } },
+        { border: { joinLeft: 1 } },
+        { border: { joinRight: 1 } },
+        { border: { joinJoin: 1 } },
+        { columns: 1 },
+        { columns: { a: { width: 5 } } },
+        { columns: { '1': 1 } },
+        { columns: { '1': { unknown: 1 } } },
+        { columns: { '1': { alignment: 1 } } },
+        { columns: { '1': { alignment: '1' } } },
+        { columns: { '1': { width: '5' } } },
+        { columns: { '1': { wrapWord: 1 } } },
+        { columns: { '1': { truncate: '1' } } },
+        { columns: { '1': { paddingLeft: '1' } } },
+        { columns: { '1': { paddingRight: '1' } } },
+        { columnDefault: 1 },
+        { columnDefault: { unknown: 1 } },
+        { columnDefault: { alignment: 1 } },
+        { columnDefault: { alignment: '1' } },
+        { columnDefault: { width: '5' } },
+        { columnDefault: { wrapWord: 1 } },
+        { columnDefault: { truncate: '1' } },
+        { columnDefault: { paddingLeft: '1' } },
+        { columnDefault: { paddingRight: '1' } },
+        { drawHorizontalLine: 1 },
+        { unknown: 1 }
+    ]
+};

package/test/createStream.js

@@ -0,0 +1,41 @@
+/* eslint-disable max-nested-callbacks */
+
+import {
+    expect
+} from 'chai';
+import createStream from './../src/createStream';
+
+describe('createStream', () => {
+  context('"config.columnDefault.width" property is not provided', () => {
+    it('throws an error', () => {
+      expect(() => {
+        createStream();
+      }).to.throw(Error, 'Must provide config.columnDefault.width when creating a stream.');
+    });
+  });
+  context('"config.columnCount" property is not provided', () => {
+    it('throws an error', () => {
+      expect(() => {
+        createStream({
+          columnDefault: {
+            width: 10
+          }
+        });
+      }).to.throw(Error, 'Must provide config.columnCount.');
+    });
+  });
+  context('Table data cell count does not match the columnCount.', () => {
+    it('throws an error', () => {
+      expect(() => {
+        const stream = createStream({
+          columnCount: 10,
+          columnDefault: {
+            width: 10
+          }
+        });
+
+        stream.write(['foo']);
+      }).to.throw(Error, 'Row cell count does not match the config.columnCount.');
+    });
+  });
+});

package/test/drawBorder.js

@@ -0,0 +1,71 @@
+/* eslint-disable sort-keys */
+
+import {
+    expect
+} from 'chai';
+import {
+    drawBorder,
+    drawBorderTop,
+    drawBorderJoin,
+    drawBorderBottom
+} from './../src/drawBorder';
+
+describe('drawBorder', () => {
+  it('draws a border using parts', () => {
+    const parts = {
+      left: '╔',
+      right: '╗',
+      body: '═',
+      join: '╤'
+    };
+
+    expect(drawBorder([1], parts)).to.equal('╔═╗\n');
+    expect(drawBorder([1, 1], parts)).to.equal('╔═╤═╗\n');
+    expect(drawBorder([5, 10], parts)).to.equal('╔═════╤══════════╗\n');
+  });
+});
+
+describe('drawBorderTop', () => {
+  it('draws a border using parts', () => {
+    const parts = {
+      topLeft: '╔',
+      topRight: '╗',
+      topBody: '═',
+      topJoin: '╤'
+    };
+
+    expect(drawBorderTop([1], parts)).to.equal('╔═╗\n');
+    expect(drawBorderTop([1, 1], parts)).to.equal('╔═╤═╗\n');
+    expect(drawBorderTop([5, 10], parts)).to.equal('╔═════╤══════════╗\n');
+  });
+});
+
+describe('drawBorderJoin', () => {
+  it('draws a border using parts', () => {
+    const parts = {
+      joinBody: '─',
+      joinLeft: '╟',
+      joinRight: '╢',
+      joinJoin: '┼'
+    };
+
+    expect(drawBorderJoin([1], parts)).to.equal('╟─╢\n');
+    expect(drawBorderJoin([1, 1], parts)).to.equal('╟─┼─╢\n');
+    expect(drawBorderJoin([5, 10], parts)).to.equal('╟─────┼──────────╢\n');
+  });
+});
+
+describe('drawBorderBottom', () => {
+  it('draws a border using parts', () => {
+    const parts = {
+      bottomBody: '═',
+      bottomJoin: '╧',
+      bottomLeft: '╚',
+      bottomRight: '╝'
+    };
+
+    expect(drawBorderBottom([1], parts)).to.equal('╚═╝\n');
+    expect(drawBorderBottom([1, 1], parts)).to.equal('╚═╧═╝\n');
+    expect(drawBorderBottom([5, 10], parts)).to.equal('╚═════╧══════════╝\n');
+  });
+});

package/test/makeConfig.js

@@ -0,0 +1,75 @@
+/* eslint-disable max-nested-callbacks */
+
+import {
+    expect
+} from 'chai';
+import makeConfig from './../src/makeConfig';
+
+describe('makeConfig', () => {
+  it('does not affect the parameter configuration object', () => {
+    const config = {};
+
+    makeConfig([
+      [
+        'aaaaa'
+      ]
+    ], config);
+
+    expect(config).to.deep.equal({});
+  });
+
+  context('column', () => {
+    context('"alignment"', () => {
+      context('is not provided', () => {
+        it('defaults to "left"', () => {
+          const config = makeConfig([
+            [
+              'aaaaa'
+            ]
+          ]);
+
+          expect(config.columns[0].alignment).to.equal('left');
+        });
+      });
+    });
+    context('"width"', () => {
+      context('is not provided', () => {
+        it('defaults to the maximum column width', () => {
+          const config = makeConfig([
+            [
+              'aaaaa'
+            ]
+          ]);
+
+          expect(config.columns[0].width).to.equal(5);
+        });
+      });
+    });
+    context('"paddingLeft"', () => {
+      context('is not provided', () => {
+        it('defaults to 1', () => {
+          const config = makeConfig([
+            [
+              'aaaaa'
+            ]
+          ]);
+
+          expect(config.columns[0].paddingLeft).to.equal(1);
+        });
+      });
+    });
+    context('"paddingRight"', () => {
+      context('is not provided', () => {
+        it('defaults to 1', () => {
+          const config = makeConfig([
+            [
+              'aaaaa'
+            ]
+          ]);
+
+          expect(config.columns[0].paddingRight).to.equal(1);
+        });
+      });
+    });
+  });
+});

package/test/mapDataUsingRowHeightIndex.js

@@ -0,0 +1,119 @@
+import {
+    expect
+} from 'chai';
+import mapDataUsingRowHeightIndex from './../src/mapDataUsingRowHeightIndex';
+
+describe('mapDataUsingRowHeightIndex', () => {
+  context('no data spans multiple rows', () => {
+    it('maps data to a single cell', () => {
+      const config = {
+        columns: {
+          0: {
+            width: 2
+          }
+        }
+      };
+
+      const rowSpanIndex = [
+        1
+      ];
+
+      const data = [
+        [
+          'aa'
+        ]
+      ];
+
+      const mappedData = mapDataUsingRowHeightIndex(data, rowSpanIndex, config);
+
+      expect(mappedData).to.deep.equal([
+        [
+          'aa'
+        ]
+      ]);
+    });
+  });
+
+  context('single cell spans multiple rows', () => {
+    it('maps data to multiple rows', () => {
+      const config = {
+        columns: {
+          0: {
+            width: 2
+          }
+        }
+      };
+
+      const rowSpanIndex = [
+        5
+      ];
+
+      const data = [
+        [
+          'aabbccddee'
+        ]
+      ];
+
+      const mappedData = mapDataUsingRowHeightIndex(data, rowSpanIndex, config);
+
+      expect(mappedData).to.deep.equal([
+        ['aa'],
+        ['bb'],
+        ['cc'],
+        ['dd'],
+        ['ee']
+      ]);
+    });
+  });
+
+  context('multiple cells spans multiple rows', () => {
+    it('maps data to multiple rows', () => {
+      const config = {
+        columns: {
+          0: {
+            width: 2
+          },
+          1: {
+            width: 4
+          }
+        }
+      };
+
+      const rowSpanIndex = [
+        5
+      ];
+
+      const data = [
+        [
+          'aabbccddee',
+          '00001111'
+        ]
+      ];
+
+      const mappedData = mapDataUsingRowHeightIndex(data, rowSpanIndex, config);
+
+      expect(mappedData).to.deep.equal([
+        [
+          'aa',
+          '0000'
+        ],
+        [
+          'bb',
+          '1111'
+        ],
+        [
+          'cc',
+          ''
+        ],
+        [
+          'dd',
+          ''
+        ],
+        [
+          'ee',
+          ''
+        ]
+      ]);
+    });
+  });
+});

package/test/streamConfig.js

@@ -0,0 +1,43 @@
+import {
+    expect
+} from 'chai';
+import configSamples from './streamConfigSamples';
+import validateConfig from '../dist/validateStreamConfig';
+import configSchema from '../src/schemas/streamConfig.json';
+import Ajv from 'ajv';
+import ajvKeywords from 'ajv-keywords';
+
+describe('streamConfig.json schema', () => {
+  var validate;
+
+  before(() => {
+    var ajv = new Ajv({allErrors: true});
+    ajvKeywords(ajv, 'typeof');
+    validate = ajv.compile(configSchema);
+  });
+
+  it('should pass validation of valid streamConfig samples', () => {
+    configSamples.valid.forEach((sample, i) => {
+      testValid(sample, validate);
+      testValid(sample, validateConfig);
+    });
+
+    function testValid(sample, validate) {
+      var valid = validate(sample);
+      if (!valid) console.log(validate.errors);
+      expect(valid).to.equal(true);
+    }
+  });
+
+  it('should fail validation of invalid streamConfig samples', () => {
+    configSamples.invalid.forEach((sample, i) => {
+      testInvalid(sample, validate);
+      testInvalid(sample, validateConfig);
+    });
+
+    function testInvalid(sample, validate) {
+      var valid = validate(sample);
+      expect(valid).to.equal(false);
+    }
+  });
+});

package/test/streamConfigSamples.js

@@ -0,0 +1,151 @@
+export default {
+    valid: [
+        {
+            columns: {
+                0: {
+                    alignment: 'left',
+                    // minWidth: 10,
+                    width: 10
+                },
+                1: {
+                    alignment: 'center',
+                    // minWidth: 10,
+                    width: 10
+                },
+                2: {
+                    alignment: 'right',
+                    // minWidth: 10,
+                    width: 10
+                }
+            }
+        },
+        {
+            border: {
+                topBody: `─`,
+                topJoin: `┬`,
+                topLeft: `┌`,
+                topRight: `┐`,
+
+                bottomBody: `─`,
+                bottomJoin: `┴`,
+                bottomLeft: `└`,
+                bottomRight: `┘`,
+
+                bodyLeft: `│`,
+                bodyRight: `│`,
+                bodyJoin: `│`,
+
+                joinBody: `─`,
+                joinLeft: `├`,
+                joinRight: `┤`,
+                joinJoin: `┼`
+            }
+        },
+        {
+            columns: {
+                0: {
+                    paddingLeft: 3
+                },
+                1: {
+                    width: 2,
+                    paddingRight: 3
+                }
+            }
+        },
+        {
+            border: {},
+            columnDefault: {
+                paddingLeft: 0,
+                paddingRight: 1
+            },
+            // drawJoin: () => {
+            //     return false
+            // }
+        },
+        {
+            columnDefault: {
+                width: 50
+            },
+            // columnCount: 3,
+            columns: {
+                0: {
+                    width: 10,
+                    alignment: 'right'
+                },
+                1: {
+                    alignment: 'center',
+                },
+                2: {
+                    width: 10
+                }
+            }
+        },        
+        { border: { topBody: '-' } },
+        { border: { topJoin: '-' } },
+        { border: { topLeft: '-' } },
+        { border: { topRight: '-' } },
+        { border: { bottomBody: '-' } },
+        { border: { bottomJoin: '-' } },
+        { border: { bottomLeft: '-' } },
+        { border: { bottomRight: '-' } },
+        { border: { bodyLeft: '-' } },
+        { border: { bodyRight: '-' } },
+        { border: { bodyJoin: '-' } },
+        { border: { joinBody: '-' } },
+        { border: { joinLeft: '-' } },
+        { border: { joinRight: '-' } },
+        { border: { joinJoin: '-' } },
+        { columns: { '1': { alignment: 'left' } } },
+        { columns: { '1': { width: 5 } } },
+        { columns: { '1': { wrapWord: true } } },
+        { columns: { '1': { truncate: 1 } } },
+        { columns: { '1': { paddingLeft: 1 } } },
+        { columns: { '1': { paddingRight: 1 } } },
+        { columnDefault: { alignment: 'left' } },
+        { columnDefault: { width: 5 } },
+        { columnDefault: { wrapWord: true } },
+        { columnDefault: { truncate: 1 } },
+        { columnDefault: { paddingLeft: 1 } },
+        { columnDefault: { paddingRight: 1 } }
+    ],
+    invalid: [
+        { border: 1 },
+        { border: { unknown: '-' } },
+        { border: { topBody: 1 } },
+        { border: { topJoin: 1 } },
+        { border: { topLeft: 1 } },
+        { border: { topRight: 1 } },
+        { border: { bottomBody: 1 } },
+        { border: { bottomJoin: 1 } },
+        { border: { bottomLeft: 1 } },
+        { border: { bottomRight: 1 } },
+        { border: { bodyLeft: 1 } },
+        { border: { bodyRight: 1 } },
+        { border: { bodyJoin: 1 } },
+        { border: { joinBody: 1 } },
+        { border: { joinLeft: 1 } },
+        { border: { joinRight: 1 } },
+        { border: { joinJoin: 1 } },
+        { columns: 1 },
+        { columns: { a: { width: 5 } } },
+        { columns: { '1': 1 } },
+        { columns: { '1': { unknown: 1 } } },
+        { columns: { '1': { alignment: 1 } } },
+        { columns: { '1': { alignment: '1' } } },
+        { columns: { '1': { width: '5' } } },
+        { columns: { '1': { wrapWord: 1 } } },
+        { columns: { '1': { truncate: '1' } } },
+        { columns: { '1': { paddingLeft: '1' } } },
+        { columns: { '1': { paddingRight: '1' } } },
+        { columnDefault: 1 },
+        { columnDefault: { unknown: 1 } },
+        { columnDefault: { alignment: 1 } },
+        { columnDefault: { alignment: '1' } },
+        { columnDefault: { width: '5' } },
+        { columnDefault: { wrapWord: 1 } },
+        { columnDefault: { truncate: '1' } },
+        { columnDefault: { paddingLeft: '1' } },
+        { columnDefault: { paddingRight: '1' } },
+        { unknown: 1 }
+    ]
+};