esxdoc/out/src/Publisher/Builder/TestDocBuilder.js

Good Documentation Generator For JavaScript

'use strict';

Object.defineProperty(exports, "__esModule", {
  value: true
});

var _iceCap = require('ice-cap');

var _iceCap2 = _interopRequireDefault(_iceCap);

var _DocBuilder = require('./DocBuilder.js');

var _DocBuilder2 = _interopRequireDefault(_DocBuilder);

function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }

/**
 * Test file output html builder class.
 */
class TestDocBuilder extends _DocBuilder2.default {
  /**
   * execute building output html.
   * @param {function(html: string, filePath: string)} callback - is called with output html.
   */
  exec(callback) {
    const testDescribeDoc = this._find({ kind: 'testDescribe' })[0];
    if (!testDescribeDoc) return;

    const ice = this._buildLayoutDoc();
    const fileName = this._getOutputFileName(testDescribeDoc);
    const baseUrl = this._getBaseUrl(fileName);
    const title = this._getTitle('Test');

    ice.load('content', this._buildTestDocHTML());
    ice.attr('baseUrl', 'href', baseUrl);
    ice.text('title', title);
    callback(ice.html, fileName);
  }

  /**
   * build whole test file output html.
   * @returns {string} html of whole test file.
   * @private
   */
  _buildTestDocHTML() {
    const ice = new _iceCap2.default(this._readTemplate('test.html'));
    const testDescribeHTML = this._buildTestDescribeDocHTML();
    ice.load('tests', testDescribeHTML);
    return ice.html;
  }

  /**
   * build test describe list html.
   * @param {number} [depth=0] - test depth.
   * @param {string} [memberof] - target test.
   * @returns {string} html of describe list.
   * @private
   */
  _buildTestDescribeDocHTML(depth = 0, memberof = null) {
    const cond = { kind: 'testDescribe', testDepth: depth };
    if (memberof) cond.memberof = memberof;
    const describeDocs = this._orderedFind('testId asec', cond);
    let padding;
    let html = '';

    for (const describeDoc of describeDocs) {
      const ice = new _iceCap2.default(this._readTemplate('testDescribe.html'));

      const testCount = this._find({ kind: 'testIt', longname: { regex: new RegExp(`^${ describeDoc.longname }\\.`) } }).length;
      padding = 10 * (depth + 1);
      ice.attr('testDescribe', 'data-test-depth', depth);
      /* eslint-disable no-loop-func */
      ice.into('testDescribe', describeDoc, (describeDoc, ice) => {
        const descriptionHTML = this._buildFileDocLinkHTML(describeDoc, describeDoc.description);

        let testTargetsHTML = [];
        for (const testTarget of describeDoc._custom_test_targets || []) {
          testTargetsHTML.push(this._buildDocLinkHTML(testTarget[0], testTarget[1]));
        }
        testTargetsHTML = testTargetsHTML.join('\n') || '-';

        ice.load('testDescription', descriptionHTML);
        ice.attr('testDescription', 'style', `padding-left: ${ padding }px`);
        ice.load('testTarget', testTargetsHTML);
        ice.text('testCount', testCount);
      });

      padding = 10 * (depth + 2);
      const itDocs = this._orderedFind('testId asec', { kind: 'testIt', testDepth: depth + 1, memberof: describeDoc.longname });
      /* eslint-disable no-loop-func */
      ice.loop('testIt', itDocs, (i, itDoc, ice) => {
        const descriptionHTML = this._buildFileDocLinkHTML(itDoc, itDoc.description);

        let testTargetsHTML = [];
        for (const testTarget of itDoc._custom_test_targets || []) {
          testTargetsHTML.push(this._buildDocLinkHTML(testTarget[0], testTarget[1]));
        }
        testTargetsHTML = testTargetsHTML.join('\n') || '-';

        ice.attr('testIt', 'data-test-depth', depth + 1);
        ice.load('testDescription', descriptionHTML);
        ice.attr('testDescription', 'style', `padding-left: ${ padding }px`);
        ice.load('testTarget', testTargetsHTML);
      });

      const innerDescribeHTML = this._buildTestDescribeDocHTML(depth + 1, describeDoc.longname);

      html += `\n${ ice.html }\n${ innerDescribeHTML }`;
    }

    return html;
  }
}
exports.default = TestDocBuilder;