@canopycanopycanopy/b-ber-grammar-attributes 2.0.0 → 3.0.2

package/dist/index.js

@@ -1,55 +1,30 @@
 "use strict";
 
 var _Object$keys = require("@babel/runtime-corejs3/core-js-stable/object/keys");
-
 var _Object$getOwnPropertySymbols = require("@babel/runtime-corejs3/core-js-stable/object/get-own-property-symbols");
-
 var _filterInstanceProperty = require("@babel/runtime-corejs3/core-js-stable/instance/filter");
-
 var _Object$getOwnPropertyDescriptor = require("@babel/runtime-corejs3/core-js-stable/object/get-own-property-descriptor");
-
 var _forEachInstanceProperty = require("@babel/runtime-corejs3/core-js-stable/instance/for-each");
-
 var _Object$getOwnPropertyDescriptors = require("@babel/runtime-corejs3/core-js-stable/object/get-own-property-descriptors");
-
 var _Object$defineProperties = require("@babel/runtime-corejs3/core-js-stable/object/define-properties");
-
 var _Object$defineProperty = require("@babel/runtime-corejs3/core-js-stable/object/define-property");
-
 var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault");
-
 _Object$defineProperty(exports, "__esModule", {
   value: true
 });
-
 exports.toAlias = exports.parseAttrs = exports.htmlId = exports.attributesString = exports.attributesQueryString = exports.attributesObject = exports.attributes = void 0;
-
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime-corejs3/helpers/defineProperty"));
-
 var _trim = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/instance/trim"));
-
 var _reduce = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/instance/reduce"));
-
 var _entries = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/object/entries"));
-
 var _concat = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/instance/concat"));
-
 var _path = _interopRequireDefault(require("path"));
-
 var _lodash = _interopRequireDefault(require("lodash.has"));
-
 var _bBerLib = require("@canopycanopycanopy/b-ber-lib");
-
-var _utils = require("@canopycanopycanopy/b-ber-lib/utils");
-
 var _bBerLogger = _interopRequireDefault(require("@canopycanopycanopy/b-ber-logger"));
-
 var _bBerShapesDirectives = require("@canopycanopycanopy/b-ber-shapes-directives");
-
 function ownKeys(object, enumerableOnly) { var keys = _Object$keys(object); if (_Object$getOwnPropertySymbols) { var symbols = _Object$getOwnPropertySymbols(object); enumerableOnly && (symbols = _filterInstanceProperty(symbols).call(symbols, function (sym) { return _Object$getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
-
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var _context3, _context4; var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? _forEachInstanceProperty(_context3 = ownKeys(Object(source), !0)).call(_context3, function (key) { (0, _defineProperty2.default)(target, key, source[key]); }) : _Object$getOwnPropertyDescriptors ? _Object$defineProperties(target, _Object$getOwnPropertyDescriptors(source)) : _forEachInstanceProperty(_context4 = ownKeys(Object(source))).call(_context4, function (key) { _Object$defineProperty(target, key, _Object$getOwnPropertyDescriptor(source, key)); }); } return target; }
-
 //
 // Querying hierarchies gets confusing, so we're using biological taxonomic
 // rank as an analogue for classification. which is obvs less confusing...
@@ -57,57 +32,51 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 // Class    -> Order  -> Family       -> Genus
 // element  -> block  -> frontmatter  -> preface
 //
-const _lookUpFamily = genus => _bBerShapesDirectives.FRONTMATTER_DIRECTIVES.has(genus) ? 'frontmatter' : _bBerShapesDirectives.BODYMATTER_DIRECTIVES.has(genus) ? 'bodymatter' : _bBerShapesDirectives.BACKMATTER_DIRECTIVES.has(genus) ? 'backmatter' : ''; // Determine the directive's classification and parent's type
 
+const _lookUpFamily = genus => _bBerShapesDirectives.FRONTMATTER_DIRECTIVES.has(genus) ? 'frontmatter' : _bBerShapesDirectives.BODYMATTER_DIRECTIVES.has(genus) ? 'bodymatter' : _bBerShapesDirectives.BACKMATTER_DIRECTIVES.has(genus) ? 'backmatter' : '';
 
+// Determine the directive's classification and parent's type
 const _directiveOrder = genus => _bBerShapesDirectives.BLOCK_DIRECTIVES.has(genus) ? 'block' : _bBerShapesDirectives.INLINE_DIRECTIVES.has(genus) ? 'inline' : _bBerShapesDirectives.MISC_DIRECTIVES.has(genus) ? 'misc' : null;
-
 const _requiresAltTag = genus => _bBerShapesDirectives.DIRECTIVES_REQUIRING_ALT_TAG.has(genus);
-
 const _isUnsupportedAttribute = (genus, attr) => {
   let key;
-
   if (_bBerShapesDirectives.BLOCK_DIRECTIVES.has(genus)) {
-    // these are all containers which share the same attributes, so they're
+    // These are all containers which share the same attributes, so they're
     // grouped under a single property
     key = 'block';
   } else {
-    // this will be the directive name, e.g., figure, video, etc
+    // This will be the directive name, e.g., figure, video, etc
     key = genus;
   }
-
   return !_bBerShapesDirectives.SUPPORTED_ATTRIBUTES[key] || _bBerShapesDirectives.SUPPORTED_ATTRIBUTES[key][attr] !== true;
 };
-
 const _applyTransforms = (k, v) => {
   switch (k) {
     case 'classes':
       return ` class="${v}"`;
-
     case 'epubTypes':
       return ` epub:type="${v}"`;
-
     case 'attrs':
       return '';
-
     case 'source':
       return ` src="${v}"`;
-    // media controls enabled by default
 
+    // media controls enabled by default
     case 'controls':
       return v === 'no' ? '' : ` ${k}="${v}"`;
-    // boolean attrs for audio/video elements
 
+    // boolean attrs for audio/video elements
     case 'autoplay':
     case 'muted':
     case 'autobuffer':
     case 'loop':
       return v === 'yes' ? ` ${k}="${k}"` : '';
-
     default:
       return ` ${k}="${v}"`;
   }
-}; // MarkdownIt returns a trimmed string of the directive's attributes, which
+};
+
+// MarkdownIt returns a trimmed string of the directive's attributes, which
 // are parsed and transformed into a string of HTML attributes
 //
 //    ::: directive:id classes:"foo bar baz"
@@ -115,8 +84,6 @@ const _applyTransforms = (k, v) => {
 //    -> {classes:"foo bar baz"}
 //    -> class="foo bar baz"
 //
-
-
 const parseAttrs = s => {
   const out = {};
   let str = '';
@@ -125,37 +92,24 @@ const parseAttrs = s => {
   let char;
   let next;
   let key;
-
   for (let i = 0; i < s.length; i++) {
     char = s[i].charCodeAt(0);
     next = s[i + 1] ? s[i + 1].charCodeAt(0) : '';
-
-    if (!open && char === 58
-    /* : */
-    ) {
+    if (!open && char === 58 /* : */) {
       // char is a token, we set `open` so that we don't misinterpret literals inside quotations
       open = true;
       key = str;
       str = '';
-      delim = 32;
-      /*   */
-
-      if (next === 34
-      /* " */
-      || next === 39
-      /* ' */
-      ) {
+      delim = 32; /*   */
+      if (next === 34 /* " */ || next === 39 /* ' */) {
         i++;
         delim = next;
       }
-
       continue;
     }
-
     if (char === delim) {
       // token is ending delimiter since we've advanced our pointer
       key = (0, _trim.default)(key).call(key); // trim whitespace, allowing for multiple spaces
-
       if (key) out[key] = str;
       str = '';
       key = '';
@@ -163,9 +117,7 @@ const parseAttrs = s => {
       delim = null;
       continue;
     }
-
     str += s[i];
-
     if (i === s.length - 1) {
       // end of line
       if (key && key.length && str && str.length) {
@@ -174,42 +126,35 @@ const parseAttrs = s => {
       }
     }
   }
-
   return out;
-}; // -> prop="val"
-// Pass reference object in to only add keys/values that exist on reference
-
+};
 
+// -> prop="val"
+// Pass reference object in to only add keys/values that exist on reference
 exports.parseAttrs = parseAttrs;
-
 const _buildAttrString = (obj, reference) => {
   var _context;
-
   return (0, _reduce.default)(_context = (0, _entries.default)(obj)).call(_context, (acc, [key, val]) => !reference || (0, _lodash.default)(reference, key) ? (0, _concat.default)(acc).call(acc, _applyTransforms(key, val)) : acc, '');
-}; // -> ?foo=bar&baz=bat
-// Pass reference object in to only add keys/values that exist on reference
-
+};
 
+// -> ?foo=bar&baz=bat
+// Pass reference object in to only add keys/values that exist on reference
 const _buildAttrQueryString = (obj, reference) => {
   var _context2;
-
   return (0, _reduce.default)(_context2 = (0, _entries.default)(obj)).call(_context2, (acc, [key, val]) => {
     const prefix = acc.length ? '&amp;' : '?';
     const encodedVal = encodeURIComponent(_bBerLib.Url.ensureDecoded(val));
     return !reference || (0, _lodash.default)(reference, key) ? (0, _concat.default)(acc).call(acc, `${prefix}${key}=${encodedVal}`) : acc;
   }, '');
-}; // Ensure that attributes required for valid XHTML are present, and that system
-// defaults are merged into user settings
-
+};
 
+// Ensure that attributes required for valid XHTML are present, and that system
+// defaults are merged into user settings
 const _extendWithDefaults = (obj, genus) => {
   const result = _objectSpread({}, obj);
-
   const order = _directiveOrder(genus);
-
   if (!order) throw new TypeError(`Invalid directive type: [${genus}]`);
   let taxonomy;
-
   switch (order) {
     case 'block':
     case 'misc':
@@ -218,34 +163,28 @@ const _extendWithDefaults = (obj, genus) => {
       if (order === 'block') {
         result.epubTypes = taxonomy;
       }
-
       if ((0, _lodash.default)(obj, 'classes')) {
         taxonomy = `${_lookUpFamily(result.classes)} ${genus}`;
-
         if (order === 'block') {
           result.epubTypes = taxonomy;
         }
-
         result.classes += ` ${taxonomy}`; // -> class="... bodymatter chapter"
       } else {
         result.classes = taxonomy; // -> class="bodymatter chapter"
       }
 
       return result;
-
     case 'inline':
       if (_requiresAltTag(genus) && !(0, _lodash.default)(obj, 'alt')) {
         result.alt = result.source;
       }
-
       return result;
-
     default:
       return result;
   }
-}; // Create an object from attributes in the given directive
-
+};
 
+// Create an object from attributes in the given directive
 const attributesObject = (attrs, origGenus, context = {}) => {
   const {
     fileName,
@@ -253,40 +192,37 @@ const attributesObject = (attrs, origGenus, context = {}) => {
   } = context;
   const attrsObject = {};
   let genus = origGenus;
-
   if (!genus || typeof genus !== 'string') {
     _bBerLogger.default.error(`No directive provided: ${fileName}:${lineNumber}`);
   }
-
   if (!_bBerShapesDirectives.ALL_DIRECTIVES.has(genus)) {
     _bBerLogger.default.error(`Invalid directive: [${genus}] at ${fileName}:${lineNumber}`);
   }
-
   if (_bBerShapesDirectives.DRAFT_DIRECTIVES.has(genus)) {
     _bBerLogger.default.warn(`render [epub:${genus}] is [draft]. substituting with [chapter]`);
-
     genus = 'chapter';
   }
-
   if (_bBerShapesDirectives.DEPRECATED_DIRECTIVES.has(genus)) {
     _bBerLogger.default.warn(`render [epub:${genus}] is [deprecated]. substituting with [chapter]`);
-
     genus = 'chapter';
   }
-
   if (attrs && typeof attrs === 'string') {
-    (0, _utils.forOf)(parseAttrs((0, _trim.default)(attrs).call(attrs)), (k, v) => {
-      if (_isUnsupportedAttribute(genus, k)) {
-        return _bBerLogger.default.warn(`render omitting unsupported attribute [${k}] at [${fileName}:${lineNumber}]`);
+    const parsedAttrs = (0, _entries.default)(parseAttrs((0, _trim.default)(attrs).call(attrs)));
+
+    // eslint-disable-next-line no-unused-vars
+    for (const [key, val] of parsedAttrs) {
+      if (_isUnsupportedAttribute(genus, key)) {
+        _bBerLogger.default.warn(`render omitting unsupported attribute [${key}] at [${fileName}:${lineNumber}]`);
+        continue;
       }
+      attrsObject[key] = val;
+    }
+  }
 
-      attrsObject[k] = v;
-    });
-  } // Add original `origGenus` as a class to the attrs object in case it's
+  // Add original `origGenus` as a class to the attrs object in case it's
   // different from the current `genus` (which might've changed due to it's
   // specification). do this to keep styling consistent
 
-
   if (genus !== origGenus) {
     if ((0, _lodash.default)(attrsObject, 'classes')) {
       attrsObject.classes += ` ${origGenus}`;
@@ -294,33 +230,23 @@ const attributesObject = (attrs, origGenus, context = {}) => {
       attrsObject.classes = origGenus;
     }
   }
-
   const mergedAttrs = _extendWithDefaults(attrsObject, genus);
-
   return mergedAttrs;
-}; // Create a string of attributes for an XHTML element
-
+};
 
+// Create a string of attributes for an XHTML element
 exports.attributesObject = attributesObject;
+const attributesString = (obj, reference) => _buildAttrString(obj, reference);
 
-const attributesString = (obj, reference) => _buildAttrString(obj, reference); // Create a query string of attributes for an iframe src
-
-
+// Create a query string of attributes for an iframe src
 exports.attributesString = attributesString;
+const attributesQueryString = (obj, reference) => _buildAttrQueryString(obj, reference);
 
-const attributesQueryString = (obj, reference) => _buildAttrQueryString(obj, reference); // Convenience wrapper for creating attributes: String -> Object -> String
-
-
+// Convenience wrapper for creating attributes: String -> Object -> String
 exports.attributesQueryString = attributesQueryString;
-
 const attributes = (str, type, context) => _buildAttrString(attributesObject(str, type, context));
-
 exports.attributes = attributes;
-
 const htmlId = s => s.replace(/[^0-9a-zA-Z_-]/g, '-');
-
 exports.htmlId = htmlId;
-
 const toAlias = fpath => _path.default.basename(_path.default.basename(fpath, _path.default.extname(fpath)));
-
 exports.toAlias = toAlias;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@canopycanopycanopy/b-ber-grammar-attributes",
-  "version": "2.0.0",
+  "version": "3.0.2",
   "description": "",
   "main": "dist/index.js",
   "scripts": {
@@ -17,9 +17,9 @@
     "access": "public"
   },
   "dependencies": {
-    "@canopycanopycanopy/b-ber-lib": "2.0.0",
-    "@canopycanopycanopy/b-ber-logger": "2.0.0",
-    "@canopycanopycanopy/b-ber-shapes-directives": "2.0.0",
+    "@canopycanopycanopy/b-ber-lib": "3.0.2",
+    "@canopycanopycanopy/b-ber-logger": "3.0.2",
+    "@canopycanopycanopy/b-ber-shapes-directives": "3.0.2",
     "lodash": "^4.17.21",
     "lodash.has": "latest",
     "tar": "^6.1.11"
@@ -49,5 +49,5 @@
       "url": "https://maxwellsimmer.com"
     }
   ],
-  "gitHead": "dbeae192709705f5bc211195ff343cbd999f9caf"
+  "gitHead": "1ec8ab9a4030fb59839d347beb04ab7605e3d5dd"
 }