Merge branch 'develop' into test-fixes

Author: WilcoFiers

build/__test-utils.js

@@ -0,0 +1,24 @@
+const outdent = require('outdent').default
+const parsePage = require('../utils/parse-page')
+
+function createGlossary(dfnObj) {
+	const dfnEntries = Object.entries(dfnObj)
+	const dfnStrings = dfnEntries.map(dfnFileContent)
+	return dfnStrings.map(parsePage)
+}
+
+function dfnFileContent([term, content]) {
+	const title = term[0].toUpperCase() + term.substr(1)
+	return outdent`
+    ---
+    title: ${title}
+    key: ${term}
+    ---
+    ${content}
+  `
+}
+
+module.exports = {
+	dfnFileContent,
+	createGlossary,
+}

build/taskforce-markdown.js

@@ -0,0 +1,79 @@
+const path = require('path')
+const getMarkdownData = require('../utils/get-markdown-data')
+const createFile = require('../utils/create-file')
+const getRuleContent = require('./taskforce-rule-page/get-rule-content')
+const getDefinitionContent = require('./taskforce-rule-page/get-definition-content')
+const program = require('commander')
+
+const rulesDirDefault = path.resolve(__dirname, '../node_modules/act-rules-community/_rules')
+const glossaryDirDefault = path.resolve(__dirname, '../node_modules/act-rules-community/pages/glossary')
+
+program
+	.option('-i, --ruleIds <id_list>', 'comma separated list of IDs', val => val.split(','))
+	.option('-o, --outDir <dirname>', 'Path to output dir')
+	.option('-r, --rulesDir <dirname>', 'Path to _rules directory')
+	.option('-g, --glossaryDir <dirname>', 'Path to glossary directory')
+	.parse(process.argv)
+
+taskforceMarkdown(program)
+	.then(() => {
+		console.log('Created taskforce markdown files')
+		process.exit()
+	})
+	.catch(e => {
+		console.error(e)
+		process.exit(1)
+	})
+
+async function taskforceMarkdown({
+	rulesDir = rulesDirDefault,
+	glossaryDir = glossaryDirDefault,
+	ruleIds = [],
+	outDir = './content/',
+}) {
+	const rulesData = getMarkdownData(rulesDir)
+	const glossary = getMarkdownData(glossaryDir)
+	const glossaryFiles = new Set()
+
+	for (const ruleData of rulesData) {
+		if (ruleIds.length && !ruleIds.includes(ruleData.frontmatter.id)) {
+			continue
+		}
+		const { filepath, content } = buildTfRuleFile(ruleData, glossary)
+		await createFile(path.resolve(outDir, filepath), content)
+
+		const definitions = parseDefinitions(content)
+		definitions.forEach(dfn => glossaryFiles.add(dfn))
+	}
+
+	for (const definition of glossaryFiles) {
+		const { filepath, content } = buildTfDefinitionFile(definition, glossary)
+		await createFile(path.resolve(outDir, filepath), content)
+	}
+}
+
+function buildTfRuleFile(ruleData, glossary) {
+	return {
+		filepath: ruleData.filename,
+		content: getRuleContent(ruleData, glossary),
+	}
+}
+
+function buildTfDefinitionFile(definitionKey, glossary) {
+	return {
+		filepath: `glossary/${definitionKey}.md`,
+		content: getDefinitionContent(definitionKey, glossary),
+	}
+}
+
+function parseDefinitions(content) {
+	const definitionKeys = []
+	const matches = content.match(/{%[^%]*%}/g)
+	matches.forEach(str => {
+		const match = str.match(/{%\s+include_relative\s+glossary\/([^.]+).md\s+%}/i)
+		if (match) {
+			definitionKeys.push(match[1])
+		}
+	})
+	return definitionKeys
+}

build/taskforce-rule-page/__tests__/get-acknowledgements.js

@@ -0,0 +1,42 @@
+const outdent = require('outdent').default
+const getAcknowledgements = require('../get-acknowledgements')
+
+describe('taskforce-markdown', () => {
+	describe('get-acknowledgements', () => {
+		const acknowledgements = {
+			beans: ['great'],
+			Assets: ['Some text', 'Some other text'],
+			previous_authors: ['Audrey Maniez', 'Random Person'],
+			authors: ['Wilco Fiers'],
+		}
+
+		it('returns a string', () => {
+			const frontmatter = { acknowledgements }
+			const ackn = getAcknowledgements({ frontmatter })
+			expect(ackn).toBe(outdent`
+        ## Acknowledgements
+        
+        This rule was written in the [ACT Rules community group](https://w3.org/community/act-r/), 
+        with the support of the EU-funded [WAI-Tools Project](https://www.w3.org/WAI/about/projects/wai-tools/).
+        
+        ### Authors
+        
+        - [Wilco Fiers](https://github.com/wilcofiers)
+        
+        ### Previous Authors
+        
+        - [Audrey Maniez](https://github.com/audreymaniez)
+        - Random Person
+        
+        ### Assets
+        
+        - Some text
+        - Some other text
+        
+        ### Beans
+        
+        - great
+			`)
+		})
+	})
+})

build/taskforce-rule-page/__tests__/get-changelog.js

@@ -0,0 +1,15 @@
+const outdent = require('outdent').default
+const getChangelog = require('../get-changelog')
+
+describe('taskforce-markdown', () => {
+	describe('get-changelog', () => {
+		it('returns a static changelog', () => {
+			const log = getChangelog()
+			expect(log).toBe(outdent`
+        ## Changelog
+
+        This is the first version of this ACT rule.
+      `)
+		})
+	})
+})

build/taskforce-rule-page/__tests__/get-definition-content.js

@@ -0,0 +1,33 @@
+const outdent = require('outdent').default
+const { createGlossary } = require('../../__test-utils')
+const getDefinitionContent = require('../get-definition-content')
+
+describe('getDefinitionContent', () => {
+	const glossaryBase = {
+		hello: outdent`
+      Hello [world][]
+
+      [world]: #world
+      [w3c]: //w3.org
+    `,
+		world: outdent`
+      World of the [ACT-rules community]
+
+      [act-rules community]: //act-rules.github.io
+    `,
+		outcome: `All good.`,
+	}
+	const glossary = createGlossary(glossaryBase)
+
+	it('runs', () => {
+		const taskforceMarkdown = getDefinitionContent('hello', glossary)
+
+		expect(taskforceMarkdown).toBe(outdent`
+      ### Hello {#hello}
+      Hello [world][]
+
+      [world]: #world
+      [w3c]: //w3.org
+    `)
+	})
+})

build/taskforce-rule-page/__tests__/get-frontmatter.js

@@ -0,0 +1,62 @@
+const getFrontmatter = require('../get-frontmatter')
+const yaml = require('js-yaml')
+
+function stripDashes(str) {
+	return str.replace(/---/g, '')
+}
+
+describe('taskforce-markdown', () => {
+	const filenameNoExt = 'hello-world-198j8j'
+	const ruleData = {
+		filename: `${filenameNoExt}.md`,
+		frontmatter: {
+			name: 'hello world',
+		},
+	}
+
+	describe('get-frontmatter', () => {
+		it('starts and ends with a line of "---"', () => {
+			const lines = getFrontmatter(ruleData).split('\n')
+			expect(lines[0]).toBe('---')
+			expect(lines[lines.length - 1]).toBe('---')
+		})
+
+		it('returns valid yaml between the "---"s', () => {
+			const frontmatter = getFrontmatter(ruleData)
+			const frontmatterData = stripDashes(frontmatter)
+			expect(() => {
+				yaml.safeLoad(frontmatterData)
+			}).not.toThrow()
+		})
+
+		it('has the appropriate data in the yaml', () => {
+			const frontmatter = getFrontmatter(ruleData)
+			const frontmatterData = stripDashes(frontmatter)
+			const data = yaml.safeLoad(frontmatterData)
+
+			expect(data).toEqual({
+				title: ruleData.frontmatter.name,
+				permalink: `/standards-guidelines/act/rules/${filenameNoExt}/`,
+				ref: `/standards-guidelines/act/rules/${filenameNoExt}/`,
+				lang: 'en',
+				github: {
+					repository: `w3c/wcag-act-rules`,
+					path: `content/${ruleData.filename}`,
+				},
+			})
+		})
+
+		it('does not include markdown in the title', () => {
+			const frontmatter = getFrontmatter({
+				filename: `${filenameNoExt}.md`,
+				frontmatter: {
+					name: '`*Hello*` **world, welcome** to _ACT_taskforce_ **',
+				},
+			})
+			const frontmatterData = stripDashes(frontmatter)
+			const data = yaml.safeLoad(frontmatterData)
+
+			expect(data).toHaveProperty('title', '*Hello* world, welcome to ACT_taskforce **')
+		})
+	})
+})

build/taskforce-rule-page/__tests__/get-glossary.js

@@ -0,0 +1,47 @@
+const parsePage = require('../../../utils/parse-page')
+const getGlossary = require('../get-glossary')
+const { createGlossary } = require('../../__test-utils')
+
+describe('taskforce-markdown', () => {
+	describe('get-glossary', () => {
+		const glossaryBase = {
+			hello: 'Hello [world](#world).',
+			world: 'World!',
+			outcome: 'All good.',
+		}
+		const glossary = createGlossary(glossaryBase)
+
+		it('includes the outcome', () => {
+			const rulePage = parsePage('Without definitions [w3](//w3.org)')
+			const ruleGlossary = getGlossary(rulePage, glossary)
+
+			expect(ruleGlossary).toBe('## Glossary\n\n{% include_relative glossary/outcome.md %}')
+		})
+
+		it('sorts definitions in alphabetic order', () => {
+			const rulePage = parsePage(`[hello](#hello), [world](#world)`)
+			const ruleGlossary = getGlossary(rulePage, glossary)
+			expect(ruleGlossary).toBe(
+				[
+					'## Glossary\n',
+					'{% include_relative glossary/hello.md %}',
+					'{% include_relative glossary/outcome.md %}',
+					'{% include_relative glossary/world.md %}',
+				].join('\n')
+			)
+		})
+
+		it('includes nested definitions', () => {
+			const rulePage = parsePage('[hello](#hello)')
+			const ruleGlossary = getGlossary(rulePage, glossary)
+			expect(ruleGlossary).toBe(
+				[
+					'## Glossary\n',
+					'{% include_relative glossary/hello.md %}',
+					'{% include_relative glossary/outcome.md %}',
+					'{% include_relative glossary/world.md %}',
+				].join('\n')
+			)
+		})
+	})
+})

build/taskforce-rule-page/__tests__/get-reference-links.js

@@ -0,0 +1,22 @@
+const outdent = require('outdent').default
+const parsePage = require('../../../utils/parse-page')
+const getReferenceLinks = require('../get-reference-links')
+
+describe('taskforce-markdown', () => {
+	describe('get-reference-links', () => {
+		it('returns a string', () => {
+			const rulePage = parsePage(outdent`
+        [hello][], [w3c][]
+
+        [hello]: #hello
+        [w3c]: //w3.org 'W3C website'
+      `)
+
+			const referenceLinks = getReferenceLinks(rulePage, [])
+			expect(referenceLinks).toBe(outdent`
+        [hello]: #hello
+        [w3c]: //w3.org 'W3C website'
+      `)
+		})
+	})
+})

build/taskforce-rule-page/__tests__/get-rule-body.js

@@ -0,0 +1,43 @@
+const outdent = require('outdent').default
+const parseMarkdown = require('../../../utils/parse-markdown')
+const getRuleBody = require('../get-rule-body')
+
+describe('taskforce-markdown', () => {
+	describe('get-rule-body', () => {
+		it('returns the trimmed body if there are no reference links', () => {
+			const body = outdent`
+        ## Hello world
+
+      ` // indent is intentional
+			const markdownAST = parseMarkdown(body)
+			const stripped = getRuleBody({ body, markdownAST })
+
+			expect(stripped).toBe(body.trim())
+		})
+
+		it('returns content without reference links', () => {
+			const content = outdent`
+        ## Hello
+        Welcome to the [party][] [time][] in the [ACT Taskforce][]!
+
+        ## Shopping list
+        - cake
+        - chips
+        - party hats
+
+      `
+			const references = outdent`
+        [party]: http://w3.org
+        [time]: <http://w3.org> 'hello world'
+
+        [act-taskforce]: https://act-rules.github.io/
+
+      ` // blank line is intentional
+			const body = content + '\n' + references
+			const markdownAST = parseMarkdown(body)
+
+			const stripped = getRuleBody({ body, markdownAST })
+			expect(stripped).toBe(content.trim())
+		})
+	})
+})