chain-able/dist/compose/Observe.js

interfaces that describe their intentions.

var toarr = require('../deps/to-arr')
var traverse = require('../deps/traverse')
var eq = require('../deps/traversers/eq')
var match = require('../deps/matcher')
var getPathSegments = require('../deps/dot/segments')
var dot = require('../deps/dot')
var OBSERVERS_KEY = require('../deps/meta/observers')

/**
 * scoped clones
 * @private
 * @type {Map}
 */
var objs = new Map()

/**
 * @desc > subscribe to changes
 *       ❗ called only on **change**
 *       observers are only called when data they subscribe to changes
 *
 * @since 3.0.1
 * @class Observe
 * @member Observe
 * @extends {ChainedMap}
 * @extends {DotProp}
 * @memberOf compose
 * @category Chainable
 *
 * @param  {Class | Composable} SuperClass composable class
 * @return {Observe} class
 *
 * @tests Observe
 * @types Observe
 *
 * @see ChainedMap
 * @see DotProp
 * @see deps/matcher
 * @see deps/traversers/eq
 * @see deps/traverse
 * @see DotProp
 *
 * {@link https://github.com/iluwatar/java-design-patterns/tree/master/observer observer-pattern}
 * {@link https://github.com/ReactiveX/rxjs/blob/master/src/Subscriber.ts reactivex}
 * {@link https://github.com/sindresorhus/awesome-observables awesome-observables}
 * {@link https://medium.com/@benlesh/learning-observable-by-building-observable-d5da57405d87 building-observables}
 * {@link https://github.com/addyosmani/essential-js-design-patterns/blob/master/diagrams/observer.png js-observer-png}
 * {@link https://github.com/addyosmani/essential-js-design-patterns/blob/master/diagrams/publishsubscribe.png pubsub-png}
 * @see {@link reactivex}
 * @see {@link awesome-observables}
 * @see {@link building-observables}
 * @see {@link observer-pattern}
 *
 * @example
 *
 *    const {compose} = require('chain-able')
 *    const {DotProp} = compose
 *    new DotProp()
 *    //=> DotProp
 *
 */
module.exports = function (SuperClass) {
  return (function (SuperClass) {
    function Observe () {
      SuperClass.apply(this, arguments);
    }

    if ( SuperClass ) Observe.__proto__ = SuperClass;
    Observe.prototype = Object.create( SuperClass && SuperClass.prototype );
    Observe.prototype.constructor = Observe;

    Observe.prototype.observe = function observe (properties, fn) {
      var this$1 = this;

      var props = toarr(properties)
      var hashKey = props.join('_')
      var data = {}

      /* prettier-ignore */
      return this.meta(OBSERVERS_KEY, function (changed) {
        /**
         * match the keys, make the data out of it
         */
        var m = match(changed.key, props)

        // @@debugger

        for (var i = 0; i < m.length; i++) {
          var segments = getPathSegments(m[i])
          dot.set(data, segments, this$1.get(segments))
        }

        /**
         * if we have called it at least once...
         *    and it has not changed, leave it
         * else
         *    clone it
         *    call the observer
         */
        if (objs.has(hashKey) && eq(objs.get(hashKey), data)) {
          // @@debugger
          return
        }

        // @@debugger

        /**
         * it did change - clone it for next deepEquals check
         */
        objs.set(hashKey, traverse(data).clone())

        /**
         * call the observer - it matched & data changed
         */
        fn.call(this$1, data, this$1)
      })
    };

    return Observe;
  }(SuperClass))
}

//# sourceMappingURL=data:application/json;charset=utf-8;base64,{"version":3,"file":"Observe.js","sources":["Observe.js"],"sourcesContent":["const toarr = require('../deps/to-arr')\nconst traverse = require('../deps/traverse')\nconst eq = require('../deps/traversers/eq')\nconst match = require('../deps/matcher')\nconst getPathSegments = require('../deps/dot/segments')\nconst dot = require('../deps/dot')\nconst OBSERVERS_KEY = require('../deps/meta/observers')\n\n/**\n * scoped clones\n * @private\n * @type {Map}\n */\nlet objs = new Map()\n\n/**\n * @desc > subscribe to changes\n *       ❗ called only on **change**\n *       observers are only called when data they subscribe to changes\n *\n * @since 3.0.1\n * @class Observe\n * @member Observe\n * @extends {ChainedMap}\n * @extends {DotProp}\n * @memberOf compose\n * @category Chainable\n *\n * @param  {Class | Composable} SuperClass composable class\n * @return {Observe} class\n *\n * @tests Observe\n * @types Observe\n *\n * @see ChainedMap\n * @see DotProp\n * @see deps/matcher\n * @see deps/traversers/eq\n * @see deps/traverse\n * @see DotProp\n *\n * {@link https://github.com/iluwatar/java-design-patterns/tree/master/observer observer-pattern}\n * {@link https://github.com/ReactiveX/rxjs/blob/master/src/Subscriber.ts reactivex}\n * {@link https://github.com/sindresorhus/awesome-observables awesome-observables}\n * {@link https://medium.com/@benlesh/learning-observable-by-building-observable-d5da57405d87 building-observables}\n * {@link https://github.com/addyosmani/essential-js-design-patterns/blob/master/diagrams/observer.png js-observer-png}\n * {@link https://github.com/addyosmani/essential-js-design-patterns/blob/master/diagrams/publishsubscribe.png pubsub-png}\n * @see {@link reactivex}\n * @see {@link awesome-observables}\n * @see {@link building-observables}\n * @see {@link observer-pattern}\n *\n * @example\n *\n *    const {compose} = require('chain-able')\n *    const {DotProp} = compose\n *    new DotProp()\n *    //=> DotProp\n *\n */\nmodule.exports = SuperClass => {\n  return class Observe extends SuperClass {\n    /**\n     * @desc observe properties when they change\n     *\n     * @method\n     * @memberOf Observe\n     * @since 4.0.0 <- refactored with dot-prop\n     * @since 1.0.0\n     *\n     * @param  {Matchable} properties Matchable properties to observe\n     * @param  {Function} fn onChanged\n     * @return {Chain} @chainable\n     *\n     * @see traversers/eq\n     * @see toarr\n     * @see matcher\n     *\n     * @see {@link https://jsfiddle.net/wqxuags2/28/} for a Demo Clock with observable\n     * @see {@link examples/playground/TodoStore} TodoStore\n     *\n     * @TODO gotta update `data` if `deleting` too...\n     * @TODO un-observe\n     * @TODO should hash these callback properties\n     * @TODO just throttle the `.set` to allow easier version of .commit\n     *\n     * @example\n     *\n     *   const Chain = require('chain-able')\n     *\n     *   const chain = new Chain()\n     *   const log = arg => console.log(arg)\n     *\n     *   chain\n     *     .extend(['eh'])\n     *     .observe('eh', data => log(data))\n     *     .eh(true)\n     *   //=> {eh: true}\n     *\n     * @example\n     *\n     *    chain\n     *      .extend(['canada', 'timbuck'])\n     *      .observe(['canad*'], data => console.log(data.canada))\n     *      .canada(true)\n     *      .canada(true)\n     *      .timbuck(false)\n     *\n     *    //=> true\n     *    //=> false\n     *\n     *    // only called when changed,\n     *    // otherwise it would be 2 `true` & 1 `false`\n     */\n    observe(properties, fn) {\n      const props = toarr(properties)\n      const hashKey = props.join('_')\n      let data = {}\n\n      /* prettier-ignore */\n      return this.meta(OBSERVERS_KEY, changed => {\n        /**\n         * match the keys, make the data out of it\n         */\n        const m = match(changed.key, props)\n\n        // @@debugger\n\n        for (let i = 0; i < m.length; i++) {\n          const segments = getPathSegments(m[i])\n          dot.set(data, segments, this.get(segments))\n        }\n\n        /**\n         * if we have called it at least once...\n         *    and it has not changed, leave it\n         * else\n         *    clone it\n         *    call the observer\n         */\n        if (objs.has(hashKey) && eq(objs.get(hashKey), data)) {\n          // @@debugger\n          return\n        }\n\n        // @@debugger\n\n        /**\n         * it did change - clone it for next deepEquals check\n         */\n        objs.set(hashKey, traverse(data).clone())\n\n        /**\n         * call the observer - it matched & data changed\n         */\n        fn.call(this, data, this)\n      })\n    }\n  }\n}\n"],"names":["const","let","this"],"mappings":"AAAAA,GAAK,CAAC,KAAK,GAAG,OAAO,CAAC,gBAAgB,CAAC;AACvCA,GAAK,CAAC,QAAQ,GAAG,OAAO,CAAC,kBAAkB,CAAC;AAC5CA,GAAK,CAAC,EAAE,GAAG,OAAO,CAAC,uBAAuB,CAAC;AAC3CA,GAAK,CAAC,KAAK,GAAG,OAAO,CAAC,iBAAiB,CAAC;AACxCA,GAAK,CAAC,eAAe,GAAG,OAAO,CAAC,sBAAsB,CAAC;AACvDA,GAAK,CAAC,GAAG,GAAG,OAAO,CAAC,aAAa,CAAC;AAClCA,GAAK,CAAC,aAAa,GAAG,OAAO,CAAC,wBAAwB,CAAC;;;;;;;AAOvDC,GAAG,CAAC,IAAI,GAAG,IAAI,GAAG,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+CpB,MAAM,CAAC,OAAO,GAAG,UAAA,UAAU,CAAA,CAAC,AAAG;EAC7B,OAAO;IAAA,AAAgC,AAAC;;;;;;;;IAAA,AAqDtC,kBAAA,OAAO,oBAAA,CAAC,UAAU,EAAE,EAAE,EAAE,CAAC;;AAAA;MACvBD,GAAK,CAAC,KAAK,GAAG,KAAK,CAAC,UAAU,CAAC;MAC/BA,GAAK,CAAC,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC;MAC/BC,GAAG,CAAC,IAAI,GAAG,EAAE;;;MAGb,OAAO,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,UAAA,OAAO,CAAA,CAAC,AAAG;;;;QAIzCD,GAAK,CAAC,CAAC,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC;;;;QAInC,KAAKC,GAAG,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;UACjCD,GAAK,CAAC,QAAQ,GAAG,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;UACtC,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,QAAQ,EAAEE,MAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;SAC5C;;;;;;;;;QASD,IAAI,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,EAAE;;UAEpD,MAAM;SACP;;;;;;;QAOD,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,CAAC;;;;;QAKzC,EAAE,CAAC,IAAI,CAACA,MAAI,EAAE,IAAI,EAAEA,MAAI,CAAC;OAC1B,CAAC;KACH,CAAA,AACF;;;IAjG4B,UAiG5B,EAAA;CACF;"}