Add message to assertions.

This commit is contained in:
Marc Jansen
2015-03-30 22:50:15 +02:00
parent 2c40d74a15
commit fb9ba22c30
45 changed files with 394 additions and 221 deletions

View File

@@ -47,32 +47,42 @@ ol.structs.LRUCache = function() {
*/
ol.structs.LRUCache.prototype.assertValid = function() {
if (this.count_ === 0) {
goog.asserts.assert(goog.object.isEmpty(this.entries_));
goog.asserts.assert(goog.isNull(this.oldest_));
goog.asserts.assert(goog.isNull(this.newest_));
goog.asserts.assert(goog.object.isEmpty(this.entries_),
'entries must be an empty object (count = 0)');
goog.asserts.assert(goog.isNull(this.oldest_),
'oldest must be null (count = 0)');
goog.asserts.assert(goog.isNull(this.newest_),
'newest must be null (count = 0)');
} else {
goog.asserts.assert(goog.object.getCount(this.entries_) == this.count_);
goog.asserts.assert(!goog.isNull(this.oldest_));
goog.asserts.assert(goog.isNull(this.oldest_.older));
goog.asserts.assert(!goog.isNull(this.newest_));
goog.asserts.assert(goog.isNull(this.newest_.newer));
goog.asserts.assert(goog.object.getCount(this.entries_) == this.count_,
'number of entries matches count');
goog.asserts.assert(!goog.isNull(this.oldest_),
'we have an oldest entry');
goog.asserts.assert(goog.isNull(this.oldest_.older),
'no entry is older than oldest');
goog.asserts.assert(!goog.isNull(this.newest_),
'we have a newest entry');
goog.asserts.assert(goog.isNull(this.newest_.newer),
'no entry is newer than newest');
var i, entry;
var older = null;
i = 0;
for (entry = this.oldest_; !goog.isNull(entry); entry = entry.newer) {
goog.asserts.assert(entry.older === older);
goog.asserts.assert(entry.older === older,
'entry.older links to correct older');
older = entry;
++i;
}
goog.asserts.assert(i == this.count_);
goog.asserts.assert(i == this.count_, 'iterated correct amount of times');
var newer = null;
i = 0;
for (entry = this.newest_; !goog.isNull(entry); entry = entry.older) {
goog.asserts.assert(entry.newer === newer);
goog.asserts.assert(entry.newer === newer,
'entry.newer links to correct newer');
newer = entry;
++i;
}
goog.asserts.assert(i == this.count_);
goog.asserts.assert(i == this.count_, 'iterated correct amount of times');
}
};
@@ -120,7 +130,7 @@ ol.structs.LRUCache.prototype.forEach = function(f, opt_this) {
*/
ol.structs.LRUCache.prototype.get = function(key) {
var entry = this.entries_[key];
goog.asserts.assert(goog.isDef(entry));
goog.asserts.assert(goog.isDef(entry), 'an entry exists for key %s', key);
if (entry === this.newest_) {
return entry.value_;
} else if (entry === this.oldest_) {
@@ -156,7 +166,7 @@ ol.structs.LRUCache.prototype.getKeys = function() {
for (entry = this.newest_; !goog.isNull(entry); entry = entry.older) {
keys[i++] = entry.key_;
}
goog.asserts.assert(i == this.count_);
goog.asserts.assert(i == this.count_, 'iterated correct number of times');
return keys;
};
@@ -171,7 +181,7 @@ ol.structs.LRUCache.prototype.getValues = function() {
for (entry = this.newest_; !goog.isNull(entry); entry = entry.older) {
values[i++] = entry.value_;
}
goog.asserts.assert(i == this.count_);
goog.asserts.assert(i == this.count_, 'iterated correct number of times');
return values;
};
@@ -180,7 +190,7 @@ ol.structs.LRUCache.prototype.getValues = function() {
* @return {T} Last value.
*/
ol.structs.LRUCache.prototype.peekLast = function() {
goog.asserts.assert(!goog.isNull(this.oldest_));
goog.asserts.assert(!goog.isNull(this.oldest_), 'oldest must not be null');
return this.oldest_.value_;
};
@@ -189,7 +199,7 @@ ol.structs.LRUCache.prototype.peekLast = function() {
* @return {string} Last key.
*/
ol.structs.LRUCache.prototype.peekLastKey = function() {
goog.asserts.assert(!goog.isNull(this.oldest_));
goog.asserts.assert(!goog.isNull(this.oldest_), 'oldest must not be null');
return this.oldest_.key_;
};
@@ -198,10 +208,11 @@ ol.structs.LRUCache.prototype.peekLastKey = function() {
* @return {T} value Value.
*/
ol.structs.LRUCache.prototype.pop = function() {
goog.asserts.assert(!goog.isNull(this.oldest_));
goog.asserts.assert(!goog.isNull(this.newest_));
goog.asserts.assert(!goog.isNull(this.oldest_), 'oldest must not be null');
goog.asserts.assert(!goog.isNull(this.newest_), 'newest must not be null');
var entry = this.oldest_;
goog.asserts.assert(entry.key_ in this.entries_);
goog.asserts.assert(entry.key_ in this.entries_,
'oldest is indexed in entries');
delete this.entries_[entry.key_];
if (!goog.isNull(entry.newer)) {
entry.newer.older = null;
@@ -220,8 +231,10 @@ ol.structs.LRUCache.prototype.pop = function() {
* @param {T} value Value.
*/
ol.structs.LRUCache.prototype.set = function(key, value) {
goog.asserts.assert(!(key in {}));
goog.asserts.assert(!(key in this.entries_));
goog.asserts.assert(!(key in {}),
'key is not a standard property of objects (e.g. "__proto__")');
goog.asserts.assert(!(key in this.entries_),
'key is not used already');
var entry = {
key_: key,
newer: null,

View File

@@ -63,7 +63,7 @@ ol.structs.PriorityQueue.DROP = Infinity;
/**
* FIXME empty desciption for jsdoc
* FIXME empty description for jsdoc
*/
ol.structs.PriorityQueue.prototype.assertValid = function() {
var elements = this.elements_;
@@ -73,8 +73,12 @@ ol.structs.PriorityQueue.prototype.assertValid = function() {
var i, priority;
for (i = 0; i < (n >> 1) - 1; ++i) {
priority = priorities[i];
goog.asserts.assert(priority <= priorities[this.getLeftChildIndex_(i)]);
goog.asserts.assert(priority <= priorities[this.getRightChildIndex_(i)]);
goog.asserts.assert(priority <= priorities[this.getLeftChildIndex_(i)],
'priority smaller than or equal to priority of left child (%s <= %s)',
priority, priorities[this.getLeftChildIndex_(i)]);
goog.asserts.assert(priority <= priorities[this.getRightChildIndex_(i)],
'priority smaller than or equal to priority of right child (%s <= %s)',
priority, priorities[this.getRightChildIndex_(i)]);
}
};
@@ -95,7 +99,8 @@ ol.structs.PriorityQueue.prototype.clear = function() {
*/
ol.structs.PriorityQueue.prototype.dequeue = function() {
var elements = this.elements_;
goog.asserts.assert(elements.length > 0);
goog.asserts.assert(elements.length > 0,
'must have elements in order to be able to dequeue');
var priorities = this.priorities_;
var element = elements[0];
if (elements.length == 1) {
@@ -107,7 +112,8 @@ ol.structs.PriorityQueue.prototype.dequeue = function() {
this.siftUp_(0);
}
var elementKey = this.keyFunction_(element);
goog.asserts.assert(elementKey in this.queuedElements_);
goog.asserts.assert(elementKey in this.queuedElements_,
'key %s is not listed as queued', elementKey);
delete this.queuedElements_[elementKey];
return element;
};
@@ -118,7 +124,8 @@ ol.structs.PriorityQueue.prototype.dequeue = function() {
* @param {T} element Element.
*/
ol.structs.PriorityQueue.prototype.enqueue = function(element) {
goog.asserts.assert(!(this.keyFunction_(element) in this.queuedElements_));
goog.asserts.assert(!(this.keyFunction_(element) in this.queuedElements_),
'key %s is already listed as queued', this.keyFunction_(element));
var priority = this.priorityFunction_(element);
if (priority != ol.structs.PriorityQueue.DROP) {
this.elements_.push(element);

View File

@@ -61,7 +61,8 @@ ol.structs.RBush.prototype.insert = function(extent, value) {
this.rbush_.insert(item);
// remember the object that was added to the internal rbush
goog.asserts.assert(
!goog.object.containsKey(this.items_, goog.getUid(value)));
!goog.object.containsKey(this.items_, goog.getUid(value)),
'uid (%s) of value (%s) already exists', goog.getUid(value), value);
this.items_[goog.getUid(value)] = item;
};
@@ -75,7 +76,9 @@ ol.structs.RBush.prototype.load = function(extents, values) {
if (goog.DEBUG && this.readers_) {
throw new Error('Can not insert values while reading');
}
goog.asserts.assert(extents.length === values.length);
goog.asserts.assert(extents.length === values.length,
'extens and values must have same length (%s === %s)',
extents.length, values.length);
var items = new Array(values.length);
for (var i = 0, l = values.length; i < l; i++) {
@@ -91,7 +94,8 @@ ol.structs.RBush.prototype.load = function(extents, values) {
];
items[i] = item;
goog.asserts.assert(
!goog.object.containsKey(this.items_, goog.getUid(value)));
!goog.object.containsKey(this.items_, goog.getUid(value)),
'uid (%s) of value (%s) already exists', goog.getUid(value), value);
this.items_[goog.getUid(value)] = item;
}
this.rbush_.load(items);
@@ -108,7 +112,8 @@ ol.structs.RBush.prototype.remove = function(value) {
throw new Error('Can not remove value while reading');
}
var uid = goog.getUid(value);
goog.asserts.assert(goog.object.containsKey(this.items_, uid));
goog.asserts.assert(goog.object.containsKey(this.items_, uid),
'uid (%s) of value (%s) does not exist', uid, value);
// get the object in which the value was wrapped when adding to the
// internal rbush. then use that object to do the removal.
@@ -125,7 +130,8 @@ ol.structs.RBush.prototype.remove = function(value) {
*/
ol.structs.RBush.prototype.update = function(extent, value) {
var uid = goog.getUid(value);
goog.asserts.assert(goog.object.containsKey(this.items_, uid));
goog.asserts.assert(goog.object.containsKey(this.items_, uid),
'uid (%s) of value (%s) does not exist', uid, value);
var item = this.items_[uid];
if (!ol.extent.equals(item.slice(0, 4), extent)) {