[FIX] xlsx: import data validation rules with formula

Data validations rules with formulas were not correctly imported,
ad they are not prefixed by "=" in the xlsx, but should be in
o-spreadsheet.

closes #7269

Task: 5062253
X-original-commit: d261046
Signed-off-by: Lucas Lefèvre (lul) <lul@odoo.com>
Signed-off-by: Adrien Minne (adrm) <adrm@odoo.com>

Author: hokolomopo

src/xlsx/conversion/cf_conversion.ts

@@ -1,5 +1,4 @@
 import { ICON_SETS } from "../../components/icons/icons";
-import { tokenize } from "../../formulas";
 import {
   ColorScaleMidPointThreshold,
   ColorScaleThreshold,
@@ -8,6 +7,7 @@ import {
   IconThreshold,
 } from "../../types";
 import { ExcelIconSet, XLSXConditionalFormat, XLSXDxf } from "../../types/xlsx";
+import { prefixFormulaWithEqual } from "../helpers/misc";
 import { WarningTypes, XLSXImportWarningManager } from "../helpers/xlsx_parser_error_manager";
 import { convertColor, hexaToInt } from "./color_conversion";
 import {
@@ -84,9 +84,9 @@ export function convertConditionalFormats(
       case "cellIs":
         if (!rule.operator || !rule.formula || rule.formula.length === 0) continue;
         operator = convertCFCellIsOperator(rule.operator);
-        values.push(prefixFormula(rule.formula[0]));
+        values.push(prefixFormulaWithEqual(rule.formula[0]));
         if (rule.formula.length === 2) {
-          values.push(prefixFormula(rule.formula[1]));
+          values.push(prefixFormulaWithEqual(rule.formula[1]));
         }
         break;
     }
@@ -269,12 +269,6 @@ function convertIcons(xlsxIconSet: ExcelIconSet, index: number): string {
     : ICON_SETS[iconSet].good;
 }
 
-/** Prefix the string by "=" if the string looks like a formula */
-function prefixFormula(formula: string): string {
-  const tokens = tokenize(formula);
-  return tokens.length === 1 && tokens[0].type !== "REFERENCE" ? formula : "=" + formula;
-}
-
 // ---------------------------------------------------------------------------
 // Warnings
 // ---------------------------------------------------------------------------

src/xlsx/conversion/data_validation_conversion.ts

@@ -7,6 +7,7 @@ import {
   DateIsNotBetweenCriterion,
 } from "../../types";
 import { XLSXDataValidation } from "../../types/xlsx";
+import { prefixFormulaWithEqual } from "../helpers/misc";
 import { WarningTypes, XLSXImportWarningManager } from "../helpers/xlsx_parser_error_manager";
 import {
   XLSX_DV_DATE_OPERATOR_TO_DV_TYPE_MAPPING,
@@ -42,7 +43,7 @@ export function convertDataValidationRules(
         dvRules.push(decimalRule);
         break;
       case "list":
-        const listRule = convertListrule(dvId++, dv);
+        const listRule = convertListRule(dvId++, dv);
         dvRules.push(listRule);
         break;
       case "date":
@@ -65,9 +66,9 @@ export function convertDataValidationRules(
 }
 
 function convertDecimalRule(id: number, dv: XLSXDataValidation): DataValidationRuleData {
-  const values = [dv.formula1.toString()];
+  const values = [prefixFormulaWithEqual(dv.formula1.toString())];
   if (dv.formula2) {
-    values.push(dv.formula2.toString());
+    values.push(prefixFormulaWithEqual(dv.formula2.toString()));
   }
   return {
     id: id.toString(),
@@ -80,7 +81,7 @@ function convertDecimalRule(id: number, dv: XLSXDataValidation): DataValidationR
   };
 }
 
-function convertListrule(id: number, dv: XLSXDataValidation): DataValidationRuleData {
+function convertListRule(id: number, dv: XLSXDataValidation): DataValidationRuleData {
   const formula1 = dv.formula1.toString();
   const isRangeRule = rangeReference.test(formula1);
   return {
@@ -97,9 +98,9 @@ function convertListrule(id: number, dv: XLSXDataValidation): DataValidationRule
 
 function convertDateRule(id: number, dv: XLSXDataValidation): DataValidationRuleData {
   let criterion: DataValidationDateCriterion | DateIsBetweenCriterion | DateIsNotBetweenCriterion;
-  const values = [dv.formula1.toString()];
+  const values = [prefixFormulaWithEqual(dv.formula1.toString())];
   if (dv.formula2) {
-    values.push(dv.formula2.toString());
+    values.push(prefixFormulaWithEqual(dv.formula2.toString()));
     criterion = {
       type: XLSX_DV_DATE_OPERATOR_TO_DV_TYPE_MAPPING[dv.operator],
       values: getDateCriterionFormattedValues(values, DEFAULT_LOCALE),
@@ -126,7 +127,7 @@ function convertCustomRule(id: number, dv: XLSXDataValidation): DataValidationRu
     isBlocking: dv.errorStyle !== "warning",
     criterion: {
       type: "customFormula",
-      values: [`=${dv.formula1.toString()}`],
+      values: [prefixFormulaWithEqual(dv.formula1.toString())],
     },
   };
 }

src/xlsx/helpers/misc.ts

@@ -1,3 +1,4 @@
+import { tokenize } from "../../formulas/tokenizer";
 import { Dimension, ExcelHeaderData, ExcelSheetData } from "../../types";
 
 /**
@@ -80,3 +81,12 @@ export function getSheetDataHeader(
   }
   return sheetData.rows[index];
 }
+
+/** Prefix the string by "=" if the string looks like a formula */
+export function prefixFormulaWithEqual(formula: string): string {
+  if (formula[0] === "=") {
+    return formula;
+  }
+  const tokens = tokenize(formula);
+  return tokens.length === 1 && tokens[0].type !== "REFERENCE" ? formula : "=" + formula;
+}

tests/__xlsx__/xlsx_demo_data.xlsx

@@ -408,6 +408,18 @@ describe("Import xlsx data", () => {
     });
   });
 
+  test("Can import a data validation rule with a formula", () => {
+    const testSheet = getWorkbookSheet("jestDataValidations", convertedData)!;
+    const dvRule = getDataValidationBeginningAt("J2", testSheet);
+    expect(dvRule).toMatchObject({
+      criterion: {
+        type: "isBetween",
+        values: ["=$A$2", "=2+10"],
+      },
+      ranges: ["J2:J6"],
+    });
+  });
+
   test.each([
     ["2 colors max", "H2"],
     ["3 colors max", "H3"],