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
|
function copyDomNodeChildren(domNode) {
var copy = [];
for (var i = 0; i < domNode.childNodes.length; i++)
copy.push(domNode.childNodes[i]);
return copy;
}
describe('Array to DOM node children mapping', function() {
beforeEach(jasmine.prepareTestNode);
it('Should populate the DOM node by mapping array elements', function () {
var array = ["A", "B"];
var mapping = function (arrayItem) {
var output1 = document.createElement("DIV");
var output2 = document.createElement("DIV");
output1.innerHTML = arrayItem + "1";
output2.innerHTML = arrayItem + "2";
return [output1, output2];
};
ko.utils.setDomNodeChildrenFromArrayMapping(testNode, array, mapping);
expect(testNode.childNodes.length).toEqual(4);
expect(testNode.childNodes[0].innerHTML).toEqual("A1");
expect(testNode.childNodes[1].innerHTML).toEqual("A2");
expect(testNode.childNodes[2].innerHTML).toEqual("B1");
expect(testNode.childNodes[3].innerHTML).toEqual("B2");
});
it('Should only call the mapping function for new array elements', function () {
var mappingInvocations = [];
var mapping = function (arrayItem) {
mappingInvocations.push(arrayItem);
return null;
};
ko.utils.setDomNodeChildrenFromArrayMapping(testNode, ["A", "B"], mapping);
expect(mappingInvocations).toEqual(["A", "B"]);
mappingInvocations = [];
ko.utils.setDomNodeChildrenFromArrayMapping(testNode, ["A", "A2", "B"], mapping);
expect(mappingInvocations).toEqual(["A2"]);
});
it('Should retain existing node instances if the array is unchanged', function () {
var array = ["A", "B"];
var mapping = function (arrayItem) {
var output1 = document.createElement("DIV");
var output2 = document.createElement("DIV");
output1.innerHTML = arrayItem + "1";
output2.innerHTML = arrayItem + "2";
return [output1, output2];
};
ko.utils.setDomNodeChildrenFromArrayMapping(testNode, array, mapping);
var existingInstances = copyDomNodeChildren(testNode);
ko.utils.setDomNodeChildrenFromArrayMapping(testNode, array, mapping);
var newInstances = copyDomNodeChildren(testNode);
expect(newInstances).toEqual(existingInstances);
});
it('Should insert added nodes at the corresponding place in the DOM', function () {
var mappingInvocations = [];
var mapping = function (arrayItem) {
mappingInvocations.push(arrayItem);
var output = document.createElement("DIV");
output.innerHTML = arrayItem;
return [output];
};
ko.utils.setDomNodeChildrenFromArrayMapping(testNode, ["A", "B"], mapping);
expect(ko.utils.arrayMap(testNode.childNodes, function (x) { return x.innerHTML })).toEqual(["A", "B"]);
expect(mappingInvocations).toEqual(["A", "B"]);
mappingInvocations = [];
ko.utils.setDomNodeChildrenFromArrayMapping(testNode, ["first", "A", "middle1", "middle2", "B", "last"], mapping);
expect(ko.utils.arrayMap(testNode.childNodes, function (x) { return x.innerHTML })).toEqual(["first", "A", "middle1", "middle2", "B", "last"]);
expect(mappingInvocations).toEqual(["first", "middle1", "middle2", "last"]);
});
it('Should remove deleted nodes from the DOM', function () {
var mappingInvocations = [];
var mapping = function (arrayItem) {
mappingInvocations.push(arrayItem);
var output = document.createElement("DIV");
output.innerHTML = arrayItem;
return [output];
};
ko.utils.setDomNodeChildrenFromArrayMapping(testNode, ["first", "A", "middle1", "middle2", "B", "last"], mapping);
expect(ko.utils.arrayMap(testNode.childNodes, function (x) { return x.innerHTML })).toEqual(["first", "A", "middle1", "middle2", "B", "last"]);
expect(mappingInvocations).toEqual(["first", "A", "middle1", "middle2", "B", "last"]);
mappingInvocations = [];
ko.utils.setDomNodeChildrenFromArrayMapping(testNode, ["A", "B"], mapping);
expect(ko.utils.arrayMap(testNode.childNodes, function (x) { return x.innerHTML })).toEqual(["A", "B"]);
expect(mappingInvocations).toEqual([]);
});
it('Should tolerate DOM nodes being removed manually, before the corresponding array entry is removed', function() {
// Represents https://github.com/SteveSanderson/knockout/issues/413
// Ideally, people wouldn't be mutating the generated DOM manually. But this didn't error in v2.0, so we should try to avoid introducing a break.
var mappingInvocations = [];
var mapping = function (arrayItem) {
mappingInvocations.push(arrayItem);
var output = document.createElement("DIV");
output.innerHTML = arrayItem;
return [output];
};
ko.utils.setDomNodeChildrenFromArrayMapping(testNode, ["A", "B", "C"], mapping);
expect(testNode).toContainHtml("<div>a</div><div>b</div><div>c</div>");
// Now kill the middle DIV manually, even though people shouldn't really do this
var elemToRemove = testNode.childNodes[1];
expect(elemToRemove.innerHTML).toEqual("B"); // Be sure it's the right one
elemToRemove.parentNode.removeChild(elemToRemove);
// Now remove the corresponding array entry. This shouldn't cause an exception.
ko.utils.setDomNodeChildrenFromArrayMapping(testNode, ["A", "C"], mapping);
expect(testNode).toContainHtml("<div>a</div><div>c</div>");
});
it('Should handle sequences of mixed insertions and deletions', function () {
var mappingInvocations = [], countCallbackInvocations = 0;
var mapping = function (arrayItem) {
mappingInvocations.push(arrayItem);
var output = document.createElement("DIV");
output.innerHTML = ko.utils.unwrapObservable(arrayItem) || "null";
return [output];
};
var callback = function(arrayItem, nodes) {
++countCallbackInvocations;
expect(mappingInvocations[mappingInvocations.length-1]).toEqual(arrayItem);
}
ko.utils.setDomNodeChildrenFromArrayMapping(testNode, ["A"], mapping, null, callback);
expect(ko.utils.arrayMap(testNode.childNodes, function (x) { return x.innerHTML })).toEqual(["A"]);
expect(mappingInvocations).toEqual(["A"]);
expect(countCallbackInvocations).toEqual(mappingInvocations.length);
mappingInvocations = [], countCallbackInvocations = 0;
ko.utils.setDomNodeChildrenFromArrayMapping(testNode, ["B"], mapping, null, callback); // Delete and replace single item
expect(ko.utils.arrayMap(testNode.childNodes, function (x) { return x.innerHTML })).toEqual(["B"]);
expect(mappingInvocations).toEqual(["B"]);
expect(countCallbackInvocations).toEqual(mappingInvocations.length);
mappingInvocations = [], countCallbackInvocations = 0;
ko.utils.setDomNodeChildrenFromArrayMapping(testNode, ["A", "B", "C"], mapping, null, callback); // Add at beginning and end
expect(ko.utils.arrayMap(testNode.childNodes, function (x) { return x.innerHTML })).toEqual(["A", "B", "C"]);
expect(mappingInvocations).toEqual(["A", "C"]);
expect(countCallbackInvocations).toEqual(mappingInvocations.length);
mappingInvocations = [], countCallbackInvocations = 0;
ko.utils.setDomNodeChildrenFromArrayMapping(testNode, ["C", "B", "A"], mapping, null, callback); // Move items
expect(ko.utils.arrayMap(testNode.childNodes, function (x) { return x.innerHTML })).toEqual(["C", "B", "A"]);
expect(mappingInvocations).toEqual([]);
expect(countCallbackInvocations).toEqual(mappingInvocations.length);
// Check that observable items can be added and unwrapped in the mapping function and will update the DOM.
// Also check that observables accessed in the callback function do not update the DOM.
mappingInvocations = [], countCallbackInvocations = 0;
var observable = ko.observable(1), callbackObservable = ko.observable(1);
var callback2 = function(arrayItem, nodes) {
callbackObservable();
callback(arrayItem, nodes);
};
ko.utils.setDomNodeChildrenFromArrayMapping(testNode, [observable, null, "B"], mapping, null, callback2); // Add to beginning; delete from end
expect(ko.utils.arrayMap(testNode.childNodes, function (x) { return x.innerHTML })).toEqual(["1", "null", "B"]);
expect(mappingInvocations).toEqual([observable, null]);
expect(countCallbackInvocations).toEqual(mappingInvocations.length);
// Change the value of the mapped observable and verify that the DOM is updated
mappingInvocations = [], countCallbackInvocations = 0;
observable(2);
expect(ko.utils.arrayMap(testNode.childNodes, function (x) { return x.innerHTML })).toEqual(["2", "null", "B"]);
expect(mappingInvocations).toEqual([observable]);
expect(countCallbackInvocations).toEqual(mappingInvocations.length);
// Change the value of the callback observable and verify that the DOM wasn't updated
mappingInvocations = [], countCallbackInvocations = 0;
callbackObservable(2);
expect(mappingInvocations.length).toEqual(0);
expect(countCallbackInvocations).toEqual(0);
});
it('Should insert nodes correctly when callback modifies node list', function() {
var array = ["A", "B"];
var mapping = function (arrayItem) {
var output1 = document.createElement("DIV");
output1.innerHTML = arrayItem + "1";
return [output1];
};
var callback = function(arrayItem, nodes) {
var output2 = document.createElement("DIV");
output2.innerHTML = arrayItem + "2";
var node = nodes[0], parent = node.parentNode;
parent.insertBefore(output2, node);
parent.removeChild(node);
nodes[0] = output2;
}
ko.utils.setDomNodeChildrenFromArrayMapping(testNode, array, mapping, null, callback);
expect(testNode.childNodes.length).toEqual(2);
expect(testNode.childNodes[0].innerHTML).toEqual("A2");
expect(testNode.childNodes[1].innerHTML).toEqual("B2");
});
it('Should insert nodes correctly when callback modifies node list when using virtual elements', function() {
// See https://github.com/knockout/knockout/issues/2433
var array = ["A", "B"];
var mapping = function (arrayItem) {
var output1 = document.createElement("DIV");
output1.innerHTML = arrayItem + "1";
return [output1];
};
var callback = function(arrayItem, nodes) {
var output2 = document.createElement("DIV");
output2.innerHTML = arrayItem + "2";
var node = nodes[0], parent = node.parentNode;
parent.insertBefore(output2, node);
parent.removeChild(node);
nodes[0] = output2;
}
testNode.innerHTML = "xxx<!--ko--><!--/ko-->";
expect(testNode.childNodes.length).toEqual(3);
ko.utils.setDomNodeChildrenFromArrayMapping(testNode.childNodes[1], array, mapping, null, callback);
expect(testNode.childNodes.length).toEqual(5);
expect(testNode.childNodes[2].innerHTML).toEqual("A2");
expect(testNode.childNodes[3].innerHTML).toEqual("B2");
});
});
|
