rasti 1.1.1 → 2.0.0-alpha.0

package/es/Model.js

@@ -1,154 +1,140 @@
-function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
-
-function _possibleConstructorReturn(self, call) { if (!self) { throw new ReferenceError("this hasn't been initialised - super() hasn't been called"); } return call && (typeof call === "object" || typeof call === "function") ? call : self; }
-
-function _inherits(subClass, superClass) { if (typeof superClass !== "function" && superClass !== null) { throw new TypeError("Super expression must either be null or a function, not " + typeof superClass); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, enumerable: false, writable: true, configurable: true } }); if (superClass) Object.setPrototypeOf ? Object.setPrototypeOf(subClass, superClass) : subClass.__proto__ = superClass; }
-
+function _assertThisInitialized(self) { if (self === void 0) { throw new ReferenceError("this hasn't been initialised - super() hasn't been called"); } return self; }
+function _inheritsLoose(subClass, superClass) { subClass.prototype = Object.create(superClass.prototype); subClass.prototype.constructor = subClass; _setPrototypeOf(subClass, superClass); }
+function _setPrototypeOf(o, p) { _setPrototypeOf = Object.setPrototypeOf ? Object.setPrototypeOf.bind() : function _setPrototypeOf(o, p) { o.__proto__ = p; return o; }; return _setPrototypeOf(o, p); }
 import Emitter from './Emitter';
 /**
  * - Orchestrates data and business logic.
  * - Emits events when data changes.
  * 
- * A Model manages an internal table of data attributes, and triggers "change" events 
- * when any of its data is modified.<br />
- * Models may handle syncing data with a persistence layer.<br />
- * Design your models as the atomic reusable objects containing all of the helpful functions for 
- * manipulating their particular bit of data.<br /> 
- * Models should be able to be passed around throughout your app, and used anywhere that bit of data is needed.<br />
- * Rasti Models stores its attributes in `this.attributes`, which is extended from `this.defaults` and constructor `attrs` parameter.
- * For every attribute, a getter is generated, which retrieve the model property from `this.attributes`.
- * And a setter, which sets the model property in `this.attributes` and emits `change` and `change:attribute` events.
+ * A `Model` manages an internal table of data attributes and triggers change events when any of its data is modified.<br />
+ * Models may handle syncing data with a persistence layer. To design your models, create atomic, reusable objects 
+ * that contain all the necessary functions for manipulating their specific data.<br />
+ * Models should be easily passed throughout your app and used anywhere the corresponding data is needed.<br />
+ * Rasti models stores its attributes in `this.attributes`, which is extended from `this.defaults` and the 
+ * constructor `attrs` parameter. For every attribute, a getter is generated to retrieve the model property 
+ * from `this.attributes`, and a setter is created to set the model property in `this.attributes` and emit `change` 
+ * and `change:attribute` events.
  * @module
  * @param {object} attrs Object containing model attributes to extend `this.attributes`. Getters and setters are generated for `this.attributtes`, in order to emit `change` events.
  * @example
- * // Todo model
- * class TodoModel extends Rasti.Model {
- *     toggle() {
- *         // Set completed property. This will call a setter that will set `completed` 
- *         // in this.attributes, and emit `change` and `change:completed` events.
- *         this.completed = !this.completed; 
+ * import { Model } from 'rasti';
+ * // Product model
+ * class ProductModel extends Model {
+ *     preinitialize() {
+ *         // The Product model has `name` and `price` default attributes.
+ *         // `defaults` will extend `this.attributes`.
+ *         // Getters and setters are generated for `this.attributes`,
+ *         // in order to emit `change` events.
+ *         this.defaults = {
+ *             name: '',
+ *             price: 0
+ *         };
+ *     }
+ *
+ *     setDiscount(discountPercentage) {
+ *         // Apply a discount to the price property.
+ *         // This will call a setter that will update `price` in `this.attributes`,
+ *         // and emit `change` and `change:price` events.
+ *         const discount = this.price * (discountPercentage / 100);
+ *         this.price -= discount;
  *     }
  * }
- * // Todo model has `title` and `completed` default attributes. `defaults` will extend `this.attributes`. Getters and setters are generated for `this.attributtes`, in order to emit `change` events.
- * TodoModel.prototype.defaults = {
- *     title : '',
- *     completed : false
- * };
- * // Create todo. Pass `title` attribute as argument.
- * const todo = new TodoModel({ title : 'Learn Rasti' });
- * // Listen to `change:completed` event.
- * todo.on('change:completed', () => console.log('Completed:', todo.completed));
- * // Complete todo.
- * todo.toggle(); // Completed: true
+ * // Create a product instance with a name and price.
+ * const product = new ProductModel({ name: 'Smartphone', price: 1000 });
+ * // Listen to the `change:price` event.
+ * product.on('change:price', () => console.log('New Price:', product.price));
+ * // Apply a 10% discount to the product.
+ * product.setDiscount(10); // Output: "New Price: 900"
  */
-
-var Model = function (_Emitter) {
-    _inherits(Model, _Emitter);
-
-    function Model() {
-        var attrs = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-
-        _classCallCheck(this, Model);
-
-        // Call preinitialize.
-        var _this = _possibleConstructorReturn(this, _Emitter.call(this));
-
-        _this.preinitialize.apply(_this, arguments);
-        // attributes object.
-        _this.attributes = Object.assign({}, _this.defaults || {}, attrs);
-        // Previous attributes.
-        _this.previous = {};
-        // Generate getters/setters for every attr.
-        Object.keys(_this.attributes).forEach(_this.defineAttribute.bind(_this));
-        return _this;
-    }
-
-    /**
-     * If you define a preinitialize method, it will be invoked when the Model is first created, before any instantiation logic is run for the Model.
-     * @param {object} attrs Object containing model attributes to extend `this.attributes`.
-     */
-
-
-    Model.prototype.preinitialize = function preinitialize() {};
-
-    /**
-     * Generate getter/setter for the given key. In order to emit `change` events.
-     * This method is called internally by the constructor
-     * for `this.attributes`.
-     * @param {string} key Attribute key.
-     */
-
-
-    Model.prototype.defineAttribute = function defineAttribute(key) {
-        var _this2 = this;
-
-        Object.defineProperty(this, key, {
-            get: function get() {
-                return _this2.get(key);
-            },
-            set: function set(value) {
-                _this2.set(key, value);
-            }
-        });
-    };
-
-    /**
-     * Get an attribute from `this.attributes`.
-     * This method is called internally by generated getters.
-     * @param {string} key Attribute key.
-     * @return {any} The attribute value.
-     */
-
-
-    Model.prototype.get = function get(key) {
-        return this.attributes[key];
-    };
-
-    /**
-     * Set an attribute into `this.attributes`.
-     * Emit `change` and `change:attribute` if value change.
-     * Could be called in two forms, `this.set('key', value)` and
-     * `this.set({ key : value })`.
-     * This method is called internally by generated setters.
-     * @param {string} key Attribute key or object containing keys/values.
-     * @param [value] Attribute value.
-     * @return {this} This model.
-     * @emits change
-     * @emits change:attribute
-     */
-
-
-    Model.prototype.set = function set(key, value) {
-        var _ref,
-            _this3 = this;
-
-        var attrs = typeof key === 'object' ? key : (_ref = {}, _ref[key] = value, _ref);
-        Object.keys(attrs).forEach(function (key) {
-            var changed = key in _this3.attributes && attrs[key] !== _this3.attributes[key];
-
-            _this3.previous[key] = _this3.attributes[key];
-            _this3.attributes[key] = attrs[key];
-            // Emit change events.
-            if (changed) {
-                _this3.emit('change', _this3, key, attrs[key]);
-                _this3.emit('change:' + key, _this3, attrs[key]);
-            }
-        });
-        return this;
-    };
-
-    /**
-     * Return object representation of the model to be used for JSON serialization.
-     * By default returns `this.attributes`.
-     * @return {object} Object representation of the model to be used for JSON serialization.
-     */
-
-
-    Model.prototype.toJSON = function toJSON() {
-        return this.attributes;
-    };
-
-    return Model;
+var Model = /*#__PURE__*/function (_Emitter) {
+  _inheritsLoose(Model, _Emitter);
+  function Model() {
+    var _this;
+    var attrs = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+    _this = _Emitter.call(this) || this;
+    // Call preinitialize.
+    _this.preinitialize.apply(_assertThisInitialized(_this), arguments);
+    // attributes object.
+    _this.attributes = Object.assign({}, _this.defaults || {}, attrs);
+    // Previous attributes.
+    _this.previous = {};
+    // Generate getters/setters for every attr.
+    Object.keys(_this.attributes).forEach(_this.defineAttribute.bind(_assertThisInitialized(_this)));
+    return _this;
+  }
+
+  /**
+   * If you define a preinitialize method, it will be invoked when the Model is first created, before any instantiation logic is run for the Model.
+   * @param {object} attrs Object containing model attributes to extend `this.attributes`.
+   */
+  var _proto = Model.prototype;
+  _proto.preinitialize = function preinitialize() {}
+
+  /**
+   * Generate getter/setter for the given key. In order to emit `change` events.
+   * This method is called internally by the constructor
+   * for `this.attributes`.
+   * @param {string} key Attribute key.
+   */;
+  _proto.defineAttribute = function defineAttribute(key) {
+    var _this2 = this;
+    Object.defineProperty(this, key, {
+      get: function get() {
+        return _this2.get(key);
+      },
+      set: function set(value) {
+        _this2.set(key, value);
+      }
+    });
+  }
+
+  /**
+   * Get an attribute from `this.attributes`.
+   * This method is called internally by generated getters.
+   * @param {string} key Attribute key.
+   * @return {any} The attribute value.
+   */;
+  _proto.get = function get(key) {
+    return this.attributes[key];
+  }
+
+  /**
+   * Set an attribute into `this.attributes`.
+   * Emit `change` and `change:attribute` if value change.
+   * Could be called in two forms, `this.set('key', value)` and
+   * `this.set({ key : value })`.
+   * This method is called internally by generated setters.
+   * @param {string} key Attribute key or object containing keys/values.
+   * @param [value] Attribute value.
+   * @return {this} This model.
+   * @emits change
+   * @emits change:attribute
+   */;
+  _proto.set = function set(key, value) {
+    var _ref,
+      _this3 = this;
+    var attrs = typeof key === 'object' ? key : (_ref = {}, _ref[key] = value, _ref);
+    Object.keys(attrs).forEach(function (key) {
+      var changed = key in _this3.attributes && attrs[key] !== _this3.attributes[key];
+      _this3.previous[key] = _this3.attributes[key];
+      _this3.attributes[key] = attrs[key];
+      // Emit change events.
+      if (changed) {
+        _this3.emit('change', _this3, key, attrs[key]);
+        _this3.emit("change:" + key, _this3, attrs[key]);
+      }
+    });
+    return this;
+  }
+
+  /**
+   * Return object representation of the model to be used for JSON serialization.
+   * By default returns `this.attributes`.
+   * @return {object} Object representation of the model to be used for JSON serialization.
+   */;
+  _proto.toJSON = function toJSON() {
+    return this.attributes;
+  };
+  return Model;
 }(Emitter);
-
-export default Model;
+export { Model as default };