{ "file": "lib/data-types/generate-classes.js", "content": "
'use strict';\nconst parseMarkdown = require('../parse-markdown');\n\n/**\n * Module handles decorating and compiling classes and their class items including:\n * - Compiling each class item to its class\n * - Creating an id for class and class src file\n * - Parsing class and class item descriptions markdown to HTML\n * @class DataTypes.GenerateClasses\n * @constructor\n * @param {Object} classes    Object of raw YUIDoc classes\n * @param {Object} classItems Array of raw YUIDoc classItems\n * @return {Object} Returns object: `{ classesMeta, classesDatas }` for saving\n */\nmodule.exports = function generateClass(classes, classitems) {\n  let classesMeta = [];\n  let classesDatas = [];\n  let map = {};\n\n  // Prep classes by adding arrays for methods/properties/events\n  for (let classKey in classes) {\n    if (!classes.hasOwnProperty(classKey)) { return; }\n    Object.assign(classes[classKey], { method: [], property: [], event: [] });\n  }\n\n  // ========================================================\n  // Decorate && Sort Class Items\n  // ========================================================\n\n  // Sort alphabet style\n  classitems.sort((a, b) => {\n    if (a.name === b.name) { return 0; }\n    return a.name < b.name ? -1 : 1;\n  });\n\n  /*\n   * Class items can have duplicate entries, which should be deduped for the\n   * final ouput. Handle picking last declared item by working array by starting\n   * from the END. Each item is added to a map which prevents dupes from being\n   * picked up. Items are added using their name && type b/c duplicate names with\n   * different types is valid.\n   */\n  for (let i = classitems.length - 1, ii = 0; i >= ii; i--) {\n    let item = classitems[i];\n\n    // Only handle item if it is not already in map, prevents dupes\n    if (!map[`${item.name}_${item.class}`]) {\n      if (item.description) { item.description = parseMarkdown(item.description); }\n      if (item.deprecationMessage) { item.deprecationMessage = parseMarkdown(item.deprecationMessage); }\n      if (item.params && item.params.length) {\n        item.params.forEach(param => {\n          param.description = param.description ? parseMarkdown(param.description) : null;\n        });\n      }\n\n      // Attach to the right parent class\n      if (item.class) {\n        classes[item.class].classitems.unshift(item);\n      }\n\n      // Attach to parent class type array\n      if (item.itemtype) {\n        classes[item.class][item.itemtype].unshift(item);\n      }\n\n      // Add src file id for reference\n      if (item.file) {\n        item.srcFileId = item.file.replace(/\\/|\\\\/g, '_');\n      }\n\n      // Add to map to prevent dupes\n      map[`${item.name}_${item.class}`] = true;\n    }\n  }\n\n  // ========================================================\n  // Decorate && Sort Classes\n  // ========================================================\n\n  for (let classKey in classes) {\n    if (!classes.hasOwnProperty(classKey)) { return; }\n\n    const klass = classes[classKey];\n\n    // Add class meta\n    classesMeta.push({\n      name: klass.name,\n      type: 'classes'\n    });\n\n    // Add src file id for reference\n    if (klass.file) {\n      klass.srcFileId = klass.file.replace(/\\/|\\\\/g, '_');\n    }\n\n    // Parse class markdown description\n    if (klass.description) {\n      klass.description = parseMarkdown(klass.description);\n    }\n\n    // Add class object that will be saved as individual file\n    classesDatas.push(klass);\n  }\n\n  // Alphabetize meta for sidebar display\n  classesMeta.sort((a, b) => a.name < b.name ? -1 : 1);\n\n  return {\n    classesMeta: classesMeta,\n    classesDatas: classesDatas\n  };\n};\n
" }