amphora-html 6.0.1-dev.0 → 7.0.0

package/lib/setup.js

@@ -1,10 +1,9 @@
 'use strict';
 
 const path = require('path'),
-  _ = require('lodash'),
-  glob = require('glob'),
   fs = require('fs'),
   render = require('./render'),
+  { toList } = require('./utils'),
   nymagHbs = require('clayhandlebars'),
   hbs = nymagHbs(),
   TEMPLATE_NAME = 'template';
@@ -24,19 +23,19 @@ function init() {
 function getRenderableItems() {
   const items = [];
 
-  _.each(getComponents(), function (cmpt) {
+  for (const cmpt of toList(getComponents())) {
     items.push({
       name: cmpt,
       path: getComponentPath(cmpt)
     });
-  });
+  }
 
-  _.each(getLayouts(), function (layout) {
+  for (const layout of toList(getLayouts())) {
     items.push({
       name: layout,
       path: getLayoutPath(layout)
     });
-  });
+  }
 
   return items;
 }
@@ -47,47 +46,56 @@ function getRenderableItems() {
  * @param {Array} items
  */
 function registerPartials(items) {
-  _.each(items, function (item) {
-    var templateFile = getPossibleTemplates(item.path, TEMPLATE_NAME),
-      isHandlebars = _.includes(templateFile, '.handlebars') || _.includes(templateFile, '.hbs'),
-      templateFileContents,
-      modifiedTemplateFile;
+  for (const item of items) {
+    const templateFile = getPossibleTemplates(item.path, TEMPLATE_NAME),
+      isHandlebars = typeof templateFile === 'string' && (templateFile.includes('.handlebars') || templateFile.includes('.hbs'));
 
     if (isHandlebars) {
-      templateFileContents = fs.readFileSync(templateFile, 'utf8');
-      // this wrapper guarantees we'll never render a component in a partial if it doesn't have a _ref
-      modifiedTemplateFile = nymagHbs.wrapPartial(item.name, templateFileContents);
+      const templateFileContents = fs.readFileSync(templateFile, 'utf8'),
+        // this wrapper guarantees we'll never render a component in a partial if it doesn't have a _ref
+        modifiedTemplateFile = nymagHbs.wrapPartial(item.name, templateFileContents);
 
       hbs.registerPartial(item.name, modifiedTemplateFile);
     }
-  });
+  }
 
-  // Compile all the loaded partials
-  _.forIn(hbs.partials, function (value, key) {
-    if (_.isString(value)) {
+  // Compile all the loaded partials (inherited ones too, as lodash's forIn did)
+  for (const key in hbs.partials) {
+    if (typeof hbs.partials[key] === 'string') {
       // preventIndent:true solve issue with  <pre> tag/white-space: pre
       // see http://handlebarsjs.com/reference.html compile() options
-      hbs.partials[key] = hbs.compile(value, { preventIndent: true });
+      hbs.partials[key] = hbs.compile(hbs.partials[key], { preventIndent: true });
     }
-  });
+  }
 
   module.exports.hbs = hbs;
 }
 
 /**
  * Grab the possible template files based on the name.
- * Returns a path to the file so that it can be read.
+ * Returns a path to the file so that it can be read: the first
+ * `<templateName>.*` file, in the order glob used to sort them.
  *
  * @param  {String} filePath
  * @param  {String} templateName
  * @return {String}
  */
 function getPossibleTemplates(filePath, templateName) {
-  if (_.isString(filePath)) {
-    return glob.sync(path.join(filePath, `${templateName}.*`))[0];
-  }
+  if (typeof filePath === 'string') {
+    const dir = path.dirname(path.join(filePath, `${templateName}.*`));
+    let names;
+
+    try {
+      names = fs.readdirSync(dir);
+    } catch (e) {
+      return;
+    }
 
-  return [];
+    return names
+      .filter((name) => name.startsWith(`${templateName}.`))
+      .map((name) => path.join(dir, name))
+      .sort((a, b) => a.localeCompare(b, 'en'))[0];
+  }
 }
 
 /**
@@ -96,10 +104,11 @@ function getPossibleTemplates(filePath, templateName) {
  * @param {Object} payload
  */
 function addHelpers(payload) {
-  _.forIn(payload, function (value, key) {
+  // inherited helpers too, as lodash's forIn did
+  for (const key in payload) { // eslint-disable-line guard-for-in
     // set up handlebars helpers that rely on internal services
-    hbs.registerHelper(`${key}`, value);
-  });
+    hbs.registerHelper(`${key}`, payload[key]);
+  }
 }
 
 /**
@@ -143,6 +152,24 @@ module.exports.renderSettings = undefined;
 module.exports.resolveMedia = undefined;
 module.exports.plugins = [];
 
+/**
+ * The Handlebars environment amphora-html renders with: clayhandlebars' helpers and
+ * partials, the helpers given to `addHelpers`, and a partial for each component and
+ * layout. It is the `handlebars` module clayhandlebars itself requires, so it is
+ * shared with anything else in the process that uses that module.
+ *
+ * @type {Object}
+ */
+module.exports.handlebars = hbs;
+
+/**
+ * What every component and layout template is wrapped in before it is registered
+ * as a partial: clayhandlebars' `wrapPartial(name, template)`.
+ *
+ * @type {Function}
+ */
+module.exports.wrapPartial = nymagHbs.wrapPartial;
+
 // Setup functions
 module.exports.init = init;
 module.exports.addHelpers = addHelpers;

package/lib/styleguide.js

@@ -1,10 +1,9 @@
 'use strict';
 
-const _ = require('lodash'),
-  clayUtils = require('clayutils'),
-  files = require('nymag-fs'),
+const clayUtils = require('clayutils'),
+  files = require('./files'),
   path = require('path'),
-  traverse = require('traverse');
+  { isObject, assignValue, memoize } = require('./utils');
 
 /**
  * Looks for CSS files associated with a component's variation
@@ -15,7 +14,7 @@ const _ = require('lodash'),
 function findVariationFiles(styleguide) {
   const stylePath = `styleguides/${styleguide}/components`,
     stylesheets = files.getFiles(stylePath),
-    variations = _.filter(stylesheets, function (file) {
+    variations = stylesheets.filter(function (file) {
       // checks for underscores which denotes variations and make sure it's a
       // css file
       return file.includes('_') && file.includes('.css');
@@ -37,20 +36,45 @@ function findVariationFiles(styleguide) {
 * component and its variations
 */
 function getVariations(styleguide = '_default') {
-  const foundVariations = styleguide !== '_default' ? _.uniq(findVariationFiles(styleguide).concat(findVariationFiles('_default'))) : findVariationFiles('_default'),
+  const foundVariations = styleguide !== '_default' ? [...new Set(findVariationFiles(styleguide).concat(findVariationFiles('_default')))] : findVariationFiles('_default'),
     componentVariations = {};
 
   if (foundVariations.length) {
-    _.forEach(foundVariations, function (variant) {
+    for (const variant of foundVariations) {
       let component = variant.split('_')[0],
         variantName = path.basename(variant, '.css');
 
       (componentVariations[component] || (componentVariations[component] = [])).push(variantName);
-    });
+    }
   }
   return componentVariations;
 }
 
+/**
+ * Call `visit` with every value in `node`, depth first, as traverse's forEach did:
+ * an object's keys are read before it is visited (so keys `visit` adds are not
+ * walked), functions are not walked, and an object found inside itself is
+ * visited but not walked again.
+ *
+ * @param {*} node
+ * @param {Function} visit
+ * @param {Object[]} [parents]  the objects being walked
+ */
+function walk(node, visit, parents = []) {
+  const isWalked = typeof node === 'object' && node !== null,
+    keys = isWalked ? Object.keys(node) : [];
+
+  visit(node);
+
+  if (isWalked && !parents.includes(node)) {
+    parents.push(node);
+    for (const key of keys) {
+      walk(node[key], visit, parents);
+    }
+    parents.pop();
+  }
+}
+
 /**
 * Goes through page data and sets a default for components
 *
@@ -71,25 +95,26 @@ function setDefaultVariations(_data, state) {
       [topLevelVariation || layoutOrSelf]: true
     };
 
-  traverse(_data).forEach(function (val) {
+  walk(_data, function (val) {
     let componentName, componentVariations;
 
-    if (!_.isObject(val) || !val._ref) {
+    if (!isObject(val) || !val._ref) {
       return; // we only care about components' root data
     }
 
     componentName = clayUtils.getComponentName(val._ref);
-    componentVariations = variations[componentName] || [];
+    // a name like `constructor` finds what the object inherits, which is not a list
+    componentVariations = Array.isArray(variations[componentName]) ? variations[componentName] : [];
 
-    if (val.componentVariation && !_.includes(componentVariations, val.componentVariation)) {
+    if (val.componentVariation && !componentVariations.includes(val.componentVariation)) {
       // component has a variation set, but it doesn't exist in the site's styleguide or the default styleguide!
       // render the component with the default variation
-      _.set(val, 'componentVariation', componentName);
+      assignValue(val, 'componentVariation', componentName);
       usedVariations[`${componentName}`] = true;
     } else if (!val.componentVariation) {
       // component has no variation set!
       // render the component with the default variation
-      _.set(val, 'componentVariation', componentName);
+      assignValue(val, 'componentVariation', componentName);
       usedVariations[`${componentName}`] = true;
     } else {
       usedVariations[`${val.componentVariation}`] = true;
@@ -98,5 +123,5 @@ function setDefaultVariations(_data, state) {
   state._usedVariations = Object.keys(usedVariations);
 }
 
-exports.getVariations = _.memoize(getVariations);
+exports.getVariations = memoize(getVariations);
 exports.setDefaultVariations = setDefaultVariations;

package/lib/utils.js

@@ -0,0 +1,127 @@
+'use strict';
+
+// The few behaviors of lodash that amphora-html depends on, in native code.
+
+/**
+ * Whether a value is an object or a function, as lodash's isObject
+ *
+ * @param {*} value
+ * @returns {boolean}
+ */
+function isObject(value) {
+  return value !== null && (typeof value === 'object' || typeof value === 'function');
+}
+
+/**
+ * Set a property the way lodash's assign and set did: nothing is written when
+ * the object already has that value, a `__proto__` key becomes a property of
+ * its own instead of replacing the prototype, and a property that can't be
+ * written is left as it is instead of throwing.
+ *
+ * @param {Object} object
+ * @param {string|symbol} key
+ * @param {*} value
+ */
+function assignValue(object, key, value) {
+  const current = object[key];
+
+  // SameValueZero, like lodash's eq
+  if (Object.hasOwn(object, key) && (current === value || Number.isNaN(current) && Number.isNaN(value))) {
+    return;
+  }
+
+  if (key === '__proto__') {
+    Object.defineProperty(object, key, { configurable: true, enumerable: true, value, writable: true });
+  } else {
+    Reflect.set(object, key, value);
+  }
+}
+
+/**
+ * Copy the own enumerable properties of `source` onto `target`, as lodash's assign
+ *
+ * @param {Object} target
+ * @param {*} source
+ * @returns {Object} target
+ */
+function assign(target, source) {
+  for (const key of Object.keys(Object(source))) {
+    assignValue(target, key, source[key]);
+  }
+
+  return target;
+}
+
+/**
+ * The properties of `object` with these names, as lodash's pick: a name is
+ * picked when it is `in` the object, inherited or not, except the ones that
+ * would reach a prototype.
+ *
+ * @param {Object} object
+ * @param {string[]|string} keys
+ * @returns {Object}
+ */
+function pick(object, keys) {
+  const picked = {};
+
+  for (const key of [].concat(keys)) {
+    if (object != null && key in Object(object) && key !== '__proto__' && key !== 'constructor' && key !== 'prototype') {
+      picked[key] = object[key];
+    }
+  }
+
+  return picked;
+}
+
+/**
+ * The items of a collection, as lodash's map and each see them: nothing for
+ * null or undefined, every index of an array or anything with a length
+ * (holes included), the own values of anything else.
+ *
+ * @param {*} collection
+ * @returns {Array}
+ */
+function toList(collection) {
+  if (collection == null) {
+    return [];
+  }
+
+  if (typeof collection !== 'function' && Number.isSafeInteger(collection.length) && collection.length >= 0) {
+    return Array.from({ length: collection.length }, (item, index) => collection[index]);
+  }
+
+  return Object.values(Object(collection));
+}
+
+/**
+ * Remember what `fn` returns for each first argument, as lodash's memoize:
+ * the cache is read from `memoized.cache` on every call, so it can be cleared
+ * or replaced with anything that has `get`, `set` and `has`.
+ *
+ * @param {Function} fn
+ * @returns {Function}
+ */
+function memoize(fn) {
+  function memoized(key) {
+    const cache = memoized.cache;
+
+    if (cache.has(key)) {
+      return cache.get(key);
+    }
+
+    const result = fn.apply(this, arguments);
+
+    memoized.cache = cache.set(key, result) || cache;
+    return result;
+  }
+
+  memoized.cache = new Map();
+  return memoized;
+}
+
+module.exports.isObject = isObject;
+module.exports.assignValue = assignValue;
+module.exports.assign = assign;
+module.exports.pick = pick;
+module.exports.toList = toList;
+module.exports.memoize = memoize;

package/package.json

@@ -1,62 +1,39 @@
 {
   "name": "amphora-html",
-  "version": "6.0.1-dev.0",
+  "version": "7.0.0",
   "description": "An HTML renderer for component data",
   "main": "index.js",
+  "files": [
+    "index.js",
+    "lib",
+    "!**/*.test.js"
+  ],
+  "engines": {
+    "node": ">=26.12.1"
+  },
   "scripts": {
-    "test": "npm run eslint && npm run jest -- --coverage --no-cache",
-    "eslint": "eslint --max-warnings 0 lib test",
-    "jest": "jest"
+    "lint": "eslint --max-warnings 0",
+    "test-local": "node --test \"lib/*.test.js\" \"test/*.test.js\"",
+    "test": "npm run lint && node --test --experimental-test-coverage --test-coverage-exclude=\"**/*.test.js\" --test-coverage-lines=100 --test-coverage-branches=100 --test-coverage-functions=100 \"lib/*.test.js\" \"test/*.test.js\""
   },
   "dependencies": {
-    "amphora-fs": "^2.0.0",
-    "bluebird": "^3.5.0",
-    "clay-log": "^1.2.0",
-    "clayutils": "^3.0.0",
-    "glob": "^7.1.1",
-    "js-yaml": "^3.8.2",
-    "lodash": "^4.17.5",
-    "nymag-fs": "^1.0.1",
-    "traverse": "^0.6.6"
+    "amphora-fs": "^3.0.0",
+    "clay-log": "^1.6.0",
+    "clayhandlebars": "^6.0.0",
+    "clayutils": "^4.0.0"
   },
   "devDependencies": {
-    "clayhandlebars": "^5.0.1",
-    "coveralls": "^3.0.2",
-    "eslint": "^3.19.0",
-    "jest": "23.6.0"
-  },
-  "peerDependencies": {
-    "handlebars": "4",
-    "clayhandlebars": "5"
+    "@eslint/js": "^10.0.1",
+    "eslint": "^10.14.0"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/nymag/amphora-html.git"
-  },
-  "jest": {
-    "clearMocks": true,
-    "restoreMocks": true,
-    "collectCoverageFrom": [
-      "<rootDir>/lib/**/*.js"
-    ],
-    "coverageReporters": [
-      "lcov",
-      "text-summary"
-    ],
-    "moduleFileExtensions": [
-      "js"
-    ],
-    "setupFiles": [
-      "<rootDir>/test/setupFile.js"
-    ],
-    "moduleNameMapper": {
-      "\\.(hbs)$": "<rootDir>/__mocks__/fileMock.js"
-    }
+    "url": "git+https://github.com/clay/amphora-html.git"
   },
   "author": "",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/nymag/amphora-html/issues"
+    "url": "https://github.com/clay/amphora-html/issues"
   },
-  "homepage": "https://github.com/nymag/amphora-html#readme"
+  "homepage": "https://github.com/clay/amphora-html#readme"
 }

package/.circleci/config.yml

@@ -1,44 +0,0 @@
-version: 2
-
-# Set defaults to reuse
-defaults: &defaults
-  working_directory: ~/repo
-  docker:
-    - image: circleci/node:8.10.0
-
-jobs:
-  test:
-    <<: *defaults
-    steps:
-      - checkout
-
-      - restore_cache:
-          keys:
-            - v2-dependencies-{{ checksum "package.json" }}
-            # fallback to using the latest cache if no exact match is found
-            - v2-dependencies-
-
-      - run: npm install
-      - run:
-          name: Run tests
-          command: npm test
-      - run:
-          name: Send to Coveralls
-          command: cat coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js
-      - save_cache:
-          paths:
-            - node_modules
-          key: v2-dependencies-{{ checksum "package.json" }}
-
-      - persist_to_workspace:
-          root: ~/repo
-          paths: .
-
-workflows:
-  version: 2
-  test-deploy:
-    jobs:
-      - test:
-          filters:
-            tags:
-              only: /^v[0-9]+\.[0-9]+\.[0-9]+/

package/.eslintrc

@@ -1,75 +0,0 @@
-{
-  "env": {
-    "browser": false,
-    "node": true,
-    "mocha": true,
-    "es6": true
-  },
-  // enable the es6 features supported by our browsers / iojs
-  "ecmaFeatures": {
-    "arrowFunctions": true,
-    "blockBindings": true,
-    "forOf": true,
-    "objectLiteralDuplicateProperties": true,
-    "objectLiteralShorthandProperties": true,
-    "objectLiteralShorthandMethods": true,
-    "octalLiterals": true,
-    "binaryLiterals": true,
-    "templateStrings": true,
-    "generators": false
-  },
-  "rules": {
-    // possible errors
-    "no-extra-parens": 1,
-    "valid-jsdoc": [1, {
-      "requireReturn": false,
-      "requireParamDescription": false,
-      "requireReturnDescription": false
-    }],
-    // best practices
-    "complexity": [2, 8],
-    "default-case": 2,
-    "guard-for-in": 2,
-    "no-alert": 1,
-    "no-floating-decimal": 1,
-    "no-self-compare": 2,
-    "no-throw-literal": 2,
-    "no-void": 2,
-    "quote-props": [2, "as-needed"],
-    "vars-on-top": 2,
-    "wrap-iife": 2,
-    // strict mode
-    "strict": [2, "global"],
-    // variables
-    "no-unused-vars": 2,
-    // node.js
-    "handle-callback-err": [2, "^.*(e|E)rr"],
-    "no-mixed-requires": 0,
-    "no-new-require": 2,
-    "no-path-concat": 2,
-    // stylistic issues
-    "brace-style": [2, "1tbs", { "allowSingleLine": true }],
-    "comma-style": [2, "last"],
-    "indent": [2, 2, { "SwitchCase": 1 }],
-    "max-nested-callbacks": [2, 4],
-    "newline-after-var": [2, "always"],
-    "no-nested-ternary": 2,
-    "no-spaced-func": 0,
-    "no-trailing-spaces": 2,
-    "no-underscore-dangle": 0,
-    "no-unneeded-ternary": 1,
-    "one-var": 0,
-    "quotes": [2, "single", "avoid-escape"],
-    "semi": [2, "always"],
-    "keyword-spacing": 2,
-    "space-before-blocks": [2, "always"],
-    "space-before-function-paren": [2, {"anonymous": "always", "named": "never"}],
-    "space-infix-ops": [1, {"int32Hint": false}],
-    "spaced-comment": [2, "always"],
-    // es6
-    "generator-star-spacing": [2, "before"],
-    // legacy jshint rules
-    "max-depth": [2, 4],
-    "max-params": [2, 4]
-  }
-}

package/.github/workflows/push.yml

@@ -1,26 +0,0 @@
-on: push
-name: Deploy to GitHub Pages
-jobs:
-  filterBranch:
-    name: Filter branch
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@master
-    - name: Filter branch
-      uses: actions/bin/filter@master
-      with:
-        args: branch master
-    - name: Install
-      uses: actions/npm@master
-      with:
-        args: install --prefix ./website
-    - name: Update version
-      uses: clay/docusaurus-github-action@master
-      with:
-        args: version
-    - name: Build and push docs
-      uses: clay/docusaurus-github-action@master
-      env:
-        DEPLOY_SSH_KEY: ${{ secrets.DEPLOY_SSH_KEY }}
-      with:
-        args: deploy

package/.istanbul.yml

@@ -1,51 +0,0 @@
-verbose: false
-instrumentation:
-    root: .
-    default-excludes: true
-    excludes: []
-    embed-source: false
-    variable: __coverage__
-    compact: true
-    preserve-comments: false
-    complete-copy: false
-    save-baseline: false
-    baseline-file: ./coverage/coverage-baseline.json
-    include-all-sources: true
-    include-pid: false
-reporting:
-    print: summary
-    reports:
-        - lcov
-    dir: ./coverage
-    watermarks:
-        statements: [98, 100]
-        lines: [98, 100]
-        functions: [98, 100]
-        branches: [98, 100]
-    report-config:
-        clover: {file: clover.xml}
-        cobertura: {file: cobertura-coverage.xml}
-        json: {file: coverage-final.json}
-        json-summary: {file: coverage-summary.json}
-        lcovonly: {file: lcov.info}
-        teamcity: {file: null}
-        text: {file: null, maxCols: 0}
-        text-lcov: {file: lcov.info}
-        text-summary: {file: null}
-hooks:
-    hook-run-in-context: false
-    post-require-hook: null
-    handle-sigint: false
-check:
-    global:
-        statements: 100
-        lines: 100
-        branches: 100
-        functions: 100
-        excludes: []
-    each:
-        statements: 0
-        lines: 0
-        branches: 0
-        functions: 0
-        excludes: []

package/__mocks__/fileMock.js

@@ -1,3 +0,0 @@
-'use strict';
-
-module.exports = 'test-export';