initial commit

Author: skratchdot

.gitignore

@@ -0,0 +1,5 @@
+_ignore/
+node_modules/
+.DS_Store
+.npm-debug.log
+.project

.jshintrc

@@ -0,0 +1,21 @@
+{
+  "curly": false,
+  "noempty": true,
+  "newcap": false,
+  "eqeqeq": true,
+  "eqnull": true,
+  "undef": true,
+  "devel": true,
+  "node": true,
+  "browser": true,
+  "evil": false,
+  "latedef": true,
+  "nonew": true,
+  "trailing": true,
+  "immed": true,
+  "smarttabs": true,
+  "strict": true,
+  "globals": {
+    "define": true
+  }
+}

.npmignore

@@ -0,0 +1,7 @@
+.git*
+_ignore/
+.DS_Store
+.gitignore
+.npm-debug.log
+.project
+.travis.yml

.travis.yml

@@ -0,0 +1,5 @@
+language: node_js
+node_js:
+  - '0.10'
+before_script:
+  - npm install -g gulp

LICENSE-MIT

@@ -0,0 +1,22 @@
+Copyright (c) 2014 skratchdot
+
+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.

README.md

@@ -0,0 +1,38 @@
+# object-path-get
+
+[![NPM version](https://badge.fury.io/js/object-path-get.svg)](http://badge.fury.io/js/object-path-get)
+[![Build Status](https://travis-ci.org/skratchdot/object-path-get.png?branch=master)](https://travis-ci.org/skratchdot/object-path-get)
+[![devDependency Status](https://david-dm.org/skratchdot/object-path-get/dev-status.svg)](https://david-dm.org/skratchdot/object-path-get#info=devDependencies)
+
+[![NPM](https://nodei.co/npm/object-path-get.svg)](https://npmjs.org/package/object-path-get)
+
+
+## Description
+
+get values from javascript objects by specifying a path.
+
+by using this library, you can help prevent the following error from occurring:
+```
+Cannot read property 'foo' of undefined
+```
+
+NOTE: I've re-written / used this function so many different times, I decided to publish it
+as a module.
+
+## Getting Started
+
+Install the module with: `npm install object-path-get`
+
+```javascript
+var getPath = require('object-path-get');
+var obj = {foo:{bar:'baz'}};
+getPath(obj, 'foo.bar'); // result: "baz"
+getPath(obj, 'foo.invalidKey', 'cool'); // result: "cool"
+getPath(obj, 'foo|bar', null, '|'); // result: "baz" (with different delimiter)
+```
+
+## License
+
+Copyright (c) 2014 skratchdot  
+Licensed under the MIT license.
+

gulpfile.js

@@ -0,0 +1,27 @@
+'use strict';
+var gulp = require('gulp');
+var jshint = require('gulp-jshint');
+var nodeunit = require('gulp-nodeunit');
+
+gulp.task('jshint', function () {
+	gulp.src('*.js')
+		.pipe(jshint())
+		.pipe(jshint.reporter('default'));
+});
+
+gulp.task('test', function () {
+	gulp.src('test.js')
+		.pipe(nodeunit());
+});
+
+gulp.task('watch', function () {
+	gulp.watch(['*.js'], ['jshint', 'test']);
+});
+
+// setup default task
+gulp.task('default', ['jshint', 'test', 'watch']);
+
+// handle errors
+process.on('uncaughtException', function (e) {
+	console.error(e);
+});

index.js

@@ -0,0 +1,18 @@
+'use strict';
+
+module.exports = exports = function (obj, path, defaultValue, delimiter) {
+	var arr, i;
+	if (typeof path === 'string') {
+		arr = path.split(delimiter || '.');
+		for (i = 0; i < arr.length; i++) {
+			if (obj && obj.hasOwnProperty(arr[i])) {
+				obj = obj[arr[i]];
+			} else {
+				return defaultValue;
+			}
+		}
+		return obj;
+	} else {
+		return defaultValue;
+	}
+};

package.json

@@ -0,0 +1,30 @@
+{
+  "name": "object-path-get",
+  "version": "0.0.1",
+  "description": "get values from javascript objects by specifying a path",
+  "main": "index.js",
+  "scripts": {
+    "test": "gulp test"
+  },
+  "author": "skratchdot",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/skratchdot/object-path-get/issues"
+  },
+  "homepage": "https://github.com/skratchdot/object-path-get",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/skratchdot/object-path-get"
+  },
+  "devDependencies": {
+    "gulp": "^3.8.1",
+    "gulp-jshint": "^1.6.3",
+    "gulp-nodeunit": "0.0.5"
+  },
+  "keywords": [
+    "object",
+    "path",
+    "helper",
+    "deep"
+  ]
+}

test.js

@@ -0,0 +1,95 @@
+'use strict';
+/*
+======== A Handy Little Nodeunit Reference ========
+https://github.com/caolan/nodeunit
+
+Test methods:
+	test.expect(numAssertions)
+	test.done()
+Test assertions:
+	test.ok(value, [message])
+	test.equal(actual, expected, [message])
+	test.notEqual(actual, expected, [message])
+	test.deepEqual(actual, expected, [message])
+	test.notDeepEqual(actual, expected, [message])
+	test.strictEqual(actual, expected, [message])
+	test.notStrictEqual(actual, expected, [message])
+	test.throws(block, [error], [message])
+	test.doesNotThrow(block, [error], [message])
+	test.ifError(value)
+*/
+var getPath = require('./index.js');
+var now = new Date();
+var getDefaultObject = function () {
+	return {
+		nested: {
+			thing: {
+				foo: 'bar'
+			},
+			is: {
+				cool: true
+			}
+		},
+		dataUndefined: undefined,
+		dataDate: now,
+		dataNumber: 42,
+		dataString: 'foo',
+		dataNull: null,
+		dataBoolean: true
+	};
+};
+
+exports['object-path-get'] = {
+	setUp: function (done) {
+		// setup here
+		done();
+	},
+	'types': function (test) {
+		var obj = getDefaultObject();
+		test.expect(8);
+		test.equal(typeof getPath(obj, 'dataUndefined'), 'undefined', 'typeof dataUndefined is wrong');
+		test.equal(typeof getPath(obj, 'dataDate'), 'object', 'typeof dataDate is wrong');
+		test.equal(typeof getPath(obj, 'nested'), 'object', 'typeof nested is wrong');
+		test.equal(typeof getPath(obj, 'nested.thing'), 'object', 'typeof nested.thing is wrong');
+		test.equal(typeof getPath(obj, 'nested.thing.foo'), 'string', 'typeof nested.thing.foo is wrong');
+		test.equal(typeof getPath(obj, 'dataNumber'), 'number', 'typeof dataNumber is wrong');
+		test.equal(typeof getPath(obj, 'dataString'), 'string', 'typeof dataString is wrong');
+		test.equal(typeof getPath(obj, 'dataBoolean'), 'boolean', 'typeof dataBoolean is wrong');
+		test.done();
+	},
+	'missing': function (test) {
+		var obj = getDefaultObject();
+		test.expect(3);
+		test.equal(getPath(obj, 'invalidKey', 'wow'), 'wow', 'invalidKey should return default value (string)');
+		test.equal(getPath(obj, 'invalidKey', null), null, 'invalidKey should return default value (null)');
+		test.equal(getPath(obj, 'nested.invalidKey', 'nested'), 'nested', 'nested.invalidKey should return default value (string)');
+		test.done();
+	},
+	'delimiter': function (test) {
+		var obj = getDefaultObject();
+		test.expect(4);
+		test.equal(getPath(obj, 'nested.is.cool', null, '.'), true, 'nested.is.cool should be true with . delimiter');
+		test.equal(getPath(obj, 'nested|is|cool', null, '|'), true, 'nested|is|cool should be true with | delimiter');
+		test.equal(getPath(obj, 'nested|is|cool', null, '.'), null, 'nested|is|cool should be null with . delimiter');
+		test.equal(getPath(obj, 'nested|is|cool', null), null, 'nested|is|cool should be null with default delimiter');
+		test.done();
+	},
+	'values': function (test) {
+		var obj = getDefaultObject();
+		test.expect(5);
+		test.equal(getPath(obj, 'dataUndefined'), undefined, 'dataUndefined is wrong');
+		test.equal(getPath(obj, 'dataDate'), now, 'dataDate is wrong');
+		test.equal(getPath(obj, 'dataNumber'), 42, 'dataNumber is wrong');
+		test.equal(getPath(obj, 'dataString'), 'foo', 'dataString is wrong');
+		test.equal(getPath(obj, 'dataBoolean'), true, 'dataBoolean is wrong');
+		test.done();
+	},
+	'nested': function (test) {
+		var obj = getDefaultObject();
+		test.expect(3);
+		test.equal(typeof getPath(obj, 'nested'), 'object', 'nested should be an object');
+		test.equal(getPath(obj, 'nested.thing.foo'), 'bar', 'nested.thing.foo should be bar');
+		test.equal(getPath(obj, 'nested.is.cool'), true, 'nested.is.cool should be true');
+		test.done();
+	}
+};