pb-mongoose-middleware/test/lib/keyword.js

Middleware for mongoose that makes filtering, sorting, pagination and projection chainable and simple to apply

var
	chai = require('chai'),
	should = chai.should();


describe('keyword', function () {
	'use strict';

	var
		keywordLib = null,
		mongoose = require('mongoose'),
		orClauseItems = [];

	var Kitteh = mongoose.model('kittehs-keyword', new mongoose.Schema({
		birthday : { type : Date, default : Date.now },
		features : {
			color : String,
			isFurreh : Boolean
		},
		isDead: Boolean,
		home : String,
		name : String,
		peePatches : [String]
	}));

	before(function () {
		keywordLib = require('../../lib/keyword')(mongoose);

		mongoose.Query.prototype.or = function (clause) {
			if (clause) {
				orClauseItems.push(clause);
			}
		};
	});

	beforeEach(function () {
		orClauseItems = [];
	});

	it ('should return a query when created', function () {
		var query = Kitteh
			.find()
			.keyword(null);

		(query instanceof mongoose.Query).should.equals(true);
	});

	it ('should not filter if there are no fields specified', function () {
		var options = {
			filters : {
				keyword : {
					fields : null,
					term : 'cat'
				}
			}
		};

		var query = Kitteh
			.find()
			.keyword(options);

		should.exist(query);
		orClauseItems.should.have.length(0);
	});

	it ('should apply search of keyword to specified fields', function () {
		var options = {
			filters : {
				keyword : {
					fields : ['name', 'features.color', 'home'],
					term : 'cat'
				}
			}
		};

		var query = Kitteh
			.find()
			.keyword(options);

		should.exist(query);
		orClauseItems[0].should.have.length(3);
		orClauseItems[0][0].name.test('cat').should.equals(true);
		orClauseItems[0][0].name.test('spec-cat-acular').should.equals(true);
	});

	it ('should search matches in arrays when a property within a schema is an array', function () {
		var options = {
			filters : {
				keyword : {
					fields : ['name', 'peePatches'],
					term : 'lawn'
				}
			}
		};

		var query = Kitteh
			.find()
			.keyword(options);

		should.exist(query);
		orClauseItems[0].should.have.length(2);
		orClauseItems[0][1].peePatches.$in.should.exist();
	});

	it ('should search for keyword occurrences with multiple words', function () {
		var options = {
			filters : {
				keyword : {
					fields : ['name', 'features.color', 'home'],
					term : 'ceiling cat'
				}
			}
		};

		var query = Kitteh
			.find()
			.keyword(options);

		should.exist(query);
		orClauseItems[0].should.have.length(3);
		orClauseItems[0][0].name.test('floor cat').should.equals(false);
		orClauseItems[0][0].name.test('cat ceiling').should.equals(true);
		orClauseItems[0][0].name.test('ceilings are not for cats').should.equals(true);
	});

	it ('should search for exact match of multiple word keywords enclosed in quotes', function () {
		var options = {
			filters : {
				keyword : {
					fields : ['name', 'features.color', 'home'],
					term : '"ceiling cat"'
				}
			}
		};

		var query = Kitteh
			.find()
			.keyword(options);

		should.exist(query);
		orClauseItems[0].should.have.length(3);
		orClauseItems[0][0].name.test('floor cat').should.equals(false);
		orClauseItems[0][0].name.test('cat ceiling').should.equals(false);
		orClauseItems[0][0].name.test('ceilings are not for cats').should.equals(false);
		orClauseItems[0][0].name.test('does ceiling cat exist?').should.equals(true);
	});
});