ember-redux-orm
v0.3.0
Published
Ember cli shim for redux-orm for building normalized orm data in your front-end ember app
Downloads
7
Maintainers
Readme
ember-redux-orm
Front-end ORM? Yes please! Read about redux-orm here: https://github.com/tommikaikkonen/redux-orm
If you're rolling ember-redux, consider using this as an alternative to ember-data
Usage
- Declare your models
ember generate orm-model taco filling:fk:protein toppings:many:topping eater:one:person name:string price:number misc
- Register them in a Schema
app/orm.js
import { ORM } from 'redux-orm';
import Taco from './orm-models/taco';
const orm = new ORM();
orm.register(Taco);
export default orm;
- Register your reducer
app/reducers/index.js
import orm from '../orm';
import { createReducer } from 'redux-orm';
import otherReducer from './other-reducer';
export default {
orm: createReducer(orm),
otherNamespace: otherReducer
};
- Write your selector
ember g orm-selector taco
import orm from '../orm';
import { createSelector } from 'redux-orm';
export const findAll = createSelector(orm, session => session.Taco.all());
export const find = (id) => (state) => orm.session(state).Taco.withId(id);
- Use your selector wherever it is you get getState
import { find } from '../orm-selectors/taco';
const { orm } = redux.getState();
const taco = find('34')(orm);
FAQ
Q: Do I really need an ORM? A: If your application has persistent state, then the answer is always yes
Q: But I already have an ORM in my back-end server, why do I need it in the front-end? A: Because ORMs make for stable and consistent software that will last. Just because it's already used elsewhere is no excuse to not use it again where it's appropriate, if anything, the fact it's already battle-tested is proof that it's good and should be reused
Q: What's wrong with ember-data A: Nothing, it just doesn't plug into redux very well due to its mutability and the fact it couples async IO with the ORM, which necessarily means they have to churn a lot as they work to iron out state-management bugs and an ever-dynamic API set
Q: Can this be used concurrently with ember-data
A: Yes, everything is appended with orm
for the purpose of avoiding collisons with ember-data's stuff
Q: What do I do for async IO? A: Use redux-thunk or redux-saga in conjunction with ajax. Use normalizr if you require data serialization / normalization from your upstream source
Installation
git clone <repository-url>
this repositorycd ember-redux-orm
npm install
bower install
Running
ember serve
- Visit your app at http://localhost:4200.
Running Tests
npm test
(Runsember try:each
to test your addon against multiple Ember versions)ember test
ember test --server
Building
ember build
For more information on using ember-cli, visit https://ember-cli.com/.