Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/es6 class constructor support #182

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,5 @@ node_modules/
experiments/
.idea/
*~
*.log
bower_components/
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ and check out a few [example applications](docs/introduction.md#example-apps).
1. [Getting Started](docs/get.md)
1. [Reference Documentation](docs/README.md)
1. [Example Code and Apps](docs/introduction.md#example-apps)
1. [Testing](docs/testing.md)
1. [Full Changelog](CHANGES.md)

# License
Expand Down
28 changes: 28 additions & 0 deletions docs/testing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Testing wire.js

Wire.js is using [buster](http://busterjs.org) for testing. You need to have [node.js](https://nodejs.org) installed to run tests of wire.js.

## Testing in node.js:

[Install wire.js](docs/get.md) and run in installation directory
```
$ npm install
$ npm test
```

## Testing in browser

[Install wire.js](docs/get.md) and run in installation directory

```
$ npm install
$ npm run-script start-test-server
```

Open http://localhost:1111 in your browser and click "Capture browser" button. Browser is now connected to test server
and will be used by it to run tests.

Run in wire.js installation directory (without closing browser and test server)
```
$ npm run-script browser-test
```
45 changes: 45 additions & 0 deletions lib/es5Apply.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
(function(define) {
'use strict';
define(function() {
/**
* Carefully sets the instance's constructor property to the supplied
* constructor, using Object.defineProperty if available. If it can't
* set the constructor in a safe way, it will do nothing.
*
* @param instance {Object} component instance
* @param ctor {Function} constructor
*/
function defineConstructorIfPossible(instance, ctor) {
try {
Object.defineProperty(instance, 'constructor', {
value: ctor,
enumerable: false
});
} catch(e) {
// If we can't define a constructor, oh well.
// This can happen if in envs where Object.defineProperty is not
// available, or when using cujojs/poly or other ES5 shims
}
}

return function(func, thisObj, args) {
var result = null;

if(thisObj && typeof thisObj[func] === 'function') {
func = thisObj[func];
}

// detect case when apply is called on constructor and fix prototype chain
if (thisObj === func) {
thisObj = Object.create(func.prototype);
defineConstructorIfPossible(thisObj, func);
func.apply(thisObj, args);
result = thisObj;
} else {
result = func.apply(thisObj, args);
}

return result;
};
});
})(typeof define === 'function' && define.amd ? define : function(factory) { module.exports = factory(); });
28 changes: 28 additions & 0 deletions lib/es6Apply.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
/* jshint esversion: 6 */
(function(define) {
'use strict';
define(function() {
return function(func, thisObj, args) {
var result = null;

if(thisObj === func || (thisObj && thisObj.constructor === func)) {
/* jshint newcap: false */
result = new func(...(args||[]));

// detect broken old prototypes with missing constructor
if (result.constructor !== func) {
Object.defineProperty(result, 'constructor', {
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't want to modify the prototype from here, so I set the constructor property on object itself.

enumerable: false,
value: func
});
}
} else if(thisObj && typeof thisObj[func] === 'function') {
result = thisObj[func](...args);
} else {
result = func.apply(thisObj, args);
}

return result;
};
});
})(typeof define === 'function' && define.amd ? define : function(factory) { module.exports = factory(); });
54 changes: 20 additions & 34 deletions lib/instantiate.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,11 @@
*/

(function(define){ 'use strict';
define(function() {
define(function(require) {

var undef;
var undef, universalApply;

universalApply = require('./universalApply');

/**
* Creates an object by either invoking ctor as a function and returning the result,
Expand All @@ -26,42 +28,19 @@ define(function() {
var begotten, ctorResult;

if (forceConstructor || (forceConstructor === undef && isConstructor(ctor))) {
begotten = Object.create(ctor.prototype);
defineConstructorIfPossible(begotten, ctor);
ctorResult = ctor.apply(begotten, args);
begotten = ctor;
ctorResult = universalApply(ctor, begotten, args);

if(ctorResult !== undef) {
begotten = ctorResult;
}

} else {
begotten = ctor.apply(undef, args);

begotten = universalApply(ctor, undef, args);
}

return begotten === undef ? null : begotten;
};

/**
* Carefully sets the instance's constructor property to the supplied
* constructor, using Object.defineProperty if available. If it can't
* set the constructor in a safe way, it will do nothing.
*
* @param instance {Object} component instance
* @param ctor {Function} constructor
*/
function defineConstructorIfPossible(instance, ctor) {
try {
Object.defineProperty(instance, 'constructor', {
value: ctor,
enumerable: false
});
} catch(e) {
// If we can't define a constructor, oh well.
// This can happen if in envs where Object.defineProperty is not
// available, or when using cujojs/poly or other ES5 shims
}
}

/**
* Determines whether the supplied function should be invoked directly or
* should be invoked using new in order to create the object to be wired.
Expand All @@ -72,10 +51,17 @@ define(function() {
*/
function isConstructor(func) {
var is = false, p;
for (p in func.prototype) {
if (p !== undef) {
is = true;
break;

// this has to work, according to spec:
// https://tc39.github.io/ecma262/#sec-function.prototype.tostring
is = is || func.toString().trim().substr(0,5) === 'class';
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep, looks right. Nice find. Any idea of the performance characteristics of this? I figure it's probably fine, but just want to make sure we're not introducing a big perf hit by toStringing every created function.


if(!is) {
for (p in func.prototype) {
if (p !== undef) {
is = true;
break;
}
}
}

Expand All @@ -88,6 +74,6 @@ define(function() {
? define
// CommonJS
: function(factory) {
module.exports = factory();
module.exports = factory(require);
}
);
8 changes: 5 additions & 3 deletions lib/invoker.js
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
(function(define) {
define(function() {
define(function(require) {

var universalApply = require('./universalApply');

return function(methodName, args) {
return function(target) {
return target[methodName].apply(target, args);
return universalApply(target[methodName], target, args);
};
};

});
})(typeof define === 'function' && define.amd ? define : function(factory) { module.exports = factory(); });
})(typeof define === 'function' && define.amd ? define : function(factory) { module.exports = factory(require); });
6 changes: 3 additions & 3 deletions lib/plugin/basePlugin.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,15 @@
define(function(require) {

var when, object, functional, pipeline, instantiate, createInvoker,
whenAll, obj, pluginInstance, undef;
whenAll, obj, pluginInstance, undef, universalApply;

when = require('when');
object = require('../object');
functional = require('../functional');
pipeline = require('../pipeline');
instantiate = require('../instantiate');
createInvoker = require('../invoker');
universalApply = require('../universalApply');

whenAll = when.all;

Expand Down Expand Up @@ -194,7 +195,6 @@ define(function(require) {
if (!proxy.clone) {
throw new Error('No clone function found for ' + componentDef.id);
}

return proxy.clone(options);
});
});
Expand Down Expand Up @@ -249,7 +249,7 @@ define(function(require) {
// We'll either use the module directly, or we need
// to instantiate/invoke it.
return constructorName
? module[constructorName].apply(module, args)
? universalApply(constructorName, module, args)
: typeof module == 'function'
? instantiate(module, args, isConstructor)
: Object.create(module);
Expand Down
45 changes: 45 additions & 0 deletions lib/universalApply.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
(function(){
'use strict';

(function(define){

function evaluates (statement) {
try {
/* jshint evil: true */
eval(statement);
/* jshint evil: false */
return true;
} catch (err) {
return false;
}
}

// we have to know it synchronously, we are unable to load this module in asynchronous way
// we cannot defer `define` and we cannot load module, that would not compile in browser
// so we can't delegate this check to another module
function isSpreadAvailable() {
return evaluates('Math.max(...[ 5, 10 ])');
}

var requires = [];
if (typeof(process) !== 'undefined' && 'ES_VERSION' in process.env) {
requires.push('./es'+process.env.ES_VERSION+'Apply');
} else {
if(isSpreadAvailable()) {
requires.push('./es6Apply');
} else {
requires.push('./es5Apply');
}
}

define(requires, function(apply){
return apply;
});
})(
typeof define === 'function'
? define
: function(requires, factory) {
module.exports = factory.apply(null, requires.map(require));
}
);
})();
Loading