Finalising shared formulas

Author: guyonroche

.eslintrc

@@ -4,6 +4,10 @@
     "func-names": ["off", "never"],
     "linebreak-style": ["off"],
     "no-var": ["off"],
+    "arrow-parens": ["off"],
+    "quote-props": ["off"],
+    "no-use-before-define": ["off"],
+    "no-underscore-dangle": ["off"],
     "vars-on-top": ["off"],
     "no-param-reassign": ["off"],
     "prefer-arrow-callback": ["off"],

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2014-2017 guyonroche
+Copyright (c) 2014-2017 Guyon Roche
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

lib/doc/cell.js

@@ -20,6 +20,7 @@
  * THE SOFTWARE.
  *
  */
+
 'use strict';
 
 var colCache = require('./../utils/col-cache');
@@ -36,13 +37,6 @@ var Cell = module.exports = function(row, column, address) {
     throw new Error('A Cell needs a Row');
   }
 
-  //if (!(row instanceof Row)) {
-  //  throw new Error('Expected row to be Row, was ' + typeof row);
-  //}
-  //if (!(column instanceof Column)) {
-  //  throw new Error('Expected col to be Column, was ' + typeof column);
-  //}
-
   this._row = row;
   this._column = column;
 
@@ -110,19 +104,19 @@ Cell.prototype = {
   },
 
   _mergeStyle: function(rowStyle, colStyle, style) {
-    var numFmt = rowStyle && rowStyle.numFmt || colStyle && colStyle.numFmt;
+    var numFmt = (rowStyle && rowStyle.numFmt) || (colStyle && colStyle.numFmt);
     if (numFmt) style.numFmt = numFmt;
 
-    var font = rowStyle && rowStyle.font || colStyle && colStyle.font;
+    var font = (rowStyle && rowStyle.font) || (colStyle && colStyle.font);
     if (font) style.font = font;
 
-    var alignment = rowStyle && rowStyle.alignment || colStyle && colStyle.alignment;
+    var alignment = (rowStyle && rowStyle.alignment) || (colStyle && colStyle.alignment);
     if (alignment) style.alignment = alignment;
 
-    var border = rowStyle && rowStyle.border || colStyle && colStyle.border;
+    var border = (rowStyle && rowStyle.border) || (colStyle && colStyle.border);
     if (border) style.border = border;
 
-    var fill = rowStyle && rowStyle.fill || colStyle && colStyle.fill;
+    var fill = (rowStyle && rowStyle.fill) || (colStyle && colStyle.fill);
     if (fill) style.fill = fill;
 
     return style;
@@ -171,31 +165,33 @@ Cell.prototype = {
     this._mergeCount--;
   },
   get isMerged() {
-    return (this._mergeCount > 0) || (this.type == Cell.Types.Merge);
+    return (this._mergeCount > 0) || (this.type === Cell.Types.Merge);
   },
   merge: function(master) {
     this._value.release();
     this._value = Value.create(Cell.Types.Merge, this, master);
     this.style = master.style;
   },
   unmerge: function() {
-    if (this.type == Cell.Types.Merge) {
+    if (this.type === Cell.Types.Merge) {
       this._value.release();
       this._value = Value.create(Cell.Types.Null, this);
       this.style = this._mergeStyle(this._row.style, this._column.style, {});
     }
   },
   isMergedTo: function(master) {
-    if (this._value.type != Cell.Types.Merge) return false;
+    if (this._value.type !== Cell.Types.Merge) return false;
     return this._value.isMergedTo(master);
   },
   get master() {
-    if (this.type === Cell.Types.Merge) return this._value.master;
-    else return this; // an unmerged cell is its own master
+    if (this.type === Cell.Types.Merge) {
+      return this._value.master;
+    }
+    return this; // an unmerged cell is its own master
   },
 
   get isHyperlink() {
-    return this._value.type == Cell.Types.Hyperlink;
+    return this._value.type === Cell.Types.Hyperlink;
   },
   get hyperlink() {
     return this._value.hyperlink;
@@ -209,7 +205,8 @@ Cell.prototype = {
   set value(v) {
     // special case - merge cells set their master's value
     if (this.type === Cell.Types.Merge) {
-      return this._value.master.value = v;
+      this._value.master.value = v;
+      return;
     }
 
     this._value.release();
@@ -226,7 +223,7 @@ Cell.prototype = {
 
   _upgradeToHyperlink: function(hyperlink) {
     // if this cell is a string, turn it into a Hyperlink
-    if (this.type == Cell.Types.String) {
+    if (this.type === Cell.Types.String) {
       this._value = Value.create(Cell.Types.Hyperlink, this, {
         text: this._value._value,
         hyperlink: hyperlink
@@ -321,6 +318,7 @@ NullValue.prototype = {
     return null;
   },
   set value(value) {
+    // nothing to do
   },
   get type() {
     return Cell.Types.Null;
@@ -605,18 +603,23 @@ var FormulaValue = function(cell, value) {
     address: cell.address,
     type: Cell.Types.Formula,
     formula: value ? value.formula : undefined,
+    sharedFormula: value ? value.sharedFormula : undefined,
     result: value ? value.result : undefined
   };
 };
 FormulaValue.prototype = {
   get value() {
-    return {
+    return this.model.formula ? {
       formula: this.model.formula,
-      result: this.model.result
+      result: this.model.result,
+    } : {
+      sharedFormula: this.model.sharedFormula,
+      result: this.model.result,
     };
   },
   set value(value) {
     this.model.formula = value.formula;
+    this.model.sharedFormula = value.sharedFormula;
     this.model.result = value.result;
   },
   validate: function(value) {
@@ -633,6 +636,7 @@ FormulaValue.prototype = {
     }
   },
   get dependencies() {
+    // find all the ranges and cells mentioned in the formula
     var ranges = this.formula.match(/([a-zA-Z0-9]+!)?[A-Z]{1,3}\d{1,4}:[A-Z]{1,3}\d{1,4}/g);
     var cells = this.formula.replace(/([a-zA-Z0-9]+!)?[A-Z]{1,3}\d{1,4}:[A-Z]{1,3}\d{1,4}/g, '')
       .match(/([a-zA-Z0-9]+!)?[A-Z]{1,3}\d{1,4}/g);
@@ -660,19 +664,19 @@ FormulaValue.prototype = {
     var v = this.model.result;
     if ((v === null) || (v === undefined)) {
       return Enums.ValueType.Null;
-    } else if ((v instanceof String) || (typeof v == 'string')) {
+    } else if ((v instanceof String) || (typeof v === 'string')) {
       return Enums.ValueType.String;
-    } else if (typeof v == 'number') {
+    } else if (typeof v === 'number') {
       return Enums.ValueType.Number;
     } else if (v instanceof Date) {
       return Enums.ValueType.Date;
     } else if (v.text && v.hyperlink) {
       return Enums.ValueType.Hyperlink;
     } else if (v.formula) {
       return Enums.ValueType.Formula;
-    } else {
-      return Enums.ValueType.Null;
     }
+
+    return Enums.ValueType.Null;
   },
   get address() {
     return this.model.address;
@@ -836,56 +840,6 @@ JSONValue.prototype = {
   }
 };
 
-var SharedFormulaValue = function(cell, value) {
-  this.model = {
-    address: cell.address,
-    type: Cell.Types.SharedFormula,
-    sharedFormula: value ? value.sharedFormula : undefined,
-    result: value ? value.result : undefined
-  };
-};
-SharedFormulaValue.prototype = {
-  get value() {
-    return {
-      sharedFormula: this.model.sharedFormula,
-      result: this.model.result
-    };
-  },
-  set value(value) {
-    this.model.sharedFormula = value.sharedFormula;
-    this.model.result = value.result;
-  },
-  get sharedFormula() {
-    return this.model.sharedFormula;
-  },
-  set sharedFormula(value) {
-    this.model.sharedFormula = value;
-  },
-  get result() {
-    return this.model.result;
-  },
-  set result(value) {
-    this.model.result = value;
-  },
-  get type() {
-    return Cell.Types.SharedFormula;
-  },
-  get address() {
-    return this.model.address;
-  },
-  set address(value) {
-    this.model.address = value;
-  },
-  toCsvString: function() {
-    return '' + (this.model.result || '');
-  },
-  release: function() {
-  },
-  toString: function() {
-    return this.model.result ? this.model.result.toString() : '';
-  }
-};
-
 // Value is a place to hold common static Value type functions
 var Value = {
   getType:  function(value) {
@@ -901,19 +855,19 @@ var Value = {
       return Cell.Types.Date;
     } else if (value.text && value.hyperlink) {
       return Cell.Types.Hyperlink;
-    } else if (value.formula) {
+    } else if (value.formula || value.sharedFormula) {
       return Cell.Types.Formula;
     } else if (value.richText) {
       return Cell.Types.RichText;
     } else if (value.sharedString) {
       return Cell.Types.SharedString;
     } else if (value.error) {
       return Cell.Types.Error;
-    } else {
-      return Cell.Types.JSON;
-      //console.log('Error: value=' + value + ', type=' + typeof value)
-      // throw new Error('I could not understand type of value: ' +  JSON.stringify(value) + ' - typeof: ' + typeof value);
     }
+
+    return Cell.Types.JSON;
+    // console.log('Error: value=' + value + ', type=' + typeof value)
+    // throw new Error('I could not understand type of value: ' +  JSON.stringify(value) + ' - typeof: ' + typeof value);
   },
 
   // map valueType to constructor
@@ -930,14 +884,13 @@ var Value = {
     {t:Cell.Types.RichText, f:RichTextValue},
     {t:Cell.Types.Boolean, f:BooleanValue},
     {t:Cell.Types.Error, f:ErrorValue},
-    {t:Cell.Types.SharedFormula, f:SharedFormulaValue},
-  ].reduce(function(p,t){p[t.t]=t.f; return p;}, []),
+  ].reduce((p,t) => { p[t.t] = t.f; return p; }, []),
 
   create: function(type, cell, value) {
-    var t = this.types[type];
-    if (!t) {
+    var T = this.types[type];
+    if (!T) {
       throw new Error('Could not create Value of type ' + type);
     }
-    return new t(cell, value);
+    return new T(cell, value);
   }
 };

lib/doc/enums.js

@@ -35,7 +35,6 @@ module.exports = {
     RichText: 8,
     Boolean: 9,
     Error: 10,
-    SharedFormula: 11
   },
   RelationshipType: {
     None: 0,
@@ -45,14 +44,14 @@ module.exports = {
     SharedStrings: 4,
     Styles: 5,
     Theme: 6,
-    Hyperlink: 7
+    Hyperlink: 7,
   },
   DocumentType: {
-    Xlsx: 1
+    Xlsx: 1,
   },
   ReadingOrder: {
     RightToLeft: 1,
-    LeftToRight: 2
+    LeftToRight: 2,
   },
   ErrorValue: {
     NotApplicable: '#N/A',
@@ -61,6 +60,6 @@ module.exports = {
     DivZero: '#DIV/0!',
     Null: '#NULL!',
     Value: '#VALUE!',
-    Num: '#NUM!'
+    Num: '#NUM!',
   },
 };

lib/doc/range.js

@@ -132,12 +132,10 @@ Range.prototype = {
     if (sheetName) {
       if (/^[a-zA-Z0-9]*$/.test(sheetName)) {
         return sheetName + '!';
-      } else {
-        return '\'' + sheetName + '\'!';
       }
-    } else {
-      return '';
+      return '\'' + sheetName + '\'!';
     }
+    return '';
   },
 
   expand: function(top, left, bottom, right) {