lateralus.model.js

  1. import _ from 'lodash-compat';
  2. import Backbone from 'backbone';
  3. import mixins from './lateralus.mixins';
  5. const fn = {};
  7. // jshint maxlen:100
  8. /**
  9.  * @private
  10.  * @param {Lateralus} lateralus
  11.  * @param {Object} [attributes]
  12.  * @param {Object} [options]
  13.  * @mixes Lateralus.mixins
  14.  * @constructs Lateralus.Model
  15.  */
  16. fn.constructor = function (lateralus, attributes, options) {
  17.   /**
  18.    * A reference to the central {@link Lateralus} instance.
  19.    * @member Lateralus.Model#lateralus
  20.    * @type {Lateralus}
  21.    * @final
  22.    */
  23.   this.lateralus = lateralus;
  24.   this.delegateLateralusEvents();
  25.   this.on('change', _.bind(this.onChange, this));
  26.   Backbone.Model.call(this, attributes, options);
  27. };
  29. /**
  30.  * For every key that is changed on this model, a corresponding `change:` event
  31.  * is `{@link Lateralus.mixins#emit}`ed.  For example, `set`ting the `"foo"`
  32.  * attribute will `{@link Lateralus.mixins#emit}` `"change:foo"` and provide
  33.  * the changed value.
  34.  * @method Lateralus.Model#onChange
  35.  */
  36. fn.onChange = function () {
  37.   const changed = this.changedAttributes();
  39.   _.each(_.keys(changed), (changedKey) => {
  40.     this.emit('change:' + changedKey, changed[changedKey]);
  42.     // Delete this property from the internal "changed" object before
  43.     // Backbone typically would to prevent "stacking" changed properties
  44.     // across onChange calls, thereby causing redundant handler calls.
  45.     delete this.changed[changedKey];
  46.   });
  48. };
  50. _.extend(fn, mixins);
  52. /**
  53.  * This class builds on the ideas and APIs of
  54.  * [`Backbone.Model`](http://backbonejs.org/#Model).  The constructor for
  55.  * this class should not be called by application code, it is used by the
  56.  * `{@link Lateralus}` constructor.
  57.  * @extends Backbone.Model
  58.  * @class Lateralus.Model
  59.  */
  60. const LateralusModel = Backbone.Model.extend(fn);
  62. /**
  63.  * @method Lateralus.Model#toString
  64.  * @return {string} The name of this Model.  This is used internally by
  65.  * Lateralus.
  66.  */
  67. LateralusModel.prototype.toString = function () {
  68.   return this.lateralus.toString() + '-model';
  69. };
  71. export default LateralusModel;