forked from jupyterlab/jupyterlab
-
Notifications
You must be signed in to change notification settings - Fork 0
/
widgetmanager.spec.ts
343 lines (265 loc) · 9.48 KB
/
widgetmanager.spec.ts
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
// Copyright (c) Jupyter Development Team.
// Distributed under the terms of the Modified BSD License.
import expect = require('expect.js');
import {
uuid
} from '@jupyterlab/coreutils';
import {
ServiceManager
} from '@jupyterlab/services';
import {
IMessageHandler, Message, MessageLoop
} from '@phosphor/messaging';
import {
Widget
} from '@phosphor/widgets';
import {
DocumentWidgetManager
} from '@jupyterlab/docmanager';
import {
DocumentRegistry, TextModelFactory, ABCWidgetFactory, Context
} from '@jupyterlab/docregistry';
import {
acceptDialog, dismissDialog
} from '../../utils';
class DocWidget extends Widget implements DocumentRegistry.IReadyWidget {
get ready(): Promise<void> {
return Promise.resolve(undefined);
}
}
class WidgetFactory extends ABCWidgetFactory<DocumentRegistry.IReadyWidget, DocumentRegistry.IModel> {
protected createNewWidget(context: DocumentRegistry.Context): DocumentRegistry.IReadyWidget {
let widget = new DocWidget();
widget.addClass('WidgetFactory');
return widget;
}
}
class LoggingManager extends DocumentWidgetManager {
methods: string[] = [];
messageHook(handler: IMessageHandler, msg: Message): boolean {
this.methods.push('messageHook');
return super.messageHook(handler, msg);
}
setCaption(widget: Widget): void {
this.methods.push('setCaption');
super.setCaption(widget);
}
onClose(widget: Widget): Promise<boolean> {
this.methods.push('onClose');
return super.onClose(widget);
}
}
describe('@jupyterlab/docmanager', () => {
let manager: LoggingManager;
let services: ServiceManager.IManager;
let textModelFactory = new TextModelFactory();
let context: Context<DocumentRegistry.IModel>;
let widgetFactory = new WidgetFactory({
name: 'test',
fileTypes: ['text']
});
let readOnlyFactory = new WidgetFactory({
name: 'readonly',
fileTypes: ['text'],
readOnly: true
});
before(() => {
services = new ServiceManager();
});
beforeEach(() => {
let registry = new DocumentRegistry({ textModelFactory });
registry.addWidgetFactory(widgetFactory);
manager = new LoggingManager({ registry });
context = new Context({
manager: services,
factory: textModelFactory,
path: uuid()
});
});
afterEach(() => {
manager.dispose();
context.dispose();
});
describe('DocumentWidgetManager', () => {
describe('#constructor()', () => {
it('should create a new document widget manager', () => {
expect(manager).to.be.a(DocumentWidgetManager);
});
});
describe('#isDisposed', () => {
it('should test whether the manager is disposed', () => {
expect(manager.isDisposed).to.be(false);
manager.dispose();
expect(manager.isDisposed).to.be(true);
});
});
describe('#dispose()', () => {
it('should dispose of the resources used by the manager', () => {
expect(manager.isDisposed).to.be(false);
manager.dispose();
expect(manager.isDisposed).to.be(true);
manager.dispose();
expect(manager.isDisposed).to.be(true);
});
});
describe('#createWidget()', () => {
it('should create a widget', () => {
let widget = manager.createWidget(widgetFactory, context);
expect(widget).to.be.a(Widget);
});
it('should emit the widgetCreated signal', () => {
let called = false;
widgetFactory.widgetCreated.connect(() => {
called = true;
});
manager.createWidget(widgetFactory, context);
expect(called).to.be(true);
});
});
describe('#adoptWidget()', () => {
it('should install a message hook', () => {
let widget = new DocWidget();
manager.adoptWidget(context, widget);
MessageLoop.sendMessage(widget, new Message('foo'));
expect(manager.methods).to.contain('messageHook');
});
it('should add the document class', () => {
let widget = new DocWidget();
manager.adoptWidget(context, widget);
expect(widget.hasClass('jp-Document')).to.be(true);
});
it('should be retrievable', () => {
let widget = new DocWidget();
manager.adoptWidget(context, widget);
expect(manager.contextForWidget(widget)).to.be(context);
});
});
describe('#findWidget()', () => {
it('should find a registered widget', () => {
let widget = manager.createWidget(widgetFactory, context);
expect(manager.findWidget(context, 'test')).to.be(widget);
});
it('should return undefined if not found', () => {
expect(manager.findWidget(context, 'test')).to.be(void 0);
});
});
describe('#contextForWidget()', () => {
it('should return the context for a widget', () => {
let widget = manager.createWidget(widgetFactory, context);
expect(manager.contextForWidget(widget)).to.be(context);
});
it('should return undefined if not tracked', () => {
expect(manager.contextForWidget(new Widget())).to.be(undefined);
});
});
describe('#cloneWidget()', () => {
it('should create a new widget with the same context using the same factory', () => {
let widget = manager.createWidget(widgetFactory, context);
let clone = manager.cloneWidget(widget);
expect(clone.hasClass('WidgetFactory')).to.be(true);
expect(clone.hasClass('jp-Document')).to.be(true);
expect(manager.contextForWidget(clone)).to.be(context);
});
it('should return undefined if the source widget is not managed', () => {
expect(manager.cloneWidget(new Widget())).to.be(void 0);
});
});
describe('#closeWidgets()', () => {
it('should close all of the widgets associated with a context', () => {
let called = 0;
let widget = manager.createWidget(widgetFactory, context);
let clone = manager.cloneWidget(widget);
widget.disposed.connect(() => { called++; });
clone.disposed.connect(() => { called++; });
return manager.closeWidgets(context).then(() => {
expect(called).to.be(2);
});
});
});
describe('#messageHook()', () => {
it('should be called for a message to a tracked widget', () => {
let widget = new DocWidget();
manager.adoptWidget(context, widget);
MessageLoop.sendMessage(widget, new Message('foo'));
expect(manager.methods).to.contain('messageHook');
});
it('should return false for close-request messages', () => {
let widget = manager.createWidget(widgetFactory, context);
let msg = new Message('close-request');
expect(manager.messageHook(widget, msg)).to.be(false);
});
it('should return true for other messages', () => {
let widget = manager.createWidget(widgetFactory, context);
let msg = new Message('foo');
expect(manager.messageHook(widget, msg)).to.be(true);
});
});
describe('#setCaption()', () => {
it('should set the title of the widget', (done) => {
context.initialize(true).then(() => {
let widget = manager.createWidget(widgetFactory, context);
widget.title.changed.connect(() => {
expect(manager.methods).to.contain('setCaption');
expect(widget.title.caption).to.contain('Last Checkpoint');
done();
});
});
});
});
describe('#onClose()', () => {
it('should be called when a widget is closed', (done) => {
let widget = manager.createWidget(widgetFactory, context);
widget.disposed.connect(() => {
expect(manager.methods).to.contain('onClose');
done();
});
widget.close();
});
it('should prompt the user before closing', (done) => {
context.model.fromString('foo');
let widget = manager.createWidget(widgetFactory, context);
manager.onClose(widget).then(() => {
expect(widget.isDisposed).to.be(true);
done();
});
acceptDialog();
});
it('should not prompt if the factory is readonly', () => {
context.model.fromString('foo');
let widget = manager.createWidget(readOnlyFactory, context);
return manager.onClose(widget).then(() => {
expect(widget.isDisposed).to.be(true);
});
});
it('should not prompt if the other widget is writable', () => {
context.model.fromString('foo');
let widget0 = manager.createWidget(widgetFactory, context);
let widget1 = manager.createWidget(widgetFactory, context);
return manager.onClose(widget0).then(() => {
expect(widget0.isDisposed).to.be(true);
widget1.dispose();
});
});
it('should prompt if the only other widget has a readonly factory', (done) => {
context.model.fromString('foo');
let widget0 = manager.createWidget(widgetFactory, context);
let widget1 = manager.createWidget(readOnlyFactory, context);
manager.onClose(widget1).then(() => {
expect(widget1.isDisposed).to.be(true);
widget0.dispose();
done();
});
acceptDialog();
});
it('should close the widget', (done) => {
context.model.fromString('foo');
let widget = manager.createWidget(widgetFactory, context);
manager.onClose(widget).then(() => {
expect(widget.isDisposed).to.be(false);
done();
});
dismissDialog();
});
});
});
});