pax_global_header00006660000000000000000000000064130725253720014520gustar00rootroot0000000000000052 comment=73bcd8385c9520c595a825486f19623a5e0550f0 map-visit-1.0.0/000077500000000000000000000000001307252537200134275ustar00rootroot00000000000000map-visit-1.0.0/.editorconfig000066400000000000000000000004051307252537200161030ustar00rootroot00000000000000root = true [*] indent_style = space end_of_line = lf charset = utf-8 indent_size = 2 trim_trailing_whitespace = true insert_final_newline = true [{**/{actual,fixtures,expected,templates}/**,*.md}] trim_trailing_whitespace = false insert_final_newline = falsemap-visit-1.0.0/.eslintrc.json000066400000000000000000000071251307252537200162300ustar00rootroot00000000000000{ "ecmaFeatures": { "modules": true, "experimentalObjectRestSpread": true }, "env": { "browser": false, "es6": true, "node": true, "mocha": true }, "globals": { "document": false, "navigator": false, "window": false }, "rules": { "accessor-pairs": 2, "arrow-spacing": [2, { "before": true, "after": true }], "block-spacing": [2, "always"], "brace-style": [2, "1tbs", { "allowSingleLine": true }], "comma-dangle": [2, "never"], "comma-spacing": [2, { "before": false, "after": true }], "comma-style": [2, "last"], "constructor-super": 2, "curly": [2, "multi-line"], "dot-location": [2, "property"], "eol-last": 2, "eqeqeq": [2, "allow-null"], "generator-star-spacing": [2, { "before": true, "after": true }], "handle-callback-err": [2, "^(err|error)$" ], "indent": [2, 2, { "SwitchCase": 1 }], "key-spacing": [2, { "beforeColon": false, "afterColon": true }], "keyword-spacing": [2, { "before": true, "after": true }], "new-cap": [2, { "newIsCap": true, "capIsNew": false }], "new-parens": 2, "no-array-constructor": 2, "no-caller": 2, "no-class-assign": 2, "no-cond-assign": 2, "no-const-assign": 2, "no-control-regex": 2, "no-debugger": 2, "no-delete-var": 2, "no-dupe-args": 2, "no-dupe-class-members": 2, "no-dupe-keys": 2, "no-duplicate-case": 2, "no-empty-character-class": 2, "no-eval": 2, "no-ex-assign": 2, "no-extend-native": 2, "no-extra-bind": 2, "no-extra-boolean-cast": 2, "no-extra-parens": [2, "functions"], "no-fallthrough": 2, "no-floating-decimal": 2, "no-func-assign": 2, "no-implied-eval": 2, "no-inner-declarations": [2, "functions"], "no-invalid-regexp": 2, "no-irregular-whitespace": 2, "no-iterator": 2, "no-label-var": 2, "no-labels": 2, "no-lone-blocks": 2, "no-mixed-spaces-and-tabs": 2, "no-multi-spaces": 2, "no-multi-str": 2, "no-multiple-empty-lines": [2, { "max": 1 }], "no-native-reassign": 0, "no-negated-in-lhs": 2, "no-new": 2, "no-new-func": 2, "no-new-object": 2, "no-new-require": 2, "no-new-wrappers": 2, "no-obj-calls": 2, "no-octal": 2, "no-octal-escape": 2, "no-proto": 0, "no-redeclare": 2, "no-regex-spaces": 2, "no-return-assign": 2, "no-self-compare": 2, "no-sequences": 2, "no-shadow-restricted-names": 2, "no-spaced-func": 2, "no-sparse-arrays": 2, "no-this-before-super": 2, "no-throw-literal": 2, "no-trailing-spaces": 0, "no-undef": 2, "no-undef-init": 2, "no-unexpected-multiline": 2, "no-unneeded-ternary": [2, { "defaultAssignment": false }], "no-unreachable": 2, "no-unused-vars": [2, { "vars": "all", "args": "none" }], "no-useless-call": 0, "no-with": 2, "one-var": [0, { "initialized": "never" }], "operator-linebreak": [0, "after", { "overrides": { "?": "before", ":": "before" } }], "padded-blocks": [0, "never"], "quotes": [2, "single", "avoid-escape"], "radix": 2, "semi": [2, "always"], "semi-spacing": [2, { "before": false, "after": true }], "space-before-blocks": [2, "always"], "space-before-function-paren": [2, "never"], "space-in-parens": [2, "never"], "space-infix-ops": 2, "space-unary-ops": [2, { "words": true, "nonwords": false }], "spaced-comment": [0, "always", { "markers": ["global", "globals", "eslint", "eslint-disable", "*package", "!", ","] }], "use-isnan": 2, "valid-typeof": 2, "wrap-iife": [2, "any"], "yoda": [2, "never"] } } map-visit-1.0.0/.gitattributes000066400000000000000000000002001307252537200163120ustar00rootroot00000000000000# Enforce Unix newlines * text eol=lf # binaries *.ai binary *.psd binary *.jpg binary *.gif binary *.png binary *.jpeg binary map-visit-1.0.0/.gitignore000066400000000000000000000004171307252537200154210ustar00rootroot00000000000000# always ignore files *.DS_Store *.sublime-* # test related, or directories generated by tests test/actual actual coverage .nyc* # npm node_modules npm-debug.log # yarn yarn.lock yarn-error.log # misc _gh_pages _draft _drafts bower_components vendor temp tmp TODO.md map-visit-1.0.0/.travis.yml000066400000000000000000000002551307252537200155420ustar00rootroot00000000000000sudo: false os: - linux - osx language: node_js node_js: - node - '7' - '6' - '5' - '4' - '0.12' - '0.10' matrix: allow_failures: [] fast_finish: true map-visit-1.0.0/.verb.md000066400000000000000000000044411307252537200147700ustar00rootroot00000000000000## Usage ```js var mapVisit = require('{%= name %}'); ``` ## What does this do? **Assign/Merge/Extend vs. Visit** Let's say you want to add a `set` method to your application that will: - set key-value pairs on a `data` object - extend objects onto the `data` object - extend arrays of objects onto the data object **Example using `extend`** Here is one way to accomplish this using Lo-Dash's `extend` (comparable to `Object.assign`): ```js var _ = require('lodash'); var obj = { data: {}, set: function (key, value) { if (Array.isArray(key)) { _.extend.apply(_, [obj.data].concat(key)); } else if (typeof key === 'object') { _.extend(obj.data, key); } else { obj.data[key] = value; } } }; obj.set('a', 'a'); obj.set([{b: 'b'}, {c: 'c'}]); obj.set({d: {e: 'f'}}); console.log(obj.data); //=> {a: 'a', b: 'b', c: 'c', d: { e: 'f' }} ``` The above approach works fine for most use cases. However, **if you also want to emit an event** each time a property is added to the `data` object, or you want more control over what happens as the object is extended, a better approach would be to use `visit`. **Example using `visit`** In this approach: - when an array is passed to `set`, the `mapVisit` library calls the `set` method on each object in the array. - when an object is passed, `visit` calls `set` on each property in the object. As a result, the `data` event will be emitted every time a property is added to `data` (events are just an example, you can use this approach to perform any necessary logic every time the method is called). ```js var mapVisit = require('{%= name %}'); var visit = require('object-visit'); var obj = { data: {}, set: function (key, value) { if (Array.isArray(key)) { mapVisit(obj, 'set', key); } else if (typeof key === 'object') { visit(obj, 'set', key); } else { // simulate an event-emitter console.log('emit', key, value); obj.data[key] = value; } } }; obj.set('a', 'a'); obj.set([{b: 'b'}, {c: 'c'}]); obj.set({d: {e: 'f'}}); obj.set({g: 'h', i: 'j', k: 'l'}); console.log(obj.data); //=> {a: 'a', b: 'b', c: 'c', d: { e: 'f' }, g: 'h', i: 'j', k: 'l'} // events would look something like: // emit a a // emit b b // emit c c // emit d { e: 'f' } // emit g h // emit i j // emit k l ``` map-visit-1.0.0/LICENSE000066400000000000000000000020771307252537200144420ustar00rootroot00000000000000The MIT License (MIT) Copyright (c) 2015-2016, Jon Schlinkert Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. map-visit-1.0.0/README.md000066400000000000000000000115161307252537200147120ustar00rootroot00000000000000# map-visit [![NPM version](https://img.shields.io/npm/v/map-visit.svg?style=flat)](https://www.npmjs.com/package/map-visit) [![NPM monthly downloads](https://img.shields.io/npm/dm/map-visit.svg?style=flat)](https://npmjs.org/package/map-visit) [![NPM total downloads](https://img.shields.io/npm/dt/map-visit.svg?style=flat)](https://npmjs.org/package/map-visit) [![Linux Build Status](https://img.shields.io/travis/jonschlinkert/map-visit.svg?style=flat&label=Travis)](https://travis-ci.org/jonschlinkert/map-visit) > Map `visit` over an array of objects. ## Install Install with [npm](https://www.npmjs.com/): ```sh $ npm install --save map-visit ``` ## Usage ```js var mapVisit = require('map-visit'); ``` ## What does this do? **Assign/Merge/Extend vs. Visit** Let's say you want to add a `set` method to your application that will: * set key-value pairs on a `data` object * extend objects onto the `data` object * extend arrays of objects onto the data object **Example using `extend`** Here is one way to accomplish this using Lo-Dash's `extend` (comparable to `Object.assign`): ```js var _ = require('lodash'); var obj = { data: {}, set: function (key, value) { if (Array.isArray(key)) { _.extend.apply(_, [obj.data].concat(key)); } else if (typeof key === 'object') { _.extend(obj.data, key); } else { obj.data[key] = value; } } }; obj.set('a', 'a'); obj.set([{b: 'b'}, {c: 'c'}]); obj.set({d: {e: 'f'}}); console.log(obj.data); //=> {a: 'a', b: 'b', c: 'c', d: { e: 'f' }} ``` The above approach works fine for most use cases. However, **if you also want to emit an event** each time a property is added to the `data` object, or you want more control over what happens as the object is extended, a better approach would be to use `visit`. **Example using `visit`** In this approach: * when an array is passed to `set`, the `mapVisit` library calls the `set` method on each object in the array. * when an object is passed, `visit` calls `set` on each property in the object. As a result, the `data` event will be emitted every time a property is added to `data` (events are just an example, you can use this approach to perform any necessary logic every time the method is called). ```js var mapVisit = require('map-visit'); var visit = require('object-visit'); var obj = { data: {}, set: function (key, value) { if (Array.isArray(key)) { mapVisit(obj, 'set', key); } else if (typeof key === 'object') { visit(obj, 'set', key); } else { // simulate an event-emitter console.log('emit', key, value); obj.data[key] = value; } } }; obj.set('a', 'a'); obj.set([{b: 'b'}, {c: 'c'}]); obj.set({d: {e: 'f'}}); obj.set({g: 'h', i: 'j', k: 'l'}); console.log(obj.data); //=> {a: 'a', b: 'b', c: 'c', d: { e: 'f' }, g: 'h', i: 'j', k: 'l'} // events would look something like: // emit a a // emit b b // emit c c // emit d { e: 'f' } // emit g h // emit i j // emit k l ``` ## About ### Related projects * [collection-visit](https://www.npmjs.com/package/collection-visit): Visit a method over the items in an object, or map visit over the objects… [more](https://github.com/jonschlinkert/collection-visit) | [homepage](https://github.com/jonschlinkert/collection-visit "Visit a method over the items in an object, or map visit over the objects in an array.") * [object-visit](https://www.npmjs.com/package/object-visit): Call a specified method on each value in the given object. | [homepage](https://github.com/jonschlinkert/object-visit "Call a specified method on each value in the given object.") ### Contributing Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new). ### Contributors | **Commits** | **Contributor** | | --- | --- | | 15 | [jonschlinkert](https://github.com/jonschlinkert) | | 7 | [doowb](https://github.com/doowb) | ### Building docs _(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_ To generate the readme, run the following command: ```sh $ npm install -g verbose/verb#dev verb-generate-readme && verb ``` ### Running tests Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command: ```sh $ npm install && npm test ``` ### Author **Jon Schlinkert** * [github/jonschlinkert](https://github.com/jonschlinkert) * [twitter/jonschlinkert](https://twitter.com/jonschlinkert) ### License Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert). Released under the [MIT License](LICENSE). *** _This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.5.0, on April 09, 2017._map-visit-1.0.0/bower.json000066400000000000000000000022561307252537200154450ustar00rootroot00000000000000{ "name": "map-visit", "description": "Map `visit` over an array of objects.", "repository": "jonschlinkert/map-visit", "license": "MIT", "homepage": "https://github.com/jonschlinkert/map-visit", "authors": [ "Jon Schlinkert (https://github.com/jonschlinkert)" ], "main": [ "index.js" ], "dependencies": { "object-visit": "^1.0.0" }, "devDependencies": { "clone-deep": "^0.2.4", "extend-shallow": "^2.0.1", "gulp-format-md": "^0.1.12", "lodash": "^4.17.4", "mocha": "^3.2.0" }, "keywords": [ "array", "arrays", "function", "helper", "invoke", "key", "map", "method", "object", "objects", "value", "visit", "visitor" ], "version": "0.1.5", "bugs": { "url": "https://github.com/jonschlinkert/map-visit/issues" }, "files": [ "index.js" ], "ignore": [ "actual", "bower_components", "fixtures", "node_modules", "temp", "test", "test.js", "tmp" ], "contributors": [ "Brian Woodward (https://twitter.com/doowb)", "Jon Schlinkert (http://twitter.com/jonschlinkert)" ] }map-visit-1.0.0/example.js000066400000000000000000000021261307252537200154210ustar00rootroot00000000000000/** * Example using Lo-Dash's extend (without visit) */ var _ = require('lodash'); var obj = { data: {}, set: function(key, value) { if (Array.isArray(key)) { _.extend.apply(_, [obj.data].concat(key)); } else if (typeof key === 'object') { _.extend(obj.data, key); } else { obj.data[key] = value; } } }; obj.set('a', 'a'); obj.set([{b: 'b'}, {c: 'c'}]); obj.set({d: {e: 'f'}}); console.log(obj.data); //=> {a: 'a', b: 'b', c: 'c', d: { e: 'f' }} /** * Example using `mapVisit` */ var mapVisit = require('./'); var visit = require('object-visit'); obj = { data: {}, set: function(key, value) { if (Array.isArray(key)) { mapVisit(obj, 'set', key); } else if (typeof key === 'object') { visit(obj, 'set', key); } else { // some event-emitter console.log('emit', key, value); obj.data[key] = value; } } }; obj.set('a', 'a'); obj.set([{b: 'b'}, {c: 'c'}]); obj.set({d: {e: 'f'}}); obj.set({g: 'h', i: 'j', k: 'l'}); console.log(obj.data); //=> { a: 'a', b: 'b', c: 'c', d: { e: 'f' }, g: 'h', i: 'j', k: 'l' } map-visit-1.0.0/index.js000066400000000000000000000017071307252537200151010ustar00rootroot00000000000000'use strict'; var util = require('util'); var visit = require('object-visit'); /** * Map `visit` over an array of objects. * * @param {Object} `collection` The context in which to invoke `method` * @param {String} `method` Name of the method to call on `collection` * @param {Object} `arr` Array of objects. */ module.exports = function mapVisit(collection, method, val) { if (isObject(val)) { return visit.apply(null, arguments); } if (!Array.isArray(val)) { throw new TypeError('expected an array: ' + util.inspect(val)); } var args = [].slice.call(arguments, 3); for (var i = 0; i < val.length; i++) { var ele = val[i]; if (isObject(ele)) { visit.apply(null, [collection, method, ele].concat(args)); } else { collection[method].apply(collection, [ele].concat(args)); } } }; function isObject(val) { return val && (typeof val === 'function' || (!Array.isArray(val) && typeof val === 'object')); } map-visit-1.0.0/package.json000066400000000000000000000027011307252537200157150ustar00rootroot00000000000000{ "name": "map-visit", "description": "Map `visit` over an array of objects.", "version": "1.0.0", "homepage": "https://github.com/jonschlinkert/map-visit", "author": "Jon Schlinkert (https://github.com/jonschlinkert)", "contributors": [ "Brian Woodward (https://twitter.com/doowb)", "Jon Schlinkert (http://twitter.com/jonschlinkert)" ], "repository": "jonschlinkert/map-visit", "bugs": { "url": "https://github.com/jonschlinkert/map-visit/issues" }, "license": "MIT", "files": [ "index.js" ], "main": "index.js", "engines": { "node": ">=0.10.0" }, "scripts": { "test": "mocha" }, "dependencies": { "object-visit": "^1.0.0" }, "devDependencies": { "clone-deep": "^0.2.4", "extend-shallow": "^2.0.1", "gulp-format-md": "^0.1.12", "lodash": "^4.17.4", "mocha": "^3.2.0" }, "keywords": [ "array", "arrays", "function", "helper", "invoke", "key", "map", "method", "object", "objects", "value", "visit", "visitor" ], "verb": { "toc": false, "layout": "default", "tasks": [ "readme" ], "plugins": [ "gulp-format-md" ], "lint": { "reflinks": true }, "related": { "list": [ "collection-visit", "object-visit" ] }, "reflinks": [ "verb", "verb-generate-readme" ] } } map-visit-1.0.0/test.js000066400000000000000000000033371307252537200147520ustar00rootroot00000000000000'use strict'; require('mocha'); var clone = require('clone-deep'); var assert = require('assert'); var extend = require('extend-shallow'); var visit = require('object-visit'); var mapVisit = require('./'); var ctx; var fixture = { data: {}, options: {}, set: function(key, value) { if (typeof key !== 'string') { if (value) extend(this.options, value); mapVisit(this, 'set', key, value); } else { this.data[key] = value; } } }; describe('visit', function() { beforeEach(function() { ctx = clone(fixture); }); it('should throw an error when value is not an array', function() { assert.throws(function() { mapVisit({}, 'foo', 'bar'); }); }); it('should call visit on every value in the given object', function() { ctx.set('a', 'a'); ctx.set([{b: 'b'}, {c: 'c'}]); ctx.set({d: {e: 'f'}}); assert.deepEqual(ctx.data, { a: 'a', b: 'b', c: 'c', d: { e: 'f' } }); }); it('should call visit on every element of any array', function() { ctx.set('a', 'a'); ctx.set(['x', 'y']); ctx.set([{b: 'b'}, {c: 'c'}]); ctx.set({d: {e: 'f'}}); assert.deepEqual(ctx.data, { a: 'a', b: 'b', c: 'c', d: { e: 'f' }, x: undefined, y: undefined }); }); it('should set the second arg on every element', function() { ctx.set(['foo', 'bar'], function() {}); assert.equal(typeof ctx.data.foo, 'function'); assert.equal(typeof ctx.data.bar, 'function'); }); it('should set the second arg on every object', function() { ctx.set({a: 'aaa', b: 'bbb'}, {cwd: process.cwd()}); assert.equal(ctx.options.cwd, process.cwd()); assert.equal(ctx.options.cwd, process.cwd()); }); });