0.0.2: renaming from gulp-rev-cleaner to gulp-rev-outdated + Docs && test

Author: shonny-ua

.travis.yml

@@ -0,0 +1,3 @@
+language: node_js
+node_js:
+  - '0.10'

README.md

@@ -1,2 +1,50 @@
-gulp-rev-cleaner
-================
+# [gulp](https://github.com/wearefractal/gulp)-rev-outdated [![Build Status](https://travis-ci.org/shonny-ua/gulp-rev-outdated.svg?branch=master)](https://travis-ci.org/shonny-ua/gulp-rev-outdated)
+
+> Old static asset revision files filter.
+
+## Install
+
+```sh
+$ npm install --save-dev gulp-rev-outdated
+```
+
+## Usage
+
+We can use [gulp-rev](https://github.com/sindresorhus/gulp-rev) to cache-bust several assets. Every modification of source files caused a new revisioned asset creation. In case of using separate http://static.exsample.com/ domain for distributing static assets we have some problem with a lot of accumulated revisioned asset files. If we have several different frontends (e.q. [www-1.exsample.com, www-2.exsample.cpm, ... www-12.exsample com]) worked with different software releases, We can't remove all revisioned asset files on static.exsample.com. We need to save number of recent revisioned assets. gulp-rev-outdated filter revisioned assets and exclude parametrised quantity of recent files for removing.
+
+Takes one parameter [ keepQuantity ] - number of saved recent files.
+Default value == 2.
+
+```js
+var gulp         = require('gulp');
+var revOutdated  = require('gulp-rev-outdated');
+var cleaner      = require('gulp-rimraf');
+
+gulp.task('clean', function() {
+    gulp.src( ['dist/js/vendors*.js'], {read: false})
+        .pipe( revOutdated(1) ) // leave 1 latest asset file
+        .pipe( cleaner() );
+
+    gulp.src( ['dist/js/bundle*.js'], {read: false})
+        .pipe( revOutdated(3) ) // leave 3 recent assets
+        .pipe( cleaner() );
+
+    gulp.src( ['dist/css/*.css'], {read: false})
+        .pipe( revOutdated() ) // leave 2 recent assets (default value)
+        .pipe( cleaner() );
+
+    return;
+});
+```
+
+gulp.src option read false prevents gulp to read the contents of the file and makes this task a lot faster. If you need the file and it's contents after cleaning in the same stream, do not set the read option to false.
+
+### Works with gulp-rev-outdated
+
+- [gulp-rev](https://github.com/sindresorhus/gulp-rev)
+- [gulp-rimraf](https://github.com/robrich/gulp-rimraf)
+- [gulp-clean](https://github.com/peter-vilja/gulp-clean)
+
+## License
+
+[MIT](http://opensource.org/licenses/MIT) © [Oleksandr Ovcharenko](mailto:shonny.ua@gmail.com)

index.js

@@ -1,6 +1,11 @@
+'use strict';
+var gutil       = require('gulp-util');
+var PluginError = gutil.PluginError;
 var through = require('through2');
 var path    = require('path');
 
+var PLUGIN_NAME = 'gulp-rev-outdated';
+
 function plugin(keepQuantity){
     keepQuantity = parseInt(keepQuantity) || 2;
     var list = [];
@@ -17,11 +22,10 @@ function plugin(keepQuantity){
         list.sort(function(a, b){
             return b.time - a.time;
         })
-        .slice(keepQuantity)
+        .slice( keepQuantity )
         .forEach(function(f){
             this.push(f.file);
         }, this);
-
         cb();
     });
 }

package.json

@@ -1,13 +1,16 @@
 {
-  "name": "gulp-rev-cleaner",
-  "version": "0.0.1",
-  "description": "Old static asset revision files cleanup",
+  "name": "gulp-rev-outdated",
+  "version": "0.0.2",
+  "description": "Old static asset revision files filter",
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/shonny-ua/gulp-rev-cleaner"
+    "url": "https://github.com/shonny-ua/gulp-rev-outdated"
+  },
+  "author": {
+    "name": "Oleksandr Ovcharenko",
+    "email": "shonny.ua@gmail.com"
   },
-  "author": "Oleksandr Ovcharenko <shonny.ua@gmail.com>",
   "main": "index.js",
   "files": [
     "index.js"
@@ -29,21 +32,25 @@
     "versioning",
     "cache",
     "expire",
+    "old",
+    "outdated",
     "static",
     "asset",
     "assets",
     "clean",
-    "cleanup"
+    "cleanup",
+    "filtering",
+    "filter"
   ],
   "dependencies": {
-    "through2": ">=0.5.1"
+    "through2": ">=0.5.1",
+    "gulp-util": "^2.2.17"
   },
   "devDependencies": {
     "mocha": "*"
   },
   "bugs": {
-    "url": "https://github.com/shonny-ua/gulp-rev-cleaner/issues"
+    "url": "https://github.com/shonny-ua/gulp-rev-outdated/issues"
   },
-  "_from": "gulp-rev-cleaner@0.0.1",
-  "homepage": "https://github.com/shonny-ua/gulp-rev-cleaner"
+  "homepage": "https://github.com/shonny-ua/gulp-rev-outdated"
 }

test.js

@@ -0,0 +1,96 @@
+'use strict';
+var assert          = require('assert');
+var gutil           = require('gulp-util');
+var revOutdated     = require('./index');
+var path            = require('path');
+
+var assets = [
+    {path: 'css/style.css',          time: 0},
+    {path: 'css/stylexxx.css',       time: 0},
+    {path: 'css/style-22222222.css', time: 1403184415416},
+    {path: 'css/style-61e0be79.css', time: 1403184377571},
+    {path: 'css/style-a42f5380.css', time: 1403184303451},
+    {path: 'css/style-1d87bebe.css', time: 1222222222222},
+    {path: 'css/style-11111111.css', time: 1111111111111},
+    {path: 'css/style-00000000.css', time: 0},
+];
+
+var keepQuantity;
+var filteredQantity;
+var fileCount;
+
+it('should filter 5 files', function (cb) {
+    keepQuantity = 1;
+    filteredQantity = 6 - keepQuantity;
+    fileCount = 0;
+
+    var stream = initStream( revOutdated(keepQuantity) );
+
+    stream.on('data', streamDataCheck);
+
+    stream.on('end', function() {
+        assert.equal(fileCount, filteredQantity, 'Only ' + filteredQantity + ' files should pass through the stream');
+        cb();
+    });
+
+    stream.end();
+});
+
+it('should filter 4 files using default keepQuantity option', function (cb) {
+    keepQuantity = undefined;
+    filteredQantity = 6 - 2;
+    fileCount = 0;
+
+    var stream = initStream( revOutdated() );
+
+    stream.on('data', streamDataCheck);
+
+    stream.on('end', function() {
+        assert.equal(fileCount, filteredQantity, 'Only ' + filteredQantity + ' files should pass through the stream');
+        cb();
+    });
+
+    stream.end();
+});
+
+it('should filter correct files', function (cb) {
+    keepQuantity = 3;
+    filteredQantity = 6 - keepQuantity;
+    fileCount = 0;
+
+    var stream = initStream( revOutdated(keepQuantity) );
+
+    stream.on('data', function(file){
+        streamDataCheck(file);
+        assert(
+        /\/style-(1d87bebe|11111111|00000000)\.css/.test(file.path),
+        'should filter correct files'
+    );
+    });
+
+    stream.on('end', function() {
+        assert.equal(fileCount, filteredQantity, 'Only ' + filteredQantity + ' files should pass through the stream');
+        cb();
+    });
+
+    stream.end();
+});
+
+function initStream(stream) {
+    assets.forEach(function(asset){
+        stream.write(new gutil.File({
+            path: asset.path,
+            stat: {ctime: new Date(asset.time)},
+            contents: new Buffer(' ')
+        }));
+    });
+    return stream;
+}
+
+function streamDataCheck (file) {
+    assert(
+        /\/style-[0-9a-f]{8}\.css/.test(file.path),
+        'should filter only revisioned files'
+    );
+    fileCount++;
+}