@odoo/o-spreadsheet 14.0.1 → 15.0.0

package/tests/model/plugins/chart_test.ts

@@ -1,562 +0,0 @@
-import { Model } from "../../../src";
-import { CancelledReason, Viewport } from "../../../src/types";
-import "../../canvas.mock";
-import { mockUuidV4To, testUndoRedo } from "../../helpers";
-jest.mock("../../../src/helpers/uuid", () => require("../../__mocks__/uuid"));
-
-let model: Model;
-const viewport: Viewport = {
-  bottom: 1000,
-  right: 1000,
-  left: 0,
-  top: 0,
-  height: 1000,
-  width: 1000,
-  offsetX: 0,
-  offsetY: 0,
-};
-
-beforeEach(() => {
-  model = new Model({
-    sheets: [
-      {
-        name: "Sheet1",
-        colNumber: 10,
-        rowNumber: 10,
-        rows: {},
-        cells: {
-          B1: { content: "first column dataset" },
-          C1: { content: "second column dataset" },
-          B2: { content: "10" },
-          B3: { content: "11" },
-          B4: { content: "12" },
-          C2: { content: "20" },
-          C3: { content: "19" },
-          C4: { content: "18" },
-          A2: { content: "P1" },
-          A3: { content: "P2" },
-          A4: { content: "P3" },
-
-          A8: { content: "first row dataset" },
-          A9: { content: "second row dataset" },
-          B7: { content: "P4" },
-          C7: { content: "P5" },
-          D7: { content: "P6" },
-          B8: { content: "30" },
-          C8: { content: "31" },
-          D8: { content: "32" },
-          B9: { content: "40" },
-          C9: { content: "41" },
-          D9: { content: "42" },
-        },
-      },
-    ],
-  });
-});
-
-describe("datasource tests", function () {
-  test("create chart with column datasets", () => {
-    model.dispatch("CREATE_CHART", {
-      id: "1",
-      sheetId: model.getters.getActiveSheet(),
-      definition: {
-        title: "test 1",
-        dataSets: ["Sheet1!B1:B4", "Sheet1!C1:C4"],
-        seriesHasTitle: true,
-        labelRange: "Sheet1!A2:A4",
-        type: "line",
-      },
-    });
-    expect(model.getters.getFigures(viewport)[0].data).toEqual({
-      dataSets: [
-        { dataRange: "B2:B4", labelCell: "B1" },
-        { dataRange: "C2:C4", labelCell: "C1" },
-      ],
-      labelRange: "Sheet1!A2:A4",
-      sheetId: model.getters.getActiveSheet(),
-      title: "test 1",
-      type: "line",
-    });
-    expect(model.getters.getChartRuntime("1")).toMatchSnapshot();
-  });
-
-  test("create chart with rectangle dataset", () => {
-    model.dispatch("CREATE_CHART", {
-      id: "1",
-      sheetId: model.getters.getActiveSheet(),
-      definition: {
-        title: "test 1",
-        dataSets: ["Sheet1!B1:C4"],
-        seriesHasTitle: true,
-        labelRange: "Sheet1!A2:A4",
-        type: "line",
-      },
-    });
-    expect(model.getters.getFigures(viewport)[0].data).toEqual({
-      dataSets: [
-        { dataRange: "B2:B4", labelCell: "B1" },
-        { dataRange: "C2:C4", labelCell: "C1" },
-      ],
-      labelRange: "Sheet1!A2:A4",
-      sheetId: model.getters.getActiveSheet(),
-      title: "test 1",
-      type: "line",
-    });
-  });
-
-  test("create chart with column datasets without series title", () => {
-    model.dispatch("CREATE_CHART", {
-      id: "1",
-      sheetId: model.getters.getActiveSheet(),
-      definition: {
-        title: "test 1",
-        dataSets: ["Sheet1!B2:B4", "Sheet1!C2:C4"],
-        seriesHasTitle: false,
-        labelRange: "Sheet1!A2:A4",
-        type: "line",
-      },
-    });
-    expect(model.getters.getFigures(viewport)[0].data).toEqual({
-      dataSets: [
-        { dataRange: "B2:B4", labelCell: undefined },
-        { dataRange: "C2:C4", labelCell: undefined },
-      ],
-      labelRange: "Sheet1!A2:A4",
-      sheetId: model.getters.getActiveSheet(),
-      title: "test 1",
-      type: "line",
-    });
-    const datasets = model.getters.getChartRuntime("1")!.data!.datasets!;
-    expect(datasets[0].label!.toString()).toEqual("Series 1");
-    expect(datasets[1].label!.toString()).toEqual("Series 2");
-  });
-
-  test("create chart with row datasets", () => {
-    model.dispatch("CREATE_CHART", {
-      id: "1",
-      sheetId: model.getters.getActiveSheet(),
-      definition: {
-        title: "test 1",
-        dataSets: ["Sheet1!A8:D8", "Sheet1!A9:D9"],
-        seriesHasTitle: true,
-        labelRange: "Sheet1!B7:D7",
-        type: "line",
-      },
-    });
-    expect(model.getters.getFigures(viewport)[0].data).toEqual({
-      dataSets: [
-        { dataRange: "B8:D8", labelCell: "A8" },
-        { dataRange: "B9:D9", labelCell: "A9" },
-      ],
-      labelRange: "Sheet1!B7:D7",
-      sheetId: model.getters.getActiveSheet(),
-      title: "test 1",
-      type: "line",
-    });
-  });
-
-  test("create chart with row datasets without series title", () => {
-    model.dispatch("CREATE_CHART", {
-      id: "1",
-      sheetId: model.getters.getActiveSheet(),
-      definition: {
-        title: "test 1",
-        dataSets: ["Sheet1!B8:D8", "Sheet1!B9:D9"],
-        seriesHasTitle: false,
-        labelRange: "Sheet1!B7:D7",
-        type: "line",
-      },
-    });
-    expect(model.getters.getFigures(viewport)[0].data).toEqual({
-      dataSets: [
-        { dataRange: "B8:D8", labelCell: undefined },
-        { dataRange: "B9:D9", labelCell: undefined },
-      ],
-      labelRange: "Sheet1!B7:D7",
-      sheetId: model.getters.getActiveSheet(),
-      title: "test 1",
-      type: "line",
-    });
-  });
-
-  test("create chart with only the dataset title (no data)", () => {
-    model.dispatch("CREATE_CHART", {
-      id: "1",
-      sheetId: model.getters.getActiveSheet(),
-      definition: {
-        title: "test 1",
-        dataSets: ["Sheet1!B8"],
-        seriesHasTitle: true,
-        labelRange: "Sheet1!B7:D7",
-        type: "line",
-      },
-    });
-    expect(model.getters.getFigures(viewport)[0].data).toEqual({
-      dataSets: [],
-      labelRange: "Sheet1!B7:D7",
-      sheetId: model.getters.getActiveSheet(),
-      title: "test 1",
-      type: "line",
-    });
-    expect(model.getters.getChartRuntime("1")!.data!.datasets!).toHaveLength(0);
-  });
-
-  test("create chart with a dataset of one cell (no title)", () => {
-    model.dispatch("CREATE_CHART", {
-      id: "1",
-      sheetId: model.getters.getActiveSheet(),
-      definition: {
-        title: "test 1",
-        dataSets: ["B8"],
-        seriesHasTitle: false,
-        labelRange: "B7",
-        type: "line",
-      },
-    });
-    expect(model.getters.getFigures(viewport)[0].data).toEqual({
-      dataSets: [
-        {
-          dataRange: "B8",
-        },
-      ],
-      labelRange: "B7",
-      sheetId: model.getters.getActiveSheet(),
-      title: "test 1",
-      type: "line",
-    });
-    const datasets = model.getters.getChartRuntime("1")!.data!.datasets!;
-    expect(datasets).toHaveLength(1);
-    expect(datasets[0].label!.toString()).toEqual("Series 1");
-  });
-
-  test("create chart with async as label", () => {
-    model.dispatch("SET_VALUE", { xc: "B7", text: "=WAIT(1000)" });
-    model.dispatch("CREATE_CHART", {
-      id: "1",
-      sheetId: model.getters.getActiveSheet(),
-      definition: {
-        title: "test 1",
-        dataSets: ["B7:B8"],
-        seriesHasTitle: true,
-        labelRange: "B7",
-        type: "line",
-      },
-    });
-    const datasets = model.getters.getChartRuntime("1")!.data!.datasets!;
-    expect(datasets).toHaveLength(1);
-    expect(datasets[0].label!.toString()).toEqual("Series 1");
-  });
-
-  test("pie chart tooltip title display the correct dataset", () => {
-    model.dispatch("CREATE_CHART", {
-      id: "1",
-      sheetId: model.getters.getActiveSheet(),
-      definition: {
-        title: "test 1",
-        dataSets: ["B7:B8"],
-        seriesHasTitle: true,
-        labelRange: "B7",
-        type: "pie",
-      },
-    });
-    const title = model.getters.getChartRuntime("1")!.options!.tooltips!.callbacks!.title!;
-    const chartData = { datasets: [{ label: "dataset 1" }, { label: "dataset 2" }] };
-    expect(title([{ datasetIndex: 0 }], chartData)).toBe("dataset 1");
-    expect(title([{ datasetIndex: 1 }], chartData)).toBe("dataset 2");
-  });
-
-  test.each(["bar", "line"] as const)("chart %s tooltip title is not dynamic", (chartType) => {
-    model.dispatch("CREATE_CHART", {
-      id: "1",
-      sheetId: model.getters.getActiveSheet(),
-      definition: {
-        title: "test 1",
-        dataSets: ["B7:B8"],
-        seriesHasTitle: true,
-        labelRange: "B7",
-        type: chartType,
-      },
-    });
-    const title = model.getters.getChartRuntime("1")?.options?.tooltips?.callbacks?.title;
-    expect(title).toBeUndefined();
-  });
-
-  test("can delete an imported chart", () => {
-    model.dispatch("CREATE_CHART", {
-      id: "1",
-      sheetId: model.getters.getActiveSheet(),
-      definition: {
-        title: "test 1",
-        dataSets: ["B7:B8"],
-        seriesHasTitle: true,
-        labelRange: "B7",
-        type: "line",
-      },
-    });
-    const newModel = new Model(model.exportData());
-    expect(newModel.getters.getFigures(viewport)).toHaveLength(1);
-    expect(newModel.getters.getChartRuntime("1")).toBeTruthy();
-    newModel.dispatch("DELETE_FIGURE", { id: "1" });
-    expect(newModel.getters.getFigures(viewport)).toHaveLength(0);
-    expect(newModel.getters.getChartRuntime("1")).toBeUndefined();
-  });
-
-  test("update dataset of imported chart", () => {
-    const sheetId = model.getters.getActiveSheet();
-    model.dispatch("CREATE_CHART", {
-      id: "1",
-      sheetId,
-      definition: {
-        title: "test 1",
-        dataSets: ["Sheet1!B1:B4"],
-        seriesHasTitle: true,
-        labelRange: "Sheet1!A2:A4",
-        type: "line",
-      },
-    });
-    const newModel = new Model(model.exportData());
-    let chart = newModel.getters.getChartRuntime("1")!;
-    expect(chart.data!.datasets![0].data).toEqual([10, 11, 12]);
-    newModel.dispatch("UPDATE_CELL", {
-      col: 1,
-      row: 1,
-      sheet: sheetId,
-      content: "99",
-    });
-    chart = newModel.getters.getChartRuntime("1")!;
-    expect(chart.data!.datasets![0].data).toEqual([99, 11, 12]);
-  });
-
-  test.skip("delete a data source column", () => {
-    model.dispatch("CREATE_CHART", {
-      id: "1",
-      sheetId: model.getters.getActiveSheet(),
-      definition: {
-        title: "test 1",
-        dataSets: ["Sheet1!B1:B4", "Sheet1!C1:C4"],
-        seriesHasTitle: true,
-        labelRange: "Sheet1!A2:A4",
-        type: "line",
-      },
-    });
-    model.dispatch("REMOVE_COLUMNS", { columns: [1], sheet: model.getters.getActiveSheet() });
-    expect(model.getters.getChartRuntime("1")!.data!.datasets).toHaveLength(1);
-    expect(model.getters.getChartRuntime("1")!.data!.datasets![0].data).toEqual([20, 19, 18]);
-  });
-
-  test.skip("delete a data set labels column", () => {
-    model.dispatch("CREATE_CHART", {
-      id: "1",
-      sheetId: model.getters.getActiveSheet(),
-      definition: {
-        title: "test 1",
-        dataSets: ["Sheet1!B1:B4", "Sheet1!C1:C4"],
-        seriesHasTitle: true,
-        labelRange: "Sheet1!A2:A4",
-        type: "line",
-      },
-    });
-    model.dispatch("REMOVE_COLUMNS", { columns: [0], sheet: model.getters.getActiveSheet() });
-    // dataset in col B becomes labels in col A
-    expect(model.getters.getChartRuntime("1")!.data!.labels).toBeUndefined();
-  });
-
-  test("update dataset cell updates chart runtime", () => {
-    const sheetId = model.getters.getActiveSheet();
-    model.dispatch("CREATE_CHART", {
-      id: "1",
-      sheetId,
-      definition: {
-        title: "test 1",
-        dataSets: ["Sheet1!B1:B4", "Sheet1!C1:C4"],
-        seriesHasTitle: true,
-        labelRange: "Sheet1!A2:A4",
-        type: "line",
-      },
-    });
-    let chart = model.getters.getChartRuntime("1")!;
-    expect(chart.data!.datasets![0].data).toEqual([10, 11, 12]);
-    expect(chart.data!.datasets![0].label).toEqual("first column dataset");
-    model.dispatch("UPDATE_CELL", {
-      col: 1,
-      row: 1,
-      sheet: sheetId,
-      content: "99",
-    });
-    model.dispatch("UPDATE_CELL", {
-      col: 1,
-      row: 0,
-      sheet: sheetId,
-      content: "new dataset label",
-    });
-    chart = model.getters.getChartRuntime("1")!;
-    expect(chart.data!.datasets![0].data).toEqual([99, 11, 12]);
-    expect(chart.data!.datasets![0].label).toEqual("new dataset label");
-  });
-
-  test("create chart with invalid dataset", () => {
-    const result = model.dispatch("CREATE_CHART", {
-      id: "1",
-      sheetId: model.getters.getActiveSheet(),
-      definition: {
-        title: "test 1",
-        dataSets: ["Sheet1!B1:B4", "This is invalid"],
-        seriesHasTitle: true,
-        labelRange: "Sheet1!A2:A4",
-        type: "line",
-      },
-    });
-    expect(result).toEqual({ status: "CANCELLED", reason: CancelledReason.InvalidChartDefinition });
-  });
-
-  test("create chart with invalid labels", () => {
-    const result = model.dispatch("CREATE_CHART", {
-      id: "1",
-      sheetId: model.getters.getActiveSheet(),
-      definition: {
-        title: "test 1",
-        dataSets: ["Sheet1!B1:B4"],
-        seriesHasTitle: true,
-        labelRange: "This is invalid",
-        type: "line",
-      },
-    });
-    expect(result).toEqual({ status: "CANCELLED", reason: CancelledReason.InvalidChartDefinition });
-  });
-  test("update chart with invalid dataset", () => {
-    const result = model.dispatch("UPDATE_CHART", {
-      id: "1",
-      definition: {
-        title: "test 1",
-        dataSets: ["Sheet1!B1:B4", "This is invalid"],
-        seriesHasTitle: true,
-        labelRange: "Sheet1!A2:A4",
-        type: "line",
-      },
-    });
-    expect(result).toEqual({ status: "CANCELLED", reason: CancelledReason.InvalidChartDefinition });
-  });
-
-  test("update chart with invalid labels", () => {
-    const result = model.dispatch("UPDATE_CHART", {
-      id: "1",
-      definition: {
-        title: "test 1",
-        dataSets: ["Sheet1!B1:B4"],
-        seriesHasTitle: true,
-        labelRange: "This is invalid",
-        type: "line",
-      },
-    });
-    expect(result).toEqual({ status: "CANCELLED", reason: CancelledReason.InvalidChartDefinition });
-  });
-  test.skip("extend data source to new values manually", () => {});
-  test.skip("extend data set labels to new values manually", () => {});
-});
-
-test("Chart is deleted on sheet deletion", () => {
-  model.dispatch("CREATE_SHEET", { id: "2" });
-  model.dispatch("CREATE_CHART", {
-    id: "1",
-    sheetId: "2",
-    definition: {
-      title: "test 1",
-      dataSets: ["Sheet1!B1:B4", "Sheet1!C1:C4"],
-      seriesHasTitle: true,
-      labelRange: "Sheet1!A2:A4",
-      type: "line",
-    },
-  });
-  expect(model.getters.getChartRuntime("1")).not.toBeUndefined();
-  model.dispatch("DELETE_SHEET", { sheet: "2" });
-  expect(model.getters.getChartRuntime("1")).toBeUndefined();
-});
-
-test("Chart is copied on sheet duplication", () => {
-  const firstSheetId = model.getters.getActiveSheet();
-  const secondSheetId = "42";
-  const chartId = "1";
-  model.dispatch("CREATE_CHART", {
-    id: chartId,
-    sheetId: firstSheetId,
-    definition: {
-      title: "test 1",
-      dataSets: ["B1:B4", "C1:C4"],
-      seriesHasTitle: true,
-      labelRange: "A2:A4",
-      type: "line",
-    },
-  });
-  mockUuidV4To(456);
-  model.dispatch("DUPLICATE_SHEET", {
-    id: secondSheetId,
-    name: "Sheet2",
-    sheet: firstSheetId,
-  });
-  model.dispatch("ACTIVATE_SHEET", {
-    from: firstSheetId,
-    to: secondSheetId,
-  });
-  const figure = model.getters.getFigure(chartId);
-  const duplicatedChart = {
-    ...figure,
-    id: "456",
-    data: {
-      dataSets: [
-        { dataRange: "B2:B4", labelCell: "B1" },
-        { dataRange: "C2:C4", labelCell: "C1" },
-      ],
-      labelRange: "A2:A4",
-      sheetId: secondSheetId,
-      title: "test 1",
-      type: "line",
-    },
-  };
-  expect(model.getters.getFigures(viewport)[0]).toEqual(duplicatedChart);
-  // duplicated chart is not deleted if original sheet is deleted
-  model.dispatch("DELETE_SHEET", { sheet: firstSheetId });
-  expect(model.getters.getSheets()).toHaveLength(1);
-  expect(model.getters.getFigures(viewport)[0]).toEqual(duplicatedChart);
-});
-
-describe.skip("title", function () {
-  test("delete a title column", () => {});
-  test("change title manually", () => {});
-  test("change title reference cell", () => {});
-  test("change content of title reference cell", () => {});
-});
-
-describe.skip("multiple sheets", function () {
-  test("create a chart on a sheet with data from another sheet", () => {});
-  test("create a chart on a sheet with dataset label from another sheet", () => {});
-  test("create a chart on a sheet with title from another sheet", () => {});
-
-  test("change source data then activate the chart sheet (it should be up-to-date)", () => {});
-  test("change dataset label then activate the chart sheet (it should be up-to-date)", () => {});
-  test("change title then activate the chart sheet (it should be up-to-date)", () => {});
-});
-
-test.skip("select a graph, it should have the  resize handles", () => {});
-describe.skip("size and position", function () {
-  test("resize columns before a graph, it should move", () => {});
-  test("resize columns before within graph, it should resize and rerender at the correct size", () => {});
-  test("delete a column before a graph, it should move", () => {});
-  test("delete a columns within graph, it should resize and rerender at the size-sizeOfRemovedColumn", () => {});
-  test("delete all columns that a graph is defined on, it should remove the graph", () => {});
-});
-
-describe("undo/redo", () => {
-  test("undo/redo chart creation", () => {
-    testUndoRedo(model, expect, "CREATE_CHART", {
-      id: "1",
-      sheetId: model.getters.getActiveSheet(),
-      definition: {
-        title: "test 1",
-        dataSets: ["Sheet1!B1:B4", "Sheet1!C1:C4"],
-        seriesHasTitle: true,
-        labelRange: "Sheet1!A2:A4",
-        type: "line",
-      },
-    });
-  });
-});

package/tests/model_test.ts

@@ -1,82 +0,0 @@
-import { BasePlugin } from "../src/base_plugin";
-import { WHistory } from "../src/history";
-import { Mode, Model } from "../src/model";
-import { ChartPlugin } from "../src/plugins/chart";
-import { ConditionalFormatPlugin } from "../src/plugins/conditional_format";
-import { CorePlugin } from "../src/plugins/core";
-import { FigurePlugin } from "../src/plugins/figures";
-import { FormattingPlugin } from "../src/plugins/formatting";
-import { pluginRegistry } from "../src/plugins/index";
-import { MergePlugin } from "../src/plugins/merge";
-import "./canvas.mock";
-
-describe("Model", () => {
-  test("can create model in headless mode", () => {
-    const model = new Model({}, { mode: "headless" });
-    expect(model["handlers"]).toHaveLength(7);
-    expect(model["handlers"][0]).toBeInstanceOf(WHistory);
-    expect(model["handlers"][1]).toBeInstanceOf(CorePlugin);
-    expect(model["handlers"][2]).toBeInstanceOf(MergePlugin);
-    expect(model["handlers"][3]).toBeInstanceOf(FormattingPlugin);
-    expect(model["handlers"][4]).toBeInstanceOf(ConditionalFormatPlugin);
-    expect(model["handlers"][5]).toBeInstanceOf(FigurePlugin);
-    expect(model["handlers"][6]).toBeInstanceOf(ChartPlugin);
-  });
-
-  test("All plugin compatible with normal mode are loaded on normal mode", () => {
-    const model = new Model();
-    const nbr = pluginRegistry
-      .getAll()
-      .reduce((acc, plugin) => (plugin.modes.includes("normal") ? acc + 1 : acc), 0);
-    expect(model["handlers"]).toHaveLength(nbr + 1); //+1 for WHistory
-  });
-
-  test("All plugin compatible with headless mode are loaded on headless mode", () => {
-    const model = new Model({}, { mode: "headless" });
-    const nbr = pluginRegistry
-      .getAll()
-      .reduce((acc, plugin) => (plugin.modes.includes("headless") ? acc + 1 : acc), 0);
-    expect(model["handlers"]).toHaveLength(nbr + 1); //+1 for WHistory
-  });
-
-  test("All plugin compatible with readonly mode are loaded on readonly mode", () => {
-    const model = new Model({}, { mode: "readonly" });
-    const nbr = pluginRegistry
-      .getAll()
-      .reduce((acc, plugin) => (plugin.modes.includes("readonly") ? acc + 1 : acc), 0);
-    expect(model["handlers"]).toHaveLength(nbr + 1); //+1 for WHistory
-  });
-
-  test("Model in headless mode should not evaluate cells", () => {
-    const model = new Model({}, { mode: "headless" });
-    model.dispatch("SET_VALUE", { xc: "A1", text: "=1" });
-    expect(model["workbook"].activeSheet.cells.A1.value).not.toBe("1");
-  });
-
-  test("can add a Plugin only in headless mode", () => {
-    class NormalPlugin extends BasePlugin {
-      static modes: Mode[] = ["normal"];
-    }
-    class HeadlessPlugin extends BasePlugin {
-      static modes: Mode[] = ["headless"];
-    }
-    class ReadOnlyPlugin extends BasePlugin {
-      static modes: Mode[] = ["readonly"];
-    }
-    pluginRegistry.add("normalPlugin", NormalPlugin);
-    pluginRegistry.add("headlessPlugin", HeadlessPlugin);
-    pluginRegistry.add("readonlyPlugin", ReadOnlyPlugin);
-    const modelNormal = new Model();
-    expect(modelNormal["handlers"][modelNormal["handlers"].length - 1]).toBeInstanceOf(
-      NormalPlugin
-    );
-    const modelHeadless = new Model({}, { mode: "headless" });
-    expect(modelHeadless["handlers"][modelHeadless["handlers"].length - 1]).toBeInstanceOf(
-      HeadlessPlugin
-    );
-    const modelReadonly = new Model({}, { mode: "readonly" });
-    expect(modelReadonly["handlers"][modelReadonly["handlers"].length - 1]).toBeInstanceOf(
-      ReadOnlyPlugin
-    );
-  });
-});