adds handler for table head

adds some refactoring
tc39 · oyilmaztekin · Jul 1, 2019 · Jul 2, 2019 · Jul 2, 2019 · Jul 2, 2019
commit f19f819df1136f9ae882eae56bc26736169e27de
diff --git a/tools/markdown-checker/.gitignore b/tools/markdown-checker/.gitignore
@@ -14,6 14,7 @@ yarn.lock
 #chunks 
 .DS_Store
 .cache
 **/.idea/**
 
 # packages
 node_modules/

diff --git a/tools/markdown-checker/config.json b/tools/markdown-checker/config.json
diff --git a/tools/markdown-checker/enums.js b/tools/markdown-checker/enums.js
@@ -0,0 1,11 @@
 module.exports = {
  stage3: './../../../../README.md',
  stage1: './../../../../stage-1-proposals.md',
  DEFINITION: 'definition',
  TABLE: 'table',
  TEXT: 'text',
  ROW: 'tableRow',
  CELL: 'tableCell',
  LINK: 'linkReference',
  INLINE_CODE: 'inlineCode',
 };
diff --git a/tools/markdown-checker/index.js b/tools/markdown-checker/index.js
@@ -1,21 1,23 @@
 const readMarkdown = require('./lib/parser/readMarkdown');
 const parseToAST = require('./lib/parser/parseToAst');
 const globalData = require('./lib/data');
 const {
- collectLinkDefinitions
  collectLinkDefinitions,
 } = require('./lib/analyzer/collectLinkDefinitions');
-const { generateTable } = require('./lib/analyzer/analyzeTable');
-const config = require('./config.json');
 const { generateTable } = require('./lib/analyzer/analyzeTable');
 const enums = require('./enums.js');
 
-function processStage3({ stage3 } = config) {
 const processStage3 = (stage) => {
  const activeStage = enums[stage];
  // parse stage
- const markdownStage3 = readMarkdown(stage3);
- const parsedFile = parseToAST(markdownStage3);
  const markdownStage = readMarkdown(activeStage);
  const parsedFile = parseToAST(markdownStage);
 
  // transform stage
- const collectedLinkDefinitions = collectLinkDefinitions(parsedFile);
- const tableStage1 = generateTable(parsedFile, collectedLinkDefinitions);
  globalData.linkDefinitions = collectLinkDefinitions(parsedFile);
  const tableStage1 = generateTable(parsedFile);
 
  // generate stage
-}
 };
 
-processStage3();
 processStage3('stage1');
diff --git a/tools/markdown-checker/lib/analyzer/__tests__/detectTableChildren.test.js b/tools/markdown-checker/lib/analyzer/__tests__/detectTableChildren.test.js
@@ -1,5 1,5 @@
 const detectTables = require('../detectTables');
-const detectHeaders = require('../detectHeaders');
 const detectHeaders = require('../handleTables');
 const parsedMarkdownTree = require('../../../mocks/parsedMarkdownTree');
 
 const markdownTables = detectTables(parsedMarkdownTree);

diff --git a/tools/markdown-checker/lib/analyzer/analyzeTable.js b/tools/markdown-checker/lib/analyzer/analyzeTable.js
@@ -1,33 1,40 @@
-/**
- * @todo inspect below and decide
- * @template [https://jsoneditoronline.org/?id=f1ce5803d66149d5bc86d0d53ffb40c0]
- *
- */
 
 const detectTables = require('./detectTables');
-const detectHeaders = require('./detectHeaders');
-const checkNodeHasChildren = require('./../transformer/nodeChildrenChecker');
 const handleTables = require('./handleTables');
 const { checkNodeHasChildren } = require('../utils');
 /**
  * @todo inspect below and decide
  * @template [https://jsoneditoronline.org/?id=f1ce5803d66149d5bc86d0d53ffb40c0]
  *
- * @param {Object} node - current node of the parsed AST
- * @param {Object} linkDefinitions - represents all of the link shortcuts
  */
 
-function generateTable(node, linkDefinitions) {
- const tables = extractAllTablesFromTree(node);
- const rows = tables && detectHeaders(table);
-}
-
 /**
  *
  * @param {Object} node
  * @returns {Array}
  */
-function extractAllTablesFromTree(node) {
 const extractAllTablesFromTree = (node) => {
  if (checkNodeHasChildren(node)) {
  return detectTables(node);
  }
  return [];
-}
 };
 /**
  *
  * @param {Object} node - current node of the parsed AST
  * @param {Object} linkDefinitions - represents all of the link shortcuts
  */
 
 const generateTable = (node) => {
  const tables = extractAllTablesFromTree(node);
  if (tables && tables.length > 0) {
  tables.forEach((table) => {
  if (Object.values(table).length > 0) {
  const JSONTables = handleTables(table);
  }
  });
  }
  return [];
 };
 
 module.exports = { generateTable, extractAllTablesFromTree };
diff --git a/tools/markdown-checker/lib/analyzer/collectLinkDefinitions.js b/tools/markdown-checker/lib/analyzer/collectLinkDefinitions.js
@@ -1,28 1,32 @@
-/**
- * @param {Object} AST
- * @returns {Object} - collected link definitions
- */
-function collectLinkDefinitions(AST) {
- const definitions = {};
- AST.children.forEach(node => {
- node.type === 'definition' && addLinkIntoDefintions(definitions, node);
- });
- return definitions;
-}
 const { DEFINITION } = require('./../../enums.js');
 
 /**
  *
  * @param {Object} definitions
  * @param {Object} node
  * @returns {Object}
  */
-function addLinkIntoDefintions(definitions, node) {
 function addLinkIntoDefinitions(definitions, node) {
  const { label, url } = node;
  // eslint-disable-next-line no-param-reassign
  definitions[label] = url;
  return {
  label,
- url
  url,
  };
 }
 
-module.exports = { collectLinkDefinitions, addLinkIntoDefintions };
 /**
  * @param {Object} AST
  * @returns {Object} - collected link definitions
  */
 function collectLinkDefinitions(AST) {
  const definitions = {};
  AST.children.forEach((node) => {
  // eslint-disable-next-line no-unused-expressions
  node.type === DEFINITION && addLinkIntoDefinitions(definitions, node);
  });
  return definitions;
 }
 
 module.exports = { collectLinkDefinitions };
diff --git a/tools/markdown-checker/lib/analyzer/detectHeaders.js b/tools/markdown-checker/lib/analyzer/detectHeaders.js
diff --git a/tools/markdown-checker/lib/analyzer/detectTables.js b/tools/markdown-checker/lib/analyzer/detectTables.js
@@ -1,9 1,10 @@
 const { TABLE } = require('./../../enums.js');
 /**
  * @param {Object} node - Parsed markdown file an AST Object
  * @returns {Array} - contains detected table nodes of the AST
  */
 function detectTables(node) {
- return node.children.filter(({ type }) => type === 'table');
-};
  return node.children.filter(({ type }) => type === TABLE);
 }
 
 module.exports = detectTables;
diff --git a/tools/markdown-checker/lib/analyzer/handleTables.js b/tools/markdown-checker/lib/analyzer/handleTables.js
@@ -0,0 1,64 @@
 const {
  CELL, TABLE, ROW, LINK, TEXT,
 } = require('../../enums');
 const globalData = require('../data');
 
 const { tableHead, tables } = globalData;
 const { iterateAndConcatValue, handleLinkReference, concatValue } = require('../utils');
 
 /**
  *
  * @param {Array} headNodes
  * @return {handleTables}
  */
 const createHead = (headNodes) => {
  headNodes.forEach(({ type, children }) => {
  if (type !== CELL) return null;
  tableHead.push(iterateAndConcatValue(children));
  return tableHead;
  });
  return tableHead;
 };
 
 const handleCell = (cells, length) => {
  // FIXME: collect only related cells
  if (cells.length) {
  let column = {};
  cells.forEach((cell, idx) => {
  if (cell.type === LINK) {
  const relatedHead = tableHead[idx];
  column[relatedHead] = handleLinkReference(cell, globalData.linkDefinitions);
  } if (cell.type === TEXT) {
  const relatedHead = tableHead[idx];
  column[relatedHead] = cell.value;
  }
  if (idx !== 0 && idx % length === 0) {
  tables.push(column);
  column = {};
  }
  });
  }
  return tables;
 };
 
 const handleRows = (row, length) => {
  row.forEach(({ type, children }) => {
  if (type !== CELL) return null;
  return handleCell(children, length);
  });
 };
 
 /**
  * @param {Object} table
  * @returns {Object} - collected header template
  */
 const handleTables = ({ align: { length }, type, children }) => {
  if (type !== TABLE) return null;
  children.forEach(({ children: tableRow, type: rowType }, idx) => {
  if (rowType !== ROW) return null;
  if (idx === 0) return createHead(tableRow);
  return handleRows(tableRow, length);
  });
 };
 
 module.exports = handleTables;
diff --git a/tools/markdown-checker/lib/data.js b/tools/markdown-checker/lib/data.js
@@ -0,0 1,4 @@
 module.exports = {
  tableHead: [],
  tables: [],
 };
diff --git a/tools/markdown-checker/lib/parser/__tests__/resolveAndParse.test.js b/tools/markdown-checker/lib/parser/__tests__/resolveAndParse.test.js
@@ -1,8 1,8 @@
 const readMarkdown = require('../readMarkdown');
-const config = require('./../../../config.json');
 const {stage3} = require('../../../enums.js');
 const parseToAST = require('./../parseToAst');
 const checkHasTokenizationRererences = require('../__tests__/parserTokenTester');
-const sourceCode = readMarkdown(config.stage3);
 const sourceCode = readMarkdown(stage3);
 
 describe('testing path resolver and reader', () => {
  test('is defined', () => {

diff --git a/tools/markdown-checker/lib/transformer/__tests__/nodeChildrenChecker.test.js b/tools/markdown-checker/lib/transformer/__tests__/nodeChildrenChecker.test.js
diff --git a/tools/markdown-checker/lib/transformer/nodeChildrenChecker.js b/tools/markdown-checker/lib/transformer/nodeChildrenChecker.js
diff --git a/tools/markdown-checker/lib/transformer/traverser.js b/tools/markdown-checker/lib/transformer/traverser.js
diff --git a/tools/markdown-checker/lib/utils.js b/tools/markdown-checker/lib/utils.js
@@ -0,0 1,52 @@
 /**
  * @param {Array} node
  * @param {function} callBackLogic
  */
 
 const traverseChildren = (node, callBackLogic) => {
  node.forEach((n) => {
  callBackLogic(n);
  if (n.children) {
  traverseChildren(n.children);
  }
  });
 
  if (callBackLogic && typeof callBackLogic === 'function') callBackLogic(node);
 };
 
 /**
  *
  * @param {Object} node
  * @returns {Boolean}
  */
 const checkNodeHasChildren = node => !!node.children;
 
 /**
  *
  * @param {String | Object} acc
  * @param node {Object}
  * @return {Buffer | any[] | string}
  */
 const concatValue = (acc = '', node) => {
  if (typeof acc === 'object') return acc.value node.value;
  return acc node.value;
 };
 
 const iterateAndConcatValue = (children) => {
  const [firstItem] = children;
  if (children.length <= 1) return firstItem.value;
  return children.reduce((acc, curr) => concatValue(acc, curr));
 };
 
 const handleLinkReference = ({ identifier, children }, linkDefinitions) => ({
  text: iterateAndConcatValue(children),
  url: linkDefinitions[identifier],
 });
 
 module.exports = {
  checkNodeHasChildren,
  traverseChildren,
  concatValue,
  iterateAndConcatValue,
  handleLinkReference,
 };