refactor: use helper function for computing totals

dhis2 · Aug 15, 2023 · 01f201f · 01f201f
1 parent 2249e73
commit 01f201f
Show file tree

Hide file tree

Showing 3 changed files with 111 additions and 27 deletions.
diff --git a/src/modules/pivotTable/PivotTableEngine.js b/src/modules/pivotTable/PivotTableEngine.js
@@ -35,6 +35,7 @@ import {
     NUMBER_TYPE_ROW_PERCENTAGE,
     NUMBER_TYPE_VALUE,
 } from './pivotTableConstants.js'
+import { processTotalValue } from './processTotalValue.js'
 
 const dataFields = [
     'value',
@@ -705,9 +706,7 @@ export class PivotTableEngine {
                 dataFields.forEach((field) => {
                     const headerIndex = this.dimensionLookup.dataHeaders[field]
                     const value = parseValue(dataRow[headerIndex])
-                    if (!isNaN(value)) {
-                        totalCell[field] = (totalCell[field] || 0) + value
-                    }
+                    processTotalValue(value, totalCell, field)
                 })
             }
             totalCell.count += 1
@@ -724,10 +723,7 @@ export class PivotTableEngine {
             dataFields.forEach((field) => {
                 const headerIndex = this.dimensionLookup.dataHeaders[field]
                 const value = parseValue(dataRow[headerIndex])
-                if (!isNaN(value)) {
-                    percentageTotal[field] =
-                        (percentageTotal[field] || 0) + value
-                }
+                processTotalValue(value, percentageTotal, field)
             })
 
             if (totals.columnSubtotal) {
@@ -742,10 +738,7 @@ export class PivotTableEngine {
                 dataFields.forEach((field) => {
                     const headerIndex = this.dimensionLookup.dataHeaders[field]
                     const value = parseValue(dataRow[headerIndex])
-                    if (!isNaN(value)) {
-                        percentageTotal[field] =
-                            (percentageTotal[field] || 0) + value
-                    }
+                    processTotalValue(value, percentageTotal, field)
                 })
             }
 
@@ -761,10 +754,7 @@ export class PivotTableEngine {
                 dataFields.forEach((field) => {
                     const headerIndex = this.dimensionLookup.dataHeaders[field]
                     const value = parseValue(dataRow[headerIndex])
-                    if (!isNaN(value)) {
-                        percentageTotal[field] =
-                            (percentageTotal[field] || 0) + value
-                    }
+                    processTotalValue(value, percentageTotal, field)
                 })
             }
         }
@@ -780,10 +770,7 @@ export class PivotTableEngine {
             dataFields.forEach((field) => {
                 const headerIndex = this.dimensionLookup.dataHeaders[field]
                 const value = parseValue(dataRow[headerIndex])
-                if (!isNaN(value)) {
-                    percentageTotal[field] =
-                        (percentageTotal[field] || 0) + value
-                }
+                processTotalValue(value, percentageTotal, field)
             })
 
             if (totals.rowSubtotal) {
@@ -798,10 +785,7 @@ export class PivotTableEngine {
                 dataFields.forEach((field) => {
                     const headerIndex = this.dimensionLookup.dataHeaders[field]
                     const value = parseValue(dataRow[headerIndex])
-                    if (!isNaN(value)) {
-                        percentageTotal[field] =
-                            (percentageTotal[field] || 0) + value
-                    }
+                    processTotalValue(value, percentageTotal, field)
                 })
             }
 
@@ -817,10 +801,7 @@ export class PivotTableEngine {
                 dataFields.forEach((field) => {
                     const headerIndex = this.dimensionLookup.dataHeaders[field]
                     const value = parseValue(dataRow[headerIndex])
-                    if (!isNaN(value)) {
-                        percentageTotal[field] =
-                            (percentageTotal[field] || 0) + value
-                    }
+                    processTotalValue(value, percentageTotal, field)
                 })
             }
         }

diff --git a/src/modules/pivotTable/__tests__/processTotalValue.spec.js b/src/modules/pivotTable/__tests__/processTotalValue.spec.js
@@ -0,0 +1,98 @@
+import { processTotalValue } from '../processTotalValue.js'
+
+const field = 'test'
+const tests = [
+    {
+        testName: 'negative value',
+        value: -1,
+        totalObj: {},
+        field,
+        expected: -1,
+    },
+    {
+        testName: 'zero value',
+        value: 0,
+        totalObj: {},
+        field,
+        expected: 0,
+    },
+    {
+        testName: 'positive value',
+        value: 1,
+        totalObj: {},
+        field,
+        expected: 1,
+    },
+    {
+        testName: 'null value',
+        value: null,
+        totalObj: {},
+        field,
+        expected: undefined,
+    },
+    {
+        testName: 'undefined value',
+        value: undefined,
+        totalObj: {},
+        field,
+        expected: undefined,
+    },
+    {
+        testName: 'string value',
+        value: 'string',
+        totalObj: {},
+        field,
+        expected: undefined,
+    },
+    {
+        testName: 'negative value with existing total',
+        value: -1,
+        totalObj: { [field]: 100 },
+        field,
+        expected: 99,
+    },
+    {
+        testName: 'zero value with existing total',
+        value: 0,
+        totalObj: { [field]: 100 },
+        field,
+        expected: 100,
+    },
+    {
+        testName: 'positive value with existing total',
+        value: 1,
+        totalObj: { [field]: 100 },
+        field,
+        expected: 101,
+    },
+    {
+        testName: 'null value with existing total',
+        value: null,
+        totalObj: { [field]: 100 },
+        field,
+        expected: 100,
+    },
+    {
+        testName: 'undefined value with existing total',
+        value: undefined,
+        totalObj: { [field]: 100 },
+        field,
+        expected: 100,
+    },
+    {
+        testName: 'string value with existing total',
+        value: 'string',
+        totalObj: { [field]: 100 },
+        field,
+        expected: 100,
+    },
+]
+
+describe('processTotalValue', () => {
+    tests.forEach((t) => {
+        it(t.testName, () => {
+            processTotalValue(t.value, t.totalObj, t.field)
+            expect(t.totalObj[field]).toEqual(t.expected)
+        })
+    })
+})
diff --git a/src/modules/pivotTable/processTotalValue.js b/src/modules/pivotTable/processTotalValue.js
@@ -0,0 +1,5 @@
+export const processTotalValue = (value, totalObj, field) => {
+    if (typeof value === 'number' && Number.isFinite(value)) {
+        totalObj[field] = (totalObj[field] ?? 0) + value
+    }
+}