table 3.8.0 → 4.0.2

package/test/README/usage/padding_cell_content.js

@@ -1,39 +0,0 @@
-import table from './../../../src';
-import expectTable from './expectTable';
-
-describe('README.md usage/', () => {
-  it('usage/padding_cell_content', () => {
-    const data = [
-      ['0A', 'AABBCC', '0C'],
-      ['1A', '1B', '1C'],
-      ['2A', '2B', '2C']
-    ];
-
-    const config = {
-      columns: {
-        0: {
-          paddingLeft: 3
-        },
-        1: {
-          paddingRight: 3,
-          width: 2
-        }
-      }
-    };
-
-    const output = table(data, config);
-
-    // eslint-disable-next-line no-restricted-syntax
-    expectTable(output, `
-╔══════╤══════╤════╗
-║   0A │ AA   │ 0C ║
-║      │ BB   │    ║
-║      │ CC   │    ║
-╟──────┼──────┼────╢
-║   1A │ 1B   │ 1C ║
-╟──────┼──────┼────╢
-║   2A │ 2B   │ 2C ║
-╚══════╧══════╧════╝
-        `);
-  });
-});

package/test/README/usage/predefined_border_templates.js

@@ -1,91 +0,0 @@
-import _ from 'lodash';
-import table, {
-    getBorderCharacters
-} from './../../../src';
-import expectTable from './expectTable';
-
-describe('README.md usage/predefined_border_templates', () => {
-  let data;
-
-  before(() => {
-    data = [
-      ['0A', '0B', '0C'],
-      ['1A', '1B', '1C'],
-      ['2A', '2B', '2C']
-    ];
-  });
-
-  it('honeywell', () => {
-    const output = table(data, {
-      border: getBorderCharacters('honeywell')
-    });
-
-    // eslint-disable-next-line no-restricted-syntax
-    expectTable(output, `
-╔════╤════╤════╗
-║ 0A │ 0B │ 0C ║
-╟────┼────┼────╢
-║ 1A │ 1B │ 1C ║
-╟────┼────┼────╢
-║ 2A │ 2B │ 2C ║
-╚════╧════╧════╝
-        `);
-  });
-
-  it('norc', () => {
-    const output = table(data, {
-      border: getBorderCharacters('norc')
-    });
-
-    // eslint-disable-next-line no-restricted-syntax
-    expectTable(output, `
-┌────┬────┬────┐
-│ 0A │ 0B │ 0C │
-├────┼────┼────┤
-│ 1A │ 1B │ 1C │
-├────┼────┼────┤
-│ 2A │ 2B │ 2C │
-└────┴────┴────┘
-        `);
-  });
-
-  it('ramac', () => {
-    const output = table(data, {
-      border: getBorderCharacters('ramac')
-    });
-
-    // eslint-disable-next-line no-restricted-syntax
-    expectTable(output, `
-+----+----+----+
-| 0A | 0B | 0C |
-|----|----|----|
-| 1A | 1B | 1C |
-|----|----|----|
-| 2A | 2B | 2C |
-+----+----+----+
-        `);
-  });
-
-  it('void', () => {
-    const output = table(data, {
-      border: getBorderCharacters('void')
-    });
-
-    expectTable(_.trim(output) + '\n', '0A  0B  0C \n\n 1A  1B  1C \n\n 2A  2B  2C');
-  });
-
-  it('borderless', () => {
-    const output = table(data, {
-      border: getBorderCharacters('void'),
-      columnDefault: {
-        paddingLeft: 0,
-        paddingRight: 1
-      },
-      drawHorizontalLine: () => {
-        return false;
-      }
-    });
-
-    expectTable(_.trim(output) + '\n', '0A 0B 0C \n1A 1B 1C \n2A 2B 2C');
-  });
-});

package/test/README/usage/streaming.js

@@ -1,56 +0,0 @@
-import {
-    createStream
-} from './../../../src';
-import expectTable from './expectTable';
-
-describe('README.md usage/', () => {
-  describe('process.stdout.write', () => {
-    let processStdoutWriteBuffer;
-
-    /**
-     * @var {Function} Reference to the original process.stdout.write function.
-     */
-    const processStdoutWrite = process.stdout.write;
-
-    /**
-     * @returns {undefined}
-     */
-    const overwriteProcessStdoutWrite = () => {
-      processStdoutWriteBuffer = '';
-
-      process.stdout.write = (text) => {
-        processStdoutWriteBuffer += text;
-      };
-    };
-
-    /**
-     * @returns {string}
-     */
-    const resetProcessStdoudWrite = () => {
-      process.stdout.write = processStdoutWrite;
-
-      return processStdoutWriteBuffer;
-    };
-
-    it('streaming', () => {
-      const config = {
-        columnCount: 3,
-        columnDefault: {
-          width: 2
-        }
-      };
-
-      const stream = createStream(config);
-
-      overwriteProcessStdoutWrite();
-
-      stream.write(['0A', '0B', '0C']);
-      stream.write(['1A', '1B', '1C']);
-      stream.write(['2A', '2B', '2C']);
-
-      const output = resetProcessStdoudWrite();
-
-      expectTable(output + '\n', '╔════╤════╤════╗\n║ 0A │ 0B │ 0C ║\n╚════╧════╧════╝\r\u001b[K╟────┼────┼────╢\n║ 1A │ 1B │ 1C ║\n╚════╧════╧════╝\r\u001b[K╟────┼────┼────╢\n║ 2A │ 2B │ 2C ║\n╚════╧════╧════╝');
-    });
-  });
-});

package/test/README/usage/text_truncating.js

@@ -1,32 +0,0 @@
-import table from './../../../src';
-import expectTable from './expectTable';
-
-describe('README.md usage/', () => {
-  it('text_truncating', () => {
-    const data = [
-      ['Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus pulvinar nibh sed mauris convallis dapibus. Nunc venenatis tempus nulla sit amet viverra.']
-    ];
-
-    const config = {
-      columns: {
-        0: {
-          truncate: 100,
-          width: 20
-        }
-      }
-    };
-
-    const output = table(data, config);
-
-    // eslint-disable-next-line no-restricted-syntax
-    expectTable(output, `
-╔══════════════════════╗
-║ Lorem ipsum dolor si ║
-║ t amet, consectetur  ║
-║ adipiscing elit. Pha ║
-║ sellus pulvinar nibh ║
-║ sed mauris conva...  ║
-╚══════════════════════╝
-        `);
-  });
-});

package/test/README/usage/text_wrapping.js

@@ -1,67 +0,0 @@
-import table from './../../../src';
-import expectTable from './expectTable';
-
-describe('README.md usage/', () => {
-  it('text_wrapping (no wrap word)', () => {
-    const data = [
-      ['Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus pulvinar nibh sed mauris convallis dapibus. Nunc venenatis tempus nulla sit amet viverra.']
-    ];
-
-    const config = {
-      columns: {
-        0: {
-          width: 20
-        }
-      }
-    };
-
-    const output = table(data, config);
-
-    // eslint-disable-next-line no-restricted-syntax
-    expectTable(output, `
-╔══════════════════════╗
-║ Lorem ipsum dolor si ║
-║ t amet, consectetur  ║
-║ adipiscing elit. Pha ║
-║ sellus pulvinar nibh ║
-║ sed mauris convallis ║
-║ dapibus. Nunc venena ║
-║ tis tempus nulla sit ║
-║ amet viverra.        ║
-╚══════════════════════╝
-        `);
-  });
-
-  it('text_wrapping (wrap word)', () => {
-    const data = [
-      ['Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus pulvinar nibh sed mauris convallis dapibus. Nunc venenatis tempus nulla sit amet viverra.']
-    ];
-
-    const config = {
-      columns: {
-        0: {
-          width: 20,
-          wrapWord: true
-        }
-      }
-    };
-
-    const output = table(data, config);
-
-    // eslint-disable-next-line no-restricted-syntax
-    expectTable(output, `
-╔══════════════════════╗
-║ Lorem ipsum dolor    ║
-║ sit amet,            ║
-║ consectetur          ║
-║ adipiscing elit.     ║
-║ Phasellus pulvinar   ║
-║ nibh sed mauris      ║
-║ convallis dapibus.   ║
-║ Nunc venenatis       ║
-║ tempus nulla sit     ║
-║ amet viverra.        ║
-╚══════════════════════╝
-        `);
-  });
-});

package/test/alignString.js

@@ -1,102 +0,0 @@
-/* eslint-disable max-nested-callbacks */
-
-import {
-    expect
-} from 'chai';
-import chalk from 'chalk';
-import alignString from './../src/alignString';
-
-describe('alignString', () => {
-  context('subject parameter value is not a string', () => {
-    it('throws an error', () => {
-      expect(() => {
-        alignString();
-      }).to.throw(Error, 'Subject parameter value must be a string.');
-    });
-  });
-  context('container width parameter value is not a string', () => {
-    it('throws an error', () => {
-      expect(() => {
-        alignString('');
-      }).to.throw(Error, 'Container width parameter value must be a number.');
-    });
-  });
-  context('subject parameter value width is greater than the container width', () => {
-    it('throws an error', () => {
-      expect(() => {
-        alignString('aa', 1, 'left');
-      }).to.throw(Error, 'Subject parameter value width cannot be greater than the container width.');
-    });
-  });
-  context('container alignment parameter value is not a string', () => {
-    it('throws an error', () => {
-      expect(() => {
-        alignString('', 1);
-      }).to.throw(Error, 'Alignment parameter value must be a string.');
-    });
-  });
-  context('container alignment parameter value is not a known alignment parameter value', () => {
-    it('throws an error', () => {
-      expect(() => {
-        alignString('', 1, 'foo');
-      }).to.throw(Error, 'Alignment parameter value must be a known alignment parameter value (left, right, center).');
-    });
-  });
-  context('subject parameter value', () => {
-    context('0 width', () => {
-      it('produces a string consisting of container width number of whitespace characters', () => {
-        expect(alignString('', 5, 'left')).to.equal('     ', 'left');
-        expect(alignString('', 5, 'center')).to.equal('     ', 'center');
-        expect(alignString('', 5, 'right')).to.equal('     ', 'right');
-      });
-    });
-    context('plain text', () => {
-      context('alignment', () => {
-        context('left', () => {
-          it('pads the string on the right side using a whitespace character', () => {
-            expect(alignString('aa', 6, 'left')).to.equal('aa    ');
-          });
-        });
-        context('right', () => {
-          it('pads the string on the left side using a whitespace character', () => {
-            expect(alignString('aa', 6, 'right')).to.equal('    aa');
-          });
-        });
-        context('center', () => {
-          it('pads the string on both sides using a whitespace character', () => {
-            expect(alignString('aa', 6, 'center')).to.equal('  aa  ');
-          });
-          context('uneven number of available with', () => {
-            it('floors the available width; adds extra space to the end of the string', () => {
-              expect(alignString('aa', 7, 'center')).to.equal('  aa   ');
-            });
-          });
-        });
-      });
-    });
-    context('text containing ANSI escape codes', () => {
-      context('alignment', () => {
-        context('left', () => {
-          it('pads the string on the right side using a whitespace character', () => {
-            expect(alignString(chalk.red('aa'), 6, 'left')).to.equal(chalk.red('aa') + '    ');
-          });
-        });
-        context('right', () => {
-          it('pads the string on the left side using a whitespace character', () => {
-            expect(alignString(chalk.red('aa'), 6, 'right')).to.equal('    ' + chalk.red('aa'));
-          });
-        });
-        context('center', () => {
-          it('pads the string on both sides using a whitespace character', () => {
-            expect(alignString(chalk.red('aa'), 6, 'center')).to.equal('  ' + chalk.red('aa') + '  ');
-          });
-          context('uneven number of available with', () => {
-            it('floors the available width; adds extra space to the end of the string', () => {
-              expect(alignString(chalk.red('aa'), 7, 'center')).to.equal('  ' + chalk.red('aa') + '   ');
-            });
-          });
-        });
-      });
-    });
-  });
-});

package/test/calculateCellHeight.js

@@ -1,44 +0,0 @@
-/* eslint-disable max-nested-callbacks */
-
-import {
-    expect
-} from 'chai';
-import calculateCellHeight from './../src/calculateCellHeight';
-
-describe('calculateCellHeight', () => {
-  describe('value', () => {
-    context('is not a string', () => {
-      it('throws an error', () => {
-        expect(() => {
-          calculateCellHeight(null);
-        }).to.throw(Error, 'Value must be a string.');
-      });
-    });
-  });
-  describe('context width', () => {
-    context('is not an integer', () => {
-      it('throws an error', () => {
-        expect(() => {
-          calculateCellHeight('foo', null);
-        }).to.throw(Error, 'Column width must be an integer.');
-      });
-    });
-    context('is 0', () => {
-      it('throws an error', () => {
-        expect(() => {
-          calculateCellHeight('foo', 0);
-        }).to.throw(Error, 'Column width must be greater than 0.');
-      });
-    });
-    context('is lesser than the column width', () => {
-      it('has height 1', () => {
-        expect(calculateCellHeight('foo', 10)).to.equal(1);
-      });
-    });
-    context('is 2 and half times greater than the column width', () => {
-      it('has height 3', () => {
-        expect(calculateCellHeight('aabbc', 2)).to.equal(3);
-      });
-    });
-  });
-});

package/test/calculateCellWidthIndex.js

@@ -1,20 +0,0 @@
-import {
-    expect
-} from 'chai';
-import calculateCellWidthIndex from './../src/calculateCellWidthIndex';
-
-describe('calculateCellWidthIndex', () => {
-  context('all cells have different width', () => {
-    it('describes each cell contents width', () => {
-      const cellWidthIndex = calculateCellWidthIndex([
-        'a',
-        'aaa',
-        'aaaaaa'
-      ]);
-
-      expect(cellWidthIndex[0]).to.equal(1, 'first column');
-      expect(cellWidthIndex[1]).to.equal(3, 'second column');
-      expect(cellWidthIndex[2]).to.equal(6, 'third column');
-    });
-  });
-});

package/test/calculateMaximumColumnWidthIndex.js

@@ -1,59 +0,0 @@
-import {
-    expect
-} from 'chai';
-import chalk from 'chalk';
-import calculateMaximumColumnWidthIndex from './../src/calculateMaximumColumnWidthIndex';
-
-describe('calculateMaximumColumnWidthIndex', () => {
-  it('throws an error when attempting to calculate maximum column value index for an empty data set', () => {
-    expect(() => {
-      calculateMaximumColumnWidthIndex([]);
-    }).to.throw(Error, 'Dataset must have at least one row.');
-  });
-  it('calculates the maximum column value index', () => {
-    const maximumColumnValueIndex = calculateMaximumColumnWidthIndex([
-      [
-        '',
-        'a',
-        'b',
-        'c'
-      ],
-      [
-        '',
-        'a',
-        'bbbbbbbbbb',
-        'c'
-      ],
-      [
-        '',
-        '',
-        'b',
-        'ccccc'
-      ]
-    ]);
-
-    expect(maximumColumnValueIndex).to.deep.equal([0, 1, 10, 5]);
-  });
-  context('cell values contain ANSI codes', () => {
-    it('uses visual width of the string', () => {
-      const maximumColumnValueIndex = calculateMaximumColumnWidthIndex([
-        [
-          chalk.red('aaaaa')
-        ]
-      ]);
-
-      expect(maximumColumnValueIndex[0]).to.equal(5);
-    });
-  });
-  context('cell values contain fullwidth characters', () => {
-    it('uses visual width of the string', () => {
-      const maximumColumnValueIndex = calculateMaximumColumnWidthIndex([
-        [
-          chalk.red('古')
-        ]
-      ]);
-
-      expect(maximumColumnValueIndex[0]).to.equal(2);
-    });
-  });
-});

package/test/calculateRowHeightIndex.js

@@ -1,78 +0,0 @@
-/* eslint-disable max-nested-callbacks */
-
-import {
-    expect
-} from 'chai';
-import calculateRowHeightIndex from './../src/calculateRowHeightIndex';
-
-describe('calculateRowHeightIndex', () => {
-  context('single column', () => {
-    context('cell content width is lesser than column width', () => {
-      it('is equal to 1', () => {
-        const data = [
-          [
-            'aaa'
-          ]
-        ];
-
-        const config = {
-          columns: {
-            0: {
-              width: 10,
-              wrapWord: false
-            }
-          }
-        };
-
-        const rowSpanIndex = calculateRowHeightIndex(data, config);
-
-        expect(rowSpanIndex[0]).to.equal(1);
-      });
-    });
-    context('cell content width is twice the size of the column width', () => {
-      it('is equal to 2', () => {
-        const data = [
-          [
-            'aaabbb'
-          ]
-        ];
-
-        const config = {
-          columns: {
-            0: {
-              width: 3,
-              wrapWord: false
-            }
-          }
-        };
-
-        const rowSpanIndex = calculateRowHeightIndex(data, config);
-
-        expect(rowSpanIndex[0]).to.equal(2);
-      });
-    });
-  });
-  context('multiple columns', () => {
-    context('multiple cell content width is greater than the column width', () => {
-      it('uses the largest height', () => {
-        const data = [
-          ['aaabbb'],
-          ['aaabbb']
-        ];
-
-        const config = {
-          columns: {
-            0: {
-              width: 2,
-              wrapWord: false
-            }
-          }
-        };
-
-        const rowSpanIndex = calculateRowHeightIndex(data, config);
-
-        expect(rowSpanIndex[0]).to.equal(3);
-      });
-    });
-  });
-});

package/test/createStream.js

@@ -1,41 +0,0 @@
-/* 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.');
-    });
-  });
-});