Added a get and set table function, updated index.js, and various other functions to accomodate tables into the header and footer pages

Author: OwainJones

fixtures/tables_test.xlsx

@@ -65,7 +65,7 @@
             Table '{{ table.name }}' is empty
             </div>
           {% else %}
-            {% set caption = importerGetTableCaption2(data, "First", 10, sheet.name, table.name) %}
+            {% set caption = importerGetTableCaption(data, "First", 10, sheet.name, table.name) %}
             {{ tableView({
               caption: caption,
               showHeaders: true,

lib/importer/nunjucks/importer/macros/table_selector.njk

@@ -79,6 +79,11 @@ exports.SessionGetSheets = (sid) => {
   return session.sheetNames
 };
 
+exports.SessionGetTables = (sid, sheetName) => {
+  let session = sessionStore.get(sid);
+  return session.tables[sheetName]
+};
+
 exports.SessionSetHeaderRange = (sid, range) => {
   assert(range != null, "Null range passed to SessionSetHeaderRange");
   assert(range.sheet != null, "Range with null sheet passed to SessionSetHeaderRange");

lib/importer/src/dudk/backend.js

@@ -266,7 +266,8 @@ exports.GetRows = (sid, sheet, start = 0, count = 10) => {
 
   // Try to provide rows from start to start+count-1, but limit ourselves to
   // the rows in the sheet.
-  const rowRange = {
+
+  rowRange = {
     sheet: sheet,
     start: { row: start, column: 0 },
     end: { row: Math.min(start + count, sheetDimensions.rows), column: sheetDimensions.columns - 1 }
@@ -277,7 +278,32 @@ exports.GetRows = (sid, sheet, start = 0, count = 10) => {
   return processMergedCells(rowRange.end.column - rowRange.start.column + 1, preview);
 };
 
-exports.GetRowRangeFromEnd = (sid, sheet, count = 10) => {
+exports.GetRowsTable = (sid, sheet, start = 0, count = 10, table=null) => {
+  const tableRangeContainer = backend.SessionGetInputTableRanges(sid, sheet).get(table);  
+  assert(tableRangeContainer, `Table Range ${table} not found in ${sheet}` )
+  rowRange = {
+    sheet: sheet,
+    start: tableRangeContainer.range.start,
+    end: { row: Math.min(tableRangeContainer.range.start.row + count, tableRangeContainer.range.end.row), column: tableRangeContainer.range.end.column }
+  }
+  const wantedRows = rowRange.end.row - rowRange.start.row
+  const preview = backend.SessionGetInputSampleRows(sid, rowRange, wantedRows, 0, 0)[0];
+  
+  return processMergedCells(rowRange.end.column - rowRange.start.column + 1, preview);    
+};
+
+exports.GetRowRangeFromEnd = (sid, sheet, count = 10, table = null) => {
+  if (table) {
+    const tableRangeContainer = backend.SessionGetInputTableRanges(sid, sheet).get(table); 
+    const tableRange = tableRangeContainer.range
+    console.debug('Table range:', tableRange)
+    return {
+      sheet: sheet,
+      start: { row: Math.max(tableRange.end.row - count, tableRange.start.row), column: tableRange.start.column},
+      end: tableRange.end 
+    }
+  }
+
   const sheetDimensions = backend.SessionGetInputDimensions(sid)
     .sheetDimensions.get(sheet);
 
@@ -286,6 +312,7 @@ exports.GetRowRangeFromEnd = (sid, sheet, count = 10) => {
   const hRange = backend.SessionGetHeaderRange(sid, sheet)
 
   const end = sheetDimensions.rows - 1;
+  
   return {
     sheet: sheet,
     start: { row: Math.max(end - count, hRange.start.row + 1), column: hRange.start.column },
@@ -296,7 +323,15 @@ exports.GetRowRangeFromEnd = (sid, sheet, count = 10) => {
 // Given a session id and a sheet returns up to count rows.
 exports.GetTrailingRows = (sid, sheet, count = 10) => {
   const hRange = backend.SessionGetHeaderRange(sid, sheet);
-  const rowRange = exports.GetRowRangeFromEnd(sid, sheet, count)
+  const rowRange = exports.GetRowRangeFromEnd(sid, sheet, count);
+  const wantedRows = Math.min(count, rowRange.end.row - hRange.end.row);
+  return backend.SessionGetInputSampleRows(sid, rowRange, 0, 0, wantedRows)[2];
+};
+
+// Given a session id, a sheet and a table returns up to count rows.
+exports.GetTrailingRowsTable = (sid, sheet, table, count = 10) => {
+  const hRange = backend.SessionGetHeaderRange(sid, sheet);
+  const rowRange = exports.GetRowRangeFromEnd(sid, sheet, count, table);
   const wantedRows = Math.min(count, rowRange.end.row - hRange.end.row);
   return backend.SessionGetInputSampleRows(sid, rowRange, 0, 0, wantedRows)[2];
 };

lib/importer/src/dudk/sheets.js

@@ -77,6 +77,9 @@ const importerErrorMappingData = (error, key) => {
 const importerGetRows = (data, start, count) => {
     const session_data = data[IMPORTER_SESSION_KEY];
     const session = new session_lib.Session(session_data)
+    if (session.table & session.table != null) {
+        return sheets_lib.GetRowsTable(session.backendSid, session.sheet, start, count, session.table)
+    }
     return sheets_lib.GetRows(session.backendSid, session.sheet, start, count);
 }
 
@@ -87,6 +90,9 @@ const importerGetRows = (data, start, count) => {
 const importerGetTrailingRows = (data, count) => {
     const session_data = data[IMPORTER_SESSION_KEY];
     const session = new session_lib.Session(session_data)
+    if (session.table & session.table != null) {
+        return sheets_lib.GetTrailingRowsTable(session.backendSid, session.sheet, session.table, count);
+    }
     return sheets_lib.GetTrailingRows(session.backendSid, session.sheet, count);
 }
 
@@ -99,35 +105,38 @@ const importerGetTrailingRows = (data, count) => {
 //     "All {n} rows of {sheet}"
 //--------------------------------------------------------------------
 const importerGetTableCaption =
-    (data, prefix, rowsAskedFor, sheetName = null) => {
+    (data, prefix, rowsAskedFor=10, sheetName = null, tableName = null) => {
+        console.debug("Table Name:", tableName)
         const session_data = data[IMPORTER_SESSION_KEY];
         const session = new session_lib.Session(session_data)
+        console.debug(session.sheet)
+        console.debug(session.table)
+        console.debug(session.headerRange)
 
         const sheet = (sheetName ??= session.sheet);
+        const table = (tableName ??= session.table);
+        console.debug(table)
+        
+        if (table) {  
+            console.debug('There is a table')          
+            const rowCount = sheets_lib.GetTableRows(session.backendSid, sheet, table)   
+
+            if (rowCount > rowsAskedFor) {
+                return `${prefix} ${rowsAskedFor} rows of '${tableName}'`;
+            }
+
+            return `All ${rowCount} rows of '${tableName}'`;
+        }
         const rowCount = sheets_lib.GetTotalRows(session.backendSid, sheet);
 
         if (rowCount > rowsAskedFor) {
             return `${prefix} ${rowsAskedFor} rows of '${sheet}'`;
         }
 
+        console.debug(`All rows of '${sheet}'`)
         return `All rows of '${sheet}'`;
     }
-
-const importerGetTableCaption2 = 
-    (data, prefix, rowsAskedFor, sheetName = null, tableName = null) => {
-        const session_data = data[IMPORTER_SESSION_KEY];
-        const session = new session_lib.Session(session_data)
-
-        const sheet = (sheetName ??= session.sheet)
-        const table = (tableName ??= sheet["!tables"].table.tableName)
-        const rowCount = sheets_lib.GetTableRows(session.backendSid, sheet, table)   
-
-        if (rowCount > rowsAskedFor) {
-            return `${prefix} ${rowsAskedFor} rows of '${tableName}'`;
-        }
-
-        return `All ${numberRows} rows of '${tableName}'`;
-    }
+    
 //--------------------------------------------------------------------
 // In the absence of a step to choose headers, we will instead provide
 // a function that will allow the system to get the headers for the
@@ -286,7 +295,6 @@ module.exports = {
     importerGetHeaders,
     importerGetTrailingRows,
     importerGetTableCaption,
-    importerGetTableCaption2,
     importerMappedData,
     importerHeaderRowDisplay,
     data_sum,

lib/importer/src/functions.js

@@ -270,40 +270,36 @@ exports.Initialise = (config, router, prototypeKit) => {
 
       if (request.body.table == "no_table") {
         console.debug("No table")
-        redirectOnwards(request, response); //if no table is selected we don't need to persist one
-        return;
+        session.table = null
+        //redirectOnwards(request, response); //if no table is selected we don't need to persist one
+        //return;
+      } else {
+        session.table = request.body.table;
+        let check = sheets_lib.GetTablePreview(session.backendSid, session.sheet, session.table);
+        if (check == null) {
+          request.session.data[IMPORTER_ERROR_KEY] =
+            "Please select a non-empty table";
+          response.redirect(request.get("Referrer"));
+          return;
+        }
+        // Get header range, for tables this will check the column names against the first row of the table.
+        // If they match that first row will be designated as the headerRange, otherwise it will be null.
+        headerRange = sheets_lib.GetTableHeader(session.backendSid, session.sheet, session.table)
+        console.debug(headerRange)
+        if (headerRange != null) {
+          session.headerRange = headerRange //overwrite assumed header range with table header range
+        }
       }
-
-      console.debug(session.footerRange)
-
-      session.table = request.body.table;
 
-      let check = sheets_lib.GetTablePreview(session.backendSid, session.sheet, session.table);
-      if (check == null) {
-        request.session.data[IMPORTER_ERROR_KEY] =
-          "Please select a non-empty table";
-        response.redirect(request.get("Referrer"));
-        return;
-      }
-
-      // In some cases, the user will next select a header row which tells us where
-      // the headers are. Sometimes, this will not be part of the flow, and so we
-      // should default to the first row in the sheet.
-      headerRange = sheets_lib.GetTableHeader(session.backendSid, session.sheet, session.table)
-      console.debug("header range", headerRange);
-      if (headerRange == null) {
-        request.session.data[IMPORTER_ERROR_KEY] = 
-          "Column names for table are not in the first row";
-        response.redirect(request.get("Referrer"));
-        return;
-      }
-
-      session.headerRange = headerRange //overwrite assumed header range with table header range
-
       // The user
 
       // Ensure the session is persisted. Currently in session, eventually another way
       request.session.data[IMPORTER_SESSION_KEY] = session;
+
+      if (headerRange == null) {
+        redirectOnwards(request, response); 
+        return;
+      }
 
       if ("other" in request.query) {
         const otherPage = decodeURIComponent(request.query.other)

lib/importer/src/index.js

@@ -16,12 +16,17 @@ class Session {
 
     this.fields = p.fields;
     this.sheet = p.sheet ?? "";
+    this.table = p.table ?? "";
   }
 
   get sheets() {
     return backend.SessionGetSheets(this.backendSid)
   }
 
+  get tables() {
+    return backend.SessionGetTables(this.backendSid, this.sheet)
+  }
+
   get headerRange() {
     return backend.SessionGetHeaderRange(this.backendSid, this.sheet)
   }