pax_global_header 0000666 0000000 0000000 00000000064 12733117470 0014517 g ustar 00root root 0000000 0000000 52 comment=d860297eb6b98f6f5b10b40ec43d8550eba07499
base-d860297eb6b98f6f5b10b40ec43d8550eba07499/ 0000775 0000000 0000000 00000000000 12733117470 0017370 5 ustar 00root root 0000000 0000000 base-d860297eb6b98f6f5b10b40ec43d8550eba07499/.editorconfig 0000664 0000000 0000000 00000000612 12733117470 0022044 0 ustar 00root root 0000000 0000000 # 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
base-d860297eb6b98f6f5b10b40ec43d8550eba07499/.eslintrc.json 0000664 0000000 0000000 00000007147 12733117470 0022175 0 ustar 00root root 0000000 0000000 {
"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 }],
"keyword-spacing": [2, {"before": true, "after": true}],
"key-spacing": [2, { "beforeColon": false, "afterColon": 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-labels": 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": 2,
"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"]
}
}
base-d860297eb6b98f6f5b10b40ec43d8550eba07499/.gitattributes 0000664 0000000 0000000 00000000200 12733117470 0022253 0 ustar 00root root 0000000 0000000 # Enforce Unix newlines
* text eol=lf
# binaries
*.ai binary
*.psd binary
*.jpg binary
*.gif binary
*.png binary
*.jpeg binary
base-d860297eb6b98f6f5b10b40ec43d8550eba07499/.gitignore 0000664 0000000 0000000 00000000221 12733117470 0021353 0 ustar 00root root 0000000 0000000 *.DS_Store
*.sublime-*
_gh_pages
bower_components
node_modules
npm-debug.log
actual
test/actual
temp
tmp
TODO.md
vendor
.idea
benchmark
coverage
base-d860297eb6b98f6f5b10b40ec43d8550eba07499/.travis.yml 0000664 0000000 0000000 00000000236 12733117470 0021502 0 ustar 00root root 0000000 0000000 sudo: false
language: node_js
node_js:
- "stable"
- "5"
- "4"
- "0.12"
- "0.10"
matrix:
fast_finish: true
allow_failures:
- node_js: "0.10"
base-d860297eb6b98f6f5b10b40ec43d8550eba07499/.verb.md 0000664 0000000 0000000 00000006611 12733117470 0020732 0 ustar 00root root 0000000 0000000 {{#block "logo"}}
{{/block}}
{{#block "about"}}
## What is Base?
Base is a framework for rapidly creating high quality node.js applications, using plugins like building blocks.
### Guiding principles
The core team follows these principles to help guide API decisions:
- **Compact API surface**: The smaller the API surface, the easier the library will be to learn and use.
- **Easy to extend**: Implementors can use any npm package, and write plugins in pure JavaScript. If you're building complex apps, Base simplifies inheritance.
- **Easy to test**: No special setup should be required to unit test `Base` or base plugins
### Minimal API surface
[The API](#api) was designed to provide only the minimum necessary functionality for creating a useful application, with or without [plugins](#plugins).
**Base core**
Base itself ships with only a handful of [useful methods](#api), such as:
- `.set`: for setting values on the instance
- `.get`: for getting values from the instance
- `.has`: to check if a property exists on the instance
- `.define`: for setting non-enumerable values on the instance
- `.use`: for adding plugins
**Be generic**
When deciding on method to add or remove, we try to answer these questions:
1. Will all or most Base applications need this method?
1. Will this method encourage practices or enforce conventions that are beneficial to implementors?
1. Can or should this be done in a plugin instead?
### Composability
**Plugin system**
It couldn't be easier to extend Base with any features or custom functionality you can think of.
Base plugins are just functions that take an instance of `Base`:
```js
var base = new Base();
function plugin(base) {
// do plugin stuff, in pure JavaScript
}
// use the plugin
base.use(plugin);
```
**Inheritance**
Easily inherit Base using `.extend`:
```js
var Base = require('{%= name %}');
function MyApp() {
Base.call(this);
}
Base.extend(MyApp);
var app = new MyApp();
app.set('a', 'b');
app.get('a');
//=> 'b';
```
**Inherit or instantiate with a namespace**
By default, the `.get`, `.set` and `.has` methods set and get values from the root of the `base` instance. You can customize this using the `.namespace` method exposed on the exported function. For example:
```js
var Base = require('{%= name %}');
// get and set values on the `base.cache` object
var base = Base.namespace('cache');
var app = base();
app.set('foo', 'bar');
console.log(app.cache.foo);
//=> 'bar'
```
{{/block}}
## API
**Usage**
```js
var Base = require('base');
var app = new Base();
app.set('foo', 'bar');
console.log(app.foo);
//=> 'bar'
```
{%= apidocs("index.js") %}
## In the wild
The following node.js applications were built with `Base`:
- [assemble][]
- [verb][]
- [generate][]
- [scaffold][]
- [boilerplate][]
## Test coverage
```
{%= coverage('coverage/summary.txt') %}
```
## History
**v0.11.0 - major breaking changes!**
- Static `.use` and `.run` methods are now non-enumerable
**v0.9.0 - major breaking changes!**
- `.is` no longer takes a function, a string must be passed
- all remaining `.debug` code has been removed
- `app._namespace` was removed (related to `debug`)
- `.plugin`, `.use`, and `.define` no longer emit events
- `.assertPlugin` was removed
- `.lazy` was removed base-d860297eb6b98f6f5b10b40ec43d8550eba07499/LICENSE 0000664 0000000 0000000 00000002100 12733117470 0020366 0 ustar 00root root 0000000 0000000 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.
base-d860297eb6b98f6f5b10b40ec43d8550eba07499/README.md 0000664 0000000 0000000 00000040542 12733117470 0020654 0 ustar 00root root 0000000 0000000 # base [](https://www.npmjs.com/package/base) [](https://npmjs.org/package/base) [](https://travis-ci.org/node-base/base)
## What is Base?
Base is a framework for rapidly creating high quality node.js applications, using plugins like building blocks.
### Guiding principles
The core team follows these principles to help guide API decisions:
* **Compact API surface**: The smaller the API surface, the easier the library will be to learn and use.
* **Easy to extend**: Implementors can use any npm package, and write plugins in pure JavaScript. If you're building complex apps, Base simplifies inheritance.
* **Easy to test**: No special setup should be required to unit test `Base` or base plugins
### Minimal API surface
[The API](#api) was designed to provide only the minimum necessary functionality for creating a useful application, with or without [plugins](#plugins).
**Base core**
Base itself ships with only a handful of [useful methods](#api), such as:
* `.set`: for setting values on the instance
* `.get`: for getting values from the instance
* `.has`: to check if a property exists on the instance
* `.define`: for setting non-enumerable values on the instance
* `.use`: for adding plugins
**Be generic**
When deciding on method to add or remove, we try to answer these questions:
1. Will all or most Base applications need this method?
2. Will this method encourage practices or enforce conventions that are beneficial to implementors?
3. Can or should this be done in a plugin instead?
### Composability
**Plugin system**
It couldn't be easier to extend Base with any features or custom functionality you can think of.
Base plugins are just functions that take an instance of `Base`:
```js
var base = new Base();
function plugin(base) {
// do plugin stuff, in pure JavaScript
}
// use the plugin
base.use(plugin);
```
**Inheritance**
Easily inherit Base using `.extend`:
```js
var Base = require('base');
function MyApp() {
Base.call(this);
}
Base.extend(MyApp);
var app = new MyApp();
app.set('a', 'b');
app.get('a');
//=> 'b';
```
**Inherit or instantiate with a namespace**
By default, the `.get`, `.set` and `.has` methods set and get values from the root of the `base` instance. You can customize this using the `.namespace` method exposed on the exported function. For example:
```js
var Base = require('base');
// get and set values on the `base.cache` object
var base = Base.namespace('cache');
var app = base();
app.set('foo', 'bar');
console.log(app.cache.foo);
//=> 'bar'
```
## Install
Install with [npm](https://www.npmjs.com/):
```sh
$ npm install --save base
```
## API
**Usage**
```js
var Base = require('base');
var app = new Base();
app.set('foo', 'bar');
console.log(app.foo);
//=> 'bar'
```
### [Base](index.js#L38)
Create an instance of `Base` with the given `config` and `options`.
**Params**
* `config` **{Object}**: If supplied, this object is passed to [cache-base](https://github.com/jonschlinkert/cache-base) to merge onto the the instance upon instantiation.
* `options` **{Object}**: If supplied, this object is used to initialize the `base.options` object.
**Example**
```js
// initialize with `config` and `options`
var app = new Base({isApp: true}, {abc: true});
app.set('foo', 'bar');
// values defined with the given `config` object will be on the root of the instance
console.log(app.baz); //=> undefined
console.log(app.foo); //=> 'bar'
// or use `.get`
console.log(app.get('isApp')); //=> true
console.log(app.get('foo')); //=> 'bar'
// values defined with the given `options` object will be on `app.options
console.log(app.options.abc); //=> true
```
### [.is](index.js#L101)
Set the given `name` on `app._name` and `app.is*` properties. Used for doing lookups in plugins.
**Params**
* `name` **{String}**
* `returns` **{Boolean}**
**Example**
```js
app.is('foo');
console.log(app._name);
//=> 'foo'
console.log(app.isFoo);
//=> true
app.is('bar');
console.log(app.isFoo);
//=> true
console.log(app.isBar);
//=> true
console.log(app._name);
//=> 'bar'
```
### [.isRegistered](index.js#L139)
Returns true if a plugin has already been registered on an instance.
Plugin implementors are encouraged to use this first thing in a plugin
to prevent the plugin from being called more than once on the same
instance.
**Params**
* `name` **{String}**: The plugin name.
* `register` **{Boolean}**: If the plugin if not already registered, to record it as being registered pass `true` as the second argument.
* `returns` **{Boolean}**: Returns true if a plugin is already registered.
**Events**
* `emits`: `plugin` Emits the name of the plugin being registered. Useful for unit tests, to ensure plugins are only registered once.
**Example**
```js
var base = new Base();
base.use(function(app) {
if (app.isRegistered('myPlugin')) return;
// do stuff to `app`
});
// to also record the plugin as being registered
base.use(function(app) {
if (app.isRegistered('myPlugin', true)) return;
// do stuff to `app`
});
```
### [.use](index.js#L169)
Define a plugin function to be called immediately upon init. Plugins are chainable and expose the following arguments to the plugin function:
* `app`: the current instance of `Base`
* `base`: the [first ancestor instance](#base) of `Base`
**Params**
* `fn` **{Function}**: plugin function to call
* `returns` **{Object}**: Returns the item instance for chaining.
**Example**
```js
var app = new Base()
.use(foo)
.use(bar)
.use(baz)
```
### [.define](index.js#L191)
The `.define` method is used for adding non-enumerable property on the instance. Dot-notation is **not supported** with `define`.
**Params**
* `key` **{String}**: The name of the property to define.
* `value` **{any}**
* `returns` **{Object}**: Returns the instance for chaining.
**Example**
```js
// arbitrary `render` function using lodash `template`
app.define('render', function(str, locals) {
return _.template(str)(locals);
});
```
### [.mixin](index.js#L216)
Mix property `key` onto the Base prototype. If base is inherited using `Base.extend` this method will be overridden by a new `mixin` method that will only add properties to the prototype of the inheriting application.
**Params**
* `key` **{String}**
* `val` **{Object|Array}**
* `returns` **{Object}**: Returns the `base` instance for chaining.
**Example**
```js
app.mixin('foo', function() {
// do stuff
});
```
### [.base](index.js#L262)
Getter/setter used when creating nested instances of `Base`, for storing a reference to the first ancestor instance. This works by setting an instance of `Base` on the `parent` property of a "child" instance. The `base` property defaults to the current instance if no `parent` property is defined.
**Example**
```js
// create an instance of `Base`, this is our first ("base") instance
var first = new Base();
first.foo = 'bar'; // arbitrary property, to make it easier to see what's happening later
// create another instance
var second = new Base();
// create a reference to the first instance (`first`)
second.parent = first;
// create another instance
var third = new Base();
// create a reference to the previous instance (`second`)
// repeat this pattern every time a "child" instance is created
third.parent = second;
// we can always access the first instance using the `base` property
console.log(first.base.foo);
//=> 'bar'
console.log(second.base.foo);
//=> 'bar'
console.log(third.base.foo);
//=> 'bar'
// and now you know how to get to third base ;)
```
### [#use](index.js#L287)
Static method for adding global plugin functions that will be added to an instance when created.
**Params**
* `fn` **{Function}**: Plugin function to use on each instance.
* `returns` **{Object}**: Returns the `Base` constructor for chaining
**Example**
```js
Base.use(function(app) {
app.foo = 'bar';
});
var app = new Base();
console.log(app.foo);
//=> 'bar'
```
### [#extend](index.js#L331)
Static method for inheriting the prototype and static methods of the `Base` class. This method greatly simplifies the process of creating inheritance-based applications. See [static-extend](https://github.com/jonschlinkert/static-extend) for more details.
**Params**
* `Ctor` **{Function}**: constructor to extend
* `methods` **{Object}**: Optional prototype properties to mix in.
* `returns` **{Object}**: Returns the `Base` constructor for chaining
**Example**
```js
var extend = cu.extend(Parent);
Parent.extend(Child);
// optional methods
Parent.extend(Child, {
foo: function() {},
bar: function() {}
});
```
### [#mixin](index.js#L373)
Used for adding methods to the `Base` prototype, and/or to the prototype of child instances. When a mixin function returns a function, the returned function is pushed onto the `.mixins` array, making it available to be used on inheriting classes whenever `Base.mixins()` is called (e.g. `Base.mixins(Child)`).
**Params**
* `fn` **{Function}**: Function to call
* `returns` **{Object}**: Returns the `Base` constructor for chaining
**Example**
```js
Base.mixin(function(proto) {
proto.foo = function(msg) {
return 'foo ' + msg;
};
});
```
### [#mixins](index.js#L395)
Static method for running global mixin functions against a child constructor. Mixins must be registered before calling this method.
**Params**
* `Child` **{Function}**: Constructor function of a child class
* `returns` **{Object}**: Returns the `Base` constructor for chaining
**Example**
```js
Base.extend(Child);
Base.mixins(Child);
```
### [#inherit](index.js#L414)
Similar to `util.inherit`, but copies all static properties, prototype properties, and getters/setters from `Provider` to `Receiver`. See [class-utils](https://github.com/jonschlinkert/class-utils#inherit) for more details.
**Params**
* `Receiver` **{Function}**: Receiving (child) constructor
* `Provider` **{Function}**: Providing (parent) constructor
* `returns` **{Object}**: Returns the `Base` constructor for chaining
**Example**
```js
Base.inherit(Foo, Bar);
```
## In the wild
The following node.js applications were built with `Base`:
* [assemble](https://github.com/assemble/assemble)
* [verb](https://github.com/verbose/verb)
* [generate](https://github.com/generate/generate)
* [scaffold](https://github.com/jonschlinkert/scaffold)
* [boilerplate](https://github.com/jonschlinkert/boilerplate)
## Test coverage
```
Statements : 98.95% ( 94/95 )
Branches : 92.31% ( 24/26 )
Functions : 100% ( 17/17 )
Lines : 98.94% ( 93/94 )
```
## History
**v0.11.0 - major breaking changes!**
* Static `.use` and `.run` methods are now non-enumerable
**v0.9.0 - major breaking changes!**
* `.is` no longer takes a function, a string must be passed
* all remaining `.debug` code has been removed
* `app._namespace` was removed (related to `debug`)
* `.plugin`, `.use`, and `.define` no longer emit events
* `.assertPlugin` was removed
* `.lazy` was removed
## Related projects
There are a number of different plugins available for extending base. Let us know if you create your own!
* [base-cwd](https://www.npmjs.com/package/base-cwd): Base plugin that adds a getter/setter for the current working directory. | [homepage](https://github.com/node-base/base-cwd "Base plugin that adds a getter/setter for the current working directory.")
* [base-data](https://www.npmjs.com/package/base-data): adds a `data` method to base-methods. | [homepage](https://github.com/node-base/base-data "adds a `data` method to base-methods.")
* [base-fs](https://www.npmjs.com/package/base-fs): base-methods plugin that adds vinyl-fs methods to your 'base' application for working with the file… [more](https://github.com/node-base/base-fs) | [homepage](https://github.com/node-base/base-fs "base-methods plugin that adds vinyl-fs methods to your 'base' application for working with the file system, like src, dest, copy and symlink.")
* [base-generators](https://www.npmjs.com/package/base-generators): Adds project-generator support to your `base` application. | [homepage](https://github.com/node-base/base-generators "Adds project-generator support to your `base` application.")
* [base-option](https://www.npmjs.com/package/base-option): Adds a few options methods to base, like `option`, `enable` and `disable`. See the readme… [more](https://github.com/node-base/base-option) | [homepage](https://github.com/node-base/base-option "Adds a few options methods to base, like `option`, `enable` and `disable`. See the readme for the full API.")
* [base-pipeline](https://www.npmjs.com/package/base-pipeline): base-methods plugin that adds pipeline and plugin methods for dynamically composing streaming plugin pipelines. | [homepage](https://github.com/node-base/base-pipeline "base-methods plugin that adds pipeline and plugin methods for dynamically composing streaming plugin pipelines.")
* [base-pkg](https://www.npmjs.com/package/base-pkg): Plugin for adding a `pkg` method that exposes pkg-store to your base application. | [homepage](https://github.com/node-base/base-pkg "Plugin for adding a `pkg` method that exposes pkg-store to your base application.")
* [base-plugins](https://www.npmjs.com/package/base-plugins): Upgrade's plugin support in base applications to allow plugins to be called any time after… [more](https://github.com/node-base/base-plugins) | [homepage](https://github.com/node-base/base-plugins "Upgrade's plugin support in base applications to allow plugins to be called any time after init.")
* [base-questions](https://www.npmjs.com/package/base-questions): Plugin for base-methods that adds methods for prompting the user and storing the answers on… [more](https://github.com/node-base/base-questions) | [homepage](https://github.com/node-base/base-questions "Plugin for base-methods that adds methods for prompting the user and storing the answers on a project-by-project basis.")
* [base-store](https://www.npmjs.com/package/base-store): Plugin for getting and persisting config values with your base-methods application. Adds a 'store' object… [more](https://github.com/node-base/base-store) | [homepage](https://github.com/node-base/base-store "Plugin for getting and persisting config values with your base-methods application. Adds a 'store' object that exposes all of the methods from the data-store library. Also now supports sub-stores!")
* [base-task](https://www.npmjs.com/package/base-task): base plugin that provides a very thin wrapper around [https://github.com/doowb/composer](https://github.com/doowb/composer) for adding task methods to… [more](https://github.com/node-base/base-task) | [homepage](https://github.com/node-base/base-task "base plugin that provides a very thin wrapper around for adding task methods to your application.")
## 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
_(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 the readme directly. Any changes to the readme must be made in [.verb.md](.verb.md).)_
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/node-base/base/blob/master/LICENSE).
***
_This file was generated by [verb](https://github.com/verbose/verb), v0.9.0, on June 23, 2016._ base-d860297eb6b98f6f5b10b40ec43d8550eba07499/docs/ 0000775 0000000 0000000 00000000000 12733117470 0020320 5 ustar 00root root 0000000 0000000 base-d860297eb6b98f6f5b10b40ec43d8550eba07499/docs/logo.png 0000775 0000000 0000000 00000242646 12733117470 0022007 0 ustar 00root root 0000000 0000000 PNG
IHDR qy tEXtSoftware Adobe ImageReadyqe< EHIDATxqI\ }4 S'p `2"UrW7c>
; o._ O?]7 oI )Bx,3+C_zw` ^ CY:# 8"; S 1`_1;>` C O=}} V `Z S CMaEՍ= 'S 5jC_u0 N
_־L|}0 !_kYUw 7&p xe1&ԯ__k9݇U9 ^ Ĕ/B7ր+ww) O pd1P5lC
L p<w #)7r+b n=]{0 ^)lE`ƸV !
kk +ww`
[Yܻk Ι 8[1Ua؇ Α 8;1<7宭m۾k Ή 8+11j 1rߚ 8w ,ĔXne
`arݛ ;; 0k1UaC
S s%p f)ܔ܍5 q[nw ى)osWwqkw D FLy j~a
_j7 0w `bʫPKk PC Ɋ)7.wU ݗ]{0 0Ew `bʛܔ[Yਆr}L L :}m
W5tߛ
; 0 1 ކ @L)uk l]{0 .; [Y xeCw}M §}jؾ ) X:; SnsS m]{0 K%p `bc>5 1rߚ % 81uy]X rݛ % 1Ua5 x5t L 8{15 ^ L Ɉ) ob(ڽ) ; 'S^ܥ5 Nb j> S p21{jd
%p BEja vqq w /KY=u q{ێC0 |\*_ O7) > Ry[Z .ƔZ> 'KR W { `
P.9 pu gS rھ \}j GK]=ni
zSj) C p.5 l6 L { ):GsY n ϑ 'p \2q k 6d
_'p EEja L{S <; Oʥv㞬 Mv ) 'RWu ~ ?C3 \2 ozO-tL !H-l pdo{S 7; RxqqE mǡ? [.uS 'mơߙ @ 05 /2O n Y.5 3K-tߛ Ew &Ry C8Ϧ n )~m_X 8sqL
; prwKk fJ-t7 p U˥v+k nZ~0 p ʥy \9n 5 W'{ }~2 pM ȥ.R ۗ nĔZ7 p
˥v<ŭ ܨmf ) K&p .Z.uK\g
q oM \*; pr;k q'S F \\" -}o
R KY=Y l L ;; pr5 >dw Ι 8[eja G1mơL #; pvr5 NbZ7 pN ȥv : !5n; 9 g!z K jo;S _M |\]ja _j{ W _"ڥ pVvS M |\s<q5 Cl
3 OK]=na
O77S A \.uZؾ E⾍C7 pJw dr]8) c GK]wo
2M .; [r]<'k ܴMv ) K]k{g
?C3 w Rw /O ~ iE3 \ ; \\2}i
)n3d
w Eja v{S ȥ>Y ~!5n; p pr- m 8) < RR ۗ R M E g$ڥ 'K-t? D.u S\g
4s:) R|[X >8) RKk ٘R 'p OKy[[ 6n3 y rs>5 q oM C % pqqơL %p ʥ.R -q ) 4 p.uܓ5 l L %p #˥R \9nsߙ G GK]c p3S 'S oʥ.R W یC7 | >(ų{, 7 ` uw \}_ KqL % p1rwKk ) \; g/ R 8k9j e7oM prx- pToO 8+Eja '5M pr]M.g d
ێC0 A ȥR (s>3 &p r5 .~2 "p $r5 .}o
M Ry pqqq X M.>5 n>w \]ja 7i{ ; KR W R # |H.9 Cl
~ _K]=na
>L Sr5 Sܷq [.5
۸8S #w ~(:GsY #9rߚ "p Orx^ 㾍C? ? Eja5 oqM L w㞬 mǡ? n\.uگ5 Bs>3 ܨ\2 ۗ O =w K] {K-tߛ v nD.g Y p{ێC0 ܀\*_ 6L p W,zK \)}2 u \\jZؾ Wh8 E perG[S <; Oʥ.S }ܷq'S 3; ?ȥ.R |[8{S r]<'k GێC0 B.uZؾ pds>3 A.uZؾ pb海) ; @WؾH-l_Y d8{S N ܴ\j:! Eqqq n Yx^ >w n 9Ի5 35=Cn
KR W ..`
K}! pau gS N \\2q k noo JEja R M \; pUr]n3 9 g#zK bJ-tL ; r]ja _bZ7 ʥ>Y K ^ǡ6 U ȥާk ge 8) &p >U..}i
6 ,w SRx (B) S 'K9n p}3 ) ɥ. U}~2 p
w r5 ҔZ7 pLw hr]<'k ܄mf ) c GK]Y q oM .; [r;k ܴq'S %p >$H-l Z7 /ɥv : 8S ?K \*5 s>3 3 ?ʥ.S ۗ 8) #p ~(H-l_Y #إM ; rw 2Eja5 boqM C W"ų{ 7d `
|w Ujw q p pr~l_Z {jd
Lw @Eja 'o{S e ɥv : ^ A "z K qqw 'p 3KK-l_Z >lJ-tL K g*ڥ G{ `
8?w 8Cx :k q8Ϧ "p 3KO5 f
8w 8E< O7 P.)nm
r۸8S ɥQ w 1s5 |>; |\2q k }~2 | ; |\"{k ŘR RxqO یC0 N(J pq ) 4 peja5 꼧O R<ŭ W-}o
8; A.g Y n&n; { r~m_X n>n3 qw \2}i
ߦB عwFl
iB (z)h Z@4iA H&pwMΝ>| kEHHwʥv<- &}g
x;; C.1 ?=ǭǡߛ zگ3k ﴋ gw \Mja 'mS _M &p _ȥv<- &}o
+; M.uڧ Ey GS rx~ͬ .8[S }Z> M;S p \\jC Xǭơߛ k$p *R p^S ݷ Yja ĭơߙ K p "R 㹋 \}sz 9 8gw Z.65 +K7) 8Ww R.&}n
ݏCj
KR Mj ; g#]\g
7q M 9 prx~ͬ !~s1 L ʥR 8mj) 8Ew NN.!ni
/[C7 D IɥNQw RS>EkS p* \<k .8[S |\, jZ3 E ȥv, pRVqq ].uگ5 NߏC1 $p hr~l[ ,oM 1 rYja g%}g
/KYu 8k8{s |\"_g (8S phw *zS mZ5 "p r]ja WeZ3 %p ru Jq M g \mjϬ @ݏCb
>B Rg[ _ئ f.5 xMj 7ɥNQw }5 ; K3nf
>ac ) ; Kϭ mS w E.g`
:n5 /; K]Y #q7 `"p `
穅7 oM p W,:K-l '%}g
$p B.e]\g N*n= E perx f Mq C p%r5 8#۸8[S \>; ˥v<- ۤL p ,]\g
.>9n= G pr> hw?) . RoR
lS _M p ڥ/ ڤM p g.! Wl۟ǡ4 \ |B) Rg k ĭơߙ GKYu {[C7 (zS pv1 q zZ> mj _K r]ja p6qM 5 _$]\g
S<) O p`yF y pe;S N \j2 [ǭơߛ 8Ww lR1 p IʥS 8B) S#p NJ.uZؾ ĭơߙ 8w dR 㹋 p8{s M |\m$H S~? { wɥS}n
5}k
Rg k /;S D Q.gwY =ǭǡߛ ; [xf vqq7 ~` 4#8P4@.#0 0̾ux' ܫʼ#Hgu;1 ! IO f]}!
Xb& `1 2 +$뮶O -be~'
H; $i13i #+? ң )f"\ mݗ t(@BiKm}"
-_e~#
H; $Y1Si 0@ qSp+f:D < Q 8)U3u s!
F&.( `\`d9ͺi 0bm}]淢 Pp(fuCi +E ç WT4E̩4 H] Rp*f<]D" ̗ Qp*4뮶O Җk aQp)fu4 1WuE à PT$u̩4 n ; \Q5L /sSR O
SE՜d4 `m12 ; LQ5YWlI 6fuEQ @(@OU3us.
ؚ۬+/E =PTM[joi ֵu_ vK vY1Si -b2 vC vig ޙg]}!
.w آj&.bΥ wsUR
%E՜ƺH -%Q )U3˺b4 `1guE RT4' Ѹy_B ~
fELb\H F*.( `}`9ͺbT 0zm~+
Xw Xjc]̤ yȺ\ :
ELb4 yYWt_ ^F ^Ӭ> Җۯ2 <; e fb>
}VTiOr; kU zw z+P]: Ze~& H )~*
9|)
D ^Yc Q1J ; QTM[j%f*
XļA ; *' ت; }/ vL `WƧU vw vj$ z.[1 +.3E\f }k1 +.F-J n2? ۦ) ; [U3ՖO 0u/E6(r}̡4 !X mPp` O Pp` FC Sp`c FG Rp`# FK Qp` Fo.Q N
r; @2 J ; k ~TB ; k {{})
^K WSn H; k( )b ; (
J ; Ϧ w("" 3v | ; RTMT f l᪫ Qp/2֩$ ؒUg ' ZF4߈ `2
X1i ˘ D6wUӖ͔ ح~PR @\n `# RpHXP De@UTySI 3n @z
,ֽ$ b H;@b3 =9|!
t 9d _q]($$P Du@:D jNc} tV O Eմzum Y e
qSpjR{[n? 9|)
}̔ iua 1w+<։$ U'8O `2(PQ5X1 `YWr_`\E 0Jיr; 5ͺ #;UsI o 0
#RT4֧4 H2.( a_ 1Sn mW1 ;HUsk& s 0{" 0'I 0l
WTM> [d]})
]d 0ͺ.
;U3u/ q]s1 ;@U3)s >9|)
`S 0ͺn
; U3u/ b w)fSz; zH3I 8 ؞ +5f"
xeA]KQ >I ֣|@SEbK . w 9 =CE\ƚJ 6b 3{" yט4 `c1Gu/D .u vt. /.HQ5X 9|.~p _F( l C '95 l᪻@ ` IO1Si -c2_`\pL v=Py.s `NJf4 `gGu/D;.E vx. [.z h?`7\pح" ^#EbK z. wݹ n(@Q5'f ^:> l;n\ zM`XSI @MW] H `.D e
[z; + []~ E`v $WH `{&' (l 0hl;v
N 6 -Pp0 `\qw 0@ A a
`Tt 6hO QT,ֽ$ `t2`\p (l PT4֯ :A ;f
M w" X?v HA] 1 w* H© w5*fu' [f( w:ɔ mWD ^" ;U35 $e
N $!5U3$ Yu/ :. ;z v*Spxj/L' MV]" ^A ~ ڞ ^i_% e˸:D |F^T gNE r
/TTMD g&n /r?
"U3$ o8|!q eND 5x&w; F Ϥ Eմ_pN$ 5 .w(<_P k8wy$ N:I Ppxߖ I'
PTa$ 5I |;, `t A f" 6`&U3$
9|!/u3 4)|O" 6HG +n& `f" 7w(q" `& Qp7_4 0G [{" [Q5XI ؒ 2_;f" h&)|# mY;f" h& ST$o ,VC^] LV Wt PR YF ڲ"B b E 0J+YdٿVi֕\}Ϻ |A H; 6 Qw~YTM OS )j~ 3ܮ R~',/@9I 5{~ s*
qGu?HѾ Qu +
ls I Hn7" 6 W-b(Y]t 5S r Hُ" ~N O9۫K ml* c2 HLX1W 1= *w) d~'
~~:D e $ɋ jf% $!vc 0^u DME $^m_ZP砨1 #3} HC]{yXX17 Ff* E.Q @B1W"0Nn/C13 #$w U [ }2Aq|6f! `t$ HQQ5K y DA/c e~)
[|NgE|ȺL* L
@2E $P )÷Cq|xa 0 N@r܁MD Cq]g O
O+b }$( `RUQxi?.i?.bN &@ ^}A8랈 HMQ5K yY[lFQ53 z.s]O ). "m]Y'# \I `7Vjf% 2C]既+fuO X{g. . m̑r;NĄq=I -x# 1" zl s
1 [vb R;? hsVGBOMi [$E H 虫oE˘YWtK ' )oD $f* 'Yw}!
qQ5'3o 6k* %
۵Ⱥb\0ly|뮨2 x} ؑeU]0.9} V D D `ncV%X`{s % 2{" RQT4֯ huW碀Us"f*
`
~hmH @J" Y]퐦ܿͺkW 8
w jˬr+Reݽ& < ؠy]m_uᬨľI x&'
@J< E zUs:) ӝ E12?Pn#^3nc \I K
woDD~,c. Q +ͳj(uדEEb_gc I H; -b2 2uTTy싘T QW1G6kMi )r beMl_cL* @*܁ xEY]sQ jfYWtJ $C HD #ڋWu߈/ Us]{ "/ 6@ xl_VY ; y D A^O8+w7Ǎcٺ@2@& #` RcLD hH DY ` hMx$зfeeJȵ"v 6|I &
-g]}'
`sE~ɺT kp' 똩r;p
eoA" ? Y # iE\j xy \y]kw/ ʽg]pxEuET Qp !f]F- i}5A* X܉ B>QnnY
ܦ1ki ca; pMe] VrOoXUͺm_ ; p
YWl߉SQ+& `D XL*[L
0(
XmؾQws$f#
`HE {2m!-}kL* ) cYV Wq̋e]Q* ܉ MD tқ1b&qu ; 0dMveK37f+
E >&w 8EQoq̤ ; 0$Po{ jd]Q* )݉ mT `x7jLcY0 I \Z˼pTl_U%Y* ) ؾx} j̺L* ܉ MD `қ7bqu- |; pNMveH+?4YK { gYm >CKjq|
)[]+Q \{㩨Y
+D 6fp{;bqu; w ؚy]F8&1i ?^ 2.( aeQoq~I ;6 ǰ(w;b 3i w 3E*-cRT*c
Gcir; 8&1[i b; +1o}) >%Oʢڷ8_cfR f; 1v -[[ASֽ% Q
?ibu/M p=K91{k pcE }̺.( 8aUQ%Y* p;lp 'mΝ*p) Oo{ plp jLBQ 0U k̃T z $y]O QVIֽe R6 m;Ĭ2߈*vuܿH
p1v &m$u$>c% w =M̲.s@ F-wڴ?|y
p;1 \m$o% Sp ۰e (1ˬ+7 q \]̲.( wY_c =( EwनUNc p Fɺ WḳT `Xlp Wnߛ澎9H C 'R!o _ߡUݷ a J*/2ߋ >N]Ug/13 ( 8g] _ U k̃T D vȺbT N/oqLb Sp L2߈ '{1+$ s/ &fQ^ p9wSQ8_c~
; >fYM 0 1-9R Ӹ \!f]D +qLb6 Pp L2_ /1ˬ+7 \{̲.F 0> c^T,ί1R Sp :d]}+
aIQ ; lb& p}|y E]{Q EQoq̤ F Ng |'
Ǽ/YWt
w 8.( v튪MEQ3
_
9e][Q )9R |:f a_O = 51 >*%қ`VEn|" n; }Q ?4TT,I [ ,mW}|%
TE>g]A* ܚ; mc& uǷ돘4 56 51~* Y5Hz̲ڷ8̤ -Pp LoN &1/vuEG pD k 3Qn &U&f Y@ \%w Ȳ]W1
c `ŵ&]l 5 7l HQE E@ޢڷ8_cfR Z( pR)lo@ yc^T헬+?J 7f3Qn E\b&qu h) p+i]/ 5*]d} 0J" cuoE \I>j%f& w :붶oE ܒibqu (( pv1W1q ou +Y E* ; uoD }q㩨Y
Cs' F.' ?'&f Y ; cL2_(f 1ɺ `E cR}'
\UטT $ TZgvv #}<>K K 1H}/
Ӊ&IQ w =f^r; ĵ&IV
!f Kdj|I S -T `=f b lp `(e*P `x:mǮU( 8ű+v1R w" o buO 8]1J v( =ۘI_* }">c \{ MmmoD PקMQqWn `Zu4f-
@*M Z\ bV6f' r/ d( :Y1I ` n>( vZTs 0^w" e]v M\nl 0^
a> \=,H `|E p՚.
nE\U;ḳT A :cuoE &IQ a YL ƛ8&1 w 뱋Ye N>ı(-טT G `1Q u{ jd]Q* á 0^i.( utzҮU.k~ >H |R=W1J/ pe:G*o 1" 8e(
nìˢj5f& p:ߊ-uoE %҃jd]Q* N '( m{]$>!X ~@ บ++ 7qJ
1[i { >&w vQTq̤ >'Tm ( 8j( Ν >l3Un >"%SĬY g; {Y[ >,+R}UT6ט/R n; Kœee h>c SQ+& ݉ lb& )7EL" )
?d]=mnW. v pKE ]Eڞ(
lWEn3
p S*e 0qc^T,R ՝ 6f QzT$>.\ eM̼.E 0hq߲#7 ͽ ˺̷ Ƥ8wYTq̤ \ [( c41 0v6 Ye p- gǮU)>c%
b!
PM ӢjnT ! }kUT6ί13 b; 0&ۘr; ccD K &fY( N+=ؤ?|y
p.6 CY
տ=k-Z ( Ce e=!fϲZ 'u/ ``v1˺ Zj( HeTloD 0Lqϖ JU t' YWl* Cܿl ; pII]Q K bq H 8{ dwQ [68_b |
9c2+ \1Y $ |; pؐ
Ӻw NqwYe] E X*4,2ߋ 6OE|M* Pp N=( nSO8-9R ~N >Un m 4 Qp i3|#
*1+7 ^ 4Y] H;U;ḳT Qp >cu( q/1)8_b ܉ C̺.r; 8&1i
L2_ c{C2o4 u/ ',W =gU%טG mQp ![Q pqcWT*c N lb& \B}iR 6 ,2ߋ K{fEQ3
\/w 1U 0qUuEG 6u]v ,[qL}l? \w `3|%
a}l*{P Ƚ f5Y c8T ` /W oO}κT `D 7e 3Qn ! 641 p7lUT6붹
; \}Q pK5Q* 0|
pҶW }O#Η p݉ 6f ɛt
p=u /qϜx,-ί13 ( }q.( =>yQ_|y
Ý `1v uq? ) 8ؾ_ |PN1[i e Fe ˼ O ڷ8_cfR Sp qH?2߈ N'U ḲT |D ( }x Ƭs lp jb8 <WEnnT `x1~S paqEkoR Ӹ JzT 'כi|\ $ ǧ ðe_ T`$ T ^ pQE '
UQ8_cH >O .#|#
TT,ί1R 6f #-f Y`;
p>M̴.Es E 'Ye \eQoq~I ~
p:ummWn S>f x
ik^ pwEծ=A* }6 q2Rn .U 4 lp 8Ĭ2߈ ;u!,}5f& 7 R} cq t 㚘i]~ /|4fuo v/ eTj߉ UQ8_b ~^9mS* V>f 1 ?gN?4 8̛8E> n
ci[>eݛ `lp ּ,2oD \wq슪]{̃T ^]T f&Y; w n6fRF -D { p1 [_dRT* 0t6 puO WqLci 0d
\i- cqs C 5I[S] W& Rp c涶 64 w n7 5 w ) <64 4w ۏuoE yi@">L Qp `lYWnl #
m E( 0&˴I,m iR}+
M 1H}#
K Ң ХaӺQ W]8Y NN !e( ..`u m]Ouآ 44 8%w hQB ÑJl6 T Tnߊ `2_a9 ' P\O SO F !H?2 8ec) pD
\r; HQr h } 0jv&1 ) p)ϩr; e-}; %|{uu' W@ cPp O G Rp Y^ I Pp \Un& Sr 8v G( pO G _ -2o pSֽ ~H SZe m|uܕ !w Ne[F $ugJ w N|! //% Qp ҏOb {2a9 ߥ 1K/2i V_rJ 1-L e7 8u];1 b,L ) p Wb We~#mr?H D gݏ 2O o ~ |H]8֒ @ X S2_ű mSp ࣚ7b 1{1 .w >ٻ㶑 jyN
XHh2f g@g֖EJ^|xo e# \Ue^>X `Lw .uh< ߥry 0 ; X q|E `0w .qjR % "p \w )Qw slײn R p 7OB uz.uc 1 xjy0 {iLߝ% +c [ _o,f `o p 9K 2K %p 9 L @@s r 3S Djv 37& Va, ;Z3 + y[3 ]e^ E ]o # " ղ=Ӻ @ w ? nZ>% r q ݚ ; V͖ 'p v jֿ } v 25 @ c; @ O 0{ + k L\q `\ + ijf wϿ :$p ' / tH 0r0 - `< 0
W :#p f `, ղ `,L `nM ; 8ת 鋆% p ʗ
:!p x rXK 'p j L ` 0{ 'p T ղr F; @pw > K V; B 6Z3 | 0; @n il I - <7 J j ?C yM& Z\p J +T <; @@w & H j9 ; @@w \ _8 - "" $j /z0 @,w |& Z-w @ w | M gL p6# 3 6 ; @.sh 8Oe; @w \\o M& A ˣ b !p w j A ix jLV A d x 䱘 ^ <_ @ S z p 8 xVk r8Zf 7L /; @K -& ؗ fM /; @^ M& ؗ f %p h xVb } hLV D D 7 j& G п/& 2 h _L ؑ ^ Z ؑ ); N
W v"p \6 ; S !p x !p b ; @ Y ZL ; S !p ; ! 6 B з/& p ; ! A @w B p ; ! A @w B p ; ! A @w B p ; ! A @w B p ; ! A @w B p ; ! صc AQ , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , {wsFq}lHsơ! K5@{FP kȃެ&zW?@_Qs~/#~ p ; ! A @w B p ; ! A @w B p ; ! A @w B p ; ! A @w B p ; ! A @w B p ; ! A @w B p ; ! A @w B p ; ! A @w B p ; ! A @w B p ; ! A @w B p ; ! A @w B p ; ! A @w B p ; ! A @w B p ; ! A @w B p ; ! A @w B p ; ! A @w B p ; ! A @w B p ; ! A @w B p ; ! A 0m/M ̅ `& B @w B |ii |ia L L | C %_N 8; ĥ\+ s p !p !p p)q; #p 2 H 0} ` pDw s x F) 8 H 0) a& 8 ; 0 ܋ ; (2X ; & ;L `^^ {5 4 ` ҧ\z3 \K# A 0? !p & [ q g0 ` 8 L, ߗrû4 @ 4 ~g "p L ?4 ; < - @ |` x w M `~2 ˢsA @Hw |wg A f,: w? &; >rYtnp K 0o~ /yg `) ! @`w u)Ew ; 1 @lw S.K3 D'p hï& e)>\
'& q. ; @); -ۘ >; @;~1 -Jlca 8I `" m٘ \, 0
w j sf O f )E}X `: 4ⴞ C О* ;= L M& `R.- 0-w 6
;3 o Itno $; @ \j i kH f `NK L mn `nL 0]w \z3 0no >; n `. 8; 0uno ; #7[ 0u& >; # 0Y)M} >; q; rYtm ̆ ): 0w >wa b{ ; R. zf ; wf _ E
3$p kR.> @H), 0?w D 3%p [~Mf z|} ` |# "2lj% K 4 J2\X ` C 8zz3 ̛ 95 DzʠwT
pg) xj ^X
w nˏ YwA p ඖ)7f \N pg) xl)E竂 pW~T )ga e x,), ; qr \qn 6 OD p0M- .; sa h{3 K C\N C\` x W>, CxrY _pa Fw c $p P˹ ҄ C:Ml \ƛK 9; vrq ߔr9% ;; Cʥ7 % ; aQ e K -w c{3 0 , xLCō\ ,n? K cۈ ڕrKv ~H S# ڲǛ{k pw ʅ Kk p[w v K S ̘ p "w Pw E 0#v A 1 f 2FW pl"w 5 x(; &賸}a
A @c~a i_XpՉ 8 ; lD vq 88; ьz q; #Y`R>z3 ߵg ۮWO npZ'+ Lβ ǵG D6
6FS Genv LE O+ )0 q?'s <_sb
܁!oj ^:q; @$'w% M 0 }w \Ƹ @('/L D\~W )E}\tnm ?^\S u'n ; S7.!rn
om߿Sݼc - vrgi
ۿCSk L h 9 #7 ]
Y|]> ϰ}zzk h M6wv^}2 Тˢ>9 dL ` n @kR. S3
7 Ђ)|] Zey=5 ;В 7sry[' srYYv ٙ h3 -Ia Ƹv \ƨ} zw Z5{r>nK Sr㼞5 :;К |iO&tߙ K݄' & Z@c> osryc
b @4Efg cQY ? \6M~f
fL )|]v& )2t7Q`
h ۆzzo JMؾ -xn1& N SIN кK -q; /z^] x )8 yf5)? w !n e^i= gI$>mO& #X =7Р& JlL U>;q; _wi5npZ] "K}ݮW& '2Ew^ - <_oz^ /\&l -n5M : (ؿ+ MwE& ,9K9 ])MwY ;4К& <)|]v& 6\8gi
I4 \ GK K݄ l+'М& 3 GrZu 0/E=o <@[sr 7 CL F^` lYχ?vڙ ]?}y nEwU; |]> bz6 L 0O_?i UvS ם ǵ3Тg& ZY_ znKS @ )+l5 x @@R.:% z^{i Ǔr㢞 ^2X '3*;вM D,9>R` x|o&l? Gm@v& `bz>\.ve p`|}i
hgUwe M D
ϷI a}wX M@ hY+ 0qcz^f
ˢ>N9 Ql+}'Ь& t` /R.WO Tu'n Mд& c[C͍; #1j @@wie~Ȃ8 ?Q gjPM"G` v2gF}`# =,%kcI}U]OZE 9e5/U-E 'lI wL0h;" mG 8u?_O E|p; &`F" ./R `QGU ˦}4j"
6AUdf;Aݍ=1 Ŧ~AH v}1 l
ˀ
YM$; l{Qx y2g K 0 lA8 & qK 2+ I"/:ΏU݊ M_. l2LD pw) 0p_>WE "/Iۧ ` ," `vD p w{^63Q E::i{d a{;@2å y\O _nۏ 1 P ~ڋZes? o^ʎ] mS ] :j*H xmv[L l93L a$NgO mD k˦~) l_ ) Z I ?N۞1u N-{# : ͇iN tU:RcPn >5x f. Ye hI$ @sJ>ܤ\ u"+똷#M% p,e -J zeT/b x" xq?nnJ 8tN 7 t @ mV" QRvs" ^<= J MY/1 "Ͳ'Q =*g ^[7UQ g;۹B +M -.b
"7 :3=& Q[Y4U e E( `:&D 0:*>> `gnE iDz
@Ogiv +! `:>T +m,X 4=̥ i1
嗘 [Lܕu7? -ocJ[ !wZy F4q @OC[lϛ J VYǛ NEmSע +x L ,(XYiz `nE iDz͓ O *r; :
{V1= dfTJ :NCT g6_l 4MsWKH) hێGy!r; V@ {f; *eSO `:*xG `;a& p,4M 0*V|Q]Pn O lp8[ؤ9kb-
$=nBO ] @lp8 mK`f* h{{Q^61 C? b; t2͢'Q we OC}*
`lo8 /9.HXq.
*={o)J 8 w \6U }Pq W& p`6 _t ]tKYi ߬F 80w ܦY6U$ ,=wk ap6 _v ]6IskYǹ8 8|Pm(KPn Glp8_D @\6U
cEh pHMU*ó x.E ,# ػmBA 8 # :+g z)mSע ` :& 8uS p
GXE @mҜ5U Pqmsi Gw0Qp8wG; ֡-oD [uE4 GjL A G c4e o$ x7iz|
vO ]pd6t@Y~ 賧4MUD u 1y/MU<:<=$ }hQ `:~4 o wɿ} 0Pns =A ѱ clp蠲סr 0dᢩ( ,=nҜH Z ݢQe $ ؤ9kb-
~)8
mT @lTœ( E [H uhQ t[YIz\9O3 C@(tXY+ `|ie tSYyz\ uT'1 t te. `lrYq[ #iwA Ź@wqe C[ 4MUE p e 'qf.
` MU\z8 0bоl܈ pL CSzc. 0r4˦* ?e OC}*
`@>9zcx! IsTŽ( v4=̤ L^t)Sp色}*
߬C[t l=] aڤ- #e gE
m I 7(K> 0P X z8 r( ^fL.1 *>?zf{]cQ {6il x^YizK K~q0@(PY$ m}#
vqE+i #{1 ;@Ouw[ ~lfi+ 0ve V@ `,$ : 5J 6U( XYǼF ;N إо9 4b &w+9(
/о@݈ xȋ
L$ C*>`> `l 4_:^ xwoO
? w(x &eS ~,4 ^צ* 0l
#Q1_s}# [* :- \ , 0|
#R.x
p(뢩'Q YY8O3 7UI A r&Q 7 `Fnkpm6 B[t߈ o8"͕4 v&` d 8kQ @wuvk ѭ (;I t&eS (8 4 v Pp_:c uh_nD Sqb\ {lR d
AYǼ}. NYY4U$
8qf"
o k1 tJe籬v @y vv 31 {6 :揶_L 9EeSkQ u RǦ* D)m$ :mfi ]YNj
~ p(* w ~<=$ i4*V +8 {4 7
~D Rr uhkQ :NCc&
Rnx7q! ^XlI oe '}q%
[5Uq& ~F +7% ~Tŵ( _7 O pp ; ;ns cTqb4 ⾩Ob x_ }NsTF AYih 84 x /uWy J }L"ھHsf" QnMx%w ^/s})
<=L pT ; o {eSkQ ge 43i r; ( }hQ '> @'R9
vKZ.O k4KU 胲q }!on N( &͢( 袲> @g(3
쌒; C[t_.(8M43i tr; ;N) *eSO :w Wi. 9 윂; ; 08mSע :R{.{ = 셂; { 0H4gMUE>uMi tr; {( :E( إO Y 앂; {09ظ 0D4*D{u?Hs%
Nۤ>)wۏy; reS+Q e 8 n˥ o
; ڹ /Qqڍ3i tr; ( }hQ =e -ϥ ; - Y~}fe7 z/p i& v N (xlj MES+Q =izܤJ 7VMUCSph Fc沩Q bL (pTe /B [S'\ og Ǣѕuǝ$ F!o9?*D sTJ ; P4%w aڗkQ l?۞ 蝼R .Pp3:Ǘ 0&7 y~bL x ]@l?Ns"
QYY4U$
ޜ/\I rL .Qps s}&
Qq)@ na \jh ]@guכ% 0:z.Eй,v7 ۪31 E
tZY|$ F>E( ~>n ESb 輲ys עަY"(g|?>?w. =/Y.Sp:?J `6(r \nTŃ( :w zc5Ki :e;o̤ 0G7
NYǻK `V-{va37 8 }@/mI r( }ξN4i YS+1 7
/w ۄ%Z >[B4 #/TŃ( #w zm{}43i :E( ~z<
0,ԞO 7q! E =? _9C R~7~) N (xsi ^._6U~ 08x^ ; bsi ګXs}-
`gYz8+ R~ `(ý ffTFO 0H.yy C`u hi^?sp4 )( "w msp
; {Q <C[lJ ` |rc) C(uW_H Y
` Yh3i VR ; ؟O B[tó44 +[ע ` ~T N8hb)
Gg8~
0di,i`L J &
֢ :|=ݞi ,Y -w Fk{{> m}#
Cؓc !'+w FEh g4KWG>Ǯ\H `k1 0f
/os? MUD ἚK> fQ 0v
;e C[ ? r}-
Yh= b; ?
dž(=I3L gk; |; <5 S4˦* ϞΡ w M˦*E9O c(
uh^s֜mϚ' |hھ ; \ XvF 7Ϥ 0
ע ~O xVYNjL& 0&Oin =
u\6 ?
1 cJsTœ( ( /R$=n ?J
<=ӜH `4֡-? w U:> ?5`{3 ??b-M*6Y!ӜJ `tV{@ w+xڢL :?XbPihS :( Pp v<=2 /mmS m[L" m}%
`\.ҜH ڤMs^ݟK'v "Ͳ'Q EYihϥ +m]_ o͌ UYYzܤ9 onA [>J |bZ ( Qq ڢR o fn^ {}2߷O ȞB[l_ 7w ` /\I X`{FvK߷ϩT eESO A 8m&os ] i'H[| u*6 I 8O 0-2v}N ? m}-
+x WA [oJO翣k ^#ߒhb)
NؖrrB A??ϛx˳?9: v ]x tJYizE %{ݿOoy׳v `_i.x
@'m7TT ; m^ @( V:=ÿX 6ۦ*E t; ye s&\ o
'Q ] FYǓg xuESkQ } NYݧ Mh+Q } VY8O3 oܦY6U$ o^+8M4si #
( Rp ,E4 yHsTZ @) Rq ڢT =ؾ 0
uEh CHlI ( Uq 7iN }hoD ; 0xe g-H M*֢ L ' z)͢( 1Pp Fc._ qԞO B K3 14gMUlD ; 0je g-O &( Rp /*D =mZ ) lu\r p 4MU< @ ?uw (y\ +,؈ ^Ih3i ?m}-
Qp xJ3 'W x w 7*8I4i&dM`LP X@@IThL(NOw!?kEHH :n3h
'p \<ܗ 8 'p 8\";k xO-lߙ K]Ϭ WkL-lߚ p GKUܓ5 lCߍ 8,; R~o
x CM p w ȥ.7 \}ja %p 8\*5 q6 8
; R}W 5ES> t $:g p6vqC߽ ,H-t[ > G p&r<ͬ '3ƽ}l
'p 8#)n[Z nگ) RR ŭۙ X.>}n
}ja I prxVqq3 o^6Cߍ 8_w K |6_ 8w K]/ =q軝) . BRsk [S \ ; ˥Y [mM p W :% ܠ~mߛ H.uZ~g
n>w;S \; ʥ.S g
q6 .w +K5 "S>) R[X 1 K p#rB5 ) RW<ͬ ^{6 ܠ\O mw) n Ry[X 3K-l7 m 0sk
o mw # C n4 w :oKk pD۸w{S \"5 8]ja /; K]ϭ S ۷ GY aL-lߚ %)n_=Y mCߍ D.uo ) CM W 8\"qsk \}ja ȥyY ઌq6 M.uۧ}e
0ES> c ptyeL-lߚ s&p "RgR uf ;; %:% گ{S p) \\" 1 \; -L-tY qcz軍) Tw .^.u۟V nOqh
. K3na
F~ }7 @ ɥ.R >}g
K]7 p%ƸסM 5 prS pqCߍ Z ԻB5 K-l7 N Mɥާϭ }ja) w nR.95 33ƽm - prS>澴 p&q yE; X.>}n
8[) t
rxVqq3 ^6Cߍ 7ʥy[Z [w{S ȥ.R {O-lߙ H.uK ptcja p pfrSܾJGw 8qFS ʥS p0oھ7 ; \" i CL K "L-tY >l[}1 ?; \\?ŭ hڧ}4 \; \\}n
> p} pr<ͬ ^6Cߍ $p K75 @۸w{S u
ɥ.y[X K-lߙ n nP.uZ> gh{ nk
-w QY 8; ppԻB5 .n= ! ɥ.y[ *S ۷ A U.u*!nf 4ƽm 8\<ܗ (oqCM 8\"}a
Zؾ3 p*w [Rͬ pV) S &:~t 6Cߍ vyj[ [k w g#H-t I~ }3 p ɥyY (ƸwS D \O 5ES> 87w R[X Kvq?ۛ 8Ww "Rsk }wo Ν (U po . x f nn4 p Uɥy[Z r۸w{S B \\"}a
R w jej ۚ Vw Rg f .:n3h
Kwo
Bk - 7'H-t pS w n Yej S ۷ n i)n_=Y fw) [%p H
[X 8] n Rsk GO-lߙ \*5 CmL Gw K)r_Y 8mw) L rx~- |. O Ax^ >hZf
&p Mx f :ݳ) >N )n~s_Z ~m M { _KK-t_X n.n= #p 8\25 S ۷ ; Rg f 7ƽm uw ˥S}i
ZoqCM p8w #ɥ.R Zؾ3 ,%nf
Xcja #p 8\R ,w) K pByj[ [jM pw oK]Y >w;S RW<ͬ n[}1 |\O m}GS | ; ȥ .w{S |?; ɥ.R =}f
!p 8Sx f ^{6 \- _M I prw k oۥ .H.>}n
G7S \; ʥ>7 n4 \\<5 ?q <w K]/
ۥL p W"L-t[ 2=}5 \\,Uj; \uf A prx^ zK) Rw
L p 7 L-tY 4oM p 7":'k pA6qFS \?; ɥ glc軽) n FRsk pF;S ; ˥yY o4ƭۘ v ")n"5 ۸ǡFS 6; K%na
N`Zn
&w $zZ> GO-l3 M ʥ>7 0ƽ}l
_ʥNq |6n= ; KK-t_X ߰K-lߙ "p R<ͭ /S ۷ \,UC" 15n3h ~ O˥S}i
[w{S w ,% 7=}g
B R3k ܄1}k
A AR}d
}7 C pyj[ ~ }7 &p rB;k \}ja ȥyY ࢌq6 L.uۧ}e
0ES> S pry _ ۚ K"p "RgR qFS pi \\<{k 7-_ R
Ej5 Zؾ3 N Uɥ.S g nc
KUܓ5 +5ES> k"p jR[X CM 5 prB5 O-lߙ k&p fRW<ͬ \1n= ; 7%:S侲 pqCߍ V IԻx^ . ; 7-zZ> o V +t!nf
ƸסM R}}i
Dq ; I.uS R w O #L-t[ 8}ja gw \,UC" 'qqFs _ R澴 ۛ ~M !% ?xO-lߙ >F K]Ϭ 1}k
=w \➬ :n3h
}w \< 7kc軽) p Eg n4 /; \\<{k k p parB;k zO-lߙ . .T.uZ> nc
<w `)n[Y Oqh
Lw y}g
w BUB \"qsk ;S C |Z.uS 1n= g /ɥNq pӦ}GS %p ":g 7ec軽) K%nn
{ ȥ>7 U^{6 phw hrS>澴 Uئkh
RR HwS $p N&zZ> Eǭۚ 8; pRYKM ̉ rj~c
j> #; 0{1] e,wh
` "Ĕ dڧ}4 0ww `Qb|/Z r9 X
; H16}k
8 F ,ZLy_rk +7;]s4 Tw `bSTng
`NM , 1PC J :1PC5 +u5l1 pM Պ)? =]h
S75 ;;]s6 p *Ĕ vw `UbʻPC5 ;L X@Lyۧw 9kh
|M{k
zCa) > ĔoC
ݷ s.wd
%p $1Mym, 7{.wf4 |<v :k G Ebm{k
Xr} |w /Sޕ 0[ca _G p1)n߇; 0/rǾkFS |-; Ŕ~k
Pm? 2 3SnC
o _5}0 e f$ 5tX >Xw p ?[ >Oqh
TLy[Zk }l
\L
5tZ ~9}0 | "/C5 r}< ` Sr;k ?:f4 2 (|jZ jj
e ,XL6}k
PS ,
Ĕ sWnc
Vh,wͣ) M p%bw +Sޔg_" ,ܡܱ I 1myZ z)ww M "16 ,ka`
u PLyj辱 34L .w )Oq܃5 Cc5) G r1myk
]s6 z CL
5tZ /t5l L )Pnc
>Xw ; %澳 ?q
S 5to W x< XsC5'S [LyS}r Xܱ Sކ p
) w >\L
5to p^]3 $p Ĕwy* UC
O 3 T1)n߇; u(wf4 E )oC gS |rj~c
Y{
5l L W p1}y m 0+cC5GS \LLyۧ}o
Y)n M % <˵ ܷkΦ FL
5tZ KC
S 0w f'/C5 >XGS 0'w f)E{k 6ES> @#tߖ{ ]j
N S-S5 Ov5l1 Tw cym |s5 ߈)Oq 9kh
ow 1PC oB
_M O oSޕ 9 ~ALyS}r c,\wh x; 6w )_Ϧ _#p w)y*wc
Xr} #p Sޅo 3L #p S}k j M 'p Sކ5 jk q Ibm5 j 'p OSޗ XcC5GS )Oq 3ES> > PLy[Zk
]s6 |
; \@L
5tZ f j> .(Xrk ōy4 \ .,; \=X8;]3 PLy[Zk pr9 XL
5tZ+p5l L I +Sޗ ,Xw p 1)n"5 X)j p 21 M [L&н _`5l5 0 %+C5 rkN L PLyS}r r} 6w N~6 w Ĕ< }5) "p ~ILyj辱 ?1L e1)nߗ{ ?p(wf4 + o)oC /~6 ; ŔPCk ҹܷkS !p >LLy_rk Xw G * &w jŔoTp%r9 Fw Ŕ|/PP 5 SޗB} M XO]5} B RLyo;k 3s
) &tf {jZbCa`
` "t !p ; l !; O݁4a; O @ o"p 1ܕYr#l x;; o)oC}g
?Bl
_#p xPuXVk,\$l }w S]"ah |m{k
ZCd
smQ \lU
|Aـ@ݠ&SH2I~ 6 O p!UE?0ں[ .jM=[<Ƕ. p9w +~x>̽m=G ; n{ݷ6GEo %p xc, 0w n ;\C?̧ 3T5] M
"_k[ fj[ yj* K UӥKS~o#?g[ ?; D &p X8; B "c^1v
+"? `U +V5]}k#,X cţu FTM 0wa"_i ` 7j)v/fW n {}k+\A Jsz s!} w ^M~7d? W ӪD8Fi8{[k g 8t]n1+ pw .̢#/!f \]te=wN?Z &; Q5t==cOSȾ @ "&rS ?}Fq g"v @ jTMW/ \ڝHG[;> k p fUM+]{Rxcm] : :
I( IENDB` base-d860297eb6b98f6f5b10b40ec43d8550eba07499/docs/recipe.tasks.md 0000664 0000000 0000000 00000001530 12733117470 0023234 0 ustar 00root root 0000000 0000000 ## Run gulp-like tasks
Add the [base-task](https://github.com/node-base/base-task) plugin:
```js
var task = require('base-task');
var Base = require('base');
var app = new Base();
// register the task plugin
app.use(task());
app.task('default', function(cb) {
// do task stuff
cb();
});
// run the `default` task
app.build(function(err) {
if (err) throw err;
});
```
**Display run times**
To log out run times in the terminal, add the [base-runtimes](https://github.com/node-base/base-runtimes) plugin:
```js
var runtimes = require('base-runtimes');
var task = require('base-task');
var Base = require('base');
var app = new Base();
// register plugins
app.use(runtimes());
app.use(task());
app.task('default', function(cb) {
// do task stuff
cb();
});
// run the `default` task
app.build(function(err) {
if (err) throw err;
});
```
base-d860297eb6b98f6f5b10b40ec43d8550eba07499/gulpfile.js 0000664 0000000 0000000 00000001363 12733117470 0021540 0 ustar 00root root 0000000 0000000 'use strict';
var gulp = require('gulp');
var mocha = require('gulp-mocha');
var istanbul = require('gulp-istanbul');
var eslint = require('gulp-eslint');
gulp.task('coverage', function() {
return gulp.src(['index.js', 'utils.js'])
.pipe(istanbul({includeUntested: true}))
.pipe(istanbul.hookRequire());
});
gulp.task('mocha', ['coverage'], function() {
return gulp.src('test.js')
.pipe(mocha())
.pipe(istanbul.writeReports())
.pipe(istanbul.writeReports({
reporters: [ 'text', 'text-summary' ],
reportOpts: {dir: 'coverage', file: 'summary.txt'}
}));
});
gulp.task('eslint', function() {
return gulp.src('*.js')
.pipe(eslint())
.pipe(eslint.format());
});
gulp.task('default', ['mocha', 'eslint']);
base-d860297eb6b98f6f5b10b40ec43d8550eba07499/index.js 0000664 0000000 0000000 00000027336 12733117470 0021050 0 ustar 00root root 0000000 0000000 'use strict';
var util = require('util');
var utils = require('./utils');
/**
* Optionally define a custom `cache` namespace to use.
*/
function namespace(name) {
var Cache = name ? utils.Cache.namespace(name) : utils.Cache;
var fns = [];
/**
* Create an instance of `Base` with the given `config` and `options`.
*
* ```js
* // initialize with `config` and `options`
* var app = new Base({isApp: true}, {abc: true});
* app.set('foo', 'bar');
*
* // values defined with the given `config` object will be on the root of the instance
* console.log(app.baz); //=> undefined
* console.log(app.foo); //=> 'bar'
* // or use `.get`
* console.log(app.get('isApp')); //=> true
* console.log(app.get('foo')); //=> 'bar'
*
* // values defined with the given `options` object will be on `app.options
* console.log(app.options.abc); //=> true
* ```
*
* @param {Object} `config` If supplied, this object is passed to [cache-base][] to merge onto the the instance upon instantiation.
* @param {Object} `options` If supplied, this object is used to initialize the `base.options` object.
* @api public
*/
function Base(config, options) {
if (!(this instanceof Base)) {
return new Base(config, options);
}
Cache.call(this, config);
this.is('base');
this.initBase(config, options);
}
/**
* Inherit cache-base
*/
util.inherits(Base, Cache);
/**
* Add static emitter methods
*/
utils.Emitter(Base);
/**
* Initialize `Base` defaults with the given `config` object
*/
Base.prototype.initBase = function(config, options) {
this.options = utils.merge({}, this.options, options);
this.cache = this.cache || {};
this.define('registered', {});
if (name) this[name] = {};
// make `app._callbacks` non-enumerable
this.define('_callbacks', this._callbacks);
if (utils.isObject(config)) {
this.visit('set', config);
}
Base.run(this, 'use', fns);
};
/**
* Set the given `name` on `app._name` and `app.is*` properties. Used for doing
* lookups in plugins.
*
* ```js
* app.is('foo');
* console.log(app._name);
* //=> 'foo'
* console.log(app.isFoo);
* //=> true
* app.is('bar');
* console.log(app.isFoo);
* //=> true
* console.log(app.isBar);
* //=> true
* console.log(app._name);
* //=> 'bar'
* ```
* @name .is
* @param {String} `name`
* @return {Boolean}
* @api public
*/
Base.prototype.is = function(name) {
if (typeof name !== 'string') {
throw new TypeError('expected name to be a string');
}
this.define('is' + utils.pascal(name), true);
this.define('_name', name);
this.define('_appname', name);
return this;
};
/**
* Returns true if a plugin has already been registered on an instance.
*
* Plugin implementors are encouraged to use this first thing in a plugin
* to prevent the plugin from being called more than once on the same
* instance.
*
* ```js
* var base = new Base();
* base.use(function(app) {
* if (app.isRegistered('myPlugin')) return;
* // do stuff to `app`
* });
*
* // to also record the plugin as being registered
* base.use(function(app) {
* if (app.isRegistered('myPlugin', true)) return;
* // do stuff to `app`
* });
* ```
* @name .isRegistered
* @emits `plugin` Emits the name of the plugin being registered. Useful for unit tests, to ensure plugins are only registered once.
* @param {String} `name` The plugin name.
* @param {Boolean} `register` If the plugin if not already registered, to record it as being registered pass `true` as the second argument.
* @return {Boolean} Returns true if a plugin is already registered.
* @api public
*/
Base.prototype.isRegistered = function(name, register) {
if (this.registered.hasOwnProperty(name)) {
return true;
}
if (register !== false) {
this.registered[name] = true;
this.emit('plugin', name);
}
return false;
};
/**
* Define a plugin function to be called immediately upon init. Plugins are chainable
* and expose the following arguments to the plugin function:
*
* - `app`: the current instance of `Base`
* - `base`: the [first ancestor instance](#base) of `Base`
*
* ```js
* var app = new Base()
* .use(foo)
* .use(bar)
* .use(baz)
* ```
* @name .use
* @param {Function} `fn` plugin function to call
* @return {Object} Returns the item instance for chaining.
* @api public
*/
Base.prototype.use = function(fn) {
fn.call(this, this);
return this;
};
/**
* The `.define` method is used for adding non-enumerable property on the instance.
* Dot-notation is **not supported** with `define`.
*
* ```js
* // arbitrary `render` function using lodash `template`
* app.define('render', function(str, locals) {
* return _.template(str)(locals);
* });
* ```
* @name .define
* @param {String} `key` The name of the property to define.
* @param {any} `value`
* @return {Object} Returns the instance for chaining.
* @api public
*/
Base.prototype.define = function(key, val) {
if (utils.isObject(key)) {
return this.visit('define', key);
}
utils.define(this, key, val);
return this;
};
/**
* Mix property `key` onto the Base prototype. If base is inherited using
* `Base.extend` this method will be overridden by a new `mixin` method that will
* only add properties to the prototype of the inheriting application.
*
* ```js
* app.mixin('foo', function() {
* // do stuff
* });
* ```
* @name .mixin
* @param {String} `key`
* @param {Object|Array} `val`
* @return {Object} Returns the `base` instance for chaining.
* @api public
*/
Base.prototype.mixin = function(key, val) {
Base.prototype[key] = val;
return this;
};
/**
* Non-enumberable mixin array, used by the static [Base.mixin]() method.
*/
Base.prototype.mixins = Base.prototype.mixins || [];
/**
* Getter/setter used when creating nested instances of `Base`, for storing a reference
* to the first ancestor instance. This works by setting an instance of `Base` on the `parent`
* property of a "child" instance. The `base` property defaults to the current instance if
* no `parent` property is defined.
*
* ```js
* // create an instance of `Base`, this is our first ("base") instance
* var first = new Base();
* first.foo = 'bar'; // arbitrary property, to make it easier to see what's happening later
*
* // create another instance
* var second = new Base();
* // create a reference to the first instance (`first`)
* second.parent = first;
*
* // create another instance
* var third = new Base();
* // create a reference to the previous instance (`second`)
* // repeat this pattern every time a "child" instance is created
* third.parent = second;
*
* // we can always access the first instance using the `base` property
* console.log(first.base.foo);
* //=> 'bar'
* console.log(second.base.foo);
* //=> 'bar'
* console.log(third.base.foo);
* //=> 'bar'
* // and now you know how to get to third base ;)
* ```
* @name .base
* @api public
*/
Object.defineProperty(Base.prototype, 'base', {
configurable: true,
get: function() {
return this.parent ? this.parent.base : this;
}
});
/**
* Static method for adding global plugin functions that will
* be added to an instance when created.
*
* ```js
* Base.use(function(app) {
* app.foo = 'bar';
* });
* var app = new Base();
* console.log(app.foo);
* //=> 'bar'
* ```
* @name #use
* @param {Function} `fn` Plugin function to use on each instance.
* @return {Object} Returns the `Base` constructor for chaining
* @api public
*/
utils.define(Base, 'use', function(fn) {
fns.push(fn);
return Base;
});
/**
* Run an array of functions by passing each function
* to a method on the given object specified by the given property.
*
* @param {Object} `obj` Object containing method to use.
* @param {String} `prop` Name of the method on the object to use.
* @param {Array} `arr` Array of functions to pass to the method.
*/
utils.define(Base, 'run', function(obj, prop, arr) {
var len = arr.length, i = 0;
while (len--) {
obj[prop](arr[i++]);
}
return Base;
});
/**
* Static method for inheriting the prototype and static methods of the `Base` class.
* This method greatly simplifies the process of creating inheritance-based applications.
* See [static-extend][] for more details.
*
* ```js
* var extend = cu.extend(Parent);
* Parent.extend(Child);
*
* // optional methods
* Parent.extend(Child, {
* foo: function() {},
* bar: function() {}
* });
* ```
* @name #extend
* @param {Function} `Ctor` constructor to extend
* @param {Object} `methods` Optional prototype properties to mix in.
* @return {Object} Returns the `Base` constructor for chaining
* @api public
*/
utils.define(Base, 'extend', utils.cu.extend(Base, function(Ctor, Parent) {
Ctor.prototype.mixins = Ctor.prototype.mixins || [];
utils.define(Ctor, 'mixin', function(fn) {
var mixin = fn(Ctor.prototype, Ctor);
if (typeof mixin === 'function') {
Ctor.prototype.mixins.push(mixin);
}
return Ctor;
});
utils.define(Ctor, 'mixins', function(Child) {
Base.run(Child, 'mixin', Ctor.prototype.mixins);
return Ctor;
});
Ctor.prototype.mixin = function(key, value) {
Ctor.prototype[key] = value;
return this;
};
return Base;
}));
/**
* Used for adding methods to the `Base` prototype, and/or to the prototype of child instances.
* When a mixin function returns a function, the returned function is pushed onto the `.mixins`
* array, making it available to be used on inheriting classes whenever `Base.mixins()` is
* called (e.g. `Base.mixins(Child)`).
*
* ```js
* Base.mixin(function(proto) {
* proto.foo = function(msg) {
* return 'foo ' + msg;
* };
* });
* ```
* @name #mixin
* @param {Function} `fn` Function to call
* @return {Object} Returns the `Base` constructor for chaining
* @api public
*/
utils.define(Base, 'mixin', function(fn) {
var mixin = fn(Base.prototype, Base);
if (typeof mixin === 'function') {
Base.prototype.mixins.push(mixin);
}
return Base;
});
/**
* Static method for running global mixin functions against a child constructor.
* Mixins must be registered before calling this method.
*
* ```js
* Base.extend(Child);
* Base.mixins(Child);
* ```
* @name #mixins
* @param {Function} `Child` Constructor function of a child class
* @return {Object} Returns the `Base` constructor for chaining
* @api public
*/
utils.define(Base, 'mixins', function(Child) {
Base.run(Child, 'mixin', Base.prototype.mixins);
return Base;
});
/**
* Similar to `util.inherit`, but copies all static properties, prototype properties, and
* getters/setters from `Provider` to `Receiver`. See [class-utils][]{#inherit} for more details.
*
* ```js
* Base.inherit(Foo, Bar);
* ```
* @name #inherit
* @param {Function} `Receiver` Receiving (child) constructor
* @param {Function} `Provider` Providing (parent) constructor
* @return {Object} Returns the `Base` constructor for chaining
* @api public
*/
utils.define(Base, 'inherit', utils.cu.inherit);
utils.define(Base, 'bubble', utils.cu.bubble);
return Base;
}
/**
* Expose `Base` with default settings
*/
module.exports = namespace();
/**
* Allow users to define a namespace
*/
module.exports.namespace = namespace;
base-d860297eb6b98f6f5b10b40ec43d8550eba07499/package.json 0000664 0000000 0000000 00000004725 12733117470 0021666 0 ustar 00root root 0000000 0000000 {
"name": "base",
"description": "base is the foundation for creating modular, unit testable and highly pluggable node.js applications, starting with a handful of common methods, like `set`, `get`, `del` and `use`.",
"version": "0.11.1",
"homepage": "https://github.com/node-base/base",
"author": "Jon Schlinkert (https://github.com/jonschlinkert)",
"contributors": [
"Brian Woodward (https://github.com/doowb)"
],
"maintainers": [
"Brian Woodward (https://github.com/doowb)",
"Jon Schlinkert (https://github.com/jonschlinkert)"
],
"repository": "node-base/base",
"bugs": {
"url": "https://github.com/node-base/base/issues"
},
"license": "MIT",
"files": [
"index.js",
"utils.js"
],
"main": "index.js",
"engines": {
"node": ">=0.10.0"
},
"scripts": {
"test": "mocha"
},
"dependencies": {
"arr-union": "^3.1.0",
"cache-base": "^0.8.4",
"class-utils": "^0.3.4",
"component-emitter": "^1.2.1",
"define-property": "^0.2.5",
"isobject": "^2.1.0",
"lazy-cache": "^2.0.1",
"mixin-deep": "^1.1.3",
"pascalcase": "^0.1.1"
},
"devDependencies": {
"gulp": "^3.9.1",
"gulp-eslint": "^2.0.0",
"gulp-format-md": "^0.1.9",
"gulp-istanbul": "^0.10.4",
"gulp-mocha": "^2.2.0",
"helper-coverage": "^0.1.3",
"mocha": "^2.5.3",
"should": "^9.0.1",
"through2": "^2.0.1",
"verb-readme-generator": "^0.1.13"
},
"keywords": [
"boilerplate",
"cache",
"del",
"get",
"inherit",
"methods",
"set",
"starter",
"unset",
"visit"
],
"verb": {
"run": true,
"toc": false,
"layout": "default",
"tasks": [
"readme"
],
"plugins": [
"gulp-format-md"
],
"helpers": [
"helper-coverage"
],
"related": {
"description": "There are a number of different plugins available for extending base. Let us know if you create your own!",
"hightlight": "generate",
"list": [
"base-cwd",
"base-data",
"base-fs",
"base-generators",
"base-option",
"base-pipeline",
"base-pkg",
"base-plugins",
"base-questions",
"base-store",
"base-task"
]
},
"reflinks": [
"assemble",
"boilerplate",
"cache-base",
"class-utils",
"generate",
"scaffold",
"verb",
"static-extend",
"verb-readme-generator"
],
"lint": {
"reflinks": true
}
}
}
base-d860297eb6b98f6f5b10b40ec43d8550eba07499/test.js 0000664 0000000 0000000 00000054312 12733117470 0020712 0 ustar 00root root 0000000 0000000 'use strict';
require('mocha');
require('should');
var assert = require('assert');
var utils = require('./utils');
var Base = require('./');
var base;
describe('constructor', function() {
it('should return an instance of Base:', function() {
base = new Base();
assert(base instanceof Base);
});
it('should return an instance of Base without new:', function() {
base = Base();
assert(base instanceof Base);
});
it('should "visit" over an object to extend the instance', function() {
base = new Base({foo: 'bar'});
assert.equal(base.foo, 'bar');
var app = new Base({options: {a: true, b: false}});
assert(app.options);
assert.equal(app.options.a, true);
assert.equal(app.options.b, false);
});
it('should map "visit" over an array to extend the instance', function() {
base = new Base([{foo: 'bar'}, {baz: 'qux'}]);
assert.equal(base.foo, 'bar');
assert.equal(base.baz, 'qux');
});
it('should set options passed as the second argument', function() {
base = new Base(null, {abc: 'xyz'});
assert.equal(base.options.abc, 'xyz');
});
it('should merge options throughout the inheritance chain', function() {
function Foo(options) {
Base.call(this, null, options);
this.options.x = 'y';
}
Base.extend(Foo);
function Bar(options) {
Foo.call(this, options);
}
Foo.extend(Bar);
var bar = new Bar({a: 'b'});
assert.equal(bar.options.a, 'b');
assert.equal(bar.options.x, 'y');
});
it('should add foo', function() {
base = new Base({
foo: 'bar'
});
assert.equal(base.foo, 'bar');
});
it('should set isBase on the instance', function() {
base = new Base();
assert.equal(base.isBase, true);
});
});
describe('static properties', function() {
beforeEach(function() {
base = new Base();
});
it('should expose `.use` method', function() {
assert.equal(typeof Base.use, 'function');
});
it('should expose `.extend` method', function() {
assert.equal(typeof Base.extend, 'function');
});
it('should extend the given Ctor with static methods:', function() {
function Ctor() {
Base.call(this);
}
Base.extend(Ctor);
assert.equal(typeof Ctor.extend, 'function');
function foo() {}
Ctor.extend(foo);
assert.equal(typeof foo.extend, 'function');
});
describe('.extend', function() {
it('should set the extend method on the given object:', function() {
function Ctor() {}
Base.extend(Ctor);
assert.equal(typeof Ctor.extend, 'function');
});
});
describe('.use', function() {
it('should set the use method on the given object:', function() {
function Ctor() {}
Base.extend(Ctor);
assert.equal(typeof Ctor.use, 'function');
});
it('should use a globally loaded plugin through the static use method:', function() {
function Ctor() {
Base.call(this);
}
Base.extend(Ctor);
Ctor.use(function(app) {
app.foo = 'bar';
});
var inst = new Ctor();
assert.equal(inst.foo, 'bar');
});
it('should use a globally loaded plugin through the static use method with namespace:', function() {
var Foo = Base.namespace('foo');
Foo.use(function(app) {
app.set('bar', 'baz');
});
var inst = new Foo();
assert.equal(inst.get('bar'), 'baz');
assert.equal(inst.foo.bar, 'baz');
});
it('should use different globally installed plugins when using different namespaces:', function() {
var Foo = Base.namespace('foo');
var Bar = Base.namespace('bar');
Foo.use(function(app) {
app.set('bar', 'baz');
});
Bar.use(function(app) {
app.set('beep', 'boop');
});
var foo = new Foo();
var bar = new Bar();
assert.equal(foo.get('bar'), 'baz');
assert.equal(foo.foo.bar, 'baz');
assert.equal(typeof foo.get('beep'), 'undefined');
assert.equal(typeof foo.foo.beep, 'undefined');
assert.equal(bar.get('beep'), 'boop');
assert.equal(bar.bar.beep, 'boop');
assert.equal(typeof bar.get('bar'), 'undefined');
assert.equal(typeof bar.bar.bar, 'undefined');
});
});
describe('.mixin', function() {
it('should set the mixin method on the given object:', function() {
function Ctor() {}
Base.extend(Ctor);
assert.equal(typeof Base.mixin, 'function');
assert.equal(typeof Ctor.mixin, 'function');
});
it('should use a globally loaded mixin through the static mixin method:', function() {
function Ctor() {
Base.call(this);
}
Base.extend(Ctor);
Base.mixin(function(proto) {
proto.foo = 'bar';
});
var inst = new Ctor();
Ctor.mixin(function(proto) {
proto.bar = 'baz';
});
assert.equal(Base.prototype.foo, 'bar');
assert.equal(Ctor.prototype.bar, 'baz');
assert.equal(inst.foo, 'bar');
assert.equal(inst.bar, 'baz');
});
});
describe('.mixins', function() {
it('should set the mixins method on the given object:', function() {
function Ctor() {}
Base.extend(Ctor);
assert.equal(typeof Ctor.mixins, 'function');
});
it('should use a globally loaded mixin through the static mixins method:', function() {
function Ctor() {
Base.call(this);
}
Base.extend(Ctor);
Base.mixin(function fn(proto) {
proto.bar = 'bar';
return fn;
});
function Child() {
Ctor.call(this);
}
Base.extend(Child);
Base.mixins(Child);
Ctor.mixins(Child);
var inst = new Child();
assert.equal(Child.prototype.bar, 'bar');
assert.equal(inst.bar, 'bar');
});
});
});
describe('extend prototype methods', function() {
beforeEach(function() {
var Ctor = require('./');
Base = Ctor.namespace();
});
it('should extend the prototype of the given Ctor:', function() {
function Ctor() {
Base.call(this);
}
Base.extend(Ctor);
assert.equal(typeof Ctor.extend, 'function');
var ctor = new Ctor();
assert.equal(typeof ctor.set, 'function');
assert.equal(typeof ctor.get, 'function');
});
it('should expose `prototype.set` method', function() {
assert.equal(typeof Base.prototype.set, 'function');
});
it('should expose `prototype.get` method', function() {
assert.equal(typeof Base.prototype.get, 'function');
});
it('should expose `prototype.del` method', function() {
assert.equal(typeof Base.prototype.del, 'function');
});
it('should expose `prototype.visit` method', function() {
assert.equal(typeof Base.prototype.visit, 'function');
});
it('should expose `prototype.define` method', function() {
assert.equal(typeof Base.prototype.define, 'function');
});
it('should expose `prototype.mixin` method', function() {
assert.equal(typeof Base.prototype.mixin, 'function');
});
it('should add prototype methods to the given Ctor:', function() {
function Ctor() {
Base.call(this);
}
Base.extend(Ctor);
assert.equal(typeof Ctor.prototype.set, 'function');
assert.equal(typeof Ctor.prototype.get, 'function');
assert.equal(typeof Ctor.prototype.del, 'function');
assert.equal(typeof Ctor.prototype.visit, 'function');
assert.equal(typeof Ctor.prototype.define, 'function');
assert.equal(typeof Ctor.prototype.mixin, 'function');
function foo() {}
Ctor.extend(foo);
assert.equal(typeof foo.prototype.set, 'function');
});
});
describe('instance properties', function() {
beforeEach(function() {
var Ctor = require('./');
Base = Ctor.namespace();
base = new Base();
});
it('should expose the options property:', function() {
assert(base.options);
assert.equal(typeof base.options, 'object');
});
it('should expose the cache property:', function() {
assert(base.cache);
assert.equal(typeof base.cache, 'object');
});
});
describe('prototype methods', function() {
beforeEach(function() {
var Ctor = require('./');
Base = Ctor.namespace();
base = new Base();
});
describe('.use', function() {
beforeEach(function() {
base = new Base();
});
it('should expose the use method:', function() {
assert(base.use);
assert.equal(typeof base.use, 'function');
});
it('should call the function passed to `use`:', function(cb) {
base.use(function(app) {
assert(app);
cb();
});
});
it('should expose the app instance:', function(cb) {
base.foo = 'bar';
base.use(function(app) {
assert.equal(app.foo, 'bar');
cb();
});
});
it('should expose the app instance as "this":', function(cb) {
base.foo = 'bar';
base.use(function(app) {
assert.equal(this.foo, 'bar');
cb();
});
});
});
describe('when `isRegistered` is used', function() {
it('should not call a plugin more than once on the same instance', function() {
base.i = 0;
function plugin(app) {
if (app.isRegistered('foo')) return;
base.i++;
}
base.use(plugin);
base.use(plugin);
base.use(plugin);
base.use(plugin);
assert.equal(base.i, 1);
});
it('should not register a plugin when `false` is passed as the 2nd arg', function() {
function plugin(app) {
if (app.isRegistered('foo', false)) return;
this.foo = 'bar';
}
base.use(plugin);
assert(!base.registered.hasOwnProperty('foo'));
assert.equal(base.foo, 'bar');
});
it('should not call a plugin more than once on the same instance', function() {
base.i = 0;
function plugin(app) {
if (app.isRegistered('foo')) return;
base.i++;
}
base.use(plugin);
base.use(plugin);
base.use(plugin);
base.use(plugin);
assert.equal(base.i, 1);
});
});
describe('.define', function() {
it('should define a key-value pair on the instance:', function() {
base.define('foo', 'bar');
assert.equal(base.foo, 'bar');
});
it('should define an own property', function() {
base.define('foo', 'bar');
assert(base.hasOwnProperty('foo'));
});
it('should define a non-emumerable property', function() {
base.define('foo', 'bar');
assert(Object.keys(base).indexOf('foo') === -1);
});
it('should multiple properties', function() {
base.define({
foo: 'bar',
baz: 'qux'
});
assert(base.hasOwnProperty('foo'));
assert(base.hasOwnProperty('baz'));
});
});
describe('.set', function() {
it('should set a key-value pair on the instance:', function() {
base.set('foo', 'bar');
assert.equal(base.foo, 'bar');
});
it('should set nested property:', function() {
base.set('a.b.c', 'd');
assert.equal(base.a.b.c, 'd');
});
it('should set a nested property with the key as an array:', function() {
base.set(['a', 'b', 'c'], 'd');
assert.equal(base.a.b.c, 'd');
});
it('should set an object on the instance:', function() {
base.set({a: 'b'});
assert.equal(base.a, 'b');
});
});
describe('.get', function() {
it('should get a property from the instance:', function() {
base.set({a: 'b'});
assert.equal(base.get('a'), 'b');
});
it('should get a nested property from the instance:', function() {
base.set({a: {b: {c: 'd'}}});
assert.equal(base.get('a.b.c'), 'd');
});
it('should get a property using an array:', function() {
base.set({a: {b: {c: 'd'}}});
assert.equal(base.get(['a', 'b', 'c']), 'd');
});
it('should get a property using a list of arguments', function() {
base.set({a: {b: {c: 'd'}}});
assert.equal(base.get('a', 'b', 'c'), 'd');
assert.equal(base.get(['a', 'b'], 'c'), 'd');
assert.equal(base.get('a', ['b', 'c']), 'd');
assert.equal(base.get('a', 'b.c'), 'd');
});
});
describe('.has', function() {
it('should work with namespaces:', function() {
var Ctor = require('./');
Base = Ctor.namespace('cache');
var foo = new Base();
foo.set({a: 'b'});
assert.equal(foo.has('a'), true);
});
it('should check for a property from the instance:', function() {
base.set({a: 'b'});
assert.equal(base.has('a'), true);
});
it('should check for a nested property from the instance:', function() {
base.set({a: {b: {c: 'd'}}});
assert.equal(base.has('a.b.c'), true);
});
it('should check for a property using an array:', function() {
base.set({a: {b: {c: 'd'}}});
assert.equal(base.has(['a', 'b', 'c']), true);
});
it('should check for a property using a list of arguments', function() {
base.set({a: {b: {c: 'd'}}});
assert.equal(base.has('a', 'b', 'c'), true);
assert.equal(base.has(['a', 'b'], 'c'), true);
assert.equal(base.has('a', ['b', 'c']), true);
assert.equal(base.has('a', 'b.c'), true);
});
});
describe('.visit', function() {
it('should visit an object with the given method:', function() {
base.visit('set', {a: 'b', c: 'd'});
assert.equal(base.get('a'), 'b');
assert.equal(base.get('c'), 'd');
});
it('should visit an array with the given method:', function() {
base.visit('set', [{a: 'b', c: 'd'}]);
assert.equal(base.get('a'), 'b');
assert.equal(base.get('c'), 'd');
});
});
describe('.del', function() {
it('should remove a property:', function() {
base.set({a: 'b'});
assert.equal(base.a, 'b');
base.del('a');
assert.equal(typeof base.a, 'undefined');
});
it('should remove an array of properties:', function() {
base.set({
a: 'a'
});
base.set({
b: 'b'
});
assert.equal(base.a, 'a');
assert.equal(base.b, 'b');
base.del(['a', 'b']);
assert.equal(typeof base.a, 'undefined');
assert.equal(typeof base.b, 'undefined');
});
});
});
describe('.mixin', function() {
beforeEach(function() {
var Ctor = require('./');
Base = Ctor.namespace();
base = new Base();
});
it('should add a property to the base prototype:', function() {
base.mixin('a', function() {});
assert.equal(typeof base.a, 'function');
assert.equal(typeof Base.prototype.a, 'function');
});
it('should add to the prototype of an inheriting app:', function() {
function Foo() {
Base.call(this);
}
Base.extend(Foo);
var foo = new Foo();
foo.mixin('a', function() {});
assert.equal(typeof Foo.prototype.a, 'function');
assert.equal(typeof foo.a, 'function');
});
it('should add to inheriting app prototype:', function() {
function Foo() {
Base.call(this);
}
Base.extend(Foo);
var base = new Base();
var foo = new Foo();
base.mixin('abc', function() {});
foo.mixin('xyz', function() {});
assert.equal(typeof Base.prototype.abc, 'function');
assert.equal(typeof Foo.prototype.abc, 'function');
assert.equal(typeof base.abc, 'function');
assert.equal(typeof foo.abc, 'function');
assert(typeof Base.prototype.xyz !== 'function');
assert.equal(typeof Foo.prototype.xyz, 'function');
assert.equal(typeof foo.xyz, 'function');
assert(typeof base.xyz !== 'function');
});
it('should chain calls to mixin:', function() {
function Foo() {
Base.call(this);
}
Base.extend(Foo);
var base = new Base();
var foo = new Foo();
base.mixin('abc', function() {})
.mixin('def', function() {});
foo.mixin('xyz', function() {})
.mixin('uvw', function() {});
assert.equal(typeof Base.prototype.abc, 'function');
assert.equal(typeof Base.prototype.def, 'function');
assert.equal(typeof Foo.prototype.abc, 'function');
assert.equal(typeof Foo.prototype.def, 'function');
assert.equal(typeof base.abc, 'function');
assert.equal(typeof base.def, 'function');
assert.equal(typeof foo.abc, 'function');
assert.equal(typeof foo.def, 'function');
assert(typeof Base.prototype.xyz !== 'function');
assert(typeof Base.prototype.uvw !== 'function');
assert.equal(typeof Foo.prototype.xyz, 'function');
assert.equal(typeof Foo.prototype.uvw, 'function');
assert.equal(typeof foo.xyz, 'function');
assert.equal(typeof foo.uvw, 'function');
assert(typeof base.xyz !== 'function');
assert(typeof base.uvw !== 'function');
});
it('should not add to Base.prototype from an inheriting app:', function() {
function Foo() {
Base.call(this);
}
Base.extend(Foo);
var foo = new Foo();
var base = new Base();
foo.mixin('a', function() {});
// yes
assert.equal(typeof Foo.prototype.a, 'function');
assert.equal(typeof foo.a, 'function');
// no
assert(typeof Base.prototype.a !== 'function');
assert(typeof base.a !== 'function');
});
it('should NOT mixin from one inheriting prototype to another:', function() {
function Foo() { Base.call(this); }
Base.extend(Foo);
function Bar() { Base.call(this); }
Base.extend(Bar);
var foo = new Foo();
var bar = new Bar();
foo.mixin('a', function() {});
// yes
assert.equal(typeof Foo.prototype.a, 'function');
assert.equal(typeof foo.a, 'function');
// no
assert(typeof Bar.prototype.a !== 'function');
assert(typeof bar.a !== 'function');
});
it('should mixin from Base.prototype to all others:', function() {
function Foo() { Base.call(this); }
Base.extend(Foo);
function Bar() { Base.call(this); }
Base.extend(Bar);
var base = new Base();
var foo = new Foo();
var bar = new Bar();
base.mixin('xyz', function() {});
assert.equal(typeof Base.prototype.xyz, 'function');
assert.equal(typeof Foo.prototype.xyz, 'function');
assert.equal(typeof Bar.prototype.xyz, 'function');
assert.equal(typeof base.xyz, 'function');
assert.equal(typeof foo.xyz, 'function');
assert.equal(typeof bar.xyz, 'function');
});
});
describe('namespaces', function() {
beforeEach(function() {
Base = require('./');
});
describe('constructor', function() {
it('should expose `namespace`', function() {
assert.equal(typeof Base.namespace, 'function');
});
it('should extend the given Ctor with static methods:', function() {
var Foo = Base.namespace('cache');
function Ctor() {
Foo.call(this);
}
Foo.extend(Ctor);
assert.equal(typeof Ctor.extend, 'function');
function foo() {}
Ctor.extend(foo);
assert.equal(typeof foo.extend, 'function');
});
});
describe('prototype methods', function() {
beforeEach(function() {
var Custom = Base.namespace('cache');
base = new Custom();
});
describe('set', function() {
it('should set a key-value pair on the instance:', function() {
base.set('foo', 'bar');
assert.equal(base.cache.foo, 'bar');
});
it('should set an object on the instance:', function() {
base.set({
a: 'b'
});
assert.equal(base.cache.a, 'b');
});
});
describe('get', function() {
it('should get a property from the instance:', function() {
base.set({
a: 'b'
});
assert.equal(base.get('a'), 'b');
});
it('should visit an object with the given method:', function() {
base.visit('set', {
a: 'b',
c: 'd'
});
assert.equal(base.get('a'), 'b');
assert.equal(base.get('c'), 'd');
});
it('should visit an array with the given method:', function() {
base.visit('set', [{
a: 'b',
c: 'd'
}]);
assert.equal(base.get('a'), 'b');
assert.equal(base.get('c'), 'd');
});
});
describe('del', function() {
it('should remove a property:', function() {
base.set({
a: 'b'
});
assert.equal(base.cache.a, 'b');
base.del('a');
assert.equal(typeof base.cache.a, 'undefined');
});
it('should remove an array of properties:', function() {
base.set({
a: 'a'
});
base.set({
b: 'b'
});
assert.equal(base.cache.a, 'a');
assert.equal(base.cache.b, 'b');
base.del(['a', 'b']);
assert.equal(typeof base.cache.a, 'undefined');
assert.equal(typeof base.cache.b, 'undefined');
});
});
});
});
describe('.base', function() {
beforeEach(function() {
base = new Base();
});
it('should set a `base` property on the instance', function() {
assert(base.base);
assert.equal(typeof base.base, 'object');
});
it('should use `parent` to set app.base', function() {
var foo = new Base();
foo.abc = 'xyz';
var bar = new Base();
bar.parent = foo;
var baz = new Base();
baz.parent = bar;
assert(baz.base);
assert.equal(baz.base.abc, 'xyz');
});
});
describe('.is', function() {
beforeEach(function() {
var Ctor = require('./');
Base = Ctor.namespace();
base = new Base();
});
it('should set a name prefixed with `is` on the instance:', function() {
base.is('Foo');
assert(base.isFoo);
assert.equal(base.isFoo, true);
});
});
describe('events', function() {
beforeEach(function() {
base = new Base();
});
it('should emit and listen for events:', function(cb) {
base.on('foo', function(val) {
assert.equal(val, 'bar');
cb();
});
base.emit('foo', 'bar');
});
it('should emit set', function(cb) {
base.on('set', function(key, val) {
assert.equal(key, 'foo');
assert.equal(val, 'bar');
cb();
});
base.set('foo', 'bar');
});
it('should emit get', function(cb) {
base.on('get', function(key, val) {
assert.equal(key, 'foo');
assert.equal(val, 'bar');
cb();
});
base.set('foo', 'bar');
base.get('foo');
});
it('should emit has', function(cb) {
base.on('has', function(key, has) {
assert.equal(key, 'foo');
assert.equal(has, true);
cb();
});
base.set('foo', 'bar');
base.has('foo');
});
it('should emit del', function(cb) {
base.on('del', function(key, val) {
assert.equal(key, 'foo');
cb();
});
base.set('foo', 'bar');
base.del('foo');
});
});
base-d860297eb6b98f6f5b10b40ec43d8550eba07499/utils.js 0000664 0000000 0000000 00000001025 12733117470 0021064 0 ustar 00root root 0000000 0000000 'use strict';
var utils = require('lazy-cache')(require);
var fn = require;
require = utils; // eslint-disable-line
/**
* Lazily required module dependencies
*/
require('arr-union', 'union');
require('cache-base', 'Cache');
require('define-property', 'define');
require('component-emitter', 'Emitter');
require('class-utils', 'cu');
require('isobject', 'isObject');
require('mixin-deep', 'merge');
require('pascalcase', 'pascal');
require = fn; // eslint-disable-line
/**
* Expose `utils` modules
*/
module.exports = utils;
base-d860297eb6b98f6f5b10b40ec43d8550eba07499/verbfile.js 0000664 0000000 0000000 00000000742 12733117470 0021527 0 ustar 00root root 0000000 0000000 'use strict';
var through = require('through2');
module.exports = function(verb) {
verb.use(require('verb-readme-generator'));
verb.task('default', ['readme'], function(cb) {
return verb.src('README.md')
.pipe(through.obj(function(file, enc, next) {
var str = file.contents.toString();
str = str.replace(/^(#+ \[)\.#/gm, '$1Base.');
file.contents = new Buffer(str);
next(null, file);
}))
.pipe(verb.dest('.'));
});
};