flux-store-factory

This is a simple module to generate generic flux stores. Someone has probably done this better... I found myself re-writing the same code for all of my stores so I created this library to keep things DRY.

The pivot method and dispatcher are passed as parameters. The pivot method is bound to a data access object so that the store's private elements can be accessed through "this." Specifically, create and destroy accept an identifier and can create, update or delete objects from the store.

The store exposes two methods to access the data in the store:

• get: fetches a single object by its identifier (or cid)

• query: takes a filter parameter and a sort parameter. Filter is an associative array of conditions that should be met and sort is an array of attributes by which to sort. Filters may be specified as equality (by default) or may use other comparators with the form {attribute: lt.5} where lt specifies the comparator and 5 parameterizes the filter. For now, the following operands are supported: eq, gt, lt, lte, gte, neq, startswith, contains.

The factory method takes an associative array of options as its only parameter. Presently, the following options are implemented:

• identifier: the name of the variable used as a primary id (probably assigned by the server). Only numeric ids will work because the store interperts ids like 'c123' as locally assigned ids

• dispatcher: the react dispacter instance that this store should listen to

• pivot: the method called by the dispatcher. This method is bound to a data access object which can be accessed through this. The data access object offers the following methods:

  • create: takes an object and creates or updates a record in the store. If a matching record (by identifier or cid) exists in the store then it is updated with the new object, otherwise a new record is created.
  • destroy: takes a single object and deletes any object in the store matching its identifier or cid
  • purge: takes a selector object and removes any objects in the store that match (uses the query method so any of the same operators work)

A typical implementation might look something like this:

var storeFactory = require('../storeFactory')
var myDispatcher = require('./path/to/dispatcher')

module.exports.ThingStore = storeFactory({
	identifier: 'thing_id',
	dispatcher: myDispatcher,
	pivot: function (payload) {
		switch (payload.actionType) {
			case 'THING_CREATE':
		    	this.create(payload.thing)
		    	this.emitChange()
		    	break

		    case 'THING_DESTROY':
		    	this.destroy(payload.thing)
		    	this.emitChange()
		    	break
		}
	}
})

Then the store can be queried like this:

// gets all the records with parent_id equal to 5
ThingStore.query({parent_id: "5"}) 

// this gets all the records with price <= 5.0
ThingStore.query({price: "lte.5.0"}) 

// this gets all the records with price <= 5.0 AND parent_id equal to 5, ordered by name
ThingStore.query({price: "lte.5.0", parent_id: "5"}, ['name'])