@odoo/o-spreadsheet 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (199) hide show
  1. package/.eslintrc.json +20 -0
  2. package/.husky/post-checkout +9 -0
  3. package/.husky/pre-commit +39 -0
  4. package/.prettierignore +1 -0
  5. package/astToFormula.patch +0 -0
  6. package/demo/data.js +255 -0
  7. package/demo/index.html +9 -0
  8. package/demo/libs/Chart.bundle.js +20755 -0
  9. package/demo/main.js +101 -0
  10. package/doc/readme.md +46 -0
  11. package/package.json +78 -0
  12. package/readme.md +39 -0
  13. package/rollup.config.js +23 -0
  14. package/src/base_plugin.ts +102 -0
  15. package/src/components/autofill.ts +146 -0
  16. package/src/components/bottom_bar.ts +199 -0
  17. package/src/components/color_picker.ts +150 -0
  18. package/src/components/composer/autocomplete_dropdown.ts +135 -0
  19. package/src/components/composer/composer.ts +487 -0
  20. package/src/components/composer/content_editable_helper.ts +146 -0
  21. package/src/components/figures/chart.ts +70 -0
  22. package/src/components/figures/container.ts +268 -0
  23. package/src/components/figures/text_figure.ts +36 -0
  24. package/src/components/grid.ts +635 -0
  25. package/src/components/helpers/dom_helpers.ts +7 -0
  26. package/src/components/helpers/drag_and_drop.ts +17 -0
  27. package/src/components/icons.ts +36 -0
  28. package/src/components/index.ts +1 -0
  29. package/src/components/menu.ts +288 -0
  30. package/src/components/overlay.ts +457 -0
  31. package/src/components/scrollbar.ts +22 -0
  32. package/src/components/selection_input.ts +168 -0
  33. package/src/components/side_panel/cell_is_rule_editor.ts +169 -0
  34. package/src/components/side_panel/chart_panel.ts +104 -0
  35. package/src/components/side_panel/color_scale_rule_editor.ts +145 -0
  36. package/src/components/side_panel/conditional_formatting.ts +396 -0
  37. package/src/components/side_panel/side_panel.ts +127 -0
  38. package/src/components/side_panel/translations_terms.ts +45 -0
  39. package/src/components/spreadsheet.ts +198 -0
  40. package/src/components/top_bar.ts +535 -0
  41. package/src/constants.ts +26 -0
  42. package/src/data.ts +149 -0
  43. package/src/fonts.ts +41 -0
  44. package/src/formulas/compiler.ts +258 -0
  45. package/src/formulas/composer_tokenizer.ts +70 -0
  46. package/src/formulas/index.ts +15 -0
  47. package/src/formulas/normalize.ts +52 -0
  48. package/src/formulas/parser.ts +280 -0
  49. package/src/formulas/range_tokenizer.ts +97 -0
  50. package/src/formulas/tokenizer.ts +242 -0
  51. package/src/functions/arguments.ts +114 -0
  52. package/src/functions/dates.ts +302 -0
  53. package/src/functions/helpers.ts +592 -0
  54. package/src/functions/index.ts +52 -0
  55. package/src/functions/module_database.ts +282 -0
  56. package/src/functions/module_date.ts +743 -0
  57. package/src/functions/module_info.ts +69 -0
  58. package/src/functions/module_logical.ts +208 -0
  59. package/src/functions/module_lookup.ts +185 -0
  60. package/src/functions/module_math.ts +1252 -0
  61. package/src/functions/module_operators.ts +291 -0
  62. package/src/functions/module_statistical.ts +882 -0
  63. package/src/functions/module_text.ts +370 -0
  64. package/src/helpers/color.ts +30 -0
  65. package/src/helpers/coordinates.ts +71 -0
  66. package/src/helpers/grid_manipulation.ts +68 -0
  67. package/src/helpers/index.ts +7 -0
  68. package/src/helpers/misc.ts +76 -0
  69. package/src/helpers/numbers.ts +117 -0
  70. package/src/helpers/uuid.ts +19 -0
  71. package/src/helpers/zones.ts +263 -0
  72. package/src/history.ts +186 -0
  73. package/src/index.ts +84 -0
  74. package/src/model.ts +261 -0
  75. package/src/plugins/autofill.ts +412 -0
  76. package/src/plugins/chart.ts +404 -0
  77. package/src/plugins/clipboard.ts +461 -0
  78. package/src/plugins/conditional_format.ts +445 -0
  79. package/src/plugins/core.ts +1502 -0
  80. package/src/plugins/edition.ts +157 -0
  81. package/src/plugins/evaluation.ts +428 -0
  82. package/src/plugins/figures.ts +123 -0
  83. package/src/plugins/formatting.ts +630 -0
  84. package/src/plugins/highlight.ts +187 -0
  85. package/src/plugins/index.ts +32 -0
  86. package/src/plugins/merge.ts +524 -0
  87. package/src/plugins/renderer.ts +571 -0
  88. package/src/plugins/selection.ts +562 -0
  89. package/src/plugins/selection_inputs.ts +326 -0
  90. package/src/registries/autofill_modifiers.ts +76 -0
  91. package/src/registries/autofill_rules.ts +98 -0
  92. package/src/registries/figure_registry.ts +30 -0
  93. package/src/registries/index.ts +7 -0
  94. package/src/registries/menu_items_registry.ts +110 -0
  95. package/src/registries/menus/cell_menu_registry.ts +79 -0
  96. package/src/registries/menus/col_menu_registry.ts +63 -0
  97. package/src/registries/menus/index.ts +6 -0
  98. package/src/registries/menus/menu_items_actions.ts +425 -0
  99. package/src/registries/menus/row_menu_registry.ts +63 -0
  100. package/src/registries/menus/sheet_menu_registry.ts +75 -0
  101. package/src/registries/menus/topbar_menu_registry.ts +204 -0
  102. package/src/registries/side_panel_registry.ts +26 -0
  103. package/src/registries/topbar_component_registry.ts +12 -0
  104. package/src/registry.ts +51 -0
  105. package/src/translation.ts +44 -0
  106. package/src/types/autofill.ts +48 -0
  107. package/src/types/chart.ts +26 -0
  108. package/src/types/commands.ts +716 -0
  109. package/src/types/conditional_formatting.ts +124 -0
  110. package/src/types/env.ts +13 -0
  111. package/src/types/functions.ts +35 -0
  112. package/src/types/getters.ts +103 -0
  113. package/src/types/index.ts +20 -0
  114. package/src/types/misc.ts +143 -0
  115. package/src/types/rendering.ts +41 -0
  116. package/src/types/workbook_data.ts +62 -0
  117. package/tests/__mocks__/uuid.ts +7 -0
  118. package/tests/canvas.mock.ts +34 -0
  119. package/tests/components/__mocks__/content_editable_helper.ts +79 -0
  120. package/tests/components/__mocks__/scrollbar.ts +18 -0
  121. package/tests/components/__snapshots__/autocomplete_dropdown_test.ts.snap +29 -0
  122. package/tests/components/__snapshots__/bottom_bar_test.ts.snap +75 -0
  123. package/tests/components/__snapshots__/context_menu_test.ts.snap +88 -0
  124. package/tests/components/__snapshots__/grid_test.ts.snap +60 -0
  125. package/tests/components/__snapshots__/spreadsheet_test.ts.snap +455 -0
  126. package/tests/components/__snapshots__/top_bar_test.ts.snap +705 -0
  127. package/tests/components/autocomplete_dropdown_test.ts +315 -0
  128. package/tests/components/autofill_test.ts +167 -0
  129. package/tests/components/bottom_bar_test.ts +262 -0
  130. package/tests/components/chart_side_panel_test.ts +123 -0
  131. package/tests/components/composer_test.ts +400 -0
  132. package/tests/components/context_menu_test.ts +825 -0
  133. package/tests/components/grid_manipulation_test.ts +163 -0
  134. package/tests/components/grid_test.ts +581 -0
  135. package/tests/components/overlay_test.ts +541 -0
  136. package/tests/components/selection_input_test.ts +259 -0
  137. package/tests/components/side_panel_test.ts +148 -0
  138. package/tests/components/spreadsheet_test.ts +194 -0
  139. package/tests/components/top_bar_test.ts +427 -0
  140. package/tests/data_test.ts +175 -0
  141. package/tests/dom_helper.ts +42 -0
  142. package/tests/formulas/__snapshots__/compiler_test.ts.snap +302 -0
  143. package/tests/formulas/compiler_test.ts +266 -0
  144. package/tests/formulas/composer_tokenizer_test.ts +137 -0
  145. package/tests/formulas/expressions_test.ts +57 -0
  146. package/tests/formulas/formulas_test.ts +80 -0
  147. package/tests/formulas/normalize_test.ts +82 -0
  148. package/tests/formulas/parser_test.ts +224 -0
  149. package/tests/formulas/range_tokenizer_test.ts +187 -0
  150. package/tests/formulas/tokenizer_test.ts +164 -0
  151. package/tests/functions/arguments_test.ts +141 -0
  152. package/tests/functions/dates_test.ts +1081 -0
  153. package/tests/functions/functions_test.ts +53 -0
  154. package/tests/functions/helper_test.ts +98 -0
  155. package/tests/functions/module_database_test.ts +311 -0
  156. package/tests/functions/module_date_test.ts +941 -0
  157. package/tests/functions/module_info_test.ts +139 -0
  158. package/tests/functions/module_logical_test.ts +369 -0
  159. package/tests/functions/module_lookup_test.ts +541 -0
  160. package/tests/functions/module_math_test.ts +2482 -0
  161. package/tests/functions/module_operators_test.ts +955 -0
  162. package/tests/functions/module_statistical_test.ts +2014 -0
  163. package/tests/functions/module_text_test.ts +667 -0
  164. package/tests/helpers/coordinates_test.ts +25 -0
  165. package/tests/helpers/misc_test.ts +95 -0
  166. package/tests/helpers/numbers_test.ts +196 -0
  167. package/tests/helpers/zones_test.ts +97 -0
  168. package/tests/helpers.ts +384 -0
  169. package/tests/menu_items_registry_test.ts +540 -0
  170. package/tests/model/plugins/__snapshots__/chart_test.ts.snap +90 -0
  171. package/tests/model/plugins/chart_test.ts +562 -0
  172. package/tests/model_test.ts +82 -0
  173. package/tests/plugins/__snapshots__/conditional_formatting_test.ts.snap +131 -0
  174. package/tests/plugins/__snapshots__/renderer_test.ts.snap +371 -0
  175. package/tests/plugins/autofill_test.ts +457 -0
  176. package/tests/plugins/borders_test.ts +295 -0
  177. package/tests/plugins/clipboard_test.ts +1180 -0
  178. package/tests/plugins/conditional_formatting_test.ts +1253 -0
  179. package/tests/plugins/core_test.ts +614 -0
  180. package/tests/plugins/edition_test.ts +100 -0
  181. package/tests/plugins/evaluation_async_test.ts +332 -0
  182. package/tests/plugins/evaluation_dates_test.ts +79 -0
  183. package/tests/plugins/evaluation_test.ts +901 -0
  184. package/tests/plugins/figures_test.ts +327 -0
  185. package/tests/plugins/formatting_test.ts +391 -0
  186. package/tests/plugins/grid_manipulation_test.ts +1366 -0
  187. package/tests/plugins/highlight_test.ts +413 -0
  188. package/tests/plugins/history_test.ts +142 -0
  189. package/tests/plugins/import_export_test.ts +276 -0
  190. package/tests/plugins/merges_test.ts +490 -0
  191. package/tests/plugins/navigation_test.ts +181 -0
  192. package/tests/plugins/plugins/evaluation_test.ts +111 -0
  193. package/tests/plugins/renderer_test.ts +598 -0
  194. package/tests/plugins/resizing_test.ts +152 -0
  195. package/tests/plugins/selection_input_test.ts +409 -0
  196. package/tests/plugins/selection_test.ts +442 -0
  197. package/tests/plugins/sheets_test.ts +643 -0
  198. package/tests/plugins/style_test.ts +90 -0
  199. package/tsconfig.json +22 -0
@@ -0,0 +1,643 @@
1
+ import { toCartesian, toZone, uuidv4 } from "../../src/helpers";
2
+ import { Model } from "../../src/model";
3
+ import { CancelledReason } from "../../src/types";
4
+ import "../helpers"; // to have getcontext mocks
5
+ import { createEqualCF, getCell, testUndoRedo } from "../helpers";
6
+
7
+ describe("sheets", () => {
8
+ test("can create a new sheet, then undo, then redo", () => {
9
+ const model = new Model();
10
+ expect(model["workbook"].visibleSheets.length).toBe(1);
11
+ expect(model["workbook"].activeSheet.name).toBe("Sheet1");
12
+
13
+ model.dispatch("CREATE_SHEET", { activate: true, id: "42" });
14
+ expect(model["workbook"].visibleSheets.length).toBe(2);
15
+ expect(model["workbook"].activeSheet.name).toBe("Sheet2");
16
+
17
+ model.dispatch("UNDO");
18
+ expect(model["workbook"].visibleSheets.length).toBe(1);
19
+ expect(model["workbook"].activeSheet.name).toBe("Sheet1");
20
+
21
+ model.dispatch("REDO");
22
+ expect(model["workbook"].visibleSheets.length).toBe(2);
23
+ expect(model["workbook"].activeSheet.name).toBe("Sheet2");
24
+ });
25
+
26
+ test("Creating a new sheet insert it just after the active", () => {
27
+ const model = new Model();
28
+ model.dispatch("CREATE_SHEET", { id: "42", name: "42" });
29
+ model.dispatch("CREATE_SHEET", { id: "43", name: "43" });
30
+ expect(model.getters.getSheets()[1].id).toBe("43");
31
+ expect(model.getters.getSheets()[2].id).toBe("42");
32
+ });
33
+
34
+ test("Creating a new sheet does not activate it by default", () => {
35
+ const model = new Model();
36
+ const sheet1 = model["workbook"].visibleSheets[0];
37
+
38
+ expect(model.getters.getActiveSheet()).toBe(sheet1);
39
+ expect(model.getters.getSheets().map((s) => s.id)).toEqual([sheet1]);
40
+ model.dispatch("CREATE_SHEET", { id: "42" });
41
+ const sheet2 = model["workbook"].visibleSheets[1];
42
+ expect(model.getters.getActiveSheet()).toBe(sheet1);
43
+ expect(model.getters.getSheets().map((s) => s.id)).toEqual([sheet1, sheet2]);
44
+ });
45
+
46
+ test("Can create a new sheet with given size and name", () => {
47
+ const model = new Model();
48
+ model.dispatch("CREATE_SHEET", {
49
+ rows: 2,
50
+ cols: 4,
51
+ name: "SheetTest",
52
+ activate: true,
53
+ id: "42",
54
+ });
55
+ expect(model["workbook"].activeSheet.colNumber).toBe(4);
56
+ expect(model["workbook"].activeSheet.cols.length).toBe(4);
57
+ expect(model["workbook"].activeSheet.rowNumber).toBe(2);
58
+ expect(model["workbook"].activeSheet.rows.length).toBe(2);
59
+ expect(model["workbook"].activeSheet.name).toBe("SheetTest");
60
+ });
61
+
62
+ test("Cannot create a sheet with a name already existent", () => {
63
+ const model = new Model();
64
+ const name = model["workbook"].activeSheet.name;
65
+ expect(model.dispatch("CREATE_SHEET", { name, id: "42" })).toEqual({
66
+ status: "CANCELLED",
67
+ reason: CancelledReason.WrongSheetName,
68
+ });
69
+ });
70
+
71
+ test("Name is correctly generated when creating a sheet without given name", () => {
72
+ const model = new Model();
73
+ expect(model.getters.getSheetName(model.getters.getActiveSheet())).toBe("Sheet1");
74
+ model.dispatch("CREATE_SHEET", { id: "42", activate: true });
75
+ expect(model.getters.getSheetName(model.getters.getActiveSheet())).toBe("Sheet2");
76
+ model.dispatch("CREATE_SHEET", { id: "43", activate: true });
77
+ expect(model.getters.getSheetName(model.getters.getActiveSheet())).toBe("Sheet3");
78
+ model.dispatch("DELETE_SHEET", { sheet: "42" });
79
+ expect(model.getters.getSheets()[0].name).toBe("Sheet1");
80
+ expect(model.getters.getSheets()[1].name).toBe("Sheet3");
81
+ model.dispatch("CREATE_SHEET", { id: "44", activate: true });
82
+ expect(model.getters.getSheetName(model.getters.getActiveSheet())).toBe("Sheet2");
83
+ });
84
+
85
+ test("can read a value in same sheet", () => {
86
+ const model = new Model();
87
+ expect(model["workbook"].activeSheet.name).toBe("Sheet1");
88
+
89
+ model.dispatch("SET_VALUE", { xc: "A1", text: "3" });
90
+ model.dispatch("SET_VALUE", { xc: "A2", text: "=Sheet1!A1" });
91
+
92
+ expect(getCell(model, "A2")!.value).toBe(3);
93
+ });
94
+
95
+ test("can read a value in another sheet", () => {
96
+ const model = new Model();
97
+ expect(model["workbook"].activeSheet.name).toBe("Sheet1");
98
+
99
+ model.dispatch("SET_VALUE", { xc: "A1", text: "3" });
100
+ model.dispatch("CREATE_SHEET", { activate: true, id: "42" });
101
+ expect(model["workbook"].activeSheet.name).toBe("Sheet2");
102
+ model.dispatch("SET_VALUE", { xc: "A1", text: "=Sheet1!A1" });
103
+ expect(getCell(model, "A1")!.value).toBe(3);
104
+ });
105
+
106
+ test("throw if invalid sheet name", () => {
107
+ const model = new Model();
108
+ model.dispatch("SET_VALUE", { xc: "A1", text: "=Sheet133!A1" });
109
+
110
+ expect(getCell(model, "A1")!.value).toBe("#ERROR");
111
+ });
112
+
113
+ test("evaluating multiple sheets", () => {
114
+ const model = new Model({
115
+ sheets: [
116
+ {
117
+ name: "ABC",
118
+ colNumber: 10,
119
+ rowNumber: 10,
120
+ cells: { B1: { content: "=DEF!B2" } },
121
+ },
122
+ {
123
+ name: "DEF",
124
+ colNumber: 10,
125
+ rowNumber: 10,
126
+ cells: { B2: { content: "3" } },
127
+ },
128
+ ],
129
+ });
130
+
131
+ expect(model["workbook"].activeSheet.name).toBe("ABC");
132
+ expect(getCell(model, "B1")!.value).toBe(3);
133
+ });
134
+
135
+ test("evaluating multiple sheets, 2", () => {
136
+ const model = new Model({
137
+ sheets: [
138
+ {
139
+ name: "ABC",
140
+ colNumber: 10,
141
+ rowNumber: 10,
142
+ cells: { B1: { content: "=DEF!B2" } },
143
+ },
144
+ {
145
+ name: "DEF",
146
+ colNumber: 10,
147
+ rowNumber: 10,
148
+ cells: {
149
+ B2: { content: "=A4" },
150
+ A4: { content: "3" },
151
+ },
152
+ },
153
+ ],
154
+ });
155
+
156
+ expect(model["workbook"].activeSheet.name).toBe("ABC");
157
+ expect(getCell(model, "B1")!.value).toBe(3);
158
+ });
159
+
160
+ test("evaluating multiple sheets, 3 (with range)", () => {
161
+ const model = new Model({
162
+ sheets: [
163
+ {
164
+ name: "ABC",
165
+ colNumber: 10,
166
+ rowNumber: 10,
167
+ cells: { B1: { content: "=DEF!B2" } },
168
+ },
169
+ {
170
+ name: "DEF",
171
+ colNumber: 10,
172
+ rowNumber: 10,
173
+ cells: {
174
+ B2: { content: "=SUM(A1:A5)" },
175
+ A1: { content: "2" },
176
+ A4: { content: "3" },
177
+ },
178
+ },
179
+ ],
180
+ });
181
+
182
+ expect(model["workbook"].activeSheet.name).toBe("ABC");
183
+ expect(getCell(model, "B1")!.value).toBe(5);
184
+ });
185
+
186
+ test("evaluating multiple sheets: cycles", () => {
187
+ const model = new Model({
188
+ sheets: [
189
+ {
190
+ name: "ABC",
191
+ colNumber: 10,
192
+ rowNumber: 10,
193
+ cells: {
194
+ B1: { content: "=DEF!B2" },
195
+ C3: { content: "=DEF!C5 + 1" },
196
+ C4: { content: "40" },
197
+ },
198
+ },
199
+ {
200
+ name: "DEF",
201
+ colNumber: 10,
202
+ rowNumber: 10,
203
+ cells: {
204
+ B2: { content: "=ABC!B1" },
205
+ C5: { content: "=ABC!C4 + 1" },
206
+ },
207
+ },
208
+ ],
209
+ });
210
+
211
+ expect(model["workbook"].activeSheet.name).toBe("ABC");
212
+ expect(getCell(model, "B1")!.value).toBe("#CYCLE");
213
+ expect(getCell(model, "C3")!.value).toBe(42);
214
+ });
215
+
216
+ test("evaluation from one sheet to another no render", () => {
217
+ const model = new Model({
218
+ sheets: [
219
+ {
220
+ name: "small",
221
+ id: "smallId",
222
+ colNumber: 2,
223
+ rowNumber: 2,
224
+ cells: {
225
+ A2: { content: "=big!A2" },
226
+ },
227
+ },
228
+ {
229
+ name: "big",
230
+ id: "bigId",
231
+ colNumber: 5,
232
+ rowNumber: 5,
233
+ cells: {
234
+ A1: { content: "23" },
235
+ A2: { content: "=A1" },
236
+ },
237
+ },
238
+ ],
239
+ });
240
+ expect(getCell(model, "A2")!.value).toBe(23);
241
+ });
242
+
243
+ test("cells are updated when dependency in other sheet is updated", () => {
244
+ const model = new Model();
245
+ model.dispatch("CREATE_SHEET", { activate: true, id: "42" });
246
+ const sheet1 = model["workbook"].visibleSheets[0];
247
+ const sheet2 = model["workbook"].visibleSheets[1];
248
+
249
+ expect(model.getters.getActiveSheet()).toEqual(sheet2);
250
+ model.dispatch("ACTIVATE_SHEET", { from: sheet2, to: sheet1 });
251
+ expect(model.getters.getActiveSheet()).toEqual(sheet1);
252
+ model.dispatch("SET_VALUE", { text: "=Sheet2!A1", xc: "A1" });
253
+ expect(getText(model, "A1")).toEqual("0");
254
+ model.dispatch("ACTIVATE_SHEET", { from: sheet1, to: sheet2 });
255
+ model.dispatch("SET_VALUE", { text: "3", xc: "A1" });
256
+ model.dispatch("ACTIVATE_SHEET", { from: sheet2, to: sheet1 });
257
+ expect(model.getters.getActiveSheet()).toEqual(sheet1);
258
+ expect(getText(model, "A1")).toEqual("3");
259
+ });
260
+
261
+ test("can move a sheet", () => {
262
+ const model = new Model();
263
+ model.dispatch("CREATE_SHEET", { id: "42" });
264
+ const sheet1 = model["workbook"].visibleSheets[0];
265
+ const sheet2 = model["workbook"].visibleSheets[1];
266
+ const beforeMoveSheet = model.exportData();
267
+ model.dispatch("MOVE_SHEET", { sheet: sheet1, direction: "right" });
268
+ expect(model.getters.getActiveSheet()).toEqual(sheet1);
269
+ expect(model["workbook"].visibleSheets[0]).toEqual(sheet2);
270
+ expect(model["workbook"].visibleSheets[1]).toEqual(sheet1);
271
+ model.dispatch("UNDO");
272
+ expect(model["workbook"].visibleSheets[0]).toEqual(sheet1);
273
+ expect(model["workbook"].visibleSheets[1]).toEqual(sheet2);
274
+ expect(beforeMoveSheet).toEqual(model.exportData());
275
+ });
276
+
277
+ test("cannot move the first sheet to left and the last to right", () => {
278
+ const model = new Model();
279
+ model.dispatch("CREATE_SHEET", { id: "42" });
280
+ const sheet1 = model["workbook"].visibleSheets[0];
281
+ const sheet2 = model["workbook"].visibleSheets[1];
282
+ expect(model.dispatch("MOVE_SHEET", { sheet: sheet1, direction: "left" })).toEqual({
283
+ status: "CANCELLED",
284
+ reason: CancelledReason.WrongSheetMove,
285
+ });
286
+ expect(model.dispatch("MOVE_SHEET", { sheet: sheet2, direction: "right" })).toEqual({
287
+ status: "CANCELLED",
288
+ reason: CancelledReason.WrongSheetMove,
289
+ });
290
+ });
291
+
292
+ test("Can rename a sheet", () => {
293
+ const model = new Model();
294
+ const sheet = model.getters.getActiveSheet();
295
+ const name = "NEW_NAME";
296
+ model.dispatch("RENAME_SHEET", { sheet, name });
297
+ expect(model.getters.getSheets().find((s) => s.id === sheet)!.name).toBe(name);
298
+ });
299
+
300
+ test("New sheet name is trimmed", () => {
301
+ const model = new Model();
302
+ const sheet = model.getters.getActiveSheet();
303
+ const name = " NEW_NAME ";
304
+ model.dispatch("RENAME_SHEET", { sheet, name });
305
+ expect(model.getters.getSheets().find((s) => s.id === sheet)!.name).toBe("NEW_NAME");
306
+ });
307
+
308
+ test("Cannot rename a sheet with existing name", () => {
309
+ const model = new Model();
310
+ const sheet = model.getters.getActiveSheet();
311
+ const name = "NEW_NAME";
312
+ model.dispatch("CREATE_SHEET", { name, id: "42" });
313
+ expect(model.dispatch("RENAME_SHEET", { sheet, name })).toEqual({
314
+ status: "CANCELLED",
315
+ reason: CancelledReason.WrongSheetName,
316
+ });
317
+ expect(model.dispatch("RENAME_SHEET", { sheet, name: "new_name" })).toEqual({
318
+ status: "CANCELLED",
319
+ reason: CancelledReason.WrongSheetName,
320
+ });
321
+ expect(model.dispatch("RENAME_SHEET", { sheet, name: "new_name " })).toEqual({
322
+ status: "CANCELLED",
323
+ reason: CancelledReason.WrongSheetName,
324
+ });
325
+ });
326
+
327
+ test("Cannot rename a sheet without name", () => {
328
+ const model = new Model();
329
+ const sheet = model.getters.getActiveSheet();
330
+ expect(model.dispatch("RENAME_SHEET", { sheet, name: undefined })).toEqual({
331
+ status: "CANCELLED",
332
+ reason: CancelledReason.WrongSheetName,
333
+ });
334
+ expect(model.dispatch("RENAME_SHEET", { sheet, name: " " })).toEqual({
335
+ status: "CANCELLED",
336
+ reason: CancelledReason.WrongSheetName,
337
+ });
338
+ });
339
+
340
+ test("Sheet reference are correctly updated", () => {
341
+ const model = new Model();
342
+ const name = "NEW_NAME";
343
+ const sheet1 = model.getters.getActiveSheet();
344
+ model.dispatch("SET_VALUE", {
345
+ xc: "A1",
346
+ text: "=NEW_NAME!A1",
347
+ });
348
+
349
+ model.dispatch("CREATE_SHEET", { name, id: "42", activate: true });
350
+ const sheet2 = model.getters.getActiveSheet();
351
+ model.dispatch("SET_VALUE", { xc: "A1", text: "42" });
352
+ const nextName = "NEXT NAME";
353
+ model.dispatch("RENAME_SHEET", { sheet: sheet2, name: nextName });
354
+ model.dispatch("ACTIVATE_SHEET", { from: sheet2, to: sheet1 });
355
+ expect(model.getters.getCell(0, 0)!.content).toBe("='NEXT NAME'!A1");
356
+ model.dispatch("UNDO"); // Activate Sheet
357
+ model.dispatch("UNDO"); // Rename sheet
358
+ model.dispatch("ACTIVATE_SHEET", { from: sheet2, to: sheet1 });
359
+ expect(model.getters.getCell(0, 0)!.content).toBe("=NEW_NAME!A1");
360
+ });
361
+
362
+ test("Rename a sheet will call editText", async () => {
363
+ const editText = jest.fn();
364
+ const model = new Model(
365
+ {
366
+ sheets: [
367
+ {
368
+ colNumber: 5,
369
+ rowNumber: 5,
370
+ },
371
+ ],
372
+ },
373
+ { editText }
374
+ );
375
+ model.dispatch("RENAME_SHEET", { sheet: model.getters.getActiveSheet(), interactive: true });
376
+ expect(editText).toHaveBeenCalled();
377
+ });
378
+
379
+ test("Rename a sheet with interaction", async () => {
380
+ const editText = jest.fn(
381
+ (title: string, placeholder: string, callback: (text: string | null) => any) => {
382
+ callback("new name");
383
+ }
384
+ );
385
+ const model = new Model(
386
+ {
387
+ sheets: [
388
+ {
389
+ colNumber: 5,
390
+ rowNumber: 5,
391
+ },
392
+ ],
393
+ },
394
+ { editText }
395
+ );
396
+ model.dispatch("RENAME_SHEET", { sheet: model.getters.getActiveSheet(), interactive: true });
397
+ expect(model.getters.getSheetName(model.getters.getActiveSheet())).toBe("new name");
398
+ });
399
+
400
+ test("Can duplicate a sheet", () => {
401
+ const model = new Model();
402
+ const sheet = model.getters.getActiveSheet();
403
+ model.dispatch("DUPLICATE_SHEET", { sheet, id: uuidv4(), name: "dup" });
404
+ expect(model.getters.getSheets()).toHaveLength(2);
405
+ model.dispatch("UNDO");
406
+ expect(model.getters.getSheets()).toHaveLength(1);
407
+ model.dispatch("REDO");
408
+ expect(model.getters.getSheets()).toHaveLength(2);
409
+ });
410
+
411
+ test("Duplicate a sheet make the newly created active", () => {
412
+ const model = new Model();
413
+ const sheet = model.getters.getActiveSheet();
414
+ model.dispatch("DUPLICATE_SHEET", { sheet, id: "42", name: "dup" });
415
+ expect(model.getters.getActiveSheet()).toBe("42");
416
+ });
417
+
418
+ test("Cannot duplicate a sheet with the same name", () => {
419
+ const model = new Model();
420
+ const sheet = model.getters.getActiveSheet();
421
+ const name = model.getters.getSheets()[0].name;
422
+ const id = uuidv4();
423
+ expect(model.dispatch("DUPLICATE_SHEET", { sheet, id, name })).toEqual({
424
+ status: "CANCELLED",
425
+ reason: CancelledReason.WrongSheetName,
426
+ });
427
+ });
428
+
429
+ test("Properties of sheet are correctly duplicated", () => {
430
+ const model = new Model({
431
+ sheets: [
432
+ {
433
+ colNumber: 5,
434
+ rowNumber: 5,
435
+ merges: ["B1:C2"],
436
+ conditionalFormats: [
437
+ {
438
+ id: "1",
439
+ ranges: ["A1:A2"],
440
+ rule: {
441
+ values: ["42"],
442
+ operator: "Equal",
443
+ type: "CellIsRule",
444
+ style: { fillColor: "orange" },
445
+ },
446
+ },
447
+ ],
448
+ },
449
+ ],
450
+ });
451
+ const sheet = model.getters.getActiveSheet();
452
+ model.dispatch("SET_VALUE", { xc: "A1", text: "42" });
453
+ model.dispatch("DUPLICATE_SHEET", { sheet, id: uuidv4(), name: "dup" });
454
+ expect(model.getters.getSheets()).toHaveLength(2);
455
+ const newSheet = model.getters.getSheets()[1].id;
456
+ model.dispatch("ACTIVATE_SHEET", { from: sheet, to: newSheet });
457
+ expect(getText(model, "A1")).toBe("42");
458
+ expect(model.getters.getNumberCols(model.getters.getActiveSheet())).toBe(5);
459
+ expect(model.getters.getNumberRows(model.getters.getActiveSheet())).toBe(5);
460
+ expect(model.getters.getConditionalStyle("A1")).toEqual({ fillColor: "orange" });
461
+ });
462
+
463
+ test("CFs of sheets are correctly duplicated", () => {
464
+ const model = new Model({
465
+ sheets: [
466
+ {
467
+ colNumber: 5,
468
+ rowNumber: 5,
469
+ conditionalFormats: [
470
+ {
471
+ id: "1",
472
+ ranges: ["A1:A2"],
473
+ rule: {
474
+ values: ["42"],
475
+ operator: "Equal",
476
+ type: "CellIsRule",
477
+ style: { fillColor: "orange" },
478
+ },
479
+ },
480
+ ],
481
+ },
482
+ ],
483
+ });
484
+ const sheet = model.getters.getActiveSheet();
485
+ model.dispatch("SET_VALUE", { xc: "A1", text: "42" });
486
+ model.dispatch("DUPLICATE_SHEET", { sheet, id: uuidv4(), name: "dup" });
487
+ expect(model.getters.getSheets()).toHaveLength(2);
488
+ const newSheet = model.getters.getSheets()[1].id;
489
+ model.dispatch("ACTIVATE_SHEET", { from: sheet, to: newSheet });
490
+ expect(getText(model, "A1")).toBe("42");
491
+ expect(model.getters.getConditionalStyle("A1")).toEqual({ fillColor: "orange" });
492
+ expect(model.getters.getConditionalFormats()).toHaveLength(1);
493
+ model.dispatch("ADD_CONDITIONAL_FORMAT", {
494
+ cf: createEqualCF(["A1:A2"], "42", { fillColor: "blue" }, "1"),
495
+ sheet: model.getters.getActiveSheet(),
496
+ });
497
+ expect(model.getters.getConditionalStyle("A1")).toEqual({ fillColor: "blue" });
498
+ expect(model.getters.getConditionalFormats()).toHaveLength(1);
499
+ model.dispatch("ACTIVATE_SHEET", { from: newSheet, to: sheet });
500
+ expect(model.getters.getConditionalStyle("A1")).toEqual({ fillColor: "orange" });
501
+ expect(model.getters.getConditionalFormats()).toHaveLength(1);
502
+ });
503
+
504
+ test("Cells are correctly duplicated", () => {
505
+ const model = new Model({
506
+ sheets: [
507
+ {
508
+ colNumber: 5,
509
+ rowNumber: 5,
510
+ cells: {
511
+ A1: { content: "42" },
512
+ },
513
+ },
514
+ ],
515
+ });
516
+ const sheet = model.getters.getActiveSheet();
517
+ model.dispatch("DUPLICATE_SHEET", { sheet, id: uuidv4(), name: "dup" });
518
+ expect(model.getters.getSheets()).toHaveLength(2);
519
+ const newSheet = model.getters.getSheets()[1].id;
520
+ model.dispatch("ACTIVATE_SHEET", { from: sheet, to: newSheet });
521
+ expect(getText(model, "A1")).toBe("42");
522
+ model.dispatch("SET_VALUE", { xc: "A1", text: "24" });
523
+ expect(getText(model, "A1")).toBe("24");
524
+ model.dispatch("ACTIVATE_SHEET", { from: newSheet, to: sheet });
525
+ expect(getText(model, "A1")).toBe("42");
526
+ });
527
+
528
+ test("Cols and Rows are correctly duplicated", () => {
529
+ const model = new Model();
530
+ const sheet = model.getters.getActiveSheet();
531
+ model.dispatch("DUPLICATE_SHEET", { sheet, id: uuidv4(), name: "dup" });
532
+ expect(model.getters.getSheets()).toHaveLength(2);
533
+ model.dispatch("RESIZE_COLUMNS", { cols: [0], size: 1, sheet });
534
+ model.dispatch("RESIZE_ROWS", { rows: [0], size: 1, sheet });
535
+ const newSheet = model.getters.getSheets()[1].id;
536
+ model.dispatch("ACTIVATE_SHEET", { from: sheet, to: newSheet });
537
+ expect(model.getters.getCol(model.getters.getActiveSheet(), 0).size).not.toBe(1);
538
+ expect(model.getters.getRow(model.getters.getActiveSheet(), 0).size).not.toBe(1);
539
+ });
540
+
541
+ test("Merges are correctly duplicated", () => {
542
+ const model = new Model({
543
+ sheets: [
544
+ {
545
+ colNumber: 5,
546
+ rowNumber: 5,
547
+ merges: ["A1:A2"],
548
+ },
549
+ ],
550
+ });
551
+ const sheet = model.getters.getActiveSheet();
552
+ model.dispatch("DUPLICATE_SHEET", { sheet, id: uuidv4(), name: "dup" });
553
+ expect(model.getters.getSheets()).toHaveLength(2);
554
+ model.dispatch("REMOVE_MERGE", { sheet, zone: toZone("A1:A2") });
555
+ const newSheet = model.getters.getSheets()[1].id;
556
+ model.dispatch("ACTIVATE_SHEET", { from: sheet, to: newSheet });
557
+ expect(model.exportData().sheets[0].merges).toHaveLength(0);
558
+ expect(model.exportData().sheets[1].merges).toHaveLength(1);
559
+ });
560
+
561
+ test("Can delete the active sheet", () => {
562
+ const model = new Model();
563
+ const sheet1 = model.getters.getActiveSheet();
564
+ model.dispatch("CREATE_SHEET", { id: "42", activate: true });
565
+ const sheet2 = model.getters.getActiveSheet();
566
+ model.dispatch("DELETE_SHEET", { sheet: sheet2 });
567
+ expect(model.getters.getSheets()).toHaveLength(1);
568
+ expect(model.getters.getSheets()[0].id).toEqual(sheet1);
569
+ expect(model.getters.getActiveSheet()).toEqual(sheet1);
570
+ model.dispatch("UNDO");
571
+ expect(model.getters.getSheets()).toHaveLength(2);
572
+ expect(model.getters.getActiveSheet()).toEqual(sheet2);
573
+ model.dispatch("REDO");
574
+ expect(model.getters.getSheets()).toHaveLength(1);
575
+ expect(model.getters.getActiveSheet()).toEqual(sheet1);
576
+ });
577
+
578
+ test("Can delete a non-active sheet", () => {
579
+ const model = new Model();
580
+ const sheet1 = model.getters.getActiveSheet();
581
+ model.dispatch("CREATE_SHEET", { id: "42", activate: true });
582
+ const sheet2 = model.getters.getSheets()[1].id;
583
+ model.dispatch("DELETE_SHEET", { sheet: sheet1 });
584
+ expect(model.getters.getSheets()).toHaveLength(1);
585
+ expect(model.getters.getSheets()[0].id).toEqual(sheet2);
586
+ expect(model.getters.getActiveSheet()).toEqual(sheet2);
587
+ });
588
+
589
+ test("Cannot delete sheet if there is only one", () => {
590
+ const model = new Model();
591
+ expect(model.dispatch("DELETE_SHEET", { sheet: model.getters.getActiveSheet() })).toEqual({
592
+ status: "CANCELLED",
593
+ reason: CancelledReason.NotEnoughSheets,
594
+ });
595
+ });
596
+
597
+ test("Can undo-redo a sheet deletion", () => {
598
+ const model = new Model();
599
+ model.dispatch("CREATE_SHEET", { id: "42" });
600
+ testUndoRedo(model, expect, "DELETE_SHEET", { sheet: "42" });
601
+ });
602
+
603
+ test("Can undo-redo a sheet renaming", () => {
604
+ const model = new Model();
605
+ testUndoRedo(model, expect, "RENAME_SHEET", {
606
+ sheet: model.getters.getActiveSheet(),
607
+ name: "New name",
608
+ });
609
+ });
610
+
611
+ test("Can undo-redo a sheet duplication", () => {
612
+ const model = new Model();
613
+ testUndoRedo(model, expect, "DUPLICATE_SHEET", {
614
+ id: "42",
615
+ sheet: model.getters.getActiveSheet(),
616
+ name: "dup",
617
+ });
618
+ });
619
+
620
+ test("Sheet reference are correctly marked as #REF on sheet deletion", () => {
621
+ const model = new Model();
622
+ const name = "NEW_NAME";
623
+ const sheet1 = model.getters.getActiveSheet();
624
+ model.dispatch("SET_VALUE", {
625
+ xc: "A1",
626
+ text: "=NEW_NAME!A1",
627
+ });
628
+
629
+ model.dispatch("CREATE_SHEET", { id: "42", name, activate: true });
630
+ const sheet2 = model.getters.getActiveSheet();
631
+ model.dispatch("SET_VALUE", { xc: "A1", text: "42" });
632
+ model.dispatch("DELETE_SHEET", { sheet: sheet2 });
633
+ expect(model.getters.getCell(0, 0)!.content).toBe("=#REF");
634
+ model.dispatch("UNDO");
635
+ model.dispatch("ACTIVATE_SHEET", { from: sheet2, to: sheet1 });
636
+ expect(model.getters.getCell(0, 0)!.content).toBe("=NEW_NAME!A1");
637
+ });
638
+ });
639
+
640
+ function getText(model: Model, xc: string): string {
641
+ const cell = model.getters.getCell(...toCartesian(xc));
642
+ return cell ? model.getters.getCellText(cell) : "";
643
+ }