Initial implementation

Author: sttk

.eslintignore

@@ -0,0 +1,2 @@
+# Coverage directory used by tools like istanbul
+coverage

.eslintrc

@@ -0,0 +1,29 @@
+{
+  "env": {
+    "node": true
+  },
+  "rules": {
+    "array-bracket-spacing": [2, "never"],
+    "block-scoped-var": 2,
+    "brace-style": [2, "1tbs"],
+    "camelcase": 1,
+    "computed-property-spacing": [2, "never"],
+    "curly": 2,
+    "eol-last": 2,
+    "eqeqeq": [2, "smart"],
+    "max-depth": [1, 3],
+    "max-len": [1, 80],
+    "max-statements": [1, 20],
+    "new-cap": 1,
+    "no-extend-native": 2,
+    "no-mixed-spaces-and-tabs": 2,
+    "no-trailing-spaces": 2,
+    "no-unused-vars": 1,
+    "no-use-before-define": [2, "nofunc"],
+    "object-curly-spacing": [2, "always"],
+    "quotes": [2, "single", "avoid-escape"],
+    "semi": [2, "always"],
+    "keyword-spacing": [2, { "before": true, "after": true }],
+    "space-unary-ops": 2
+  }
+}

.gitignore

@@ -0,0 +1,16 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# Dependency directories
+node_modules
+
+# Optional npm cache directory
+.npm
+
+# Files generated by platform.
+.DS_Store

.travis.yml

@@ -0,0 +1,14 @@
+sudo: false
+
+language: node_js
+
+node_js:
+  - '6'
+  - '5'
+  - '4'
+  - '0.12'
+  - '0.10'
+
+os:
+  - linux
+  - osx

README.md

@@ -0,0 +1,93 @@
+# each-props [![Build Status][travis-img]][travis-url] [![Build Status][appveyor-img]][appveyor-url]
+
+Process object properties deeply.
+
+[![NPM][npm-img]][npm-url]
+
+[npm-img]: https://nodei.co/npm/each-props.png
+[npm-url]: https://nodei.co/npm/each-props/
+[travis-img]: https://travis-ci.org/sttk/each-props.svg?branch=master
+[travis-url]: https://travis-ci.org/sttk/each-props
+[appveyor-img]: https://ci.appveyor.com/api/projects/status/github/sttk/each-props?branch=master&svg=true
+[appveyor-url]: https://ci.appveyor.com/project/sttk/each-props
+
+Install
+-------
+
+```
+$ npm i each-props --save
+```
+
+Usage
+-----
+
+* Load this module :
+
+    ```js
+    const eachProps = require('each-props');
+    ```
+
+* Apply a function to all (= non plain object) properties.
+
+    ```js
+    var obj = { a: 1, b: { c: 'CCC', d: { e: 'EEE' } } };
+
+    eachProps(obj, function(value, keychain, nodeinfo) {
+      if (keychain === 'a') {
+        nodeinfo.parent['a'] = value * 2;
+      } else if (keychain === 'b.c') {
+        nodeinfo.parent['c'] = value.toLowerCase();
+      } else if (keychain === 'b.d') {
+        return true; // stop to dig
+      } else i f(keychain === 'b.d.e') {
+        nodeinfo.parent['e'] = value.toLowerCase();
+      }
+    });
+    console.log(obj);
+    // => { a: 2, b: { c: 'ccc', d: { e: 'EEE' } } };
+    ```
+
+API
+---
+
+### eachProps(obj, callback [, opts]) => void
+
+Executes the *callback* function for all properties.
+
+##### **Arguments :** 
+
+   * **obj** [object] : A plain object to be treated.
+   * **callback** [function] : A function to treat the plain object.
+   * **opts** [object] : An object to be able to has options.
+
+##### **API of *callback* function**
+
+* ***callback(value, key, info) => object***
+
+    * **Arguments :**
+        * **value** [any] : The property value.
+        * **keychain** [string] : A string concatenated the hierarchical keys with dots.
+        * **nodeinfo** [object] : An object which contains properties: `index`, `count`, `depth`, `parent`, `sort`, and can contains more properties by specifying in **eachProps**'s *opts*. 
+
+    * **Returns :**
+        * [boolean] : Stops digging child properties if `true`.
+
+    ##### **Properties of *nodeinfo* :**
+
+    * ***nodeinfo*** *[object]*
+        * **index** [number] : The index of the property among the sibling properties.
+        * **count** [number] : The count of the sibling properties.
+        * **depth** [number] : The depth in the property hierarchy.
+        * **parent** [object] : The parent property.
+        * **sort** [function] : A sort function which orders the child properties. (Not sort If null.) 
+
+##### **Properties of *opts* :**
+
+* ***opts*** *[object]*
+    * **sort** [function] : A sort function which orders the same level properties. (Not sort if null.)
+    * ... and any properties you want to pass to each node.
+
+License
+-------
+
+MIT

appveyor.yml

@@ -0,0 +1,24 @@
+# http://www.appveyor.com/docs/appveyor-yml
+# http://www.appveyor.com/docs/lang/nodejs-iojs
+
+environment:
+  matrix:
+    # node.js
+    - nodejs_version: "6"
+    - nodejs_version: "5"
+    - nodejs_version: "4"
+    - nodejs_version: "0.12"
+    - nodejs_version: "0.10"
+
+install:
+  - ps: Install-Product node $env:nodejs_version
+  - npm install
+
+test_script:
+  - node --version
+  - npm --version
+  - cmd: npm test
+
+build: off
+
+version: "{build}"

index.js

@@ -0,0 +1,72 @@
+'use strict';
+
+var inspect = require('util').inspect;
+var isPlainObject = require('lodash.isplainobject');
+
+module.exports = function(obj, callback, opts) {
+  if (!isPlainObject(obj)) {
+    throw new TypeError('1st argument needs to be a plain object: ' +
+      inspect(obj));
+  }
+
+  if (typeof callback !== 'function') {
+    throw new TypeError('2nd argument needs to be a function: ' +
+      inspect(callback));
+  }
+
+  if (opts == null) {
+    opts = {};
+  } else if (!isPlainObject(opts)) {
+    throw new TypeError('3rd argument needs to be an object: ' +
+      inspect(opts));
+  }
+
+  if (opts.sort != null && typeof opts.sort !== 'function') {
+    throw new TypeError('The `sort` property in 3rd argument needs to be a ' +
+      'function: ' + inspect(opts));
+  }
+
+  opts.depth = 0;
+
+  foreachNode(obj, '', callback, opts);
+};
+
+function foreachNode(node, basekey, callback, info) {
+  var keys = Object.keys(node);
+  if (typeof info.sort === 'function') {
+    keys = info.sort(keys);
+  }
+
+  for (var i = 0, n = keys.length; i < n; i++) {
+    var key = keys[i];
+    var keychain = basekey + '.' + key;
+    var value = node[key];
+
+    var childinfo = createChildInfo(info, node, i, n);
+
+    if (callback(value, keychain.slice(1), childinfo)) {
+      continue;
+    }
+
+    if (isPlainObject(value)) {
+      foreachNode(value, keychain, callback, childinfo);
+    }
+  }
+}
+
+function createChildInfo(info, node, i, n) {
+  var childinfo = {};
+
+  var keys = Object.keys(info);
+  for (var j = 0; j < keys.length; j++) {
+    var key = keys[j];
+    childinfo[key] = info[key];
+  }
+
+  childinfo.index = i;
+  childinfo.count = n;
+  childinfo.depth = info.depth + 1;
+  childinfo.parent = node;
+
+  return childinfo;
+}

package.json

@@ -0,0 +1,36 @@
+{
+  "name": "each-props",
+  "version": "0.1.0",
+  "description": "Process each properties deeply.",
+  "main": "index.js",
+  "scripts": {
+    "lint": "eslint .",
+    "test": "mocha",
+    "coverage": "istanbul cover _mocha"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/sttk/each-props.git"
+  },
+  "keywords": [
+    "object",
+    "property",
+    "deep"
+  ],
+  "author": "Takayuki Sato",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/sttk/each-props/issues"
+  },
+  "homepage": "https://github.com/sttk/each-props#readme",
+  "dependencies": {
+    "lodash.isplainobject": "^4.0.6"
+  },
+  "devDependencies": {
+    "chai": "^3.5.0",
+    "eslint": "^3.6.1",
+    "istanbul": "^0.4.5",
+    "mocha": "^3.1.0",
+    "testrun": "^0.7.0"
+  }
+}