resourceful/test/couchdb-filter-test.js

an isomorphic Resource engine for JavaScript

var assert = require('assert'),
    events = require('events'),
    cradle = require('cradle'),
    vows = require('vows'),
    resourceful = require('../lib/resourceful');

var Article;

resourceful.env = 'test';

var couch = require('./engines/couchdb');

vows.describe('resourceful/resource/view').addBatch({
  "A database containing articles and other resources": {
    topic: function () {
      resourceful.use(couch.name, couch.options);
      couch.load(resourceful, [
        { _id: 'article/1', resource: 'Article', title: 'The Great Gatsby', published: true,  author: 'fitzgerald', tags: ['classic'] },
        { _id: 'article/2', resource: 'Article', title: 'Finding vim',      published: false, author: 'cloudhead',  tags: ['hacking', 'vi'] },
        { _id: 'article/3', resource: 'Article', title: 'On Writing',       published: true,  author: 'cloudhead',  tags: ['writing'] },
        { _id: 'article/4', resource: 'Article', title: 'vi Zen',           published: false, author: 'cloudhead',  tags: ['vi', 'zen'] },
        { _id: 'article/5', resource: 'Article', title: 'Channeling force', published: true,  author: 'yoda',       tags: ['force', 'zen'] },
      ], this.callback);
    },
    "is created": function () {},
    "A Resource definition with filters": {
      topic: function () {
        Article = resourceful.define('Article', function () {
          this.property('author');
          this.property('title');
          this.property('published', Boolean);

          this.filter('all', {});
          this.filter('published', { published: true });
          this.filter('by', function (author) { return { author: author } });
        })

        Article.register();
        return Article;
      },
      "should respond to the filters": function (R) {
        assert.isFunction(R.published);
        assert.isFunction(R.all);
        assert.isFunction(R.by);
      },
      "can be used to query the database:": {
        "<published>": {
          topic: function (Article) {
            this.Article = Article;
            Article.published(this.callback);
          },
          "should return an array of all published Articles": function (e, res) {
            var that = this;
            assert.isArray(res);
            assert.equal(res.length,3);
            res.forEach(function (d) {
              assert.isObject(d);
              assert.instanceOf(d,that.Article);
              assert.equal(d.constructor,that.Article);
              assert.equal(d.resource,'Article');
              assert.ok(d.published);
            });
          }
        },
        "<all>": {
          topic: function (Article) {
            Article.all(this.callback);
          },
          "should return an array of all Article records": function (e, res) {
            assert.isArray(res);
            assert.equal(res.length,5);
          }
        },
        "<by> 'cloudhead'": {
          topic: function (Article) {
            Article.by('cloudhead', this.callback);
          },
          "should return an array of Article records by 'cloudhead'": function (e, res) {
            assert.isArray(res);
            assert.equal(res.length,3);
            res.forEach(function (d) {
              assert.isObject(d);
              assert.equal(d.resource,'Article');
              assert.equal(d.author,'cloudhead');
            });
          }
        },
        "<by> 'yoda'": {
          topic: function (Article) {
            Article.by('yoda', this.callback);
          },
          "should return an array of Article records by 'yoda'": function (e, res) {
            assert.isArray(res);
            assert.equal(res.length,1);
            assert.equal(res[0].author,'yoda');
          }
        },
        "<by> ['yoda', 'fitzgerald']": {
          topic: function (Article) {
            Article.by({
              keys: ['yoda', 'fitzgerald']
            }, this.callback);
          },
          "should return an array of Article records by 'yoda' or 'fitzgerald'": function (e, res) {
            assert.isArray(res);
            assert.equal(res.length, 2);
            assert(
              (res[0].author === 'yoda' && res[1].author === 'fitzgerald') ||
              (res[0].author === 'fitzgerald' && res[1].author === 'yoda')
            );
          }
        }
      }
    }
  }
}).addBatch({
  "A second Resource definition with filters": {
    topic: function () {
      return resourceful.define('Person', function () {
        this.property('name');
        this.property('position');
        this.property('age', Number);

        this.filter('all', {});
        this.filter('at', function (position) { return { position: position } });
        this.filter('age', function (age) { return { age: age } });
      }).register();
    },
    "should have no side effects on the first resource views": function () {
      var views = Object.keys(Article.views);
      assert.isTrue(views.indexOf('at')===-1);
      assert.isTrue(views.indexOf('age')===-1);
    }
  }
}).export(module);