wecatch / ember-easy-orm

A easy ORM for ember app, simple and flexible

Ember-easy-orm

Docs

This Ember addon support some basic model layer for ajax request like find, create, delete and so on. When you use this addon, please remove ember-data. It also support some mixin for component to easily manage form

Getting Started

Install

In your ember-cli project, install this addon from npm

ember install ember-easy-orm

or install the latest version from github

npm install https://github.com/wecatch/ember-easy-orm --save-dev

Use this addon in your ember application

In ember-cli project, create one model

ember g model user

modify model/user.js code like this

import EmberObject from '@ember/object';
import model, {DS} from 'ember-easy-orm/mixins/model'

const {attr} = DS;

export default EmberObject.extend(model, {
    url: '/v1/food',
    init(){
        this._super(...arguments);
        this.model = EmberObject.extend({
            'name': attr('string'),
            'desc': attr('string'),
            'pic': attr('array'),
            'province_id': attr('string'),
            'city_id': attr('string'),
            'area_id': attr('string'),
            'town_id': attr('string'),
            'country_id': attr('string'),
            'url': attr('string'),
            'host': attr('string'),
            'tag': attr('array'),
            'user': attr({defaultValue: function(){
                return {name: '', 'gender': ''};
            }})
        });
    }
})

then in any route, you can use store service to connect to your backend server api

import Route from '@ember/routing/route';

import { inject as service } from '@ember/service';

export default class IndexRoute extends Route {
  @service store;

  model() {
    return this.store.find('user');
  }
}

Running Tests

ember test
ember test --server

npm test (Runs ember try:testall to test your addon against multiple Ember versions)

Store service api

• find
• findOne
• save
• createRecord
• deleteRecord
• ajax
• request.get
• request.post
• request.put
• request.delete

Release notes

1.0.1

• Model add glimmer tracked for template rerender

1.0.0

• Rewrite to native class
• Bump to 4.3

0.2.0

• Bump ember-cli to 3.21.0

0.1.1

• Serialize request data into json when use post and put method

0.1.0

• Bump ember-cli to 3.1.0

0.0.9

• Replace sendAction with normal function call.
• Bump ember-cli to 2.3.0

0.0.8

• fix #19

0.0.7

2016-06-01

• add docs
• add dummy app

0.0.5

2016-01-08

• fix issues#11

0.0.4

2016-01-06

• add ajax mixin to support lower level ajax request
• add ajax, model unit test
• redesign model mixin for custome response data
• more flexible model api

0.0.2

2015-10-21

• fix form mixin to support component
• fix all model mixin ajax request to return promise

ember-easy-orm's Issues

mixins model find do not resolve correct result data

Ember which verison > 2.3 use getOwner to get appInstance

see http://emberjs.com/blog/2016/01/15/ember-2-3-released.html

ajax do not support contentType json

        if (ajaxSettings.contentType == 'application/json' && ajaxSettings['data'] && (method == "post" || method ==="put")){
            ajaxSettings['data'] = JSON.stringify(ajaxSettings['data']);
        }

formComponent delete data model, must notice godForm component which model is removed

当formComponent 组件的model 被删除的时候需要通知godForm 哪个model 被删除了

ajax mixin add request Event: start, stop, error, RESTSerializerError

when model attribute is mutable like array or object, create record must recreate these mutable attributes

model 的属性如果是可变对象，创建 model 实例必须要对所有属性进行重新实例化

godForm add new user action

mode mixin add DS for model attribute

model mixni add DS for model attribute type create

后端返回数据，不能直接 Object.create, 因为有可能返回不是对象

后端假如返回 {res: {status: 1}}, Object.create 本身拿到的 status 并不是对象 #8

godForm mixin init check modelName invalid lead to Component instance error

godForm minxin 校验 modelName 的时机不对导致 Component 无法正常初始化

formComponent save action callback success make difference update and create

formComponent mixin save action 回掉 success 区分update 和 create 操作

when model has object attribute, stringify submodel as json to pass to backend server

model object 类型的属性时, 序列化属性为 json 串, 传到后端, 形如:

export default Ember.Object.extend(model, {
    url: '/v1/shop',
    model: {
        'address':      attr('string'),
        'longitude':    attr('number'),
        'latitude':     attr('number'),
        'url':          attr('string'),
        'user':     attr('object', {defaultValue: function(){
            return Ember.Object.create({'name': '', 'gender': 'f'});   
        }}),
    }
});

user 为object, 表单提交时, 序列化 user

array content contains object

数组内容包含object，需要对object 进行序列化

            if(Ember.isArray(model[key])){
                for (let i = 0; i < model[key].length; i++) {
                    if(typeof model[key][i] === 'object' && model[key][i]){
                        model[key][i] = JSON.stringify(model[key][i]);
                    }
                }
            }

model support multi rootKey allow response data to resolve multi level data

{
"wallpaper":[]
"user":[]
}

Ember.isEmpty(object) return true bug

godForm Ember.isEmpty(selectedItem) return true

formComponent 和 godComponent 交互进行数据管理

formComponent 代表一条数据单元，godForm 代表一组数据单元， 二者配合完成数据的增，删，改。

当数据发生更改，formComponent 需要通知使用它的上层，发生了什么动作，后端的响应结果如何，此时，formComponent 需要向上层传递后端响应结果和发生改变的 model，上层根据响应结果，动作和发生变化的 model 进行相应处理

model need some custom api to do something special

store createRecord can init object property value

store createRecord 初始化对象属性

ajax mixin request.parent pointe to final init object

request parent 是可变对象，所有的实例都持有该request对象，导致 parent 指向最后一次实例化的对象

mixins model findOne do not resolve response data