1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
|
# (C) Copyright 2005-2023 Enthought, Inc., Austin, TX
# All rights reserved.
#
# This software is provided without warranty under the terms of the BSD
# license included in LICENSE.txt and may be redistributed only under
# the conditions described in the aforementioned license. The license
# is also available online at http://www.enthought.com/licenses/BSD.txt
#
# Thanks for using Enthought open source!
from contextlib import contextmanager
import unittest
from pyface.action.api import (
Action,
ActionItem,
ActionManager,
Group,
MenuManager,
MenuBarManager,
)
from pyface.action.schema.api import (
GroupSchema,
MenuSchema,
MenuBarSchema,
SchemaAddition,
)
from pyface.tasks.action.task_action_manager_builder import (
TaskActionManagerBuilder,
)
from pyface.tasks.api import Task
class ActionManagerBuilderTestCase(unittest.TestCase):
# 'TestCase' protocol -------------------------------------------------#
def setUp(self):
""" Create some dummy actions to use while testing.
"""
for i in range(1, 7):
action_id = "action%i" % i
setattr(
self, action_id, Action(id=action_id, name="Action %i" % i)
)
# 'ActionManagerBuilderTestCase' protocol -----------------------------#
def assertActionElementsEqual(self, first, second):
""" Checks that two action managers are (logically) equivalent.
"""
children1 = children2 = []
self.assertEqual(type(first), type(second))
self.assertEqual(first.id, second.id)
if isinstance(first, ActionItem):
self.assertEqual(first.action.name, second.action.name)
elif isinstance(first, ActionManager):
if not isinstance(first, MenuBarManager):
self.assertEqual(first.name, second.name)
children1, children2 = first.groups, second.groups
elif isinstance(first, Group):
self.assertEqual(first.separator, second.separator)
children1, children2 = first.items, second.items
self.assertEqual(len(children1), len(children2))
for i in range(len(children1)):
self.assertActionElementsEqual(children1[i], children2[i])
def reset_unique_ids(self):
import pyface.util.id_helper as id_helper
id_helper.object_counter = id_helper._ObjectCounter()
@contextmanager
def unique_id_context_manager(self):
self.reset_unique_ids()
try:
yield
finally:
self.reset_unique_ids()
# Tests ----------------------------------------------------------------
def test_simple_menu_bar(self):
""" Does constructing a simple menu with no additions work?
"""
schema = MenuBarSchema(
MenuSchema(self.action1, self.action2, id="File", name="&File"),
MenuSchema(self.action3, self.action4, id="Edit", name="&Edit"),
)
builder = TaskActionManagerBuilder(task=Task(menu_bar=schema))
actual = builder.create_menu_bar_manager()
desired = MenuBarManager(
MenuManager(self.action1, self.action2, id="File", name="&File"),
MenuManager(self.action3, self.action4, id="Edit", name="&Edit"),
id="MenuBar",
)
self.assertActionElementsEqual(actual, desired)
# Tests about schema additions -----------------------------------------
def test_additions_menu_bar(self):
""" Does constructing a menu with a few additions work?
"""
schema = MenuBarSchema(
MenuSchema(
GroupSchema(self.action1, self.action2, id="FileGroup"),
id="File",
)
)
extras = [
SchemaAddition(
factory=lambda: self.action3,
before="action1",
path="MenuBar/File/FileGroup",
),
SchemaAddition(
factory=lambda: self.action4,
before="action1",
path="MenuBar/File/FileGroup",
),
SchemaAddition(
factory=lambda: self.action5, path="MenuBar/File/FileGroup"
),
]
builder = TaskActionManagerBuilder(
task=Task(menu_bar=schema, extra_actions=extras)
)
actual = builder.create_menu_bar_manager()
desired = MenuBarManager(
MenuManager(
Group(
self.action3,
self.action4,
self.action1,
self.action2,
self.action5,
id="FileGroup",
),
id="File",
),
id="MenuBar",
)
self.assertActionElementsEqual(actual, desired)
def test_extra_menu(self):
""" Test contributing a whole new menu to the menu bar. """
# Initial menu.
schema = MenuBarSchema(
MenuSchema(
GroupSchema(self.action1, id="FileGroup"), id="FileMenu"
)
)
# Contributed menu.
extra_menu = MenuSchema(
GroupSchema(self.action2, id="BarGroup"), id="DummyActionsMenu"
)
extra_actions = [
SchemaAddition(
path="MenuBar",
factory=lambda: extra_menu,
id="DummyActionsSMenu",
)
]
# Build the final menu.
builder = TaskActionManagerBuilder(
task=Task(menu_bar=schema, extra_actions=extra_actions)
)
actual = builder.create_menu_bar_manager()
desired = MenuBarManager(
MenuManager(Group(self.action1, id="FileGroup"), id="FileMenu"),
MenuManager(
Group(self.action2, id="BarGroup"), id="DummyActionsMenu"
),
id="MenuBar",
)
self.assertActionElementsEqual(actual, desired)
# Tests about merging schemas -----------------------------------------#
def test_merging_redundant_items(self):
""" Menus and groups with matching path are merged together. """
# Initial menu.
schema = MenuBarSchema(
MenuSchema(
GroupSchema(self.action1, id="FileGroup"),
name="File menu number one",
id="FileMenu",
)
)
# Contributed menus.
extra_menu = MenuSchema(
GroupSchema(self.action2, id="FileGroup"),
name="File menu number two",
id="FileMenu",
)
extra_actions = [
SchemaAddition(
path="MenuBar",
factory=lambda: extra_menu,
id="DummyActionsSMenu",
)
]
# Build the final menu.
builder = TaskActionManagerBuilder(
task=Task(menu_bar=schema, extra_actions=extra_actions)
)
actual = builder.create_menu_bar_manager()
# Note that we expect the name of the menu to be inherited from
# the menu in the menu bar schema that is defined first.
desired = MenuBarManager(
MenuManager(
Group(self.action1, self.action2, id="FileGroup"),
name="File menu number one",
id="FileMenu",
),
id="MenuBar",
)
self.assertActionElementsEqual(actual, desired)
def test_unwanted_merge(self):
""" Test that we don't have automatic merges due to forgetting to set
a schema ID. """
with self.unique_id_context_manager():
# Initial menu.
schema = MenuBarSchema(
MenuSchema(
GroupSchema(self.action1, id="FileGroup"), name="File 1"
)
)
# Contributed menus.
extra_menu = MenuSchema(
GroupSchema(self.action2, id="FileGroup"), name="File 2"
)
extra_actions = [
SchemaAddition(
path="MenuBar",
factory=lambda: extra_menu,
id="DummyActionsSMenu",
)
]
# Build the final menu.
builder = TaskActionManagerBuilder(
task=Task(menu_bar=schema, extra_actions=extra_actions)
)
actual = builder.create_menu_bar_manager()
# Note that we expect the name of the menu to be inherited from
# the menu in the menu bar schema that is defined first.
desired = MenuBarManager(
MenuManager(
Group(self.action1, id="FileGroup"),
name="File 1",
id="MenuSchema_1",
),
MenuManager(
Group(self.action2, id="FileGroup"),
name="File 2",
id="MenuSchema_2",
),
id="MenuBar",
)
self.assertActionElementsEqual(actual, desired)
def test_merging_items_with_same_id_but_different_class(self):
""" Schemas with the same path but different types (menus, groups)
are not merged together.
Having a group and a menu with the same path is of course bad practice,
but we need a predictable outcome.
"""
# Initial menu.
schema = MenuBarSchema(
MenuSchema(
GroupSchema(self.action1, id="FileGroup"), id="FileSchema"
)
)
# Contributed menus.
extra_group = GroupSchema(self.action2, id="FileSchema")
extra_actions = [
SchemaAddition(
path="MenuBar",
factory=(lambda: extra_group),
id="DummyActionsSMenu",
)
]
# Build the final menu.
builder = TaskActionManagerBuilder(
task=Task(menu_bar=schema, extra_actions=extra_actions)
)
actual = builder.create_menu_bar_manager()
desired = MenuBarManager(
MenuManager(Group(self.action1, id="FileGroup"), id="FileSchema"),
Group(self.action2, id="FileSchema"),
id="MenuBar",
)
self.assertActionElementsEqual(actual, desired)
def test_merging_redundant_items_that_are_not_schemas(self):
""" Items that are not schemas cannot be merged, but we should
not crash, either. """
# Initial menu.
schema = MenuBarSchema(
# This menu is not a schema...
MenuManager(Group(self.action1, id="FileGroup"), id="FileMenu")
)
# Contributed menus.
extra_menu = MenuSchema(
GroupSchema(self.action2, id="FileGroup"), id="FileMenu"
)
extra_actions = [
SchemaAddition(
path="MenuBar",
factory=lambda: extra_menu,
id="DummyActionsSMenu",
)
]
# Build the final menu.
builder = TaskActionManagerBuilder(
task=Task(menu_bar=schema, extra_actions=extra_actions)
)
actual = builder.create_menu_bar_manager()
desired = MenuBarManager(
MenuManager(Group(self.action1, id="FileGroup"), id="FileMenu"),
MenuManager(Group(self.action2, id="FileGroup"), id="FileMenu"),
id="MenuBar",
)
self.assertActionElementsEqual(actual, desired)
# Tests about ordering -------------------------------------------------
def test_absolute_ordering(self):
""" Does specifying absolute_position work?
"""
schema = MenuBarSchema(
MenuSchema(
GroupSchema(self.action1, self.action2, id="FileGroup"),
id="File",
)
)
extras = [
SchemaAddition(
factory=lambda: self.action3,
absolute_position="last",
path="MenuBar/File/FileGroup",
),
SchemaAddition(
factory=lambda: self.action4,
absolute_position="first",
path="MenuBar/File/FileGroup",
),
SchemaAddition(
factory=lambda: self.action5,
absolute_position="first",
path="MenuBar/File/FileGroup",
),
]
builder = TaskActionManagerBuilder(
task=Task(menu_bar=schema, extra_actions=extras)
)
actual = builder.create_menu_bar_manager()
desired = MenuBarManager(
MenuManager(
Group(
self.action4,
self.action5,
self.action1,
self.action2,
self.action3,
id="FileGroup",
),
id="File",
),
id="MenuBar",
)
self.assertActionElementsEqual(actual, desired)
def test_absolute_and_before_after(self):
""" Does specifying absolute_position along with before, after work?
"""
schema = MenuBarSchema(
MenuSchema(
GroupSchema(self.action1, self.action2, id="FileGroup"),
id="File",
)
)
extras = [
SchemaAddition(
factory=lambda: self.action3,
id="action3",
after="action2",
path="MenuBar/File/FileGroup",
),
SchemaAddition(
factory=lambda: self.action4,
after="action3",
path="MenuBar/File/FileGroup",
),
SchemaAddition(
factory=lambda: self.action5,
id="action5",
absolute_position="last",
path="MenuBar/File/FileGroup",
),
SchemaAddition(
factory=lambda: self.action6,
absolute_position="last",
before="action5",
path="MenuBar/File/FileGroup",
),
]
builder = TaskActionManagerBuilder(
task=Task(menu_bar=schema, extra_actions=extras)
)
actual = builder.create_menu_bar_manager()
desired = MenuBarManager(
MenuManager(
Group(
self.action1,
self.action2,
self.action3,
self.action4,
self.action6,
self.action5,
id="FileGroup",
),
id="File",
),
id="MenuBar",
)
self.assertActionElementsEqual(actual, desired)
|
