pax_global_header00006660000000000000000000000064130620521550014511gustar00rootroot0000000000000052 comment=43ef1b50b2deed3a1ea57a62236a6d5d5330f3c9 fragment-cache-0.2.1/000077500000000000000000000000001306205215500143555ustar00rootroot00000000000000fragment-cache-0.2.1/.editorconfig000066400000000000000000000004051306205215500170310ustar00rootroot00000000000000root = true [*] indent_style = space end_of_line = lf charset = utf-8 indent_size = 2 trim_trailing_whitespace = true insert_final_newline = true [{**/{actual,fixtures,expected,templates}/**,*.md}] trim_trailing_whitespace = false insert_final_newline = falsefragment-cache-0.2.1/.eslintrc.json000066400000000000000000000071251306205215500171560ustar00rootroot00000000000000{ "ecmaFeatures": { "modules": true, "experimentalObjectRestSpread": true }, "env": { "browser": false, "es6": true, "node": true, "mocha": true }, "globals": { "document": false, "navigator": false, "window": false }, "rules": { "accessor-pairs": 2, "arrow-spacing": [2, { "before": true, "after": true }], "block-spacing": [2, "always"], "brace-style": [2, "1tbs", { "allowSingleLine": true }], "comma-dangle": [2, "never"], "comma-spacing": [2, { "before": false, "after": true }], "comma-style": [2, "last"], "constructor-super": 2, "curly": [2, "multi-line"], "dot-location": [2, "property"], "eol-last": 2, "eqeqeq": [2, "allow-null"], "generator-star-spacing": [2, { "before": true, "after": true }], "handle-callback-err": [2, "^(err|error)$" ], "indent": [2, 2, { "SwitchCase": 1 }], "key-spacing": [2, { "beforeColon": false, "afterColon": true }], "keyword-spacing": [2, { "before": true, "after": true }], "new-cap": [2, { "newIsCap": true, "capIsNew": false }], "new-parens": 2, "no-array-constructor": 2, "no-caller": 2, "no-class-assign": 2, "no-cond-assign": 2, "no-const-assign": 2, "no-control-regex": 2, "no-debugger": 2, "no-delete-var": 2, "no-dupe-args": 2, "no-dupe-class-members": 2, "no-dupe-keys": 2, "no-duplicate-case": 2, "no-empty-character-class": 2, "no-eval": 2, "no-ex-assign": 2, "no-extend-native": 2, "no-extra-bind": 2, "no-extra-boolean-cast": 2, "no-extra-parens": [2, "functions"], "no-fallthrough": 2, "no-floating-decimal": 2, "no-func-assign": 2, "no-implied-eval": 2, "no-inner-declarations": [2, "functions"], "no-invalid-regexp": 2, "no-irregular-whitespace": 2, "no-iterator": 2, "no-label-var": 2, "no-labels": 2, "no-lone-blocks": 2, "no-mixed-spaces-and-tabs": 2, "no-multi-spaces": 2, "no-multi-str": 2, "no-multiple-empty-lines": [2, { "max": 1 }], "no-native-reassign": 0, "no-negated-in-lhs": 2, "no-new": 2, "no-new-func": 2, "no-new-object": 2, "no-new-require": 2, "no-new-wrappers": 2, "no-obj-calls": 2, "no-octal": 2, "no-octal-escape": 2, "no-proto": 0, "no-redeclare": 2, "no-regex-spaces": 2, "no-return-assign": 2, "no-self-compare": 2, "no-sequences": 2, "no-shadow-restricted-names": 2, "no-spaced-func": 2, "no-sparse-arrays": 2, "no-this-before-super": 2, "no-throw-literal": 2, "no-trailing-spaces": 0, "no-undef": 2, "no-undef-init": 2, "no-unexpected-multiline": 2, "no-unneeded-ternary": [2, { "defaultAssignment": false }], "no-unreachable": 2, "no-unused-vars": [2, { "vars": "all", "args": "none" }], "no-useless-call": 0, "no-with": 2, "one-var": [0, { "initialized": "never" }], "operator-linebreak": [0, "after", { "overrides": { "?": "before", ":": "before" } }], "padded-blocks": [0, "never"], "quotes": [2, "single", "avoid-escape"], "radix": 2, "semi": [2, "always"], "semi-spacing": [2, { "before": false, "after": true }], "space-before-blocks": [2, "always"], "space-before-function-paren": [2, "never"], "space-in-parens": [2, "never"], "space-infix-ops": 2, "space-unary-ops": [2, { "words": true, "nonwords": false }], "spaced-comment": [0, "always", { "markers": ["global", "globals", "eslint", "eslint-disable", "*package", "!", ","] }], "use-isnan": 2, "valid-typeof": 2, "wrap-iife": [2, "any"], "yoda": [2, "never"] } } fragment-cache-0.2.1/.gitattributes000066400000000000000000000002001306205215500172400ustar00rootroot00000000000000# Enforce Unix newlines * text eol=lf # binaries *.ai binary *.psd binary *.jpg binary *.gif binary *.png binary *.jpeg binary fragment-cache-0.2.1/.gitignore000066400000000000000000000004171306205215500163470ustar00rootroot00000000000000# always ignore files *.DS_Store *.sublime-* # test related, or directories generated by tests test/actual actual coverage .nyc* # npm node_modules npm-debug.log # yarn yarn.lock yarn-error.log # misc _gh_pages _draft _drafts bower_components vendor temp tmp TODO.md fragment-cache-0.2.1/.travis.yml000066400000000000000000000001461306205215500164670ustar00rootroot00000000000000sudo: false language: node_js node_js: - node - '7' - '6' - '5' - '4' - '0.12' - '0.10' fragment-cache-0.2.1/.verb.md000066400000000000000000000001751306205215500157160ustar00rootroot00000000000000## Usage ```js var Fragment = require('{%= name %}'); var fragment = new Fragment(); ``` ## API {%= apidocs("index.js") %} fragment-cache-0.2.1/LICENSE000066400000000000000000000020771306205215500153700ustar00rootroot00000000000000The MIT License (MIT) Copyright (c) 2016-2017, 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. fragment-cache-0.2.1/README.md000066400000000000000000000107511306205215500156400ustar00rootroot00000000000000# fragment-cache [![NPM version](https://img.shields.io/npm/v/fragment-cache.svg?style=flat)](https://www.npmjs.com/package/fragment-cache) [![NPM downloads](https://img.shields.io/npm/dm/fragment-cache.svg?style=flat)](https://npmjs.org/package/fragment-cache) [![Linux Build Status](https://img.shields.io/travis/jonschlinkert/fragment-cache.svg?style=flat&label=Travis)](https://travis-ci.org/jonschlinkert/fragment-cache) > A cache for managing namespaced sub-caches ## Install Install with [npm](https://www.npmjs.com/): ```sh $ npm install --save fragment-cache ``` ## Usage ```js var Fragment = require('fragment-cache'); var fragment = new Fragment(); ``` ## API ### [FragmentCache](index.js#L24) Create a new `FragmentCache` with an optional object to use for `caches`. **Example** ```js var fragment = new FragmentCache(); ``` **Params** * `cacheName` **{String}** * `returns` **{Object}**: Returns the [map-cache](https://github.com/jonschlinkert/map-cache) instance. ### [.cache](index.js#L49) Get cache `name` from the `fragment.caches` object. Creates a new `MapCache` if it doesn't already exist. **Example** ```js var cache = fragment.cache('files'); console.log(fragment.caches.hasOwnProperty('files')); //=> true ``` **Params** * `cacheName` **{String}** * `returns` **{Object}**: Returns the [map-cache](https://github.com/jonschlinkert/map-cache) instance. ### [.set](index.js#L67) Set a value for property `key` on cache `name` **Example** ```js fragment.set('files', 'somefile.js', new File({path: 'somefile.js'})); ``` **Params** * `name` **{String}** * `key` **{String}**: Property name to set * `val` **{any}**: The value of `key` * `returns` **{Object}**: The cache instance for chaining ### [.has](index.js#L93) Returns true if a non-undefined value is set for `key` on fragment cache `name`. **Example** ```js var cache = fragment.cache('files'); cache.set('somefile.js'); console.log(cache.has('somefile.js')); //=> true console.log(cache.has('some-other-file.js')); //=> false ``` **Params** * `name` **{String}**: Cache name * `key` **{String}**: Optionally specify a property to check for on cache `name` * `returns` **{Boolean}** ### [.get](index.js#L115) Get `name`, or if specified, the value of `key`. Invokes the [cache](#cache) method, so that cache `name` will be created it doesn't already exist. If `key` is not passed, the entire cache (`name`) is returned. **Example** ```js var Vinyl = require('vinyl'); var cache = fragment.cache('files'); cache.set('somefile.js', new Vinyl({path: 'somefile.js'})); console.log(cache.get('somefile.js')); //=> ``` **Params** * `name` **{String}** * `returns` **{Object}**: Returns cache `name`, or the value of `key` if specified ## About ### Related projects * [base](https://www.npmjs.com/package/base): base is the foundation for creating modular, unit testable and highly pluggable node.js applications, starting… [more](https://github.com/node-base/base) | [homepage](https://github.com/node-base/base "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`.") * [map-cache](https://www.npmjs.com/package/map-cache): Basic cache object for storing key-value pairs. | [homepage](https://github.com/jonschlinkert/map-cache "Basic cache object for storing key-value pairs.") ### Contributing Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new). ### Building docs _(This document was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme) (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).)_ To generate the readme and API documentation with [verb](https://github.com/verbose/verb): ```sh $ npm install -g verb verb-generate-readme && verb ``` ### Running tests Install dev dependencies: ```sh $ npm install -d && npm test ``` ### Author **Jon Schlinkert** * [github/jonschlinkert](https://github.com/jonschlinkert) * [twitter/jonschlinkert](http://twitter.com/jonschlinkert) ### License Copyright © 2016, [Jon Schlinkert](https://github.com/jonschlinkert). Released under the [MIT license](https://github.com/jonschlinkert/fragment-cache/blob/master/LICENSE). *** _This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.2.0, on October 17, 2016._fragment-cache-0.2.1/examples.js000066400000000000000000000003041306205215500165260ustar00rootroot00000000000000'use strict'; var FragmentCache = require('./'); var fragment = new FragmentCache(); fragment.set('foo', 'bar', 'baz'); console.log(fragment.get('foo')) console.log(fragment.get('foo', 'bar')) fragment-cache-0.2.1/gulpfile.js000066400000000000000000000012241306205215500165210ustar00rootroot00000000000000'use strict'; var gulp = require('gulp'); var mocha = require('gulp-mocha'); var istanbul = require('gulp-istanbul'); var eslint = require('gulp-eslint'); var lib = ['index.js', 'lib/**/*.js', 'bin/*.js']; gulp.task('coverage', function() { return gulp.src(lib) .pipe(istanbul()) .pipe(istanbul.hookRequire()); }); gulp.task('test', ['coverage'], function() { return gulp.src('test/*.js') .pipe(mocha({reporter: 'spec'})) .pipe(istanbul.writeReports()); }); gulp.task('lint', function() { return gulp.src(['*.js', 'test/*.js'].concat(lib)) .pipe(eslint()) .pipe(eslint.format()); }); gulp.task('default', ['test', 'lint']); fragment-cache-0.2.1/index.js000066400000000000000000000060031306205215500160210ustar00rootroot00000000000000/*! * fragment-cache * * Copyright (c) 2016-2017, Jon Schlinkert. * Released under the MIT License. */ 'use strict'; var MapCache = require('map-cache'); /** * Create a new `FragmentCache` with an optional object to use for `caches`. * * ```js * var fragment = new FragmentCache(); * ``` * @name FragmentCache * @param {String} `cacheName` * @return {Object} Returns the [map-cache][] instance. * @api public */ function FragmentCache(caches) { this.caches = caches || {}; } /** * Prototype */ FragmentCache.prototype = { /** * Get cache `name` from the `fragment.caches` object. Creates a new * `MapCache` if it doesn't already exist. * * ```js * var cache = fragment.cache('files'); * console.log(fragment.caches.hasOwnProperty('files')); * //=> true * ``` * @name .cache * @param {String} `cacheName` * @return {Object} Returns the [map-cache][] instance. * @api public */ cache: function(cacheName) { return this.caches[cacheName] || (this.caches[cacheName] = new MapCache()); }, /** * Set a value for property `key` on cache `name` * * ```js * fragment.set('files', 'somefile.js', new File({path: 'somefile.js'})); * ``` * @name .set * @param {String} `name` * @param {String} `key` Property name to set * @param {any} `val` The value of `key` * @return {Object} The cache instance for chaining * @api public */ set: function(cacheName, key, val) { var cache = this.cache(cacheName); cache.set(key, val); return cache; }, /** * Returns true if a non-undefined value is set for `key` on fragment cache `name`. * * ```js * var cache = fragment.cache('files'); * cache.set('somefile.js'); * * console.log(cache.has('somefile.js')); * //=> true * * console.log(cache.has('some-other-file.js')); * //=> false * ``` * @name .has * @param {String} `name` Cache name * @param {String} `key` Optionally specify a property to check for on cache `name` * @return {Boolean} * @api public */ has: function(cacheName, key) { return typeof this.get(cacheName, key) !== 'undefined'; }, /** * Get `name`, or if specified, the value of `key`. Invokes the [cache]() method, * so that cache `name` will be created it doesn't already exist. If `key` is not passed, * the entire cache (`name`) is returned. * * ```js * var Vinyl = require('vinyl'); * var cache = fragment.cache('files'); * cache.set('somefile.js', new Vinyl({path: 'somefile.js'})); * console.log(cache.get('somefile.js')); * //=> * ``` * @name .get * @param {String} `name` * @return {Object} Returns cache `name`, or the value of `key` if specified * @api public */ get: function(name, key) { var cache = this.cache(name); if (typeof key === 'string') { return cache.get(key); } return cache; } }; /** * Expose `FragmentCache` */ exports = module.exports = FragmentCache; fragment-cache-0.2.1/package.json000066400000000000000000000022061306205215500166430ustar00rootroot00000000000000{ "name": "fragment-cache", "description": "A cache for managing namespaced sub-caches", "version": "0.2.1", "homepage": "https://github.com/jonschlinkert/fragment-cache", "author": "Jon Schlinkert (https://github.com/jonschlinkert)", "repository": "jonschlinkert/fragment-cache", "bugs": { "url": "https://github.com/jonschlinkert/fragment-cache/issues" }, "license": "MIT", "files": [ "index.js" ], "main": "index.js", "engines": { "node": ">=0.10.0" }, "scripts": { "test": "mocha" }, "dependencies": { "map-cache": "^0.2.2" }, "devDependencies": { "gulp": "^3.9.1", "gulp-eslint": "^3.0.1", "gulp-format-md": "^0.1.11", "gulp-istanbul": "^1.1.1", "gulp-mocha": "^3.0.1", "mocha": "^3.2.0" }, "keywords": [ "cache", "fragment" ], "verb": { "plugins": [ "gulp-format-md" ], "reflinks": [ "map-cache", "verb" ], "related": { "list": [ "base", "map-cache" ] }, "layout": "default", "toc": false, "tasks": [ "readme" ], "lint": { "reflinks": true } } } fragment-cache-0.2.1/test.js000066400000000000000000000061471306205215500157020ustar00rootroot00000000000000'use strict'; require('mocha'); var assert = require('assert'); var FragmentCache = require('./'); var MapCache = require('map-cache'); describe('fragment-cache', function() { it('should export a function', function() { assert.equal(typeof FragmentCache, 'function'); }); it('should create an instance of FragmentCache', function() { var fragment = new FragmentCache(); assert(fragment instanceof FragmentCache); }); }); describe('methods', function() { describe('.cache', function() { it('should create a cache', function() { var fragment = new FragmentCache(); fragment.cache('foo'); assert(fragment.caches.hasOwnProperty('foo')); }); it('should return the cache after creating it', function() { var fragment = new FragmentCache(); fragment.cache('foo'); var cache = fragment.get('foo'); assert.equal(cache, fragment.caches.foo); }); }); describe('.get', function() { it('should get a cache', function() { var fragment = new FragmentCache(); fragment.cache('foo'); var cache = fragment.get('foo'); assert(cache); assert.equal(typeof cache, 'object'); }); it('should be an instance of MapCache', function() { var fragment = new FragmentCache(); fragment.cache('foo'); var cache = fragment.get('foo'); assert(cache); assert(cache instanceof MapCache); }); it('should get an item from a cache', function() { var fragment = new FragmentCache(); var cache = fragment.cache('foo'); fragment.set('foo', 'a', 'b'); assert.deepEqual(fragment.get('foo', 'a'), 'b'); assert.deepEqual(fragment.cache('foo').get('a'), 'b'); }); }); describe('.set', function() { it('should set items on the __data__ object of a cache', function() { var fragment = new FragmentCache(); var cache = fragment.cache('foo'); fragment.set('foo', 'a', 'b'); assert(cache.__data__.hasOwnProperty('a')); assert.equal(cache.__data__.a, 'b'); }); }); describe('.has', function() { it('should return true when `key` exists on a cache', function() { var fragment = new FragmentCache(); var cache = fragment.cache('foo'); cache.set('a', 'b'); assert(fragment.has('foo', 'a')); }); }); describe('.cache.set', function() { it('should set items on cache.__data__', function() { var fragment = new FragmentCache(); var cache = fragment.cache('foo'); cache.set('a', 'b'); assert(cache.__data__.hasOwnProperty('a')); assert.equal(cache.__data__.a, 'b'); }); }); describe('.cache.get', function() { it('should get items from a cache', function() { var fragment = new FragmentCache(); var cache = fragment.cache('foo'); cache.set('a', 'b'); assert.equal(cache.get('a'), 'b'); }); }); describe('.cache.has', function() { it('should return true when an item exists on a cache', function() { var fragment = new FragmentCache(); var cache = fragment.cache('foo'); cache.set('a', 'b'); assert(cache.has('a')); }); }); });