[Pkg-javascript-commits] [node-set-getter] 01/04: Import Upstream version 0.1.0
Sruthi Chandran
srud-guest at moszumanska.debian.org
Sun Oct 16 11:12:37 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-set-getter.
commit 41c5900c12329a630c27a593e4d2935c0d65533f
Author: Sruthi <srud at disroot.org>
Date: Sun Oct 16 16:28:55 2016 +0530
Import Upstream version 0.1.0
---
.editorconfig | 22 +++++
.eslintrc.json | 275 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
.gitattributes | 10 +++
.gitignore | 21 +++++
.travis.yml | 13 +++
.verb.md | 37 ++++++++
LICENSE | 21 +++++
README.md | 109 +++++++++++++++++++++++
example.js | 58 ++++++++++++
index.js | 83 +++++++++++++++++
package.json | 47 ++++++++++
test.js | 97 ++++++++++++++++++++
12 files changed, 793 insertions(+)
diff --git a/.editorconfig b/.editorconfig
new file mode 100644
index 0000000..408d870
--- /dev/null
+++ b/.editorconfig
@@ -0,0 +1,22 @@
+# http://editorconfig.org
+root = true
+
+[*]
+indent_style = space
+end_of_line = lf
+charset = utf-8
+indent_size = 2
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false
+insert_final_newline = false
+
+[**/{actual,fixtures,expected}/**]
+trim_trailing_whitespace = false
+insert_final_newline = false
+
+[**/templates/**]
+trim_trailing_whitespace = false
+insert_final_newline = false
diff --git a/.eslintrc.json b/.eslintrc.json
new file mode 100644
index 0000000..5b78706
--- /dev/null
+++ b/.eslintrc.json
@@ -0,0 +1,275 @@
+{
+ "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..7988154
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,21 @@
+# always ignore files
+*.DS_Store
+*.sublime-*
+
+# test related, or directories generated by tests
+test/actual
+actual
+coverage
+
+# npm
+node_modules
+npm-debug.log
+
+# misc
+_gh_pages
+benchmark
+bower_components
+vendor
+temp
+tmp
+TODO.md
diff --git a/.travis.yml b/.travis.yml
new file mode 100644
index 0000000..b06e148
--- /dev/null
+++ b/.travis.yml
@@ -0,0 +1,13 @@
+sudo: false
+language: node_js
+node_js:
+ - '6'
+ - '5'
+ - '4'
+ - '0.12'
+ - '0.10'
+matrix:
+ fast_finish: true
+ allow_failures:
+ - node_js: '0.10'
+ - node_js: '0.12'
diff --git a/.verb.md b/.verb.md
new file mode 100644
index 0000000..e41f456
--- /dev/null
+++ b/.verb.md
@@ -0,0 +1,37 @@
+## Usage
+
+```js
+var getter = require('{%= name %}');
+```
+
+{%= name %} works like [set-value][] by adding a property to an object or an object hierarchy using dot notation. The main difference is that the property is added using `Object.defineProperty` and is expected to be a getter function that returns a value.
+
+**Example**
+
+```js
+var obj = {};
+
+// root level property
+getter(obj, 'foo', function() {
+ return 'bar';
+});
+console.log(obj.foo);
+//=> 'bar'
+
+// property dot notation
+getter(obj, 'bar.baz', function() {
+ return 'qux';
+});
+console.log(obj.bar.baz);
+//=> 'qux'
+
+// property array notation
+getter(obj, ['beep', 'boop'], function() {
+ return 'bop';
+});
+console.log(obj.beep.boop);
+//=> 'bop'
+```
+
+## API
+{%= apidocs("index.js") %}
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..3f525ab
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016, Brian Woodward.
+
+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..072d3ea
--- /dev/null
+++ b/README.md
@@ -0,0 +1,109 @@
+# set-getter [](https://www.npmjs.com/package/set-getter) [](https://npmjs.org/package/set-getter) [](https://travis-ci.org/doowb/set-getter)
+
+> Create nested getter properties and any intermediary dot notation (`'a.b.c'`) paths
+
+## Install
+
+Install with [npm](https://www.npmjs.com/):
+
+```sh
+$ npm install set-getter --save
+```
+
+## Usage
+
+```js
+var getter = require('set-getter');
+```
+
+set-getter works like [set-value](https://github.com/jonschlinkert/set-value) by adding a property to an object or an object hierarchy using dot notation. The main difference is that the property is added using `Object.defineProperty` and is expected to be a getter function that returns a value.
+
+**Example**
+
+```js
+var obj = {};
+
+// root level property
+getter(obj, 'foo', function() {
+ return 'bar';
+});
+console.log(obj.foo);
+//=> 'bar'
+
+// property dot notation
+getter(obj, 'bar.baz', function() {
+ return 'qux';
+});
+console.log(obj.bar.baz);
+//=> 'qux'
+
+// property array notation
+getter(obj, ['beep', 'boop'], function() {
+ return 'bop';
+});
+console.log(obj.beep.boop);
+//=> 'bop'
+```
+
+## API
+
+### [setGetter](index.js#L27)
+
+Defines a getter function on an object using property path notation.
+
+**Params**
+
+* `obj` **{Object}**: Object to add property to.
+* `prop` **{String|Array}**: Property string or array to add.
+* `getter` **{Function}**: Getter function to add as a property.
+
+**Example**
+
+```js
+var obj = {};
+getter(obj, 'foo', function() {
+ return 'bar';
+});
+```
+
+## Contributing
+
+Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/doowb/set-getter/issues/new).
+
+## Building docs
+
+Generate readme and API documentation with [verb](https://github.com/verbose/verb):
+
+```sh
+$ npm install verb && npm run docs
+```
+
+Or, if [verb](https://github.com/verbose/verb) is installed globally:
+
+```sh
+$ verb
+```
+
+## Running tests
+
+Install dev dependencies:
+
+```sh
+$ npm install -d && npm test
+```
+
+## Author
+
+**Brian Woodward**
+
+* [github/doowb](https://github.com/doowb)
+* [twitter/doowb](http://twitter.com/doowb)
+
+## License
+
+Copyright © 2016, [Brian Woodward](https://github.com/doowb).
+Released under the [MIT license](https://github.com/doowb/set-getter/blob/master/LICENSE).
+
+***
+
+_This file was generated by [verb](https://github.com/verbose/verb), v0.9.0, on April 29, 2016._
\ No newline at end of file
diff --git a/example.js b/example.js
new file mode 100644
index 0000000..f37547c
--- /dev/null
+++ b/example.js
@@ -0,0 +1,58 @@
+'use strict';
+
+var toPath = require('to-object-path');
+var getter = require('./');
+
+/**
+ * Normal getters on an object. Just returning strings.
+ */
+
+var obj = {};
+
+// root level property
+getter(obj, 'foo', function() {
+ return 'bar';
+});
+console.log(obj.foo);
+
+// property dot notation
+getter(obj, 'bar.baz', function() {
+ return 'qux';
+});
+console.log(obj.bar.baz);
+
+// property array notation
+getter(obj, ['beep', 'boop'], function() {
+ return 'bop';
+});
+console.log(obj.beep.boop);
+
+/**
+ * Advanced getter that caches results to ensure work is only done once.
+ */
+
+var lazy = function(requireFn) {
+ var cache = {};
+ return function fn(name, alias) {
+ var key = toPath(alias || name);
+ return getter(fn, alias || name, function() {
+ return cache[key] || (cache[key] = requireFn(name));
+ });
+ };
+};
+
+var calls = {};
+var utils = lazy(function(key) {
+ calls[key] = (calls[key] || 0) + 1;
+ return key.toUpperCase();
+});
+
+utils('foo');
+utils('qux', 'bar.baz');
+utils('bop', ['beep', 'boop']);
+
+// show that the lazy getter function is only called once for each property.
+console.log(utils.foo, utils.foo);
+console.log(utils.bar.baz, utils.bar.baz);
+console.log(utils.beep.boop, utils.beep.boop);
+console.log(calls);
diff --git a/index.js b/index.js
new file mode 100644
index 0000000..ce9a6a0
--- /dev/null
+++ b/index.js
@@ -0,0 +1,83 @@
+/*!
+ * set-getter (https://github.com/doowb/set-getter)
+ *
+ * Copyright (c) 2016, Brian Woodward.
+ * Licensed under the MIT License.
+ */
+
+'use strict';
+
+var toPath = require('to-object-path');
+
+/**
+ * Defines a getter function on an object using property path notation.
+ *
+ * ```js
+ * var obj = {};
+ * getter(obj, 'foo', function() {
+ * return 'bar';
+ * });
+ * ```
+ * @param {Object} `obj` Object to add property to.
+ * @param {String|Array} `prop` Property string or array to add.
+ * @param {Function} `getter` Getter function to add as a property.
+ * @api public
+ */
+
+function setGetter(obj, prop, getter) {
+ var key = toPath(arguments);
+ return define(obj, key, getter);
+}
+
+/**
+ * Define getter function on object or object hierarchy using dot notation.
+ *
+ * @param {Object} `obj` Object to define getter property on.
+ * @param {String} `prop` Property string to define.
+ * @param {Function} `getter` Getter function to define.
+ * @return {Object} Returns original object.
+ */
+
+function define(obj, prop, getter) {
+ if (!~prop.indexOf('.')) {
+ defineProperty(obj, prop, getter);
+ return obj;
+ }
+
+ var keys = prop.split('.');
+ var last = keys.pop();
+ var target = obj;
+ var key;
+
+ while ((key = keys.shift())) {
+ while (key.slice(-1) === '\\') {
+ key = key.slice(0, -1) + '.' + keys.shift();
+ }
+ target = target[key] || (target[key] = {});
+ }
+
+ defineProperty(target, last, getter);
+ return obj;
+}
+
+/**
+ * Define getter function on object as a configurable and enumerable property.
+ *
+ * @param {Object} `obj` Object to define property on.
+ * @param {String} `prop` Property to define.
+ * @param {Function} `getter` Getter function to define.
+ */
+
+function defineProperty(obj, prop, getter) {
+ Object.defineProperty(obj, prop, {
+ configurable: true,
+ enumerable: true,
+ get: getter
+ });
+}
+
+/**
+ * Expose `setGetter`
+ */
+
+module.exports = setGetter;
diff --git a/package.json b/package.json
new file mode 100644
index 0000000..cb8a035
--- /dev/null
+++ b/package.json
@@ -0,0 +1,47 @@
+{
+ "name": "set-getter",
+ "description": "Create nested getter properties and any intermediary dot notation (`'a.b.c'`) paths",
+ "version": "0.1.0",
+ "homepage": "https://github.com/doowb/set-getter",
+ "author": "Brian Woodward (https://github.com/doowb)",
+ "repository": "doowb/set-getter",
+ "bugs": {
+ "url": "https://github.com/doowb/set-getter/issues"
+ },
+ "license": "MIT",
+ "files": [
+ "index.js"
+ ],
+ "main": "index.js",
+ "engines": {
+ "node": ">=0.10.0"
+ },
+ "scripts": {
+ "test": "mocha"
+ },
+ "dependencies": {
+ "to-object-path": "^0.3.0"
+ },
+ "devDependencies": {
+ "gulp-format-md": "^0.1.9",
+ "mocha": "^2.4.5"
+ },
+ "keywords": [],
+ "verb": {
+ "plugins": [
+ "gulp-format-md"
+ ],
+ "reflinks": [
+ "verb",
+ "set-value"
+ ],
+ "layout": "default",
+ "toc": false,
+ "tasks": [
+ "readme"
+ ],
+ "lint": {
+ "reflinks": true
+ }
+ }
+}
diff --git a/test.js b/test.js
new file mode 100644
index 0000000..ece8350
--- /dev/null
+++ b/test.js
@@ -0,0 +1,97 @@
+'use strict';
+
+require('mocha');
+var assert = require('assert');
+var getter = require('./');
+
+describe('set-getter', function() {
+ it('should export a function', function() {
+ assert.equal(typeof getter, 'function');
+ });
+
+ it('should set a getter on an object', function() {
+ var obj = {};
+ getter(obj, 'foo', function() {
+ return 'bar';
+ });
+
+ assert('foo' in obj);
+ assert.equal(typeof obj.foo, 'string');
+ assert.equal(obj.foo, 'bar');
+ });
+
+ it('should only call the getter once', function() {
+ var calls = 0;
+ var cache = {}, obj = {};
+
+ getter(obj, 'foo', function() {
+ if (cache.foo) return cache.foo;
+ calls++;
+ return (cache.foo = 'bar');
+ });
+
+ assert.equal(calls, 0);
+
+ assert('foo' in obj);
+ assert.equal(calls, 0);
+
+ assert.equal(typeof obj.foo, 'string');
+ assert.equal(calls, 1);
+
+ assert.equal(obj.foo, 'bar');
+ assert.equal(calls, 1);
+ });
+
+ it('should expose the object as "this" in the getter', function() {
+ var obj = {abc: 'xyz'};
+
+ getter(obj, 'foo', function() {
+ assert.equal(this.abc, 'xyz');
+ return 'bar';
+ });
+
+ assert('foo' in obj);
+ assert.equal(typeof obj.foo, 'string');
+ assert.equal(obj.foo, 'bar');
+ });
+
+ it('should add getter to an object hierarchy using dot notation', function() {
+ var obj = {};
+ getter(obj, 'foo.bar', function() {
+ return 'beep';
+ });
+
+ getter(obj, 'foo.baz', function() {
+ return 'boop';
+ });
+
+ assert('foo' in obj);
+ assert.equal(typeof obj.foo, 'object');
+ assert('bar' in obj.foo);
+ assert('baz' in obj.foo);
+ assert.equal(typeof obj.foo.bar, 'string');
+ assert.equal(typeof obj.foo.baz, 'string');
+ assert.equal(obj.foo.bar, 'beep');
+ assert.equal(obj.foo.baz, 'boop');
+ });
+
+ it('should add getter to an object hierarchy using array notation', function() {
+ var obj = {};
+ getter(obj, ['foo', 'bar'], function() {
+ return 'beep';
+ });
+
+ getter(obj, ['foo', 'baz'], function() {
+ return 'boop';
+ });
+
+ assert('foo' in obj);
+ assert.equal(typeof obj.foo, 'object');
+ assert('bar' in obj.foo);
+ assert('baz' in obj.foo);
+ assert.equal(typeof obj.foo.bar, 'string');
+ assert.equal(typeof obj.foo.baz, 'string');
+ assert.equal(obj.foo.bar, 'beep');
+ assert.equal(obj.foo.baz, 'boop');
+ });
+});
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-javascript/node-set-getter.git
More information about the Pkg-javascript-commits
mailing list