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

Register shouldn't read data #256

Merged
merged 6 commits into from
Nov 25, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
30 changes: 23 additions & 7 deletions can-route.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
var Bind = require("can-bind");
var queues = require("can-queues");
var Observation = require("can-observation");
var type = require("can-type");

var namespace = require("can-namespace");
var devLog = require("can-log/dev/dev");
Expand Down Expand Up @@ -176,6 +177,27 @@ canReflect.assignMap(canRoute, {

// ## canRoute.start
start: function (val) {
if (canRoute.data instanceof RouteData) {
var routeData = canRoute.data;
var definePropertyWithDefault = function(defaults, name) {
var defaultValue = defaults[name];
var propertyType = defaultValue != null ? type.maybeConvert(defaultValue.constructor) : type.maybeConvert(String);
canReflect.defineInstanceKey(routeData.constructor, name, {
type: propertyType
});
};

canReflect.eachKey(canRoute.routes, function(route) {
canReflect.eachIndex(route.names, function (name) {
definePropertyWithDefault(route.defaults, name);
});

canReflect.eachKey(route.defaults, function(value, key) {
definePropertyWithDefault(route.defaults, key);
});
});
}

if (val !== true) {
canRoute._setup();
if (isBrowserWindow() || isWebWorker()) {
Expand All @@ -192,6 +214,7 @@ canReflect.assignMap(canRoute, {
updateUrl();
}
}

return canRoute;
},
// ## canRoute.url
Expand Down Expand Up @@ -346,13 +369,6 @@ Object.defineProperty(canRoute, "data", {
}
},
set: function(data) {
//!steal-remove-start
if (typeof process !== "undefined" && process.env.NODE_ENV !== "production") {
if (Object.keys(registerRoute.routes).length > 0) {
devLog.warn("can-route: Setting can-route.data after calling can-route.register() may result in unexpected behavior. Set can-route.data before calling can-route.register().");
}
}
//!steal-remove-end
if ( canReflect.isConstructorLike(data) ) {
data = new data();
}
Expand Down
23 changes: 2 additions & 21 deletions src/register.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,13 @@
var canReflect = require("can-reflect");

var dev = require("can-log/dev/dev");
var type = require("can-type");

var bindingProxy = require("./binding-proxy");
var regexps = require("./regexps");

var diff = require("can-diff/list/list");
var diffObject = require("can-diff/map/map");
var RouteData = require("./routedata");

// `RegExp` used to match route variables of the type '{name}'.
// Any word character or a period is matched.

Expand Down Expand Up @@ -102,25 +101,7 @@ var RouteRegistry = {
}
});
}
//!steal-remove-end

// Assign to the instance props
if (this.data instanceof RouteData) {
var routeData = this.data;
var definePropertyWithDefault = function(name) {
var defaultValue = defaults[name];
var propertyType = defaultValue != null ? type.maybeConvert(defaultValue.constructor) : type.maybeConvert(String);

canReflect.defineInstanceKey(routeData.constructor, name, {
type: propertyType
});
};
canReflect.eachIndex(names, definePropertyWithDefault);
canReflect.eachKey(defaults, function(value, key){
definePropertyWithDefault(key);
});

}
//!steal-remove-end

// Add route in a form that can be easily figured out.
return RouteRegistry.routes[url] = {
Expand Down
33 changes: 29 additions & 4 deletions test/route-data-test.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ var canReflect = require("can-reflect");
var canSymbol = require("can-symbol");
var mockRoute = require("./mock-route-binding");
var RouteData = require("../src/routedata");
var testHelpers = require("can-test-helpers");

require("can-observation");

Expand Down Expand Up @@ -105,11 +104,37 @@ QUnit.test("Default map registers defaults as properties", function(assert) {
canRoute.start();
});

testHelpers.dev.devOnlyTest("should warn when .data is set after .register() is called", function (assert) {
var teardown = testHelpers.dev.willWarn(/Set can-route.data before/);
QUnit.test("route.register should not read route.data, register first", function (assert) {
var done = assert.async();
mockRoute.start();

canRoute.register("{page}/{subpage}");
canRoute.data = new RouteData();

assert.equal(teardown(), 1);
canRoute._onStartComplete = function () {
assert.ok('page' in canRoute.data);
assert.ok('subpage' in canRoute.data);
done();
mockRoute.stop();
};

canRoute.start();
});

QUnit.test("route.register should not read route.data 2, start first", function (assert) {
var done = assert.async();
mockRoute.start();

canRoute.data = new RouteData();
canRoute.register("{page}/{subpage}");

canRoute._onStartComplete = function () {
assert.ok('page' in canRoute.data);
assert.ok('subpage' in canRoute.data);
done();
mockRoute.stop();
};


canRoute.start();
});
1 change: 1 addition & 0 deletions test/route-observable-test.js
Original file line number Diff line number Diff line change
Expand Up @@ -340,6 +340,7 @@ if ("onhashchange" in window) {

canRoute.routes = {};
canRoute.register("{type}/{id}");
canRoute.start();

canReflect.update(canRoute.data, {});

Expand Down