refactor: helper-name, workbook-table

Author: singerla

src/helper/cell-id-helper.ts

@@ -0,0 +1,85 @@
+// Thanks to Nathan Wall
+// https://stackoverflow.com/questions/12504042/what-is-a-method-that-can-be-used-to-increment-letters#12504061
+
+export default class CellIdHelper {
+  private _chars: string;
+  private _nextId: number[];
+
+  constructor(chars = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ') {
+    this._chars = chars;
+    this._nextId = [0];
+  }
+
+  start(index: number): this {
+    this._nextId = [index];
+    return this;
+  }
+
+  next(): string {
+    const r = [];
+    for (const char of this._nextId) {
+      r.unshift(this._chars[char]);
+    }
+    this._increment();
+    return r.join('');
+  }
+
+  _increment(): void {
+    for (let i = 0; i < this._nextId.length; i++) {
+      const val = ++this._nextId[i];
+      if (val >= this._chars.length) {
+        this._nextId[i] = 0;
+      } else {
+        return;
+      }
+    }
+    this._nextId.push(0);
+  }
+
+  // eslint-disable-next-line
+  *[Symbol.iterator]() {
+    while (true) {
+      yield this.next();
+    }
+  }
+
+  static increment(letterNumber: number): string {
+    const Generator = new this('ABCDEFGHIJKLMNOPQRSTUVWXYZ')
+    return Generator.start(letterNumber).next();
+  }
+
+  static setRange(range: string, colId: number, length?: number): string {
+    const info = range.split('!');
+    const spans = info[1].split(':');
+    const start = spans[0].split('$');
+    const startRow = Number(spans[0].split('$')[2]);
+
+    const colLetter = CellIdHelper.increment(colId);
+
+    let endCell = '';
+    if (length !== undefined) {
+      const endRow = String(startRow + length - 1);
+      endCell = `:$${colLetter}$${endRow}`;
+    }
+
+    const newRange = `${info[0]}!$${colLetter}$${start[2]}${endCell}`;
+    return newRange
+  }
+
+  static getSpanString(
+    startColNumber: number,
+    startRowNumber: number,
+    cols: number,
+    rows: number,
+  ): string {
+    const startColLetter = CellIdHelper.increment(startColNumber);
+    const endColLetter =  CellIdHelper.increment(startColNumber + cols);
+    const endRowNumber = startRowNumber + rows;
+    return `${startColLetter}${startRowNumber}:${endColLetter}${endRowNumber}`;
+  }
+
+  static getCellAddressString(c: number, r: number): string {
+    const colLetter = CellIdHelper.increment(c);
+    return `${colLetter}${r + 1}`;
+  }
+}

src/helper/string-id-generator.ts

@@ -1,39 +1,35 @@
 import {
   ChartData,
   ChartColumn,
-  ModificationPatternChildren,
+  ModificationTags,
 } from '../types/chart-types';
 import { GeneralHelper } from '../helper/general-helper';
 import { XmlHelper } from '../helper/xml-helper';
-import StringIdGenerator from '../helper/string-id-generator';
+import StringIdGenerator from '../helper/cell-id-helper';
 
 export class ModifyChart {
   root: XMLDocument;
-  StringIdGenerator: StringIdGenerator;
   data: ChartData;
   height: number;
   width: number;
   columns: ChartColumn[];
 
   constructor(root: XMLDocument, data: ChartData, columns: ChartColumn[]) {
     this.root = root;
-    this.StringIdGenerator = new StringIdGenerator(
-      'ABCDEFGHIJKLMNOPQRSTUVWXYZ',
-    );
     this.data = data;
     this.columns = GeneralHelper.arrayify(columns);
     this.height = this.data.categories.length;
     this.width = this.columns.length;
   }
 
   pattern(
-    pattern: ModificationPatternChildren,
+    tags: ModificationTags,
     root?: XMLDocument | Element,
   ): void {
     root = root || this.root;
 
-    for (const tag in pattern) {
-      const parentPattern = pattern[tag];
+    for (const tag in tags) {
+      const parentPattern = tags[tag];
       const index = parentPattern.index || 0;
       this.assertNode(root.getElementsByTagName(tag), index);
       const element = root.getElementsByTagName(tag)[index];
@@ -71,47 +67,10 @@ export class ModifyChart {
   };
 
   range = (series: number, length?: number) => (element: Element): void => {
-    this.setRange(element, series, length);
+    const range = element.firstChild.textContent
+    element.firstChild.textContent = StringIdGenerator.setRange(range, series, length);;
   };
 
-  setRange(element: Element, colId: number, length?: number): void {
-    const range = element.firstChild.textContent;
-    const info = range.split('!');
-    const spans = info[1].split(':');
-    const start = spans[0].split('$');
-    const startRow = Number(spans[0].split('$')[2]);
-    const colLetter = this.StringIdGenerator.start(colId).next();
-
-    let endCell = '';
-    if (length !== undefined) {
-      const endRow = String(startRow + length - 1);
-      endCell = `:$${colLetter}$${endRow}`;
-    }
-
-    const newRange = `${info[0]}!$${colLetter}$${start[2]}${endCell}`;
-
-    element.firstChild.textContent = newRange;
-  }
-
-  getSpanString(
-    startColNumber: number,
-    startRowNumber: number,
-    cols: number,
-    rows: number,
-  ): string {
-    const startColLetter = this.StringIdGenerator.start(startColNumber).next();
-    const endColLetter = this.StringIdGenerator.start(
-      startColNumber + cols,
-    ).next();
-    const endRowNumber = startRowNumber + rows;
-    return `${startColLetter}${startRowNumber}:${endColLetter}${endRowNumber}`;
-  }
-
-  getCellAddressString(c: number, r: number): string {
-    const colLetter = this.StringIdGenerator.start(c).next();
-    return `${colLetter}${r + 1}`;
-  }
-
   assertNode(collection: HTMLCollectionOf<Element>, index: number): void {
     if (!collection[index]) {
       const tplNode = collection[collection.length - 1];

src/modify/chart.ts

@@ -2,7 +2,7 @@ import {
   ChartData,
   ChartColumn,
   ModificationPattern,
-  ModificationPatternChildren,
+  ModificationTags,
 } from '../types/chart-types';
 import { ModifyChart } from './chart';
 
@@ -46,8 +46,8 @@ export class ModifyChartspace extends ModifyChart {
 
   series = (
     index: number,
-    children: ModificationPatternChildren,
-  ): ModificationPatternChildren => {
+    children: ModificationTags,
+  ): ModificationTags => {
     return {
       'c:ser': {
         index: index,
@@ -56,7 +56,7 @@ export class ModifyChartspace extends ModifyChart {
     };
   };
 
-  seriesId = (series: number): ModificationPatternChildren => {
+  seriesId = (series: number): ModificationTags => {
     return {
       'c:idx': {
         modify: this.attribute('val', series),
@@ -70,7 +70,7 @@ export class ModifyChartspace extends ModifyChart {
   seriesLabel = (
     label: string,
     series: number,
-  ): ModificationPatternChildren => {
+  ): ModificationTags => {
     return {
       'c:f': {
         modify: this.range(series + 1),
@@ -86,7 +86,7 @@ export class ModifyChartspace extends ModifyChart {
     value: number,
     index: number,
     series: number,
-  ): ModificationPatternChildren => {
+  ): ModificationTags => {
     return {
       'c:val': this.point(value, index, series + 1),
       'c:cat': this.point(index, 0, label),

src/modify/chartspace.ts

@@ -1,32 +1,33 @@
+import CellIdHelper from '../helper/cell-id-helper';
 import { ChartData, ChartColumn } from '../types/chart-types';
 import { Workbook } from '../types/types';
 import { ModifyChart } from './chart';
 
 export class ModifyWorkbookTable extends ModifyChart {
-  sharedStrings: XMLDocument;
-  table: Workbook['table'];
-
   constructor(workbook: Workbook, data: ChartData, columns?: ChartColumn[]) {
     super(workbook.table, data, columns);
-    this.sharedStrings = workbook.sharedStrings;
-    this.table = workbook.table;
   }
 
   setWorkbookTable(): void {
-    this.table
-      .getElementsByTagName('table')[0]
-      .setAttribute('ref', this.getSpanString(0, 1, this.width, this.height));
-
-    const tableColumns = this.table.getElementsByTagName('tableColumns')[0];
-    tableColumns.setAttribute('count', String(this.width + 1));
+    this.pattern({
+      'table': {
+        modify: this.attribute('ref', CellIdHelper.getSpanString(0, 1, this.width, this.height))
+      },
+      'tableColumns': {
+        modify: this.attribute('count', this.width + 1)
+      }
+    })
   }
 
   setWorkbookTableColumn(c: number, label: string): void {
-    const tableColumns = this.table.getElementsByTagName('tableColumns')[0];
-    this.assertNode(tableColumns.getElementsByTagName('tableColumn'), c);
-
-    const tableColumn = tableColumns.getElementsByTagName('tableColumn')[c];
-    tableColumn.setAttribute('id', String(c + 1));
-    tableColumn.setAttribute('name', label);
+    this.pattern({
+      'tableColumn': {
+        index: c,
+        modify: [
+          this.attribute('id', c + 1),
+          this.attribute('name', label),
+        ]
+      }
+    })
   }
 }