foop/dist/TraverseChain.js

interfaces that describe their intentions.

var ChainedMapBase = require('./ChainedMapBase')
var traverse = require('./deps/traverse')
var isTrue = require('./deps/is/true')
var matchFactory = require('./deps/matcher/testKeysVals')
var ENV_DEBUG = require('./deps/env/debug')

var TRAVERSED_KEY = 1
var EXTENSION_KEYS = ['obj', 'keys', 'vals', 'onNonMatch', 'onMatch', 'clone']

/**
 * @since 1.0.0
 * @type {Map}
 * @extends {ChainedMapBase}
 *
 * @memberOf Chainable
 * @memberOf Traverse
 * @see deps/traverse
 * @category traverse
 * @types TraverseChain
 * @tests TraverseChain
 * @symb 👣
 *
 * @prop {Object} obj
 * @prop {Array<Matcher>} [keys]
 * @prop {Array<Matcher>} [vals]
 * @prop {Function} [onMatch]
 * @prop {Function} [onNonMatch]
 * @prop {boolean} [clone]
 */
module.exports = (function (ChainedMapBase) {
  function Traverser(parent) {
    ChainedMapBase.call(this, parent)
    this.call = this.traverse.bind(this)

    /* prettier-ignore */
    this
      .extend(EXTENSION_KEYS)
      .keys([])
      .vals([])
      // key,
      .onMatch(function (arg, traverser) {
        // no return needed
        traverser.remove()
      })
  }

  if ( ChainedMapBase ) Traverser.__proto__ = ChainedMapBase;
  Traverser.prototype = Object.create( ChainedMapBase && ChainedMapBase.prototype );
  Traverser.prototype.constructor = Traverser;

  /**
   * @desc runs traverser, checks the tests, calls the onMatch
   *       @modifies this.cleaned
   *
   * @memberOf TraverseChain
   * @alias call
   * @since 1.0.0
   *
   * @param  {boolean} [shouldReturn=false] returns traversed object
   * @return {any} this.obj/data cleaned
   *
   * @example
   *
   *   const traversed = new Chain()
   *     .merge({flat: 0, one: {two: true}})
   *     .traverse(false)
   *     .vals([/true/])
   *     .onMatch((current, traverser) => {
   *       traverser.path.join('.')
   *       //=> 'one.two'
   *
   *       current
   *       //=> true
   *
   *       typeof traverser.update === typeof traverser.remove
   *       typeof traverser.update === 'function'
   *       //=> true
   *
   *       traverser.remove()
   *       //=> void
   *     })
   *     .onNonMatch(val => {
   *       // ignore
   *     })
   *     .call(true)
   *
   *   traversed
   *   //=> {flat: 0}
   *
   */
  Traverser.prototype.traverse = function traverse$1 (shouldReturn) {
    var ref = this.entries();
    var obj = ref.obj;
    var keys = ref.keys;
    var vals = ref.vals;
    var onMatch = ref.onMatch;
    var onNonMatch = ref.onNonMatch;
    var clone = ref.clone;
    var result = clone ? traverse(obj).clone() : obj

    // diff between keys and val is order of arg in ^ tester
    var matcher = matchFactory(keys, vals)

    /* istanbul ignore next: debug */
    if (ENV_DEBUG) {
      console.log('matcher for traverse...', keys, vals)
    }

    // bound to the traverser
    traverse(result).forEach(function(key, x, traverser) {
      if (traverser.isRoot) {
        // nothing
      }
      else if (matcher(key, x)) {
        /* istanbul ignore next: debug */
        if (ENV_DEBUG) {
          console.log('------- match ------- ', key, x)
        }

        onMatch(x, traverser)
      }
      else if (onNonMatch) {
        /* istanbul ignore next: debug */
        if (ENV_DEBUG) {
          console.log('------- NONmatch ------- ', key, x)
        }

        onNonMatch(x, traverser)
      }
    })

    this.set(TRAVERSED_KEY, result)
    return isTrue(shouldReturn) ? result : this
  };

  return Traverser;
}(ChainedMapBase))

//# sourceMappingURL=data:application/json;charset=utf-8;base64,{"version":3,"file":"TraverseChain.js","sources":["TraverseChain.js"],"sourcesContent":["const ChainedMapBase = require('./ChainedMapBase')\nconst traverse = require('./deps/traverse')\nconst isTrue = require('./deps/is/true')\nconst matchFactory = require('./deps/matcher/testKeysVals')\nconst ENV_DEBUG = require('./deps/env/debug')\n\nconst TRAVERSED_KEY = 1\nconst EXTENSION_KEYS = ['obj', 'keys', 'vals', 'onNonMatch', 'onMatch', 'clone']\n\n/**\n * @since 1.0.0\n * @type {Map}\n * @extends {ChainedMapBase}\n *\n * @memberOf Chainable\n * @memberOf Traverse\n * @see deps/traverse\n * @category traverse\n * @types TraverseChain\n * @tests TraverseChain\n * @symb 👣\n *\n * @prop {Object} obj\n * @prop {Array<Matcher>} [keys]\n * @prop {Array<Matcher>} [vals]\n * @prop {Function} [onMatch]\n * @prop {Function} [onNonMatch]\n * @prop {boolean} [clone]\n */\nmodule.exports = class Traverser extends ChainedMapBase {\n  /**\n   * @inheritdoc\n   * @modifies this.call\n   *\n   * @example\n   *\n   *    new Traverser({})\n   *\n   */\n  constructor(parent) {\n    super(parent)\n    this.call = this.traverse.bind(this)\n\n    /* prettier-ignore */\n    this\n      .extend(EXTENSION_KEYS)\n      .keys([])\n      .vals([])\n      // key,\n      .onMatch((arg, traverser) => {\n        // no return needed\n        traverser.remove()\n      })\n  }\n\n  /**\n   * @desc runs traverser, checks the tests, calls the onMatch\n   *       @modifies this.cleaned\n   *\n   * @memberOf TraverseChain\n   * @alias call\n   * @since 1.0.0\n   *\n   * @param  {boolean} [shouldReturn=false] returns traversed object\n   * @return {any} this.obj/data cleaned\n   *\n   * @example\n   *\n   *   const traversed = new Chain()\n   *     .merge({flat: 0, one: {two: true}})\n   *     .traverse(false)\n   *     .vals([/true/])\n   *     .onMatch((current, traverser) => {\n   *       traverser.path.join('.')\n   *       //=> 'one.two'\n   *\n   *       current\n   *       //=> true\n   *\n   *       typeof traverser.update === typeof traverser.remove\n   *       typeof traverser.update === 'function'\n   *       //=> true\n   *\n   *       traverser.remove()\n   *       //=> void\n   *     })\n   *     .onNonMatch(val => {\n   *       // ignore\n   *     })\n   *     .call(true)\n   *\n   *   traversed\n   *   //=> {flat: 0}\n   *\n   */\n  traverse(shouldReturn) {\n    const {obj, keys, vals, onMatch, onNonMatch, clone} = this.entries()\n    let result = clone ? traverse(obj).clone() : obj\n\n    // diff between keys and val is order of arg in ^ tester\n    const matcher = matchFactory(keys, vals)\n\n    /* istanbul ignore next: debug */\n    if (ENV_DEBUG) {\n      console.log('matcher for traverse...', keys, vals)\n    }\n\n    // bound to the traverser\n    traverse(result).forEach(function(key, x, traverser) {\n      if (traverser.isRoot) {\n        // nothing\n      }\n      else if (matcher(key, x)) {\n        /* istanbul ignore next: debug */\n        if (ENV_DEBUG) {\n          console.log('------- match ------- ', key, x)\n        }\n\n        onMatch(x, traverser)\n      }\n      else if (onNonMatch) {\n        /* istanbul ignore next: debug */\n        if (ENV_DEBUG) {\n          console.log('------- NONmatch ------- ', key, x)\n        }\n\n        onNonMatch(x, traverser)\n      }\n    })\n\n    this.set(TRAVERSED_KEY, result)\n    return isTrue(shouldReturn) ? result : this\n  }\n\n  /**\n   * @ignore\n   * @version 5.0.0-beta.5 @depreciated\n   * value traversed in traverse\n   * @since 1.0.0\n   * @see TraverseChain.traverse\n   * @return {Object | Array | any} traversed\n   *\n   * @example\n   *\n   *   const traverser = new Traverser()\n   *   traverser.obj(['duck', 'duck', 'goose'])\n   *   traverser.vals(['g**se'])\n   *   traverser.traverse()\n   *\n   *   traverser.traversed()\n   *   //=> ['goose']\n   *\n   * @example\n   *\n   *    const eh = {\n   *      me: true,\n   *      nested: {\n   *        really: {\n   *          deep: {\n   *            super: false,\n   *            not: 'eh',\n   *            canada: true,\n   *            modules: [{parser: 'hi'}],\n   *          },\n   *          matchme: 'minime',\n   *          notme: 'eh',\n   *        },\n   *      },\n   *    }\n   *\n   *    const chain = new Chain()\n   *    Object.assign(chain, eh)\n   *\n   *    const traverser = chain\n   *      .merge(eh)\n   *      .traverse(true)\n   *      .keys([/super/, /parser/, /store/, /meta/])\n   *      .vals([/minime/])\n   *      .call(false)\n   *\n   *    traverser.traversed()\n   *    //=> {\n   *      className: 'DotProp',\n   *      me: true,\n   *      nested: {\n   *        really: {\n   *          deep: {\n   *            not: 'eh',\n   *            canada: true,\n   *            modules: [{}],\n   *          },\n   *          notme: 'eh',\n   *        },\n   *      },\n   *    }\n   *\n   */\n  // traversed() {\n  //   return this.get(TRAVERSED_KEY)\n  // }\n}\n"],"names":["const","super","let"],"mappings":"AAAAA,GAAK,CAAC,cAAc,GAAG,OAAO,CAAC,kBAAkB,CAAC;AAClDA,GAAK,CAAC,QAAQ,GAAG,OAAO,CAAC,iBAAiB,CAAC;AAC3CA,GAAK,CAAC,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;AACxCA,GAAK,CAAC,YAAY,GAAG,OAAO,CAAC,6BAA6B,CAAC;AAC3DA,GAAK,CAAC,SAAS,GAAG,OAAO,CAAC,kBAAkB,CAAC;;AAE7CA,GAAK,CAAC,aAAa,GAAG,CAAC;AACvBA,GAAK,CAAC,cAAc,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,SAAS,EAAE,OAAO,CAAC;;;;;;;;;;;;;;;;;;;;;;AAsBhF,MAAM,CAAC,OAAO,GAAG;EAAA,AAAsC,AAAC,AAUtD,kBAAW,CAAC,MAAM,EAAE;IAClBC,cAAK,KAAA,CAAC,MAAA,MAAM,CAAC;IACb,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC;;;IAGpC,IAAI;OACD,MAAM,CAAC,cAAc,CAAC;OACtB,IAAI,CAAC,EAAE,CAAC;OACR,IAAI,CAAC,EAAE,CAAC;;OAER,OAAO,CAAC,SAAA,CAAC,GAAG,EAAE,SAAS,EAAE,AAAG;;QAE3B,SAAS,CAAC,MAAM,EAAE;OACnB,CAAC;GACL;;;;8CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA0CD,oBAAA,QAAQ,uBAAA,CAAC,YAAY,EAAE;IACrB,AAAK,AAA8C,OAAA,GAAG,IAAI,CAAC,OAAO,EAAE;IAA7D,IAAA,GAAG;IAAE,IAAA,IAAI;IAAE,IAAA,IAAI;IAAE,IAAA,OAAO;IAAE,IAAA,UAAU;IAAE,IAAA,KAAK,aAA5C,AAAI,AAAM,AAAM,AAAS,AAAY,AAAO,AAAkB;IACpEC,GAAG,CAAC,MAAM,GAAG,KAAK,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,GAAG,GAAG;;;IAGhDF,GAAK,CAAC,OAAO,GAAG,YAAY,CAAC,IAAI,EAAE,IAAI,CAAC;;;IAGxC,IAAI,SAAS,EAAE;MACb,OAAO,CAAC,GAAG,CAAC,yBAAyB,EAAE,IAAI,EAAE,IAAI,CAAC;KACnD;;;IAGD,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,SAAS,GAAG,EAAE,CAAC,EAAE,SAAS,EAAE;MACnD,IAAI,SAAS,CAAC,MAAM,EAAE;;OAErB;WACI,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE;;QAExB,IAAI,SAAS,EAAE;UACb,OAAO,CAAC,GAAG,CAAC,wBAAwB,EAAE,GAAG,EAAE,CAAC,CAAC;SAC9C;;QAED,OAAO,CAAC,CAAC,EAAE,SAAS,CAAC;OACtB;WACI,IAAI,UAAU,EAAE;;QAEnB,IAAI,SAAS,EAAE;UACb,OAAO,CAAC,GAAG,CAAC,2BAA2B,EAAE,GAAG,EAAE,CAAC,CAAC;SACjD;;QAED,UAAU,CAAC,CAAC,EAAE,SAAS,CAAC;OACzB;KACF,CAAC;;IAEF,IAAI,CAAC,GAAG,CAAC,aAAa,EAAE,MAAM,CAAC;IAC/B,OAAO,MAAM,CAAC,YAAY,CAAC,GAAG,MAAM,GAAG,IAAI;GAC5C,CAAA,AAoEF;;;EA3KwC,cA2KxC,EAAA;"}