[Pkg-javascript-commits] [node-static-extend] 01/05: Import Upstream version 0.1.2
Sruthi Chandran
srud-guest at moszumanska.debian.org
Thu Oct 27 14:53:21 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-static-extend.
commit 573309b70c8670c038e9032e2f986882751d9992
Author: Sruthi <srud at disroot.org>
Date: Thu Oct 27 20:08:28 2016 +0530
Import Upstream version 0.1.2
---
.editorconfig | 22 +++++
.eslintrc.json | 275 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++
.gitattributes | 10 +++
.gitignore | 15 ++++
.travis.yml | 12 +++
.verb.md | 7 ++
LICENSE | 21 +++++
README.md | 92 +++++++++++++++++++
fixtures/app.js | 22 +++++
index.js | 90 +++++++++++++++++++
package.json | 63 +++++++++++++
test.js | 145 ++++++++++++++++++++++++++++++
12 files changed, 774 insertions(+)
diff --git a/.editorconfig b/.editorconfig
new file mode 100644
index 0000000..991900b
--- /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
+
+[test/**]
+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..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..09768f0
--- /dev/null
+++ b/.travis.yml
@@ -0,0 +1,12 @@
+sudo: false
+language: node_js
+node_js:
+ - "stable"
+ - "5"
+ - "4"
+ - "0.12"
+ - "0.10"
+matrix:
+ fast_finish: true
+ allow_failures:
+ - node_js: "0.10"
diff --git a/.verb.md b/.verb.md
new file mode 100644
index 0000000..e0e007a
--- /dev/null
+++ b/.verb.md
@@ -0,0 +1,7 @@
+## Usage
+
+```js
+var extend = require('{%= name %}');
+```
+## API
+{%= apidocs('index.js') %}
\ No newline at end of file
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..e28e603
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 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..a329dc3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,92 @@
+# static-extend [](https://www.npmjs.com/package/static-extend) [](https://npmjs.org/package/static-extend) [](https://travis-ci.org/jonschlinkert/static-extend)
+
+Adds a static `extend` method to a class, to simplify inheritance. Extends the static properties, prototype properties, and descriptors from a `Parent` constructor onto `Child` constructors.
+
+## Install
+
+Install with [npm](https://www.npmjs.com/):
+
+```sh
+$ npm install static-extend --save
+```
+
+## Usage
+
+```js
+var extend = require('static-extend');
+```
+
+## API
+
+### [extend](index.js#L47)
+
+Returns a function for extending the static properties, prototype properties, and descriptors from the `Parent` constructor onto `Child` constructors.
+
+**Params**
+
+* `Parent` **{Function}**: Parent ctor
+* `extendFn` **{Function}**: Optional extend function for handling any necessary custom merging. Useful when updating methods that require a specific prototype.
+* `Child` **{Function}**: Child ctor
+* `proto` **{Object}**: Optionally pass additional prototype properties to inherit.
+* `returns` **{Object}**
+
+**Example**
+
+```js
+var extend = require('static-extend');
+Parent.extend = extend(Parent);
+
+// optionally pass a custom merge function as the second arg
+Parent.extend = extend(Parent, function(Child) {
+ Child.prototype.mixin = function(key, val) {
+ Child.prototype[key] = val;
+ };
+});
+
+// extend "child" constructors
+Parent.extend(Child);
+
+// optionally define prototype methods as the second arg
+Parent.extend(Child, {
+ foo: function() {},
+ bar: function() {}
+});
+```
+
+## Contributing
+
+This document was generated by [verb-readme-generator](https://github.com/verbose/verb-readme-generator) (a [verb](https://github.com/verbose/verb) generator), please don't edit directly. Any changes to the readme must be made in [.verb.md](.verb.md). See [Building Docs](#building-docs).
+
+Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new). Or visit the [verb-readme-generator](https://github.com/verbose/verb-readme-generator) project to submit bug reports or pull requests for the readme layout template.
+
+## Building docs
+
+Generate readme and API documentation with [verb](https://github.com/verbose/verb):
+
+```sh
+$ npm install -g verb verb-readme-generator && 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/static-extend/blob/master/LICENSE).
+
+***
+
+_This file was generated by [verb](https://github.com/verbose/verb), v0.9.0, on June 09, 2016._
\ No newline at end of file
diff --git a/fixtures/app.js b/fixtures/app.js
new file mode 100644
index 0000000..4f9c66b
--- /dev/null
+++ b/fixtures/app.js
@@ -0,0 +1,22 @@
+function App(options) {
+ this.options = options || {};
+}
+App.prototype.set = function(key, value) {
+ this[key] = value;
+ return this;
+};
+App.prototype.get = function(key) {
+ return this[key];
+};
+App.prototype.del = function(key) {
+ delete this[key];
+};
+Object.defineProperty(App.prototype, 'count', {
+ get: function () {
+ return Object.keys(this).length;
+ },
+ set: function () {
+ }
+});
+
+module.exports = App;
\ No newline at end of file
diff --git a/index.js b/index.js
new file mode 100644
index 0000000..f4124b2
--- /dev/null
+++ b/index.js
@@ -0,0 +1,90 @@
+/*!
+ * static-extend <https://github.com/jonschlinkert/static-extend>
+ *
+ * Copyright (c) 2016, Jon Schlinkert.
+ * Licensed under the MIT License.
+ */
+
+'use strict';
+
+var copy = require('object-copy');
+var define = require('define-property');
+var util = require('util');
+
+/**
+ * Returns a function for extending the static properties,
+ * prototype properties, and descriptors from the `Parent`
+ * constructor onto `Child` constructors.
+ *
+ * ```js
+ * var extend = require('static-extend');
+ * Parent.extend = extend(Parent);
+ *
+ * // optionally pass a custom merge function as the second arg
+ * Parent.extend = extend(Parent, function(Child) {
+ * Child.prototype.mixin = function(key, val) {
+ * Child.prototype[key] = val;
+ * };
+ * });
+ *
+ * // extend "child" constructors
+ * Parent.extend(Child);
+ *
+ * // optionally define prototype methods as the second arg
+ * Parent.extend(Child, {
+ * foo: function() {},
+ * bar: function() {}
+ * });
+ * ```
+ * @param {Function} `Parent` Parent ctor
+ * @param {Function} `extendFn` Optional extend function for handling any necessary custom merging. Useful when updating methods that require a specific prototype.
+ * @param {Function} `Child` Child ctor
+ * @param {Object} `proto` Optionally pass additional prototype properties to inherit.
+ * @return {Object}
+ * @api public
+ */
+
+function extend(Parent, extendFn) {
+ if (typeof Parent !== 'function') {
+ throw new TypeError('expected Parent to be a function.');
+ }
+
+ return function(Ctor, proto) {
+ if (typeof Ctor !== 'function') {
+ throw new TypeError('expected Ctor to be a function.');
+ }
+
+ util.inherits(Ctor, Parent);
+ copy(Ctor, Parent);
+
+ // proto can be null or a plain object
+ if (typeof proto === 'object') {
+ var obj = Object.create(proto);
+
+ for (var k in obj) {
+ Ctor.prototype[k] = obj[k];
+ }
+ }
+
+ // keep a reference to the parent prototype
+ define(Ctor.prototype, '_parent_', {
+ configurable: true,
+ set: function() {},
+ get: function() {
+ return Parent.prototype;
+ }
+ });
+
+ if (typeof extendFn === 'function') {
+ extendFn(Ctor, Parent);
+ }
+
+ Ctor.extend = extend(Ctor, extendFn);
+ };
+};
+
+/**
+ * Expose `extend`
+ */
+
+module.exports = extend;
diff --git a/package.json b/package.json
new file mode 100644
index 0000000..a63ab95
--- /dev/null
+++ b/package.json
@@ -0,0 +1,63 @@
+{
+ "name": "static-extend",
+ "description": "Adds a static `extend` method to a class, to simplify inheritance. Extends the static properties, prototype properties, and descriptors from a `Parent` constructor onto `Child` constructors.",
+ "version": "0.1.2",
+ "homepage": "https://github.com/jonschlinkert/static-extend",
+ "author": "Jon Schlinkert (https://github.com/jonschlinkert)",
+ "repository": "jonschlinkert/static-extend",
+ "bugs": {
+ "url": "https://github.com/jonschlinkert/static-extend/issues"
+ },
+ "license": "MIT",
+ "files": [
+ "index.js"
+ ],
+ "main": "index.js",
+ "engines": {
+ "node": ">=0.10.0"
+ },
+ "scripts": {
+ "test": "mocha"
+ },
+ "dependencies": {
+ "define-property": "^0.2.5",
+ "object-copy": "^0.1.0"
+ },
+ "devDependencies": {
+ "gulp-format-md": "^0.1.9",
+ "mocha": "^2.5.3"
+ },
+ "keywords": [
+ "class",
+ "ctor",
+ "descriptor",
+ "extend",
+ "extends",
+ "inherit",
+ "inheritance",
+ "merge",
+ "method",
+ "prop",
+ "properties",
+ "property",
+ "prototype"
+ ],
+ "verb": {
+ "run": true,
+ "toc": false,
+ "layout": "default",
+ "tasks": [
+ "readme"
+ ],
+ "plugins": [
+ "gulp-format-md"
+ ],
+ "reflinks": [
+ "verb",
+ "verb-readme-generator"
+ ],
+ "lint": {
+ "reflinks": true
+ }
+ }
+}
diff --git a/test.js b/test.js
new file mode 100644
index 0000000..31d9309
--- /dev/null
+++ b/test.js
@@ -0,0 +1,145 @@
+'use strict';
+
+require('mocha');
+var App = require('./fixtures/app');
+var assert = require('assert');
+var extend = require('./');
+
+describe('extend', function() {
+ var Parent;
+ var Ctor;
+ var proto;
+
+ beforeEach(function() {
+ Parent = function() {}
+ Parent.foo = 'bar';
+ Parent.prototype.a = function() {};
+ Parent.prototype.b = function() {};
+ Parent.prototype.c = function() {};
+ Object.defineProperty(Parent.prototype, 'count', {
+ get: function() {
+ return Object.keys(this).length;
+ },
+ set: function() {}
+ });
+ Ctor = function() {
+ Parent.call(this);
+ };
+ proto = App.prototype;
+ });
+
+ it('should add `Parent.prototype` to `Ctor` instances as `_parent_`', function() {
+ var ext = extend(Parent);
+ var instance1 = new Ctor();
+ assert.equal(typeof instance1._parent_, 'undefined');
+ ext(Ctor);
+ var instance2 = new Ctor();
+ assert.equal(typeof instance2._parent_, 'object');
+ assert.deepEqual(instance2._parent_, Parent.prototype);
+ });
+
+ it('should access `Parent` methods through `_parent_`', function() {
+ Parent.prototype.upper = function(str) {
+ return str.toUpperCase();
+ };
+
+ var ext = extend(Parent);
+ ext(Ctor);
+
+ var instance = new Ctor();
+ assert.equal(instance.upper('foo'), 'FOO');
+
+ instance.upper = function(str) {
+ return str;
+ };
+ assert.equal(instance.upper('foo'), 'foo');
+
+ instance.upper = function(str) {
+ return this._parent_.upper(str) + ' ' + str;
+ };
+ assert.equal(instance.upper('foo'), 'FOO foo');
+ });
+
+ it('should add static methods to Ctor:', function() {
+ var ext = extend(Parent);
+ ext(Ctor);
+ assert(typeof Ctor.extend === 'function');
+ assert(Ctor.foo === 'bar');
+ });
+
+ it('should add an extend method to Parent to add static methods to Ctor:', function() {
+ Parent.extend = extend(Parent);
+ Parent.extend(Ctor);
+ assert(typeof Ctor.extend === 'function');
+ assert(Ctor.foo === 'bar');
+ });
+
+ it('should add prototype methods to Ctor:', function() {
+ var ext = extend(Parent);
+ ext(Ctor);
+ assert(typeof Ctor.prototype.a === 'function');
+ assert(typeof Ctor.prototype.b === 'function');
+ assert(typeof Ctor.prototype.c === 'function');
+ });
+
+ it('should add descriptors to Ctor:', function() {
+ var ext = extend(Parent);
+ ext(Ctor);
+ });
+
+ it('should copy prototype properties to Ctor:', function() {
+ var ext = extend(Parent);
+ ext(Ctor, App.prototype);
+ assert(typeof Ctor.prototype.get === 'function');
+ assert(typeof Ctor.prototype.set === 'function');
+ assert(typeof Ctor.prototype.del === 'function');
+ });
+
+ it('should add a mixin method to the prototype of Ctor using `extend` function:', function() {
+ var ext = extend(Parent, function(Child) {
+ Child.prototype.mixin = function(key, val) {
+ Child.prototype[key] = val;
+ };
+ });
+ ext(Ctor, App.prototype);
+ assert(typeof Ctor.prototype.mixin === 'function');
+ assert(typeof Ctor.prototype.get === 'function');
+ assert(typeof Ctor.prototype.set === 'function');
+ assert(typeof Ctor.prototype.del === 'function');
+ });
+
+ it('should mixin methods to the Ctor.prototype using `extend` function:', function() {
+ var ext = extend(Parent, function(Child) {
+ Child.prototype.mixin = function(key, val) {
+ Child.prototype[key] = val;
+ };
+ });
+ ext(Ctor, App.prototype);
+ var app = new Ctor();
+ app.mixin('foo', function() {});
+ assert.equal(typeof Ctor.prototype.foo, 'function');
+ });
+
+ it('should throw an error when Parent is not a function:', function(cb) {
+ try {
+ extend('foo');
+ cb(new Error('expected an error'));
+ cb();
+ } catch (err) {
+ assert.equal(err.message, 'expected Parent to be a function.');
+ cb();
+ }
+ });
+
+ it('should throw an error when Ctor is not a function:', function(cb) {
+ try {
+ extend(function Foo() {})('bar')
+ cb(new Error('expected an error'));
+ cb();
+ } catch (err) {
+ assert.equal(err.message, 'expected Ctor to be a function.');
+ cb();
+ }
+ });
+});
+
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-javascript/node-static-extend.git
More information about the Pkg-javascript-commits
mailing list