@roots/bud-cache 5.0.0-next.7 → 5.1.0

package/README.md

@@ -1,41 +1,25 @@
 <p align="center">
-  <img alt="Bud" src="https://cdn.roots.io/app/uploads/logo-bud.svg" height="100" />
+  <img src="https://cdn.roots.io/app/uploads/logo-bud.svg" height="100" alt="Bud" />
 </p>
 
 <p align="center">
-  <img
-    alt="MIT License"
-    src="https://img.shields.io/github/license/roots/bud?color=%23525ddc&style=flat-square"
-  />
-  <a href="https://app.fossa.com/projects/git%2Bgithub.com%2Froots%2Fbud?ref=badge_small" alt="FOSSA Status">
-    <img src="https://app.fossa.com/api/projects/git%2Bgithub.com%2Froots%2Fbud.svg?type=small"/>
-  </a>
-  <a href="https://www.npmjs.com/package/@roots/bud">
-    <img src="https://img.shields.io/npm/v/@roots/bud.svg?color=%23525ddc&style=flat-square" />
-  </a>
-  <a href="https://codecov.io/gh/roots/bud">
-    <img src="https://codecov.io/gh/roots/bud/branch/next/graph/badge.svg?token=DRJ28OD8XD"/>
-  </a>
-  <a href="https://twitter.com/rootswp">
-    <img
-      alt="Follow Roots"
-      src="https://img.shields.io/twitter/follow/rootswp.svg?color=%23525ddc&style=flat-square"
-    />
-  </a>
+  <img alt="MIT License" src="https://img.shields.io/github/license/roots/bud?color=%23525ddc&style=flat-square" /> <img alt="npm" src="https://img.shields.io/npm/v/@roots/bud.svg?color=%23525ddc&style=flat-square" /> <img alt="Follow Roots" src="https://img.shields.io/twitter/follow/rootswp.svg?color=%23525ddc&style=flat-square" />
 </p>
 
-
 <h1 align="center">
   <strong>@roots/bud-cache</strong>
 </h1>
 
-> Config caching
+<p align="center">
+  Config caching
+</p>
+
 ## Installation
 
 Install **@roots/bud-cache** to your project.
 
 ```shell
-yarn add @roots/bud-cache
+yarn add @roots/bud-cache --dev
 ```
 
 ## Documentation
@@ -67,8 +51,4 @@ Help support our open-source development efforts by [becoming a patron](https://
 <a href="https://carrot.com/"><img src="https://cdn.roots.io/app/uploads/carrot.svg" alt="Carrot" width="200" height="150"/></a>
 <a href="https://www.c21redwood.com/"><img src="https://cdn.roots.io/app/uploads/c21redwood.svg" alt="C21 Redwood Realty" width="200" height="150"/></a>
 <a href="https://wordpress.com/"><img src="https://cdn.roots.io/app/uploads/wordpress.svg" alt="WordPress.com" width="200" height="150"/></a>
-<a href="https://icons8.com/"><img src="https://cdn.roots.io/app/uploads/icons8.svg" alt="Icons8" width="200" height="150"/></a>
-<a href="https://www.harnessup.com/"><img src="https://cdn.roots.io/app/uploads/harness-software.svg" alt="Harness Software" width="200" height="150"/></a>
-<a href="https://www.codersclan.com/"><img src="https://cdn.roots.io/app/uploads/coders-clan.svg" alt="Coders Clan" width="200" height="150"/></a>
-<a href="https://generodigital.com/"><img src="https://cdn.roots.io/app/uploads/genero.svg" alt="Genero" width="200" height="150"/></a>
-<a href="https://motto.ca/roots"><img src="https://cdn.roots.io/app/uploads/motto.svg" alt="Motto" width="200" height="150"/></a>
+<a href="https://pantheon.io/"><img src="https://cdn.roots.io/app/uploads/pantheon.svg" alt="Pantheon" width="200" height="150"/></a>

package/lib/cjs/Cache/cache.dependencies.js

@@ -1,13 +1,31 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.readFileSync = exports.createHash = exports.globby = exports.bind = exports.Bud = void 0;
-const tslib_1 = require("tslib");
-exports.Bud = (0, tslib_1.__importStar)(require("@roots/bud-framework"));
+exports.Bud = exports.writeFile = exports.writeJson = exports.remove = exports.readJson = exports.readFile = exports.ensureFile = exports.createHash = exports.globby = exports.bind = void 0;
+const Bud = __importStar(require("@roots/bud-framework"));
+exports.Bud = Bud;
 var bud_support_1 = require("@roots/bud-support");
 Object.defineProperty(exports, "bind", { enumerable: true, get: function () { return bud_support_1.bind; } });
 Object.defineProperty(exports, "globby", { enumerable: true, get: function () { return bud_support_1.globby; } });
 var crypto_1 = require("crypto");
 Object.defineProperty(exports, "createHash", { enumerable: true, get: function () { return crypto_1.createHash; } });
 const bud_support_2 = require("@roots/bud-support");
-exports.readFileSync = bud_support_2.fs.readFileSync;
-//# sourceMappingURL=cache.dependencies.js.map
+exports.ensureFile = bud_support_2.fs.ensureFile, exports.readFile = bud_support_2.fs.readFile, exports.readJson = bud_support_2.fs.readJson, exports.remove = bud_support_2.fs.remove, exports.writeJson = bud_support_2.fs.writeJson, exports.writeFile = bud_support_2.fs.writeFile;

package/lib/cjs/Cache/index.js

@@ -1,109 +1,89 @@
 "use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Cache = void 0;
-const tslib_1 = require("tslib");
+const fs_extra_1 = require("fs-extra");
+const helpful_decorators_1 = require("helpful-decorators");
+const lodash_1 = require("lodash");
 const cache_dependencies_1 = require("./cache.dependencies");
 /**
  * Cache service class
  *
- * @remarks
- * Interfaces with:
- *
- *  - {@link @roots/bud-framework#Project} to determine project dependencies for snapshotting/validation.
- *
- *  - {@link @roots/bud-framework#Build} via {@link @roots/bud-framework#Hooks} to update config.
- *
- * Facades:
- *
- *  - {@link @roots/bud-framework#Api} can toggle cache settings with {@link Bud.Persist}
- *
  * @public
  */
 class Cache extends cache_dependencies_1.Bud.Cache.Abstract {
     /**
-     * Service register event
-     *
-     * @decorator `@bind`
-     */
-    register(app) {
-        app.hooks
-            .on('build/cache', () => ({
-            type: app.hooks.filter('build/cache/type'),
-        }))
-            .hooks.on('build/cache/type', () => 'memory');
-    }
-    /**
-     * Returns sha1 hash as a version string
-     *
-     * @decorator `@bind`
-     */
-    version() {
-        return (0, cache_dependencies_1.createHash)('sha1')
-            .update(this.hash())
-            .digest('base64')
-            .replace(/[^a-z0-9]/gi, '_')
-            .toLowerCase();
-    }
-    /**
-     * Returns cache storage directory
+     * Type
      *
-     * @decorator `@bind`
+     * @public
      */
-    directory() {
-        return this.app.path('storage', 'cache');
+    get type() {
+        const flags = this.app.store.get('cli.flags');
+        const cache = this.app.store.get('cache');
+        if (!(0, lodash_1.isUndefined)(flags['cache.type'])) {
+            this.log('log', {
+                message: '--cache.type flag',
+                suffix: flags['cache.type'],
+            });
+            return flags['cache.type'];
+        }
+        if (!(0, lodash_1.isUndefined)(cache.type)) {
+            this.log('log', {
+                message: 'bud.store',
+                suffix: cache.type,
+            });
+            return cache.type;
+        }
+        this.log('warn', 'no cache setting was passed from cli flags or from settings');
+        return false;
     }
     /**
-     * Returns array of build dependency paths
-     *
-     * @remarks
-     * @see https://webpack.js.org/configuration/cache/#cachebuilddependencies
-     *
-     * @decorator `@bind`
+     * @public
      */
-    buildDependencies() {
-        return [
-            ...new Set(cache_dependencies_1.globby.globbySync([
-                this.app.path('project', `${this.app.name}.config.{js,ts,yml,json}`),
-                this.app.path('project', `${this.app.name}.${this.app.mode}.config.{js,ts.yml,json}`),
-                ...this.getFrameworkEntrypoints(),
-                this.app.path('storage', 'cache', '**', '*'),
-            ])),
-        ];
+    async boot() {
+        this.version = await this.hashFileContents();
+        if (this.app.store.get('features.cache')) {
+            this.app.api.call('persist', this.type);
+        }
     }
     /**
-     * Cache location: framework entrypoints
-     *
-     * @see https://webpack.js.org/configuration/resolve
+     * @public
      */
-    getFrameworkEntrypoints() {
-        var _a, _b, _c;
-        const project = (_a = this.app.project) !== null && _a !== void 0 ? _a : this.app.parent.project;
-        return ((_c = (_b = project.resolveFrom) === null || _b === void 0 ? void 0 : _b.map(dep => `${dep}/lib/cjs/index.js`)) !== null && _c !== void 0 ? _c : []);
-    }
-    /**
-     * Returns hash of all build dependencies and parsed CLI arguments
-     *
-     * @decorator `@bind`
-     */
-    hash() {
-        var _a;
-        return JSON.stringify((_a = this.buildDependencies().reduce((all, file) => all.concat((0, cache_dependencies_1.readFileSync)(file, 'utf8')), process.argv.slice(3).join(''))) !== null && _a !== void 0 ? _a : '{}');
+    async hashFileContents() {
+        const makeHash = async (str) => (0, cache_dependencies_1.createHash)('sha1')
+            .update(str)
+            .digest('base64')
+            .replace(/[^a-z0-9]/gi, '_')
+            .toLowerCase();
+        try {
+            const paths = this.app.project.get('dependencies');
+            const strings = await Promise.all(paths.map(async (path) => (0, fs_extra_1.readFile)(path, 'utf8')));
+            const hash = await makeHash(`${strings}${JSON.stringify(this.app.project.get('cli'))}`);
+            this.log('info', {
+                message: 'cache hash generated',
+                suffix: hash,
+            });
+            this.app.hooks.async('event.project.write', async (project) => {
+                project.set('cache.hash', hash);
+                return project;
+            });
+            return hash;
+        }
+        catch (e) {
+            this.app.error('error hashing file contents for cache');
+            throw new Error(e);
+        }
     }
 }
-(0, tslib_1.__decorate)([
-    cache_dependencies_1.bind
-], Cache.prototype, "register", null);
-(0, tslib_1.__decorate)([
-    cache_dependencies_1.bind
-], Cache.prototype, "version", null);
-(0, tslib_1.__decorate)([
-    cache_dependencies_1.bind
-], Cache.prototype, "directory", null);
-(0, tslib_1.__decorate)([
-    cache_dependencies_1.bind
-], Cache.prototype, "buildDependencies", null);
-(0, tslib_1.__decorate)([
-    cache_dependencies_1.bind
-], Cache.prototype, "hash", null);
+__decorate([
+    helpful_decorators_1.bind
+], Cache.prototype, "boot", null);
+__decorate([
+    helpful_decorators_1.bind
+], Cache.prototype, "hashFileContents", null);
 exports.Cache = Cache;
-//# sourceMappingURL=index.js.map

package/lib/cjs/index.js

@@ -9,8 +9,7 @@ exports.Cache = void 0;
  * @see https://roots.io/bud
  * @see https://github.com/roots/bud
  *
- * @packageDocumentation @betaDocumentation
+ * @packageDocumentation
  */
 var Cache_1 = require("./Cache");
 Object.defineProperty(exports, "Cache", { enumerable: true, get: function () { return Cache_1.Cache; } });
-//# sourceMappingURL=index.js.map