1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
|
var _ = require('lodash');
var utils = require('./utils');
/**
* A representation of a cell within the table.
* Implementations must have `init` and `draw` methods,
* as well as `colSpan`, `rowSpan`, `desiredHeight` and `desiredWidth` properties.
* @param options
* @constructor
*/
function Cell(options){
this.setOptions(options);
}
Cell.prototype.setOptions = function(options){
if(_.isString(options) || _.isNumber(options) || _.isBoolean(options)){
options = {content:''+options};
}
options = options || {};
this.options = options;
var content = options.content;
if (_.isString(content) || _.isNumber(content) || _.isBoolean(content)) {
this.content = String(content);
} else if (!content) {
this.content = '';
} else {
throw new Error('Content needs to be a primitive, got: ' + (typeof content));
}
this.colSpan = options.colSpan || 1;
this.rowSpan = options.rowSpan || 1;
};
Cell.prototype.mergeTableOptions = function(tableOptions,cells){
this.cells = cells;
var optionsChars = this.options.chars || {};
var tableChars = tableOptions.chars;
var chars = this.chars = {};
_.forEach(CHAR_NAMES,function(name){
setOption(optionsChars,tableChars,name,chars);
});
this.truncate = this.options.truncate || tableOptions.truncate;
var style = this.options.style = this.options.style || {};
var tableStyle = tableOptions.style;
setOption(style, tableStyle, 'padding-left', this);
setOption(style, tableStyle, 'padding-right', this);
this.head = style.head || tableStyle.head;
this.border = style.border || tableStyle.border;
var fixedWidth = tableOptions.colWidths[this.x];
if(tableOptions.wordWrap && fixedWidth){
fixedWidth -= this.paddingLeft + this.paddingRight;
this.lines = utils.colorizeLines(utils.wordWrap(fixedWidth,this.content));
}
else {
this.lines = utils.colorizeLines(this.content.split('\n'));
}
this.desiredWidth = utils.strlen(this.content) + this.paddingLeft + this.paddingRight;
this.desiredHeight = this.lines.length;
};
/**
* Each cell will have it's `x` and `y` values set by the `layout-manager` prior to
* `init` being called;
* @type {Number}
*/
Cell.prototype.x = null;
Cell.prototype.y = null;
/**
* Initializes the Cells data structure.
*
* @param tableOptions - A fully populated set of tableOptions.
* In addition to the standard default values, tableOptions must have fully populated the
* `colWidths` and `rowWidths` arrays. Those arrays must have lengths equal to the number
* of columns or rows (respectively) in this table, and each array item must be a Number.
*
*/
Cell.prototype.init = function(tableOptions){
var x = this.x;
var y = this.y;
this.widths = tableOptions.colWidths.slice(x, x + this.colSpan);
this.heights = tableOptions.rowHeights.slice(y, y + this.rowSpan);
this.width = _.reduce(this.widths,sumPlusOne);
this.height = _.reduce(this.heights,sumPlusOne);
this.hAlign = this.options.hAlign || tableOptions.colAligns[x];
this.vAlign = this.options.vAlign || tableOptions.rowAligns[y];
this.drawRight = x + this.colSpan == tableOptions.colWidths.length;
};
/**
* Draws the given line of the cell.
* This default implementation defers to methods `drawTop`, `drawBottom`, `drawLine` and `drawEmpty`.
* @param lineNum - can be `top`, `bottom` or a numerical line number.
* @param spanningCell - will be a number if being called from a RowSpanCell, and will represent how
* many rows below it's being called from. Otherwise it's undefined.
* @returns {String} The representation of this line.
*/
Cell.prototype.draw = function(lineNum,spanningCell){
if(lineNum == 'top') return this.drawTop(this.drawRight);
if(lineNum == 'bottom') return this.drawBottom(this.drawRight);
var padLen = Math.max(this.height - this.lines.length, 0);
var padTop;
switch (this.vAlign){
case 'center':
padTop = Math.ceil(padLen / 2);
break;
case 'bottom':
padTop = padLen;
break;
default :
padTop = 0;
}
if( (lineNum < padTop) || (lineNum >= (padTop + this.lines.length))){
return this.drawEmpty(this.drawRight,spanningCell);
}
var forceTruncation = (this.lines.length > this.height) && (lineNum + 1 >= this.height);
return this.drawLine(lineNum - padTop, this.drawRight, forceTruncation,spanningCell);
};
/**
* Renders the top line of the cell.
* @param drawRight - true if this method should render the right edge of the cell.
* @returns {String}
*/
Cell.prototype.drawTop = function(drawRight){
var content = [];
if(this.cells){ //TODO: cells should always exist - some tests don't fill it in though
_.forEach(this.widths,function(width,index){
content.push(this._topLeftChar(index));
content.push(
utils.repeat(this.chars[this.y == 0 ? 'top' : 'mid'],width)
);
},this);
}
else {
content.push(this._topLeftChar(0));
content.push(utils.repeat(this.chars[this.y == 0 ? 'top' : 'mid'],this.width));
}
if(drawRight){
content.push(this.chars[this.y == 0 ? 'topRight' : 'rightMid']);
}
return this.wrapWithStyleColors('border',content.join(''));
};
Cell.prototype._topLeftChar = function(offset){
var x = this.x+offset;
var leftChar;
if(this.y == 0){
leftChar = x == 0 ? 'topLeft' : (offset == 0 ? 'topMid' : 'top');
} else {
if(x == 0){
leftChar = 'leftMid';
}
else {
leftChar = offset == 0 ? 'midMid' : 'bottomMid';
if(this.cells){ //TODO: cells should always exist - some tests don't fill it in though
var spanAbove = this.cells[this.y-1][x] instanceof Cell.ColSpanCell;
if(spanAbove){
leftChar = offset == 0 ? 'topMid' : 'mid';
}
if(offset == 0){
var i = 1;
while(this.cells[this.y][x-i] instanceof Cell.ColSpanCell){
i++;
}
if(this.cells[this.y][x-i] instanceof Cell.RowSpanCell){
leftChar = 'leftMid';
}
}
}
}
}
return this.chars[leftChar];
};
Cell.prototype.wrapWithStyleColors = function(styleProperty,content){
if(this[styleProperty] && this[styleProperty].length){
try {
var colors = require('colors/safe');
for(var i = this[styleProperty].length - 1; i >= 0; i--){
colors = colors[this[styleProperty][i]];
}
return colors(content);
} catch (e) {
return content;
}
}
else {
return content;
}
};
/**
* Renders a line of text.
* @param lineNum - Which line of text to render. This is not necessarily the line within the cell.
* There may be top-padding above the first line of text.
* @param drawRight - true if this method should render the right edge of the cell.
* @param forceTruncationSymbol - `true` if the rendered text should end with the truncation symbol even
* if the text fits. This is used when the cell is vertically truncated. If `false` the text should
* only include the truncation symbol if the text will not fit horizontally within the cell width.
* @param spanningCell - a number of if being called from a RowSpanCell. (how many rows below). otherwise undefined.
* @returns {String}
*/
Cell.prototype.drawLine = function(lineNum,drawRight,forceTruncationSymbol,spanningCell){
var left = this.chars[this.x == 0 ? 'left' : 'middle'];
if(this.x && spanningCell && this.cells){
var cellLeft = this.cells[this.y+spanningCell][this.x-1];
while(cellLeft instanceof ColSpanCell){
cellLeft = this.cells[cellLeft.y][cellLeft.x-1];
}
if(!(cellLeft instanceof RowSpanCell)){
left = this.chars['rightMid'];
}
}
var leftPadding = utils.repeat(' ', this.paddingLeft);
var right = (drawRight ? this.chars['right'] : '');
var rightPadding = utils.repeat(' ', this.paddingRight);
var line = this.lines[lineNum];
var len = this.width - (this.paddingLeft + this.paddingRight);
if(forceTruncationSymbol) line += this.truncate || '…';
var content = utils.truncate(line,len,this.truncate);
content = utils.pad(content, len, ' ', this.hAlign);
content = leftPadding + content + rightPadding;
return this.stylizeLine(left,content,right);
};
Cell.prototype.stylizeLine = function(left,content,right){
left = this.wrapWithStyleColors('border',left);
right = this.wrapWithStyleColors('border',right);
if(this.y === 0){
content = this.wrapWithStyleColors('head',content);
}
return left + content + right;
};
/**
* Renders the bottom line of the cell.
* @param drawRight - true if this method should render the right edge of the cell.
* @returns {String}
*/
Cell.prototype.drawBottom = function(drawRight){
var left = this.chars[this.x == 0 ? 'bottomLeft' : 'bottomMid'];
var content = utils.repeat(this.chars.bottom,this.width);
var right = drawRight ? this.chars['bottomRight'] : '';
return this.wrapWithStyleColors('border',left + content + right);
};
/**
* Renders a blank line of text within the cell. Used for top and/or bottom padding.
* @param drawRight - true if this method should render the right edge of the cell.
* @param spanningCell - a number of if being called from a RowSpanCell. (how many rows below). otherwise undefined.
* @returns {String}
*/
Cell.prototype.drawEmpty = function(drawRight,spanningCell){
var left = this.chars[this.x == 0 ? 'left' : 'middle'];
if(this.x && spanningCell && this.cells){
var cellLeft = this.cells[this.y+spanningCell][this.x-1];
while(cellLeft instanceof ColSpanCell){
cellLeft = this.cells[cellLeft.y][cellLeft.x-1];
}
if(!(cellLeft instanceof RowSpanCell)){
left = this.chars['rightMid'];
}
}
var right = (drawRight ? this.chars['right'] : '');
var content = utils.repeat(' ',this.width);
return this.stylizeLine(left , content , right);
};
/**
* A Cell that doesn't do anything. It just draws empty lines.
* Used as a placeholder in column spanning.
* @constructor
*/
function ColSpanCell(){}
ColSpanCell.prototype.draw = function(){
return '';
};
ColSpanCell.prototype.init = function(tableOptions){};
/**
* A placeholder Cell for a Cell that spans multiple rows.
* It delegates rendering to the original cell, but adds the appropriate offset.
* @param originalCell
* @constructor
*/
function RowSpanCell(originalCell){
this.originalCell = originalCell;
}
RowSpanCell.prototype.init = function(tableOptions){
var y = this.y;
var originalY = this.originalCell.y;
this.cellOffset = y - originalY;
this.offset = findDimension(tableOptions.rowHeights,originalY,this.cellOffset);
};
RowSpanCell.prototype.draw = function(lineNum){
if(lineNum == 'top'){
return this.originalCell.draw(this.offset,this.cellOffset);
}
if(lineNum == 'bottom'){
return this.originalCell.draw('bottom');
}
return this.originalCell.draw(this.offset + 1 + lineNum);
};
ColSpanCell.prototype.mergeTableOptions =
RowSpanCell.prototype.mergeTableOptions = function(){};
// HELPER FUNCTIONS
function setOption(objA,objB,nameB,targetObj){
var nameA = nameB.split('-');
if(nameA.length > 1) {
nameA[1] = nameA[1].charAt(0).toUpperCase() + nameA[1].substr(1);
nameA = nameA.join('');
targetObj[nameA] = objA[nameA] || objA[nameB] || objB[nameA] || objB[nameB];
}
else {
targetObj[nameB] = objA[nameB] || objB[nameB];
}
}
function findDimension(dimensionTable, startingIndex, span){
var ret = dimensionTable[startingIndex];
for(var i = 1; i < span; i++){
ret += 1 + dimensionTable[startingIndex + i];
}
return ret;
}
function sumPlusOne(a,b){
return a+b+1;
}
var CHAR_NAMES = [ 'top'
, 'top-mid'
, 'top-left'
, 'top-right'
, 'bottom'
, 'bottom-mid'
, 'bottom-left'
, 'bottom-right'
, 'left'
, 'left-mid'
, 'mid'
, 'mid-mid'
, 'right'
, 'right-mid'
, 'middle'
];
module.exports = Cell;
module.exports.ColSpanCell = ColSpanCell;
module.exports.RowSpanCell = RowSpanCell;
|