Collection and resource ID handling altered to be case-insensitive for issue #49.

lib/Collection.js

@@ -21,6 +21,11 @@ class Collection {
 			throw new TypeError('Provided class is not a function (constructor)');
 		}
 
+		// A Collection is case-insensitive by default.
+		// When a Collection is case-insensitive, all map keys are converted to lowercase before use.
+		// If being used with a case-sensitive app or router, caseSensitive will be set to true by setupRoutes.
+		this.caseSensitive = false;
+
 		this.map = {};
 		this.Class = Class;
 		this.lastModified = Date.now();
@@ -76,10 +81,16 @@ class Collection {
 	}
 
 	has(id) {
+		if (!this.caseSensitive) {
+			id = id.toLowerCase();
+		}
 		return this.map.hasOwnProperty(id);
 	}
 
 	get(id) {
+		if (!this.caseSensitive) {
+			id = id.toLowerCase();
+		}
 		return this.map[id];
 	}
 
@@ -108,6 +119,9 @@ class Collection {
 	}
 
 	set(id, resource, cb) {
+		if (!this.caseSensitive) {
+			id = id.toLowerCase();
+		}
 		const previous = this.map[id];
 		this.map[id] = resource;
 
@@ -133,6 +147,16 @@ class Collection {
 
 	setAll(resources, cb) {
 		const previous = this.map;
+		if (!this.caseSensitive) {
+			// Lowercase all keys in the new resource set.
+			const lowercasedResources = {};
+			for (const key in resources) {
+				if (resources.hasOwnProperty(key)) {
+					lowercasedResources[key.toLowerCase()] = resources[key];
+				}
+			}
+			resources = lowercasedResources;
+		}
 		this.map = resources;
 
 		this.save(this.getIds(), (error) => {
@@ -149,6 +173,9 @@ class Collection {
 	}
 
 	del(id, cb) {
+		if (!this.caseSensitive) {
+			id = id.toLowerCase();
+		}
 		const previous = this.get(id);
 
 		if (!previous) {
@@ -351,6 +378,15 @@ class Collection {
 			};
 		}
 	}
+
+	getCaseSensitive() {
+		return this.caseSensitive;
+	}
+
+	setCaseSensitive(caseSensitive) {
+		// caseSensitive is retained as a Boolean value with value = truthiness of parameter
+		this.caseSensitive = caseSensitive;
+	}
 }
 
 

lib/operations/collection/get.js

@@ -145,6 +145,14 @@ module.exports = function (collection, context, cb) {
 	const fn = context.createCustomFn('get', collection.Class);
 	const map = collection.getMapRef();
 
+	if (!collection.getCaseSensitive()) {
+		for (const clause in context.query) {
+			if (context.query.hasOwnProperty(clause)) {
+				context.query[clause] = context.query[clause].toLowerCase();
+			}
+		}
+	}
+
 	const properties = getProperties(context.query);
 	const propertyStatus = validateProperties(map, properties);
 	if (propertyStatus >= 400) {

lib/setupRoutes.js

@@ -81,9 +81,26 @@ function respond(context) {
 // route handlers
 
 module.exports = function setupRoutes(router, collection, path, rights) {
-	// Set up a regular expression for the given path and optionally allow extensions
-
-	const reCollection = new RegExp('^' + path + '(\\.[a-zA-Z]+)?/?$');
+	// When router is a Router, router.caseSensitive will yield true or false,
+	// but when router is a base Express application, it will always yield undefined.
+	const routerCaseSensitive = router.caseSensitive;
+
+	// When router is a Router, router.get('case sensitive routing') will yield a function,
+	// but when router is a base Express application, it will yield true, false or undefined.
+	const appCaseSensitiveRoutingSetting = router.get('case sensitive routing');
+	const appCaseSensitive = (typeof appCaseSensitiveRoutingSetting !== 'function' && appCaseSensitiveRoutingSetting);
+
+	// Set up a regular expression for the given path and optionally allow extensions.
+	// Also, set the collection's case sensitivity to match the app/router's case sensitivity,
+	// since this is one of the only places we currently have all this information together.
+	let reCollection;
+	if (appCaseSensitive || routerCaseSensitive) {
+		reCollection = new RegExp('^' + path + '(\\.[a-zA-Z]+)?/?$');
+		collection.setCaseSensitive(true);
+	} else {
+		reCollection = new RegExp('^' + path + '(\\.[a-z]+)?/?$', 'i');
+		collection.setCaseSensitive(false);
+	}
 
 	// GET all resources in the collection
 

test/cache.js

@@ -20,8 +20,8 @@ test('HTTP cache', function (t) {
 			collection = _collection;
 			http = _http;
 
-			collection.loadOne('Heineken', heineken);
-			heineken.id = 'Heineken';
+			collection.loadOne('heineken', heineken);
+			heineken.id = 'heineken';
 
 			t.end();
 		});
@@ -48,7 +48,7 @@ test('HTTP cache', function (t) {
 
 			t.equal(res.statusCode, 200, 'HTTP status 200 (OK)');
 			t.equal(res.headers['content-type'], 'application/json', 'JSON response');
-			t.deepEqual(data, { Heineken: heineken }, 'Heineken returned');
+			t.deepEqual(data, { heineken }, 'Heineken returned');
 			t.end();
 		});
 	});