/
test-member_builder-method.js
376 lines (317 loc) · 10.2 KB
/
test-member_builder-method.js
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
/**
* Tests method builder
*
* Copyright (C) 2010 Mike Gerwitz
*
* This file is part of ease.js.
*
* ease.js is free software: you can redistribute it and/or modify it under the
* terms of the GNU Lesser General Public License as published by the Free
* Software Foundation, either version 3 of the License, or (at your option)
* any later version.
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
* for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* @author Mike Gerwitz
* @package test
*/
var common = require( './common' ),
assert = require( 'assert' ),
mb_common = require( __dirname + '/inc-member_builder-common' ),
builder = common.require( 'member_builder' ),
util = common.require( 'util' )
;
mb_common.funcVal = 'foobar';
mb_common.value = function() { return mb_common.funcVal; };
mb_common.buildMember = builder.buildMethod;
// do assertions common to all member builders
mb_common.assertCommon();
/**
* One may question the purpose of this assertion. Why should we not permit
* overriding properties with methods? It's useful to be able to store callbacks
* and such within properties.
*
* Yes, it is. However, that would be misinterpreting the purpose of the method
* builder. Here, we are working with prototypes, not class instances. If the
* user wishes to assign a function to the property (so long as it's permitted
* by the type definition) after the class is instantiated, he/she may go right
* ahead. However, if we modify the prototype to use a function, then the
* prototype will interpret the function as a method. As such, the method cannot
* be overridden with a property in the future. To avoid this confusing
* scenario, we'll prevent it from occurring entirely.
*/
( function testCannotOverridePropertyWithMethod()
{
mb_common.value = 'moofoo';
mb_common.funcVal = undefined;
mb_common.buildMemberQuick();
assert.throws( function()
{
// attempt to override with function
mb_common.value = function() {};
mb_common.buildMemberQuick( {}, true );
}, TypeError, "Cannot override property with method" );
} )();
/**
* To ensure interfaces of subtypes remain compatible with that of their
* supertypes, the parameter lists must match and build upon each other.
*/
( function testMethodOverridesMustHaveEqualOrGreaterParameters()
{
mb_common.value = function( one, two ) {};
mb_common.buildMemberQuick();
assert.doesNotThrow( function()
{
mb_common.buildMemberQuick( {}, true );
}, TypeError, "Method can have equal number of parameters" );
assert.doesNotThrow( function()
{
mb_common.value = function( one, two, three ) {};
mb_common.buildMemberQuick( {}, true );
}, TypeError, "Method can have greater number of parameters" );
assert.throws( function()
{
mb_common.value = function( one ) {};
mb_common.buildMemberQuick( {}, true );
}, TypeError, "Method cannot have lesser number of parameters" );
} )();
/**
* The __super property is defined for method overrides and permits invoking the
* overridden method (method of the supertype).
*
* In this test, we are not looking to assert that __super matches the super
* method. Rather, we want to ensure it /invokes/ it. This is because the super
* method may be wrapped to provide additional functionality. We don't know, we
* don't care. We just want to make sure it's functioning properly.
*/
( function testOverridenMethodShouldContainReferenceToSuperMethod()
{
var orig_called = false;
// "super" method
mb_common.value = function()
{
orig_called = true;
};
mb_common.buildMemberQuick();
// override method
mb_common.value = function()
{
assert.notEqual(
this.__super,
undefined,
"__super is defined for overridden method"
);
this.__super();
assert.equal(
orig_called,
true,
"Invoking __super calls super method"
);
};
mb_common.buildMemberQuick( {}, true );
// invoke the method
mb_common.members[ 'public' ][ mb_common.name ]();
} )();
/**
* If the method is called when bound to a different context (e.g. for
* protected/private members), __super may not be properly bound.
*
* This test is in response to a bug found after implementing visibility
* support. The __super() method was previously defined on 'this', which may or
* may not be the context that is actually used. Likely, it's not.
*/
( function testSuperMethodWorksProperlyWhenContextDiffers()
{
var members = builder.initMembers(),
super_called = false,
retobj = {},
instCallback = function()
{
return retobj;
},
// the overriding method
newfunc = function()
{
this.__super();
}
;
// super method to be overridden
members[ 'public' ].foo = function()
{
super_called = true;
};
// override
builder.buildMethod( members, {}, 'foo', newfunc, {}, instCallback );
// call the overriding method
members[ 'public' ].foo();
// ensure that the super method was called
assert.equal( super_called, true,
"__super() method is called even when context differs"
);
// finally, ensure that __super is no longer set on the returned object
// after the call to ensure that the caller cannot break encapsulation by
// stealing a method reference (sneaky, sneaky)
assert.equal( retobj.__super, undefined,
"__super() method is unset after being called"
);
} )();
/**
* Once a concrete implementation has been defined for a method, a subtype
* cannot make it abstract.
*/
( function testCannotOverrideConcreteMethodWithAbstractMethod()
{
// concrete method
mb_common.value = function() {};
mb_common.buildMemberQuick();
assert.throws( function()
{
mb_common.buildMemberQuick( { 'abstract': true }, true );
}, TypeError, "Cannot override concrete method with abstract method" );
} )();
/**
* One of the powerful features of the method builder is the ability to pass in
* an instance to be bound to 'this' when invoking a method. This has some
* important consequences, such as the ability to implement protected/private
* members.
*/
( function testMethodInvocationBindsThisToPassedInstance()
{
var instance = function() {},
val = 'fooboo',
val2 = 'fooboo2',
iid = 1,
func = function()
{
return this.foo;
},
func2 = function()
{
return this.foo2;
},
called = false,
instCallback = function()
{
called = true;
return instance;
},
members = { 'public': {}, 'protected': {}, 'private': {} }
;
// set instance values
instance.foo = val;
instance.foo2 = val2;
// concrete method
mb_common.buildMember(
members,
exports.meta,
'func',
func,
[ 'public' ],
instCallback
);
assert.equal(
members[ 'public' ].func(),
val,
"Calling method will bind 'this' to passed instance"
);
// override method
mb_common.buildMember(
members,
exports.meta,
'func',
func2,
[ 'public' ],
instCallback
);
assert.equal(
members[ 'public' ].func(),
val2,
"Calling method override will bind 'this' to passed instance"
);
} )();
/**
* It does not make sense to be able to declare abstract private methods, since
* they cannot be inherited and overridden by subtypes.
*/
( function testCannotDeclareAbstractPrivateMethods()
{
mb_common.value = function() {};
assert.throws( function()
{
mb_common.buildMemberQuick( { 'private': true, 'abstract': true } );
}, TypeError, "Cannot declare private abstract method" );
} )();
/**
* While getters are technically methods, it doesn't make sense to override
* getters/setters with methods because they are fundamentally different.
*/
( function testCannotOverrideGetters()
{
if ( util.definePropertyFallback() )
{
return;
}
mb_common.members[ 'public' ] = {};
Object.defineProperty( mb_common.members[ 'public' ], mb_common.name, {
get: function() {},
} );
try
{
mb_common.value = function() {};
mb_common.buildMemberQuick( {}, true );
}
catch ( e )
{
assert.ok( e.message.search( mb_common.name ) !== -1,
"Method override getter failure should contain method name"
);
// ensure we have the correct error
assert.ok( e.message.search( 'getter' ) !== -1,
"Proper error is thrown for getter override failure"
);
return;
}
assert.fail(
"Should not be permitted to override getters with methods"
);
} )();
/**
* While setters are technically methods, it doesn't make sense to override
* getters/setters with methods because they are fundamentally different.
*/
( function testCannotOverrideSetters()
{
if ( util.definePropertyFallback() )
{
return;
}
mb_common.members[ 'public' ] = {};
Object.defineProperty( mb_common.members[ 'public' ], mb_common.name, {
set: function() {},
} );
try
{
mb_common.value = function() {};
mb_common.buildMemberQuick( {}, true );
}
catch ( e )
{
assert.ok( e.message.search( mb_common.name ) !== -1,
"Method override setter failure should contain method name"
);
// ensure we have the correct error
assert.ok( e.message.search( 'setter' ) !== -1,
"Proper error is thrown for setter override failure"
);
return;
}
assert.fail(
"Should not be permitted to override setters with methods"
);
} )();