Merge branch 'release/1.0.7'

Author: budnix

dist/formula-parser.js

@@ -67,7 +67,7 @@ function lintGulpfile() {
 }
 
 function build() {
-  return gulp.src(path.join('src', config.entryFileName + '.js'))
+  return gulp.src(path.join(config.entryFileName + '.js'))
     .pipe($.plumber())
     .pipe(webpackStream({
       output: {

dist/formula-parser.js.map

@@ -0,0 +1,15 @@
+import {Parser, SUPPORTED_FORMULAS} from './src/parser';
+import {default as error} from './src/error';
+import {extractLabel, toLabel, columnIndexToLabel, columnLabelToIndex, rowIndexToLabel, rowLabelToIndex} from './src/helper/cell';
+
+export {
+  SUPPORTED_FORMULAS,
+  Parser,
+  error,
+  extractLabel,
+  toLabel,
+  columnIndexToLabel,
+  columnLabelToIndex,
+  rowIndexToLabel,
+  rowLabelToIndex
+};

dist/formula-parser.min.js

@@ -1,6 +1,6 @@
 {
   "name": "hot-formula-parser",
-  "version": "1.0.6",
+  "version": "1.0.7",
   "description": "Formula parser",
   "main": "dist/formula-parser.js",
   "scripts": {
@@ -72,7 +72,7 @@
     "yargs": "^4.7.1"
   },
   "babelBoilerplateOptions": {
-    "entryFileName": "parser",
+    "entryFileName": "index",
     "mainVarName": "formulaParser"
   },
   "dependencies": {

dist/formula-parser.min.js.map

@@ -14,7 +14,7 @@ export function extractLabel(label) {
 
   return [
     {
-      index: parseInt(row, 10) - 1,
+      index: rowLabelToIndex(row),
       label: row,
       isAbsolute: rowAbs === '$',
     },
@@ -26,6 +26,20 @@ export function extractLabel(label) {
   ];
 }
 
+/**
+ * Convert row and column indexes into cell label.
+ *
+ * @param {Object} row Object with `index` and `isAbsolute` properties.
+ * @param {Object} column Object with `index` and `isAbsolute` properties.
+ * @returns {String} Returns cell label.
+ */
+export function toLabel(row, column) {
+  const rowLabel = (row.isAbsolute ? '$' : '') + rowIndexToLabel(row.index);
+  const columnLabel = (column.isAbsolute ? '$' : '') + columnIndexToLabel(column.index);
+
+  return columnLabel + rowLabel;
+}
+
 const COLUMN_LABEL_BASE = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ';
 const COLUMN_LABEL_BASE_LENGTH = COLUMN_LABEL_BASE.length;
 
@@ -64,3 +78,37 @@ export function columnIndexToLabel(column) {
 
   return result.toUpperCase();
 }
+
+/**
+ * Convert row label to index.
+ *
+ * @param {String} label Row label (eq. '1', '5')
+ * @returns {Number} Returns -1 if label is not recognized otherwise proper row index.
+ */
+export function rowLabelToIndex(label) {
+  let result = parseInt(label, 10);
+
+  if (isNaN(result)) {
+    result = -1;
+  } else {
+    result = Math.max(result - 1, -1);
+  }
+
+  return result;
+}
+
+/**
+ * Convert row index to label.
+ *
+ * @param {Number} row Row index.
+ * @returns {String} Returns row label (eq. '1', '7').
+ */
+export function rowIndexToLabel(row) {
+  let result = '';
+
+  if (row >= 0) {
+    result = `${row + 1}`;
+  }
+
+  return result;
+}

gulpfile.babel.js

@@ -4,7 +4,7 @@ import {Parser as GrammarParser} from './grammar-parser/grammar-parser';
 import {trimEdges} from './helper/string';
 import {toNumber, invertNumber} from './helper/number';
 import {default as errorParser, ERROR, ERROR_NAME} from './error';
-import {extractLabel} from './helper/cell';
+import {extractLabel, toLabel} from './helper/cell';
 
 export {default as SUPPORTED_FORMULAS} from './supported-formulas';
 
@@ -132,30 +132,41 @@ class Parser extends Emitter {
   }
 
   /**
-   * Retrieve value by its label (`B3`, `B$3`, `B$3`, `$B$3`).
+   * Retrieve value by its label (`B3:A1`, `B$3:A1`, `B$3:$A1`, `$B$3:A$1`).
    *
-   * @param {String} firstLabel Coordinates of the first cell.
-   * @param {String} lastLabel Coordinates of the last cell.
+   * @param {String} startLabel Coordinates of the first cell.
+   * @param {String} endLabel Coordinates of the last cell.
    * @returns {Array} Returns an array of mixed values.
    * @private
    */
-  _callRangeValue(firstLabel, lastLabel) {
-    const [firstRow, firstColumn] = extractLabel(firstLabel);
-    const [lastRow, lastColumn] = extractLabel(lastLabel);
-
-    const firstCell = {
-      label: firstLabel,
-      row: firstRow,
-      column: firstColumn,
-    };
-    const lastCell = {
-      label: lastLabel,
-      row: lastRow,
-      column: lastColumn,
-    };
+  _callRangeValue(startLabel, endLabel) {
+    const [startRow, startColumn] = extractLabel(startLabel);
+    const [endRow, endColumn] = extractLabel(endLabel);
+    let startCell = {};
+    let endCell = {};
+
+    if (startRow.index <= endRow.index) {
+      startCell.row = startRow;
+      endCell.row = endRow;
+    } else {
+      startCell.row = endRow;
+      endCell.row = startRow;
+    }
+
+    if (startColumn.index <= endColumn.index) {
+      startCell.column = startColumn;
+      endCell.column = endColumn;
+    } else {
+      startCell.column = endColumn;
+      endCell.column = startColumn;
+    }
+
+    startCell.label = toLabel(startCell.row, startCell.column);
+    endCell.label = toLabel(endCell.row, endCell.column);
+
     let value = [];
 
-    this.emit('callRangeValue', firstCell, lastCell, (_value = []) => {
+    this.emit('callRangeValue', startCell, endCell, (_value = []) => {
       value = _value;
     });
 

index.js

@@ -1,4 +1,4 @@
-import {extractLabel, columnIndexToLabel, columnLabelToIndex} from '../../../src/helper/cell';
+import {extractLabel, toLabel, columnIndexToLabel, columnLabelToIndex, rowIndexToLabel, rowLabelToIndex} from '../../../src/helper/cell';
 
 describe('.extractLabel()', () => {
   it('should correctly extract coordinates', () => {
@@ -70,6 +70,16 @@ describe('.extractLabel()', () => {
   });
 });
 
+describe('.toLabel()', () => {
+  it('should correctly convert coords to label ', () => {
+    expect(toLabel({index: 0, isAbsolute: false}, {index: 0, isAbsolute: false})).to.eq('A1');
+    expect(toLabel({index: 0, isAbsolute: true}, {index: 0, isAbsolute: false})).to.eq('A$1');
+    expect(toLabel({index: 0, isAbsolute: true}, {index: 0, isAbsolute: true})).to.eq('$A$1');
+    expect(toLabel({index: 44, isAbsolute: true}, {index: 20, isAbsolute: true})).to.eq('$U$45');
+    expect(toLabel({index: 1, isAbsolute: false}, {index: 20, isAbsolute: true})).to.eq('$U2');
+  });
+});
+
 describe('.columnIndexToLabel()', () => {
   it('should correctly convert column index to label ', () => {
     expect(columnIndexToLabel(-100)).to.eq('');
@@ -95,3 +105,25 @@ describe('.columnLabelToIndex()', () => {
     expect(columnLabelToIndex('NTQ')).to.eq(10000);
   });
 });
+
+describe('.rowIndexToLabel()', () => {
+  it('should correctly convert row index to label ', () => {
+    expect(rowIndexToLabel(-100)).to.eq('');
+    expect(rowIndexToLabel(-1)).to.eq('');
+    expect(rowIndexToLabel(0)).to.eq('1');
+    expect(rowIndexToLabel(1)).to.eq('2');
+    expect(rowIndexToLabel(10)).to.eq('11');
+    expect(rowIndexToLabel(100)).to.eq('101');
+  });
+});
+
+describe('.rowLabelToIndex()', () => {
+  it('should correctly convert row label to index', () => {
+    expect(rowLabelToIndex('')).to.eq(-1);
+    expect(rowLabelToIndex('0')).to.eq(-1);
+    expect(rowLabelToIndex('1')).to.eq(0);
+    expect(rowLabelToIndex('2')).to.eq(1);
+    expect(rowLabelToIndex('100')).to.eq(99);
+    expect(rowLabelToIndex('92')).to.eq(91);
+  });
+});

package.json

@@ -0,0 +1,39 @@
+import * as lib from '../../index';
+
+describe('Public API', () => {
+  it('Parser should be defined', () => {
+    expect(lib.Parser).to.be.a('function');
+  });
+
+  it('SUPPORTED_FORMULAS should be defined', () => {
+    expect(lib.SUPPORTED_FORMULAS).to.be.a('array');
+  });
+
+  it('error should be defined', () => {
+    expect(lib.error).to.be.a('function');
+  });
+
+  it('extractLabel should be defined', () => {
+    expect(lib.extractLabel).to.be.a('function');
+  });
+
+  it('toLabel should be defined', () => {
+    expect(lib.toLabel).to.be.a('function');
+  });
+
+  it('columnIndexToLabel should be defined', () => {
+    expect(lib.columnIndexToLabel).to.be.a('function');
+  });
+
+  it('columnLabelToIndex should be defined', () => {
+    expect(lib.columnLabelToIndex).to.be.a('function');
+  });
+
+  it('rowIndexToLabel should be defined', () => {
+    expect(lib.rowIndexToLabel).to.be.a('function');
+  });
+
+  it('rowLabelToIndex should be defined', () => {
+    expect(lib.rowLabelToIndex).to.be.a('function');
+  });
+});

src/helper/cell.js

@@ -290,5 +290,45 @@ describe('Parser', () => {
       expect(parser._callRangeValue('A$1', '$D4')).to.deep.equal([['a', 'b'], ['z', 'd']]);
       expect(parser._callRangeValue('$A$1', '$E$5')).to.deep.equal([[true, false], [true, true]]);
     });
+
+    it('should convert coordinates in top-left bottom-right format (from bottom-left to top-right)', () => {
+      const obj = {cb: function() {}};
+
+      spy(obj, 'cb');
+
+      parser.on('callRangeValue', obj.cb);
+      parser._callRangeValue('$A$9', 'B2');
+
+      const startCell = {
+        row: {index: 1, isAbsolute: false, label: '2'},
+        column: {index: 0, isAbsolute: true, label: 'A'},
+      };
+      const endCell = {
+        row: {index: 8, isAbsolute: true, label: '9'},
+        column: {index: 1, isAbsolute: false, label: 'B'},
+      };
+
+      sinon.assert.calledWithMatch(obj.cb, startCell, endCell);
+    });
+
+    it('should convert coordinates in top-left bottom-right format (from top-right to bottom-left)', () => {
+      const obj = {cb: function() {}};
+
+      spy(obj, 'cb');
+
+      parser.on('callRangeValue', obj.cb);
+      parser._callRangeValue('B$2', 'A$8');
+
+      const startCell = {
+        row: {index: 1, isAbsolute: true, label: '2'},
+        column: {index: 0, isAbsolute: false, label: 'A'},
+      };
+      const endCell = {
+        row: {index: 7, isAbsolute: true, label: '8'},
+        column: {index: 1, isAbsolute: false, label: 'B'},
+      };
+
+      sinon.assert.calledWithMatch(obj.cb, startCell, endCell);
+    });
   });
 });