pax_global_header00006660000000000000000000000064131457133570014523gustar00rootroot0000000000000052 comment=0ef703616063c32751b66085732abfe5306d91a6 resolve-options-1.1.0/000077500000000000000000000000001314571335700146725ustar00rootroot00000000000000resolve-options-1.1.0/.editorconfig000066400000000000000000000003261314571335700173500ustar00rootroot00000000000000# http://editorconfig.org root = true [*] indent_style = space indent_size = 2 charset = utf-8 trim_trailing_whitespace = true insert_final_newline = true end_of_line = lf [*.md] trim_trailing_whitespace = false resolve-options-1.1.0/.eslintrc000066400000000000000000000000301314571335700165070ustar00rootroot00000000000000{ "extends": "gulp" } resolve-options-1.1.0/.gitattributes000066400000000000000000000000171314571335700175630ustar00rootroot00000000000000* text eol=lf resolve-options-1.1.0/.gitignore000066400000000000000000000012541314571335700166640ustar00rootroot00000000000000# Logs logs *.log # Runtime data pids *.pid *.seed # Directory for instrumented libs generated by jscoverage/JSCover lib-cov # Coverage directory used by tools like istanbul coverage # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) .grunt # Compiled binary addons (http://nodejs.org/api/addons.html) build/Release # Dependency directory # Commenting this out is preferred by some people, see # https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git- node_modules # Users Environment Variables .lock-wscript # Garbage files .DS_Store # Generated by integration tests test/fixtures/tmp test/fixtures/out resolve-options-1.1.0/.jscsrc000066400000000000000000000000271314571335700161610ustar00rootroot00000000000000{ "preset": "gulp" } resolve-options-1.1.0/.travis.yml000066400000000000000000000001711314571335700170020ustar00rootroot00000000000000sudo: false language: node_js node_js: - '6' - '5' - '4' - '0.12' - '0.10' after_script: - npm run coveralls resolve-options-1.1.0/LICENSE000066400000000000000000000022141314571335700156760ustar00rootroot00000000000000The MIT License (MIT) Copyright (c) 2017 Blaine Bublitz , Eric Schoffstall and other contributors 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. resolve-options-1.1.0/README.md000066400000000000000000000065121314571335700161550ustar00rootroot00000000000000

# resolve-options [![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Build Status][travis-image]][travis-url] [![AppVeyor Build Status][appveyor-image]][appveyor-url] [![Coveralls Status][coveralls-image]][coveralls-url] [![Gitter chat][gitter-image]][gitter-url] Resolve an options object based on configuration. ## Usage ```js // This example assumes a Vinyl file var createResolver = require('resolve-options'); var config = { cwd: { type: 'string', default: process.cwd }, sourcemaps: { type: 'boolean', default: false }, since: { type: ['date', 'number'] }, read: { type: 'boolean' } }; var options = { sourcemaps: true, since: Date.now(), read: function(file) { return (file.extname !== '.mp4'); } }; var resolver = createResolver(config, options); var cwd = resolver.resolve('cwd', file); // cwd === process.cwd() var sourcemaps = resolver.resolve('sourcemaps', file); // sourcemaps === true var read = resolver.resolve('read', file); // Given .mp4, read === false // Given .txt, read === true ``` ## API ### `createResolver([config,] [options])` Takes a `config` object that describes the options to accept/resolve and an `options` object (usually passed by a user) to resolve against the `config`. Returns a `resolver` that contains a `resolve` method for realtime resolution of options. The `config` object takes the following structure: ```graphql config { [optionKey] { type // string, array or function default // any value or function } } ``` Each option is represented by its `optionKey` in the `config` object. It must be an object with a `type` property. The `type` property must be a string, array or function which will be passed to the [`value-or-function`][value-or-function] module (functions will be bound to the resolver to allow for dependent options). A `default` property may also be specified as a fallback if the option isn't available or is invalid. The `default` value can be any value or a function (functions will be bound to the resolver to allow for dependent defaults). __Note:__ `default` values are not type-validated by the `value-or-function` module. ### `resolver.resolve(optionKey, [...arguments])` Takes an `optionKey` string and any number of `arguments` to apply if an option is a function. Returns the resolved value for the `optionKey`. ## License MIT [value-or-function]: https://github.com/gulpjs/value-or-function [downloads-image]: http://img.shields.io/npm/dm/resolve-options.svg [npm-url]: https://npmjs.com/package/resolve-options [npm-image]: http://img.shields.io/npm/v/resolve-options.svg [travis-url]: https://travis-ci.org/gulpjs/resolve-options [travis-image]: http://img.shields.io/travis/gulpjs/resolve-options.svg?label=travis-ci [appveyor-url]: https://ci.appveyor.com/project/gulpjs/resolve-options [appveyor-image]: https://img.shields.io/appveyor/ci/gulpjs/resolve-options.svg?label=appveyor [coveralls-url]: https://coveralls.io/r/gulpjs/resolve-options [coveralls-image]: http://img.shields.io/coveralls/gulpjs/resolve-options/master.svg [gitter-url]: https://gitter.im/gulpjs/gulp [gitter-image]: https://badges.gitter.im/gulpjs/gulp.png resolve-options-1.1.0/appveyor.yml000066400000000000000000000007211314571335700172620ustar00rootroot00000000000000# http://www.appveyor.com/docs/appveyor-yml # http://www.appveyor.com/docs/lang/nodejs-iojs environment: matrix: # node.js - nodejs_version: "0.10" - nodejs_version: "0.12" - nodejs_version: "4" - nodejs_version: "5" - nodejs_version: "6" install: - ps: Install-Product node $env:nodejs_version - npm install test_script: - node --version - npm --version - cmd: npm test build: off # build version format version: "{build}" resolve-options-1.1.0/index.js000066400000000000000000000042521314571335700163420ustar00rootroot00000000000000'use strict'; var normalize = require('value-or-function'); var slice = Array.prototype.slice; function createResolver(config, options) { // TODO: should the config object be validated? config = config || {}; options = options || {}; var resolver = { resolve: resolve, }; // Keep constants separately var constants = {}; function resolveConstant(key) { if (constants.hasOwnProperty(key)) { return constants[key]; } var definition = config[key]; // Ignore options that are not defined if (!definition) { return; } var option = options[key]; if (option != null) { if (typeof option === 'function') { return; } option = normalize.call(resolver, definition.type, option); if (option != null) { constants[key] = option; return option; } } var fallback = definition.default; if (option == null && typeof fallback !== 'function') { constants[key] = fallback; return fallback; } } // Keep requested keys to detect (and disallow) recursive resolution var stack = []; function resolve(key) { var option = resolveConstant(key); if (option != null) { return option; } var definition = config[key]; // Ignore options that are not defined if (!definition) { return; } if (stack.indexOf(key) >= 0) { throw new Error('Recursive resolution denied.'); } option = options[key]; var fallback = definition.default; var appliedArgs = slice.call(arguments, 1); var args = [definition.type, option].concat(appliedArgs); function toResolve() { stack.push(key); var option = normalize.apply(resolver, args); if (option == null) { option = fallback; if (typeof option === 'function') { option = option.apply(resolver, appliedArgs); } } return option; } function onResolve() { stack.pop(); } return tryResolve(toResolve, onResolve); } return resolver; } function tryResolve(toResolve, onResolve) { try { return toResolve(); } finally { onResolve(); } } module.exports = createResolver; resolve-options-1.1.0/package.json000066400000000000000000000022051314571335700171570ustar00rootroot00000000000000{ "name": "resolve-options", "version": "1.1.0", "description": "Resolve an options object based on configuration.", "author": "Gulp Team (http://gulpjs.com/)", "contributors": [ "Blaine Bublitz " ], "repository": "gulpjs/resolve-options", "license": "MIT", "engines": { "node": ">= 0.10" }, "main": "index.js", "files": [ "LICENSE", "index.js" ], "scripts": { "lint": "eslint index.js test/ && jscs index.js test/", "pretest": "npm run lint", "test": "mocha --async-only", "cover": "istanbul cover _mocha --report lcovonly", "coveralls": "npm run cover && istanbul-coveralls" }, "dependencies": { "value-or-function": "^3.0.0" }, "devDependencies": { "eslint": "^1.10.3", "eslint-config-gulp": "^2.0.0", "expect": "^1.20.2", "istanbul": "^0.4.3", "istanbul-coveralls": "^1.0.3", "jscs": "^2.4.0", "jscs-preset-gulp": "^1.0.0", "mocha": "^3.2.0" }, "keywords": [ "options", "functions", "resolver", "type", "configuration", "config", "opts", "opt", "default" ] } resolve-options-1.1.0/test/000077500000000000000000000000001314571335700156515ustar00rootroot00000000000000resolve-options-1.1.0/test/.eslintrc000066400000000000000000000000351314571335700174730ustar00rootroot00000000000000{ "extends": "gulp/test" } resolve-options-1.1.0/test/index.js000066400000000000000000000253621314571335700173260ustar00rootroot00000000000000'use strict'; var expect = require('expect'); var createResolver = require('../'); describe('createResolver', function() { it('does not need a config or options object', function(done) { var resolver = createResolver(); expect(resolver).toExist(); done(); }); it('returns a resolver that contains a `resolve` method', function(done) { var resolver = createResolver(); expect(resolver.resolve).toBeA('function'); done(); }); it('accepts a config object', function(done) { var config = { myOpt: { type: 'string', default: 'hello world', }, }; var resolver = createResolver(config); expect(resolver).toExist(); done(); }); it('accepts an options object', function(done) { var config = { myOpt: { type: 'string', default: 'hello world', }, }; var options = {}; var resolver = createResolver(config, options); expect(resolver).toExist(); done(); }); it('coerces just once for constant options', function(done) { var coerced = 0; var config = { myOpt: { type: function(value) { coerced++; return value; }, default: 'bye bye', }, }; var options = { myOpt: 'hello world', }; var resolver = createResolver(config, options); expect(resolver).toExist(); expect(coerced).toBe(0); var myOpt1 = resolver.resolve('myOpt'); expect(myOpt1).toEqual('hello world'); expect(coerced).toBe(1); var myOpt2 = resolver.resolve('myOpt'); expect(myOpt2).toEqual('hello world'); expect(coerced).toBe(1); done(); }); }); describe('resolver.resolve', function() { it('takes a string key and returns a resolved option', function(done) { var config = { myOpt: { type: 'string', default: 'hello world', }, }; var resolver = createResolver(config); var myOpt = resolver.resolve('myOpt'); expect(myOpt).toEqual('hello world'); done(); }); it('returns undefined if a string key is not given', function(done) { var resolver = createResolver(); var myOpt = resolver.resolve({}); expect(myOpt).toEqual(undefined); done(); }); it('returns undefined if the key is not defined in the config object', function(done) { var resolver = createResolver(); var myOpt = resolver.resolve('myOpt'); expect(myOpt).toEqual(undefined); done(); }); it('resolves values against the defined type', function(done) { var config = { myOpt: { type: 'string', default: 'hello world', }, }; var validOptions = { myOpt: 'foo', }; var validResolver = createResolver(config, validOptions); var validOpt = validResolver.resolve('myOpt'); expect(validOpt).toEqual('foo'); var invalidOptions = { myOpt: 123, }; var invalidResolver = createResolver(config, invalidOptions); var invalidOpt = invalidResolver.resolve('myOpt'); expect(invalidOpt).toEqual('hello world'); done(); }); it('resolves options that are given as a function, validating the return type', function(done) { var config = { myOpt: { type: 'string', default: 'hello world', }, }; var validOptions = { myOpt: function() { return 'foo'; }, }; var validResolver = createResolver(config, validOptions); var validOpt = validResolver.resolve('myOpt'); expect(validOpt).toEqual('foo'); var invalidOptions = { myOpt: function() { return 123; }, }; var invalidResolver = createResolver(config, invalidOptions); var invalidOpt = invalidResolver.resolve('myOpt'); expect(invalidOpt).toEqual('hello world'); done(); }); it('forwards extra arguments to an option function', function(done) { var config = { myOpt: { type: 'string', default: 'hello world', }, }; var options = { myOpt: function(arg1, arg2) { expect(arg1).toEqual('arg1'); expect(arg2).toEqual('arg2'); return arg2; }, }; var resolver = createResolver(config, options); var myOpt = resolver.resolve('myOpt', 'arg1', 'arg2'); expect(myOpt).toEqual('arg2'); done(); }); it('binds the resolver to an option function', function(done) { var resolver; var config = { myOpt: { type: 'string', default: 'hello world', }, }; var options = { myOpt: function() { expect(this).toBe(resolver); return 'foo'; }, }; resolver = createResolver(config, options); var myOpt = resolver.resolve('myOpt'); expect(myOpt).toEqual('foo'); done(); }); it('allows non-recursive nested resolution of options', function(done) { var config = { myOpt1: { type: 'string', }, myOpt2: { type: 'string', }, }; var options = { myOpt1: function() { return 'hello ' + this.resolve('myOpt2'); }, myOpt2: 'world', }; var resolver = createResolver(config, options); var myOpt = resolver.resolve('myOpt1'); expect(myOpt).toEqual('hello world'); done(); }); it('allows non-recursive deeply nested resolution of options', function(done) { var config = { myOpt1: { type: 'string', }, myOpt2: { type: 'string', }, myOpt3: { type: 'string', }, }; var options = { myOpt1: function() { return 'hello' + this.resolve('myOpt2'); }, myOpt2: function() { return ' ' + this.resolve('myOpt3'); }, myOpt3: 'world', }; var resolver = createResolver(config, options); var myOpt = resolver.resolve('myOpt1'); expect(myOpt).toEqual('hello world'); done(); }); it('does not allow recursive resolution of options (to avoid blowing the stack)', function(done) { var config = { myOpt: { type: 'string', default: 'hello world', }, }; var options = { myOpt: function() { return this.resolve('myOpt'); }, }; var resolver = createResolver(config, options); function recursive() { resolver.resolve('myOpt'); } expect(recursive).toThrow('Recursive resolution denied.'); done(); }); it('does not allow indirectly recursive resolution (to avoid blowing the stack)', function(done) { var config = { myOpt1: { type: 'string', default: 'hello world', }, myOpt2: { type: 'string', default: 'bye bye', }, }; var options = { myOpt1: function() { return this.resolve('myOpt2'); }, myOpt2: function() { return this.resolve('myOpt1'); }, }; var resolver = createResolver(config, options); function recursive() { resolver.resolve('myOpt1'); } expect(recursive).toThrow('Recursive resolution denied.'); done(); }); it('supports custom type resolution with functions', function(done) { var now = new Date(); var config = { myOpt: { type: function(value) { return value.constructor === Date ? value : null; }, default: 'hello world', }, }; var options = { myOpt: now, }; var resolver = createResolver(config, options); var myOpt = resolver.resolve('myOpt'); expect(myOpt).toBe(now); done(); }); it('supports arrays of types', function(done) { var config = { myOpt: { type: ['string', 'boolean'], default: false, }, }; var strOptions = { myOpt: 'foo', }; var strResolver = createResolver(config, strOptions); var strOpt = strResolver.resolve('myOpt'); expect(strOpt).toEqual('foo'); var boolOptions = { myOpt: true, }; var boolResolver = createResolver(config, boolOptions); var boolOpt = boolResolver.resolve('myOpt'); expect(boolOpt).toEqual(true); var invalidOptions = { myOpt: 123, }; var invalidResolver = createResolver(config, invalidOptions); var invalidOpt = invalidResolver.resolve('myOpt'); expect(invalidOpt).toEqual(false); done(); }); it('allows functions as default values', function(done) { var config = { myOpt: { type: 'string', default: function() { return 'hello world'; }, }, }; var resolver = createResolver(config); var myOpt = resolver.resolve('myOpt'); expect(myOpt).toEqual('hello world'); done(); }); it('forwards extra arguments to a default function', function(done) { var config = { myOpt: { type: 'string', default: function(arg1, arg2) { expect(arg1).toEqual('arg1'); expect(arg2).toEqual('arg2'); return arg2; }, }, }; var resolver = createResolver(config); var myOpt = resolver.resolve('myOpt', 'arg1', 'arg2'); expect(myOpt).toEqual('arg2'); done(); }); it('binds the resolver to a default function', function(done) { var resolver; var config = { myOpt: { type: 'string', default: function() { expect(this).toBe(resolver); return 'hello world'; }, }, }; resolver = createResolver(config); var myOpt = resolver.resolve('myOpt'); expect(myOpt).toEqual('hello world'); done(); }); it('does not allow recursive resolution in defaults (to avoid blowing the stack)', function(done) { var config = { myOpt: { type: 'string', default: function() { return this.resolve('myOpt'); }, }, }; var resolver = createResolver(config); function recursive() { resolver.resolve('myOpt'); } expect(recursive).toThrow('Recursive resolution denied.'); done(); }); it('does not allow indirectly recursive resolution in defaults (to avoid blowing the stack)', function(done) { var config = { myOpt1: { type: 'string', default: function() { return this.resolve('myOpt2'); }, }, myOpt2: { type: 'string', default: function() { return this.resolve('myOpt1'); }, }, }; var resolver = createResolver(config); function recursive() { resolver.resolve('myOpt1'); } expect(recursive).toThrow('Recursive resolution denied.'); done(); }); it('does not verify your default matches the type', function(done) { var config = { myOpt: { type: 'string', default: 123, }, }; var resolver = createResolver(config); var myOpt = resolver.resolve('myOpt'); expect(myOpt).toEqual(123); done(); }); });