All files / mvc model.js

98.82% Statements 84/85
90% Branches 36/40
100% Functions 17/17
98.82% Lines 84/85

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293                                                                                    1x 1x 1x 1x 1x     1x   1x 109x     109x 109x 109x 2x   107x   107x 107x 3x     107x 102x 102x 102x       1x 57x 57x 4x 53x 53x     57x 57x 4x     57x     1x 6x 6x     1x                                                                                           36x 36x 36x 36x 36x   36x 36x 36x 36x                   36x 36x 36x                   39x 39x 39x 39x 39x                     2x   1x     1x     2x                     114x 66x 69x 69x   48x 40x   114x 67x 67x                           58x 55x 1x   54x   3x 3x 3x 3x   3x                     15x                   1x 1x                 4x 4x                   3x 3x 3x 3x 3x       1x  
/**
 * 模型类: 基础工厂元件类,用于做数据包装,提供可观察的数据对象
 * - 继承自 [mvc/base](#mvc-base)
 * @module mvc/Model
 * @param {Object} [options] 初始数据
 * @example
 * var $model = require('@spore-ui/kit/packages/mvc/model');
 *
 * var m1 = new $model({
 *   a : 1
 * });
 * m1.on('change:a', function(prevA){
 *   console.info(prevA); // 1
 * });
 * m1.on('change', function(){
 *   console.info('model changed');
 * });
 * m1.set('a', 2);
 *
 * var MyModel = Model.extend({
 *   defaults : {
 *     a : 2,
 *     b : 2
 *   },
 *   events : {
 *     'change:a' : 'updateB'
 *   },
 *   updateB : function(){
 *     this.set('b', this.get('a') + 1);
 *   }
 * });
 *
 * var m2 = new MyModel();
 * console.info(m2.get('b')); // 2
 *
 * m2.set('a', 3);
 * console.info(m2.get('b')); // 4
 *
 * m2.set('b', 5);
 * console.info(m2.get('b')); // 5
 */
 
var $assign = require('../obj/assign');
var $type = require('../obj/type');
var $cloneDeep = require('../obj/cloneDeep');
var $base = require('./base');
var $delegate = require('./delegate');
 
// 数据属性名称
var DATA = '__data__';
 
var setAttr = function (key, value) {
  Iif (typeof key !== 'string') {
    return;
  }
  var that = this;
  var data = this[DATA];
  if (!data) {
    return;
  }
  var prevValue = data[key];
 
  var processor = this.processors[key];
  if (processor && $type(processor.set) === 'function') {
    value = processor.set(value);
  }
 
  if (value !== prevValue) {
    data[key] = value;
    that.changed = true;
    that.trigger('change:' + key, prevValue);
  }
};
 
var getAttr = function (key) {
  var value = this[DATA][key];
  if ($type(value) === 'object') {
    value = $cloneDeep(value);
  } else Eif ($type(value === 'array')) {
    value = $cloneDeep(value);
  }
 
  var processor = this.processors[key];
  if (processor && $type(processor.get) === 'function') {
    value = processor.get(value);
  }
 
  return value;
};
 
var removeAttr = function (key) {
  delete this[DATA][key];
  this.trigger('change:' + key);
};
 
var Model = $base.extend({
 
  /**
   * 模型的默认数据
   * - 绑定在原型上,不要在实例中直接修改这个对象。
   * @name Model#defaults
   * @type {Object}
   * @memberof mvc/Model
   */
  defaults: {},
 
  /**
   * 模型的事件绑定列表。
   * - 绑定在原型上,不要在实例中直接修改这个对象。
   * - 尽量在 events 对象定义属性关联事件。
   * - 事件应当仅用于自身属性的关联运算。
   * - 事件绑定格式可以为:
   * - {'event':'method'}
   * - {'event':'method1 method2'}
   * @name Model#events
   * @type {Object}
   * @memberof mvc/Model
   */
  events: {},
 
  /**
   * 模型数据的预处理器。
   * - 绑定在原型上,不要在实例中直接修改这个对象。
   * @name Model#processors
   * @type {Object}
   * @memberof mvc/Model
   * @example
   * processors : {
   *   name : {
   *     set : function(value){
   *       return value;
   *     },
   *     get : function(value){
   *       return value;
   *     }
   *   }
   * }
   */
  processors: {},
 
  initialize: function (options) {
    this[DATA] = {};
    this.defaults = $assign({}, this.defaults);
    this.events = $assign({}, this.events);
    this.processors = $assign({}, this.processors);
    this.changed = false;
 
    this.build();
    this.delegate('on');
    this.setEvents('on');
    this.setOptions(options);
  },
 
  /**
   * 深度混合传入的选项与默认选项,然后混合到数据对象中
   * @method Model#setOptions
   * @memberof mvc/Model
   * @param {Object} [options] 选项
   */
  setOptions: function (options) {
    this.set(this.defaults);
    this.supr(options);
    this.set(options);
  },
 
  /**
   * 绑定 events 对象列举的事件。在初始化时自动执行了 this.delegate('on')。
   * @method Model#delegate
   * @memberof mvc/Model
   * @param {String} [action='on'] 绑定动作标记。可选:['on', 'off']
   */
  delegate: function (action, root, events, bind) {
    action = action || 'on';
    root = root || this;
    events = events || this.events;
    bind = bind || this;
    $delegate(action, root, events, bind);
  },
 
  /**
   * 数据预处理
   * @method Model#process
   * @memberof mvc/Model
   * @param {String} key 模型属性名称。或者JSON数据。
   * @param {*} [val] 数据
   */
  process: function (name, spec) {
    spec = $assign({
      set: function (value) {
        return value;
      },
      get: function (value) {
        return value;
      },
    }, spec);
    this.processors[name] = spec;
  },
 
  /**
   * 设置模型数据
   * @method Model#set
   * @memberof mvc/Model
   * @param {String|Object} key 模型属性名称。或者JSON数据。
   * @param {*} [val] 数据
   */
  set: function (key, val) {
    if ($type(key) === 'object') {
      Object.keys(key).forEach(function (k) {
        var v = key[k];
        setAttr.call(this, k, v);
      }.bind(this));
    } else if (typeof key === 'string') {
      setAttr.call(this, key, val);
    }
    if (this.changed) {
      this.trigger('change');
      this.changed = false;
    }
  },
 
  /**
   * 获取模型对应属性的值的拷贝
   * - 如果不传参数,则直接获取整个模型数据。
   * - 如果值是一个对象,则该对象会被深拷贝。
   * @method Model#get
   * @memberof mvc/Model
   * @param {String} [key] 模型属性名称。
   * @returns {*} 属性名称对应的值
   */
  get: function (key) {
    if (typeof key === 'string') {
      if (!this[DATA]) {
        return;
      }
      return getAttr.call(this, key);
    }
    Eif (typeof key === 'undefined') {
      var data = {};
      this.keys().forEach(function (k) {
        data[k] = getAttr.call(this, k);
      }.bind(this));
      return data;
    }
  },
 
  /**
   * 获取模型上设置的所有键名
   * @method Model#keys
   * @memberof mvc/Model
   * @returns {Array} 属性名称列表
   */
  keys: function () {
    return Object.keys(this[DATA] || {});
  },
 
  /**
   * 删除模型上的一个键
   * @method Model#remove
   * @memberof mvc/Model
   * @param {String} key 属性名称。
   */
  remove: function (key) {
    removeAttr.call(this, key);
    this.trigger('change');
  },
 
  /**
   * 清除模型中所有数据
   * @method Model#clear
   * @memberof mvc/Model
   */
  clear: function () {
    Object.keys(this[DATA]).forEach(removeAttr, this);
    this.trigger('change');
  },
 
  /**
   * 销毁模型,不会触发任何change事件。
   * - 模型销毁后,无法再设置任何数据。
   * @method Model#destroy
   * @memberof mvc/Model
   */
  destroy: function () {
    this.changed = false;
    this.delegate('off');
    this.supr();
    this.clear();
    this[DATA] = null;
  },
});
 
module.exports = Model;