From 59d01f737dc123b83a9ba21b44a874cbf0b7fefa Mon Sep 17 00:00:00 2001 From: Hunter Perrin Date: Sat, 5 Aug 2017 11:44:24 -0700 Subject: [PATCH 1/2] Added setup function which can supply static methods/properties. Closes #480. Closes #578. --- src/generators/dom/index.ts | 2 + src/validate/js/propValidators/index.ts | 2 + src/validate/js/propValidators/setup.ts | 14 ++ .../samples/setup-method/expected-bundle.js | 188 ++++++++++++++++++ test/js/samples/setup-method/expected.js | 77 +++++++ test/js/samples/setup-method/input.html | 13 ++ 6 files changed, 296 insertions(+) create mode 100644 src/validate/js/propValidators/setup.ts create mode 100644 test/js/samples/setup-method/expected-bundle.js create mode 100644 test/js/samples/setup-method/expected.js create mode 100644 test/js/samples/setup-method/input.html diff --git a/src/generators/dom/index.ts b/src/generators/dom/index.ts index 6fa230d1eb..e0b814be25 100644 --- a/src/generators/dom/index.ts +++ b/src/generators/dom/index.ts @@ -275,6 +275,8 @@ export default function dom( this._state = {}; this._destroyed = true; }; + + ${templateProperties.setup && `@template.setup.call( ${name} );`} `); const usedHelpers = new Set(); diff --git a/src/validate/js/propValidators/index.ts b/src/validate/js/propValidators/index.ts index 6d3b089d99..aa71fa0aeb 100644 --- a/src/validate/js/propValidators/index.ts +++ b/src/validate/js/propValidators/index.ts @@ -10,6 +10,7 @@ import components from './components'; import events from './events'; import namespace from './namespace'; import transitions from './transitions'; +import setup from './setup'; export default { data, @@ -24,4 +25,5 @@ export default { events, namespace, transitions, + setup, }; diff --git a/src/validate/js/propValidators/setup.ts b/src/validate/js/propValidators/setup.ts new file mode 100644 index 0000000000..ec8fe7c8a0 --- /dev/null +++ b/src/validate/js/propValidators/setup.ts @@ -0,0 +1,14 @@ +import usesThisOrArguments from '../utils/usesThisOrArguments'; +import { Validator } from '../../'; +import { Node } from '../../../interfaces'; + +export default function setup(validator: Validator, prop: Node) { + if (prop.value.type === 'ArrowFunctionExpression') { + if (usesThisOrArguments(prop.value.body)) { + validator.error( + `'setup' should be a function expression, not an arrow function expression`, + prop.start + ); + } + } +} diff --git a/test/js/samples/setup-method/expected-bundle.js b/test/js/samples/setup-method/expected-bundle.js new file mode 100644 index 0000000000..34e8ff4274 --- /dev/null +++ b/test/js/samples/setup-method/expected-bundle.js @@ -0,0 +1,188 @@ +function noop() {} + +function assign(target) { + var k, + source, + i = 1, + len = arguments.length; + for (; i < len; i++) { + source = arguments[i]; + for (k in source) target[k] = source[k]; + } + + return target; +} + +function differs(a, b) { + return a !== b || ((a && typeof a === 'object') || typeof a === 'function'); +} + +function dispatchObservers(component, group, newState, oldState) { + for (var key in group) { + if (!(key in newState)) continue; + + var newValue = newState[key]; + var oldValue = oldState[key]; + + if (differs(newValue, oldValue)) { + var callbacks = group[key]; + if (!callbacks) continue; + + for (var i = 0; i < callbacks.length; i += 1) { + var callback = callbacks[i]; + if (callback.__calling) continue; + + callback.__calling = true; + callback.call(component, newValue, oldValue); + callback.__calling = false; + } + } + } +} + +function get(key) { + return key ? this._state[key] : this._state; +} + +function fire(eventName, data) { + var handlers = + eventName in this._handlers && this._handlers[eventName].slice(); + if (!handlers) return; + + for (var i = 0; i < handlers.length; i += 1) { + handlers[i].call(this, data); + } +} + +function observe(key, callback, options) { + var group = options && options.defer + ? this._observers.post + : this._observers.pre; + + (group[key] || (group[key] = [])).push(callback); + + if (!options || options.init !== false) { + callback.__calling = true; + callback.call(this, this._state[key]); + callback.__calling = false; + } + + return { + cancel: function() { + var index = group[key].indexOf(callback); + if (~index) group[key].splice(index, 1); + } + }; +} + +function on(eventName, handler) { + if (eventName === 'teardown') return this.on('destroy', handler); + + var handlers = this._handlers[eventName] || (this._handlers[eventName] = []); + handlers.push(handler); + + return { + cancel: function() { + var index = handlers.indexOf(handler); + if (~index) handlers.splice(index, 1); + } + }; +} + +function set(newState) { + this._set(assign({}, newState)); + if (this._root._lock) return; + this._root._lock = true; + callAll(this._root._beforecreate); + callAll(this._root._oncreate); + callAll(this._root._aftercreate); + this._root._lock = false; +} + +function callAll(fns) { + while (fns && fns.length) fns.pop()(); +} + +var proto = { + get: get, + fire: fire, + observe: observe, + on: on, + set: set +}; + +var template = (function () { + return { + methods: { + foo ( bar ) { + console.log( bar ); + } + }, + setup () { + this.SOME_CONSTANT = 42; + this.prototype.foo( 'baz' ); + } + }; +}()); + +function create_main_fragment ( state, component ) { + + return { + create: noop, + + mount: noop, + + unmount: noop, + + destroy: noop + }; +} + +function SvelteComponent ( options ) { + options = options || {}; + this._state = options.data || {}; + + this._observers = { + pre: Object.create( null ), + post: Object.create( null ) + }; + + this._handlers = Object.create( null ); + + this._root = options._root || this; + this._yield = options._yield; + + this._destroyed = false; + + this._fragment = create_main_fragment( this._state, this ); + + if ( options.target ) { + this._fragment.create(); + this._fragment.mount( options.target, null ); + } +} + +assign( SvelteComponent.prototype, template.methods, proto ); + +SvelteComponent.prototype._set = function _set ( newState ) { + var oldState = this._state; + this._state = assign( {}, oldState, newState ); + dispatchObservers( this, this._observers.pre, newState, oldState ); + dispatchObservers( this, this._observers.post, newState, oldState ); +}; + +SvelteComponent.prototype.teardown = SvelteComponent.prototype.destroy = function destroy ( detach ) { + if ( this._destroyed ) return; + this.fire( 'destroy' ); + + if ( detach !== false ) this._fragment.unmount(); + this._fragment.destroy(); + this._fragment = null; + + this._state = {}; + this._destroyed = true; +}; + +template.setup.call( SvelteComponent ); + +export default SvelteComponent; diff --git a/test/js/samples/setup-method/expected.js b/test/js/samples/setup-method/expected.js new file mode 100644 index 0000000000..55cd938aa6 --- /dev/null +++ b/test/js/samples/setup-method/expected.js @@ -0,0 +1,77 @@ +import { assign, dispatchObservers, noop, proto } from "svelte/shared.js"; + +var template = (function () { + return { + methods: { + foo ( bar ) { + console.log( bar ); + } + }, + setup () { + this.SOME_CONSTANT = 42; + this.prototype.foo( 'baz' ); + } + }; +}()); + +function create_main_fragment ( state, component ) { + + return { + create: noop, + + mount: noop, + + unmount: noop, + + destroy: noop + }; +} + +function SvelteComponent ( options ) { + options = options || {}; + this._state = options.data || {}; + + this._observers = { + pre: Object.create( null ), + post: Object.create( null ) + }; + + this._handlers = Object.create( null ); + + this._root = options._root || this; + this._yield = options._yield; + + this._destroyed = false; + + this._fragment = create_main_fragment( this._state, this ); + + if ( options.target ) { + this._fragment.create(); + this._fragment.mount( options.target, null ); + } +} + +assign( SvelteComponent.prototype, template.methods, proto ); + +SvelteComponent.prototype._set = function _set ( newState ) { + var oldState = this._state; + this._state = assign( {}, oldState, newState ); + dispatchObservers( this, this._observers.pre, newState, oldState ); + dispatchObservers( this, this._observers.post, newState, oldState ); +}; + +SvelteComponent.prototype.teardown = SvelteComponent.prototype.destroy = function destroy ( detach ) { + if ( this._destroyed ) return; + this.fire( 'destroy' ); + + if ( detach !== false ) this._fragment.unmount(); + this._fragment.destroy(); + this._fragment = null; + + this._state = {}; + this._destroyed = true; +}; + +template.setup.call( SvelteComponent ); + +export default SvelteComponent; diff --git a/test/js/samples/setup-method/input.html b/test/js/samples/setup-method/input.html new file mode 100644 index 0000000000..56d3f46f0a --- /dev/null +++ b/test/js/samples/setup-method/input.html @@ -0,0 +1,13 @@ + From ba74297a196f9bac0969779697d57d52c0f2ed33 Mon Sep 17 00:00:00 2001 From: Hunter Perrin Date: Sat, 5 Aug 2017 12:41:37 -0700 Subject: [PATCH 2/2] Changed from this keyword to argument in setup method. --- src/generators/dom/index.ts | 2 +- src/validate/js/propValidators/setup.ts | 14 ++++++-------- test/js/samples/setup-method/expected-bundle.js | 13 +++++++++---- test/js/samples/setup-method/expected.js | 13 +++++++++---- test/js/samples/setup-method/input.html | 11 ++++++++--- 5 files changed, 33 insertions(+), 20 deletions(-) diff --git a/src/generators/dom/index.ts b/src/generators/dom/index.ts index e0b814be25..b9500e3491 100644 --- a/src/generators/dom/index.ts +++ b/src/generators/dom/index.ts @@ -276,7 +276,7 @@ export default function dom( this._destroyed = true; }; - ${templateProperties.setup && `@template.setup.call( ${name} );`} + ${templateProperties.setup && `@template.setup( ${name} );`} `); const usedHelpers = new Set(); diff --git a/src/validate/js/propValidators/setup.ts b/src/validate/js/propValidators/setup.ts index ec8fe7c8a0..7e4c21ce3b 100644 --- a/src/validate/js/propValidators/setup.ts +++ b/src/validate/js/propValidators/setup.ts @@ -1,14 +1,12 @@ -import usesThisOrArguments from '../utils/usesThisOrArguments'; import { Validator } from '../../'; import { Node } from '../../../interfaces'; +const disallowed = new Set(['Literal', 'ObjectExpression', 'ArrayExpression']); + export default function setup(validator: Validator, prop: Node) { - if (prop.value.type === 'ArrowFunctionExpression') { - if (usesThisOrArguments(prop.value.body)) { - validator.error( - `'setup' should be a function expression, not an arrow function expression`, - prop.start - ); - } + while (prop.type === 'ParenthesizedExpression') prop = prop.expression; + + if (disallowed.has(prop.value.type)) { + validator.error(`'setup' must be a function`, prop.value.start); } } diff --git a/test/js/samples/setup-method/expected-bundle.js b/test/js/samples/setup-method/expected-bundle.js index 34e8ff4274..6c4e62fa04 100644 --- a/test/js/samples/setup-method/expected-bundle.js +++ b/test/js/samples/setup-method/expected-bundle.js @@ -118,9 +118,14 @@ var template = (function () { console.log( bar ); } }, - setup () { - this.SOME_CONSTANT = 42; - this.prototype.foo( 'baz' ); + setup: (Component) => { + Component.SOME_CONSTANT = 42; + Component.factory = function (target) { + return new Component({ + target: target + }); + }; + Component.prototype.foo( 'baz' ); } }; }()); @@ -183,6 +188,6 @@ SvelteComponent.prototype.teardown = SvelteComponent.prototype.destroy = functio this._destroyed = true; }; -template.setup.call( SvelteComponent ); +template.setup( SvelteComponent ); export default SvelteComponent; diff --git a/test/js/samples/setup-method/expected.js b/test/js/samples/setup-method/expected.js index 55cd938aa6..3e72768ac8 100644 --- a/test/js/samples/setup-method/expected.js +++ b/test/js/samples/setup-method/expected.js @@ -7,9 +7,14 @@ var template = (function () { console.log( bar ); } }, - setup () { - this.SOME_CONSTANT = 42; - this.prototype.foo( 'baz' ); + setup: (Component) => { + Component.SOME_CONSTANT = 42; + Component.factory = function (target) { + return new Component({ + target: target + }); + } + Component.prototype.foo( 'baz' ); } }; }()); @@ -72,6 +77,6 @@ SvelteComponent.prototype.teardown = SvelteComponent.prototype.destroy = functio this._destroyed = true; }; -template.setup.call( SvelteComponent ); +template.setup( SvelteComponent ); export default SvelteComponent; diff --git a/test/js/samples/setup-method/input.html b/test/js/samples/setup-method/input.html index 56d3f46f0a..17a34221a3 100644 --- a/test/js/samples/setup-method/input.html +++ b/test/js/samples/setup-method/input.html @@ -5,9 +5,14 @@ console.log( bar ); } }, - setup () { - this.SOME_CONSTANT = 42; - this.prototype.foo( 'baz' ); + setup: (Component) => { + Component.SOME_CONSTANT = 42; + Component.factory = function (target) { + return new Component({ + target: target + }); + } + Component.prototype.foo( 'baz' ); } };