[IMP] Data filter: Trim whitespace

[Data filter] Trim whitespace and don't bother of caps vs low case when filtering
Changes done in the filters by values and by criterion

Task:5375214

Author: matho-odoo

packages/o-spreadsheet-engine/src/helpers/text_helper.ts

@@ -297,6 +297,11 @@ export function toLowerCase(str: string | undefined): string {
   return str ? str.toLowerCase() : "";
 }
 
+/** Transform a string to lowercase and removes whitespace from both ends of the string*/
+export function normalize(value: string): string {
+  return toLowerCase(value).trim();
+}
+
 /**
  * Extract the fontSize from a context font string
  * @param font The (context) font string to parse

packages/o-spreadsheet-engine/src/plugins/ui_stateful/filter_evaluation.ts

@@ -2,7 +2,7 @@ import { isMultipleElementMatrix, toScalar } from "../../functions/helper_matric
 import { parseLiteral } from "../../helpers/cells/cell_evaluation";
 import { toXC } from "../../helpers/coordinates";
 import { deepCopy, getUniqueText, range } from "../../helpers/misc";
-import { toLowerCase } from "../../helpers/text_helper";
+import { normalize } from "../../helpers/text_helper";
 import { positions, toZone, zoneToDimension } from "../../helpers/zones";
 import { criterionEvaluatorRegistry } from "../../registries/criterion_registry";
 import { Command, CommandResult, LocalCommand, UpdateFilterCommand } from "../../types/commands";
@@ -163,7 +163,7 @@ export class FilterEvaluationPlugin extends UIPlugin {
         continue;
       }
       if (filterValue.filterType === "values") {
-        const filteredValues = filterValue.hiddenValues?.map(toLowerCase);
+        const filteredValues = filterValue.hiddenValues?.map(normalize);
         if (!filteredValues) continue;
         const filteredValuesSet = new Set(filteredValues);
         for (let row = filteredZone.top; row <= filteredZone.bottom; row++) {
@@ -205,7 +205,7 @@ export class FilterEvaluationPlugin extends UIPlugin {
 
   private getCellValueAsString(sheetId: UID, col: number, row: number): string {
     const value = this.getters.getEvaluatedCell({ sheetId, col, row }).formattedValue;
-    return value.toLowerCase();
+    return normalize(value);
   }
 
   exportForExcel(data: ExcelWorkbookData) {

packages/o-spreadsheet-engine/src/registries/criterion_registry.ts

@@ -20,6 +20,7 @@ import { detectLink } from "../helpers/links";
 import { localizeContent } from "../helpers/locale";
 import { isNumberBetween } from "../helpers/misc";
 import { rangeReference } from "../helpers/references";
+import { normalize } from "../helpers/text_helper";
 import { _t } from "../translation";
 import { CellValue } from "../types/cells";
 import {
@@ -115,8 +116,8 @@ criterionEvaluatorRegistry.add("notContainsText", {
 criterionEvaluatorRegistry.add("isEqualText", {
   type: "isEqualText",
   isValueValid: (value: CellValue, criterion: EvaluatedCriterion) => {
-    const strValue = String(value);
-    return strValue.toLowerCase() === String(criterion.values[0]).toLowerCase();
+    const strValue = normalize(String(value));
+    return strValue === normalize(String(criterion.values[0]));
   },
   getErrorString: (criterion: EvaluatedCriterion) => {
     return _t('The value must be exactly "%s"', String(criterion.values[0]));
@@ -663,8 +664,8 @@ criterionEvaluatorRegistry.add("customFormula", {
 criterionEvaluatorRegistry.add("beginsWithText", {
   type: "beginsWithText",
   isValueValid: (value: CellValue, criterion: EvaluatedCriterion) => {
-    const strValue = String(value);
-    return strValue.toLowerCase().startsWith(String(criterion.values[0]).toLowerCase());
+    const strValue = normalize(String(value));
+    return strValue.startsWith(normalize(String(criterion.values[0])));
   },
   getErrorString: (criterion: EvaluatedCriterion) => {
     return _t('The value must be a text that begins with "%s"', String(criterion.values[0]));
@@ -679,8 +680,8 @@ criterionEvaluatorRegistry.add("beginsWithText", {
 criterionEvaluatorRegistry.add("endsWithText", {
   type: "endsWithText",
   isValueValid: (value: CellValue, criterion: EvaluatedCriterion) => {
-    const strValue = String(value);
-    return strValue.toLowerCase().endsWith(String(criterion.values[0]).toLowerCase());
+    const strValue = normalize(String(value));
+    return strValue.endsWith(normalize(String(criterion.values[0])));
   },
   getErrorString: (criterion: EvaluatedCriterion) => {
     return _t('The value must be a text that ends with "%s"', String(criterion.values[0]));

src/components/filters/filter_menu_value_list/filter_menu_value_list.ts

@@ -1,6 +1,6 @@
 import { SpreadsheetChildEnv } from "@odoo/o-spreadsheet-engine/types/spreadsheet_env";
 import { Component, onWillUpdateProps, useRef, useState } from "@odoo/owl";
-import { deepEquals, positions, toLowerCase } from "../../../helpers";
+import { deepEquals, normalize, positions } from "../../../helpers";
 import { fuzzyLookup } from "../../../helpers/search";
 import { Position } from "../../../types";
 import { FilterMenuValueItem } from "../filter_menu_item/filter_menu_value_item";
@@ -76,12 +76,12 @@ export class FilterMenuValueList extends Component<Props, SpreadsheetChildEnv> {
 
     const cellValues = cells.map((val) => val.cellValue);
     const filterValues = filterValue?.filterType === "values" ? filterValue.hiddenValues : [];
-    const normalizedFilteredValues = new Set(filterValues.map(toLowerCase));
+    const normalizedFilteredValues = new Set(filterValues.map(normalize));
 
     const set = new Set<string>();
     const values: (Value & { normalizedValue: string })[] = [];
     const addValue = (value: string) => {
-      const normalizedValue = toLowerCase(value);
+      const normalizedValue = normalize(value);
       if (!set.has(normalizedValue)) {
         values.push({
           string: value || "",

tests/table/filter_evaluation_plugin.test.ts

@@ -161,6 +161,15 @@ describe("Filter Evaluation", () => {
     expect(model.getters.isRowHidden(sheetId, 2)).toEqual(true);
   });
 
+  test("Filters ignore whitespaces", () => {
+    setCellContent(model, "A2", "a");
+    setCellContent(model, "A3", " a");
+    setCellContent(model, "A4", "a ");
+    updateFilter(model, "A2", ["a"]);
+    expect(model.getters.isRowHidden(sheetId, 1)).toEqual(true);
+    expect(model.getters.isRowHidden(sheetId, 2)).toEqual(true);
+    expect(model.getters.isRowHidden(sheetId, 3)).toEqual(true);
+  });
   test("Header is not filtered", () => {
     updateFilter(model, "A1", ["A1"]);
     expect(model.getters.isRowHidden(sheetId, 0)).toEqual(false);
@@ -352,6 +361,30 @@ describe("Filter criterion test", () => {
     return range(0, 10).filter((row) => model.getters.isRowFiltered(sheetId, row));
   }
 
+  test.each([
+    ["beginsWithText", ["a"], []],
+    ["endsWithText", ["a"], []],
+    ["isEqualText", ["a"], []],
+  ])(
+    "Can filter based on a text criterion %s ignoring lowercase/uppercase and whitespaces",
+    (type: string, criterionValues: string[], expectedFilteredRows: number[]) => {
+      const grid = {
+        A2: "a",
+        A3: " a",
+        A4: "a ",
+        A5: "A",
+      };
+      setGrid(model, grid);
+      createTableWithFilter(model, "A1:A5");
+      updateFilterCriterion(model, "A1", {
+        type: type as FilterCriterionType,
+        values: criterionValues,
+      });
+
+      expect(getFilteredRows()).toEqual(expectedFilteredRows);
+    }
+  );
+
   test.each([
     ["isEmpty", [], [1, 2]],
     ["isNotEmpty", [], [3]],