roll20-character-sheets-tester/under_the_neighborhood/source/scaffold/accessSheet.js

/*jshint esversion: 11, laxcomma:true, eqeqeq:true*/
/*jshint -W014,-W084,-W030,-W033*/
//Sheet Updaters and styling functions
/**
 * An object to store your update functions in. Functions should be index by the version they are for (e.g. the update handler for version 1.01 would be indexed to '1.01'). These update functions will be iterated through based on the previous version of the sheet (as stored in the `sheet_version` attribute of the sheet) and the new version of the sheet (as stored in {@link k.version}).
 * @type {object}
 */
const updateSheet = function(){
  log('updating sheet');
  getAllAttrs({props:['debug_mode',...baseGet],callback:(attributes,sections,casc)=>{
    kFuncs.debugMode = kFuncs.debugMode || !!attributes.debug_mode;
    debug({sheet_version:attributes.sheet_version});
    if(!attributes.sheet_version){
      Object.entries(initialSetups).forEach(([funcName,handler])=>{
        if(typeof funcs[funcName] === 'function'){
          debug(`running ${funcName}`);
          funcs[funcName]({attributes,sections,casc});
        }else{
          debug(`!!!Warning!!! no function named ${funcName} found. Initial sheet setup not performed.`);
        }
      });
    }else{
      Object.entries(updateHandlers).forEach(([ver,handler])=>{
        if(attributes.version < +ver){
          handler({attributes,sections,casc});
        }
      });
    }
    Object.entries(openHandlers).forEach(([funcName,func])=>{
      if(typeof funcs[funcName] === 'function'){
        debug(`running ${funcName}`);
        funcs[funcName]({attributes,sections,casc});
      }else{
        debug(`!!!Warning!!! no function named ${funcName} found. Sheet open handling not performed.`);
      }
    });
    setActionCalls({attributes,sections});
    attributes.sheet_version = kFuncs.version;
    log(`Sheet Update applied. Current Sheet Version ${kFuncs.version}`);
    if(document){
      ['pug','js'].forEach((type)=>{
        log(docGen(type));
      });
    }
    attributes.set();
    log('Sheet ready for use');
  }});
};

const docGen = function(language){
  debug(`generating documentation for ${language}`);
  let docHead = [`# K Scaffold ${language.toUpperCase()} documentation`];
  Object.keys(docs[language])
    .sort((nameA,nameB) => nameA.localeCompare(nameB))
    .forEach((funcName)=>{
      docHead.push(`- [${funcName}](#${funcName.replace(/\./g,'').replace(/\s/g,'-')})`);
    });
  return Object.entries(docs[language])
    .sort(([nameA,docObjA],[nameB,docObjB]) => nameA.localeCompare(nameB))
    .reduce((text,[name,docObj]) => {
      let type = docObj.type;
      text.push(`## ${docObj.name || name}`,`\`${type}\`\n`);
      if(docObj.invocation){
        text.push(`\`\`\`js\n${docObj.invocation}\n\`\`\``);
      }
      if(docObj.description){
        text.push(docObj.description);
      }
      let args = Array.isArray(docObj.arguments) ? docObj.arguments : [];
      if(args.length){
        text.push('|Argument|type|description|','|---|---|---|')
      }
      args.forEach((a)=>{
        text.push(`|${a.name}|\`${a.type}\`|${a.description || ''}|`)
      });
      if(args.length){
        text.push('\n')
      }
      let example = Array.isArray(docObj.example) ? docObj.example : [];
      if(example.length){
        text.push(`### Example${example.length > 1 ? 's' : ''}`);
      }
      example.forEach((eArr)=>{
        text.push(
          `**${language.toUpperCase()}**`,
          `\`\`\`js`,
          eArr[0],
          `\`\`\``
        );
        if(type === 'mixin'){
          text.push(
            '**HTML**',
            `\`\`\`html`,
            eArr[1],
            `\`\`\``
          );
        }
      });
      if(docObj.retValue){
        text.push(`returns \`${docObj.retValue.type}\` ${
          docObj.retValue.description ? 
            `- ${docObj.retValue.description}` :
            ''
          }`
        );
      }
      return text;
    },docHead).join('\n');
};

const initialSetup = function(attributes,sections){
  debug('Initial sheet setup');
};

/**
 * This is the default listener function for attributes that the K-Scaffold uses. It utilizes the `triggerFuncs`, `listenerFunc`, `calculation`, and `affects` properties of the K-scaffold trigger object (see the Pug section of the scaffold for more details).
 * @param {Roll20Event} event
 * @returns {void}
 */
const accessSheet = function(event){
  debug({funcs:Object.keys(funcs)});
  debug({event});
  getAllAttrs({event,callback:(attributes,sections,casc)=>{
    let trigger = attributes.getCascObj(event,casc);
    attributes.processChange({event,trigger,attributes,sections,casc});
  }});
};
funcs.accessSheet = accessSheet;