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
|
import assert from 'assert';
import EpubCFI from '../src/epubcfi.js';
// var fs = require('fs');
if (typeof DOMParser === "undefined") {
global.DOMParser = require('xmldom').DOMParser;
}
describe('EpubCFI', function() {
it('parse a cfi on init', function() {
var cfi = new EpubCFI("epubcfi(/6/2[cover]!/6)");
assert.equal( cfi.spinePos, 0, "spinePos is parsed as the first item" );
});
it('parse a cfi and ignore the base if present', function() {
var cfi = new EpubCFI("epubcfi(/6/2[cover]!/6)", "/6/6[end]");
assert.equal( cfi.spinePos, 0, "base is ignored and spinePos is parsed as the first item" );
});
describe('#parse()', function() {
var cfi = new EpubCFI();
it('parse a cfi on init', function() {
var parsed = cfi.parse("epubcfi(/6/2[cover]!/6)");
assert.equal( parsed.spinePos, 0, "spinePos is parsed as the first item" );
});
it('parse a cfi and ignore the base if present', function() {
var parsed = cfi.parse("epubcfi(/6/2[cover]!/6)", "/6/6[end]");
assert.equal( parsed.spinePos, 0, "base is ignored and spinePos is parsed as the first item" );
});
it('parse a cfi with a charecter offset', function() {
var parsed = cfi.parse("epubcfi(/6/4[chap01ref]!/4[body01]/10[para05]/2/1:3)");
assert.equal( parsed.path.terminal.offset, 3, "Path has a terminal offset of 3" );
});
it('parse a cfi with a range', function() {
var parsed = cfi.parse("epubcfi(/6/4[chap01ref]!/4[body01]/10[para05],/2/1:1,/3:4)");
assert.equal( parsed.range, true, "Range is true" );
assert.equal( parsed.start.steps.length, 2, "Start steps are present" );
assert.equal( parsed.end.steps.length, 1, "End steps are present" );
assert.equal( parsed.start.terminal.offset, 1, "Start has a terminal offset of 1" );
assert.equal( parsed.end.terminal.offset, 4, "End has a terminal offset of 4" );
});
});
describe('#toString()', function() {
it('parse a cfi and write it back', function() {
assert.equal(new EpubCFI("epubcfi(/6/2[cover]!/6)").toString(), "epubcfi(/6/2[cover]!/6)", "output cfi string is same as input" );
assert.equal(new EpubCFI("epubcfi(/6/4[chap01ref]!/4[body01]/10[para05]/2/1:3)").toString(), "epubcfi(/6/4[chap01ref]!/4[body01]/10[para05]/2/1:3)", "output cfi string is same as input" );
assert.equal(new EpubCFI("epubcfi(/6/4[chap01ref]!/4[body01]/10[para05],/2/1:1,/3:4)").toString(), "epubcfi(/6/4[chap01ref]!/4[body01]/10[para05],/2/1:1,/3:4)", "output cfi string is same as input" );
});
});
describe('#checkType()', function() {
it('determine the type of a cfi string', function() {
var cfi = new EpubCFI();
assert.equal( cfi.checkType('epubcfi(/6/2[cover]!/6)'), 'string' );
assert.equal( cfi.checkType('/6/2[cover]!/6'), false );
});
it('determine the type of a cfi', function() {
var ogcfi = new EpubCFI("epubcfi(/6/4[chap01ref]!/4[body01]/10[para05]/2/1:3)");
var cfi = new EpubCFI();
assert.equal( cfi.checkType(ogcfi), 'EpubCFI' );
});
it('determine the type of a node', function() {
var cfi = new EpubCFI();
var el = document.createElement('div');
assert.equal( cfi.checkType(el), 'node' );
});
it('determine the type of a range', function() {
var cfi = new EpubCFI();
var range = document.createRange();
assert.equal( cfi.checkType(range), 'range' );
});
});
describe('#compare()', function() {
it('compare CFIs', function() {
var epubcfi = new EpubCFI();
// Spines
assert.equal(epubcfi.compare("epubcfi(/6/4[cover]!/4)", "epubcfi(/6/2[cover]!/4)"), 1, "First spine is greater");
assert.equal(epubcfi.compare("epubcfi(/6/4[cover]!/4)", "epubcfi(/6/6[cover]!/4)"), -1, "Second spine is greater");
// First is deeper
assert.equal(epubcfi.compare("epubcfi(/6/2[cover]!/8/2)", "epubcfi(/6/2[cover]!/6)"), 1, "First Element is after Second");
assert.equal(epubcfi.compare("epubcfi(/6/2[cover]!/4/2)", "epubcfi(/6/2[cover]!/6)"), -1, "First Element is before Second");
// Second is deeper
assert.equal(epubcfi.compare("epubcfi(/6/2[cover]!/8/2)", "epubcfi(/6/2[cover]!/6/4/2/2)"), 1, "First Element is after Second");
assert.equal(epubcfi.compare("epubcfi(/6/2[cover]!/4/4)", "epubcfi(/6/2[cover]!/6/4/2/2)"), -1, "First Element is before Second");
assert.equal(epubcfi.compare("epubcfi(/6/2[cover]!/4/6)", "epubcfi(/6/2[cover]!/4/6/8/1:0)"), -1, "First is less specific, so is before Second");
// Same Depth
assert.equal(epubcfi.compare("epubcfi(/6/2[cover]!/6/8)", "epubcfi(/6/2[cover]!/6/2)"), 1, "First Element is after Second");
assert.equal(epubcfi.compare("epubcfi(/6/2[cover]!/4/20)", "epubcfi(/6/2[cover]!/6/10)"), -1, "First Element is before Second");
// Text nodes
assert.equal(epubcfi.compare("epubcfi(/6/2[cover]!/4/5)", "epubcfi(/6/2[cover]!/4/3)"), 1, "First TextNode is after Second");
assert.equal(epubcfi.compare("epubcfi(/6/2[cover]!/4/7)", "epubcfi(/6/2[cover]!/4/13)"), -1, "First TextNode is before Second");
// Char offset
assert.equal(epubcfi.compare("epubcfi(/6/2[cover]!/4/5:1)", "epubcfi(/6/2[cover]!/4/5:0)"), 1, "First Char Offset after Second");
assert.equal(epubcfi.compare("epubcfi(/6/2[cover]!/4/5:2)", "epubcfi(/6/2[cover]!/4/5:30)"), -1, "Second Char Offset before Second");
// Normal example
assert.equal(epubcfi.compare("epubcfi(/6/2[cover]!/4/8/5:1)", "epubcfi(/6/2[cover]!/4/6/15:2)"), 1, "First Element after Second");
assert.equal(epubcfi.compare("epubcfi(/6/2[cover]!/4/8/1:0)", "epubcfi(/6/2[cover]!/4/8/1:0)"), 0, "All Equal");
// Different Lengths
assert.equal(epubcfi.compare(
'epubcfi(/6/16[id42]!/4[5N3C0-8c483216e03a4ff49927fc1a97dc7b2c]/10/1:317)',
'epubcfi(/6/16[id42]!/4[5N3C0-8c483216e03a4ff49927fc1a97dc7b2c]/10/2[page18]/1:0)'
), -1, "First CFI is before Second");
assert.equal(epubcfi.compare(
'epubcfi(/6/16[id42]!/4[5N3C0-8c483216e03a4ff49927fc1a97dc7b2c]/12/1:0)',
'epubcfi(/6/16[id42]!/4[5N3C0-8c483216e03a4ff49927fc1a97dc7b2c]/12/2/1:9)'
), -1, "First CFI is before Second");
assert.equal(epubcfi.compare(
'epubcfi(/6/16!/4/12/1:0)',
'epubcfi(/6/16!/4/12/2/1:9)'
), -1, "First CFI is before Second");
});
});
describe('#fromNode()', function() {
var base = "/6/4[chap01ref]";
// var contents = fs.readFileSync(__dirname + '/fixtures/chapter1-highlights.xhtml', 'utf8');
var contents = require('./fixtures/chapter1-highlights.xhtml').default;
// var serializer = new XMLSerializer();
// var doc = serializer.serializeToString(contents);
var doc = new DOMParser().parseFromString(contents, "application/xhtml+xml");
it('get a cfi from a p node', function() {
var span = doc.getElementById('c001p0004');
var cfi = new EpubCFI(span, base);
assert.equal(span.nodeType, Node.ELEMENT_NODE, "provided a element node");
assert.equal( cfi.toString(), "epubcfi(/6/4[chap01ref]!/4/2/10/2[c001p0004])" );
});
it('get a cfi from a text node', function() {
var t = doc.getElementById('c001p0004').childNodes[0];
var cfi = new EpubCFI(t, base);
assert.equal(t.nodeType, Node.TEXT_NODE, "provided a text node");
assert.equal( cfi.toString(), "epubcfi(/6/4[chap01ref]!/4/2/10/2[c001p0004]/1)" );
});
it('get a cfi from a text node inside a highlight', function() {
var t = doc.getElementById('highlight-1').childNodes[0];
var cfi = new EpubCFI(t, base, 'annotator-hl');
assert.equal(t.nodeType, Node.TEXT_NODE, "provided a text node");
assert.equal( cfi.toString(), "epubcfi(/6/4[chap01ref]!/4/2/32/2[c001p0017]/1)" );
});
it('get a cfi from a highlight node', function() {
var t = doc.getElementById('highlight-1');
var cfi = new EpubCFI(t, base, 'annotator-hl');
assert.equal(t.nodeType, Node.ELEMENT_NODE, "provided a highlight node");
assert.equal( cfi.toString(), "epubcfi(/6/4[chap01ref]!/4/2/32/2[c001p0017])" );
});
});
describe('#fromRange()', function() {
var base = "/6/4[chap01ref]";
// var contentsClean = fs.readFileSync(__dirname + '/fixtures/chapter1.xhtml', 'utf8');
var contentsClean = require('./fixtures/chapter1.xhtml').default;
var doc = new DOMParser().parseFromString(contentsClean, "application/xhtml+xml");
// var contentsHighlights = fs.readFileSync(__dirname + '/fixtures/chapter1-highlights.xhtml', 'utf8');
var contentsHighlights = require('./fixtures/chapter1-highlights.xhtml').default;
var docHighlights = new DOMParser().parseFromString(contentsHighlights, "application/xhtml+xml");
// var highlightContents = fs.readFileSync(__dirname + '/fixtures/highlight.xhtml', 'utf8');
var highlightContents = require('./fixtures/highlight.xhtml').default;
var docHighlightsAlice = new DOMParser().parseFromString(highlightContents, "application/xhtml+xml");
it('get a cfi from a collapsed range', function() {
var t1 = doc.getElementById('c001p0004').childNodes[0];
var t2 = doc.getElementById('c001p0007').childNodes[0];
var range = doc.createRange();
var cfi;
range.setStart(t1, 6);
cfi = new EpubCFI(range, base);
assert.equal( cfi.range, false);
assert.equal( cfi.toString(), "epubcfi(/6/4[chap01ref]!/4/2/10/2[c001p0004]/1:6)" );
});
it('get a cfi from a range', function() {
var t1 = doc.getElementById('c001p0004').childNodes[0];
var t2 = doc.getElementById('c001p0007').childNodes[0];
var range = doc.createRange();
var cfi;
range.setStart(t1, 6);
range.setEnd(t2, 27);
cfi = new EpubCFI(range, base);
assert.equal( cfi.range, true);
assert.equal( cfi.toString(), "epubcfi(/6/4[chap01ref]!/4/2,/10/2[c001p0004]/1:6,/16/2[c001p0007]/1:27)" );
});
it('get a cfi from a range with offset 0', function() {
var t1 = doc.getElementById('c001p0004').childNodes[0];
var range = doc.createRange();
var cfi;
range.setStart(t1, 0);
range.setEnd(t1, 1);
cfi = new EpubCFI(range, base);
assert.equal( cfi.range, true);
assert.equal( cfi.toString(), "epubcfi(/6/4[chap01ref]!/4/2/10/2[c001p0004],/1:0,/1:1)" );
});
it('get a cfi from a range inside a highlight', function() {
var t1 = docHighlights.getElementById('highlight-1').childNodes[0];
var range = docHighlights.createRange();
var cfi;
range.setStart(t1, 6);
cfi = new EpubCFI(range, base, 'annotator-hl');
assert.equal( cfi.toString(), "epubcfi(/6/4[chap01ref]!/4/2/32/2[c001p0017]/1:43)" );
});
// TODO: might need to have double ranges in front
it('get a cfi from a range past a highlight', function() {
var t1 = docHighlights.getElementById('c001s0001').childNodes[1];
var range = docHighlights.createRange();
var cfi;
range.setStart(t1, 25);
cfi = new EpubCFI(range, base, 'annotator-hl');
assert.equal( cfi.toString(), "epubcfi(/6/4[chap01ref]!/4/2/4/2[c001s0001]/1:41)" );
});
it('get a cfi from a range inbetween two highlights', function() {
var t1 = docHighlightsAlice.getElementById('p2').childNodes[1];
var range = docHighlightsAlice.createRange();
var cfi;
range.setStart(t1, 4);
cfi = new EpubCFI(range, base, 'annotator-hl');
assert.equal( cfi.toString(), "epubcfi(/6/4[chap01ref]!/4/4[p2]/1:123)" );
});
it('correctly count text nodes, independent of any elements present inbetween', function() {
var t1 = docHighlightsAlice.getElementById('p3').childNodes[2];
var range = docHighlightsAlice.createRange();
var cfi;
range.setStart(t1, 4);
cfi = new EpubCFI(range, base);
assert.equal( cfi.toString(), "epubcfi(/6/4[chap01ref]!/4/6[p3]/3:4)" );
});
});
describe('#toRange()', function() {
var base = "/6/4[chap01ref]";
// var contents = fs.readFileSync(__dirname + '/fixtures/chapter1-highlights.xhtml', 'utf8');
var contents = require('./fixtures/chapter1-highlights.xhtml').default;
var doc = new DOMParser().parseFromString(contents, "application/xhtml+xml");
// var serializer = new XMLSerializer();
// console.log(serializer.serializeToString(doc));
it('get a range from a cfi', function() {
var t1 = doc.getElementById('c001p0004').childNodes[0];
var t2 = doc.getElementById('c001p0007').childNodes[0];
var ogRange = doc.createRange();
var cfi;
var newRange;
ogRange.setStart(t1, 6);
cfi = new EpubCFI(ogRange, base);
// Check it was parse correctly
assert.equal( cfi.toString(), "epubcfi(/6/4[chap01ref]!/4/2/10/2[c001p0004]/1:6)" );
// Check the range
newRange = cfi.toRange(doc);
assert.equal( newRange.startContainer, t1);
assert.equal( newRange.startOffset, 6);
assert.equal( newRange.collapsed, true);
});
it('get a range from a cfi with a range', function() {
var t1 = doc.getElementById('c001p0004').childNodes[0];
var t2 = doc.getElementById('c001p0007').childNodes[0];
var ogRange = doc.createRange();
var cfi;
var newRange;
ogRange.setStart(t1, 6);
ogRange.setEnd(t2, 27);
cfi = new EpubCFI(ogRange, base);
// Check it was parse correctly
assert.equal( cfi.toString(), "epubcfi(/6/4[chap01ref]!/4/2,/10/2[c001p0004]/1:6,/16/2[c001p0007]/1:27)" );
// Check the range
newRange = cfi.toRange(doc);
assert.equal( newRange.startContainer, t1);
assert.equal( newRange.startOffset, 6);
assert.equal( newRange.endContainer, t2);
assert.equal( newRange.endOffset, 27);
assert.equal( newRange.collapsed, false);
});
it('get a cfi from a range inside a highlight', function() {
var t1 = doc.getElementById('highlight-1').childNodes[0];
var ogRange = doc.createRange();
var cfi;
var newRange;
ogRange.setStart(t1, 6);
cfi = new EpubCFI(ogRange, base, 'annotator-hl');
assert.equal( cfi.toString(), "epubcfi(/6/4[chap01ref]!/4/2/32/2[c001p0017]/1:43)" );
// Check the range
newRange = cfi.toRange(doc, 'annotator-hl');
assert.ok(newRange.startContainer);
assert.equal( newRange.startContainer, t1);
assert.equal( newRange.startOffset, 6);
});
it('get a cfi from a range inside a highlight range', function() {
var t1 = doc.getElementById('highlight-2').childNodes[0];
var t2 = doc.getElementById('c001s0001').childNodes[1];
var ogRange = doc.createRange();
var cfi;
var newRange;
ogRange.setStart(t1, 5);
ogRange.setEnd(t2, 25);
cfi = new EpubCFI(ogRange, base, 'annotator-hl');
assert.equal( cfi.toString(), "epubcfi(/6/4[chap01ref]!/4/2/4/2[c001s0001],/1:5,/1:41)" );
// Check the range
newRange = cfi.toRange(doc, 'annotator-hl');
assert.strictEqual( newRange.startContainer.textContent, t1.textContent);
// assert.strictEqual( newRange.startContainer, t1);
// assert.equal( newRange.startOffset, 5);
});
});
});
|
