[DONE} - migration from v3 to v4.

Author: ajitesh-NC

lib/sheets.js

@@ -79,7 +79,6 @@ Sheets.prototype.get = async function get() {
       auth: authClient
     });
     return sheets;
-    // this.sheets = sheets;
   } catch(e){
     throw new Error(e);
   }
@@ -98,7 +97,6 @@ Sheets.prototype.getSheets = async function getSheets(docId) {
     }
     const response = await sheets.spreadsheets.get(request);
 
-    console.log('v4 response-->', response.data.sheets )
     return(response.data.sheets.map((sheet) => {
       return {
         id: sheet.properties.sheetId,
@@ -121,7 +119,6 @@ Sheets.prototype.getSheets = async function getSheets(docId) {
 Sheets.prototype.getSheet = async function getSheet(docId, sheetId) {
   try {
     const sheetsInfo = await this.getSheets(docId);
-    console.log('-----sheetsInfo-----', sheetsInfo)
     const { id, title, rowCount, colCount } = sheetsInfo
     .find((sheet) => sheet.id === +sheetId);
 
@@ -143,7 +140,6 @@ Sheets.prototype.getSheet = async function getSheet(docId, sheetId) {
  * @return {Promise}        A promise that resolves to list of data from a sheet
  */
 Sheets.prototype.getList = async function getList(docId, sheetId) {
-  // TODO: parse rows to sane data, now returns raw feed data
   try {
     const { title } = await this.getSheet(docId, sheetId);
     const sheets = await this.get();
@@ -153,7 +149,6 @@ Sheets.prototype.getList = async function getList(docId, sheetId) {
       range: title
     }
     const sheet = await sheets.spreadsheets.values.get(request);
-    // console.log(JSON.stringify(sheet.data.values, null, 2));
     return sheet.data.values;
   } catch(error) {
     throw new Error(error);
@@ -177,165 +172,178 @@ Sheets.prototype.getCells = async function getCells(docId, sheetId) {
 
 
 /**
- * Convert rangeInfo to valid Google Sheets API v4 range
- *
- * Examples:
- *
- * - "Sheet1!A1:B2" refers to the first two cells in the top two rows of Sheet1.
- * - "Sheet1!A:A" refers to all the cells in the first column of Sheet1.
- * - "Sheet1!1:2" refers to all the cells in the first two rows of Sheet1.
- * - "Sheet1!A5:A" refers to all the cells of the first column of Sheet 1, from row 5 onward.
- * - "Sheet1" refers to all the cells in Sheet1.
- * - "'My Custom Sheet'!A:A" refers to all the cells in a sheet named "My Custom Sheet."
- *   Single quotes are required for sheet names with spaces, special characters, or an alphanumeric combination.
- *
+ * Sanitize range info before passing it to v4 request
  * @param {String} t Title, name of the sheet
  * @param {String} ri Range info, e.g "A1:B2", where "A" and "B" are columns and "1" and "2" are rows
- */
-Sheets.prototype.toV4Range = (t, ri) => {
+*/
+Sheets.prototype.v4RangeSanitizer = (t, ri) => {
   // Titles with spaces need to be wrapped into single quotes
   let title = t.includes(" ") ? `'${t}'` : t;
-
-  // Return just the title "Sheet1" if there is no range info
-  if ([undefined, null].includes(ri)) {
-    return title;
-  }
-
-  // "Sheet1!A3:" -> "Sheet1" -> start from A3 and go column per column on the response returning all cells that are on row 3 or above
-  if (ri[ri.length - 1] === ":") {
-    return title;
-  }
-  // "Sheet1!1:2" -> all the cells in the first two rows of Sheet1
-  // const patternMatch = ri.match(/([a-zA-Z]*)(\d*):([a-zA-Z]*)(\d*)/);
-  // if (patternMatch && patternMatch[1] === '' && patternMatch[3] === '') {
-  //   return title;
-  // }
-
   return `${title}!${ri}`;
-  // return title;
 };
 
+/**
+ * Get total count of rows and columns in a data array
+ * @param {Array} data Title, name of the sheet
+ * @return {Array<number>} Total count of rows and columns
+*/
+Sheets.prototype.getRowAndColCount = (data) => {
+  const dataArray = data || [];
+  let col = 0;
+  
+  for (let r = 0; r < dataArray.length; r += 1) {
+    for (let c = 0; c < dataArray[r].length; c += 1) {
+      if (c >= col) {
+        col = col + c;
+      }
+    }
+  }
+  return [dataArray.length, col];
+}
+
+/**
+ * Get total count of rows and columns in a data array
+ * @param {Array} data Title, name of the sheet
+ * @return {Array<number>} Total count of rows and columns
+*/
+Sheets.prototype.paddedEmptyMatrix = (totalRow = 0, totalCol = 0, startRow = 1, startCol = 1) => {
+  return [...Array(totalRow)]
+  .map((_ ,r) =>
+    [...Array(totalCol)]
+       .map((__, c) => ({ row: r+startRow, column: excelColumnName.intToExcelCol(c+startCol), content: '' }))
+  )
+}
 
- Sheets.prototype.fullDataMatrix = function (data, range) {
-  const parts = range//'D1:D5'//'C5:A1'//'A1:B2'//'A1:C5'//'B2:C2';
-  const partsMatch = parts.match(/([a-zA-Z]*)(\d*):([a-zA-Z]*)(\d*)/);
-  let noOfColumns = 0;
+/**
+ * Creates a full, padded matrix
+ * if the range is like 'A3:' or 'B1:C2' and there are missing
+ * cells (no content) this function adds them there (unlike other functions),
+ * thus you'll always have full matrix like B1:C2 -->
+ * [
+      [
+        { row: 1, column: "B", content: "B1" },
+        { row: 1, column: "C", content: "C1" },
+      ],
+      [
+        { row: 2, column: "B", content: "" },
+        { row: 2, column: "C", content: "C2" },
+      ],
+    ]
+ * or in either case it will return raw v4 response like, A:B --> [[A1, B1], ['', B2]]
+ * 
+ * @param  {Array}   data     Sheet document id
+ * @param  {String}  rangeInfo Range info
+ * @return {Array}          Rows containing cells
+ */
+Sheets.prototype.paddedDataMatrix = function (data, rangePattern) {
+  let noOfCols = 0;
   let startCol = 0;
   let noOfRows = 0;
   let startRow = 0;
-
-  // No column specified --> '1:2'
-  if(partsMatch[1] === '' && partsMatch[3] === ''){
-    let col = 0;
-    
-    for (let r = 0; r < data.length; r += 1) {
-      for (let c = 0; c < data[r].length; c += 1) {
-        if (c >= col) {
-          col = col + c;
-        }
-      }
-    }
-    noOfRows = Math.abs(+partsMatch[4] - +partsMatch[2]) + 1;
-    startRow = Math.min(+partsMatch[2], +partsMatch[4]);
-    noOfColumns = col;
-    startCol = 1;
-  } 
-  // No row specified --> 'A:B' OR 'A:A' OR 'B:B'
-  else if (partsMatch[2] === '' && partsMatch[4] === '') {
-    noOfRows = data.length;
-    startRow = 1;
-    noOfColumns = Math.abs(
-      excelColumnName.excelColToInt(partsMatch[3]) - excelColumnName.excelColToInt(partsMatch[1])
-    ) + 1;
-    startCol = Math.min(excelColumnName.excelColToInt(partsMatch[1]), excelColumnName.excelColToInt(partsMatch[3]))
-  }
-  // Only 1st part of a range specified --> 'A3:'
-  else if (partsMatch[3] === '' && partsMatch[4] === '') {
-    let col = 0;
-    
-    for (let r = 0; r < data.length; r += 1) {
-      for (let c = 0; c < data[r].length; c += 1) {
-        if (c >= col) {
-          col = col + c;
-        }
-      }
-    }
-    startRow = +partsMatch[2];
+  let nMatrix = [];
+  const [row, col] = this.getRowAndColCount(data);
+  const [_, pattern1, pattern2, pattern3, pattern4] = rangePattern || [];
+  const specialPatternType1 = [pattern3, pattern4].every(value => value === ''); // 'A3:'
+
+  if(!rangePattern){
+    nMatrix = this.paddedEmptyMatrix(row, col);
+  } else if (specialPatternType1) {
+    startRow = +pattern2;
     noOfRows = Math.abs(data.length - startRow) + 1;
-    startCol = excelColumnName.excelColToInt(partsMatch[1]);
-    noOfColumns = Math.abs(col - startCol) + 1;
-
-    console.log('results-->', startRow, startCol, noOfRows, noOfColumns, partsMatch[1], excelColumnName.excelColToInt(partsMatch[1]))
-  } 
-  // full range specified --> 'A1:C5'
-  else {
-    noOfRows = Math.abs(+partsMatch[4] - +partsMatch[2]) + 1;
-    startRow = Math.min(+partsMatch[2], +partsMatch[4]);
-    noOfColumns = Math.abs(
-      excelColumnName.excelColToInt(partsMatch[3]) - excelColumnName.excelColToInt(partsMatch[1])
+    startCol = excelColumnName.excelColToInt(pattern1);
+    noOfCols = Math.abs(col - startCol) + 1;
+    nMatrix = this.paddedEmptyMatrix(noOfRows, noOfCols, startRow, startCol);
+  } else {
+    noOfRows = Math.abs(+pattern4 - +pattern2) + 1;
+    startRow = Math.min(+pattern2, +pattern4);
+    noOfCols = Math.abs(
+      excelColumnName.excelColToInt(pattern3) - excelColumnName.excelColToInt(pattern1)
     ) + 1;
-    startCol = Math.min(excelColumnName.excelColToInt(partsMatch[1]), excelColumnName.excelColToInt(partsMatch[3]))
+    startCol = Math.min(excelColumnName.excelColToInt(pattern1), excelColumnName.excelColToInt(pattern3));
+    nMatrix = this.paddedEmptyMatrix(noOfRows, noOfCols, startRow, startCol);
   }
 
-  const nMatrix = [...Array(noOfRows)]
-    .map((_ ,r) =>
-      [...Array(noOfColumns)]
-        .map((__, c) => ({ row: r+startRow, col: c+startCol, content: '' }))
-    )
-  console.log('nMatrix', nMatrix)
   for (let r = 0; r < nMatrix.length; r += 1) {
     for (let c = 0; c < nMatrix[r].length; c += 1) {
-      // console.log('data--->', r, c, data[r+startRow-1][c+startCol-1], nMatrix[r][c])
-      // const startRowIndex = startRow - 1;
-      // const startColIndex = startCol - 1;
-      // console.log('results-->', startRow, startCol, data[r+startRowIndex][c+startColIndex])
-      nMatrix[r][c].content = (data  === undefined || data[r][c] === undefined) ? '' : data[r][c];
+      if (specialPatternType1) {
+        const startRowIndex = startRow - 1;
+        const startColIndex = startCol - 1;
+        nMatrix[r][c].content = (data  === undefined || data[r+startRowIndex][c+startColIndex] === undefined) 
+        ? '' 
+        : data[r+startRowIndex][c+startColIndex];
+      } else {
+        nMatrix[r][c].content = (data  === undefined || data[r][c] === undefined) 
+        ? '' 
+        : data[r][c];
+      }
+
     }
   }
   return nMatrix;
 }
 
 /**
- * Retrieve cells based on given range
- * NOTE: If there are missing cells (no content) this function
- * adds them there (unlike other functions), thus you'll always
- * have full matrix
+ * Retrieve cells data based on given range
+ * 
+ *  * All below ranges are v4 compatible but full matrix are [SUPPORTED] only for few of them:
+ *
+ * -  [SUPPORTED] "Sheet1!A1:B2" refers to the first two cells in the top two rows of Sheet1.
+ * -  [SUPPORTED] "A3:" refres to all cells starts from 'A' column and 3rd row.
+ * - "Sheet1!A:A" refers to all the cells in the first column of Sheet1.
+ * - "Sheet1!1:2" refers to all the cells in the first two rows of Sheet1.
+ * - "Sheet1!A5:A" refers to all the cells of the first column of Sheet 1, from row 5 onward.
+ * - [SUPPORTED]"Sheet1" refers to all the cells in Sheet1.
+ * - "'My Custom Sheet'!A:A" refers to all the cells in a sheet named "My Custom Sheet."
+ *   Single quotes are required for sheet names with spaces, special characters, or an alphanumeric combination.
+ *
  *
  * @param  {String} docId     Sheet document id
  * @param  {String} sheetId   Sheet id
- * @param  {Mixed}  rangeInfo Range info. use sheets A1 notation for this https://developers.google.com/sheets/api/guides/concepts
- * @return {Promise<{ row: Number, column: String, content: String }[]>}          Rows containing cells, like [[{A1}, {B1}], [{A2}, {B2}]]
+ * @param  {Mixed}  rangeInfo Range info.
+ * @return {Promise}          Rows containing cells
  */
 Sheets.prototype.getRange = async function(docId, sheetId, rangeInfo) {
   try {
     const [{ title }, sheets] = await Promise.all([
       this.getSheet(docId, sheetId),
       this.get()
     ]);
-    const range = this.toV4Range(title, rangeInfo);
+
     const request = {
       spreadsheetId: docId,
-      range
+      range: this.v4RangeSanitizer(title, rangeInfo)
     }
-    const sheet = await sheets.spreadsheets.values.get(request);
-    console.log('Actual data-->', sheet.data.values)
-    return this.fullDataMatrix(sheet.data.values, rangeInfo);
-    // const patternMatch = ![undefined, null].includes(rangeInfo) 
-    //             ? rangeInfo.match(/([a-zA-Z]*)(\d*):([a-zA-Z]*)(\d*)/)
-    //             : null
-    // const sheet = await sheets.spreadsheets.values.get(request);
-    // console.log('Actual data-->', sheet.data.values)
-    // const fullMatrix = this.fullDataMatrix(sheet.data.values);
-    
-    // if(patternMatch && patternMatch[1] === '' && patternMatch[3] === ''){ // range 'Sheet1!1:2'
-    //   return fullMatrix.slice(patternMatch[2] - 1, patternMatch[4]);
-    // } else if (patternMatch && patternMatch[3] === '' && patternMatch[4] === '') { // range 'Sheet1!A3:'
-    //   return fullMatrix.slice(patternMatch[2] - 1, fullMatrix.length);
-    // } 
-    // else { // range "Sheet1"
-    //   return fullMatrix;
-    // }
-    
+
+    if (!rangeInfo) {
+      const req = {
+        ...request,
+        range: title
+      }
+      const sheet = await sheets.spreadsheets.values.get(req);
+      return this.paddedDataMatrix(sheet.data.values);
+    } else {
+      const rangePattern = rangeInfo.match(/([a-zA-Z]*)(\d*):([a-zA-Z]*)(\d*)/);
+      const [_, pattern1, pattern2, pattern3, pattern4] = rangePattern;
+      const patternType1 = [pattern3, pattern4].every(value => value === ''); // 'A3:'
+      const patternType2 = [pattern1, pattern2, pattern3, pattern4].every(value => value !== ''); // 'A1:C10'
+
+      if (patternType1) {
+        const req = {
+          ...request,
+          range: title
+        }
+        const sheet = await sheets.spreadsheets.values.get(req);
+        return this.paddedDataMatrix(sheet.data.values, rangePattern);
+      } else if(patternType2) {
+        const sheet = await sheets.spreadsheets.values.get(request);
+        return this.paddedDataMatrix(sheet.data.values, rangePattern);
+      } else { // 'A:A' or '1:2' or 'A3:A' or 'Sheet1'
+        const sheet = await sheets.spreadsheets.values.get(request);
+        console.log('data->', sheet.data.values, request)
+        return sheet.data.values || [];
+      }
+    }
+
   } catch(error) {
     throw new Error(error);
   }

spec/cells.json

@@ -46,13 +46,11 @@ describe("Sheets", function () {
               },
               values: {
                 get: function ({range}) {
-                  console.log('<range>', range)
                   // Partial range --> 'Sheet1!'
                   if(range.includes('!')) {
                     // 'Sheet1!A3:A'
-                    const match = range.match(/([a-zA-Z]+)(\d+):([a-zA-Z]+)(\d*)/);
-                    console.log('<match>', match)
-                    if (match[1] === match[3]) {
+                    const partsMatch = range.match(/([a-zA-Z]+)(\d+):([a-zA-Z]+)(\d*)/);
+                    if (partsMatch[1] === partsMatch[3]) {
                       return Promise.resolve(rangeOfValues2)
                     }
                     return Promise.resolve(rangeOfValues1);
@@ -138,15 +136,12 @@ describe("Sheets", function () {
       //   [ { row: 9, column: 'A', content: 'A9' }, { row: 9, column: 'B', content: '' }, { row: 9, column: 'C', content: '' } ],
       //   [ { row: 10, column: 'A', content: 'A10' }, { row: 10, column: 'B', content: '' }, { row: 10, column: 'C', content: '' } ],
       // ]
-
-      // console.log('<ROWS>', rows)
       expect(rows.length).toBe(8);
       expect(rows[0].length).toBe(3);
       done();
     });
   });
 
-  // DONE
   it("returns rows with full range", function (done) {
     sheets.getRange(null, 807593019, "B1:C2").then(function (rows) {
       // rows = [
@@ -165,11 +160,8 @@ describe("Sheets", function () {
     });
   });
 
-  // DONE
   it("returns rows with no range", function (done) {
     sheets.getRange(null, 807593019, null).then(function (rows) {
-      console.log('<Rows>', rows)
-      // console.log('<<ROWS>>', rows)
       // rows = [
       //   [
       //     { row: 1, column: "A", content: "A1" },