forked from GetmeUK/ContentTools
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathui.coffee
More file actions
497 lines (326 loc) · 14.9 KB
/
Copy pathui.coffee
File metadata and controls
497 lines (326 loc) · 14.9 KB
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
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
# HACK: Disable getComputedStyle so that transitions/animations are not
# considered for the purpose of testing.
window.getComputedStyle = null
# HACK: Force the appVersion to be linux for testing
navigator.appVersion = 'Linux'
# UI
# ComponentUI
describe 'ContentTools.ComponentUI()', () ->
it 'should return an instance of a ComponentUI', () ->
component = new ContentTools.ComponentUI()
expect(component instanceof ContentTools.ComponentUI).toBe true
describe 'ContentTools.ComponentUI.children()', () ->
it 'should return a list of children attached to the component', () ->
parent = new ContentTools.ComponentUI()
child = new ContentTools.ComponentUI()
parent.attach(child)
expect(parent.children()).toEqual [child]
describe 'ContentTools.ComponentUI.domElement()', () ->
it 'should return a DOM element for the component if it\'s mounted', () ->
# Components can't mount themselves so we have to fake this by
# associating a DOM element with the component manually.
component = new ContentTools.ComponentUI()
domElement = document.createElement('div')
component._domElement = domElement
expect(component.domElement()).toBe domElement
describe 'ContentTools.ComponentUI.isMounted()', () ->
it 'should return true if the component is mounted', () ->
component = new ContentTools.ComponentUI()
# Initially the component isn't mounted
expect(component.isMounted()).toBe false
# Components can't mount themselves so we have to fake this by
# associating a DOM element with the component manually.
domElement = document.createElement('div')
component._domElement = domElement
expect(component.isMounted()).toBe true
describe 'ContentTools.ComponentUI.parent()', () ->
it 'should return a the parent the component is attached to', () ->
parent = new ContentTools.ComponentUI()
child = new ContentTools.ComponentUI()
parent.attach(child)
expect(child.parent()).toBe parent
describe 'ContentTools.ComponentUI.attach()', () ->
it 'should attach a component as a child of another component', () ->
# NOTE: Currently this is a duplicate of the test for `children()`.
parent = new ContentTools.ComponentUI()
child = new ContentTools.ComponentUI()
parent.attach(child)
expect(parent.children()).toEqual [child]
describe 'ContentTools.ComponentUI.addCSSClass()', () ->
it 'should add a CSS class to the component\'s DOM element', () ->
# Components can't mount themselves so we have to fake this by
# associating a DOM element with the component manually.
component = new ContentTools.ComponentUI()
domElement = document.createElement('div')
component._domElement = domElement
component.addCSSClass('foo')
expect(domElement.getAttribute('class')).toBe 'foo'
describe 'ContentTools.ComponentUI.detatch()', () ->
it 'should detatch a child component', () ->
parent = new ContentTools.ComponentUI()
child = new ContentTools.ComponentUI()
parent.attach(child)
parent.detatch(child)
expect(parent.children()).toEqual []
describe 'ContentTools.ComponentUI.mount()', () ->
it 'should do nothing, `mount()` is a placeholder method only', () ->
component = new ContentTools.ComponentUI()
component.mount()
expect(component.isMounted()).toBe false
describe 'ContentTools.ComponentUI.removeCSSClass()', () ->
it 'should remove a CSS class from the component\'s DOM element', () ->
# Components can't mount themselves so we have to fake this by
# associating a DOM element with the component manually.
component = new ContentTools.ComponentUI()
domElement = document.createElement('div')
component._domElement = domElement
component.addCSSClass('foo')
component.addCSSClass('bar')
component.removeCSSClass('foo')
expect(domElement.getAttribute('class')).toBe 'bar'
describe 'ContentTools.ComponentUI.unmount()', () ->
it 'should remove a CSS class from the component\'s DOM element', () ->
# Components can't mount themselves so we have to fake this by
# associating a DOM element with the component manually.
component = new ContentTools.ComponentUI()
domElement = document.createElement('div')
document.body.appendChild(domElement)
component._domElement = domElement
component.unmount()
expect(component.isMounted()).toBe false
describe 'ContentTools.ComponentUI.addEventListener()', () ->
it 'should bind a function to be called whenever the named event is
dispatched against the component', () ->
# Create a function to call when the event is triggered
foo = {
handleFoo: () ->
return
}
spyOn(foo, 'handleFoo')
# Create a component and add an event listner
component = new ContentTools.ComponentUI()
component.addEventListener('foo', foo.handleFoo)
# Dispatch the event
ev = component.createEvent('foo', {'bar': 1})
component.dispatchEvent(ev)
expect(foo.handleFoo).toHaveBeenCalledWith(ev)
describe 'ContentTools.ComponentUI.createEvent()', () ->
it 'should return an new event', () ->
# Create a component to create an event against
component = new ContentTools.ComponentUI()
ev = new ContentTools.Event('foo', {bar: 1})
expect(ev.name()).toBe 'foo'
expect(ev.detail()).toEqual {bar: 1}
describe 'ContentTools.ComponentUI.dispatchEvent()', () ->
it 'should dispatch an event against a component', () ->
# Create a function to call when the event is triggered
foo = {
handleFoo: () ->
return
}
spyOn(foo, 'handleFoo')
# Create a component and add an event listner
component = new ContentTools.ComponentUI()
component.addEventListener('foo', foo.handleFoo)
# Dispatch the event
ev = component.createEvent('foo', {'bar': 1})
component.dispatchEvent(ev)
expect(foo.handleFoo).toHaveBeenCalledWith(ev)
it 'should return false (prevent the default action) for the event if
cancelled', () ->
# Define a test component class that triggers an event when a method is
# called.
class TestComponent extends ContentTools.ComponentUI
foo: () ->
if @triggerEvent('foo')
@bar = 1
# Create a function to call when the event is triggered
foo = {
handleFoo: (ev) ->
ev.preventDefault()
return
}
spyOn(foo, 'handleFoo')
# Create a test component and add an event listner
component = new TestComponent()
component.addEventListener('foo', foo.handleFoo)
# Dispatch the event
ev = component.createEvent('foo', {'bar': 1})
component.dispatchEvent(ev)
expect(foo.handleFoo).toHaveBeenCalledWith(ev)
expect(foo.bar).toBe undefined
it 'should prevent stop calling listener functions once the event has been
halted', () ->
# Create a set of functions to call when the event is triggered
foo = {
handleBar: () ->
return
handleFoo: () ->
ev.stopImmeditatePropagation()
return
}
spyOn(foo, 'handleBar')
spyOn(foo, 'handleFoo')
# Create a component and add an event listner
component = new ContentTools.ComponentUI()
component.addEventListener('foo', foo.handleFoo)
component.addEventListener('bar', foo.handleBar)
# Dispatch the event
ev = component.createEvent('foo', {'bar': 1})
component.dispatchEvent(ev)
expect(foo.handleFoo).toHaveBeenCalledWith(ev)
expect(foo.handleBar).not.toHaveBeenCalled()
describe 'ContentTools.ComponentUI.removeEventListener()', () ->
component = null
listeners = null
beforeEach ->
listeners = {
handleBar: () ->
return
handleFoo: () ->
return
handleZee: () ->
return
}
spyOn(listeners, 'handleBar')
spyOn(listeners, 'handleFoo')
spyOn(listeners, 'handleZee')
# Create an editable region
component = new ContentTools.ComponentUI()
component.addEventListener('foo', listeners.handleFoo)
component.addEventListener('foo', listeners.handleBar)
component.addEventListener('zee', listeners.handleZee)
it 'should remove a single event listener against a component if called with
an event name and the listener function', () ->
# Remove an individual event listener
component.removeEventListener('foo', listeners.handleFoo)
# Dispatch foo event
ev = component.createEvent('foo', {'bar': 1})
component.dispatchEvent(ev)
expect(listeners.handleFoo).not.toHaveBeenCalled()
expect(listeners.handleBar).toHaveBeenCalled()
# Dispatch zee event
ev = component.createEvent('zee')
component.dispatchEvent(ev)
expect(listeners.handleZee).toHaveBeenCalled()
it 'should remove multiple event listener against a component by
name', () ->
# Remove an individual event listener
component.removeEventListener('foo')
# Dispatch foo event
ev = component.createEvent('foo')
component.dispatchEvent(ev)
expect(listeners.handleFoo).not.toHaveBeenCalled()
expect(listeners.handleBar).not.toHaveBeenCalled()
# Dispatch zee event
ev = component.createEvent('zee')
component.dispatchEvent(ev)
expect(listeners.handleZee).toHaveBeenCalled()
it 'should remove all event listener against a component if called without
arguments', () ->
# Remove an individual event listener
component.removeEventListener()
# Dispatch foo event
ev = component.createEvent('foo')
component.dispatchEvent(ev)
expect(listeners.handleFoo).not.toHaveBeenCalled()
expect(listeners.handleBar).not.toHaveBeenCalled()
# Dispatch zee event
ev = component.createEvent('zee')
component.dispatchEvent(ev)
expect(listeners.handleZee).not.toHaveBeenCalled()
describe 'ContentTools.ComponentUI.createDiv()', () ->
it 'should create a DOM element with the specified classes, attributes and
content', () ->
domElement = ContentTools.ComponentUI.createDiv(
['foo'],
{'bar': 'foo'},
'foo bar'
)
expect(domElement.getAttribute('class')).toBe 'foo'
expect(domElement.getAttribute('bar')).toBe 'foo'
expect(domElement.innerHTML).toBe 'foo bar'
# WidgetUI
describe 'ContentTools.WidgetUI()', () ->
it 'should return an instance of a WidgetUI', () ->
widget = new ContentTools.WidgetUI()
expect(widget instanceof ContentTools.WidgetUI).toBe true
describe 'ContentTools.WidgetUI.attach()', () ->
it 'should attach a widget as a child of another widget and mount it', () ->
parent = new ContentTools.WidgetUI()
child = new ContentTools.WidgetUI()
spyOn(child, 'mount')
parent.attach(child)
# Check the widget was added as a child
expect(parent.children()).toEqual [child]
# Check `mount` was called against the widget
expect(child.mount).toHaveBeenCalledWith()
describe 'ContentTools.WidgetUI.detatch()', () ->
it 'should detatch a child widget and unmount it', () ->
parent = new ContentTools.WidgetUI()
child = new ContentTools.WidgetUI()
spyOn(child, 'unmount')
parent.attach(child)
# Widgets can't mount themselves so we have to fake this by associating
# a DOM element with the widget manually.
domElement = document.createElement('div')
document.body.appendChild(domElement)
parent._domElement = domElement
parent.detatch(child)
# Check the widget was removed as a child
expect(parent.children()).toEqual []
# Check `unmount` was called against the widget
expect(child.unmount).toHaveBeenCalled()
describe 'ContentTools.WidgetUI.show()', () ->
it 'should add the `--active` CSS modifier class to a widget', (done) ->
widget = new ContentTools.WidgetUI()
# Widgets can't mount themselves so we have to fake this by associating
# a DOM element with the widget manually.
domElement = document.createElement('div')
document.body.appendChild(domElement)
widget._domElement = domElement
# Show the widget (there's a delay to allow any CSS transitions to
# activate).
widget.show()
checkShown = () ->
classes = widget.domElement().getAttribute('class').split(' ')
expect(classes.indexOf('ct-widget--active') > -1).toBe true
done();
setTimeout(checkShown, 500)
describe 'ContentTools.WidgetUI.hide()', () ->
widget = null
beforeEach ->
# Create a widget
widget = new ContentTools.WidgetUI()
# Widgets can't mount themselves so we have to fake this by associating
# a DOM element with the widget manually.
domElement = document.createElement('div')
domElement.setAttribute('class', 'ct-widget')
document.body.appendChild(domElement)
widget._domElement = domElement
it 'should remove the `--active` CSS modifier class from a
widget', () ->
widget.hide()
classes = (widget.domElement().getAttribute('class') or '').split(' ')
expect(classes.indexOf('ct-widget--active') == -1).toBe true
it 'should unmount the component after X seconds', (done) ->
widget.hide()
checkUnmounted = () ->
expect(widget.isMounted()).toBe false
done();
setTimeout(checkUnmounted, 500)
# AnchoredComponentUI
describe 'ContentTools.AnchoredComponentUI()', () ->
it 'should return an instance of a AnchoredComponentUI', () ->
anchored = new ContentTools.AnchoredComponentUI()
expect(anchored instanceof ContentTools.AnchoredComponentUI).toBe true
describe 'ContentTools.AnchoredComponentUI.mount()', () ->
it 'should mount the component to a DOM element', () ->
domElement = document.createElement('div')
parentDOMElement = document.createElement('div')
anchored = new ContentTools.AnchoredComponentUI()
# Components can't mount themselves so we have to fake this by
# associating a DOM element with the component manually.
anchored._domElement = domElement
anchored.mount(parentDOMElement)
expect(anchored.domElement().parentNode).toEqual parentDOMElement