[Pkg-javascript-commits] [node-map-visit] 01/07: Import Upstream version 0.1.5
Sruthi Chandran
srud-guest at moszumanska.debian.org
Mon Oct 17 07:00:47 UTC 2016
This is an automated email from the git hooks/post-receive script.
srud-guest pushed a commit to branch master
in repository node-map-visit.
commit a8b96a3243d20ead75f190ab82f44c4d6d98d4f6
Author: Sruthi <srud at disroot.org>
Date: Mon Oct 17 12:18:16 2016 +0530
Import Upstream version 0.1.5
---
.editorconfig | 13 ++++++
.eslintrc.json | 122 +++++++++++++++++++++++++++++++++++++++++++++++++
.gitattributes | 10 ++++
.gitignore | 15 ++++++
.travis.yml | 14 ++++++
.verb.md | 85 ++++++++++++++++++++++++++++++++++
LICENSE | 21 +++++++++
README.md | 141 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
bower.json | 36 +++++++++++++++
example.js | 55 ++++++++++++++++++++++
index.js | 25 ++++++++++
package.json | 71 +++++++++++++++++++++++++++++
test.js | 62 +++++++++++++++++++++++++
utils.js | 14 ++++++
14 files changed, 684 insertions(+)
diff --git a/.editorconfig b/.editorconfig
new file mode 100644
index 0000000..818e072
--- /dev/null
+++ b/.editorconfig
@@ -0,0 +1,13 @@
+root = 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 = false
\ No newline at end of file
diff --git a/.eslintrc.json b/.eslintrc.json
new file mode 100644
index 0000000..948dbdb
--- /dev/null
+++ b/.eslintrc.json
@@ -0,0 +1,122 @@
+{
+ "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"]
+ }
+}
diff --git a/.gitattributes b/.gitattributes
new file mode 100644
index 0000000..660957e
--- /dev/null
+++ b/.gitattributes
@@ -0,0 +1,10 @@
+# Enforce Unix newlines
+* text eol=lf
+
+# binaries
+*.ai binary
+*.psd binary
+*.jpg binary
+*.gif binary
+*.png binary
+*.jpeg binary
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..80a228c
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,15 @@
+*.DS_Store
+*.sublime-*
+_gh_pages
+bower_components
+node_modules
+npm-debug.log
+actual
+test/actual
+temp
+tmp
+TODO.md
+vendor
+.idea
+benchmark
+coverage
diff --git a/.travis.yml b/.travis.yml
new file mode 100644
index 0000000..3932eaa
--- /dev/null
+++ b/.travis.yml
@@ -0,0 +1,14 @@
+sudo: false
+language: node_js
+node_js:
+ - '6'
+ - '5'
+ - '4'
+ - '0.12'
+ - '0.10'
+matrix:
+ fast_finish: true
+ allow_failures:
+ - node_js: '4'
+ - node_js: '0.10'
+ - node_js: '0.12'
diff --git a/.verb.md b/.verb.md
new file mode 100644
index 0000000..f37fdbe
--- /dev/null
+++ b/.verb.md
@@ -0,0 +1,85 @@
+{{#block "logo"}}{{/block}}
+## Usage
+
+```js
+var mapVisit = require('{%= name %}');
+```
+
+## Assign or Merge 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`:
+
+```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. But **if you also want to emit an event** each time a property is added to the `data` object. A better approach would be to use `visit`.
+
+**Example using `visit`**
+
+In this approach, when an array is passed to `set`, `mapVisit` calls `set` 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`.
+
+```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 {
+ // 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'}
+
+// 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
+```
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..6525171
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,21 @@
+The 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.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c4b7598
--- /dev/null
+++ b/README.md
@@ -0,0 +1,141 @@
+# map-visit [](https://www.npmjs.com/package/map-visit) [](https://npmjs.org/package/map-visit) [](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');
+```
+
+## Assign or Merge 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`:
+
+```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. But **if you also want to emit an event** each time a property is added to the `data` object. A better approach would be to use `visit`.
+
+**Example using `visit`**
+
+In this approach, when an array is passed to `set`, `mapVisit` calls `set` 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`.
+
+```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 {
+ // 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'}
+
+// 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).
+
+### Building docs
+
+_(This document was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme) (a [verb](https://github.com/verbose/verb) generator), please don't edit the readme directly. Any changes to the readme must be made in [.verb.md](.verb.md).)_
+
+To generate the readme and API documentation with [verb](https://github.com/verbose/verb):
+
+```sh
+$ npm install -g verb verb-generate-readme && verb
+```
+
+### Running tests
+
+Install dev dependencies:
+
+```sh
+$ npm install -d && npm test
+```
+
+### Author
+
+**Jon Schlinkert**
+
+* [github/jonschlinkert](https://github.com/jonschlinkert)
+* [twitter/jonschlinkert](http://twitter.com/jonschlinkert)
+
+### License
+
+Copyright © 2016, [Jon Schlinkert](https://github.com/jonschlinkert).
+Released under the [MIT license](https://github.com/jonschlinkert/map-visit/blob/master/LICENSE).
+
+***
+
+_This file was generated by [verb](https://github.com/verbose/verb), v0.9.0, on August 05, 2016._
\ No newline at end of file
diff --git a/bower.json b/bower.json
new file mode 100644
index 0000000..b22bc98
--- /dev/null
+++ b/bower.json
@@ -0,0 +1,36 @@
+{
+ "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": {
+ "lazy-cache": "^0.2.4",
+ "object-visit": "^0.3.1"
+ },
+ "devDependencies": {
+ "mocha": "*",
+ "should": "*"
+ },
+ "keywords": [
+ "array",
+ "arrays",
+ "function",
+ "helper",
+ "invoke",
+ "key",
+ "map",
+ "method",
+ "object",
+ "objects",
+ "value",
+ "visit",
+ "visitor"
+ ]
+}
\ No newline at end of file
diff --git a/example.js b/example.js
new file mode 100644
index 0000000..7130136
--- /dev/null
+++ b/example.js
@@ -0,0 +1,55 @@
+/**
+ * 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' }
diff --git a/index.js b/index.js
new file mode 100644
index 0000000..426735d
--- /dev/null
+++ b/index.js
@@ -0,0 +1,25 @@
+'use strict';
+
+var utils = require('./utils');
+
+/**
+ * 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, arr) {
+ if (!Array.isArray(arr)) {
+ throw new TypeError('expected an array');
+ }
+
+ arr.forEach(function(val) {
+ if (typeof val === 'string') {
+ collection[method](val);
+ } else {
+ utils.visit(collection, method, val);
+ }
+ });
+};
diff --git a/package.json b/package.json
new file mode 100644
index 0000000..d848c51
--- /dev/null
+++ b/package.json
@@ -0,0 +1,71 @@
+{
+ "name": "map-visit",
+ "description": "Map `visit` over an array of objects.",
+ "version": "0.1.5",
+ "homepage": "https://github.com/jonschlinkert/map-visit",
+ "author": "Jon Schlinkert (https://github.com/jonschlinkert)",
+ "repository": "jonschlinkert/map-visit",
+ "bugs": {
+ "url": "https://github.com/jonschlinkert/map-visit/issues"
+ },
+ "license": "MIT",
+ "files": [
+ "index.js",
+ "utils.js"
+ ],
+ "main": "index.js",
+ "engines": {
+ "node": ">=0.10.0"
+ },
+ "scripts": {
+ "test": "mocha"
+ },
+ "dependencies": {
+ "lazy-cache": "^2.0.1",
+ "object-visit": "^0.3.4"
+ },
+ "devDependencies": {
+ "gulp-format-md": "^0.1.10",
+ "lodash": "^4.14.1",
+ "mocha": "^3.0.1",
+ "should": "^10.0.0"
+ },
+ "keywords": [
+ "array",
+ "arrays",
+ "function",
+ "helper",
+ "invoke",
+ "key",
+ "map",
+ "method",
+ "object",
+ "objects",
+ "value",
+ "visit",
+ "visitor"
+ ],
+ "verb": {
+ "related": {
+ "list": [
+ "collection-visit",
+ "object-visit"
+ ]
+ },
+ "toc": false,
+ "layout": "default",
+ "tasks": [
+ "readme"
+ ],
+ "plugins": [
+ "gulp-format-md"
+ ],
+ "lint": {
+ "reflinks": true
+ },
+ "reflinks": [
+ "verb",
+ "verb-generate-readme"
+ ]
+ }
+}
diff --git a/test.js b/test.js
new file mode 100644
index 0000000..61dafd7
--- /dev/null
+++ b/test.js
@@ -0,0 +1,62 @@
+'use strict';
+
+require('mocha');
+require('should');
+var assert = require('assert');
+var visit = require('object-visit');
+var mapVisit = require('./');
+
+var ctx = {
+ data: {},
+ set: function(key, value) {
+ if (Array.isArray(key)) {
+ mapVisit(ctx, 'set', key);
+ } else if (typeof key === 'object') {
+ visit(ctx, 'set', key);
+ } else {
+ ctx.data[key] = value;
+ }
+ }
+};
+
+describe('visit', function() {
+ it('should throw an error when value is not an array.', function(done) {
+ try {
+ mapVisit({}, 'foo', 'bar');
+ done(new Error('expected an error'));
+ } catch (err) {
+ assert(err);
+ assert(err.message);
+ assert(err.message === 'expected an array');
+ done();
+ }
+ });
+
+ 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'}});
+ ctx.data.should.eql({
+ a: 'a',
+ b: 'b',
+ c: 'c',
+ d: { e: 'f' }
+ });
+ });
+
+ it('should call visit on every value in the given object:', function() {
+ ctx.set('a', 'a');
+ ctx.set(['x', 'y']);
+ ctx.set([{b: 'b'}, {c: 'c'}]);
+ ctx.set({d: {e: 'f'}});
+
+ ctx.data.should.eql({
+ a: 'a',
+ b: 'b',
+ c: 'c',
+ d: { e: 'f' },
+ x: undefined,
+ y: undefined
+ });
+ });
+});
diff --git a/utils.js b/utils.js
new file mode 100644
index 0000000..4707585
--- /dev/null
+++ b/utils.js
@@ -0,0 +1,14 @@
+'use strict';
+
+var utils = require('lazy-cache')(require);
+var fn = require;
+
+require = utils; // trick browserify
+require('object-visit', 'visit');
+require = fn;
+
+/**
+ * Expose utils
+ */
+
+module.exports = utils;
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-javascript/node-map-visit.git
More information about the Pkg-javascript-commits
mailing list