@odoo/o-spreadsheet 14.0.0 → 14.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 (198) 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 +3 -17
  12. package/rollup.config.js +23 -0
  13. package/src/base_plugin.ts +102 -0
  14. package/src/components/autofill.ts +146 -0
  15. package/src/components/bottom_bar.ts +199 -0
  16. package/src/components/color_picker.ts +150 -0
  17. package/src/components/composer/autocomplete_dropdown.ts +135 -0
  18. package/src/components/composer/composer.ts +487 -0
  19. package/src/components/composer/content_editable_helper.ts +146 -0
  20. package/src/components/figures/chart.ts +70 -0
  21. package/src/components/figures/container.ts +268 -0
  22. package/src/components/figures/text_figure.ts +36 -0
  23. package/src/components/grid.ts +635 -0
  24. package/src/components/helpers/dom_helpers.ts +7 -0
  25. package/src/components/helpers/drag_and_drop.ts +17 -0
  26. package/src/components/icons.ts +36 -0
  27. package/src/components/index.ts +1 -0
  28. package/src/components/menu.ts +288 -0
  29. package/src/components/overlay.ts +457 -0
  30. package/src/components/scrollbar.ts +22 -0
  31. package/src/components/selection_input.ts +168 -0
  32. package/src/components/side_panel/cell_is_rule_editor.ts +169 -0
  33. package/src/components/side_panel/chart_panel.ts +104 -0
  34. package/src/components/side_panel/color_scale_rule_editor.ts +145 -0
  35. package/src/components/side_panel/conditional_formatting.ts +396 -0
  36. package/src/components/side_panel/side_panel.ts +127 -0
  37. package/src/components/side_panel/translations_terms.ts +45 -0
  38. package/src/components/spreadsheet.ts +198 -0
  39. package/src/components/top_bar.ts +535 -0
  40. package/src/constants.ts +26 -0
  41. package/src/data.ts +149 -0
  42. package/src/fonts.ts +41 -0
  43. package/src/formulas/compiler.ts +258 -0
  44. package/src/formulas/composer_tokenizer.ts +70 -0
  45. package/src/formulas/index.ts +15 -0
  46. package/src/formulas/normalize.ts +52 -0
  47. package/src/formulas/parser.ts +280 -0
  48. package/src/formulas/range_tokenizer.ts +97 -0
  49. package/src/formulas/tokenizer.ts +242 -0
  50. package/src/functions/arguments.ts +114 -0
  51. package/src/functions/dates.ts +302 -0
  52. package/src/functions/helpers.ts +592 -0
  53. package/src/functions/index.ts +52 -0
  54. package/src/functions/module_database.ts +282 -0
  55. package/src/functions/module_date.ts +743 -0
  56. package/src/functions/module_info.ts +69 -0
  57. package/src/functions/module_logical.ts +208 -0
  58. package/src/functions/module_lookup.ts +185 -0
  59. package/src/functions/module_math.ts +1252 -0
  60. package/src/functions/module_operators.ts +291 -0
  61. package/src/functions/module_statistical.ts +882 -0
  62. package/src/functions/module_text.ts +370 -0
  63. package/src/helpers/color.ts +30 -0
  64. package/src/helpers/coordinates.ts +71 -0
  65. package/src/helpers/grid_manipulation.ts +68 -0
  66. package/src/helpers/index.ts +7 -0
  67. package/src/helpers/misc.ts +76 -0
  68. package/src/helpers/numbers.ts +117 -0
  69. package/src/helpers/uuid.ts +19 -0
  70. package/src/helpers/zones.ts +263 -0
  71. package/src/history.ts +186 -0
  72. package/src/index.ts +84 -0
  73. package/src/model.ts +261 -0
  74. package/src/plugins/autofill.ts +412 -0
  75. package/src/plugins/chart.ts +404 -0
  76. package/src/plugins/clipboard.ts +461 -0
  77. package/src/plugins/conditional_format.ts +445 -0
  78. package/src/plugins/core.ts +1502 -0
  79. package/src/plugins/edition.ts +157 -0
  80. package/src/plugins/evaluation.ts +428 -0
  81. package/src/plugins/figures.ts +123 -0
  82. package/src/plugins/formatting.ts +630 -0
  83. package/src/plugins/highlight.ts +187 -0
  84. package/src/plugins/index.ts +32 -0
  85. package/src/plugins/merge.ts +524 -0
  86. package/src/plugins/renderer.ts +571 -0
  87. package/src/plugins/selection.ts +562 -0
  88. package/src/plugins/selection_inputs.ts +326 -0
  89. package/src/registries/autofill_modifiers.ts +76 -0
  90. package/src/registries/autofill_rules.ts +98 -0
  91. package/src/registries/figure_registry.ts +30 -0
  92. package/src/registries/index.ts +7 -0
  93. package/src/registries/menu_items_registry.ts +110 -0
  94. package/src/registries/menus/cell_menu_registry.ts +79 -0
  95. package/src/registries/menus/col_menu_registry.ts +63 -0
  96. package/src/registries/menus/index.ts +6 -0
  97. package/src/registries/menus/menu_items_actions.ts +425 -0
  98. package/src/registries/menus/row_menu_registry.ts +63 -0
  99. package/src/registries/menus/sheet_menu_registry.ts +75 -0
  100. package/src/registries/menus/topbar_menu_registry.ts +204 -0
  101. package/src/registries/side_panel_registry.ts +26 -0
  102. package/src/registries/topbar_component_registry.ts +12 -0
  103. package/src/registry.ts +51 -0
  104. package/src/translation.ts +44 -0
  105. package/src/types/autofill.ts +48 -0
  106. package/src/types/chart.ts +26 -0
  107. package/src/types/commands.ts +716 -0
  108. package/src/types/conditional_formatting.ts +124 -0
  109. package/src/types/env.ts +13 -0
  110. package/src/types/functions.ts +35 -0
  111. package/src/types/getters.ts +103 -0
  112. package/src/types/index.ts +20 -0
  113. package/src/types/misc.ts +143 -0
  114. package/src/types/rendering.ts +41 -0
  115. package/src/types/workbook_data.ts +62 -0
  116. package/tests/__mocks__/uuid.ts +7 -0
  117. package/tests/canvas.mock.ts +34 -0
  118. package/tests/components/__mocks__/content_editable_helper.ts +79 -0
  119. package/tests/components/__mocks__/scrollbar.ts +18 -0
  120. package/tests/components/__snapshots__/autocomplete_dropdown_test.ts.snap +29 -0
  121. package/tests/components/__snapshots__/bottom_bar_test.ts.snap +75 -0
  122. package/tests/components/__snapshots__/context_menu_test.ts.snap +88 -0
  123. package/tests/components/__snapshots__/grid_test.ts.snap +60 -0
  124. package/tests/components/__snapshots__/spreadsheet_test.ts.snap +455 -0
  125. package/tests/components/__snapshots__/top_bar_test.ts.snap +705 -0
  126. package/tests/components/autocomplete_dropdown_test.ts +315 -0
  127. package/tests/components/autofill_test.ts +167 -0
  128. package/tests/components/bottom_bar_test.ts +262 -0
  129. package/tests/components/chart_side_panel_test.ts +123 -0
  130. package/tests/components/composer_test.ts +400 -0
  131. package/tests/components/context_menu_test.ts +825 -0
  132. package/tests/components/grid_manipulation_test.ts +163 -0
  133. package/tests/components/grid_test.ts +581 -0
  134. package/tests/components/overlay_test.ts +541 -0
  135. package/tests/components/selection_input_test.ts +259 -0
  136. package/tests/components/side_panel_test.ts +148 -0
  137. package/tests/components/spreadsheet_test.ts +194 -0
  138. package/tests/components/top_bar_test.ts +427 -0
  139. package/tests/data_test.ts +175 -0
  140. package/tests/dom_helper.ts +42 -0
  141. package/tests/formulas/__snapshots__/compiler_test.ts.snap +302 -0
  142. package/tests/formulas/compiler_test.ts +266 -0
  143. package/tests/formulas/composer_tokenizer_test.ts +137 -0
  144. package/tests/formulas/expressions_test.ts +57 -0
  145. package/tests/formulas/formulas_test.ts +80 -0
  146. package/tests/formulas/normalize_test.ts +82 -0
  147. package/tests/formulas/parser_test.ts +224 -0
  148. package/tests/formulas/range_tokenizer_test.ts +187 -0
  149. package/tests/formulas/tokenizer_test.ts +164 -0
  150. package/tests/functions/arguments_test.ts +141 -0
  151. package/tests/functions/dates_test.ts +1081 -0
  152. package/tests/functions/functions_test.ts +53 -0
  153. package/tests/functions/helper_test.ts +98 -0
  154. package/tests/functions/module_database_test.ts +311 -0
  155. package/tests/functions/module_date_test.ts +941 -0
  156. package/tests/functions/module_info_test.ts +139 -0
  157. package/tests/functions/module_logical_test.ts +369 -0
  158. package/tests/functions/module_lookup_test.ts +541 -0
  159. package/tests/functions/module_math_test.ts +2482 -0
  160. package/tests/functions/module_operators_test.ts +955 -0
  161. package/tests/functions/module_statistical_test.ts +2014 -0
  162. package/tests/functions/module_text_test.ts +667 -0
  163. package/tests/helpers/coordinates_test.ts +25 -0
  164. package/tests/helpers/misc_test.ts +95 -0
  165. package/tests/helpers/numbers_test.ts +196 -0
  166. package/tests/helpers/zones_test.ts +97 -0
  167. package/tests/helpers.ts +384 -0
  168. package/tests/menu_items_registry_test.ts +540 -0
  169. package/tests/model/plugins/__snapshots__/chart_test.ts.snap +90 -0
  170. package/tests/model/plugins/chart_test.ts +562 -0
  171. package/tests/model_test.ts +82 -0
  172. package/tests/plugins/__snapshots__/conditional_formatting_test.ts.snap +131 -0
  173. package/tests/plugins/__snapshots__/renderer_test.ts.snap +371 -0
  174. package/tests/plugins/autofill_test.ts +457 -0
  175. package/tests/plugins/borders_test.ts +295 -0
  176. package/tests/plugins/clipboard_test.ts +1180 -0
  177. package/tests/plugins/conditional_formatting_test.ts +1253 -0
  178. package/tests/plugins/core_test.ts +614 -0
  179. package/tests/plugins/edition_test.ts +100 -0
  180. package/tests/plugins/evaluation_async_test.ts +332 -0
  181. package/tests/plugins/evaluation_dates_test.ts +79 -0
  182. package/tests/plugins/evaluation_test.ts +901 -0
  183. package/tests/plugins/figures_test.ts +327 -0
  184. package/tests/plugins/formatting_test.ts +391 -0
  185. package/tests/plugins/grid_manipulation_test.ts +1366 -0
  186. package/tests/plugins/highlight_test.ts +413 -0
  187. package/tests/plugins/history_test.ts +142 -0
  188. package/tests/plugins/import_export_test.ts +276 -0
  189. package/tests/plugins/merges_test.ts +490 -0
  190. package/tests/plugins/navigation_test.ts +181 -0
  191. package/tests/plugins/plugins/evaluation_test.ts +111 -0
  192. package/tests/plugins/renderer_test.ts +598 -0
  193. package/tests/plugins/resizing_test.ts +152 -0
  194. package/tests/plugins/selection_input_test.ts +409 -0
  195. package/tests/plugins/selection_test.ts +442 -0
  196. package/tests/plugins/sheets_test.ts +643 -0
  197. package/tests/plugins/style_test.ts +90 -0
  198. package/tsconfig.json +22 -0
@@ -0,0 +1,490 @@
1
+ import { toZone } from "../../src/helpers/index";
2
+ import { Model } from "../../src/model";
3
+ import { Border, Style } from "../../src/types/index";
4
+ import "../canvas.mock";
5
+ import { getActiveXc, getCell } from "../helpers";
6
+
7
+ describe("merges", () => {
8
+ test("can merge two cells", () => {
9
+ const model = new Model();
10
+ model.dispatch("SET_VALUE", { xc: "B2", text: "b2" });
11
+
12
+ expect(Object.keys(model["workbook"].activeSheet.cells)).toEqual(["B2"]);
13
+ expect(Object.keys(model["workbook"].activeSheet.mergeCellMap)).toEqual([]);
14
+ expect(Object.keys(model["workbook"].activeSheet.merges)).toEqual([]);
15
+ const sheet1 = model["workbook"].visibleSheets[0];
16
+ model.dispatch("ADD_MERGE", { sheet: sheet1, zone: toZone("B2:B3") });
17
+
18
+ expect(Object.keys(model["workbook"].activeSheet.cells)).toEqual(["B2"]);
19
+ expect(model["workbook"].activeSheet.cells.B2.content).toBe("b2");
20
+ expect(Object.keys(model["workbook"].activeSheet.mergeCellMap)).toEqual(["B2", "B3"]);
21
+ expect(model["workbook"].activeSheet.merges).toEqual({
22
+ "1": { bottom: 2, id: 1, left: 1, right: 1, top: 1, topLeft: "B2" },
23
+ });
24
+ });
25
+
26
+ test("can unmerge two cells", () => {
27
+ const model = new Model({
28
+ sheets: [
29
+ {
30
+ colNumber: 10,
31
+ rowNumber: 10,
32
+ cells: { B2: { content: "b2" } },
33
+ merges: ["B2:B3"],
34
+ },
35
+ ],
36
+ });
37
+ expect(Object.keys(model["workbook"].activeSheet.mergeCellMap)).toEqual(["B2", "B3"]);
38
+ expect(model["workbook"].activeSheet.merges).toEqual({
39
+ "1": { bottom: 2, id: 1, left: 1, right: 1, top: 1, topLeft: "B2" },
40
+ });
41
+ const sheet1 = model["workbook"].visibleSheets[0];
42
+
43
+ model.dispatch("SELECT_CELL", { col: 1, row: 1 });
44
+ model.dispatch("REMOVE_MERGE", { sheet: sheet1, zone: toZone("B2:B3") });
45
+ expect(Object.keys(model["workbook"].activeSheet.cells)).toEqual(["B2"]);
46
+ expect(Object.keys(model["workbook"].activeSheet.mergeCellMap)).toEqual([]);
47
+ expect(Object.keys(model["workbook"].activeSheet.merges)).toEqual([]);
48
+ });
49
+
50
+ test("a single cell is not merged", () => {
51
+ const model = new Model();
52
+ model.dispatch("SET_VALUE", { xc: "B2", text: "b2" });
53
+ const sheet1 = model["workbook"].visibleSheets[0];
54
+
55
+ expect(Object.keys(model["workbook"].activeSheet.merges)).toEqual([]);
56
+
57
+ model.dispatch("ADD_MERGE", { sheet: sheet1, zone: toZone("B2:B2") });
58
+
59
+ expect(Object.keys(model["workbook"].activeSheet.mergeCellMap)).toEqual([]);
60
+ expect(Object.keys(model["workbook"].activeSheet.merges)).toEqual([]);
61
+ });
62
+
63
+ test("editing a merge cell actually edits the top left", () => {
64
+ const model = new Model({
65
+ sheets: [
66
+ {
67
+ colNumber: 10,
68
+ rowNumber: 10,
69
+ cells: { B2: { content: "b2" } },
70
+ merges: ["B2:C3"],
71
+ },
72
+ ],
73
+ });
74
+
75
+ model.dispatch("SELECT_CELL", { col: 2, row: 2 });
76
+ expect(getActiveXc(model)).toBe("C3");
77
+ model.dispatch("START_EDITION");
78
+ expect(model.getters.getCurrentContent()).toBe("b2");
79
+ model.dispatch("SET_CURRENT_CONTENT", { content: "new value" });
80
+ model.dispatch("STOP_EDITION");
81
+ expect(getCell(model, "B2")!.content).toBe("new value");
82
+ });
83
+
84
+ test("setting a style to a merge edit all the cells", () => {
85
+ const model = new Model({
86
+ sheets: [
87
+ {
88
+ colNumber: 10,
89
+ rowNumber: 10,
90
+ cells: { B2: { content: "b2" } },
91
+ merges: ["B2:C3"],
92
+ },
93
+ ],
94
+ });
95
+
96
+ model.dispatch("SELECT_CELL", { col: 2, row: 2 });
97
+ expect(getActiveXc(model)).toBe("C3");
98
+ expect(Object.keys(model["workbook"].activeSheet.cells)).toEqual(["B2"]);
99
+ expect(getCell(model, "B2")!.style).not.toBeDefined();
100
+ const sheet1 = model["workbook"].visibleSheets[0];
101
+
102
+ model.dispatch("SET_FORMATTING", {
103
+ sheet: sheet1,
104
+ target: model.getters.getSelectedZones(),
105
+ style: { fillColor: "#333" },
106
+ });
107
+
108
+ expect(Object.keys(model["workbook"].activeSheet.cells)).toEqual(["B2", "B3", "C2", "C3"]);
109
+ expect(getCell(model, "B2")!.style).toBeDefined();
110
+ });
111
+
112
+ test("when moving in a merge, selected cell is topleft", () => {
113
+ const model = new Model({
114
+ sheets: [
115
+ {
116
+ colNumber: 10,
117
+ rowNumber: 10,
118
+ cells: { B2: { content: "b2" } },
119
+ merges: ["B2:C3"],
120
+ },
121
+ ],
122
+ });
123
+
124
+ model.dispatch("SELECT_CELL", { col: 2, row: 3 });
125
+ expect(getActiveXc(model)).toBe("C4");
126
+ expect(model.getters.getActiveCell()).toBeNull(); // no active cell in C4
127
+ model.dispatch("MOVE_POSITION", { deltaX: 0, deltaY: -1 });
128
+ expect(getActiveXc(model)).toBe("C3");
129
+ expect(model.getters.getActiveCell()!.xc).toBe("B2");
130
+ });
131
+
132
+ test("merge style is correct for inactive sheets", () => {
133
+ const model = new Model({
134
+ sheets: [
135
+ {
136
+ id: "1",
137
+ colNumber: 1,
138
+ rowNumber: 1,
139
+ cells: {
140
+ A1: { content: "1", style: 1 },
141
+ },
142
+ },
143
+ {
144
+ id: "2",
145
+ colNumber: 3,
146
+ rowNumber: 3,
147
+ merges: ["A1:B1"],
148
+ cells: {
149
+ A1: { content: "2", style: 2 },
150
+ B1: { content: "", style: 2 },
151
+ },
152
+ },
153
+ ],
154
+ styles: {
155
+ 1: { fillColor: "#f2f2f2" },
156
+ 2: { fillColor: "#a2a2a2" },
157
+ },
158
+ });
159
+ const [, sheet2] = model.getters.getSheets();
160
+ expect(sheet2).not.toBe(model.getters.getActiveSheet());
161
+ model.dispatch("REMOVE_ROWS", {
162
+ rows: [2],
163
+ sheet: sheet2.id,
164
+ });
165
+ const cell = model.getters.getCell(0, 0, sheet2.name);
166
+ expect(model.getters.getCellStyle(cell!)).toEqual({
167
+ fillColor: "#a2a2a2",
168
+ });
169
+ });
170
+
171
+ test("properly compute if a merge is destructive or not", () => {
172
+ const model = new Model({
173
+ sheets: [
174
+ {
175
+ colNumber: 10,
176
+ rowNumber: 10,
177
+ cells: { B2: { content: "b2" } },
178
+ },
179
+ ],
180
+ });
181
+ // B2 is not top left, so it is destructive
182
+ expect(model.getters.isMergeDestructive(toZone("A1:C4"))).toBeTruthy();
183
+
184
+ // B2 is top left, so it is not destructive
185
+ expect(model.getters.isMergeDestructive(toZone("B2:C4"))).toBeFalsy();
186
+ });
187
+
188
+ test("a merge with only style should not be considered destructive", () => {
189
+ const model = new Model({
190
+ sheets: [
191
+ {
192
+ colNumber: 10,
193
+ rowNumber: 10,
194
+ cells: { B2: { style: 1 } },
195
+ },
196
+ ],
197
+ styles: { 1: {} },
198
+ });
199
+
200
+ expect(model.getters.isMergeDestructive(toZone("A1:C4"))).toBeFalsy();
201
+ });
202
+
203
+ test("merging destructively a selection ask for confirmation", async () => {
204
+ const askConfirmation = jest.fn();
205
+ const model = new Model({}, { askConfirmation });
206
+ model.dispatch("SET_VALUE", { xc: "B2", text: "b2" });
207
+ model.dispatch("ALTER_SELECTION", { cell: [5, 5] });
208
+ model.dispatch("ADD_MERGE", {
209
+ sheet: model.getters.getActiveSheet(),
210
+ zone: model.getters.getSelectedZone(),
211
+ interactive: true,
212
+ });
213
+ expect(askConfirmation).toHaveBeenCalled();
214
+ });
215
+
216
+ test("merging cells with values will do nothing if not forced", () => {
217
+ const model = new Model({
218
+ sheets: [
219
+ {
220
+ colNumber: 10,
221
+ rowNumber: 10,
222
+ cells: {
223
+ A1: { content: "1" },
224
+ A2: { content: "2" },
225
+ A3: { content: "3" },
226
+ A4: { content: "=sum(A1:A3)" },
227
+ },
228
+ },
229
+ ],
230
+ });
231
+ expect(getCell(model, "A4")!.value).toBe(6);
232
+ model.dispatch("ADD_MERGE", { sheet: "Sheet1", zone: toZone("A1:A3") });
233
+
234
+ expect(getCell(model, "A1")!.value).toBe(1);
235
+ expect(getCell(model, "A2")!.value).toBe(2);
236
+ expect(getCell(model, "A3")!.value).toBe(3);
237
+ expect(getCell(model, "A4")!.value).toBe(6);
238
+ });
239
+
240
+ test("merging cells with values remove them if forced", () => {
241
+ const model = new Model({
242
+ sheets: [
243
+ {
244
+ colNumber: 10,
245
+ rowNumber: 10,
246
+ cells: {
247
+ A1: { content: "1" },
248
+ A2: { content: "2" },
249
+ A3: { content: "3" },
250
+ A4: { content: "=sum(A1:A3)" },
251
+ },
252
+ },
253
+ ],
254
+ });
255
+ const sheet1 = model["workbook"].visibleSheets[0];
256
+ expect(getCell(model, "A4")!.value).toBe(6);
257
+ model.dispatch("ADD_MERGE", { sheet: sheet1, zone: toZone("A1:A3"), force: true });
258
+
259
+ expect(getCell(model, "A1")!.value).toBe(1);
260
+ expect(getCell(model, "A2")).toBeNull();
261
+ expect(getCell(model, "A3")).toBeNull();
262
+ expect(getCell(model, "A4")!.value).toBe(1);
263
+ });
264
+
265
+ test("merging => setting background color => unmerging", () => {
266
+ const model = new Model();
267
+ const sheet1 = model["workbook"].visibleSheets[0];
268
+ model.dispatch("ALTER_SELECTION", { cell: [1, 0] });
269
+
270
+ expect(model.getters.getSelectedZones()[0]).toEqual({ top: 0, left: 0, right: 1, bottom: 0 });
271
+
272
+ model.dispatch("ADD_MERGE", { sheet: sheet1, zone: toZone("A1:B1") });
273
+ model.dispatch("SET_FORMATTING", {
274
+ sheet: sheet1,
275
+ target: [{ left: 0, right: 1, top: 0, bottom: 0 }],
276
+ style: { fillColor: "red" },
277
+ });
278
+
279
+ expect(getStyle(model, "A1")).toEqual({ fillColor: "red" });
280
+ expect(getStyle(model, "B1")).toEqual({ fillColor: "red" });
281
+
282
+ model.dispatch("REMOVE_MERGE", { sheet: sheet1, zone: toZone("A1:B1") });
283
+ expect(getStyle(model, "A1")).toEqual({ fillColor: "red" });
284
+ expect(getStyle(model, "B1")).toEqual({ fillColor: "red" });
285
+ });
286
+
287
+ test("setting background color => merging => unmerging", () => {
288
+ const model = new Model();
289
+ const sheet1 = model.getters.getSheets()[0].id;
290
+ model.dispatch("ALTER_SELECTION", { cell: [1, 0] });
291
+ model.dispatch("SET_FORMATTING", {
292
+ sheet: sheet1,
293
+ target: [{ left: 0, right: 1, top: 0, bottom: 0 }],
294
+ style: { fillColor: "red" },
295
+ });
296
+
297
+ expect(getStyle(model, "A1")).toEqual({ fillColor: "red" });
298
+ expect(getStyle(model, "B1")).toEqual({ fillColor: "red" });
299
+
300
+ model.dispatch("ADD_MERGE", { sheet: sheet1, zone: toZone("A1:B1") });
301
+ expect(getStyle(model, "A1")).toEqual({ fillColor: "red" });
302
+ expect(getStyle(model, "B1")).toEqual({ fillColor: "red" });
303
+
304
+ model.dispatch("REMOVE_MERGE", { sheet: sheet1, zone: toZone("A1:B1") });
305
+ expect(getStyle(model, "A1")).toEqual({ fillColor: "red" });
306
+ expect(getStyle(model, "B1")).toEqual({ fillColor: "red" });
307
+ });
308
+
309
+ test("setting background color to topleft => merging => unmerging", () => {
310
+ const model = new Model();
311
+ const sheet1 = model.getters.getSheets()[0].id;
312
+ model.dispatch("SET_FORMATTING", {
313
+ sheet: sheet1,
314
+ target: [{ left: 0, right: 0, top: 0, bottom: 0 }],
315
+ style: { fillColor: "red" },
316
+ });
317
+ model.dispatch("ALTER_SELECTION", { cell: [1, 0] });
318
+
319
+ expect(getStyle(model, "A1")).toEqual({ fillColor: "red" });
320
+
321
+ model.dispatch("ADD_MERGE", { sheet: sheet1, zone: toZone("A1:B1") });
322
+ expect(getStyle(model, "A1")).toEqual({ fillColor: "red" });
323
+ expect(getStyle(model, "B1")).toEqual({ fillColor: "red" });
324
+
325
+ model.dispatch("REMOVE_MERGE", { sheet: sheet1, zone: toZone("A1:B1") });
326
+ expect(getStyle(model, "A1")).toEqual({ fillColor: "red" });
327
+ expect(getStyle(model, "B1")).toEqual({ fillColor: "red" });
328
+ });
329
+
330
+ test("merging => setting border => unmerging", () => {
331
+ const model = new Model();
332
+ const sheet1 = model.getters.getSheets()[0].id;
333
+ model.dispatch("ALTER_SELECTION", { cell: [1, 0] });
334
+
335
+ expect(model.getters.getSelectedZones()[0]).toEqual({ top: 0, left: 0, right: 1, bottom: 0 });
336
+
337
+ model.dispatch("ADD_MERGE", { sheet: sheet1, zone: toZone("A1:B1") });
338
+ model.dispatch("SET_FORMATTING", {
339
+ sheet: sheet1,
340
+ target: model.getters.getSelectedZones(),
341
+ border: "external",
342
+ });
343
+ const line = ["thin", "#000"];
344
+ expect(getBorder(model, "A1")).toEqual({ left: line, bottom: line, top: line });
345
+ expect(getBorder(model, "B1")).toEqual({ right: line, bottom: line, top: line });
346
+
347
+ model.dispatch("REMOVE_MERGE", { sheet: sheet1, zone: toZone("A1:B1") });
348
+ expect(getBorder(model, "A1")).toEqual({ left: line, bottom: line, top: line });
349
+ expect(getBorder(model, "B1")).toEqual({ right: line, bottom: line, top: line });
350
+ });
351
+
352
+ test("setting border => merging => unmerging", () => {
353
+ const model = new Model();
354
+ const sheet1 = model.getters.getSheets()[0].id;
355
+ model.dispatch("ALTER_SELECTION", { cell: [1, 0] });
356
+
357
+ model.dispatch("SET_FORMATTING", {
358
+ sheet: sheet1,
359
+ target: model.getters.getSelectedZones(),
360
+ border: "external",
361
+ });
362
+ const line = ["thin", "#000"];
363
+ expect(getBorder(model, "A1")).toEqual({ left: line, bottom: line, top: line });
364
+ expect(getBorder(model, "B1")).toEqual({ right: line, bottom: line, top: line });
365
+ model.dispatch("ADD_MERGE", { sheet: sheet1, zone: toZone("A1:B1") });
366
+ model.dispatch("REMOVE_MERGE", { sheet: sheet1, zone: toZone("A1:B1") });
367
+ expect(getBorder(model, "A1")).toEqual({ left: line, bottom: line, top: line });
368
+ expect(getBorder(model, "B1")).toEqual({ right: line, bottom: line, top: line });
369
+ });
370
+
371
+ test("setting border to topleft => merging => unmerging", () => {
372
+ const model = new Model();
373
+ const sheet1 = model.getters.getSheets()[0].id;
374
+ model.dispatch("SET_FORMATTING", {
375
+ sheet: sheet1,
376
+ target: [{ left: 0, right: 0, top: 0, bottom: 0 }],
377
+ border: "external",
378
+ });
379
+ const line = ["thin", "#000"];
380
+ model.dispatch("ADD_MERGE", { sheet: sheet1, zone: toZone("A1:B1") });
381
+ expect(getBorder(model, "A1")).toEqual({ left: line, bottom: line, top: line });
382
+ expect(getBorder(model, "B1")).toEqual({ right: line, bottom: line, top: line });
383
+ model.dispatch("REMOVE_MERGE", { sheet: sheet1, zone: toZone("A1:B1") });
384
+ expect(getBorder(model, "A1")).toEqual({ left: line, bottom: line, top: line });
385
+ expect(getBorder(model, "B1")).toEqual({ right: line, bottom: line, top: line });
386
+ });
387
+
388
+ test("setting border to topleft => setting style => merging => unmerging", () => {
389
+ const model = new Model();
390
+ const sheet1 = model.getters.getSheets()[0].id;
391
+ model.dispatch("SET_FORMATTING", {
392
+ sheet: sheet1,
393
+ target: [{ left: 0, right: 0, top: 0, bottom: 0 }],
394
+ border: "external",
395
+ style: { fillColor: "red" },
396
+ });
397
+ const line = ["thin", "#000"];
398
+ model.dispatch("ADD_MERGE", { sheet: sheet1, zone: toZone("A1:B1") });
399
+ expect(getBorder(model, "A1")).toEqual({ left: line, bottom: line, top: line });
400
+ expect(getBorder(model, "B1")).toEqual({ right: line, bottom: line, top: line });
401
+ expect(getStyle(model, "A1")).toEqual({ fillColor: "red" });
402
+ expect(getStyle(model, "B1")).toEqual({ fillColor: "red" });
403
+ model.dispatch("REMOVE_MERGE", { sheet: sheet1, zone: toZone("A1:B1") });
404
+ expect(getBorder(model, "A1")).toEqual({ left: line, bottom: line, top: line });
405
+ expect(getBorder(model, "B1")).toEqual({ right: line, bottom: line, top: line });
406
+ expect(getStyle(model, "A1")).toEqual({ fillColor: "red" });
407
+ expect(getStyle(model, "B1")).toEqual({ fillColor: "red" });
408
+ });
409
+
410
+ test("selecting cell next to merge => expanding selection => merging => unmerging", () => {
411
+ const model = new Model({
412
+ sheets: [{ colNumber: 10, rowNumber: 10, merges: ["A1:A2"] }],
413
+ });
414
+ const sheet1 = model["workbook"].visibleSheets[0];
415
+
416
+ //merging
417
+ model.dispatch("ADD_MERGE", { sheet: sheet1, zone: toZone("A1:A3") });
418
+ const mergeId = model["workbook"].activeSheet.mergeCellMap.A1;
419
+ expect(mergeId).toBeGreaterThan(0);
420
+ expect(model["workbook"].activeSheet.mergeCellMap.A2).toBe(mergeId);
421
+
422
+ // unmerge. there should not be any merge left
423
+ model.dispatch("REMOVE_MERGE", { sheet: sheet1, zone: toZone("A1:A3") });
424
+ expect(model["workbook"].activeSheet.mergeCellMap).toEqual({});
425
+ expect(model["workbook"].activeSheet.merges).toEqual({});
426
+ });
427
+
428
+ test("can undo and redo a merge", () => {
429
+ const model = new Model();
430
+ const sheet1 = model["workbook"].visibleSheets[0];
431
+
432
+ // select B2:B3 and merge
433
+ model.dispatch("ADD_MERGE", { sheet: sheet1, zone: toZone("B2:B3") });
434
+
435
+ expect(Object.keys(model["workbook"].activeSheet.mergeCellMap)).toEqual(["B2", "B3"]);
436
+ expect(model["workbook"].activeSheet.merges).toEqual({
437
+ "1": { bottom: 2, id: 1, left: 1, right: 1, top: 1, topLeft: "B2" },
438
+ });
439
+
440
+ // undo
441
+ model.dispatch("UNDO");
442
+ expect(Object.keys(model["workbook"].activeSheet.mergeCellMap)).toEqual([]);
443
+ expect(Object.keys(model["workbook"].activeSheet.merges)).toEqual([]);
444
+
445
+ // redo
446
+ model.dispatch("REDO");
447
+ expect(Object.keys(model["workbook"].activeSheet.mergeCellMap)).toEqual(["B2", "B3"]);
448
+ expect(model["workbook"].activeSheet.merges).toEqual({
449
+ "1": { bottom: 2, id: 1, left: 1, right: 1, top: 1, topLeft: "B2" },
450
+ });
451
+ });
452
+
453
+ test("merge, undo, select, redo: correct selection", () => {
454
+ const model = new Model();
455
+ const sheet1 = model["workbook"].visibleSheets[0];
456
+
457
+ model.dispatch("ADD_MERGE", { sheet: sheet1, zone: toZone("B2:B3") });
458
+ model.dispatch("SELECT_CELL", { col: 1, row: 1 }); // B2
459
+ expect(model.getters.getSelection().zones).toEqual([{ bottom: 2, left: 1, right: 1, top: 1 }]);
460
+ model.dispatch("UNDO");
461
+ expect(model.getters.getSelection().zones).toEqual([{ bottom: 2, left: 1, right: 1, top: 1 }]);
462
+ model.dispatch("SELECT_CELL", { col: 1, row: 1 }); // B2
463
+
464
+ expect(model.getters.getSelection().zones).toEqual([{ bottom: 1, left: 1, right: 1, top: 1 }]);
465
+ model.dispatch("REDO");
466
+ expect(model.getters.getSelection().zones).toEqual([{ bottom: 2, left: 1, right: 1, top: 1 }]);
467
+ });
468
+
469
+ test("merge, unmerge, select, undo: correct selection", () => {
470
+ const model = new Model();
471
+ const sheet1 = model["workbook"].visibleSheets[0];
472
+
473
+ model.dispatch("ADD_MERGE", { sheet: sheet1, zone: toZone("B2:B3") });
474
+ model.dispatch("REMOVE_MERGE", { sheet: sheet1, zone: toZone("B2:B3") });
475
+ model.dispatch("SELECT_CELL", { col: 1, row: 1 }); // B2
476
+ expect(model.getters.getSelection().zones).toEqual([{ bottom: 1, left: 1, right: 1, top: 1 }]);
477
+ model.dispatch("UNDO");
478
+ expect(model.getters.getSelection().zones).toEqual([{ bottom: 2, left: 1, right: 1, top: 1 }]);
479
+ });
480
+ });
481
+
482
+ function getStyle(model: Model, xc: string): Style {
483
+ const cell = getCell(model, xc)!;
484
+ return cell && model.getters.getCellStyle(cell);
485
+ }
486
+
487
+ function getBorder(model: Model, xc: string): Border | null {
488
+ const cell = getCell(model, xc)!;
489
+ return cell && model.getters.getCellBorder(cell);
490
+ }
@@ -0,0 +1,181 @@
1
+ import { Model } from "../../src/model";
2
+ import { Viewport } from "../../src/types";
3
+ import "../canvas.mock";
4
+ import { getActiveXc } from "../helpers";
5
+
6
+ function getViewport(
7
+ model: Model,
8
+ width: number,
9
+ height: number,
10
+ offsetX: number,
11
+ offsetY: number
12
+ ): Viewport {
13
+ let viewport = { width, height, offsetX, offsetY, left: 0, right: 0, top: 0, bottom: 0 };
14
+ viewport = model.getters.adjustViewportZone(viewport);
15
+ return viewport;
16
+ }
17
+
18
+ describe("navigation", () => {
19
+ test("normal move to the right", () => {
20
+ const model = new Model();
21
+ expect(model.getters.getSelectedZones()[0]).toEqual({ top: 0, right: 0, left: 0, bottom: 0 });
22
+ expect(model.getters.getPosition()).toEqual([0, 0]);
23
+ expect(model.getters.getSelection().anchor).toEqual([0, 0]);
24
+
25
+ model.dispatch("MOVE_POSITION", { deltaX: 1, deltaY: 0 });
26
+ expect(model.getters.getSelectedZones()[0]).toEqual({ top: 0, right: 1, left: 1, bottom: 0 });
27
+ expect(model.getters.getPosition()).toEqual([1, 0]);
28
+ expect(model.getters.getSelection().anchor).toEqual([1, 0]);
29
+ });
30
+
31
+ test("move up from top row", () => {
32
+ const model = new Model();
33
+ expect(model.getters.getSelectedZones()[0]).toEqual({ top: 0, right: 0, left: 0, bottom: 0 });
34
+ expect(model.getters.getPosition()).toEqual([0, 0]);
35
+
36
+ model.dispatch("MOVE_POSITION", { deltaX: 0, deltaY: -1 });
37
+ expect(model.getters.getSelectedZones()[0]).toEqual({ top: 0, right: 0, left: 0, bottom: 0 });
38
+ expect(model.getters.getPosition()).toEqual([0, 0]);
39
+ });
40
+
41
+ test("move right from right row", () => {
42
+ const model = new Model();
43
+ const colNumber = model["workbook"].activeSheet.cols.length;
44
+ model.dispatch("SELECT_CELL", { col: colNumber - 1, row: 0 });
45
+
46
+ expect(model.getters.getPosition()).toEqual([colNumber - 1, 0]);
47
+ model.dispatch("MOVE_POSITION", { deltaX: 1, deltaY: 0 });
48
+ expect(model.getters.getPosition()).toEqual([colNumber - 1, 0]);
49
+ });
50
+
51
+ test("move bottom from bottom row", () => {
52
+ const model = new Model();
53
+ const rowNumber = model["workbook"].activeSheet.rows.length;
54
+ model.dispatch("SELECT_CELL", { col: 0, row: rowNumber - 1 });
55
+ expect(model.getters.getPosition()).toEqual([0, rowNumber - 1]);
56
+ model.dispatch("MOVE_POSITION", { deltaX: 0, deltaY: 1 });
57
+ expect(model.getters.getPosition()).toEqual([0, rowNumber - 1]);
58
+ });
59
+
60
+ test("move in and out of a merge", () => {
61
+ const model = new Model({
62
+ sheets: [
63
+ {
64
+ colNumber: 10,
65
+ rowNumber: 10,
66
+ merges: ["B1:C2"],
67
+ },
68
+ ],
69
+ });
70
+ expect(model.getters.getPosition()).toEqual([0, 0]);
71
+
72
+ // move to the right, inside the merge
73
+ model.dispatch("MOVE_POSITION", { deltaX: 1, deltaY: 0 });
74
+
75
+ expect(model.getters.getSelectedZones()[0]).toEqual({ top: 0, right: 2, left: 1, bottom: 1 });
76
+ expect(model.getters.getPosition()).toEqual([1, 0]);
77
+
78
+ // move to the right, outside the merge
79
+ model.dispatch("MOVE_POSITION", { deltaX: 1, deltaY: 0 });
80
+ expect(model.getters.getSelectedZones()[0]).toEqual({ top: 0, right: 3, left: 3, bottom: 0 });
81
+ expect(model.getters.getPosition()).toEqual([3, 0]);
82
+ expect(getActiveXc(model)).toBe("D1");
83
+ });
84
+
85
+ test("do nothing if moving out of merge is out of grid", () => {
86
+ const model = new Model({
87
+ sheets: [
88
+ {
89
+ colNumber: 10,
90
+ rowNumber: 10,
91
+ merges: ["B1:C2"],
92
+ },
93
+ ],
94
+ });
95
+ expect(model.getters.getPosition()).toEqual([0, 0]);
96
+
97
+ // put selection below merge
98
+ model.dispatch("SELECT_CELL", { col: 1, row: 2 });
99
+
100
+ // enter merge from below
101
+ expect(getActiveXc(model)).toBe("B3");
102
+ model.dispatch("MOVE_POSITION", { deltaX: 0, deltaY: -1 });
103
+ expect(getActiveXc(model)).toBe("B2");
104
+
105
+ expect(model.getters.getSelectedZones()[0]).toEqual({ top: 0, right: 2, left: 1, bottom: 1 });
106
+ expect(model.getters.getPosition()).toEqual([1, 1]);
107
+
108
+ // move to the top, outside the merge
109
+ model.dispatch("MOVE_POSITION", { deltaX: 0, deltaY: -1 });
110
+ expect(model.getters.getSelectedZones()[0]).toEqual({ top: 0, right: 2, left: 1, bottom: 1 });
111
+ expect(model.getters.getPosition()).toEqual([1, 1]);
112
+ });
113
+
114
+ test("move right from right col (of the viewport)", () => {
115
+ const model = new Model();
116
+ let viewport = getViewport(model, 600, 300, 0, 0);
117
+ expect(viewport.left).toBe(0);
118
+ expect(viewport.right).toBe(5);
119
+
120
+ model.dispatch("SELECT_CELL", { col: 4, row: 0 });
121
+ viewport = model.getters.adjustViewportPosition(viewport);
122
+ expect(viewport.left).toBe(0);
123
+ expect(viewport.right).toBe(5);
124
+
125
+ model.dispatch("SELECT_CELL", { col: 5, row: 0 });
126
+ viewport = model.getters.adjustViewportPosition(viewport);
127
+ expect(viewport.left).toBe(1);
128
+ expect(viewport.right).toBe(6);
129
+ });
130
+
131
+ test("move left from left col (of the viewport)", () => {
132
+ const model = new Model();
133
+ let viewport = getViewport(model, 600, 300, 100, 0);
134
+ expect(viewport.left).toBe(1);
135
+ expect(viewport.right).toBe(6);
136
+
137
+ model.dispatch("SELECT_CELL", { col: 1, row: 0 });
138
+ viewport = model.getters.adjustViewportPosition(viewport);
139
+ expect(viewport.left).toBe(1);
140
+ expect(viewport.right).toBe(6);
141
+
142
+ model.dispatch("SELECT_CELL", { col: 0, row: 0 });
143
+ viewport = model.getters.adjustViewportPosition(viewport);
144
+ expect(viewport.left).toBe(0);
145
+ expect(viewport.right).toBe(5);
146
+ });
147
+
148
+ test("move bottom from bottom row (of the viewport)", () => {
149
+ const model = new Model();
150
+ let viewport = getViewport(model, 600, 300, 0, 0);
151
+ expect(viewport.top).toBe(0);
152
+ expect(viewport.bottom).toBe(11);
153
+
154
+ model.dispatch("SELECT_CELL", { col: 0, row: 10 });
155
+ viewport = model.getters.adjustViewportPosition(viewport);
156
+ expect(viewport.top).toBe(0);
157
+ expect(viewport.bottom).toBe(11);
158
+
159
+ model.dispatch("SELECT_CELL", { col: 0, row: 11 });
160
+ viewport = model.getters.adjustViewportPosition(viewport);
161
+ expect(viewport.top).toBe(1);
162
+ expect(viewport.bottom).toBe(12);
163
+ });
164
+
165
+ test("move top from top row (of the viewport)", () => {
166
+ const model = new Model();
167
+ let viewport = getViewport(model, 600, 300, 0, 60);
168
+ expect(viewport.top).toBe(2);
169
+ expect(viewport.bottom).toBe(14);
170
+
171
+ model.dispatch("SELECT_CELL", { col: 0, row: 2 });
172
+ viewport = model.getters.adjustViewportPosition(viewport);
173
+ expect(viewport.top).toBe(2);
174
+ expect(viewport.bottom).toBe(14);
175
+
176
+ model.dispatch("SELECT_CELL", { col: 0, row: 1 });
177
+ viewport = model.getters.adjustViewportPosition(viewport);
178
+ expect(viewport.top).toBe(1);
179
+ expect(viewport.bottom).toBe(12);
180
+ });
181
+ });