Merge pull request #205 from jameslnewell/regexp

Add support for RegExp in caches
NekR · Mar 14, 2017 · 0f9ae03 · 0f9ae03
2 parents b69e179 + bcece4b
commit 0f9ae03
Show file tree

Hide file tree

Showing 12 changed files with 127 additions and 10 deletions.
diff --git a/docs/caches.md b/docs/caches.md
@@ -8,7 +8,7 @@ ___________________________________
 Tells to the plugin what to cache and how.
 
 * `'all'`: means that everything (all the webpack output assets) and URLs listed in `externals` option will be cached on install.
-* `Object`: Object with 3 possible sections (properties) of type `Array<string>`: `main`, `additional`, `optional`. All sections are optional and by default are empty (no assets added).
+* `Object`: Object with 3 possible sections (properties) of type `Array<string | RegExp>`: `main`, `additional`, `optional`. All sections are optional and by default are empty (no assets added).
 
 > Default: `'all'`.
 

diff --git a/docs/options.md b/docs/options.md
@@ -8,7 +8,7 @@ _Also see list of default options [here](https://github.com/NekR/offline-plugin/
 Allows you to define what to cache and how.
 
 * `'all'`: means that everything (all the webpack output assets) and URLs listed in `externals` option will be cached on install.
-* `Object`: Object with 3 possible `Array<string>` sections (properties): `main`, `additional`, `optional`. All sections are optional and by default are empty (no assets added).
+* `Object`: Object with 3 possible `Array<string | RegExp>` sections (properties): `main`, `additional`, `optional`. All sections are optional and by default are empty (no assets added).
 
 [More details about `caches`](caches.md)
 

diff --git a/lib/index.js b/lib/index.js
@@ -393,7 +393,16 @@ var OfflinePlugin = (function () {
 
               var magic = undefined;
 
-              if (!(0, _miscUtils.isAbsoluteURL)(cacheKey) && cacheKey[0] !== '/' && cacheKey.indexOf('./') !== 0 && (magic = (0, _miscUtils.hasMagic)(cacheKey))) {
+              if (typeof cacheKey === 'string') {
+                magic = !(0, _miscUtils.isAbsoluteURL)(cacheKey) && cacheKey[0] !== '/' && cacheKey.indexOf('./') !== 0 && (0, _miscUtils.hasMagic)(cacheKey);
+              } else if (cacheKey instanceof RegExp) {
+                magic = (0, _miscUtils.hasMagic)(cacheKey);
+              } else {
+                // Ignore non-string and non-RegExp keys
+                return;
+              }
+
+              if (magic) {
                 var matched = undefined;
 
                 for (var i = 0, len = assets.length; i < len; i++) {

diff --git a/lib/misc/utils.js b/lib/misc/utils.js
@@ -22,6 +22,15 @@ var isAbsolutePath = _path2['default'].isAbsolute;
 // (glob.hasMagic)
 
 function hasMagic(pattern, options) {
+  //Support RegExp as well as glob
+  if (pattern instanceof RegExp) {
+    return {
+      match: function match(str) {
+        return pattern.test(str);
+      }
+    };
+  }
+
   var minimatch = new _minimatch.Minimatch(pattern, options);
   var set = minimatch.set;
 

diff --git a/src/index.js b/src/index.js
@@ -401,12 +401,20 @@ export default class OfflinePlugin {
 
           let magic;
 
-          if (
-            !isAbsoluteURL(cacheKey) &&
-            cacheKey[0] !== '/' &&
-            cacheKey.indexOf('./') !== 0 &&
-            (magic = hasMagic(cacheKey))
-          ) {
+          if (typeof cacheKey === 'string') {
+            magic =
+              !isAbsoluteURL(cacheKey) &&
+              cacheKey[0] !== '/' &&
+              cacheKey.indexOf('./') !== 0 &&
+              hasMagic(cacheKey);
+          } else if (cacheKey instanceof RegExp) {
+            magic = hasMagic(cacheKey);
+          } else {
+            // Ignore non-string and non-RegExp keys
+            return;
+          }
+
+          if (magic) {
             let matched;
 
             for (let i = 0, len = assets.length; i < len; i++) {

diff --git a/src/misc/utils.js b/src/misc/utils.js
@@ -6,6 +6,13 @@ const isAbsolutePath = path.isAbsolute;
 // Based on https://github.com/isaacs/node-glob/blob/master/glob.js#L83
 // (glob.hasMagic)
 export function hasMagic(pattern, options) {
+  //Support RegExp as well as glob
+  if (pattern instanceof RegExp) {
+    return {
+      match: str => pattern.test(str)
+    };
+  }
+
   const minimatch = new Minimatch(pattern, options);
   const set = minimatch.set;
 
@@ -19,7 +26,7 @@ export function hasMagic(pattern, options) {
     }
   }
 
-  return false
+  return false;
 }
 
 export function getSource(source) {

diff --git a/tests/legacy/fixtures/paths-regex/__expected/appcache/manifest.appcache b/tests/legacy/fixtures/paths-regex/__expected/appcache/manifest.appcache
@@ -0,0 +1,8 @@
+CACHE MANIFEST
+#ver:f2435b5e97ab165cde456b61eb28bf8bc103076e
+
+CACHE:
+../main.js
+
+NETWORK:
+*
diff --git a/tests/legacy/fixtures/paths-regex/__expected/appcache/manifest.html b/tests/legacy/fixtures/paths-regex/__expected/appcache/manifest.html
@@ -0,0 +1,2 @@
+<!doctype html>
+<html manifest="manifest.appcache"></html>
diff --git a/tests/legacy/fixtures/paths-regex/__expected/main.js b/tests/legacy/fixtures/paths-regex/__expected/main.js
@@ -0,0 +1,50 @@
+/******/ (function(modules) { // webpackBootstrap
+/******/ 	// The module cache
+/******/ 	var installedModules = {};
+
+/******/ 	// The require function
+/******/ 	function __webpack_require__(moduleId) {
+
+/******/ 		// Check if module is in cache
+/******/ 		if(installedModules[moduleId])
+/******/ 			return installedModules[moduleId].exports;
+
+/******/ 		// Create a new module (and put it into the cache)
+/******/ 		var module = installedModules[moduleId] = {
+/******/ 			exports: {},
+/******/ 			id: moduleId,
+/******/ 			loaded: false
+/******/ 		};
+
+/******/ 		// Execute the module function
+/******/ 		modules[moduleId].call(module.exports, module, module.exports, __webpack_require__);
+
+/******/ 		// Flag the module as loaded
+/******/ 		module.loaded = true;
+
+/******/ 		// Return the exports of the module
+/******/ 		return module.exports;
+/******/ 	}
+
+
+/******/ 	// expose the modules object (__webpack_modules__)
+/******/ 	__webpack_require__.m = modules;
+
+/******/ 	// expose the module cache
+/******/ 	__webpack_require__.c = installedModules;
+
+/******/ 	// __webpack_public_path__
+/******/ 	__webpack_require__.p = "";
+
+/******/ 	// Load entry module and return exports
+/******/ 	return __webpack_require__(0);
+/******/ })
+/************************************************************************/
+/******/ ([
+/* 0 */
+/***/ function(module, exports) {
+
+
+
+/***/ }
+/******/ ]);
diff --git a/tests/legacy/fixtures/paths-regex/__expected/sw.js b/tests/legacy/fixtures/paths-regex/__expected/sw.js
@@ -0,0 +1,18 @@
+var __wpo = {
+  "assets": {
+    "main": [
+      "./main.js"
+    ],
+    "additional": [],
+    "optional": []
+  },
+  "externals": [],
+  "hashesMap": {
+    "fe8df8db17e5f8edb5c44ada1a7fdd9fe1a5012c": "./main.js"
+  },
+  "strategy": "changed",
+  "responseStrategy": "cache-first",
+  "version": "f2435b5e97ab165cde456b61eb28bf8bc103076e",
+  "name": "webpack-offline",
+  "relativePaths": true
+};
diff --git a/tests/legacy/fixtures/paths-regex/main.js b/tests/legacy/fixtures/paths-regex/main.js
diff --git a/tests/legacy/fixtures/paths-regex/webpack.config.js b/tests/legacy/fixtures/paths-regex/webpack.config.js
@@ -0,0 +1,6 @@
+module.exports = __CONFIG__({
+  caches: {
+    main: [/\.js$/]
+  },
+  version: '[hash]'
+});