gitbookio / filterable Goto Github PK

Accept multi field as alias and convert it to an $or of the condition.

Hi

Is it possible currently to filter an array based on its objects inside.
What i want to achieve is a local filter option, every time you have some grid, doing individual filter boxes for multiple properties its tedious, having just one box to filter based on this syntax which is pretty easy could be great.

If not possible, can i create such a thing and do a PR

Thnx

I think before I continue work on PR #12 we should consider adding unit tests for FilterablePlugin. If you agree, I will submit a separate PR for this.

While working on a PR for issue #8 if found what I believe are inconstancies in the way some comparison operators are inverted. For example: >= inverts to <=, I posit it should invert to <. The way I see it >= is inclusive of the value its comparing, therefore the inverted operator should not, hence < and not <= (which does).

The following should be corrected:

If you agree I will submit a PR correcting this.

Add support for querying boolean queries using the is:xxx syntax. I propose something like the following:

var Filterable = require('filterable').Filterable;
var filterable = new Filterable({
  ...
  fields: {
    published: {
      type: Boolean
    },
    admin: {
      type: Boolean,
      alias: 'isAdmin'
    },
    gender: {
      type: String
    },
    male: {
      type: Boolean,
      query: 'gender:male'
    },
    female: {
      type: Boolean,
      query: 'gender:female'
    },
    age: {
      type: Number
    },
    minor: {
      type: Boolean,
      query: 'age:<18'
    },
  },
  ...
});

And .query() would yield:

filterable.query('is:published', function(err, query) {
    /*
    query.toMongo() == {
        "published": true
    }
    */
});

filterable.query("is:admin", function(err, query) {
    /*
    query.toMongo() == {
        "isAdmin": true
    }
    */
});

filterable.query('is:male', function(err, query) {
    /*
    query.toMongo() == {
        "gender": "male"
    }
    */
});

filterable.query('is:female', function(err, query) {
    /*
    query.toMongo() == {
        "gender": "female"
    }
    */
});

filterable.query('is:minor', function(err, query) {
    /*
    query.toMongo() == {
        "age": { "$lt": 18 }
    }
    */
});

The above is by no means an exhaustive description. If you're amenable to include this feature I would be willing to work on a PR.

This is my progress so far:

• refactor code to split groups into a reusable function
• implement "is:" operator in Query class
• add unit tests
• implement "is:" operator in FitlerablePlugin().
• update README

Current GROUP_DELIMITER regex does not support queries with escaped quotes inside:
label:"test \" test"

https://help.github.com/articles/search-syntax/#query-for-values-between-a-range