File: tags.py

package info (click to toggle)
zim 0.76.3-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 10,952 kB
  • sloc: python: 68,612; xml: 1,270; javascript: 512; sh: 101; makefile: 47
file content (415 lines) | stat: -rw-r--r-- 11,054 bytes parent folder | download | duplicates (3)
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

# Copyright 2011-2015 Jaap Karssenberg <jaap.karssenberg@gmail.com>

import tests

from gi.repository import Gtk
from gi.repository import Pango

from zim.notebook import Path
from zim.notebook.index import Index
from zim.notebook.index.tags import MyTreeIter, IS_PAGE, IS_TAG
from zim.config import ConfigDict
from zim.plugins.tags import *

from tests.pageindex import init_model_validator_wrapper


class TestTaggedPageTreeStore(tests.TestCase):

	def setUp(self):
		self.storeclass = TaggedPageTreeStore
		self.viewclass = TagsPageTreeView
		self.toplevel = IS_PAGE
		self.tags = ('foo', 'bar')
		self.notebook = self.setUpNotebook(mock=tests.MOCK_ALWAYS_MOCK, content={
			'foobar': '@foo @bar',
			'foobar:child1:subfoobar': '@foo @bar',
			'bar:foobar': '@foo @bar',

			'bar': '@bar',
			'none': 'no tag here',
			'none:child': 'or here',
			'other': '@third tag, not used in test',
		})
		# select: (@foo, @bar), sort by (basename, len(name), name)
		#
		# TaggedPageTreeStore
		# - foobar
		#   - child1
		#     - subfoobar
		# - bar:foobar
		# - foobar:child1:subfoobar

	def testTreeStore(self):
		'''Test TaggedPageTreeStore index interface'''
		notebook = self.notebook

		# Check configuration
		treestore = self.storeclass(notebook.index, self.tags)
		init_model_validator_wrapper(self, treestore)
		self.assertEqual(treestore.get_flags(), 0)
		self.assertEqual(treestore.get_n_columns(), 7)
		for i in range(treestore.get_n_columns()):
			self.assertTrue(not treestore.get_column_type(i) is None)

		# Check top level
		n = treestore.on_iter_n_children(None) # iternal
		self.assertTrue(n > 0)
		n = treestore.iter_n_children(None) # external
		self.assertTrue(n > 0)

		# Quick check for basic methods
		myiter = treestore.on_get_iter((0,))
		self.assertIsInstance(myiter, MyTreeIter)
		self.assertEqual(myiter.hint, self.toplevel)
		self.assertEqual(myiter.treepath, Gtk.TreePath((0,)))
		self.assertEqual(treestore.on_get_path(myiter), Gtk.TreePath((0,)))

		treeiter = treestore.get_iter((0,))
		path = treestore.get_indexpath(treeiter)
		self.assertEqual(treestore.find(path), Gtk.TreePath((0,)))

		basename = treestore.on_get_value(myiter, 0)
		self.assertTrue(len(basename) > 0)

		iter2 = treestore.on_iter_children(None)
		self.assertEqual(iter2.treepath, Gtk.TreePath((0,)))

		self.assertTrue(treestore.on_get_iter((20, 20, 20, 20, 20)) is None)
		self.assertRaises(IndexNotFoundError, treestore.find, Path('nonexisting'))
		self.assertRaises(ValueError, treestore.find, Path(':'))

		# Now walk through the whole tree testing the API
		nitems = 0
		path = (0,)
		prevpath = None
		while path:
			#~ print('PATH', path)
			assert path != prevpath, 'Prevent infinite loop'
			nitems += 1
			prevpath = path

			iter = treestore.get_iter(path)
			self.assertEqual(treestore.get_path(iter), Gtk.TreePath(path))

			# Determine how to continue
			if treestore.iter_has_child(iter):
				path = path + (0,)
			else:
				path = path[:-1] + (path[-1] + 1,) # increase last member
				while path:
					try:
						treestore.get_iter(path)
					except ValueError:
						path = path[:-1]
						if len(path):
							path = path[:-1] + (path[-1] + 1,) # increase last member
					else:
						break


	def testTreeView(self):
		self.notebook.index.flush() # we want to index ourselves
		navigation = tests.MockObject(methods=('open_page',))
		treestore = self.storeclass(self.notebook.index, self.tags)
		init_model_validator_wrapper(self, treestore)
		treeview = self.viewclass(self.notebook, navigation, treestore)

		# Process signals on by one
		self.assertEqual(self.notebook.pages.n_all_pages(), 0) # assert we start blank
		for p in self.notebook.index.update_iter():
			tests.gtk_process_events()
		tests.gtk_process_events()

		# Try some TreeView methods
		path = Path('foobar')
		treepath = treeview.get_model().find(path)
		self.assertEqual(treeview.set_current_page(path), treepath)
		col = treeview.get_column(0)
		treeview.row_activated(treepath, col)

		#~ treeview.emit('popup-menu')
		treeview.emit('insert-link', path)
		treeview.emit('copy')

		# Check signals for page change
		page = self.notebook.get_page(Path('Foo'))

		page.parse('wiki', 'Fooo @tag1 @tag2\n')
		self.notebook.store_page(page)
		tests.gtk_process_events()

		page.parse('wiki', 'Fooo @foo @bar @tag2\n')
		self.notebook.store_page(page)
		tests.gtk_process_events()

		# Check if all the signals go OK in delete
		for page in reversed(list(self.notebook.pages.walk())): # delete bottom up
			self.notebook.delete_page(page)
			tests.gtk_process_events()

	def testSignals(self):
		PAGES = ('a', 'a:a', 'a:b', 'b', 'c')
		TAGS = ('@foo @bar', '', '@foo @bar', '@foo @bar', '@bar')

		#  - a
		#    - a:a
		#    - a:b
		#  - b
		#  - a:b

		notebook = self.setUpNotebook()
		navigation = tests.MockObject(methods=('open_page',))
		model = self.storeclass(notebook.index, ('foo', 'bar'))
		init_model_validator_wrapper(self, model)
		treeview = PageTreeView(notebook, navigation, model=model)

		signals = []
		def signal_logger(o, *a):
			path = a[0].to_string()
			signal = a[-1]
			signals.append((signal, path))
			#print(">>>", signal, path)

		for signal in ('row-inserted', 'row-changed', 'row-deleted', 'row-has-child-toggled'):
			model.connect(signal, signal_logger, signal)

		for path, tags in zip(PAGES, TAGS):
			page = notebook.get_page(Path(path))
			page.parse('wiki', 'Test 123 %s\n' % tags)
			notebook.store_page(page)

		expect_add = [
			('row-inserted', '0'),
			('row-changed', '0'),

			('row-inserted', '0:0'),
			('row-has-child-toggled', '0'),
			('row-changed', '0'),
			('row-changed', '0:0'),

			('row-inserted', '0:1'),
			('row-changed', '0'),

			('row-inserted', '1'),
			('row-changed', '0:1'),
			('row-changed', '1'),

			('row-inserted', '1'),
			('row-changed', '1'),
		]
		self.assertEqual(signals, expect_add)
		signals[:] = []

		for path in reversed(PAGES):
			notebook.delete_page(Path(path))

		expect_del = [
			('row-deleted', '1'),

			('row-deleted', '1'),

			('row-deleted', '0:1'),
			('row-changed', '0'),

			('row-deleted', '0:0'),
			('row-has-child-toggled', '0'),
			('row-changed', '0'),

			('row-deleted', '0'),
		]
		self.assertEqual(signals, expect_del)


@tests.slowTest
class TestTagsPageTreeStore(TestTaggedPageTreeStore):

	def setUp(self):
		self.storeclass = TagsPageTreeStore
		self.viewclass = TagsPageTreeView
		self.toplevel = IS_TAG
		self.tags = ('foo', 'bar')
		self.notebook = self.setUpNotebook(mock=tests.MOCK_ALWAYS_MOCK, content={
			'foo': '@foo',
			'bar': '@bar',
			'foobar': '@foo @bar',
			'foo:child1:subfoo': '@foo',

			'none': 'no tag here',
			'none:child': 'or here',
			'other': '@third tag, not used in test',
		})
		# select: (@foo, @bar)
		#
		# TagsPageTreeStore
		# @bar
		#   - bar
		#   - foobar
		# @foo
		#   - foo
		#     - child1
		#       - subfoo
		#   - foobar
		#   - foo:child1:subfoo


	def testSignals(self):
		PAGES = ('a', 'a:a', 'a:b', 'b', 'c')
		TAGS = ('@foo', '', '@foo @bar', '@foo', '@bar')
		#
		# @bar
		#  - a:b
		#  - c
		# @foo
		#  - a
		#    - a:a
		#    - a:b
		#  - b
		#  - a:b

		notebook = self.setUpNotebook()
		navigation = tests.MockObject(methods=('open_page',))
		model = self.storeclass(notebook.index, ('foo', 'bar'))
		init_model_validator_wrapper(self, model)
		treeview = PageTreeView(notebook, navigation, model=model)

		signals = []
		def signal_logger(o, *a):
			path = a[0].to_string()
			signal = a[-1]
			signals.append((signal, path))
			#print(">>>", signal, path)

		for signal in ('row-inserted', 'row-changed', 'row-deleted', 'row-has-child-toggled'):
			model.connect(signal, signal_logger, signal)

		for path, tags in zip(PAGES, TAGS):
			page = notebook.get_page(Path(path))
			page.parse('wiki', 'Test 123 %s\n' % tags)
			notebook.store_page(page)

		expect_add = [
			('row-inserted', '0'), # @foo

			('row-inserted', '0:0'), # @foo a
			('row-has-child-toggled', '0'),
			('row-changed', '0'),
			('row-changed', '0:0'),

			('row-inserted', '0:0:0'), # @foo a:a
			('row-has-child-toggled', '0:0'),
			('row-changed', '0:0'),
			('row-changed', '0:0:0'),

			('row-inserted', '0:0:1'), # @foo a:b
			('row-changed', '0:0'),
			('row-inserted', '0:1'), # @foo a:b
			('row-changed', '0'),
			('row-inserted', '0'), # @bar
			('row-inserted', '0:0'), # @bar a:b
			('row-has-child-toggled', '0'),
			('row-changed', '0'),
			('row-changed', '0:0'),
			('row-changed', '1:0:1'),
			('row-changed', '1:1'),

			('row-inserted', '1:1'), # @foo b
			('row-changed', '1'),
			('row-changed', '1:1'),

			('row-inserted', '0:1'), # @bar c
			('row-changed', '0'),
			('row-changed', '0:1'),
		]
		self.assertEqual(signals, expect_add)
		signals[:] = []

		for path in reversed(PAGES):
			notebook.delete_page(Path(path))

		expect_del = [
			('row-deleted', '0:1'), # @bar c
			('row-changed', '0'),

			('row-deleted', '1:1'), # @foo b
			('row-changed', '1'),

			('row-deleted', '0:0'), # @bar a:b --> @bar
			('row-changed', '0'),
			('row-deleted', '0'),

			('row-deleted', '0:1'), # @foo a:b
			('row-changed', '0'),

			('row-deleted', '0:0:1'), # @foo a:b
			('row-changed', '0:0'),

			('row-deleted', '0:0:0'), # @foo a:a
			('row-has-child-toggled', '0:0'),
			('row-changed', '0:0'),

			('row-deleted', '0:0'), # @foo a --> @foo
			('row-changed', '0'),
			('row-deleted', '0'),

		]
		self.assertEqual(signals, expect_del)


@tests.slowTest
class TestTagPluginWidget(tests.TestCase):

	def runTest(self):
		notebook = self.setUpNotebook(content=tests.FULL_NOTEBOOK)
		navigation = tests.MockObject(methods=('open_page',))
		uistate = ConfigDict()
		widget = TagsPluginWidget(notebook, navigation, uistate)

		# Excersize all model switches and check we still have a sane state
		widget.toggle_treeview()
		widget.toggle_treeview()

		path = Path('Test:tags')
		notebook.pages.lookup_by_pagename(path)
		treepath = widget.treeview.get_model().find(path)

		widget.disconnect_model()
		widget.reconnect_model()

		path = Path('Test:tags')
		treepath = widget.treeview.get_model().find(path)

		# Check signals
		widget.treeview.emit('populate-popup', Gtk.Menu())
		widget.treeview.emit('insert-link', path)

		# Toggles in popup
		widget.toggle_show_full_page_name()
		widget.toggle_show_full_page_name()

		# Check tag filtering
		cloud = widget.tagcloud
		self.assertFalse(cloud.get_tag_filter())
		tag = None
		for button in cloud.get_children():
			if button.indextag.name == 'tags':
				tag = button.indextag
				button.clicked()
				break
		else:
			raise AssertionError('No button for @tags ?')

		selected = cloud.get_tag_filter()
		self.assertEqual(selected, [tag])
		model = widget.treeview.get_model()
		self.assertIsInstance(model, TaggedPageTreeStore)
		self.assertEqual(model.tags, (tag.name,))

		# check menu and sorting of tag cloud
		cloud.emit('populate-popup', Gtk.Menu())
		mockaction = tests.MockObject()
		mockaction.get_active = lambda: True
		cloud._switch_sorting(mockaction)
		mockaction.get_active = lambda: False
		cloud._switch_sorting(mockaction)