-
Notifications
You must be signed in to change notification settings - Fork 27.1k
feat: support decorator chaining and class creation in ES5 #2534
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
Closed
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1 @@ | ||
| export { | ||
| View as ViewAnnotation, | ||
| } from '../annotations_impl/view'; | ||
| export {View as ViewAnnotation, ViewArgs} from '../annotations_impl/view'; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,48 +1,149 @@ | ||
| import {global} from 'angular2/src/facade/lang'; | ||
| import {global, Type, isFunction, stringify} from 'angular2/src/facade/lang'; | ||
|
|
||
| export function makeDecorator(annotationCls) { | ||
| return function(...args) { | ||
| var Reflect = global.Reflect; | ||
| if (!(Reflect && Reflect.getMetadata)) { | ||
| throw 'reflect-metadata shim is required when using class decorators'; | ||
| export interface ClassDefinition { | ||
| extends?: Type; | ||
| constructor: (Function | Array<any>); | ||
| } | ||
|
|
||
| export interface TypeDecorator { | ||
| (cls: any): any; | ||
| annotations: Array<any>; | ||
| Class(obj: ClassDefinition): Type; | ||
| } | ||
|
|
||
| function extractAnnotation(annotation: any) { | ||
| if (isFunction(annotation) && annotation.hasOwnProperty('annotation')) { | ||
| // it is a decorator, extract annotation | ||
| annotation = annotation.annotation; | ||
| } | ||
| return annotation; | ||
| } | ||
|
|
||
| function applyParams(fnOrArray: (Function | Array<any>), key: string): Function { | ||
| if (fnOrArray === Object || fnOrArray === String || fnOrArray === Function || | ||
| fnOrArray === Number || fnOrArray === Array) { | ||
| throw new Error(`Can not use native ${stringify(fnOrArray)} as constructor`); | ||
| } | ||
| if (isFunction(fnOrArray)) { | ||
| return <Function>fnOrArray; | ||
| } else if (fnOrArray instanceof Array) { | ||
| var annotations: Array<any> = fnOrArray; | ||
| var fn: Function = fnOrArray[fnOrArray.length - 1]; | ||
| if (!isFunction(fn)) { | ||
| throw new Error( | ||
| `Last position of Class method array must be Function in key ${key} was '${stringify(fn)}'`); | ||
| } | ||
| var annotationInstance = Object.create(annotationCls.prototype); | ||
| annotationCls.apply(annotationInstance, args); | ||
| return function(cls) { | ||
| var annoLength = annotations.length - 1; | ||
| if (annoLength != fn.length) { | ||
| throw new Error( | ||
| `Number of annotations (${annoLength}) does not match number of arguments (${fn.length}) in the function: ${stringify(fn)}`); | ||
| } | ||
| var paramsAnnotations: Array<Array<any>> = []; | ||
| for (var i = 0, ii = annotations.length - 1; i < ii; i++) { | ||
| var paramAnnotations: Array<any> = []; | ||
| paramsAnnotations.push(paramAnnotations); | ||
| var annotation = annotations[i]; | ||
| if (annotation instanceof Array) { | ||
| for (var j = 0; j < annotation.length; j++) { | ||
| paramAnnotations.push(extractAnnotation(annotation[j])); | ||
| } | ||
| } else if (isFunction(annotation)) { | ||
| paramAnnotations.push(extractAnnotation(annotation)); | ||
| } else { | ||
| paramAnnotations.push(annotation); | ||
| } | ||
| } | ||
| Reflect.defineMetadata('parameters', paramsAnnotations, fn); | ||
| return fn; | ||
| } else { | ||
| throw new Error( | ||
| `Only Function or Array is supported in Class definition for key '${key}' is '${stringify(fnOrArray)}'`); | ||
| } | ||
| } | ||
|
|
||
| var annotations = Reflect.getMetadata('annotations', cls); | ||
| annotations = annotations || []; | ||
| annotations.push(annotationInstance); | ||
| Reflect.defineMetadata('annotations', annotations, cls); | ||
| return cls; | ||
| export function Class(clsDef: ClassDefinition): Type { | ||
| var constructor = applyParams( | ||
| clsDef.hasOwnProperty('constructor') ? clsDef.constructor : undefined, 'constructor'); | ||
| var proto = constructor.prototype; | ||
| if (clsDef.hasOwnProperty('extends')) { | ||
| if (isFunction(clsDef.extends)) { | ||
| (<Function>constructor).prototype = proto = | ||
| Object.create((<Function>clsDef.extends).prototype); | ||
| } else { | ||
| throw new Error( | ||
| `Class definition 'extends' property must be a constructor function was: ${stringify(clsDef.extends)}`); | ||
| } | ||
| } | ||
| for (var key in clsDef) { | ||
| if (key != 'extends' && key != 'prototype' && clsDef.hasOwnProperty(key)) { | ||
| proto[key] = applyParams(clsDef[key], key); | ||
| } | ||
| } | ||
| return <Type>constructor; | ||
| } | ||
|
|
||
| export function makeParamDecorator(annotationCls): any { | ||
| return function(...args) { | ||
| var Reflect = global.Reflect; | ||
| if (!(Reflect && Reflect.getMetadata)) { | ||
| throw 'reflect-metadata shim is required when using parameter decorators'; | ||
| var Reflect = global.Reflect; | ||
| if (!(Reflect && Reflect.getMetadata)) { | ||
| throw 'reflect-metadata shim is required when using class decorators'; | ||
| } | ||
|
|
||
| export function makeDecorator(annotationCls, chainFn: (fn: Function) => void = null): (...args) => | ||
| (cls: any) => any { | ||
| function DecoratorFactory(objOrType): (cls: any) => any { | ||
| var annotationInstance = new (<any>annotationCls)(objOrType); | ||
| if (this instanceof annotationCls) { | ||
| return annotationInstance; | ||
| } else { | ||
| var chainAnnotation = isFunction(this) && this.annotations instanceof Array ? | ||
| this.annotations : | ||
| []; | ||
| chainAnnotation.push(annotationInstance); | ||
| var TypeDecorator: TypeDecorator = <TypeDecorator>function TypeDecorator(cls) { | ||
| var annotations = Reflect.getMetadata('annotations', cls); | ||
| annotations = annotations || []; | ||
| annotations.push(annotationInstance); | ||
| Reflect.defineMetadata('annotations', annotations, cls); | ||
| return cls; | ||
| }; | ||
| TypeDecorator.annotations = chainAnnotation; | ||
| TypeDecorator.Class = Class; | ||
| if (chainFn) chainFn(TypeDecorator); | ||
| return TypeDecorator; | ||
| } | ||
| } | ||
| DecoratorFactory.prototype = Object.create(annotationCls.prototype); | ||
| return DecoratorFactory; | ||
| } | ||
|
|
||
| export function makeParamDecorator(annotationCls): any { | ||
| function ParamDecoratorFactory(...args) { | ||
| var annotationInstance = Object.create(annotationCls.prototype); | ||
| annotationCls.apply(annotationInstance, args); | ||
| return function(cls, unusedKey, index) { | ||
| var parameters: Array<Array<any>> = Reflect.getMetadata('parameters', cls); | ||
| parameters = parameters || []; | ||
|
|
||
| // there might be gaps if some in between parameters do not have annotations. | ||
| // we pad with nulls. | ||
| while (parameters.length <= index) { | ||
| parameters.push(null); | ||
| } | ||
| if (this instanceof annotationCls) { | ||
| return annotationInstance; | ||
| } else { | ||
| function ParamDecorator(cls, unusedKey, index) { | ||
| var parameters: Array<Array<any>> = Reflect.getMetadata('parameters', cls); | ||
| parameters = parameters || []; | ||
|
|
||
| parameters[index] = parameters[index] || []; | ||
| var annotationsForParam: Array<any> = parameters[index]; | ||
| annotationsForParam.push(annotationInstance); | ||
| // there might be gaps if some in between parameters do not have annotations. | ||
| // we pad with nulls. | ||
| while (parameters.length <= index) { | ||
| parameters.push(null); | ||
| } | ||
|
|
||
| parameters[index] = parameters[index] || []; | ||
| var annotationsForParam: Array<any> = parameters[index]; | ||
| annotationsForParam.push(annotationInstance); | ||
|
|
||
| Reflect.defineMetadata('parameters', parameters, cls); | ||
| return cls; | ||
| } | ||
|
|
||
| Reflect.defineMetadata('parameters', parameters, cls); | ||
| return cls; | ||
| (<any>ParamDecorator).annotation = annotationInstance; | ||
| return ParamDecorator; | ||
| } | ||
| } | ||
| ParamDecoratorFactory.prototype = Object.create(annotationCls.prototype); | ||
| return ParamDecoratorFactory; | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| library angular2.test.core.annotations.decorators_dart_spec; | ||
|
|
||
| main() { | ||
| // not relavant for dart. | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| import { | ||
| AsyncTestCompleter, | ||
| beforeEach, | ||
| ddescribe, | ||
| describe, | ||
| expect, | ||
| iit, | ||
| inject, | ||
| it, | ||
| xit, | ||
| } from 'angular2/test_lib'; | ||
|
|
||
| import {Component, View, Directive} from 'angular2/angular2'; | ||
|
|
||
| export function main() { | ||
| describe('es5 decorators', () => { | ||
| it('should declare directive class', () => { | ||
| var MyDirective = Directive({}).Class({constructor: function() { this.works = true; }}); | ||
| expect(new MyDirective().works).toEqual(true); | ||
| }); | ||
|
|
||
| it('should declare Component class', () => { | ||
| var MyComponent = | ||
| Component({}).View({}).View({}).Class({constructor: function() { this.works = true; }}); | ||
| expect(new MyComponent().works).toEqual(true); | ||
| }); | ||
| }); | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure if ctor are supported in ifs ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The code is typed and it passes
tscso it seems to be supported.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
forget about it, it's a property, not the ctor method