@accordproject/markdown-template/lib/templaterules.js

/*
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

'use strict';

var formulaName = require('./util').formulaName;
var {
  getAttr
} = require('@accordproject/markdown-common').CommonMarkUtils;
var NS_PREFIX_TemplateMarkModel = require('./externalModels/TemplateMarkModel').NS_PREFIX_TemplateMarkModel;

// Inline rules
var variableRule = {
  tag: NS_PREFIX_TemplateMarkModel + 'VariableDefinition',
  leaf: true,
  open: false,
  close: false,
  enter: (node, token, callback) => {
    var format = getAttr(token.attrs, 'format', null);
    if (format) {
      node.$class = NS_PREFIX_TemplateMarkModel + 'FormattedVariableDefinition';
      node.format = format;
    }
    node.name = getAttr(token.attrs, 'name', null);
    node.format = getAttr(token.attrs, 'format', null);
  },
  skipEmpty: false
};
var thisRule = {
  // 'this' is a special variable for the current data in scope within the template
  tag: NS_PREFIX_TemplateMarkModel + 'VariableDefinition',
  leaf: true,
  open: false,
  close: false,
  enter: (node, token, callback) => {
    var format = getAttr(token.attrs, 'format', null);
    if (format) {
      node.$class = NS_PREFIX_TemplateMarkModel + 'FormattedVariableDefinition';
      node.format = format;
    }
    node.name = 'this';
    node.format = getAttr(token.attrs, 'format', null);
  },
  skipEmpty: false
};
var formulaRule = {
  tag: NS_PREFIX_TemplateMarkModel + 'FormulaDefinition',
  leaf: true,
  open: false,
  close: false,
  enter: (node, token, callback) => {
    var code = token.content;
    node.name = formulaName(code);
    node.code = code;
    node.dependencies = [];
  },
  skipEmpty: false
};
var ifOpenRule = {
  tag: NS_PREFIX_TemplateMarkModel + 'ConditionalDefinition',
  leaf: false,
  open: true,
  close: false,
  enter: (node, token, callback) => {
    node.name = getAttr(token.attrs, 'name', null);
    node.whenTrue = null;
    node.whenFalse = null;
  },
  skipEmpty: false
};
var ifCloseRule = {
  tag: NS_PREFIX_TemplateMarkModel + 'ConditionalDefinition',
  leaf: false,
  open: false,
  close: true,
  exit: (node, token, callback) => {
    if (node.whenTrue) {
      node.whenFalse = node.nodes ? node.nodes : [];
    } else {
      node.whenTrue = node.nodes ? node.nodes : [];
      node.whenFalse = [];
    }
    delete node.nodes; // Delete children (now in whenTrue or whenFalse)
  },

  skipEmpty: false
};
var elseRule = {
  tag: NS_PREFIX_TemplateMarkModel + 'ConditionalDefinition',
  leaf: false,
  open: false,
  close: false,
  enter: (node, token, callback) => {
    if (node.$class === 'org.accordproject.templatemark.ConditionalDefinition') {
      node.whenTrue = node.nodes ? node.nodes : [];
      node.nodes = []; // Reset children (now in whenTrue)
    } else {
      // Optional definition
      node.whenSome = node.nodes ? node.nodes : [];
      node.nodes = []; // Reset children (now in whenSome)
    }
  },

  skipEmpty: false
};
var optionalOpenRule = {
  tag: NS_PREFIX_TemplateMarkModel + 'OptionalDefinition',
  leaf: false,
  open: true,
  close: false,
  enter: (node, token, callback) => {
    node.name = getAttr(token.attrs, 'name', null);
    node.whenSome = null;
    node.whenNone = null;
  },
  skipEmpty: false
};
var optionalCloseRule = {
  tag: NS_PREFIX_TemplateMarkModel + 'OptionalDefinition',
  leaf: false,
  open: false,
  close: true,
  exit: (node, token, callback) => {
    if (node.whenSome) {
      node.whenNone = node.nodes ? node.nodes : [];
    } else {
      node.whenSome = node.nodes ? node.nodes : [];
      node.whenNone = [];
    }
    delete node.nodes; // Delete children (now in whenSome or whenNone)
  },

  skipEmpty: false
};
var withOpenRule = {
  tag: NS_PREFIX_TemplateMarkModel + 'WithDefinition',
  leaf: false,
  open: true,
  close: false,
  enter: (node, token, callback) => {
    node.name = getAttr(token.attrs, 'name', null);
  },
  skipEmpty: false
};
var withCloseRule = {
  tag: NS_PREFIX_TemplateMarkModel + 'WithDefinition',
  leaf: false,
  open: false,
  close: true
};
var joinOpenRule = {
  tag: NS_PREFIX_TemplateMarkModel + 'JoinDefinition',
  leaf: false,
  open: true,
  close: false,
  enter: (node, token, callback) => {
    node.name = getAttr(token.attrs, 'name', null);
    node.separator = getAttr(token.attrs, 'separator', ',');
  },
  skipEmpty: false
};
var joinCloseRule = {
  tag: NS_PREFIX_TemplateMarkModel + 'JoinDefinition',
  leaf: false,
  open: false,
  close: true
};

// Block rules
var clauseOpenRule = {
  tag: NS_PREFIX_TemplateMarkModel + 'ClauseDefinition',
  leaf: false,
  open: true,
  close: false,
  enter: (node, token, callback) => {
    node.name = getAttr(token.attrs, 'name', null);
  }
};
var clauseCloseRule = {
  tag: NS_PREFIX_TemplateMarkModel + 'ClauseDefinition',
  leaf: false,
  open: false,
  close: true
};
var ulistOpenRule = {
  tag: NS_PREFIX_TemplateMarkModel + 'ListBlockDefinition',
  leaf: false,
  open: true,
  close: false,
  enter: (node, token, callback) => {
    node.name = getAttr(token.attrs, 'name', null);
    node.type = 'bullet';
    node.tight = 'true';
  }
};
var ulistCloseRule = {
  tag: NS_PREFIX_TemplateMarkModel + 'ListBlockDefinition',
  leaf: false,
  open: false,
  close: true
};
var olistOpenRule = {
  tag: NS_PREFIX_TemplateMarkModel + 'ListBlockDefinition',
  leaf: false,
  open: true,
  close: false,
  enter: (node, token, callback) => {
    node.name = getAttr(token.attrs, 'name', null);
    node.type = 'ordered';
    node.tight = 'true';
    node.start = '1';
    node.delimiter = 'period';
  }
};
var olistCloseRule = {
  tag: NS_PREFIX_TemplateMarkModel + 'ListBlockDefinition',
  leaf: false,
  open: false,
  close: true
};
var rules = {
  inlines: {},
  blocks: {}
};
rules.inlines.variable = variableRule;
rules.inlines.this = thisRule;
rules.inlines.formula = formulaRule;
rules.inlines.inline_block_if_open = ifOpenRule;
rules.inlines.inline_block_if_close = ifCloseRule;
rules.inlines.inline_block_optional_open = optionalOpenRule;
rules.inlines.inline_block_optional_close = optionalCloseRule;
rules.inlines.inline_block_else = elseRule;
rules.inlines.inline_block_with_open = withOpenRule;
rules.inlines.inline_block_with_close = withCloseRule;
rules.inlines.inline_block_join_open = joinOpenRule;
rules.inlines.inline_block_join_close = joinCloseRule;
rules.blocks.block_clause_open = clauseOpenRule;
rules.blocks.block_clause_close = clauseCloseRule;
rules.blocks.block_ulist_open = ulistOpenRule;
rules.blocks.block_ulist_close = ulistCloseRule;
rules.blocks.block_olist_open = olistOpenRule;
rules.blocks.block_olist_close = olistCloseRule;
module.exports = rules;