Merge branch 'release/1.1.0'

README.md

@@ -32,7 +32,7 @@ Usage
 
 ```js
 gulp.task('assets', function () {
-  var postcss = require('postcss');
+  var postcss = require('gulp-postcss');
   var assets  = require('postcss-assets');
 
   return gulp.src('source/*.css')
@@ -127,6 +127,33 @@ var options = {
 };
 ```
 
+Cachebuster
+-----------
+
+PostCSS Assets can bust the assets cache, changing urls depending on asset’s modification date:
+
+```js
+var options = {
+  cachebuster: true
+};
+```
+
+```css
+body {
+  background: url('/images/icons/baz.png?14a931c501f');
+}
+```
+
+To define a custom cachebuster pass a function as an option:
+
+```js
+var options = {
+  cachebuster: function (path) {
+    return fs.statSync(path).mtime.getTime().toString(16);
+  }
+};
+```
+
 Image dimensions
 ----------------
 
@@ -166,9 +193,10 @@ SVG files would be inlined unencoded, because [then they benefit in size](http:/
 Full list of options
 --------------------
 
-| Option           | Description                                                                     | Default |
-|:-----------------|:--------------------------------------------------------------------------------|:--------|
-| `basePath`       | Root directory of the project.                                                  | `.`     |
-| `baseUrl`        | URL of the project when running the web server.                                 | `/`     |
-| `loadPaths`      | Specific directories to look for the files.                                     | `[]`    |
-| `relativeTo`     | Directory to relate to when resolving URLs. If `false`, disables relative URLs. | `false` |
+| Option           | Description                                                                       | Default |
+|:-----------------|:----------------------------------------------------------------------------------|:--------|
+| `basePath`       | Root directory of the project.                                                    | `.`     |
+| `baseUrl`        | URL of the project when running the web server.                                   | `/`     |
+| `cachebuster`    | If cache should be busted. Pass a function to define custom busting strategy.     | `false` |
+| `loadPaths`      | Specific directories to look for the files.                                       | `[]`    |
+| `relativeTo`     | Directory to relate to when resolving URLs. When `false`, disables relative URLs. | `false` |

index.js

@@ -39,14 +39,20 @@ module.exports = function (options) {
     options.relativeTo = false;
   }
 
+  if (options.cachebuster === true) {
+    options.cachebuster = function (path) {
+      var mtime = fs.statSync(path).mtime;
+      return mtime.getTime().toString(16);
+    };
+  }
+
   function getImageSize(assetStr, density) {
     var assetPath = resolvePath(assetStr.value);
     var size;
     try {
       size = sizeOf(assetPath);
       if (typeof density !== 'undefined') {
         density = parseFloat(density.value, 10);
-        console.log(density);
         size.width  = +(size.width  / density).toFixed(4);
         size.height = +(size.height / density).toFixed(4);
       }
@@ -100,6 +106,14 @@ module.exports = function (options) {
       var baseToAsset = path.relative(options.basePath, matchPath(assetPath));
       assetUrl.pathname = url.resolve(options.baseUrl, baseToAsset);
     }
+    if (options.cachebuster) {
+      if (assetUrl.search) {
+        assetUrl.search = assetUrl.search + '&';
+      } else {
+        assetUrl.search = '?';
+      }
+      assetUrl.search += options.cachebuster(assetPath);
+    }
     return cssesc(url.format(assetUrl));
   }
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "postcss-assets",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "PostCSS plugin to manage assets",
   "author": "Vadim Borodean <[email protected]>",
   "license": "MIT",

test/fixtures/cachebuster.css

@@ -0,0 +1,4 @@
+body {
+  background: url('test/fixtures/alpha/kateryna.jpg');
+  background: url('test/fixtures/alpha/kateryna.jpg?foo=bar');
+}

test/fixtures/cachebuster.expected.css

@@ -0,0 +1,4 @@
+body {
+  background: url('/test/fixtures/alpha/kateryna.jpg?20');
+  background: url('/test/fixtures/alpha/kateryna.jpg?foo=bar&20');
+}

test/index.js

@@ -26,6 +26,12 @@ function compareFixtures(t, name, msg, opts, postcssOpts) {
   t.equal(actual, expected, msg);
 }
 
+function modifyFile(path) {
+  var atime = fs.statSync(path).atime;
+  var mtime = new Date();
+  fs.utimesSync(path, atime, mtime);
+}
+
 test('path resolving', function (t) {
 
   compareFixtures(t, 'resolve', 'resolves paths');
@@ -80,3 +86,19 @@ test('dimensions', function (t) {
   compareFixtures(t, 'dimensions', 'resolves dimensions', { basePath: 'test/fixtures/' });
   t.end();
 });
+
+test('cachebuster', function (t) {
+  var options = { cachebuster: true };
+  var a = process('cachebuster', options);
+  modifyFile('test/fixtures/alpha/kateryna.jpg');
+  var b = process('cachebuster', options);
+  t.notEqual(a, b, 'busts cache');
+
+  compareFixtures(t, 'cachebuster', 'accepts buster function', {
+    cachebuster: function (path) {
+      return path.length.toString(16);
+    }
+  });
+
+  t.end();
+});