File: menu.py

package info (click to toggle)
nyx 2.1.0-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 7,732 kB
  • sloc: python: 7,055; makefile: 7; sh: 3
file content (248 lines) | stat: -rw-r--r-- 7,149 bytes parent folder | download | duplicates (4)
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
"""
Unit tests for nyx.menu.
"""

import curses
import unittest

import nyx.curses

from nyx.menu import MenuItem, Submenu, RadioMenuItem, RadioGroup, MenuCursor


class Container(object):
  value = False

  def __nonzero__(self):
    return bool(self.value)  # for python 2.x

  def __bool__(self):
    return bool(self.value)  # for python 3.x


def action(*args):
  IS_CALLED.value = args if args else True


def menu_cursor(*key_inputs):
  cursor = MenuCursor(INITIAL_SELECTION)

  for key in key_inputs:
    cursor.handle_key(nyx.curses.KeyInput(key))

  return cursor


def no_op():
  pass


IS_CALLED = Container()

TEST_MENU = Submenu('Root Submenu', [
  Submenu('Submenu 1', [
    MenuItem('Item 1', action, 'selected 1'),
    MenuItem('Item 2', action, 'selected 2'),
    Submenu('Inner Submenu', [
      MenuItem('Item 3', action, 'selected 3'),
    ]),
    Submenu('Empty Submenu', []),
  ]),
  Submenu('Submenu 2', [
    MenuItem('Item 4', action, 'selected 1'),
    MenuItem('Item 5', action, 'selected 2'),
  ])
])

INITIAL_SELECTION = TEST_MENU.children[0].children[0]


class TestMenuItem(unittest.TestCase):
  def setUp(self):
    IS_CALLED.value = False

  def test_parameters(self):
    menu_item = MenuItem('Test Item', no_op)

    self.assertEqual('', menu_item.prefix)
    self.assertEqual('Test Item', menu_item.label)
    self.assertEqual('', menu_item.suffix)

    self.assertEqual(None, menu_item.next)
    self.assertEqual(None, menu_item.prev)
    self.assertEqual(None, menu_item.parent)
    self.assertEqual(menu_item, menu_item.submenu)

  def test_selection(self):
    menu_item = MenuItem('Test Item', action)
    menu_item.select()
    self.assertTrue(IS_CALLED)

  def test_selection_with_value(self):
    menu_item = MenuItem('Test Item', action, 'hi')
    menu_item.select()
    self.assertEqual(('hi',), IS_CALLED.value)

  def test_menu_item_hierarchy(self):
    root_submenu = Submenu('Root Submenu')
    middle_submenu = Submenu('Middle Submenu')

    root_submenu.add(MenuItem('Middle Item 1', no_op))
    root_submenu.add(MenuItem('Middle Item 2', no_op))
    root_submenu.add(middle_submenu)

    bottom_item = MenuItem('Bottom Item', no_op)
    middle_submenu.add(bottom_item)

    self.assertEqual(middle_submenu, bottom_item.parent)
    self.assertEqual(middle_submenu, bottom_item.submenu)
    self.assertEqual(bottom_item, bottom_item.next)
    self.assertEqual(bottom_item, bottom_item.prev)

    self.assertEqual(root_submenu, middle_submenu.parent)
    self.assertEqual(middle_submenu, middle_submenu.submenu)
    self.assertEqual('Middle Item 1', middle_submenu.next.label)
    self.assertEqual('Middle Item 2', middle_submenu.prev.label)


class TestSubmenu(unittest.TestCase):
  def test_parameters(self):
    menu_item = Submenu('Test Item')

    self.assertEqual('', menu_item.prefix)
    self.assertEqual('Test Item', menu_item.label)
    self.assertEqual(' >', menu_item.suffix)

    self.assertEqual(None, menu_item.next)
    self.assertEqual(None, menu_item.prev)
    self.assertEqual(None, menu_item.parent)
    self.assertEqual(menu_item, menu_item.submenu)

    self.assertEqual([], menu_item.children)

    menu_item = Submenu('Test Item', [
      MenuItem('Test Item 1', no_op),
      MenuItem('Test Item 2', no_op),
    ])

    self.assertEqual(2, len(menu_item.children))

  def test_add(self):
    submenu = Submenu('Menu')
    item_1 = MenuItem('Test Item 1', no_op)
    item_2 = MenuItem('Test Item 2', no_op)

    self.assertEqual([], submenu.children)

    submenu.add(item_1)
    self.assertEqual([item_1], submenu.children)

    submenu.add(item_2)
    self.assertEqual([item_1, item_2], submenu.children)

  def test_add_raises_when_already_in_menu(self):
    submenu_1 = Submenu('Menu 1')
    submenu_2 = Submenu('Menu 2')
    item = MenuItem('Test Item', no_op)

    submenu_1.add(item)
    self.assertRaises(ValueError, submenu_2.add, item)


class TestRadioMenuItem(unittest.TestCase):
  def setUp(self):
    IS_CALLED.value = False

  def test_parameters(self):
    group = RadioGroup(no_op, 'selected_item')
    menu_item = RadioMenuItem('Test Item', group, 'selected_item')

    self.assertEqual('[X] ', menu_item.prefix)
    self.assertEqual('Test Item', menu_item.label)
    self.assertEqual('', menu_item.suffix)

    self.assertEqual(None, menu_item.next)
    self.assertEqual(None, menu_item.prev)
    self.assertEqual(None, menu_item.parent)
    self.assertEqual(menu_item, menu_item.submenu)

  def test_selection(self):
    group = RadioGroup(action, 'other_item')
    menu_item = RadioMenuItem('Test Item', group, 'selected_item')

    menu_item.select()
    self.assertTrue(IS_CALLED)

  def test_when_already_selected(self):
    group = RadioGroup(action, 'selected_item')
    menu_item = RadioMenuItem('Test Item', group, 'selected_item')

    menu_item.select()
    self.assertFalse(IS_CALLED)


class TestMenuCursor(unittest.TestCase):
  def setUp(self):
    IS_CALLED.value = False

  def test_selection_of_item(self):
    cursor = menu_cursor(curses.KEY_ENTER)
    self.assertEqual(('selected 1',), IS_CALLED.value)
    self.assertTrue(cursor.is_done)

  def test_selection_of_submenu(self):
    cursor = menu_cursor(curses.KEY_DOWN, curses.KEY_DOWN, curses.KEY_ENTER)
    self.assertEqual('Item 3', cursor.selection.label)
    self.assertFalse(IS_CALLED.value)
    self.assertFalse(cursor.is_done)

  def test_up(self):
    cursor = menu_cursor()

    for expected in ('Item 1', 'Empty Submenu', 'Inner Submenu', 'Item 2', 'Item 1'):
      self.assertEqual(expected, cursor.selection.label)
      cursor.handle_key(nyx.curses.KeyInput(curses.KEY_UP))

  def test_down(self):
    cursor = menu_cursor()

    for expected in ('Item 1', 'Item 2', 'Inner Submenu', 'Empty Submenu', 'Item 1'):
      self.assertEqual(expected, cursor.selection.label)
      cursor.handle_key(nyx.curses.KeyInput(curses.KEY_DOWN))

  def test_left(self):
    cursor = menu_cursor()

    for expected in ('Item 1', 'Item 4', 'Item 1'):
      self.assertEqual(expected, cursor.selection.label)
      cursor.handle_key(nyx.curses.KeyInput(curses.KEY_LEFT))

  def test_left_when_inner_submenu(self):
    cursor = menu_cursor(curses.KEY_DOWN, curses.KEY_DOWN, curses.KEY_RIGHT)

    for expected in ('Item 3', 'Inner Submenu', 'Item 4'):
      self.assertEqual(expected, cursor.selection.label)
      cursor.handle_key(nyx.curses.KeyInput(curses.KEY_LEFT))

  def test_right(self):
    cursor = menu_cursor()

    for expected in ('Item 1', 'Item 4', 'Item 1'):
      self.assertEqual(expected, cursor.selection.label)
      cursor.handle_key(nyx.curses.KeyInput(curses.KEY_RIGHT))

  def test_right_when_inner_submenu(self):
    cursor = menu_cursor(curses.KEY_DOWN, curses.KEY_DOWN)

    for expected in ('Inner Submenu', 'Item 3', 'Item 4', 'Item 1'):
      self.assertEqual(expected, cursor.selection.label)
      cursor.handle_key(nyx.curses.KeyInput(curses.KEY_RIGHT))

  def test_esc(self):
    cursor = menu_cursor(27)
    self.assertTrue(cursor.is_done)

    # pressing 'm' closes the menu too

    cursor = menu_cursor(ord('m'))
    self.assertTrue(cursor.is_done)